Issue 2119 - Add get_page_content template function.

cms/utils.py

 # coding: utf-8
 
 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-2015 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
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
 # along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
 
 from .converters import converters, TemplateConverter
 
-def process_page(source, locale, page, format, site_url_override=None):
+def get_page_params(source, locale, page, format=None, site_url_override=None):
+  # Guess page format if omitted, but default to Markdown for friendlier exceptions
+  if format is None:
+    format = "md"
+    for fmt in converters.keys():
+      if source.has_page(page, fmt):
+        format = fmt

[Sebastian Noack, 2015/04/08 08:38:57]

I'd prefer to break when we found a match. Then we only need one variable and
can make it more obvious that we use "md" as default:

for format in converters:
  if source.has_page(page, format):
    break
else:
  format = "md"

Also do we actually need to fallback to "md" here, or shouldn't we better raise
an exception when we don't find a match?

[kzar, 2015/04/08 08:50:20]

Cool, I've never seen an `else` clause for a `for` loop before! Done.

Setting the default of "md" here is fine I think, we will then throw the correct
exception ("IOError: [Errno 2] No such file or directory:
'./pages/example.md'"). It was just without setting a default it would appear
broken when complaining that "./pages/example.None" didn't exist.

+
   params = {
     "source": source,
     "template": "default",
     "locale": locale,
     "page": page,
     "pagedata": source.read_page(page, format),
     "config": source.read_config(),
   }
 
   localefile = page
   if params["config"].has_option("locale_overrides", page):
     localefile = params["config"].get("locale_overrides", page)
   params["localedata"] = source.read_locale(params["locale"], localefile)
 
   if params["config"].has_option("general", "siteurl"):
     if site_url_override:
       params["site_url"] = site_url_override
     else:
       params["site_url"] = params["config"].get("general", "siteurl")
 
   try:
     converter = converters[format](params)
   except KeyError:
     raise Exception("Page %s uses unknown format %s" % (page, format))
 
   # Note: The converter might change some parameters so we can only read in
   # template data here.
   params["templatedata"] = source.read_template(params["template"])
-  template_converter = TemplateConverter(params, key="templatedata")
 
   defaultlocale = params["config"].get("general", "defaultlocale")
   params["defaultlocale"] = defaultlocale
 
   locales = [
     locale
     for locale in source.list_locales()
     if source.has_locale(locale, localefile)
   ]
   if defaultlocale not in locales:
     locales.append(defaultlocale)
   locales.sort()
   params["available_locales"] = locales
 
   params["head"], params["body"] = converter()
-  return template_converter()
+  return params
+
+def process_page(source, locale, page, format, site_url_override=None):
+  return TemplateConverter(
+    get_page_params(source, locale, page, format, site_url_override),
+    key="templatedata"
+  )()