eduvia/lms
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: pre commit issues

Browse Source
This commit is contained in:
Jannat Patel
2022-11-04 11:47:09 +05:30
parent cda26ab248
commit 603eddf878
210 changed files with 10725 additions and 6733 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
lms/overrides/test_user.py
View File

@@ -2,43 +2,43 @@
# See license.txt
import unittest
import frappe
from lms.lms.doctype.lms_course.test_lms_course import new_user
class TestCustomUser(unittest.TestCase):
def test_with_basic_username(self):
user = new_user("Username", "test_with_basic_username@example.com")
self.assertEqual(user.username, "username")
def test_with_basic_username(self):
user = new_user("Username", "test_with_basic_username@example.com")
self.assertEqual(user.username, "username")
def test_without_username(self):
"""The user in this test has the same first name as the user of the test test_with_basic_username.
In such cases frappe makes the username of the second user empty.
The condition in lms app should override this and save a username."""
user = new_user("Username", "test-without-username@example.com")
self.assertTrue(user.username)
def test_without_username(self):
""" The user in this test has the same first name as the user of the test test_with_basic_username.
In such cases frappe makes the username of the second user empty.
The condition in lms app should override this and save a username. """
user = new_user("Username", "test-without-username@example.com")
self.assertTrue(user.username)
def test_with_illegal_characters(self):
user = new_user("Username$$", "test_with_illegal_characters@example.com")
self.assertEqual(user.username[:8], "username")
def test_with_illegal_characters(self):
user = new_user("Username$$", "test_with_illegal_characters@example.com")
self.assertEqual(user.username[:8], "username")
def test_with_underscore_at_end(self):
user = new_user("Username___", "test_with_underscore_at_end@example.com")
self.assertNotEqual(user.username[-1], "_")
def test_with_underscore_at_end(self):
user = new_user("Username___", "test_with_underscore_at_end@example.com")
self.assertNotEqual(user.username[-1], "_")
def test_with_short_first_name(self):
user = new_user("USN", "test_with_short_first_name@example.com")
self.assertGreaterEqual(len(user.username), 4)
def test_with_short_first_name(self):
user = new_user("USN", "test_with_short_first_name@example.com")
self.assertGreaterEqual(len(user.username), 4)
@classmethod
def tearDownClass(cls) -> None:
users = [
"test_with_basic_username@example.com",
"test-without-username@example.com",
"test_with_illegal_characters@example.com",
"test_with_underscore_at_end@example.com",
"test_with_short_first_name@example.com"
]
frappe.db.delete("User", {"name": ["in", users]})
@classmethod
def tearDownClass(cls) -> None:
users = [
"test_with_basic_username@example.com",
"test-without-username@example.com",
"test_with_illegal_characters@example.com",
"test_with_underscore_at_end@example.com",
"test_with_short_first_name@example.com",
]
frappe.db.delete("User", {"name": ["in", users]})

549
lms/overrides/user.py
View File

@@ -1,319 +1,359 @@
import frappe
from frappe.core.doctype.user.user import User
from frappe.utils import cint, escape_html, random_string
import hashlib
import random
import re
from frappe import _
from frappe.website.utils import is_signup_disabled
from lms.lms.utils import validate_image
import frappe
import requests
from frappe import _
from frappe.core.doctype.user.user import User
from frappe.utils import cint, escape_html, random_string
from frappe.website.utils import is_signup_disabled
from lms.lms.utils import validate_image
from lms.widgets import Widgets
class CustomUser(User):
def validate(self):
super().validate()
self.validate_username_characters()
self.validate_completion()
self.user_image = validate_image(self.user_image)
self.cover_image = validate_image(self.cover_image)
def validate_username_characters(self):
if self.username and len(self.username):
other_conditions = (
self.username[0] == "_" or self.username[-1] == "_" or "-" in self.username
)
else:
other_conditions = ""
def validate(self):
super(CustomUser, self).validate()
self.validate_username_characters()
self.validate_completion()
self.user_image = validate_image(self.user_image)
self.cover_image = validate_image(self.cover_image)
regex = re.compile(r"[@!#$%^&*()<>?/\|}{~:-]")
if self.is_new():
if not self.username:
self.username = self.get_username_from_first_name()
def validate_username_characters(self):
if self.username and len(self.username):
other_conditions = self.username[0] == "_" or self.username[-1] == "_" or "-" in self.username
else:
other_conditions = ''
if self.username.find(" "):
self.username.replace(" ", "")
regex = re.compile('[@!#$%^&*()<>?/\|}{~:-]')
if len(self.username) < 4:
self.username = self.email.replace("@", "").replace(".", "")
if self.is_new():
if not self.username:
self.username = self.get_username_from_first_name()
if regex.search(self.username) or other_conditions:
self.username = self.remove_illegal_characters()
if self.username.find(" "):
self.username.replace(" ", "")
while self.username_exists():
self.username = self.remove_illegal_characters() + str(random.randint(0, 99))
if len(self.username) < 4:
self.username = self.email.replace("@", "").replace(".", "")
else:
if not self.username:
frappe.throw(_("Username already exists."))
if regex.search(self.username) or other_conditions:
self.username = self.remove_illegal_characters()
if regex.search(self.username):
frappe.throw(_("Username can only contain alphabets, numbers and underscore."))
while self.username_exists():
self.username = self.remove_illegal_characters() + str(random.randint(0, 99))
if other_conditions:
if "-" in self.username:
frappe.throw(_("Username cannot contain a Hyphen(-)"))
else:
frappe.throw(_("First and Last character of username cannot be Underscore(_)."))
else:
if not self.username:
frappe.throw(_("Username already exists."))
if len(self.username) < 4:
frappe.throw(_("Username cannot be less than 4 characters"))
if regex.search(self.username):
frappe.throw(_("Username can only contain alphabets, numbers and underscore."))
def get_username_from_first_name(self):
return frappe.scrub(self.first_name) + str(random.randint(0, 99))
if other_conditions:
if "-" in self.username:
frappe.throw(_("Username cannot contain a Hyphen(-)"))
else:
frappe.throw(_("First and Last character of username cannot be Underscore(_)."))
def remove_illegal_characters(self):
return re.sub(r"[^\w]+", "", self.username).strip("_")
if len(self.username) < 4:
frappe.throw(_("Username cannot be less than 4 characters"))
def validate_skills(self):
unique_skills = []
for skill in self.skill:
if not skill.skill_name:
return
if not skill.skill_name in unique_skills:
unique_skills.append(skill.skill_name)
else:
frappe.throw(_("Skills must be unique"))
def get_username_from_first_name(self):
return frappe.scrub(self.first_name) + str(random.randint(0, 99))
def validate_completion(self):
if frappe.db.get_single_value("LMS Settings", "force_profile_completion"):
all_fields_have_value = True
profile_mandatory_fields = frappe.get_hooks("profile_mandatory_fields")
docfields = frappe.get_meta(self.doctype).fields
def remove_illegal_characters(self):
return re.sub("[^\w]+", "", self.username).strip("_")
for field in profile_mandatory_fields:
if not self.get(field):
all_fields_have_value = False
break
def validate_skills(self):
unique_skills = []
for skill in self.skill:
if not skill.skill_name:
return
if not skill.skill_name in unique_skills:
unique_skills.append(skill.skill_name)
else:
frappe.throw(_("Skills must be unique"))
self.profile_complete = all_fields_have_value
def validate_completion(self):
if frappe.db.get_single_value("LMS Settings", "force_profile_completion"):
all_fields_have_value = True
profile_mandatory_fields = frappe.get_hooks("profile_mandatory_fields")
docfields = frappe.get_meta(self.doctype).fields
def get_batch_count(self) -> int:
"""Returns the number of batches authored by this user."""
return frappe.db.count(
"LMS Batch Membership", {"member": self.name, "member_type": "Mentor"}
)
for field in profile_mandatory_fields:
if not self.get(field):
all_fields_have_value = False
break
def get_user_reviews(self):
"""Returns the reviews created by user"""
return frappe.get_all("LMS Course Review", {"owner": self.name})
self.profile_complete = all_fields_have_value
def get_mentored_courses(self):
"""Returns all courses mentored by this user"""
mentored_courses = []
mapping = frappe.get_all(
"LMS Course Mentor Mapping",
{
"mentor": self.name,
},
["name", "course"],
)
for map in mapping:
if frappe.db.get_value("LMS Course", map.course, "published"):
course = frappe.db.get_value(
"LMS Course",
map.course,
["name", "upcoming", "title", "image", "enable_certification"],
as_dict=True,
)
mentored_courses.append(course)
def get_batch_count(self) -> int:
"""Returns the number of batches authored by this user.
"""
return frappe.db.count(
'LMS Batch Membership', {
'member': self.name,
'member_type': 'Mentor'
})
def get_user_reviews(self):
""" Returns the reviews created by user """
return frappe.get_all("LMS Course Review",
{
"owner": self.name
})
def get_mentored_courses(self):
""" Returns all courses mentored by this user """
mentored_courses = []
mapping = frappe.get_all("LMS Course Mentor Mapping",
{
"mentor": self.name,
},
["name", "course"]
)
for map in mapping:
if frappe.db.get_value("LMS Course", map.course, "published"):
course = frappe.db.get_value("LMS Course", map.course,
["name", "upcoming", "title", "image", "enable_certification"], as_dict=True)
mentored_courses.append(course)
return mentored_courses
return mentored_courses
def get_enrolled_courses():
in_progress = []
completed = []
memberships = get_course_membership(None, member_type="Student")
in_progress = []
completed = []
memberships = get_course_membership(None, member_type="Student")
for membership in memberships:
course = frappe.db.get_value("LMS Course", membership.course, ["name", "upcoming", "title", "image",
"enable_certification", "paid_certificate", "price_certificate", "currency", "published"], as_dict=True)
if not course.published:
continue
progress = cint(membership.progress)
if progress < 100:
in_progress.append(course)
else:
completed.append(course)
for membership in memberships:
course = frappe.db.get_value(
"LMS Course",
membership.course,
[
"name",
"upcoming",
"title",
"image",
"enable_certification",
"paid_certificate",
"price_certificate",
"currency",
"published",
],
as_dict=True,
)
if not course.published:
continue
progress = cint(membership.progress)
if progress < 100:
in_progress.append(course)
else:
completed.append(course)
return {"in_progress": in_progress, "completed": completed}
return {
"in_progress": in_progress,
"completed": completed
}
def get_course_membership(member=None, member_type=None):
""" Returns all memberships of the user. """
"""Returns all memberships of the user."""
filters = {
"member": member or frappe.session.user
}
if member_type:
filters["member_type"] = member_type
filters = {"member": member or frappe.session.user}
if member_type:
filters["member_type"] = member_type
return frappe.get_all("LMS Batch Membership", filters, ["name", "course", "progress"])
return frappe.get_all("LMS Batch Membership", filters, ["name", "course", "progress"])
def get_authored_courses(member=None, only_published=True):
""" Returns the number of courses authored by this user. """
course_details = []
courses = frappe.get_all("Course Instructor", {
"instructor": member or frappe.session.user
}, ["parent"])
"""Returns the number of courses authored by this user."""
course_details = []
courses = frappe.get_all(
"Course Instructor", {"instructor": member or frappe.session.user}, ["parent"]
)
for course in courses:
detail = frappe.db.get_value("LMS Course", course.parent,
["name", "upcoming", "title", "image", "enable_certification", "status", "published"], as_dict=True)
for course in courses:
detail = frappe.db.get_value(
"LMS Course",
course.parent,
[
"name",
"upcoming",
"title",
"image",
"enable_certification",
"status",
"published",
],
as_dict=True,
)
if only_published and detail and not detail.published:
continue
course_details.append(detail)
if only_published and detail and not detail.published:
continue
course_details.append(detail)
return course_details
return course_details
def get_palette(full_name):
"""
Returns a color unique to each member for Avatar """
"""
Returns a color unique to each member for Avatar"""
palette = [
['--orange-avatar-bg', '--orange-avatar-color'],
['--pink-avatar-bg', '--pink-avatar-color'],
['--blue-avatar-bg', '--blue-avatar-color'],
['--green-avatar-bg', '--green-avatar-color'],
['--dark-green-avatar-bg', '--dark-green-avatar-color'],
['--red-avatar-bg', '--red-avatar-color'],
['--yellow-avatar-bg', '--yellow-avatar-color'],
['--purple-avatar-bg', '--purple-avatar-color'],
['--gray-avatar-bg', '--gray-avatar-color0']
]
palette = [
["--orange-avatar-bg", "--orange-avatar-color"],
["--pink-avatar-bg", "--pink-avatar-color"],
["--blue-avatar-bg", "--blue-avatar-color"],
["--green-avatar-bg", "--green-avatar-color"],
["--dark-green-avatar-bg", "--dark-green-avatar-color"],
["--red-avatar-bg", "--red-avatar-color"],
["--yellow-avatar-bg", "--yellow-avatar-color"],
["--purple-avatar-bg", "--purple-avatar-color"],
["--gray-avatar-bg", "--gray-avatar-color0"],
]
encoded_name = str(full_name).encode("utf-8")
hash_name = hashlib.md5(encoded_name).hexdigest()
idx = cint((int(hash_name[4:6], 16) + 1) / 5.33)
return palette[idx % 8]
encoded_name = str(full_name).encode("utf-8")
hash_name = hashlib.md5(encoded_name).hexdigest()
idx = cint((int(hash_name[4:6], 16) + 1) / 5.33)
return palette[idx % 8]
@frappe.whitelist(allow_guest=True)
def sign_up(email, full_name, verify_terms, user_category):
if is_signup_disabled():
frappe.throw(_('Sign Up is disabled'), title='Not Allowed')
if is_signup_disabled():
frappe.throw(_("Sign Up is disabled"), title="Not Allowed")
user = frappe.db.get("User", {"email": email})
if user:
if user.enabled:
return 0, _("Already Registered")
else:
return 0, _("Registered but disabled")
else:
if frappe.db.get_creation_count('User', 60) > 300:
frappe.respond_as_web_page(_('Temporarily Disabled'),
_('Too many users signed up recently, so the registration is disabled. Please try back in an hour'),
http_status_code=429)
user = frappe.db.get("User", {"email": email})
if user:
if user.enabled:
return 0, _("Already Registered")
else:
return 0, _("Registered but disabled")
else:
if frappe.db.get_creation_count("User", 60) > 300:
frappe.respond_as_web_page(
_("Temporarily Disabled"),
_(
"Too many users signed up recently, so the registration is disabled. Please try back in an hour"
),
http_status_code=429,
)
user = frappe.get_doc({
"doctype":"User",
"email": email,
"first_name": escape_html(full_name),
"verify_terms": verify_terms,
"user_category": user_category,
"country": "",
"enabled": 1,
"new_password": random_string(10),
"user_type": "Website User"
})
user.flags.ignore_permissions = True
user.flags.ignore_password_policy = True
user.insert()
set_country_from_ip(None, user.name)
user = frappe.get_doc(
{
"doctype": "User",
"email": email,
"first_name": escape_html(full_name),
"verify_terms": verify_terms,
"user_category": user_category,
"country": "",
"enabled": 1,
"new_password": random_string(10),
"user_type": "Website User",
}
)
user.flags.ignore_permissions = True
user.flags.ignore_password_policy = True
user.insert()
set_country_from_ip(None, user.name)
# set default signup role as per Portal Settings
default_role = frappe.db.get_value("Portal Settings", None, "default_role")
if default_role:
user.add_roles(default_role)
# set default signup role as per Portal Settings
default_role = frappe.db.get_value("Portal Settings", None, "default_role")
if default_role:
user.add_roles(default_role)
if user.flags.email_sent:
return 1, _("Please check your email for verification")
else:
return 2, _("Please ask your administrator to verify your sign-up")
if user.flags.email_sent:
return 1, _("Please check your email for verification")
else:
return 2, _("Please ask your administrator to verify your sign-up")
def set_country_from_ip(login_manager=None, user=None):
if not user and login_manager:
user = login_manager.user
if not user and login_manager:
user = login_manager.user
user_country = frappe.db.get_value("User", user, "country")
# if user_country:
# return
frappe.db.set_value("User", user, "country", get_country_code())
return
user_country = frappe.db.get_value("User", user, "country")
#if user_country:
# return
frappe.db.set_value("User", user, "country", get_country_code())
return
def get_country_code():
ip = frappe.local.request_ip
res = requests.get("http://ip-api.com/json/{ip}".format(ip=ip))
ip = frappe.local.request_ip
res = requests.get(f"http://ip-api.com/json/{ip}")
try:
data = res.json()
if data.get("status") != "fail":
return frappe.db.get_value("Country", {"code": data.get("countryCode")}, "name")
except Exception:
pass
return
try:
data = res.json()
if data.get("status") != "fail":
return frappe.db.get_value("Country", {"code": data.get("countryCode")}, "name")
except Exception:
pass
return
@frappe.whitelist(allow_guest=True)
def search_users(start=0, text=""):
or_filters = get_or_filters(text)
count = len(get_users(or_filters, 0, 900000000, text))
users = get_users(or_filters, start, 24, text)
user_details = get_user_details(users)
or_filters = get_or_filters(text)
count = len(get_users(or_filters, 0, 900000000, text))
users = get_users(or_filters, start, 24, text)
user_details = get_user_details(users)
return {"user_details": user_details, "start": cint(start) + 24, "count": count}
return {
"user_details": user_details,
"start": cint(start) + 24,
"count": count
}
def get_or_filters(text):
user_fields = ["first_name", "last_name", "full_name", "email", "preferred_location", "dream_companies"]
education_fields = ["institution_name", "location", "degree_type", "major"]
work_fields = ["title", "company"]
certification_fields = ["certification_name", "organization"]
user_fields = [
"first_name",
"last_name",
"full_name",
"email",
"preferred_location",
"dream_companies",
]
education_fields = ["institution_name", "location", "degree_type", "major"]
work_fields = ["title", "company"]
certification_fields = ["certification_name", "organization"]
or_filters = []
if text:
for field in user_fields:
or_filters.append(f"u.{field} like '%{text}%'")
for field in education_fields:
or_filters.append(f"ed.{field} like '%{text}%'")
for field in work_fields:
or_filters.append(f"we.{field} like '%{text}%'")
for field in certification_fields:
or_filters.append(f"c.{field} like '%{text}%'")
or_filters = []
if text:
for field in user_fields:
or_filters.append(f"u.{field} like '%{text}%'")
for field in education_fields:
or_filters.append(f"ed.{field} like '%{text}%'")
for field in work_fields:
or_filters.append(f"we.{field} like '%{text}%'")
for field in certification_fields:
or_filters.append(f"c.{field} like '%{text}%'")
or_filters.append(f"s.skill_name like '%{text}%'")
or_filters.append(f"pf.function like '%{text}%'")
or_filters.append(f"pi.industry like '%{text}%'")
or_filters.append(f"s.skill_name like '%{text}%'")
or_filters.append(f"pf.function like '%{text}%'")
or_filters.append(f"pi.industry like '%{text}%'")
return "AND ({})".format(" OR ".join(or_filters)) if or_filters else ""
return "AND ({})".format(" OR ".join(or_filters)) if or_filters else ""
def get_user_details(users):
user_details = []
for user in users:
details = frappe.db.get_value("User", user, ["name", "username", "full_name", "user_image", "headline"], as_dict=True)
user_details.append(Widgets().MemberCard(member=details, avatar_class="avatar-large"))
user_details = []
for user in users:
details = frappe.db.get_value(
"User",
user,
["name", "username", "full_name", "user_image", "headline"],
as_dict=True,
)
user_details.append(Widgets().MemberCard(member=details, avatar_class="avatar-large"))
return user_details
return user_details
def get_users(or_filters, start, page_length, text):
users = frappe.db.sql("""
users = frappe.db.sql(
"""
SELECT DISTINCT u.name
FROM `tabUser` u
LEFT JOIN `tabEducation Detail` ed
@@ -331,25 +371,28 @@ def get_users(or_filters, start, page_length, text):
WHERE u.enabled = True {or_filters}
ORDER BY u.creation desc
LIMIT {start}, {page_length}
""".format(or_filters = or_filters, start=start, page_length=page_length), as_dict=1)
""".format(
or_filters=or_filters, start=start, page_length=page_length
),
as_dict=1,
)
return users
return users
@frappe.whitelist()
def save_role(user, role, value):
if cint(value):
doc = frappe.get_doc({
"doctype": "Has Role",
"parent": user,
"role": role,
"parenttype": "User",
"parentfield": "roles"
})
doc.save(ignore_permissions=True)
else:
frappe.db.delete("Has Role", {
"parent": user,
"role": role
})
return True
if cint(value):
doc = frappe.get_doc(
{
"doctype": "Has Role",
"parent": user,
"role": role,
"parenttype": "User",
"parentfield": "roles",
}
)
doc.save(ignore_permissions=True)
else:
frappe.db.delete("Has Role", {"parent": user, "role": role})
return True

26
lms/overrides/web_template.py
View File

@@ -1,15 +1,17 @@
import frappe
from frappe.website.doctype.web_template.web_template import WebTemplate
from lms.widgets import Widgets
import json
class CustomWebTemplate(WebTemplate):
import frappe
from frappe.website.doctype.web_template.web_template import WebTemplate
def render(self, values=None):
if not values:
values = {}
values = frappe.parse_json(values)
values.update({"values": values})
values.update({"widgets": Widgets()})
template = self.get_template(self.standard)
return frappe.render_template(template, values)
from lms.widgets import Widgets
class CustomWebTemplate(WebTemplate):
def render(self, values=None):
if not values:
values = {}
values = frappe.parse_json(values)
values.update({"values": values})
values.update({"widgets": Widgets()})
template = self.get_template(self.standard)
return frappe.render_template(template, values)