diff libervia/pages/blog/view/page_meta.py @ 1509:106bae41f5c8

massive refactoring from camelCase -> snake_case. See backend commit log for more details
author Goffi <goffi@goffi.org>
date Sat, 08 Apr 2023 13:44:11 +0200
parents 1702b8c821c4
children
line wrap: on
line diff
--- a/libervia/pages/blog/view/page_meta.py	Fri Apr 07 15:20:40 2023 +0200
+++ b/libervia/pages/blog/view/page_meta.py	Sat Apr 08 13:44:11 2023 +0200
@@ -30,7 +30,7 @@
     args = [uri_data['path'], uri_data['node']]
     if 'item' in uri_data:
         args.extend(['id', uri_data['item']])
-    return self.getURL(*args)
+    return self.get_url(*args)
 
 def parse_url(self, request):
     """URL is /[service]/[node]/[filter_keyword]/[item]|[other]
@@ -41,10 +41,10 @@
         id: next value is a item id
         tag: next value is a blog tag
     """
-    data = self.getRData(request)
+    data = self.get_r_data(request)
 
     try:
-        service = self.nextPath(request)
+        service = self.next_path(request)
     except IndexError:
         data['service'] = ''
     else:
@@ -52,16 +52,16 @@
             data["service"] = jid.JID(service)
         except Exception:
             log.warning(_("bad service entered: {}").format(service))
-            self.pageError(request, C.HTTP_BAD_REQUEST)
+            self.page_error(request, C.HTTP_BAD_REQUEST)
 
     try:
-        node = self.nextPath(request)
+        node = self.next_path(request)
     except IndexError:
         node = '@'
     data['node'] = '' if node == '@' else node
 
     try:
-        filter_kw = data['filter_keyword'] = self.nextPath(request)
+        filter_kw = data['filter_keyword'] = self.next_path(request)
     except IndexError:
         filter_kw = '@'
     else:
@@ -70,28 +70,28 @@
             pass
         elif filter_kw == 'id':
             try:
-                data['item'] = self.nextPath(request)
+                data['item'] = self.next_path(request)
             except IndexError:
-                self.pageError(request, C.HTTP_BAD_REQUEST)
+                self.page_error(request, C.HTTP_BAD_REQUEST)
             # we get one more argument in case text has been added to have a nice URL
             try:
-                self.nextPath(request)
+                self.next_path(request)
             except IndexError:
                 pass
         elif filter_kw == 'tag':
             try:
-                data['tag'] = self.nextPath(request)
+                data['tag'] = self.next_path(request)
             except IndexError:
-                self.pageError(request, C.HTTP_BAD_REQUEST)
+                self.page_error(request, C.HTTP_BAD_REQUEST)
         else:
             # invalid filter keyword
             log.warning(_("invalid filter keyword: {filter_kw}").format(
                 filter_kw=filter_kw))
-            self.pageError(request, C.HTTP_BAD_REQUEST)
+            self.page_error(request, C.HTTP_BAD_REQUEST)
 
     # if URL is parsed here, we'll have atom.xml available and we need to
     # add the link to the page
-    atom_url = self.getURLByPath(
+    atom_url = self.get_url_by_path(
         SubPage('blog_view'),
         service,
         node,
@@ -107,10 +107,10 @@
 
 
 def add_breadcrumb(self, request, breadcrumbs):
-    data = self.getRData(request)
+    data = self.get_r_data(request)
     breadcrumbs.append({
         "label": D_("Feed"),
-        "url": self.getURL(data["service"].full(), data.get("node", "@"))
+        "url": self.get_url(data["service"].full(), data.get("node", "@"))
     })
     if "item" in data:
         breadcrumbs.append({
@@ -118,7 +118,7 @@
         })
 
 
-async def appendComments(
+async def append_comments(
     self,
     request: server.Request,
     blog_items: dict,
@@ -133,10 +133,10 @@
     """
     if _seen is None:
         _seen = set()
-    await self.fillMissingIdentities(
+    await self.fill_missing_identities(
         request, [i['author_jid'] for i in blog_items['items']])
     extra: Dict[str, Any] = {C.KEY_ORDER_BY: C.ORDER_BY_CREATION}
-    if not self.useCache(request):
+    if not self.use_cache(request):
         extra[C.KEY_USE_CACHE] = False
     for blog_item in blog_items['items']:
         for comment_data in blog_item['comments']:
@@ -153,7 +153,7 @@
             else:
                 _seen.add(service_node)
             try:
-                comments_data = await self.host.bridgeCall('mbGet',
+                comments_data = await self.host.bridge_call('mb_get',
                                       service,
                                       node,
                                       C.NO_LIMIT,
@@ -177,9 +177,9 @@
                 comment_data["items"] = []
                 continue
             comment_data['items'] = comments['items']
-            await appendComments(self, request, comments, profile, _seen=_seen)
+            await append_comments(self, request, comments, profile, _seen=_seen)
 
-async def getBlogItems(
+async def get_blog_items(
     self,
     request: server.Request,
     service: jid.JID,
@@ -193,9 +193,9 @@
             items_id = [item_id]
         else:
             items_id = []
-        if not self.useCache(request):
+        if not self.use_cache(request):
             extra[C.KEY_USE_CACHE] = False
-        blog_data = await self.host.bridgeCall('mbGet',
+        blog_data = await self.host.bridge_call('mb_get',
                               service.userhost(),
                               node,
                               C.NO_LIMIT,
@@ -205,7 +205,7 @@
     except Exception as e:
         # FIXME: need a better way to test errors in bridge errback
         if "forbidden" in str(e):
-            self.pageError(request, 401)
+            self.page_error(request, 401)
         else:
             log.warning(_("can't retrieve blog for [{service}]: {msg}".format(
                 service = service.userhost(), msg=e)))
@@ -216,7 +216,7 @@
     return blog_data
 
 async def prepare_render(self, request):
-    data = self.getRData(request)
+    data = self.get_r_data(request)
     template_data = request.template_data
     page_max = data.get("page_max", 10)
     # if the comments are not explicitly hidden, we show them
@@ -226,7 +226,7 @@
         data.get('item'),
         data.get('show_comments', True)
     )
-    profile = self.getProfile(request)
+    profile = self.get_profile(request)
     if profile is None:
         profile = C.SERVICE_PROFILE
         profile_connected = False
@@ -237,15 +237,15 @@
     if item_id:
         extra = {}
     else:
-        extra = self.getPubsubExtra(request, page_max=page_max)
+        extra = self.get_pubsub_extra(request, page_max=page_max)
         tag = data.get('tag')
         if tag:
             extra[f'mam_filter_{C.MAM_FILTER_CATEGORY}'] = tag
-        self.handleSearch(request, extra)
+        self.handle_search(request, extra)
 
     ## main data ##
     # we get data from backend/XMPP here
-    blog_items = await getBlogItems(self, request, service, node, item_id, extra, profile)
+    blog_items = await get_blog_items(self, request, service, node, item_id, extra, profile)
 
     ## navigation ##
     # no let's fill service, node and pagination URLs
@@ -257,13 +257,13 @@
 
     if blog_items:
         if item_id:
-            template_data["previous_page_url"] = self.getURL(
+            template_data["previous_page_url"] = self.get_url(
                 service.full(),
                 node,
                 before=item_id,
                 page_max=1
             )
-            template_data["next_page_url"] = self.getURL(
+            template_data["next_page_url"] = self.get_url(
                 service.full(),
                 node,
                 after=item_id,
@@ -275,33 +275,33 @@
             }
             blog_items["complete"] = False
         else:
-            self.setPagination(request, blog_items)
+            self.set_pagination(request, blog_items)
     else:
         if item_id:
             # if item id has been specified in URL and it's not found,
             # we must return an error
-            self.pageError(request, C.HTTP_NOT_FOUND)
+            self.page_error(request, C.HTTP_NOT_FOUND)
 
     ## identities ##
     # identities are used to show nice nickname or avatars
-    await self.fillMissingIdentities(request, [i['author_jid'] for i in blog_items['items']])
+    await self.fill_missing_identities(request, [i['author_jid'] for i in blog_items['items']])
 
     ## Comments ##
     # if comments are requested, we need to take them
     if show_comments:
-        await appendComments(self, request, blog_items, profile)
+        await append_comments(self, request, blog_items, profile)
 
     ## URLs ##
     # We will fill items_http_uri and tags_http_uri in template_data with suitable urls
     # if we know the profile, we use it instead of service + blog (nicer url)
     if target_profile is None:
-        blog_base_url_item = self.getPageByName('blog_view').getURL(service.full(), node or '@', 'id')
-        blog_base_url_tag = self.getPageByName('blog_view').getURL(service.full(), node or '@', 'tag')
+        blog_base_url_item = self.get_page_by_name('blog_view').get_url(service.full(), node or '@', 'id')
+        blog_base_url_tag = self.get_page_by_name('blog_view').get_url(service.full(), node or '@', 'tag')
     else:
-        blog_base_url_item = self.getURLByNames([('user', [target_profile]), ('user_blog', ['id'])])
-        blog_base_url_tag = self.getURLByNames([('user', [target_profile]), ('user_blog', ['tag'])])
+        blog_base_url_item = self.get_url_by_names([('user', [target_profile]), ('user_blog', ['id'])])
+        blog_base_url_tag = self.get_url_by_names([('user', [target_profile]), ('user_blog', ['tag'])])
         # we also set the background image if specified by user
-        bg_img = await self.host.bridgeCall('asyncGetParamA', 'Background', 'Blog page', 'value', -1, template_data['target_profile'])
+        bg_img = await self.host.bridge_call('param_get_a_async', 'Background', 'Blog page', 'value', -1, template_data['target_profile'])
         if bg_img:
             template_data['dynamic_style'] = safe("""
                 :root {
@@ -327,7 +327,7 @@
             # item's id is already user friendly.
             # TODO: to be removed,  this is only kept for a transition period until
             #   user friendly item IDs are more common.
-            text = regex.urlFriendlyText(item.get('title', item['content']))
+            text = regex.url_friendly_text(item.get('title', item['content']))
             if text:
                 blog_url = blog_canonical_url + '/' + text
             else:
@@ -335,11 +335,11 @@
         else:
             blog_url = blog_canonical_url
 
-        items_http_uri[item['id']] = self.host.getExtBaseURL(request, blog_url)
+        items_http_uri[item['id']] = self.host.get_ext_base_url(request, blog_url)
         for tag in item['tags']:
             if tag not in tags_http_uri:
                 tag_url = '/'.join([blog_base_url_tag, utils.quote(tag)])
-                tags_http_uri[tag] = self.host.getExtBaseURL(request, tag_url)
+                tags_http_uri[tag] = self.host.get_ext_base_url(request, tag_url)
 
     # if True, page should display a comment box
     template_data['allow_commenting'] = data.get('allow_commenting', profile_connected)
@@ -350,31 +350,31 @@
         uri_args['node'] = node
     if item_id:
         uri_args['item'] = item_id
-    template_data['xmpp_uri'] = uri.buildXMPPUri(
+    template_data['xmpp_uri'] = uri.build_xmpp_uri(
         'pubsub', subtype='microblog', **uri_args
     )
 
 
 async def on_data_post(self, request):
-    profile = self.getProfile(request)
+    profile = self.get_profile(request)
     if profile is None:
-        self.pageError(request, C.HTTP_FORBIDDEN)
-    type_ = self.getPostedData(request, 'type')
+        self.page_error(request, C.HTTP_FORBIDDEN)
+    type_ = self.get_posted_data(request, 'type')
     if type_ == 'comment':
-        service, node, body = self.getPostedData(request, ('service', 'node', 'body'))
+        service, node, body = self.get_posted_data(request, ('service', 'node', 'body'))
 
         if not body:
-            self.pageError(request, C.HTTP_BAD_REQUEST)
+            self.page_error(request, C.HTTP_BAD_REQUEST)
         comment_data = {"content_rich": body}
         try:
-            await self.host.bridgeCall('mbSend',
+            await self.host.bridge_call('mb_send',
                                        service,
                                        node,
                                        data_format.serialise(comment_data),
                                        profile)
         except Exception as e:
             if "forbidden" in str(e):
-                self.pageError(request, 401)
+                self.page_error(request, 401)
             else:
                 raise e
     else: