Products.ZSQLCatalog.SQLCatalog: Make SQLCatalog not rely on isIndexable from ERP5Site

Earlier, In ERP5Site, we use property 'isIndexable' to have control over indexing and unindexing.
This was usefull specially in case of bootstrap. To have this control, we had a function
`isIndexable` in SQLCatalog which we used to switch for enabling-disabling indexation. (769f9fb2)

This is a preparative commit for case where:
Now, as we move to ERP5 based Catalog, which itself is an ERP5 Object, hence it has an accessor `isIndexable`
of itself which we plan to disable for now(as we don't want circular dependency while indexing
catalog in itself). But as we did have a function `isIndexable` in SQLCatalog which had control
over the indexing, we needed to rename this property for ERP5Site.

Hence, now we use property 'isIndexingRequired' for ERP5Site and use to have overall control
over indexing process.

Please note, we do not intend to change the same property name for any other object. Its just
for ERP5Site.

product/ERP5/Document/BusinessTemplate.py

@@ -5286,7 +5286,7 @@ Business Template is a set of definitions, such as skins, portal types and categ
 
       if update_catalog:
         catalog = _getCatalogValue(self)
-        if (catalog is None) or (not site.isIndexable):
+        if (catalog is None) or (not site.isIndexingRequired):
           LOG('Business Template', 0, 'no SQL Catalog available')
           update_catalog = 0
         else:

product/ERP5/ERP5Site.py

@@ -235,7 +235,7 @@ class ERP5Site(FolderMixIn, CMFSite, CacheCookieMixin):
   last_id = 0
   icon = 'portal.gif'
   # Default value, prevents error during upgrade
-  isIndexable = ConstantGetter('isIndexable', value=True)
+  isIndexingRequired = ConstantGetter('isIndexingRequired', value=True)
 
   _properties = (
       { 'id':'title',
@@ -1860,7 +1860,7 @@ class ERP5Generator(PortalGenerator):
     portal = self.klass(id=id)
     # Make sure reindex will not be called until business templates
     # will be installed
-    setattr(portal, 'isIndexable', ConstantGetter('isIndexable', value=False))
+    setattr(portal, 'isIndexingRequired', ConstantGetter('isIndexingRequired', value=False))
 
     # This is only used to refine log level.
     # Has no functional use, and should never have any:
@@ -2154,7 +2154,7 @@ class ERP5Generator(PortalGenerator):
     # When no SQL connection was define on the site,
     # we don't want to make it crash
     if p.erp5_sql_connection_type is not None:
-      setattr(p, 'isIndexable', ConstantGetter('isIndexable', value=True))
+      setattr(p, 'isIndexingRequired', ConstantGetter('isIndexingRequired', value=True))
       # Clear portal ids sql table, like this we do not take
       # ids for a previously created web site
       p.portal_ids.clearGenerator(all=True)

product/ERP5Type/Base.py

@@ -2823,7 +2823,7 @@ class Base( CopyContainer,
     """
       Reindexes an object - also useful for testing
     """
-    root_indexable = int(getattr(self.getPortalObject(),'isIndexable',1))
+    root_indexable = int(getattr(self.getPortalObject(),'isIndexingRequired',1))
     if self.isIndexable and root_indexable:
       #LOG("immediateReindexObject",0,self.getRelativeUrl())
       # Reindex result should not depend on the user

product/ZSQLCatalog/SQLCatalog.py

@@ -1231,8 +1231,8 @@ class Catalog(Folder,
         uid_list = [x.uid for x in method(count = UID_BUFFER_SIZE, instance_id = instance_id) if x.uid != 0]
       uid_buffer.extend(uid_list)
 
-  security.declarePrivate('isIndexable')
-  def isIndexable(self):
+  security.declarePrivate('isIndexingRequired')
+  def isIndexingRequired(self):
     """
     This is required to check in many methods that
     the site root and zope root are indexable
@@ -1240,8 +1240,8 @@ class Catalog(Folder,
     zope_root = self.getZopeRoot()
     site_root = self.getSiteRoot() # XXX-JPS - Why don't we use getPortalObject here ?
 
-    root_indexable = int(getattr(zope_root, 'isIndexable', 1))
-    site_indexable = int(getattr(site_root, 'isIndexable', 1))
+    root_indexable = int(getattr(zope_root, 'isIndexingRequired', 1))
+    site_indexable = int(getattr(site_root, 'isIndexingRequired', 1))
     if not (root_indexable and site_indexable):
       return False
     return True
@@ -1288,7 +1288,7 @@ class Catalog(Folder,
       Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
       with the risk of graph loops
     """
-    if not self.isIndexable():
+    if not self.isIndexingRequired():
       return None
 
     klass = self.__class__
@@ -1461,7 +1461,7 @@ class Catalog(Folder,
       LOG('ZSLQCatalog.SQLCatalog:catalogObjectList', WARNING,
           'idxs is ignored in this function and is only provided to be compatible with CMFCatalogAware.reindexObject.')
 
-    if not self.isIndexable():
+    if not self.isIndexingRequired():
       return
 
     # Reminder about optimization: It might be possible to issue just one
@@ -1710,7 +1710,7 @@ class Catalog(Folder,
     """
     Set the path as deleted
     """
-    if not self.isIndexable():
+    if not self.isIndexingRequired():
       return None
 
     if uid is None and path is not None:
@@ -1740,7 +1740,7 @@ class Catalog(Folder,
     XXX Add filter of methods
 
     """
-    if not self.isIndexable():
+    if not self.isIndexingRequired():
       return None
 
     if uid is None and path is not None:

[Vincent Pelletier]

If I understand correctly, the problem is that SQLCatalog accesses isIndexable on self, hence relying on implicit acquisition to reach the one from ERP5Site.

If so, and if we really always want the one from ERP5Site (I believe we do), then what about just doing .getPortalObject().isIndexable instead of .isIndexable ? I think the change would be smaller and more local.