Changeset 2916 in products

Timestamp:

Oct 22, 2010 11:38:57 AM (14 years ago)

Author:

mylan

Message:

#228: Added getBOFiltered method to sitemap common view

File:

• quintagroup.plonegooglesitemaps/branches/blacklist/quintagroup/plonegooglesitemaps/browser/commonview.py (modified) (4 diffs)

quintagroup.plonegooglesitemaps/branches/blacklist/quintagroup/plonegooglesitemaps/browser/commonview.py

@@ -1 +1 @@
 from string import find
 from zope.interface import implements, Interface, Attribute
+from zope.component import queryUtility
 
 from Acquisition import aq_inner, aq_parent
@@ -7 +8 @@
 
 from quintagroup.plonegooglesitemaps import qPloneGoogleSitemapsMessageFactory as _
+from quintagroup.plonegooglesitemaps.config import BLACKOUT_PREFIX
+from quintagroup.plonegooglesitemaps.interfaces import IBlackoutFilterUtility
 from quintagroup.plonegooglesitemaps.browser.utils import additionalURLs, applyOperations
 
@@ -68 +71 @@
         result = []
         objects = self.getFilteredObjects()
-        blackout_list = self.context.getBlackout_list()
         reg_exps = self.context.getReg_exp()
 
-        brain_url_map = applyOperations([ob for ob in objects 
-            if (ob.getId not in blackout_list)],
-            reg_exps)
-
+        brain_url_map = applyOperations(self.getBOFiltered(objects), reg_exps)
         # Prepare dictionary for view
         for url, b in brain_url_map.items():
@@ -82 +81 @@
         self.num_entries = len(result)
         return result
+
+    def getBOFiltered(self, objects):
+        """Return blkack-out filtered objects
+          Every record in blackout_list filter should follow the spec:
+             [extra filter data, separated by ':':][<filter name>:]<filter data>
+          For example:
+          1|  index.html
+          2|  id:index.html
+          3|  path:/folder_1_level/obj_in_folder
+          4|  path:./folder_near_sitemap/obj_in_folder
+          5|  extra_arg1:extra_arg2:super_filter:super arg-1, super arg-2
+         
+          1->used default "id" filter - remove "index.html" objects;
+          2->explicit "id" filter - remove "index.html" objects;
+          3->"path" filter - remove /folder_1_level/obj_in_folder object,
+              path from the root of the plone site;
+          4->same to 3), but path get from the folder, where sitemap is located;
+          5->filter name is "super_filter" (must be registered IBlackoutFilterUtility,
+             named "seoptimzier.blackoutfilter.super_filter:), which get list of extra
+             parameters, e.g. [extra_arg1,extra_arg2] to the filterOut method in
+             "extras" option, and get filter arguments: super arg-1, super arg-2
+          
+          class SuperFilterUtility(object):
+              def filterOut(self, fdata, fargs, **kwargs):
+                  sitemap = kwargs.get("sitemap")
+                  extras = kwargs.get("extras") # [extra_arg1,extra_arg2]
+                  # some logic to filter-out fdata by fargs with taking into
+                  # consideration extras ...
+        """
+        blackout_list = filter(None, self.context.getBlackout_list())
+        for frec in blackout_list:
+            fspec = frec.split(":")
+            fargs = fspec.pop()
+            fname = BLACKOUT_PREFIX + (fspec and fspec.pop() or "id")
+            futility = queryUtility(IBlackoutFilterUtility, name=fname)
+            if futility:
+                kw = {"sitemap": self.context,
+                      "extras": fspec}
+                objects = futility.filterOut(objects, fargs, **kw)
+        return objects
 
     def updateRequest(self):