Issue 2559 - [cms] Detect conflicting pages in the development server

cms/bin/test_server.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,
@@ skipping 32 matching lines @@
       <p>An error occurred while processing the request for {{uri}}:</p>
       <pre>{{error}}</pre>
     {% endif %}
   </body>
 </html>"""
 
 # Create our own instance, the default one will introduce "random" host-specific
 # behavior by parsing local config files.
 mime_types = mimetypes.MimeTypes()
 
+class ConflictingPage(Exception):
+  pass
+
+def get_pages_and_localizable_files(source):
+  for page, format in source.list_pages():
+    yield page
+  for filename in source.list_localizable_files():
+    yield filename
+
 def get_data(path):
   if source.has_static(path):
     return source.read_static(path)
 
   path = path.strip("/")
   if path == "":
     path = source.read_config().get("general", "defaultlocale")
   if "/" in path:
-    locale, page = path.split("/", 1)
+    locale, requested_page = path.split("/", 1)
   else:
-    locale, page = path, ""
+    locale, requested_page = path, ""
 
   default_page = source.read_config().get("general", "defaultpage")
-  alternative_page = "/".join([page, default_page]).lstrip("/")
+  alternative_page = "/".join([requested_page, default_page]).lstrip("/")
+
+  found_page = None
+  func = None
+  args = None
+
   for format in converters.iterkeys():
-    for p in (page, alternative_page):
-      if source.has_page(p, format):
-        return process_page(source, locale, p, format, "http://127.0.0.1:5000")
-  if source.has_localizable_file(locale, page):
-    return source.read_localizable_file(locale, page)
+    for page in (requested_page, alternative_page):
+      if source.has_page(page, format):
+        if found_page:
+          raise ConflictingPage("The requested page correpsonds to multiple files")
 
-  return None
+        found_page = page
+        func = process_page
+        args = (source, locale, page, format, "http://127.0.0.1:5000")
+
+  if source.has_localizable_file(locale, requested_page):
+    if found_page:
+      raise ConflictingPage("The requested page conflicts with a localizable file")
+
+    found_page = requested_page
+    func = source.read_localizable_file
+    args = (locale, requested_page)
+
+  if not found_page:
+    return None
+
+  for page in get_pages_and_localizable_files(source):
+    if page.startswith(found_page + "/") or found_page.startswith(page + "/"):
+      raise ConflictingPage("The requested path conflicts with the path of another page")
+
+  return func(*args)
 
 def show_error(start_response, status, **kwargs):
   env = jinja2.Environment(autoescape=True)
   template = env.from_string(ERROR_TEMPLATE)
   mime = "text/html; encoding=%s" % UNICODE_ENCODING
   start_response(status, [("Content-Type", mime)])
   for fragment in template.stream(status=status, **kwargs):
     yield fragment.encode(UNICODE_ENCODING)
 
 def handler(environ, start_response):
   path = environ.get("PATH_INFO")
 
   data = get_data(path)
-  if data == None:
+  if data is None:
     return show_error(start_response, "404 Not Found", uri=path)
 
   mime = mime_types.guess_type(path)[0] or "text/html"
 
   if isinstance(data, unicode):
     data = data.encode(UNICODE_ENCODING)
     mime = "%s; charset=%s" % (mime, UNICODE_ENCODING)
 
   start_response("200 OK", [("Content-Type", mime)])
   return [data]
@@ skipping 26 matching lines @@
           return app(environ, start_response)
         except Exception, e:
           return show_error(start_response, "500 Internal Server Error",
               uri=environ.get("PATH_INFO"), error=e)
 
       server = make_server(host, port, wrapper)
       print " * Running on http://%s:%i/" % server.server_address
       server.serve_forever()
 
   run("localhost", 5000, handler, use_reloader=True, use_debugger=True)