Changeset 8718 for main/waeup.kofa

Timestamp:

14 Jun 2012, 06:58:14 (12 years ago)

Author:

uli

Message:

Add maintenance function to add objects in catalogs.

Location:

main/waeup.kofa/trunk/src/waeup/kofa

Files:

• maintenance.py (modified) (2 diffs)
• tests/test_maintenance.py (added)

main/waeup.kofa/trunk/src/waeup/kofa/maintenance.py

@@ -6 +6 @@
 import sys
 from ZODB.scripts.analyze import report, analyze
+from zope.component.hooks import setSite
+from zope.component import getUtility
+from zope.catalog.interfaces import ICatalog
+from zope.intid.interfaces import IIntIds
+from zope.location.interfaces import ILocation
 
 def db_analyze(args=None):
@@ -26 +31 @@
 
     report(analyze(path))
+
+def update_catalog(site, cat_name, objects=[], func=None):
+    """Update a catalog.
+
+    Put `objects` or objects delivered by `func()` into the catalog
+    registered under `cat_name` in `site`.
+
+    Objects to be catalogued must be 'located', i.e. they must have a
+    __name__ and __parent__ (because they are adapted to
+    IKeyReference).
+
+    You can pass in objects as some iterable or as a function that is
+    called to deliver the set of objects to be catalogued.
+
+    A function takes precedence over object lists.
+    """
+    setSite(site)
+    cat = getUtility(ICatalog, name=cat_name)
+    intids = getUtility(IIntIds, context=cat)
+    if func is not None:
+        objects = func()
+    for ob in objects:
+        doc_id = intids.queryId(ob, None)
+        if doc_id is None:
+            doc_id = intids.register(ob)
+        cat.index_doc(doc_id, ob)
+    return cat