Issue 5452 - Improve CMS API for local link generation

cms/converters.py

 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-present eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@@ skipping 424 matching lines @@
             'linkify': self.linkify,
             'toclist': self.toclist,
         }
 
         globals = {
             'get_string': self.get_string,
             'has_string': self.has_string,
             'get_page_content': self.get_page_content,
             'get_pages_metadata': self.get_pages_metadata,
             'get_canonical_url': self.get_canonical_url,
+            'get_page_url': self.get_page_url,
+            'page_has_locale': self.page_has_locale,
         }
 
         for dirname, dictionary in [('filters', filters),
                                     ('globals', globals)]:
             for filename in self._params['source'].list_files(dirname):
                 root, ext = os.path.splitext(filename)
                 if ext.lower() != '.py':
                     continue
 
                 path = os.path.join(dirname, filename)
@@ skipping 126 matching lines @@
 
         structured = []
         stack = [{'level': 0, 'subitems': structured}]
         for item in flat:
             while stack[-1]['level'] >= item['level']:
                 stack.pop()
             stack[-1]['subitems'].append(item)
             stack.append(item)
         return structured
 
+    def page_has_locale(self, page, locale):
+        return self._params['source'].has_locale(locale, page)
+
+    def get_page_url(self, page, locale=None, redirect=False):

[Vasily Kuznetsov, 2019/01/14 13:29:27]

The redirect argument is great, but it's not described in the original ticket.
Could you add it there please so that everything is in sync.

[rhowell, 2019/01/14 14:56:47]

Done.

+        if not locale:
+            locale = self._params['locale']
+        if self.page_has_locale(page, locale):

[Vasily Kuznetsov, 2019/01/14 13:29:27]

Since the body of this if is the same as that of the next, and they are kind of
long, maybe it would be worth it to combine them:

    if self.page_has_locale(...) or redirect:
        ...

It makes the logic a bit less clear but the saved repetition seems to be worth
it. What do you think?

[rhowell, 2019/01/14 14:56:47]

Yeah, I agree. Done.

+            return self._params['source'].resolve_link(page, locale)[1]
+        if redirect:
+            return self._params['source'].resolve_link(page, locale)[1]
+        raise Exception('{} does not exist in {}'.format(page, locale))
+
 
 converters = {
     'html': RawConverter,
     'md': MarkdownConverter,
     'tmpl': TemplateConverter,
 }