feat: added support for making profile urls to be top-level

Made the profile_url_prefix customizable by adding it in the hooks.

Issue #192

community/hooks.py

@@ -141,15 +141,16 @@ website_route_rules = [
 	{"from_route": "/courses/<course>/learn/<int:chapter>.<int:lesson>", "to_route": "batch/learn"},
 	{"from_route": "/courses/<course>/progress", "to_route": "batch/progress"},
 	{"from_route": "/courses/<course>/join", "to_route": "batch/join"},
-	{"from_route": "/user/<string(minlength=4):username>", "to_route": "profiles/profile"},
 ]
 
 website_redirects = [
 	{"source": "/update-profile", "target": "/edit-profile"},
 ]
 
-update_website_context = 'community.widgets.update_website_context'
-
+update_website_context = [
+    'community.widgets.update_website_context',
+    'community.page_renderers.update_website_context'
+]
 ## Specify the additional tabs to be included in the user profile page.
 ## Each entry must be a subclass of community.community.plugins.ProfileTab
 # profile_tabs = []
@@ -170,3 +171,11 @@ community_markdown_macro_renderers = {
 	"YouTubeVideo": "community.plugins.youtube_video_renderer",
     "Video": "community.plugins.video_renderer"
 }
+
+# page_renderer to manage profile pages
+page_renderer = [
+	"community.page_renderers.ProfilePage"
+]
+
+# set this to "/" to have profiles on the top-level
+profile_url_prefix = "/users/"

community/page_renderers.py

@@ -0,0 +1,98 @@
+"""Custom page renderers for Community app.
+
+Handles rendering of profile pages.
+"""
+import re
+import frappe
+from frappe.website.page_renderers.base_renderer import BaseRenderer
+from frappe.website.page_renderers.template_page import TemplatePage
+
+from frappe.website.page_renderers.document_page import DocumentPage
+from frappe.website.page_renderers.list_page import ListPage
+from frappe.website.page_renderers.not_found_page import NotFoundPage
+from frappe.website.page_renderers.print_page import PrintPage
+from frappe.website.page_renderers.redirect_page import RedirectPage
+from frappe.website.page_renderers.static_page import StaticPage
+from frappe.website.page_renderers.template_page import TemplatePage
+from frappe.website.page_renderers.web_form import WebFormPage
+
+
+def update_website_context(context):
+    """Adds get_profile_url to context
+
+    Specified in the hooks.
+    """
+    context.get_profile_url = get_profile_url
+
+def get_profile_url(username):
+    """Returns the profile URL given username.
+
+    The default URL prefix for profiles is /users, but tha can be customized.
+
+    This functions looks at the current value from the config and generates
+    the URL for the profile.
+    """
+    return get_profile_url_prefix() + username
+
+def get_profile_url_prefix():
+    hooks = frappe.get_hooks("profile_url_prefix") or ["/users/"]
+    return hooks[-1]
+
+RE_USERNAME = re.compile("[a-zA-Z0-9_]{4,}")
+
+class ProfilePage(BaseRenderer):
+    def __init__(self, path, http_status_code):
+        super().__init__(path, http_status_code)
+        self.renderer = None
+
+    def can_render(self):
+        if "." in self.path:
+            return False
+
+        # has prefix and path starts with prefix?
+        prefix = get_profile_url_prefix().lstrip("/")
+        if prefix and not self.path.startswith(prefix):
+            return False
+
+        # not a userpage?
+        username = self.get_username()
+        if not RE_USERNAME.match(username):
+            return False
+
+        # if there is prefix then we can allow all usernames
+        if prefix:
+            return True
+
+        # if we are having top-level usernames, then give preference to
+        # the existing website_route_rules, web pages, web forms etc.
+
+        # Don't handle any of the exsiting website_route_rules
+        routes = [rule['to_route'] for rule in frappe.get_hooks("website_route_rules")]
+        if self.path in routes:
+            return False
+
+        # if any of the existing renders can render, let them do
+        renderers = [StaticPage, WebFormPage, DocumentPage, TemplatePage, ListPage, PrintPage]
+        for renderer in renderers:
+            renderer_instance = renderer(self.path, 200)
+            if renderer_instance.can_render():
+                self.renderer = renderer_instance
+                return True
+
+        return True
+
+    def get_username(self):
+        prefix = get_profile_url_prefix().lstrip("/")
+        return self.path[len(prefix):]
+
+    def render(self):
+        if self.renderer:
+            return self.renderer.render()
+        else:
+            username = self.get_username()
+            return render_portal_page("profiles/profile", username=username)
+
+def render_portal_page(path, **kwargs):
+    frappe.form_dict.update(kwargs)
+    page = TemplatePage(path)
+    return page.render()