Issue 2440 - implement Source.get_cache_dir() to be used by custom filters/globals

cms/sources.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 193 matching lines @@
 class MercurialSource(Source):
   def __init__(self, repo):
     command = ["hg", "-R", repo, "archive", "-r", "default",
         "-t", "uzip", "-p", ".", "-"]
     data = subprocess.check_output(command)
     self._archive = zipfile.ZipFile(StringIO(data), mode="r")
 
     command = ["hg", "-R", repo, "id", "-n", "-r", "default"]
     self.version = subprocess.check_output(command).strip()
 
+    self._origin = urlparse.urlsplit(repo).path.strip('/')

[Wladimir Palant, 2015/04/30 15:45:09]

|hg archive| won't work for remote repositories, so repo is a local path. So
this should be something like:

self._name = os.path.basename(repo) or os.path.basename(os.path.dirname(repo))

I'm not amused any more. For the last time: if you submit code for review, it
has to be tested! If it isn't tested then at the very least you should point
that out. You can also ask me if you need help finding a way to test your code.

[Sebastian Noack, 2015/04/30 18:09:19]

Fixed. Note that urlparse.urlsplit() did actually work (for local file paths).
But instead the last part the full path was considered.

+
   def __enter__(self):
     return self
 
   def __exit__(self, type, value, traceback):
     self.close()
     return False
 
   def close(self):
     self._archive.close()
 
   def has_file(self, filename):
     try:
       self._archive.getinfo("./%s" % filename)
     except KeyError:
       return False
     return True
 
   def read_file(self, filename, binary=False):
     result = self._archive.read("./%s" % filename)
     if not binary:
       result = result.decode("utf-8")
     return result
 
   def list_files(self, subdir):
     prefix = "./%s/" % subdir
     for filename in self._archive.namelist():
       if filename.startswith(prefix):
         yield filename[len(prefix):]
 
+  if os.name == "posix":
+    def get_cache_dir(self):
+      return "/var/cache/" + self._origin
+
 class FileSource(Source):
   def __init__(self, dir):
     self._dir = dir
 
   def __enter__(self):
     return self
 
   def __exit__(self, type, value, traceback):
     return False
 
@@ skipping 20 matching lines @@
         return
 
       for filename in files:
         path = os.path.join(dir, filename)
         if os.path.isfile(path):
           result.append(relpath + filename)
         elif os.path.isdir(path):
           do_list(path, relpath + filename + "/")
     do_list(self.get_path(subdir), "")
     return result
+
+  def get_cache_dir(self):
+    return os.path.join(self._dir, "cache")