Issue 2275 - Parse notification groups

sitescripts/notifications/parser.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 31 matching lines @@
         known = True
       elif spec.startswith(parameter + "Version="):
         target[parameter + "MinVersion"] = target[parameter + "MaxVersion"] = spec[len(parameter + "Version="):]
         known = True
     if not known:
       raise Exception("Unknown target specifier '%s' in file '%s'" % (spec, name))
   return target
 
 def _parse_notification(data, name):
   notification = {"id": name, "severity": "information", "message": {}, "title": {}}
+  current = notification
 
   for line in data:
     if not re.search(r"\S", line):
       continue
 
+    if re.search(r"^\[.*\]$", line):
+      current = {"title": {}, "message": {}}
+      if not "variants" in notification:
+        notification["variants"] = []
+      notification["variants"].append(current)
+      continue
+
     if line.find("=") < 0:
       raise Exception("Could not process line '%s' in file '%s'" % (line.strip(), name))
 
     key, value = map(unicode.strip, line.split("=", 1))
+    is_variant = current != notification
 
-    if key == "inactive":
-      notification["inactive"] = True
+    if key == "inactive" and not is_variant:
+      current["inactive"] = True
     elif key == "severity":
       if value not in ("information", "critical"):
         raise Exception("Unknown severity value '%s' in file '%s'" % (value, name))
-      notification["severity"] = value
+      current["severity"] = value
     elif key == "links":
-      notification["links"] = value.split()
+      current["links"] = value.split()
     elif key.startswith("title."):
       locale = key[len("title."):]
-      notification["title"][locale] = value
+      current["title"][locale] = value
     elif key.startswith("message."):
       locale = key[len("message."):]
-      notification["message"][locale] = value
+      current["message"][locale] = value
     elif key == "target":
       target = _parse_targetspec(value, name)
       if "targets" in notification:
-        notification["targets"].append(target)
+        current["targets"].append(target)
       else:
-        notification["targets"] = [target]
+        current["targets"] = [target]
+    elif key == "sample" and is_variant:
+      current["sample"] = value
     else:
       raise Exception("Unknown parameter '%s' in file '%s'" % (key, name))
 
-  if "en-US" not in notification["title"]:
-    raise Exception("No title for en-US (default language) in file '%s'" % name)
-  if "en-US" not in notification["message"]:
-    raise Exception("No message for en-US (default language) in file '%s'" % name)
+  for text_key in ["title", "message"]:

[Sebastian Noack, 2015/04/13 09:04:37]

Please use tuples for sequences that don't need to be mutable.

+    if "en-US" not in notification[text_key] and \
+       (not "variants" in notification or \

[Sebastian Noack, 2015/04/13 09:04:37]

Hint: Newlines don't need to be escaped within parenthesis.

+        not all("en-US" in variant[text_key]
+                for variant in notification["variants"])):
+      raise Exception("No %s for en-US (default language) in file '%s'" %
+                      (text_key, name))
   return notification
 
 def load_notifications():
   repo = get_config().get("notifications", "repository")
   subprocess.call(["hg", "-R", repo, "pull", "-q"])
   command = ["hg", "-R", repo, "archive", "-r", "default", "-t", "tar",
       "-p", ".", "-X", os.path.join(repo, ".hg_archival.txt"), "-"]
   data = subprocess.check_output(command)
 
   result = {"version": time.strftime("%Y%m%d%H%M", time.gmtime()), "notifications": []}
   with tarfile.open(mode="r:", fileobj=StringIO(data)) as archive:
     for fileinfo in archive:
       name = fileinfo.name
       if name.startswith("./"):
         name = name[2:]
 
       if fileinfo.type == tarfile.REGTYPE:
         data = codecs.getreader("utf8")(archive.extractfile(fileinfo))
         try:
           notification = _parse_notification(data, name)
           if "inactive" in notification:
             continue
           result["notifications"].append(notification)
         except:
           traceback.print_exc()
   return result