Issue 5331 - Adds has_string() global

cms/converters.py

 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-2017 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 390 matching lines @@
                 except KeyError:
                     raise Exception('Expected symbol {} not found'
                                     ' in {}'.format(name, path))
 
         self._env = jinja2.Environment(
             loader=SourceTemplateLoader(self._params['source']),
             autoescape=True)
         self._env.filters.update(filters)
         self._env.globals.update(globals)
 
+    def _get_locale_data(self, page):
+        return self._params['source'].read_locale(self._params['locale'], page)
+
     def get_html(self, source, filename):
         env = self._env
         code = env.compile(source, None, filename)
         template = jinja2.Template.from_code(env, code, env.globals)
 
         try:
             module = template.make_module(self._params)
         except Exception:
             env.handle_exception()
 
         for key, value in module.__dict__.iteritems():
             if not key.startswith('_'):
                 self._params[key] = value
 
         result = unicode(module)
         result = self.process_links(result)
         return result
 
     def translate(self, default, name, comment=None):
         return jinja2.Markup(self.localize_string(
             self._params['page'], name, default, comment,
             self._params['localedata'], html_escapes
         ))
 
     def get_string(self, name, page=None):
         if page is None:
             page = self._params['page']
 
-        localedata = self._params['source'].read_locale(self._params['locale'],
-                                                        page)
+        localedata = self._get_locale_data(page)
         default = localedata[name]

[Vasily Kuznetsov, 2017/06/20 17:38:27]

I didn't pay attention to this line when looking into this. Actually you seem to
be right and checking that the string exists is much simpler than I thought.

         return jinja2.Markup(self.localize_string(
             page, name, default, '', localedata, html_escapes
         ))
 
     def has_string(self, name, page=None):
         if page is None:
             page = self._params['page']
 
-        localedata = self._params['source'].read_locale(self._params['locale'],

[Vasily Kuznetsov, 2017/06/20 17:38:27]

Maybe create a small protected method for this logic to not replicate it? For
example `_get_localedata(self, page)`

[Jon Sonesen, 2017/06/21 07:53:54]

yeah, this is good. but what about the if page is none logic? Basically, it
seems it would be redundant to put in the new method unless we remove it here.
the problem there is that we still have casees where the page will be none,
however the protected method could always return the page and the local data.
What do you think?

[Vasily Kuznetsov, 2017/06/21 08:17:00]

Yeah, all true. I was thinking to leave that part in this method (and have a bit
of duplication -- this one you can't really avoid I guess). So the new method
would just have one call to blabla.read_locale(...) in it, but there's quite
some stuff in it, so it makes sense I think.

-                                                        page)
-        if name in localedata:

[Vasily Kuznetsov, 2017/06/20 17:38:28]

`return name in localedata` would do the same in one line.

[Jon Sonesen, 2017/06/21 07:53:54]

Acknowledged.

-            return True
-        return False
+        localedata = self._get_locale_data(page)
+        return name in localedata
 
     def get_page_content(self, page, locale=None):
         from cms.utils import get_page_params
 
         if locale is None:
             locale = self._params['locale']
         return get_page_params(self._params['source'], locale, page)
 
     def linkify(self, page, locale=None, **attrs):
         if locale is None:
@@ skipping 25 matching lines @@
                 stack.pop()
             stack[-1]['subitems'].append(item)
             stack.append(item)
         return structured
 
 converters = {
     'html': RawConverter,
     'md': MarkdownConverter,
     'tmpl': TemplateConverter,
 }