TemplateTool.py 17.2 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets 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
#
# 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.
#
##############################################################################

29
from webdav.client import Resource
Jean-Paul Smets's avatar
Jean-Paul Smets committed
30 31
from Products.CMFCore.utils import UniqueObject

Yoshinori Okuji's avatar
Yoshinori Okuji committed
32
from App.config import getConfiguration
Aurel's avatar
Aurel committed
33
import os, tarfile, string, commands, OFS
Yoshinori Okuji's avatar
Yoshinori Okuji committed
34

35
from Acquisition import Implicit
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36
from AccessControl import ClassSecurityInfo
37
from Globals import InitializeClass, DTMLFile, PersistentMapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38
from Products.ERP5Type.Tool.BaseTool import BaseTool
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39
from Products.ERP5Type import Permissions
Aurel's avatar
Aurel committed
40
from Products.ERP5.Document.BusinessTemplate import TemplateConditionError
Aurel's avatar
Aurel committed
41
from tempfile import mkstemp
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42
from Products.ERP5 import _dtmldir
Aurel's avatar
Aurel committed
43 44 45
from OFS.Traversable import NotFound
from difflib import unified_diff
from cStringIO import StringIO
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46 47
from zLOG import LOG

48 49 50 51 52 53 54 55 56 57
class LocalConfiguration(Implicit):
  """
    Holds local configuration information
  """
  def __init__(self, **kw):
    self.__dict__.update(kw)

  def update(self, **kw):
    self.__dict__.update(kw)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
58
class TemplateTool (BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
59
    """
60
      TemplateTool manages Business Templates.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
61

62
      TemplateTool provides some methods to deal with Business Templates:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63

64
        - download
Jean-Paul Smets's avatar
Jean-Paul Smets committed
65

66
        - publish
Jean-Paul Smets's avatar
Jean-Paul Smets committed
67

68
        - install
Jean-Paul Smets's avatar
Jean-Paul Smets committed
69

70
        - update
Jean-Paul Smets's avatar
Jean-Paul Smets committed
71

72
        - save
Jean-Paul Smets's avatar
Jean-Paul Smets committed
73 74 75
    """
    id = 'portal_templates'
    meta_type = 'ERP5 Template Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
76
    portal_type = 'Template Tool'
77
    allowed_types = ( 'ERP5 Business Template',)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
78 79 80 81 82 83 84

    # Declarative Security
    security = ClassSecurityInfo()

    security.declareProtected( Permissions.ManagePortal, 'manage_overview' )
    manage_overview = DTMLFile( 'explainRuleTool', _dtmldir )

85 86 87 88 89 90 91 92 93 94 95 96
    def getInstalledBusinessTemplate(self, title, **kw):
      """
        Return a installed business template if any.
      """
      # This can be slow if, say, 10000 business templates are present.
      # However, that unlikely happens, and using a Z SQL Method has a potential danger
      # because business templates may exchange catalog methods, so the database could be
      # broken temporarily.
      for bt in self.contentValues(filter={'portal_type':'Business Template'}):
        if bt.getInstallationState() == 'installed' and bt.getTitle() == title:
          return bt
      return None
97

98 99
    # Import a business template
    def importURL(self, url):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
100
      """
101
        Import a business template
Jean-Paul Smets's avatar
Jean-Paul Smets committed
102
      """
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
      # Copy it to import directory
      # and import in self

    def updateLocalConfiguration(self, template, **kw):
      template_id = template.getId()
      if not hasattr(self, '_local_configuration'): self._local_configuration = PersistentMapping()
      if not self._local_configuration.has_key(template_id):
        self._local_configuration[template_id] = LocalConfiguration(**kw)
      else:
        self._local_configuration[template_id].update(**kw)

    def getLocalConfiguration(self, template):
      template_id = template.getId()
      if not hasattr(self, '_local_configuration'): self._local_configuration = PersistentMapping()
      local_configuration = self._local_configuration.get(template_id, None)
      if local_configuration is not None:
        return local_configuration.__of__(self)
      return None

122 123
    security.declareProtected( 'Import/Export objects', 'save' )
    def save(self, business_template, REQUEST=None, RESPONSE=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
124
      """
Aurel's avatar
Aurel committed
125
        Save BT in folder format
Yoshinori Okuji's avatar
Yoshinori Okuji committed
126 127
      """
      cfg = getConfiguration()
Aurel's avatar
Aurel committed
128 129
      path = os.path.join(cfg.clienthome, '%s' % (business_template.getTitle(),))
      business_template.export(path=path, local=1)
130 131 132 133 134 135 136 137 138
      if REQUEST is not None:
        ret_url = business_template.absolute_url() + '/' + REQUEST.get('form_id', 'view')
        qs = '?portal_status_message=Saved+in+%s+.' % path
        if RESPONSE is None: RESPONSE = REQUEST.RESPONSE
        return REQUEST.RESPONSE.redirect( ret_url + qs )

    security.declareProtected( 'Import/Export objects', 'export' )
    def export(self, business_template, REQUEST=None, RESPONSE=None):
      """
Aurel's avatar
Aurel committed
139
        Export BT in tarball format 
140
      """
141
      path = business_template.getTitle()
142 143
      tmpfile_path = os.tmpnam()
      tmpdir_path = os.path.dirname(tmpfile_path)
144 145
      current_directory = os.getcwd()
      os.chdir(tmpdir_path)
Aurel's avatar
Aurel committed
146
      export_string = business_template.export(path=path)
147
      os.chdir(current_directory)
148
      if RESPONSE is not None:
149
        RESPONSE.setHeader('Content-type','tar/x-gzip')
150
        RESPONSE.setHeader('Content-Disposition',
151 152 153
                           'inline;filename=%s-%s.bt5' % \
                               (business_template.getTitle(), 
                                business_template.getVersion()))
Aurel's avatar
Aurel committed
154 155 156 157
      try:
        return export_string.getvalue()
      finally:
        export_string.close()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
158

159 160 161 162 163 164 165
    def publish(self, business_template, url, username=None, password=None):
      """
        Publish in a format or another
      """
      business_template.build()
      export_string = self.manage_exportObject(id=business_template.getId(), download=1)
      bt = Resource(url, username=username, password=password)
166
      bt.put(file=export_string, content_type='application/x-erp5-business-template')
167
      business_template.setPublicationUrl(url)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
168

169 170 171 172 173 174 175 176 177
    def update(self, business_template):
      """
        Update an existing template
      """
      url = business_template.getPublicationUrl()
      id = business_template.getId()
      bt = Resource(url)
      export_string = bt.get().get_body()
      self.deleteContent(id)
Aurel's avatar
Aurel committed
178
      self._importObjectFromFile(StringIO(export_string), id=id)
179

Aurel's avatar
Aurel committed
180 181 182 183 184 185 186 187 188 189 190 191 192
    def _importBT(self, path=None, id=id):
      """
        Import template from a temp file
      """
      file = open(path, 'r')
      # read magic key to determine wich kind of bt we use
      file.seek(0)
      magic = file.read(5)
      file.close()
      if magic == '<?xml': # old version
        self._importObjectFromFile(path, id=id)
        bt = self[id]
        bt.id = id # Make sure id is consistent
193
        bt.setProperty('template_format_version', 0, type='int')
Aurel's avatar
Aurel committed
194 195 196 197 198
      else: # new version
        tar = tarfile.open(path, 'r:gz')
        # create bt object
        self.newContent(portal_type='Business Template', id=id)
        bt = self._getOb(id)
199
        prop_dict = {}
Aurel's avatar
Aurel committed
200 201 202
        for prop in bt.propertyMap():
          type = prop['type']
          pid = prop['id']
203
          prop_path = os.path.join(tar.members[0].name, 'bt', pid)
204 205 206 207
          try:
            info = tar.getmember(prop_path)
          except KeyError:
            continue
Aurel's avatar
Aurel committed
208 209
          value = tar.extractfile(info).read()
          if type == 'text' or type == 'string' or type == 'int':
210
            prop_dict[pid] = value
Aurel's avatar
Aurel committed
211
          elif type == 'lines' or type == 'tokens':
212
            prop_dict[pid[:-5]] = value.split(str(os.linesep))
213
        prop_dict.pop('id', '')
214
        bt.edit(**prop_dict)
Aurel's avatar
Aurel committed
215 216 217 218 219 220 221 222
        # import all other files from bt
        fobj = open(path, 'r')
        bt.importFile(file=fobj)
        fobj.close()
        tar.close()
      os.remove(path)
      return bt

Jean-Paul Smets's avatar
Jean-Paul Smets committed
223
    def download(self, url, id=None, REQUEST=None):
224
      """
Aurel's avatar
Aurel committed
225
        Download Business template, can be file or local directory
226
      """
227 228
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
229 230 231
      from urllib import splittype, urlretrieve

      type, name = splittype(url)
Aurel's avatar
Aurel committed
232
      if os.path.isdir(name): # new version of business template in plain format (folder)
233 234 235 236 237 238
        file_list = []
        def callback(arg, directory, files):
          for file in files:
            file_list.append(os.path.join(directory, file))

        os.path.walk(name, callback, None)        
Aurel's avatar
Aurel committed
239 240 241 242 243 244 245
        file_list.sort()
        # import bt object
        self.newContent(portal_type='Business Template', id=id)
        bt = self._getOb(id)
        bt_path = os.path.join(name, 'bt')

        # import properties
246
        prop_dict = {}
Aurel's avatar
Aurel committed
247 248 249
        for prop in bt.propertyMap():
          type = prop['type']
          pid = prop['id']
250 251 252
          prop_path = os.path.join('.', bt_path, pid)
          if not os.path.exists(prop_path):
            continue          
Aurel's avatar
Aurel committed
253
          value = open(prop_path, 'r').read()
254
          if type in ('text', 'string', 'int'):
255
            prop_dict[pid] = value
256
          elif type in ('lines', 'tokens'):
257
            prop_dict[pid[:-5]] = value.split(str(os.linesep))
258
        prop_dict.pop('id', '')
259
        bt.edit(**prop_dict)
Aurel's avatar
Aurel committed
260 261 262 263 264 265
        # import all others objects
        bt.importFile(dir=1, file=file_list, root_path=name)
      else:
        tempid, temppath = mkstemp()      
        file, headers = urlretrieve(url, temppath)
        bt = self._importBT(temppath, id)
266
      bt.build(no_action=1)
267
      bt.reindexObject()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
268 269 270 271

      if REQUEST is not None:
        REQUEST.RESPONSE.redirect("%s?portal_status_message=Business+Template+Downloaded+Successfully"
                           % self.absolute_url())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
272

Alexandre Boeglin's avatar
Alexandre Boeglin committed
273
    def importFile(self, import_file=None, id=None, REQUEST=None, **kw):
274
      """
Aurel's avatar
Aurel committed
275
        Import Business template from one file
276
      """
277 278 279
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
        
Alexandre Boeglin's avatar
Alexandre Boeglin committed
280 281 282 283 284 285 286
      if (import_file is None) or (len(import_file.read()) == 0) :
        if REQUEST is not None :
          REQUEST.RESPONSE.redirect("%s?portal_status_message=No+file+or+an+empty+file+was+specified"
              % self.absolute_url())
          return
        else :
          raise 'Error', 'No file or an empty file was specified'
Aurel's avatar
Aurel committed
287
      # copy to a temp location
Alexandre Boeglin's avatar
Alexandre Boeglin committed
288
      import_file.seek(0) #Rewind to the beginning of file
289 290
      tempid, temppath = mkstemp()
      tempfile = open(temppath, 'w')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
291
      tempfile.write(import_file.read())
292
      tempfile.close()
293 294
      bt = self._importBT(temppath, id)
      bt.build(no_action=1)
Aurel's avatar
Aurel committed
295
      bt.reindexObject()
296 297

      if REQUEST is not None:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
298
        REQUEST.RESPONSE.redirect("%s?portal_status_message=Business+Template+Imported+Successfully"
299 300
                           % self.absolute_url())

301 302 303 304 305 306 307 308
    def runUnitTestList(self, test_list=[], **kwd) :
      """
        Runs Unit Tests related to this Business Template
      """
      
      from Products.ERP5Type.tests.runUnitTest import getUnitTestFile
      return os.popen('/usr/bin/python %s %s 2>&1' % (getUnitTestFile(), ' '.join(test_list))).read()

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
    security.declareProtected(Permissions.DeletePortalContent, 'deleteBackupObjects')

    def deleteBackupObjects(self, dry_run=1) :
      """
      removes 'btsave' objects from the ZODB
      """
      import re
      backup_re = re.compile('_btsave_[0-9]+$')
      backup_list = []

      portal = self.getPortalObject()
      for module in portal.objectValues() :
        if backup_re.search(module.getId()) :
          backup_list.append((module.getId(), portal))
        else :
          for oid in module.objectIds() :
            if backup_re.search(oid) :
              backup_list.append((oid, module))
      if dry_run :
        return '\n'.join(['%s in %s' % e for e in backup_list])
      else :
        for oid, module in backup_list :
          module.manage_delObjects(oid)

Aurel's avatar
Aurel committed
333 334 335 336 337 338 339 340 341 342 343 344 345
    def diff(self, **kw):
      """
      Make a diff between two Business Template
      """
      compare_to_installed = 0
      # get the business template      
      p = self.getPortalObject()
      portal_selections = p.portal_selections
      selection_name = 'business_template_selection' # harcoded because we can also get delete_selection
      uids = portal_selections.getSelectionCheckedUidsFor(selection_name)
      bt1 = self.portal_catalog.getObject(uids[0])
      if bt1.getBuildingState() != 'built':
        raise TemplateConditionError, 'Business Template must be built to make diff'
346 347
      if (getattr(bt1, 'template_format_version', 0)) != 1:
        raise TemplateConditionError, 'Business Template must be in new format'
Aurel's avatar
Aurel committed
348 349 350 351 352
      # check if there is a second bt is or if we compare to installed one
      if len(uids) == 2:
        bt2 = self.portal_catalog.getObject(uids[1])
        if bt2.getBuildingState() != 'built':
          raise TemplateConditionError, 'Business Template must be built to make diff'
353 354
        if (getattr(bt2, 'template_format_version', 0)) != 1:
          raise TemplateConditionError, 'Business Template must be in new format'
Aurel's avatar
Aurel committed
355 356 357 358
      else:
        compare_to_installed = 1
        installed_bt = self.getInstalledBusinessTemplate(title=bt1.getTitle())
        if installed_bt is None:
359
          raise NotFound, 'Installed business template with title %s not found' %(bt1.getTitle(),)
Aurel's avatar
Aurel committed
360
        LOG('compare to installed bt', 0, str((installed_bt.getTitle(), installed_bt.getId())))
Aurel's avatar
Aurel committed
361 362 363
        # get a copy of the installed bt
        bt2 = self.manage_clone(ob=installed_bt, id='installed_bt')
        bt2.edit(description='tmp bt generated for diff')
364 365
        
      # separate item because somes are exported with zope exportXML and other with our own method
366
      # and others are just python code on filesystem
Aurel's avatar
Aurel committed
367
      diff_msg = 'Diff between %s-%s and %s-%s' %(bt1.getTitle(), bt1.getId(), bt2.getTitle(), bt2.getId())
368 369 370
      # for the one with zope exportXml
      item_list_1 = ['_product_item', '_workflow_item', '_portal_type_item', '_category_item', '_path_item', '_skin_item', '_action_item']
      for item_name  in item_list_1:
Aurel's avatar
Aurel committed
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
        item1 = getattr(bt1, item_name)        
        # build current item if we compare to installed bt
        if compare_to_installed:
          getattr(bt2, item_name).build(bt2)
        item2 = getattr(bt2, item_name)
        for key in  item1._objects.keys():
          if item2._objects.has_key(key):
            object1 = item1._objects[key]
            object2 = item2._objects[key]
            f1 = StringIO()
            f2 = StringIO()
            OFS.XMLExportImport.exportXML(object1._p_jar, object1._p_oid, f1)
            OFS.XMLExportImport.exportXML(object2._p_jar, object2._p_oid, f2)
            obj1_xml = f1.getvalue()
            obj2_xml = f2.getvalue()
            f1.close()
            f2.close()
            ob1_xml_lines = obj1_xml.splitlines()
            ob2_xml_lines = obj2_xml.splitlines()
            diff_list = list(unified_diff(ob1_xml_lines, ob2_xml_lines, fromfile=bt1.getId(), tofile=bt2.getId(), lineterm=''))
            if len(diff_list) != 0:
              diff_msg += '\n\nObject %s diff :\n' %(key)
              diff_msg += '\n'.join(diff_list)
394
      # for our own way to generate xml
395
      item_list_2 = ['_site_property_item', '_module_item', '_catalog_result_key_item', '_catalog_related_key_item', '_catalog_result_table_item']
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
      for item_name  in item_list_2:
        item1 = getattr(bt1, item_name)        
        # build current item if we compare to installed bt
        if compare_to_installed:
          getattr(bt2, item_name).build(bt2)
        item2 = getattr(bt2, item_name)
        for key in  item1._objects.keys():
          if item2._objects.has_key(key):
            obj1_xml = item1.generate_xml(path=key)
            obj2_xml = item2.generate_xml(path=key)
            ob1_xml_lines = obj1_xml.splitlines()
            ob2_xml_lines = obj2_xml.splitlines()
            diff_list = list(unified_diff(ob1_xml_lines, ob2_xml_lines, fromfile=bt1.getId(), tofile=bt2.getId(), lineterm=''))
            if len(diff_list) != 0:
              diff_msg += '\n\nObject %s diff :\n' %(key)
              diff_msg += '\n'.join(diff_list)
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430

      # for document located on filesystem
      item_list_3 = ['_document_item', '_property_sheet_item', '_extension_item', '_test_item']
      for item_name  in item_list_3:
        item1 = getattr(bt1, item_name)        
        # build current item if we compare to installed bt
        if compare_to_installed:
          getattr(bt2, item_name).build(bt2)
        item2 = getattr(bt2, item_name)
        for key in  item1._objects.keys():
          if item2._objects.has_key(key):
            obj1_code = item1._objects[key]
            obj2_code = item2._objects[key]
            ob1_lines = obj1_code.splitlines()
            ob2_lines = obj2_code.splitlines()
            diff_list = list(unified_diff(ob1_lines, ob2_lines, fromfile=bt1.getId(), tofile=bt2.getId(), lineterm=''))
            if len(diff_list) != 0:
              diff_msg += '\n\nObject %s diff :\n' %(key)
              diff_msg += '\n'.join(diff_list)
431
              
Aurel's avatar
Aurel committed
432 433 434 435
      if compare_to_installed:
        self.manage_delObjects(ids=['installed_bt'])
      return diff_msg
          
Jean-Paul Smets's avatar
Jean-Paul Smets committed
436
InitializeClass(TemplateTool)