TemplateTool.py 63 KB
Newer Older
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3 4
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# 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.
#
##############################################################################

30 31 32 33
try:
  from webdav.client import Resource
except ImportError: # six.PY3, Zope4
  from webdav.Resource import Resource
34
from past.builtins import cmp
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35

Yoshinori Okuji's avatar
Yoshinori Okuji committed
36
from App.config import getConfiguration
37
import os
38
import shutil
39
import sys
40
import six
Yoshinori Okuji's avatar
Yoshinori Okuji committed
41

42
from Acquisition import Implicit, Explicit
Jean-Paul Smets's avatar
Jean-Paul Smets committed
43
from AccessControl import ClassSecurityInfo
44
from AccessControl.SecurityInfo import ModuleSecurityInfo
45
from Products.CMFActivity.ActiveResult import ActiveResult
46
from Products.ERP5Type.Globals import InitializeClass, DTMLFile, PersistentMapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
47
from Products.ERP5Type.Tool.BaseTool import BaseTool
48
from Products.ERP5Type.Cache import transactional_cached
49
from Products.ERP5Type import Permissions
50
from Products.ERP5.Document.BusinessTemplate import BusinessTemplateMissingDependency
51
from Products.ERP5.genbt5list import generateInformation
52
from Acquisition import aq_base
53
from tempfile import mkstemp, mkdtemp
Jean-Paul Smets's avatar
Jean-Paul Smets committed
54
from Products.ERP5 import _dtmldir
55 56 57 58 59 60 61 62
from six.moves import xrange
from six.moves import cStringIO as StringIO
from six.moves.urllib.request import pathname2url, urlopen, urlretrieve
try:
  from urllib import splittype
except ImportError: # six.PY3
  from urllib.parse import splittype
from six.moves import urllib
63 64
import re
from xml.dom.minidom import parse
65
from xml.parsers.expat import ExpatError
66
import struct
67
from six.moves import cPickle as pickle
68
from base64 import b64encode, b64decode
69
from Products.ERP5Type.Message import translateString
70
from zLOG import LOG, INFO, WARNING
71
from base64 import decodestring
72
import subprocess
73
import time
74
from Products.ERP5Type.Utils import bytes2str
Jean-Paul Smets's avatar
Jean-Paul Smets committed
75

76
WIN = os.name == 'nt'
77

78 79
CATALOG_UPDATABLE = object()
ModuleSecurityInfo(__name__).declarePublic('CATALOG_UPDATABLE')
80

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
class BusinessTemplateUnknownError(Exception):
  """ Exception raised when the business template
      is impossible to find in the repositories
  """
  pass

class UnsupportedComparingOperator(Exception):
  """ Exception when the comparing string is unsupported
  """
  pass

class BusinessTemplateIsMeta(Exception):
  """ Exception when the business template is provided by another one
  """
  pass

97 98
ModuleSecurityInfo(__name__).declarePublic('BusinessTemplateUnknownError')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
99
class TemplateTool (BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
100
    """
101
      TemplateTool manages Business Templates.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
102

103 104 105 106 107 108
      TemplateTool provides some methods to deal with Business Templates:
        - download
        - publish
        - install
        - update
        - save
Jean-Paul Smets's avatar
Jean-Paul Smets committed
109 110 111
    """
    id = 'portal_templates'
    meta_type = 'ERP5 Template Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
112
    portal_type = 'Template Tool'
113
    title = 'Business Templates'
Rafael Monnerat's avatar
Rafael Monnerat committed
114
    allowed_types = ('ERP5 Business Template', )
115

116 117
    # This stores information on repositories.
    repository_dict = {}
Jean-Paul Smets's avatar
Jean-Paul Smets committed
118 119 120 121

    # Declarative Security
    security = ClassSecurityInfo()

Rafael Monnerat's avatar
Rafael Monnerat committed
122 123
    security.declareProtected(Permissions.ManagePortal, 'manage_overview')
    manage_overview = DTMLFile('explainTemplateTool', _dtmldir)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
124

125 126
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getInstalledBusinessTemplate')
127
    def getInstalledBusinessTemplate(self, title, strict=False, **kw):
128
      """Returns an installed version of business template of a given title.
129

130
        Returns None if business template is not installed or has been uninstalled.
131 132
        It not "installed" business template is found, look at replaced ones.
        This is mostly usefull if we are looking for the installed business
133 134
        template in a transaction replacing an existing business template.
        If strict is true, we do not take care of "replaced" business templates.
135 136
      """
      # This can be slow if, say, 10000 business templates are present.
Vincent Pelletier's avatar
Vincent Pelletier committed
137 138 139
      # 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.
140 141
      last_bt = last_time = None
      for bt in self.objectValues(portal_type='Business Template'):
142
        if bt.getTitle() == title or title in bt.getProvisionList():
143 144 145
          state = bt.getInstallationState()
          if state == 'installed':
            return bt
146 147 148 149 150 151 152 153 154
          if state == 'not_installed':
            last_transition = bt.workflow_history \
              ['business_template_installation_workflow'][-1]
            if last_transition['action'] == 'uninstall': # There is not uninstalled state !
              t = last_transition['time']
              if last_time < t:
                last_bt = None
                last_time = t
          elif state == 'replaced' and not strict:
155 156 157 158 159 160
            t = bt.workflow_history \
              ['business_template_installation_workflow'][-1]['time']
            if last_time < t:
              last_bt = bt
              last_time = t
      return last_bt
161

162 163
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getInstalledBusinessTemplatesList')
164
    def getInstalledBusinessTemplatesList(self):
165 166 167 168 169
      """Deprecated.
      """
      DeprecationWarning('getInstalledBusinessTemplatesList is deprecated; Use getInstalledBusinessTemplateList instead.', DeprecationWarning)
      return self.getInstalledBusinessTemplateList()

170
    def _getInstalledBusinessTemplateList(self, only_title=0):
171
      """Get the list of installed business templates.
172 173
      """
      installed_bts = []
174
      for bt in self.contentValues(portal_type='Business Template'):
175
        if bt.getInstallationState() == 'installed':
176 177 178 179
          bt5 = bt
          if only_title:
            bt5 = bt.getTitle()
          installed_bts.append(bt5)
180
      return installed_bts
181

182 183
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getInstalledBusinessTemplateList')
184 185 186 187 188
    def getInstalledBusinessTemplateList(self):
      """Get the list of installed business templates.
      """
      return self._getInstalledBusinessTemplateList(only_title=0)

189 190
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getInstalledBusinessTemplateTitleList')
191 192 193 194 195
    def getInstalledBusinessTemplateTitleList(self):
      """Get the list of installed business templates.
      """
      return self._getInstalledBusinessTemplateList(only_title=1)

196 197
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getInstalledBusinessTemplateRevision')
198 199 200 201 202 203
    def getInstalledBusinessTemplateRevision(self, title, **kw):
      """
        Return the revision of business template installed with the title
        given
      """
      bt = self.getInstalledBusinessTemplate(title)
204 205 206
      if bt is not None:
        return bt.getRevision()
      return None
207

208 209
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getBuiltBusinessTemplateList')
210 211
    def getBuiltBusinessTemplateList(self):
      """Get the list of built and not installed business templates.
212
      """
213 214 215
      return [bt for bt in self.objectValues(portal_type='Business Template')
                 if bt.getInstallationState() == 'not_installed' and
                    bt.getBuildingState() == 'built']
216

217 218 219 220 221 222
    @property
    def asRepository(self):
      class asRepository(Explicit):
        """Export business template by their title

        Provides a view of template tool allowing a user to download the last
223
        edited business template with a URL like:
224 225 226 227 228 229 230 231 232 233 234
          http://.../erp5/portal_templates/asRepository/erp5_core
        """
        def __before_publishing_traverse__(self, self2, request):
          path = request['TraversalRequestNameStack']
          self.subpath = tuple(reversed(path))
          del path[:]
        def __call__(self, REQUEST, RESPONSE):
          title, = self.subpath
          last_bt = None, None
          for bt in self.aq_parent.searchFolder(title=title):
            bt = bt.getObject()
235 236 237
            modified = bt.getModificationDate()
            if last_bt[0] < modified and bt.getInstallationState() != 'deleted':
              last_bt = modified, bt
238 239 240 241 242 243 244 245 246 247 248
          if last_bt[1] is None:
            return RESPONSE.notFoundError(title)
          RESPONSE.setHeader('Content-type', 'application/data')
          RESPONSE.setHeader('Content-Disposition',
                             'inline;filename=%s-%s.zexp' % (title, last_bt[0]))
          if REQUEST['REQUEST_METHOD'] == 'GET':
            bt = last_bt[1]
            if bt.getBuildingState() != 'built':
              bt.build()
            return self.aq_parent.manage_exportObject(bt.getId(), download=1)
      return asRepository().__of__(self)
249

250
    security.declareProtected(Permissions.ManagePortal,
251 252
                              'getDefaultBusinessTemplateDownloadURL')
    def getDefaultBusinessTemplateDownloadURL(self):
253 254 255 256 257
      """Returns the default download URL for business templates.
      """
      return "file://%s/" % pathname2url(
                  os.path.join(getConfiguration().instancehome, 'bt5'))

Rafael Monnerat's avatar
Rafael Monnerat committed
258
    security.declareProtected('Import/Export objects', 'save')
259
    def save(self, business_template, REQUEST=None, RESPONSE=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
260
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
261
        Save the BusinessTemplate in the servers's filesystem.
Yoshinori Okuji's avatar
Yoshinori Okuji committed
262 263
      """
      cfg = getConfiguration()
Vincent Pelletier's avatar
Vincent Pelletier committed
264 265
      path = os.path.join(cfg.clienthome,
                          '%s' % (business_template.getTitle(),))
266
      path = pathname2url(path)
267
      business_template.export(path=path, local=True)
268
      if REQUEST is not None:
269
        psm = translateString('Saved in ${path} .',
270
                              mapping={'path':pathname2url(path)})
271
        ret_url = '%s/%s?portal_status_message=%s' % \
Vincent Pelletier's avatar
Vincent Pelletier committed
272
                  (business_template.absolute_url(),
273
                   REQUEST.get('form_id', 'view'), psm)
Vincent Pelletier's avatar
Vincent Pelletier committed
274 275 276
        if RESPONSE is None:
          RESPONSE = REQUEST.RESPONSE
        return REQUEST.RESPONSE.redirect( ret_url )
277 278 279 280

    security.declareProtected( 'Import/Export objects', 'export' )
    def export(self, business_template, REQUEST=None, RESPONSE=None):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
281 282
        Export the Business Template as a bt5 file and offer the user to
        download it.
283
      """
284
      export_string = business_template.export()
Aurel's avatar
Aurel committed
285
      try:
286 287 288 289
        if RESPONSE is not None:
          RESPONSE.setHeader('Content-type','tar/x-gzip')
          RESPONSE.setHeader('Content-Disposition', 'inline;filename=%s-%s.bt5'
            % (business_template.getTitle(), business_template.getVersion()))
Aurel's avatar
Aurel committed
290 291 292
        return export_string.getvalue()
      finally:
        export_string.close()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
293

294
    security.declareProtected( 'Import/Export objects', 'publish' )
295 296
    def publish(self, business_template, url, username=None, password=None):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
297
        Publish the given business template at the given URL.
298
      """
299
      if six.PY3:
300
        raise NotImplementedError("XXX-zope4py3")
301

302
      business_template.build()
Vincent Pelletier's avatar
Vincent Pelletier committed
303
      export_string = self.manage_exportObject(id=business_template.getId(),
304
                                               download=True)
305
      bt = Resource(url, username=username, password=password)
Vincent Pelletier's avatar
Vincent Pelletier committed
306 307
      bt.put(file=export_string,
             content_type='application/x-erp5-business-template')
308
      business_template.setPublicationUrl(url)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
309

310
    security.declareProtected(Permissions.ManagePortal, 'update')
311 312
    def update(self, business_template):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
313
        Update an existing template from its publication URL.
314
      """
315
      if six.PY3:
316
        raise NotImplementedError("XXX-zope4py3")
317

318 319 320 321 322
      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
323
      self._importObjectFromFile(StringIO(export_string), id=id)
324

325
    security.declareProtected( Permissions.ManagePortal, 'manage_download' )
326 327
    def manage_download(self, url, id=None, REQUEST=None):
      """The management interface for download.
328
      """
329 330
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
331

332
      bt = self.download(url, id=id)
333

334
      if REQUEST is not None:
335
        ret_url = bt.absolute_url()
Yusei Tahara's avatar
Yusei Tahara committed
336
        psm = translateString("Business template downloaded successfully.")
337
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
338
                                    % (ret_url, psm))
339

340 341 342
    def _download_local(self, path, bt_id):
      """Download Business Template from local directory or file
      """
343 344
      bt = self.newContent(bt_id, 'Business Template')
      bt.importFile(path)
345
      return bt
346 347 348 349

    def _download_url(self, url, bt_id):
      tempid, temppath = mkstemp()
      try:
350
        os.close(tempid) # Close the opened fd as soon as possible.
351
        file_path, headers = urlretrieve(url, temppath)
352
        if re.search(r'<title>.*Revision \d+:', open(file_path, 'r').read()):
353 354 355
          # this looks like a subversion repository, try to check it out
          LOG('ERP5', INFO, 'TemplateTool doing a svn checkout of %s' % url)
          return self._download_svn(url, bt_id)
Rafael Monnerat's avatar
Rafael Monnerat committed
356

357 358 359 360 361
        return self._download_local(file_path, bt_id)
      finally:
        os.remove(temppath)

    def _download_svn(self, url, bt_id):
362 363 364 365 366
      try:
        from erp5.component.module.WorkingCopy import getVcsTool
      except ImportError:
        raise RuntimeError("VCS features require 'erp5_forge' bt5")

367 368 369
      svn_checkout_tmp_dir = mkdtemp()
      svn_checkout_dir = os.path.join(svn_checkout_tmp_dir, 'bt')
      try:
370
        getVcsTool('svn').__of__(self).export(url, svn_checkout_dir)
371 372 373 374 375 376 377 378 379 380 381 382 383
        return self._download_local(svn_checkout_dir, bt_id)
      finally:
        shutil.rmtree(svn_checkout_tmp_dir)

    security.declareProtected( 'Import/Export objects', 'download' )
    def download(self, url, id=None, REQUEST=None):
      """
      Download Business Template from url, can be file or local directory
      """
      # For backward compatibility: If REQUEST is passed, it is likely that we
      # come from the management interface.
      if REQUEST is not None:
        return self.manage_download(url, id=id, REQUEST=REQUEST)
384

385 386 387
      if id is None:
        id = self.generateNewId()

388 389
      urltype, path = splittype(url)
      if WIN and urltype and '\\' in path:
390
        urltype = None
391
        path = url
392
      if urltype and urltype != 'file':
393
        if '/portal_templates/asRepository/' in url:
394 395 396 397 398
          # In this case, the downloaded BT is already built.
          bt = self._p_jar.importFile(urlopen(url))
          bt.id = id
          del bt.uid
          return self[self._setObject(id, bt)]
399 400
        bt = self._download_url(url, id)
      else:
401 402
        path = os.path.normpath(os.path.expanduser(path))
        bt = self._download_local(path, id)
403

404
      bt.build(no_action=True)
405
      return bt
Jean-Paul Smets's avatar
Jean-Paul Smets committed
406

407
    security.declareProtected('Import/Export objects', 'importBase64EncodedText')
408
    def importBase64EncodedText(self, file_data=None, id=None, REQUEST=None,
409
                                batch_mode=False, **kw):
410
      """
411 412 413
        Import Business Template from passed base64 encoded text.
      """
      import_file = StringIO(decodestring(file_data))
414
      return self.importFile(import_file = import_file, id = id, REQUEST = REQUEST,
415 416
                             batch_mode = batch_mode, **kw)

417
    security.declareProtected('Import/Export objects', 'importFile')
418
    def importFile(self, import_file=None, id=None, REQUEST=None,
419
                   batch_mode=False, **kw):
420
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
421
        Import Business Template from one file
422
      """
423 424
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
425

426 427 428 429 430
      if id is None:
        id = self.generateNewId()

      if (import_file is None) or (len(import_file.read()) == 0):
        if REQUEST is not None:
Yusei Tahara's avatar
Yusei Tahara committed
431
          psm = translateString('No file or an empty file was specified.')
432 433
          REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                    % (self.absolute_url(), psm))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
434 435
          return
        else :
436
          raise RuntimeError('No file or an empty file was specified')
Aurel's avatar
Aurel committed
437
      # copy to a temp location
Alexandre Boeglin's avatar
Alexandre Boeglin committed
438
      import_file.seek(0) #Rewind to the beginning of file
439
      tempid, temppath = mkstemp()
440 441
      try:
        os.close(tempid) # Close the opened fd as soon as possible
442
        with open(temppath, 'wb') as tempfile:
443
          tempfile.write(import_file.read())
444
        bt = self._download_local(temppath, id)
445 446
      finally:
        os.remove(temppath)
447
      bt.build(no_action=True)
Aurel's avatar
Aurel committed
448
      bt.reindexObject()
449

450
      if not batch_mode and \
451
         (REQUEST is not None):
452
        ret_url = bt.absolute_url()
Yusei Tahara's avatar
Yusei Tahara committed
453
        psm = translateString("Business templates imported successfully.")
454 455
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                  % (ret_url, psm))
456
      elif batch_mode:
457
        return bt
458

459
    security.declareProtected(Permissions.ManagePortal, 'getDiffFilterScriptList')
460 461 462 463
    def getDiffFilterScriptList(self):
      """
      Return list of scripts usable to filter diff
      """
464
      # XXX, the "or ()" should not be there, the preference tool is
465 466
      # inconsistent, the called method should not return None when
      # nothing is selected
467
      portal = self.getPortalObject()
468 469 470 471 472 473 474 475
      script_list = []
      for script_id in portal.portal_preferences\
         .getPreferredDiffFilterScriptIdList() or ():
        try:
          script_list.append(getattr(portal, script_id))
        except AttributeError:
          LOG("TemplateTool", WARNING, "Unable to find %r script" % script_id)
      return script_list
476

477
    security.declareProtected(Permissions.ManagePortal, 'getFilteredDiffAsHTML')
478 479 480 481 482 483
    def getFilteredDiffAsHTML(self, diff):
      """
      Return the diff filtered by python scripts into html format
      """
      return self.getFilteredDiff(diff).toHTML()

484
    def _cleanUpTemplateFolder(self, folder_path):
485 486
      file_object_list = [x for x in os.listdir(folder_path)]
      for file_object in file_object_list:
487 488 489 490 491 492
        file_object_path = os.path.join(folder_path, file_object)
        if os.path.isfile(file_object_path):
          os.unlink(file_object_path)
        else:
          shutil.rmtree(file_object_path)

493 494
    security.declareProtected( 'Import/Export objects', 'importAndReExportBusinessTemplateFromPath' )
    def importAndReExportBusinessTemplateFromPath(self, template_path):
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
      """
        Imports the template that is in the template_path and exports it to the
        same path.

        We want to clean this directory, i.e. remove all files before
        the export. Because this is called as activity though, it could cause
        the following problem:
        - Activity imports the template
        - Activity removes all files from template_path
        - Activity fails in export.
        Then the folder contents will be changed, so when retrying the
        activity may succeed without the user understanding that files were
        erased. For this reason export is done in 3 steps:
        - First to a temporary directory
        - If there was no error delete contents of template_path
        - Copy the contents of the temporary directory to the template_path
      """
      import_template = self.download(url=template_path)
      export_dir = mkdtemp()
      try:
        import_template.export(path=export_dir, local=True)
        self._cleanUpTemplateFolder(template_path)
517 518 519 520 521
        file_name_list = [x for x in os.listdir(export_dir)]
        for file_name in file_name_list:
          temp_file_path = os.path.join(export_dir, file_name)
          destination_file_path = os.path.join(template_path, file_name)
          shutil.move(temp_file_path, destination_file_path)
522 523 524 525 526
      except:
        raise
      finally:
        shutil.rmtree(export_dir)

527 528
    security.declareProtected( 'Import/Export objects', 'importAndReExportBusinessTemplateListFromPath' )
    def importAndReExportBusinessTemplateListFromPath(self, repository_list, REQUEST=None, **kw):
529 530 531 532
      """
        Migrate business templates to new format where files like .py or .html
        are exported seprately than the xml.
      """
533
      repository_list = [r for r in repository_list if r]
534 535 536

      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
537

538 539 540 541
      if len(repository_list) == 0 and REQUEST:
        ret_url = self.absolute_url()
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                  % (ret_url, 'No repository was defined'))
542

543 544 545 546 547 548 549 550 551 552 553
      for repository in repository_list:
        repository = repository.rstrip('\n')
        repository = repository.rstrip('\r')
        for business_template_id in os.listdir(repository):
          template_path = os.path.join(repository, business_template_id)
          if os.path.isfile(template_path):
            LOG(business_template_id,0,'is file, so it is skipped')
          else:
            if not os.path.exists((os.path.join(template_path, 'bt'))):
              LOG(business_template_id,0,'has no bt sub-folder, so it is skipped')
            else:
554 555
              self.activate(activity='SQLQueue').\
                importAndReExportBusinessTemplateFromPath(template_path)
556

557
    security.declareProtected(Permissions.ManagePortal, 'getFilteredDiff')
558 559 560 561
    def getFilteredDiff(self, diff):
      """
      Filter the diff using python scripts
      """
562
      from erp5.component.module.DiffUtils import DiffFile
563 564
      diff_file_object = DiffFile(diff)
      diff_block_list = diff_file_object.getModifiedBlockList()
565 566 567 568
      if diff_block_list:
        script_list = self.getDiffFilterScriptList()
        for block, line_tuple in diff_block_list:
          for script in script_list:
569 570
            if script(line_tuple[0], line_tuple[1]):
              diff_file_object.children.remove(block)
571
              break
572 573 574 575
      # XXX-Aurel : this method should return a text diff but
      # DiffFile does not provide yet such feature
      return diff_file_object

576
    security.declareProtected(Permissions.ManagePortal, 'diffObjectAsHTML')
577 578 579
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
580
        This is compatible with ERP5VCS look and feel but
581 582
        it is preferred in future we use more difflib python library.
      """
583
      from erp5.component.module.DiffUtils import DiffFile
584 585
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

586
    security.declareProtected(Permissions.ManagePortal, 'diffObject')
587
    def diffObject(self, REQUEST, **kw):
Aurel's avatar
Aurel committed
588
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
589 590
        Make diff between two objects, whose paths are stored in values bt1
        and bt2 in the REQUEST object.
Aurel's avatar
Aurel committed
591
      """
592 593
      bt1_id = getattr(REQUEST, 'bt1', None)
      bt2_id = getattr(REQUEST, 'bt2', None)
594 595 596 597 598 599 600
      if bt1_id is not None and bt2_id is not None:
        bt1 = self._getOb(bt1_id)
        bt2 = self._getOb(bt2_id)
        if self.compareVersions(bt1.getVersion(), bt2.getVersion()) < 0:
          return bt2.diffObject(REQUEST, compare_with=bt1_id)
        else:
          return bt1.diffObject(REQUEST, compare_with=bt2_id)
Aurel's avatar
Aurel committed
601
      else:
602 603 604 605 606
        object_id = getattr(REQUEST, 'object_id', None)
        bt1_id = object_id.split('|')[0]
        bt1 = self._getOb(bt1_id)
        REQUEST.set('object_id', object_id.split('|')[1])
        return bt1.diffObject(REQUEST)
607

Vincent Pelletier's avatar
Vincent Pelletier committed
608 609 610 611
    security.declareProtected( 'Import/Export objects',
                               'updateRepositoryBusinessTemplateList' )

    def updateRepositoryBusinessTemplateList(self, repository_list,
612
        REQUEST=None, RESPONSE=None, genbt5list=0, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
613 614
      """
        Update the information on Business Templates from repositories.
615

616 617 618 619
      For local repositories, genbt5list > 0 enables automatic generation
      of bt5list, without saving it on disk:
      - genbt5list=1: only if bt5list is missing
      - genbt5list>1: always
620 621
      """
      self.repository_dict = PersistentMapping()
622
      property_list = ('title', 'version', 'revision', 'description', 'license',
623 624
                       'dependency', 'test_dependency', 'provision', 'copyright',
                       'force_install')
Vincent Pelletier's avatar
Vincent Pelletier committed
625 626
      #LOG('updateRepositoryBusiessTemplateList', 0,
      #    'repository_list = %r' % (repository_list,))
627
      for repository in repository_list:
628 629 630 631 632 633 634
        urltype, url = splittype(repository)
        if WIN and urltype and '\\' in url:
          urltype = None
          url = repository
        if urltype and urltype != 'file':
          f = urlopen(repository + '/bt5list')
        else:
635
          url = os.path.expanduser(url)
636 637 638 639 640 641
          bt5list = os.path.join(url, 'bt5list')
          if genbt5list > os.path.exists(bt5list):
            f = generateInformation(url)
            f.seek(0)
          else:
            f = open(bt5list, 'rb')
642
        try:
643 644 645 646 647 648 649 650 651 652
          try:
            doc = parse(f)
          except ExpatError:
            if REQUEST is not None:
              psm = translateString('Invalid repository: ${repo}',
                                    mapping={'repo':repository})
              REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                       % (self.absolute_url(), psm))
              return
            else:
653
              raise RuntimeError('Invalid repository: %s' % repository)
654
          try:
655
            property_dict_list = []
656 657 658
            root = doc.documentElement
            for template in root.getElementsByTagName("template"):
              id = template.getAttribute('id')
659
              if six.PY2 and type(id) == type(u''):
660 661 662 663 664 665 666 667
                id = id.encode('utf-8')
              temp_property_dict = {}
              for node in template.childNodes:
                if node.nodeName in property_list:
                  value = ''
                  for text in node.childNodes:
                    if text.nodeType == text.TEXT_NODE:
                      value = text.data
668
                      if six.PY2 and type(value) == type(u''):
669 670 671 672 673 674 675
                        value = value.encode('utf-8')
                      break
                  temp_property_dict.setdefault(node.nodeName, []).append(value)

              property_dict = {}
              property_dict['id'] = id
              property_dict['title'] = temp_property_dict.get('title', [''])[0]
Vincent Pelletier's avatar
Vincent Pelletier committed
676 677
              property_dict['version'] = \
                  temp_property_dict.get('version', [''])[0]
Jérome Perrin's avatar
Jérome Perrin committed
678 679
              property_dict['revision'] = \
                  temp_property_dict.get('revision', [''])[0]
Vincent Pelletier's avatar
Vincent Pelletier committed
680 681 682 683 684 685
              property_dict['description'] = \
                  temp_property_dict.get('description', [''])[0]
              property_dict['license'] = \
                  temp_property_dict.get('license', [''])[0]
              property_dict['dependency_list'] = \
                  temp_property_dict.get('dependency', ())
686 687
              property_dict['test_dependency_list'] = \
                  temp_property_dict.get('test_dependency', ())
688 689
              property_dict['provision_list'] = \
                  temp_property_dict.get('provision', ())
Vincent Pelletier's avatar
Vincent Pelletier committed
690 691
              property_dict['copyright_list'] = \
                  temp_property_dict.get('copyright', ())
692 693
              property_dict['force_install'] = \
                  int(temp_property_dict.get('force_install', [0])[0])
694

695 696 697 698 699
              property_dict_list.append(property_dict)
          finally:
            doc.unlink()
        finally:
          f.close()
700

701
        self.repository_dict[repository] = tuple(property_dict_list)
702

703
      if REQUEST is not None:
704
        ret_url = self.absolute_url() + '/' + REQUEST.get('dialog_id', 'view')
Yusei Tahara's avatar
Yusei Tahara committed
705
        psm = translateString("Business templates updated successfully.")
706 707
        REQUEST.RESPONSE.redirect("%s?cancel_url=%s&portal_status_message=%s&dialog_category=object_exchange&selection_name=business_template_selection"
                                  % (ret_url, REQUEST.form.get('cancel_url', ''), psm))
708

Vincent Pelletier's avatar
Vincent Pelletier committed
709 710
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRepositoryList' )
711
    def getRepositoryList(self):
Vincent Pelletier's avatar
Vincent Pelletier committed
712 713
      """
        Get the list of repositories.
714 715
      """
      return self.repository_dict.keys()
716

717 718
    security.declarePublic( 'decodeRepositoryBusinessTemplateUid' )
    def decodeRepositoryBusinessTemplateUid(self, uid):
Vincent Pelletier's avatar
Vincent Pelletier committed
719 720 721
      """
        Decode the uid of a business template from a repository.
        Return a repository and an id.
722
      """
723
      return pickle.loads(b64decode(uid))
724

725 726 727 728 729 730
    security.declarePublic( 'encodeRepositoryBusinessTemplateUid' )
    def encodeRepositoryBusinessTemplateUid(self, repository, id):
      """
        encode the repository and the id of a business template.
        Return an uid.
      """
731
      return b64encode(pickle.dumps((repository, id)))
732

733
    security.declarePublic('compareVersionStrings')
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
    def compareVersionStrings(self, version, comparing_string):
      """
       comparing_string is like "<= 0.2" | "operator version"
       operators supported: '<=', '<' or '<<', '>' or '>>', '>=', '=' or '=='
      """
      operator, comp_version = comparing_string.split(' ')
      diff_version = self.compareVersions(version, comp_version)
      if operator == '<' or operator == '<<':
        if diff_version < 0:
          return True;
        return False;
      if operator == '<=':
        if diff_version <= 0:
          return True;
        return False;
      if operator == '>' or operator == '>>':
        if diff_version > 0:
          return True;
        return False;
      if operator == '>=':
        if diff_version >= 0:
          return True;
        return False;
      if operator == '=' or operator == '==':
        if diff_version == 0:
          return True;
        return False;
761
      raise UnsupportedComparingOperator('Unsupported comparing operator: %s'%(operator,))
762

763 764 765 766 767 768 769 770 771 772 773 774 775 776
    security.declareProtected(Permissions.AccessContentsInformation,
                              'IsOneProviderInstalled')
    def IsOneProviderInstalled(self, title):
      """
        return true if a business template that
        provides the bt with the given title is
        installed
      """
      installed_bt_list = self.getInstalledBusinessTemplatesList()
      for bt in installed_bt_list:
        provision_list = bt.getProvisionList()
        if title in provision_list:
          return True
      return False
777

778 779 780 781 782
    security.declareProtected(Permissions.AccessContentsInformation,
                               'getLastestBTOnRepos')
    def getLastestBTOnRepos(self, title, version_restriction=None):
      """
       It's possible we have different versions of the same BT
783
       available on various repositories or on the same repository.
784 785 786 787 788 789
       This function returns the latest one that meet the version_restriction
       (i.e "<= 0.2") in the following form :
       tuple (repository, id)
      """
      result = None
      for repository, property_dict_list in self.repository_dict.items():
Jérome Perrin's avatar
Jérome Perrin committed
790
        for property_dict in property_dict_list:
791 792
          provision_list = property_dict.get('provision_list', [])
          if title in provision_list:
793
            raise BusinessTemplateIsMeta('Business Template %s is provided by another one'%(title,))
Jérome Perrin's avatar
Jérome Perrin committed
794
          if title == property_dict['title']:
795 796
            if (version_restriction is None) or (self.compareVersionStrings(property_dict['version'], version_restriction)):
              if (result is None) or (self.compareVersions(property_dict['version'], result[2]) > 0):
Rafael Monnerat's avatar
Rafael Monnerat committed
797
                result = (repository, property_dict['id'], property_dict['version'])
798 799 800
      if result is not None:
        return (result[0], result[1])
      else:
801
        raise BusinessTemplateUnknownError('Business Template %s (%s) could not be found in the repositories'%(title, version_restriction or ''))
802

803 804 805 806 807 808 809 810 811 812 813 814 815 816
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getProviderList')
    def getProviderList(self, title):
      """
       return a list of business templates that provides
       the given business template
      """
      result_list = []
      for repository, property_dict_list in self.repository_dict.items():
        for property_dict in property_dict_list:
          provision_list = property_dict['provision_list']
          if (title in provision_list) and (property_dict['title'] not in result_list):
            result_list.append(property_dict['title'])
      return result_list
817

818 819
    security.declareProtected(Permissions.AccessContentsInformation,
                               'getDependencyList')
820 821 822
    @transactional_cached(lambda self, bt, with_test_dependency_list=False:
                          (bt, with_test_dependency_list))
    def getDependencyList(self, bt, with_test_dependency_list=False):
823 824 825 826
      """
       Return the list of missing dependencies for a business
       template, given a tuple : (repository, id)
      """
827 828 829
      # We do not take into consideration the dependencies
      # for meta business templates
      if bt[0] != 'meta':
830 831 832 833 834
        result_list = []
        for repository, property_dict_list in self.repository_dict.items():
          if repository == bt[0]:
            for property_dict in property_dict_list:
              if property_dict['id'] == bt[1]:
835 836 837 838 839
                dependency_list = [q.strip() for q in
                                   property_dict['dependency_list'] if q]
                if with_test_dependency_list:
                  dependency_list.extend([q.strip() for q in
                                          property_dict['test_dependency_list'] if q])
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
                for dependency_couple in dependency_list:
                  # dependency_couple is like "erp5_xhtml_style (>= 0.2)"
                  dependency_couple_list = dependency_couple.split(' ', 1)
                  dependency = dependency_couple_list[0]
                  version_restriction = None
                  if len(dependency_couple_list) > 1:
                    version_restriction = dependency_couple_list[1]
                    if version_restriction.startswith('('):
                      # Something like "(>= 1.0rc6)".
                      version_restriction = version_restriction[1:-1]
                  require_update = False
                  if dependency not in result_list:
                    # Get the lastest version of the dependency on the
                    # repository that meet the version restriction
                    provider_installed = False
                    bt_dep = None
                    try:
                      bt_dep = self.getLastestBTOnRepos(dependency, version_restriction)
                    except BusinessTemplateUnknownError:
859
                      raise BusinessTemplateMissingDependency('While analysing %s the following dependency could not be satisfied: %s (%s)\nReason: Business Template could not be found in the repositories'%(bt[1], dependency, version_restriction or ''))
860 861 862
                    except BusinessTemplateIsMeta:
                      provider_list = self.getProviderList(dependency)
                      for provider in provider_list:
863
                        if self.getInstalledBusinessTemplate(provider) is not None:
864 865 866 867 868 869 870 871 872 873
                          bt_dep = self.getLastestBTOnRepos(provider)
                          break
                      if bt_dep is None:
                        bt_dep = ('meta', dependency)
                    sub_dep_list = self.getDependencyList(bt_dep)
                    for sub_dep in sub_dep_list:
                      if sub_dep not in result_list:
                        result_list.append(sub_dep)
                    result_list.append(bt_dep)
                return result_list
874
        raise BusinessTemplateUnknownError('The Business Template %s could not be found on repository %s'%(bt[1], bt[0]))
875
      return []
876

877 878
    security.declareProtected(Permissions.ManagePortal,
                              'findProviderInBTList')
879 880 881 882 883 884 885 886 887 888
    def findProviderInBTList(self, provider_list, bt_list):
      """
       Find one provider in provider_list which is present in
       bt_list and returns the found tuple (repository, id)
       in bt_list.
      """
      for provider in provider_list:
        for repository, id in bt_list:
          if id.startswith(provider):
            return (repository, id)
889
      raise BusinessTemplateUnknownError('Provider not found in bt_list')
890

891 892 893 894
    security.declareProtected(Permissions.AccessContentsInformation,
                              'sortBusinessTemplateList')
    def sortBusinessTemplateList(self, bt_list):
      """
895 896 897 898 899 900
      Sort a list of business template in repositories according to
      dependencies

      bt_list : list of (repository, id) tuple.
      """
      sorted_bt_list = []
901
      title_id_mapping = {}
902 903 904 905 906 907 908

      # Calculate the dependency graph
      dependency_dict = {}
      provition_dict = {}
      repository_dict = {}
      undependent_list = []

909 910 911
      for repository, bt_id in bt_list:
        bt = [x for x in self.repository_dict[repository] \
              if x['id'] == bt_id][0]
912 913 914 915 916 917
        bt_title = bt['title']
        repository_dict[bt_title] = repository
        dependency_dict[bt_title] = [x.split(' ')[0] for x in bt['dependency_list']]
        title_id_mapping[bt_title] = bt_id
        if not dependency_dict[bt_title]:
          del dependency_dict[bt_title]
918
        for provision in list(bt['provision_list']):
919 920
          provition_dict[provision] = bt_title
        undependent_list.append(bt_title)
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949

      # Calculate the reverse dependency graph
      reverse_dependency_dict = {}
      for bt_id, dependency_id_list in dependency_dict.items():
        update_dependency_id_list = []
        for dependency_id in dependency_id_list:

          # Get ride of provision id
          if dependency_id in provition_dict:
            dependency_id = provition_dict[dependency_id]
          update_dependency_id_list.append(dependency_id)

          # Fill incoming edge dict
          if dependency_id in reverse_dependency_dict:
            reverse_dependency_dict[dependency_id].append(bt_id)
          else:
            reverse_dependency_dict[dependency_id] = [bt_id]

          # Remove from free node list
          try:
            undependent_list.remove(dependency_id)
          except ValueError:
            pass

        dependency_dict[bt_id] = update_dependency_id_list

      # Let's sort the bt5!
      while undependent_list:
        bt_id = undependent_list.pop(0)
950 951 952
        if bt_id not in repository_dict:
          continue
        sorted_bt_list.insert(0, (repository_dict[bt_id], title_id_mapping[bt_id]))
953 954 955 956 957 958 959 960 961 962 963
        for dependency_id in dependency_dict.get(bt_id, []):

          local_dependency_list = reverse_dependency_dict[dependency_id]
          local_dependency_list.remove(bt_id)
          if local_dependency_list:
            reverse_dependency_dict[dependency_id] = local_dependency_list
          else:
            del reverse_dependency_dict[dependency_id]
            undependent_list.append(dependency_id)

      if len(sorted_bt_list) != len(bt_list):
964
        raise NotImplementedError("Circular dependencies on %s" % list(reverse_dependency_dict))
965 966
      else:
        return sorted_bt_list
967

968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
    security.declareProtected(Permissions.AccessContentsInformation,
                              'sortDownloadedBusinessTemplateList')
    def sortDownloadedBusinessTemplateList(self, id_list):
      """
      Sort a list of already downloaded business templates according to
      dependencies

      id_list : list of business template's id in portal_templates.
      """
      def isDepend(a, b):
        # return True if a depends on b.
        dependency_list = [x.split(' ')[0] for x in a.getDependencyList()]
        provision_list = list(b.getProvisionList()) + [b.getTitle()]
        for i in provision_list:
          if i in dependency_list:
            return True
          return False

      sorted_bt_list = []
      for bt_id in id_list:
        bt = self._getOb(bt_id)
        for j in range(len(sorted_bt_list)):
          if isDepend(sorted_bt_list[j], bt):
            sorted_bt_list.insert(j, bt)
            break
        else:
           sorted_bt_list.append(bt)
      sorted_bt_list = [bt.getId() for bt in sorted_bt_list]
      return sorted_bt_list

Vincent Pelletier's avatar
Vincent Pelletier committed
998 999
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRepositoryBusinessTemplateList' )
1000
    def getRepositoryBusinessTemplateList(self, update_only=False,
1001
             template_list=None, **kw):
1002
      """Get the list of Business Templates in repositories.
1003 1004 1005

         update_only: return only bt that needs to be updated
         template_list: only returns bt within the given list
1006
      """
1007 1008 1009 1010
      result_list = []
      template_set = None
      if template_list is not None:
        template_set = set(template_list)
1011 1012

      template_item_list = []
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
      # First of all, filter Business Templates in repositories.
      template_item_dict = {}
      for repository, property_dict_list in self.repository_dict.items():
        for property_dict in property_dict_list:
          title = property_dict['title']
          if template_set and not(title in template_set):
            continue
          if not update_only:
            template_item_list.append((repository, property_dict))
          else:
1023
            if title not in template_item_dict:
Vincent Pelletier's avatar
Vincent Pelletier committed
1024 1025
              # If this is the first time to see this business template,
              # insert it.
1026 1027
              template_item_dict[title] = (repository, property_dict)
            else:
Vincent Pelletier's avatar
Vincent Pelletier committed
1028 1029 1030 1031
              # If this business template has been seen before, insert it only
              # if this business template is newer.
              previous_repository, previous_property_dict = \
                  template_item_dict[title]
1032 1033
              if self.compareVersions(previous_property_dict['version'],
                                      property_dict['version']) < 0:
1034
                template_item_dict[title] = (repository, property_dict)
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
      # Next, select only updated business templates.
      if update_only:
        for repository, property_dict in template_item_dict.values():
          installed_bt = \
              self.getInstalledBusinessTemplate(property_dict['title'], strict=True)
          if installed_bt is not None:
            diff_version = self.compareVersions(installed_bt.getVersion(),
                                                property_dict['version'])
            if diff_version < 0:
              template_item_list.append((repository, property_dict))
            elif diff_version == 0 \
                  and property_dict['revision'] \
1047
                  and installed_bt.getRevision() != property_dict['revision']:
1048 1049
                    template_item_list.append((repository, property_dict))
          elif template_list is not None:
1050 1051 1052 1053 1054
            template_item_list.append((repository, property_dict))

      # Create temporary Business Template objects for displaying.
      for repository, property_dict in template_item_list:
        property_dict = property_dict.copy()
1055
        id = filename = property_dict.pop('id')
1056 1057 1058 1059
        installed_bt = \
            self.getInstalledBusinessTemplate(property_dict['title'])
        if installed_bt is not None:
          installed_version = installed_bt.getVersion()
1060 1061
          installed_revision = installed_bt.getShortRevision()
          if installed_bt.getRevision() == property_dict['revision']:
1062
            version_state = 'present'
1063 1064
          else:
            version_state = 'different'
1065 1066 1067
        else:
          installed_version = ''
          installed_revision = ''
1068
          version_state = 'new'
1069
        uid = self.encodeRepositoryBusinessTemplateUid(repository, id)
1070 1071
        obj = self.newContent(temp_object=True,
                              portal_type='Business Template',
1072
                              id='temp_' + bytes2str(uid),
1073 1074 1075 1076 1077 1078 1079
                              version_state=version_state,
                              version_state_title=version_state.title(),
                              filename=filename,
                              installed_version=installed_version,
                              installed_revision=installed_revision,
                              repository=repository,
                              **property_dict)
1080
        obj.setUid(uid)
1081 1082 1083
        result_list.append(obj)
      result_list.sort(key=lambda x: x.getTitle())
      return result_list
1084

Vincent Pelletier's avatar
Vincent Pelletier committed
1085 1086
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getUpdatedRepositoryBusinessTemplateList' )
1087 1088 1089 1090
    def getUpdatedRepositoryBusinessTemplateList(self, **kw):
      """Get the list of updated Business Templates in repositories.
      """
      #LOG('getUpdatedRepositoryBusinessTemplateList', 0, 'kw = %r' % (kw,))
1091
      return self.getRepositoryBusinessTemplateList(update_only=True, **kw)
1092

1093
    security.declarePublic('compareVersions')
1094
    def compareVersions(self, version1, version2):
Vincent Pelletier's avatar
Vincent Pelletier committed
1095 1096 1097
      """
        Return negative if version1 < version2, 0 if version1 == version2,
        positive if version1 > version2.
1098 1099

      Here is the algorithm:
Vincent Pelletier's avatar
Vincent Pelletier committed
1100 1101
        - Non-alphanumeric characters are not significant, besides the function
          of delimiters.
1102 1103 1104 1105
        - If a level of a version number is missing, it is assumed to be zero.
        - An alphabetical character is less than any numerical value.
        - Numerical values are compared as integers.

Vincent Pelletier's avatar
Vincent Pelletier committed
1106
      This implements the following predicates:
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
        - 1.0 < 1.0.1
        - 1.0rc1 < 1.0
        - 1.0a < 1.0.1
        - 1.1 < 2.0
        - 1.0.0 = 1.0
      """
      r = re.compile('(\d+|[a-zA-Z])')
      v1 = r.findall(version1)
      v2 = r.findall(version2)

      def convert(v, i):
        """Convert the ith element of v to an interger for a comparison.
        """
        #LOG('convert', 0, 'v = %r, i = %r' % (v, i))
        try:
          e = v[i]
          try:
            e = int(e)
          except ValueError:
            # ASCII code is one byte, so this produces negative.
            e = struct.unpack('b', e)[0] - 0x200
        except IndexError:
          e = 0
        return e
1131

1132 1133 1134 1135 1136 1137 1138 1139
      for i in xrange(max(len(v1), len(v2))):
        e1 = convert(v1, i)
        e2 = convert(v2, i)
        result = cmp(e1, e2)
        if result != 0:
          return result

      return 0
1140

1141
    def _getBusinessTemplateUrlDict(self):
1142
      business_template_url_dict = {}
1143
      for bt in self.getRepositoryBusinessTemplateList():
1144
        url, name = self.decodeRepositoryBusinessTemplateUid(bt.getUid())
1145 1146 1147
        if name.endswith('.bt5'):
          name = name[:-4]
        business_template_url_dict[name] = {
Rafael Monnerat's avatar
Rafael Monnerat committed
1148
          'url': '%s/%s' % (url, bt.filename),
1149 1150 1151 1152 1153
          'revision': bt.getRevision()
          }
      return business_template_url_dict

    security.declareProtected(Permissions.ManagePortal,
Rafael Monnerat's avatar
Rafael Monnerat committed
1154
        'installBusinessTemplatesFromRepositories')
1155
    def installBusinessTemplatesFromRepositories(self, *args, **kw):
1156 1157
      """Deprecated.
      """
1158
      DeprecationWarning('installBusinessTemplatesFromRepositories is deprecated; Use self.installBusinessTemplateListFromRepository instead.', DeprecationWarning)
1159
      return self.installBusinessTemplateListFromRepository(*args, **kw)
1160

1161 1162
    security.declareProtected(Permissions.ManagePortal,
         'resolveBusinessTemplateListDependency')
1163 1164 1165
    def resolveBusinessTemplateListDependency(self,
                                              template_title_list,
                                              with_test_dependency_list=False):
1166
      available_bt5_list = self.getRepositoryBusinessTemplateList()
1167

1168
      template_title_list = set(template_title_list)
1169 1170
      installed_bt5_title_list = self.getInstalledBusinessTemplateTitleList()

1171
      bt5_set = set()
1172 1173
      for available_bt5 in available_bt5_list:
        if available_bt5.title in template_title_list:
1174
          template_title_list.remove(available_bt5.title)
1175 1176
          bt5 = self.decodeRepositoryBusinessTemplateUid(available_bt5.uid)
          bt5_set.add(bt5)
1177
          meta_dependency_set = set()
1178 1179 1180
          for dep_repository, dep_id in self.getDependencyList(
              bt5,
              with_test_dependency_list):
1181 1182 1183
            if dep_repository != 'meta':
              bt5_set.add((dep_repository, dep_id))
            else:
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
              meta_dependency_set.add((dep_repository, dep_id))
          for dep_repository, dep_id in meta_dependency_set:
            provider_list = self.getProviderList(dep_id)
            provider_installed = False
            provider_title = None
            for provider in provider_list:
              if provider in [i[1].replace(".bt5", "") for i in bt5_set] or \
                    provider in installed_bt5_title_list or \
                    provider in template_title_list:
                provider_title = provider
1194
                for candidate in available_bt5_list:
1195
                  if candidate.title == provider:
1196 1197 1198
                    bt5_set.add(\
                      self.decodeRepositoryBusinessTemplateUid(
                          candidate.uid))
1199
                    break
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
                break
            if provider_title is None and len(provider_list) == 1:
              provider_title = provider_list[0]
            LOG('resolveBT, provider_title', 0, provider_title)
            if provider_title:
              for candidate in available_bt5_list:
                if candidate.title == provider_title:
                  bt5_set.add(\
                    self.decodeRepositoryBusinessTemplateUid(
                        candidate.uid))
                  break
            else:
1212 1213
              raise BusinessTemplateMissingDependency("Unable to resolve dependencies for %s, options are %s"
                    % (dep_id, provider_list))
1214 1215

      if len(template_title_list) > 0:
1216 1217
         raise BusinessTemplateUnknownError('The Business Template %s could not be found on repositories %s' %
             (list(template_title_list), self.getRepositoryList()))
1218 1219
      return self.sortBusinessTemplateList(list(bt5_set))

1220 1221 1222
    security.declareProtected(Permissions.ManagePortal,
        'installBusinessTemplateListFromRepository')
    def installBusinessTemplateListFromRepository(self, template_list,
1223
        only_different=True, update_catalog=False, activate=False,
1224
        install_dependency=False):
1225 1226 1227 1228
      """Installs template_list from configured repositories by default only newest"""
      # XXX-Luke: This method could replace
      # TemplateTool_installRepositoryBusinessTemplateList while still being
      # possible to reuse by external callers
1229

1230 1231
      operation_log = []
      resolved_template_list = self.resolveBusinessTemplateListDependency(
1232
                   template_list)
1233 1234
      installed_bt5_dict = {x.getTitle(): x.getRevision()
        for x in self.getInstalledBusinessTemplateList()}
1235 1236
      if only_different:
        template_url_dict = self._getBusinessTemplateUrlDict()
1237 1238

      def checkAvailability(bt_title):
1239
        return bt_title in template_list or bt_title in installed_bt5_dict
1240 1241 1242 1243
      missing_dependency_list = [i for i in resolved_template_list
                                 if not checkAvailability(i[1].replace(".bt5", ""))]

      if not install_dependency and len(missing_dependency_list) > 0:
1244 1245
        raise BusinessTemplateMissingDependency("Impossible to install, please install the following dependencies before: %s"
            % [x[1] for x in missing_dependency_list])
1246 1247

      activate_kw =  dict(activity="SQLQueue", tag="start_%s" % (time.time()))
1248
      for repository, bt_id in resolved_template_list:
1249 1250 1251
        if only_different:
          bt = template_url_dict.get(bt_id)
          if bt is not None and bt['revision'] == installed_bt5_dict.get(bt_id):
1252
            continue
1253
        bt_url = '%s/%s' % (repository, bt_id)
1254
        param_dict = dict(download_url=bt_url, only_different=only_different)
1255
        param_dict["update_catalog"] = update_catalog
1256 1257 1258 1259 1260 1261 1262

        if activate:
          self.activate(**activate_kw).\
                updateBusinessTemplateFromUrl(**param_dict)
          activate_kw["after_tag"] = activate_kw["tag"]
          activate_kw["tag"] = bt_id
          operation_log.append('Installed %s using activities' % (bt_id))
1263
        else:
1264 1265
          document = self.updateBusinessTemplateFromUrl(**param_dict)
          operation_log.append('Installed %s with revision %s' % (
1266
              document.getTitle(), document.getShortRevision()))
1267 1268

      return operation_log
1269

1270 1271 1272
    security.declareProtected(Permissions.ManagePortal,
            'updateBusinessTemplateFromUrl')
    def updateBusinessTemplateFromUrl(self, download_url, id=None,
1273 1274 1275
                                         keep_original_list=None,
                                         before_triggered_bt5_id_list=None,
                                         after_triggered_bt5_id_list=None,
1276
                                         update_catalog=False,
1277
                                         reinstall=False,
1278
                                         active_process=None,
Rafael Monnerat's avatar
Rafael Monnerat committed
1279
                                         force_keep_list=None,
1280
                                         only_different=True):
Rafael Monnerat's avatar
Rafael Monnerat committed
1281
      """
1282
        This method download and install a bt5, from a URL.
1283 1284 1285 1286 1287

        keep_original_list can be used to make paths not touched at all

        force_keep_list can be used to force path to be modified or removed
        even if template system proposes not touching it
1288
      """
1289 1290 1291 1292 1293 1294 1295 1296
      if keep_original_list is None:
        keep_original_list = []
      if before_triggered_bt5_id_list is None:
        before_triggered_bt5_id_list = []
      if after_triggered_bt5_id_list is None:
        after_triggered_bt5_id_list = []
      if force_keep_list is None:
        force_keep_list = []
1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
      if active_process is None:
        installed_dict = {}
        def log(msg):
          LOG('TemplateTool.updateBusinessTemplateFromUrl', INFO, msg)
      else:
        active_process = self.unrestrictedTraverse(active_process)
        if getattr(aq_base(active_process), 'installed_dict', None) is None:
          active_process.installed_dict = PersistentMapping()
        installed_dict = active_process.installed_dict
        message_list = []
        log = message_list.append

      log("Installing %s ..." % download_url)
1310
      imported_bt5 = self.download(url = download_url, id = id)
1311 1312
      bt_title = imported_bt5.getTitle()

1313 1314 1315
      if reinstall:
        install_kw = None
      else:
1316 1317 1318 1319 1320 1321 1322
        if only_different:
          previous_bt5 = self.getInstalledBusinessTemplate(bt_title)
          if previous_bt5 and \
             imported_bt5.getRevision() == previous_bt5.getRevision():
            log("%s is already installed with revision %s"
                % (bt_title, imported_bt5.getShortRevision()))
            return imported_bt5
1323 1324 1325

        install_kw = {}
        for listbox_line in imported_bt5.BusinessTemplate_getModifiedObject():
1326 1327
          item = listbox_line.object_id
          state = listbox_line.object_state
1328
          if state.startswith('Removed'):
1329 1330 1331 1332 1333 1334 1335 1336
            # The following condition could not be used to automatically decide
            # if an item must be kept or not. For example, this would not work
            # for items installed by PortalTypeWorkflowChainTemplateItem.
            maybe_moved = installed_dict.get(listbox_line.object_id, '')
            log('%s: %s%s' % (state, item,
              maybe_moved and ' (moved to %s ?)' % maybe_moved))
          else:
            installed_dict[item] = bt_title
1337 1338 1339

          # For actions which suggest that item shall be kept and item is not
          # explicitely forced, keep the default -- do nothing
1340 1341
          # XXX: 'force_keep_list' variable is misnamed.
          should_keep = item not in force_keep_list and state in (
1342 1343
            'Modified but should be kept', 'Removed but should be kept')
          # If item is forced to be untouched, do not touch it
1344 1345
          if item in keep_original_list or should_keep:
            if not should_keep:
1346 1347 1348
              log('Item %r is in force_keep_list and keep_original_list,'
                  ' as keep_original_list has precedence item is NOT MODIFIED'
                  % item)
1349 1350 1351
            install_kw[item] = 'nothing'
          else:
            install_kw[item] = listbox_line.choice_item_list[0][1]
1352

1353 1354
      # Run before script list
      for before_triggered_bt5_id in before_triggered_bt5_id_list:
1355 1356 1357
        log('Execute %r' % before_triggered_bt5_id)
        imported_bt5.unrestrictedTraverse(before_triggered_bt5_id)()

1358 1359 1360 1361 1362 1363 1364
      # Note: CATALOG_UPDATABLE should only be used in eceptional cases
      #       where the caller installs several bts and does not know
      #       which ones need to update catalog. Handling catalog should be
      #       usually done at upgrader level.
      if update_catalog is CATALOG_UPDATABLE and install_kw != {}:
        update_catalog = imported_bt5.isCatalogUpdatable()

1365 1366
      imported_bt5.install(object_to_update=install_kw,
                           update_catalog=update_catalog)
1367

1368 1369
      # Run After script list
      for after_triggered_bt5_id in after_triggered_bt5_id_list:
1370 1371 1372 1373 1374 1375 1376 1377
        log('Execute %r' % after_triggered_bt5_id)
        imported_bt5.unrestrictedTraverse(after_triggered_bt5_id)()
      if active_process is not None:
        active_process.postResult(ActiveResult(
          '%03u. %s' % (len(active_process.getResultList()) + 1, bt_title),
          detail='\n'.join(message_list)))
      else:
        log("Updated %s from %s" % (bt_title, download_url))
1378

1379 1380
      return imported_bt5

1381 1382 1383 1384 1385 1386 1387
    security.declareProtected(Permissions.ManagePortal,
            'getBusinessTemplateUrl')
    def getBusinessTemplateUrl(self, base_url_list, bt5_title):
      """
        This method verify if the business template are available
        into one url (repository).
      """
1388 1389
      if base_url_list is None:
        base_url_list = self.getRepositoryList()
1390 1391 1392 1393 1394
      # This list could be preconfigured at some properties or
      # at preferences.
      for base_url in base_url_list:
        url = "%s/%s" % (base_url, bt5_title)
        if base_url == "INSTANCE_HOME_REPOSITORY":
Rafael Monnerat's avatar
Rafael Monnerat committed
1395
          url = "file://%s/bt5/%s" % (getConfiguration().instancehome,
1396 1397 1398 1399
                                      bt5_title)
          LOG('ERP5', INFO, "TemplateTool: INSTANCE_HOME_REPOSITORY is %s." \
              % url)
        try:
1400
          urllib.request.urlopen(url)
1401
          return url
1402
        except (urllib.error.HTTPError, OSError):
1403 1404 1405 1406
          # XXX Try again with ".bt5" in case the folder format be used
          # Instead tgz one.
          url = "%s.bt5" % url
          try:
1407
            urllib.request.urlopen(url)
1408
            return url
1409
          except (urllib.error.HTTPError, OSError):
1410
            pass
Rafael Monnerat's avatar
Rafael Monnerat committed
1411
      LOG('ERP5', INFO, 'TemplateTool: %s was not found into the url list: '
1412 1413 1414
                        '%s.' % (bt5_title, base_url_list))
      return None

1415 1416 1417
    security.declareProtected(Permissions.ManagePortal,
        'upgradeSite')
    def upgradeSite(self, bt5_list, deprecated_after_script_dict=None,
1418 1419
                    deprecated_reinstall_set=None, dry_run=False,
                    delete_orphaned=False,
1420
                    keep_bt5_id_set=(),
1421
                    update_catalog=False):
1422 1423 1424 1425 1426 1427 1428
      """
      Upgrade many business templates at a time. bt5_list should
      contains only final business templates, then all dependencies
      are calculated, and missing business templates will be added,
      old business templates will be updated, and orphelin business
      templates will be deleted

1429 1430 1431
      keep_bt5_id_set: business template that should not be deleted.
                       This is useful if we want to keep an old business
                       template without updating it and without removing it
1432

1433 1434
      deprecated_reinstall_set: this parameter is obsolete, please set
                                force_install property at business template level
1435 1436
                                It list all business templates who needs
                                reinstall
1437 1438 1439 1440 1441 1442

      update_catalog: handling catalog should be handled outside upgradeSite.
                      This option only exists for the case where it is not
                      known which bts need catalog update. In this case one
                      can pass CATALOG_UPDATABLE which will be propagated to
                      updateBusinessTemplateFromUrl.
1443
      """
1444
      # make sure that we updated information on repository
1445 1446
      self.updateRepositoryBusinessTemplateList(self.getRepositoryList())
      # do upgrade
1447
      is_something_changed = False
1448 1449 1450 1451 1452 1453 1454
      message_list = []
      deprecated_reinstall_set = deprecated_reinstall_set or set()
      def append(message):
        message_list.append(message)
        LOG('upgradeSite', 0, message)
      dependency_list = [x[1] for x in \
        self.resolveBusinessTemplateListDependency(bt5_list)]
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464
      keep_bt5_id_set = set(keep_bt5_id_set)
      # XXX: Removed bt5: used to contain Configurator Workflow implementation
      # (workflow_module) which has since been migrated to portal_workflow and
      # erp5_core.  This must not be uninstalled as it would remove Workflow
      # Portal Type and erp5_core upgrade then fails on _reindexObjectVariables():
      #   Base_reindexObjectSecurity: getTypeInfo().getTypeAllowedContentTypeList()
      #   => AttributeError: 'NoneType'
      #
      # Tested by testUpgradeInstanceWithOldDataFs
      keep_bt5_id_set.add('erp5_workflow')
1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
      if delete_orphaned:
        to_remove_bt5_list = [x for x in self.getInstalledBusinessTemplateList()
                              if x.title not in dependency_list]
        sorted_to_remove_bt5_id_list = self.sortDownloadedBusinessTemplateList(
                                  [x.id for x in to_remove_bt5_list])
        sorted_to_remove_bt5_id_list.reverse()
        to_remove_bt5_list.sort(
          key=lambda x: sorted_to_remove_bt5_id_list.index(x.id))
        for bt in to_remove_bt5_list:
          if bt.title in keep_bt5_id_set:
            continue
1476
          is_something_changed = True
1477
          append("Uninstall business template %s" % bt.title)
1478
          if not dry_run:
1479 1480
            # XXX Here is missing parameters to really remove stuff
            bt.uninstall()
1481 1482 1483 1484 1485 1486 1487 1488
      update_bt5_list = self.getRepositoryBusinessTemplateList(
        template_list=dependency_list)
      update_bt5_list.sort(key=lambda x: dependency_list.index(x.title))
      for bt5 in update_bt5_list:
        reinstall = bt5.title in deprecated_reinstall_set or bt5.force_install
        if (not(reinstall) and bt5.version_state == 'present') or \
            bt5.title in keep_bt5_id_set:
          continue
1489
        is_something_changed = True
1490 1491
        append("Update %s business template in state %s%s" % \
          (bt5.title, bt5.version_state, (reinstall and ' (reinstall)') or ''))
1492
        if not dry_run:
1493 1494 1495
          bt5_url = "%s/%s" % (bt5.repository, bt5.title)
          self.updateBusinessTemplateFromUrl(bt5_url, reinstall=reinstall,
                                             update_catalog=update_catalog)
1496 1497 1498 1499
      if is_something_changed:
        append("Update translation table")
        if not dry_run:
          self.ERP5Site_updateTranslationTable()
1500 1501
      return message_list

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1502
InitializeClass(TemplateTool)