TrashTool.py 7.3 KB
Newer Older
Aurel's avatar
Aurel committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Aurelien Calonne <aurel@nexedi.com>
Aurel's avatar
Aurel committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
#
# 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 Globals import InitializeClass, DTMLFile
from Products.ERP5Type.Tool.BaseTool import BaseTool
from Products.ERP5Type import Permissions
from Products.ERP5 import _dtmldir
35
from Products.ERP5.Document.BusinessTemplate import getChainByType
Aurel's avatar
Aurel committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
from zLOG import LOG
from DateTime import DateTime
from Acquisition import aq_base

class TrashTool(BaseTool):
  """
    TrashTool manage removed object from installation of BusinessTemplates
  """
  title = 'Trash Tool'
  id = 'portal_trash'
  meta_type = 'ERP5 Trash Tool'
  portal_type = 'Trash Tool'
  allowed_types = ('ERP5 Trash Bin',)

  # Declarative Security
  security = ClassSecurityInfo()
  
  security.declareProtected(Permissions.ManagePortal, 'manage_overview' )
Aurel's avatar
Aurel committed
54
  manage_overview = DTMLFile( 'explainTrashTool', _dtmldir )
Aurel's avatar
Aurel committed
55 56 57 58 59 60 61 62 63 64 65 66 67

  def backupObject(self, trashbin, container_path, object_id, save, **kw):
    """
      Backup an object in a trash bin
    """
#     LOG('Trash : backup object', 0, str((container_path, object_id)))
    if save:
      # recreate path of the backup object if necessary
      backup_object_container = trashbin
      for path in container_path:
        if 'portal' in path:
          path += '_items'
        if path not in backup_object_container.objectIds():
68
          backup_object_container = backup_object_container.newContent(portal_type='Trash Folder', id=path, is_indexable=0)
Aurel's avatar
Aurel committed
69 70 71 72 73 74
          backup_object_container.edit(isHidden=1)
        else:
          backup_object_container = backup_object_container._getOb(path)
      # backup the object
      # here we choose export/import to copy because cut/paste
      # do too many things and check for what we want to do
75
      obj = None
Aurel's avatar
Aurel committed
76 77 78
      if object_id not in backup_object_container.objectIds():
        # export object
        object_path = container_path + [object_id]
79 80
        obj = self.unrestrictedTraverse(object_path)
        copy = obj._p_jar.exportFile(obj._p_oid)
Aurel's avatar
Aurel committed
81 82
        # import object in trash
        connection = backup_object_container._p_jar
83
        o = backup_object_container
Aurel's avatar
Aurel committed
84
        while connection is None:
85 86
          o = o.aq_parent
          connection=o._p_jar
Aurel's avatar
Aurel committed
87 88
        copy.seek(0)
        backup = connection.importFile(copy)
Aurel's avatar
Aurel committed
89
        backup.isIndexable = 0
90 91 92 93 94 95 96 97
        try:
          backup_object_container._setObject(object_id, backup)
        except AttributeError:
          # XXX we can go here due to formulator because attribute field_added
          # doesn't not exists on parent if it is a Trash Folder and not a Form
          # so object is not backup
          LOG("Trash Tool backupObject", 100, "Can't backup object %s" %(object_id))
          pass
98
      # in case of portal types, export properties instead of subobjects
99
      if obj is None:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
100
        object_path = container_path + [object_id]
101
        obj = self.unrestrictedTraverse(object_path)
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
      if getattr(obj, 'meta_type', None) == 'ERP5 Type Information':
        subobjects_dict = {}
        subobjects_dict['allowed_content_type_list'] = getattr(obj, 'allowed_content_types', []) or []
        subobjects_dict['hidden_content_type_list'] = getattr(obj, 'hidden_content_type_list', []) or []
        subobjects_dict['property_sheet_list'] = getattr(obj, 'property_sheet_list', []) or []
        subobjects_dict['base_category_list'] = getattr(obj, 'base_category_list', []) or []
        subobjects_dict['roles_list'] =  getattr(obj, '_roles', []) or []
        action_list = obj.listActions() or []
        subobjects_dict['action_list'] = []
        for action in action_list:
          subobjects_dict['action_list'].append(action._getCopy(obj))
        wf_chain = getChainByType(self.getPortalObject())[1]
        if wf_chain.has_key(object_id):
          subobjects_dict['workflow_chain'] = wf_chain[object_id]
        else:
          subobjects_dict['workflow_chain'] = ''
        return subobjects_dict
Aurel's avatar
Aurel committed
119 120 121
        
    keep_sub = kw.get('keep_subobjects', 0)
    subobjects_dict = {}
122
    
Aurel's avatar
Aurel committed
123 124 125
    if not keep_sub:
      # export subobjects
      if save:
126
        obj = backup_object_container._getOb(object_id)
Aurel's avatar
Aurel committed
127 128
      else:
        object_path = container_path + [object_id]
129 130
        obj = self.unrestrictedTraverse(object_path)
      for subobject_id in list(obj.objectIds()):
Aurel's avatar
Aurel committed
131 132 133 134 135
        subobject_path = object_path + [subobject_id]
        subobject = self.unrestrictedTraverse(subobject_path)
        subobject_copy = subobject._p_jar.exportFile(subobject._p_oid)
        subobjects_dict[subobject_id] = subobject_copy
        if save: # remove subobjecs from backup object
136
          obj.manage_delObjects([subobject_id])
Aurel's avatar
Aurel committed
137 138 139 140 141 142 143
#     LOG('return subobject dict', 0, subobjects_dict)
    return subobjects_dict

  def newTrashBin(self, bt_title='trash', bt=None):
    """
      Create a new trash bin at upgrade of bt
    """
144
#     LOG('new Trash bin for', 0, bt_title)
Aurel's avatar
Aurel committed
145 146 147 148 149 150 151 152 153 154 155
    # construct date
    date = DateTime()
    start_date = date.strftime('%Y-%m-%d')
    # generate id
    trash_ids = self.objectIds()
    n = 0
    new_trash_id = bt_title+'_'+start_date
    while  new_trash_id in trash_ids:
      n = n + 1
      new_trash_id = '%s_%s' %(bt_title+'_'+start_date, n)
    # create trash bin
156
#     LOG('creating trash bin with id', 0, new_trash_id)
Aurel's avatar
Aurel committed
157
    trashbin = self.newContent(portal_type='Trash Bin', id=new_trash_id, title=bt_title, start_date=start_date, causality_value=bt)
158
#     LOG('trash item created', 0, trashbin)
Aurel's avatar
Aurel committed
159 160 161 162 163 164 165
    return trashbin
  

  def getTrashBinObjectsList(self, trashbin):
    """
      Return a list of trash objects for a given trash bin
    """
166
    def getChildObjects(obj):
Aurel's avatar
Aurel committed
167
      object_list = []
168 169 170 171 172
      if hasattr(aq_base(obj), 'objectValues'):
        childObjects = obj.objectValues()
      if hasattr(aq_base(obj), 'isHidden'):
        if not obj.isHidden:
          object_list.append(obj)
Aurel's avatar
Aurel committed
173
      if len(childObjects) > 0:
174 175
        for o in childObjects:
          object_list.extend(getChildObjects(o))          
Aurel's avatar
Aurel committed
176
      else:
177
        object_list.append(obj)
Aurel's avatar
Aurel committed
178 179 180 181 182 183 184 185 186
      return object_list
              
    list = getChildObjects(trashbin)
    list.sort()
    return list



InitializeClass(TrashTool)