Initial import of Cache configuration object

git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@11030 20353a03-c40f-0410-a6d1-a30d3c3de9de

product/ERP5Type/Document/CacheFactory.py

+##############################################################################
+#
+# Copyright (c) 2005 Nexedi SARL and Contributors. All Rights Reserved.
+#                     Ivan Tyagov <ivan@nexedi.com>
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# garantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+
+from AccessControl import ClassSecurityInfo
+from Products.CMFCore import CMFCorePermissions
+from Products.ERP5Type import Permissions
+from Products.ERP5Type import PropertySheet
+from Products.ERP5Type.PropertySheet.CacheFactory import CacheFactory
+from Products.ERP5Type.XMLObject import XMLObject
+from Products.ERP5Type.Cache import CachingMethod
+
+class CacheFactory(XMLObject):
+  """
+  CacheFactory is a collection of cache plugins. CacheFactory is an object which lives in ZODB.
+  """
+    
+  meta_type = 'ERP5 Cache Factory'
+  portal_type = 'Cache Factory'
+  isPortalContent = 1 
+  isRADContent = 1
+  
+  allowed_types = ('ERP5 Ram Cache Plugin', 
+                   'ERP5 Distributed Ram Cache Plugin', 
+                   'ERP5 SQL Cache Plugin',
+                  )
+    
+  security = ClassSecurityInfo()
+  security.declareProtected(CMFCorePermissions.ManagePortal,
+                            'manage_editProperties',
+                            'manage_changeProperties',
+                            'manage_propertiesForm',
+                            )
+
+  property_sheets = ( PropertySheet.Base
+                    , PropertySheet.SimpleItem
+                    , PropertySheet.Folder
+                    , CacheFactory  
+                    )
+    
+       
+  def getCachePluginList(self):
+    """ get ordered list of installed cache plugins in ZODB """
+    cache_plugins = self.objectValues(self.allowed_types)
+    cache_plugins = map(None, cache_plugins)
+    cache_plugins.sort(lambda x,y: cmp(x.int_index, y.int_index))
+    return  cache_plugins
+    
+  security.declareProtected(Permissions.AccessContentsInformation, 'getRamCacheFactory')
+  def getRamCacheFactory(self):
+    """ Return RAM based cache factory """
+    erp5_site_id = self.getPortalObject().getId()
+    return CachingMethod.factories[erp5_site_id][self.cache_scope]
+    
+  security.declareProtected(Permissions.AccessContentsInformation, 'getRamCacheFactoryPluginList')
+  def getRamCacheFactoryPluginList(self):
+    """ Return RAM based list of cache plugins for this factory """
+    return self.getRamCacheFactory().getCachePluginList()
+  
+  def clearCache(self):
+    """ clear cache for this cache factory """
+    for cp in self.getRamCacheFactory().getCachePluginList():
+      cp.clearCache()

product/ERP5Type/Document/DistributedRamCachePlugin.py

+##############################################################################
+#
+# Copyright (c) 2005 Nexedi SARL and Contributors. All Rights Reserved.
+#                     Ivan Tyagov <ivan@nexedi.com>
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# garantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+from AccessControl import ClassSecurityInfo
+from Products.CMFCore import CMFCorePermissions
+from Products.ERP5Type.XMLObject import XMLObject
+from Products.ERP5Type import PropertySheet
+from Products.ERP5.PropertySheet.SortIndex import SortIndex
+from Products.ERP5Type.PropertySheet.BaseCachePlugin import BaseCachePlugin
+from Products.ERP5Type.PropertySheet.DistributedRamCachePlugin import DistributedRamCachePlugin
+
+class DistributedRamCachePlugin(XMLObject):
+  """
+  DistributedRamCachePlugin is a Zope (persistent) representation of 
+  the Distributed RAM Cache real cache plugin object.
+  """
+  
+  meta_type='ERP5 Distributed Ram Cache Plugin'
+  portal_type='Distributed Ram Cache Plugin'
+  isPortalContent = 1
+  isRADContent = 1
+  
+  allowed_types = ()
+    
+  security = ClassSecurityInfo()
+  security.declareProtected(CMFCorePermissions.ManagePortal,
+                            'manage_editProperties',
+                            'manage_changeProperties',
+                            'manage_propertiesForm',
+                            )
+
+  property_sheets = ( PropertySheet.Base
+                    , PropertySheet.SimpleItem
+                    , PropertySheet.Folder
+                    , BaseCachePlugin
+                    , SortIndex
+                    , DistributedRamCachePlugin 
+                    )

product/ERP5Type/Document/RamCachePlugin.py

+##############################################################################
+#
+# Copyright (c) 2005 Nexedi SARL and Contributors. All Rights Reserved.
+#                     Ivan Tyagov <ivan@nexedi.com>
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# garantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+
+from AccessControl import ClassSecurityInfo
+from Products.CMFCore import CMFCorePermissions
+from Products.ERP5Type.XMLObject import XMLObject
+from Products.ERP5Type import PropertySheet
+from Products.ERP5.PropertySheet.SortIndex import SortIndex
+from Products.ERP5Type.PropertySheet.BaseCachePlugin import BaseCachePlugin
+
+class RamCachePlugin(XMLObject):
+  """
+  RamCachePlugin is a Zope (persistent) representation of 
+  the RAM based real cache plugin object.
+  """
+  meta_type = 'ERP5 Ram Cache Plugin'
+  portal_type = 'Ram Cache Plugin'
+  isPortalContent = 1
+  isRADContent = 1
+  allowed_types = ()
+    
+  security = ClassSecurityInfo()
+  security.declareProtected(CMFCorePermissions.ManagePortal,
+                            'manage_editProperties',
+                            'manage_changeProperties',
+                            'manage_propertiesForm',
+                            )
+
+  property_sheets = ( PropertySheet.Base
+                    , PropertySheet.SimpleItem
+                    , PropertySheet.Folder
+                    , SortIndex
+                    , BaseCachePlugin 
+                    )

product/ERP5Type/Document/SQLCachePlugin.py

+##############################################################################
+#
+# Copyright (c) 2005 Nexedi SARL and Contributors. All Rights Reserved.
+#                     Ivan Tyagov <ivan@nexedi.com>
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# garantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+from AccessControl import ClassSecurityInfo
+from Products.CMFCore import CMFCorePermissions
+from Products.ERP5Type.Base import Base
+from Products.ERP5Type.XMLObject import XMLObject
+from Products.ERP5Type import PropertySheet
+from Products.ERP5.PropertySheet.SortIndex import SortIndex
+from Products.ERP5Type.PropertySheet.BaseCachePlugin import BaseCachePlugin
+from Products.ERP5Type.PropertySheet.SQLCachePlugin import SQLCachePlugin
+
+class SQLCachePlugin(XMLObject):
+  """
+  SQLCachePlugin is a Zope (persistent) representation of 
+  the RAM based real SQL cache plugin object.
+  """
+  
+  meta_type = 'ERP5 SQL Cache Plugin'
+  portal_type = 'SQL Cache Plugin'
+  isPortalContent = 1
+  isRADContent = 1
+  
+  allowed_types = ()
+    
+  security = ClassSecurityInfo()
+  security.declareProtected(CMFCorePermissions.ManagePortal,
+                            'manage_editProperties',
+                            'manage_changeProperties',
+                            'manage_propertiesForm',
+                            )
+
+  property_sheets = ( PropertySheet.Base
+                    , PropertySheet.SimpleItem
+                    , PropertySheet.Folder
+                    , BaseCachePlugin
+                    , SortIndex
+                    , SQLCachePlugin 
+                    )