TemplateTool.py 56 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
from webdav.client import Resource
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31

Yoshinori Okuji's avatar
Yoshinori Okuji committed
32
from App.config import getConfiguration
33
import os
34
import shutil
35
import sys
Yoshinori Okuji's avatar
Yoshinori Okuji committed
36

37
from Acquisition import Implicit, Explicit
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38
from AccessControl import ClassSecurityInfo
39
from AccessControl.SecurityInfo import ModuleSecurityInfo
40
from Products.CMFActivity.ActiveResult import ActiveResult
41
from Products.ERP5Type.Globals import InitializeClass, DTMLFile, PersistentMapping
42
from Products.ERP5Type.DiffUtils import DiffFile
Jean-Paul Smets's avatar
Jean-Paul Smets committed
43
from Products.ERP5Type.Tool.BaseTool import BaseTool
44
from Products.ERP5Type.Cache import transactional_cached
45
from Products.ERP5Type import Permissions
46
from Products.ERP5.Document.BusinessTemplate import BusinessTemplateMissingDependency
47
from Products.ERP5.genbt5list import generateInformation
48
from Acquisition import aq_base
49
from tempfile import mkstemp, mkdtemp
Jean-Paul Smets's avatar
Jean-Paul Smets committed
50
from Products.ERP5 import _dtmldir
Aurel's avatar
Aurel committed
51
from cStringIO import StringIO
52
from urllib import pathname2url, urlopen, splittype, urlretrieve
53
import urllib2
54 55
import re
from xml.dom.minidom import parse
56
from xml.parsers.expat import ExpatError
57 58
import struct
import cPickle
59
from base64 import b64encode, b64decode
60
from Products.ERP5Type.Message import translateString
61
from zLOG import LOG, INFO, WARNING
62
from base64 import decodestring
63
import subprocess
64
import time
65

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

67
WIN = os.name == 'nt'
68

69 70
CATALOG_UPDATABLE = object()
ModuleSecurityInfo(__name__).declarePublic('CATALOG_UPDATABLE')
71

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
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

88 89
ModuleSecurityInfo(__name__).declarePublic('BusinessTemplateUnknownError')

Jean-Paul Smets's avatar
Jean-Paul Smets committed
90
class TemplateTool (BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
91
    """
92
      TemplateTool manages Business Templates.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
93

94 95 96 97 98 99
      TemplateTool provides some methods to deal with Business Templates:
        - download
        - publish
        - install
        - update
        - save
Jean-Paul Smets's avatar
Jean-Paul Smets committed
100 101
    """
    id = 'portal_templates'
102
    title = 'Template Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
103
    meta_type = 'ERP5 Template Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
104
    portal_type = 'Template Tool'
Rafael Monnerat's avatar
Rafael Monnerat committed
105
    allowed_types = ('ERP5 Business Template', )
106

107 108
    # This stores information on repositories.
    repository_dict = {}
Jean-Paul Smets's avatar
Jean-Paul Smets committed
109 110 111 112

    # Declarative Security
    security = ClassSecurityInfo()

Rafael Monnerat's avatar
Rafael Monnerat committed
113 114
    security.declareProtected(Permissions.ManagePortal, 'manage_overview')
    manage_overview = DTMLFile('explainTemplateTool', _dtmldir)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
115

116
    def getInstalledBusinessTemplate(self, title, strict=False, **kw):
117
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
118
        Return an installed version of business template of a certain title.
119 120 121

        It not "installed" business template is found, look at replaced ones.
        This is mostly usefull if we are looking for the installed business
122 123
        template in a transaction replacing an existing business template.
        If strict is true, we do not take care of "replaced" business templates.
124 125
      """
      # This can be slow if, say, 10000 business templates are present.
Vincent Pelletier's avatar
Vincent Pelletier committed
126 127 128
      # 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.
129 130
      last_bt = last_time = None
      for bt in self.objectValues(portal_type='Business Template'):
131
        if bt.getTitle() == title or title in bt.getProvisionList():
132 133 134 135 136 137 138 139 140 141
          state = bt.getInstallationState()
          if state == 'installed':
            return bt
          if state == 'replaced' and not strict:
            t = bt.workflow_history \
              ['business_template_installation_workflow'][-1]['time']
            if last_time < t:
              last_bt = bt
              last_time = t
      return last_bt
142

143
    def getInstalledBusinessTemplatesList(self):
144 145 146 147 148
      """Deprecated.
      """
      DeprecationWarning('getInstalledBusinessTemplatesList is deprecated; Use getInstalledBusinessTemplateList instead.', DeprecationWarning)
      return self.getInstalledBusinessTemplateList()

149
    def _getInstalledBusinessTemplateList(self, only_title=0):
150
      """Get the list of installed business templates.
151 152
      """
      installed_bts = []
153
      for bt in self.contentValues(portal_type='Business Template'):
154
        if bt.getInstallationState() == 'installed':
155 156 157 158
          bt5 = bt
          if only_title:
            bt5 = bt.getTitle()
          installed_bts.append(bt5)
159
      return installed_bts
160

161 162 163 164 165 166 167 168 169 170
    def getInstalledBusinessTemplateList(self):
      """Get the list of installed business templates.
      """
      return self._getInstalledBusinessTemplateList(only_title=0)

    def getInstalledBusinessTemplateTitleList(self):
      """Get the list of installed business templates.
      """
      return self._getInstalledBusinessTemplateList(only_title=1)

171 172 173 174 175 176
    def getInstalledBusinessTemplateRevision(self, title, **kw):
      """
        Return the revision of business template installed with the title
        given
      """
      bt = self.getInstalledBusinessTemplate(title)
177 178 179
      if bt is not None:
        return bt.getRevision()
      return None
180

181 182
    def getBuiltBusinessTemplateList(self):
      """Get the list of built and not installed business templates.
183
      """
184 185 186
      return [bt for bt in self.objectValues(portal_type='Business Template')
                 if bt.getInstallationState() == 'not_installed' and
                    bt.getBuildingState() == 'built']
187

188 189 190 191 192 193
    @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
194
        edited business template with a URL like:
195 196 197 198 199 200 201 202 203 204 205
          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()
206 207 208
            modified = bt.getModificationDate()
            if last_bt[0] < modified and bt.getInstallationState() != 'deleted':
              last_bt = modified, bt
209 210 211 212 213 214 215 216 217 218 219
          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)
220

221
    security.declareProtected(Permissions.ManagePortal,
222 223
                              'getDefaultBusinessTemplateDownloadURL')
    def getDefaultBusinessTemplateDownloadURL(self):
224 225 226 227 228
      """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
229
    security.declareProtected('Import/Export objects', 'save')
230
    def save(self, business_template, REQUEST=None, RESPONSE=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
231
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
232
        Save the BusinessTemplate in the servers's filesystem.
Yoshinori Okuji's avatar
Yoshinori Okuji committed
233 234
      """
      cfg = getConfiguration()
Vincent Pelletier's avatar
Vincent Pelletier committed
235 236
      path = os.path.join(cfg.clienthome,
                          '%s' % (business_template.getTitle(),))
237
      path = pathname2url(path)
238
      business_template.export(path=path, local=True)
239
      if REQUEST is not None:
240
        psm = translateString('Saved in ${path} .',
241
                              mapping={'path':pathname2url(path)})
242
        ret_url = '%s/%s?portal_status_message=%s' % \
Vincent Pelletier's avatar
Vincent Pelletier committed
243
                  (business_template.absolute_url(),
244
                   REQUEST.get('form_id', 'view'), psm)
Vincent Pelletier's avatar
Vincent Pelletier committed
245 246 247
        if RESPONSE is None:
          RESPONSE = REQUEST.RESPONSE
        return REQUEST.RESPONSE.redirect( ret_url )
248 249 250 251

    security.declareProtected( 'Import/Export objects', 'export' )
    def export(self, business_template, REQUEST=None, RESPONSE=None):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
252 253
        Export the Business Template as a bt5 file and offer the user to
        download it.
254
      """
255
      export_string = business_template.export()
Aurel's avatar
Aurel committed
256
      try:
257 258 259 260
        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
261 262 263
        return export_string.getvalue()
      finally:
        export_string.close()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
264

265
    security.declareProtected( 'Import/Export objects', 'publish' )
266 267
    def publish(self, business_template, url, username=None, password=None):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
268
        Publish the given business template at the given URL.
269 270
      """
      business_template.build()
Vincent Pelletier's avatar
Vincent Pelletier committed
271
      export_string = self.manage_exportObject(id=business_template.getId(),
272
                                               download=True)
273
      bt = Resource(url, username=username, password=password)
Vincent Pelletier's avatar
Vincent Pelletier committed
274 275
      bt.put(file=export_string,
             content_type='application/x-erp5-business-template')
276
      business_template.setPublicationUrl(url)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
277

278 279
    def update(self, business_template):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
280
        Update an existing template from its publication URL.
281 282 283 284 285 286
      """
      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
287
      self._importObjectFromFile(StringIO(export_string), id=id)
288

289
    security.declareProtected( Permissions.ManagePortal, 'manage_download' )
290 291
    def manage_download(self, url, id=None, REQUEST=None):
      """The management interface for download.
292
      """
293 294
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
295

296
      bt = self.download(url, id=id)
297

298
      if REQUEST is not None:
299
        ret_url = bt.absolute_url()
Yusei Tahara's avatar
Yusei Tahara committed
300
        psm = translateString("Business template downloaded successfully.")
301
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
302
                                    % (ret_url, psm))
303

304 305 306
    def _download_local(self, path, bt_id):
      """Download Business Template from local directory or file
      """
307 308
      bt = self.newContent(bt_id, 'Business Template')
      bt.importFile(path)
309
      return bt
310 311 312 313

    def _download_url(self, url, bt_id):
      tempid, temppath = mkstemp()
      try:
314
        os.close(tempid) # Close the opened fd as soon as possible.
315 316 317 318 319
        file_path, headers = urlretrieve(url, temppath)
        if re.search(r'<title>Revision \d+:', open(file_path, 'r').read()):
          # 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
320

321 322 323 324 325 326 327 328
        return self._download_local(file_path, bt_id)
      finally:
        os.remove(temppath)

    def _download_svn(self, url, bt_id):
      svn_checkout_tmp_dir = mkdtemp()
      svn_checkout_dir = os.path.join(svn_checkout_tmp_dir, 'bt')
      try:
329 330
        from Products.ERP5VCS.WorkingCopy import getVcsTool
        getVcsTool('svn').__of__(self).export(url, svn_checkout_dir)
331 332 333 334 335 336 337 338 339 340 341 342 343
        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)
344

345 346 347 348
      if id is None:
        id = self.generateNewId()

      urltype, name = splittype(url)
349 350 351
      if WIN and urltype and '\\' in name:
        urltype = None
        name = url
352
      if urltype and urltype != 'file':
353
        if '/portal_templates/asRepository/' in url:
354 355 356 357 358
          # 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)]
359 360
        bt = self._download_url(url, id)
      else:
361
        bt = self._download_local(os.path.normpath(name), id)
362

363
      bt.build(no_action=True)
364
      return bt
Jean-Paul Smets's avatar
Jean-Paul Smets committed
365

366
    def importBase64EncodedText(self, file_data=None, id=None, REQUEST=None,
367
                                batch_mode=False, **kw):
368
      """
369 370 371
        Import Business Template from passed base64 encoded text.
      """
      import_file = StringIO(decodestring(file_data))
372
      return self.importFile(import_file = import_file, id = id, REQUEST = REQUEST,
373 374
                             batch_mode = batch_mode, **kw)

375
    def importFile(self, import_file=None, id=None, REQUEST=None,
376
                   batch_mode=False, **kw):
377
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
378
        Import Business Template from one file
379
      """
380 381
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
382

383 384 385 386 387
      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
388
          psm = translateString('No file or an empty file was specified.')
389 390
          REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                    % (self.absolute_url(), psm))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
391 392
          return
        else :
393
          raise RuntimeError, 'No file or an empty file was specified'
Aurel's avatar
Aurel committed
394
      # copy to a temp location
Alexandre Boeglin's avatar
Alexandre Boeglin committed
395
      import_file.seek(0) #Rewind to the beginning of file
396
      tempid, temppath = mkstemp()
397 398
      try:
        os.close(tempid) # Close the opened fd as soon as possible
399
        with open(temppath, 'wb') as tempfile:
400
          tempfile.write(import_file.read())
401
        bt = self._download_local(temppath, id)
402 403
      finally:
        os.remove(temppath)
404
      bt.build(no_action=True)
Aurel's avatar
Aurel committed
405
      bt.reindexObject()
406

407
      if not batch_mode and \
408
         (REQUEST is not None):
409
        ret_url = bt.absolute_url()
Yusei Tahara's avatar
Yusei Tahara committed
410
        psm = translateString("Business templates imported successfully.")
411 412
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                  % (ret_url, psm))
413
      elif batch_mode:
414
        return bt
415

416 417 418 419
    def getDiffFilterScriptList(self):
      """
      Return list of scripts usable to filter diff
      """
420
      # XXX, the "or ()" should not be there, the preference tool is
421 422
      # inconsistent, the called method should not return None when
      # nothing is selected
423
      portal = self.getPortalObject()
424 425 426 427 428 429 430 431
      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
432 433 434 435 436 437 438 439 440 441 442 443 444

    def getFilteredDiffAsHTML(self, diff):
      """
      Return the diff filtered by python scripts into html format
      """
      return self.getFilteredDiff(diff).toHTML()

    def getFilteredDiff(self, diff):
      """
      Filter the diff using python scripts
      """
      diff_file_object = DiffFile(diff)
      diff_block_list = diff_file_object.getModifiedBlockList()
445 446 447 448
      if diff_block_list:
        script_list = self.getDiffFilterScriptList()
        for block, line_tuple in diff_block_list:
          for script in script_list:
449 450
            if script(line_tuple[0], line_tuple[1]):
              diff_file_object.children.remove(block)
451
              break
452 453 454 455
      # XXX-Aurel : this method should return a text diff but
      # DiffFile does not provide yet such feature
      return diff_file_object

456 457 458
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
459
        This is compatible with ERP5VCS look and feel but
460 461 462 463
        it is preferred in future we use more difflib python library.
      """
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

464
    def diffObject(self, REQUEST, **kw):
Aurel's avatar
Aurel committed
465
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
466 467
        Make diff between two objects, whose paths are stored in values bt1
        and bt2 in the REQUEST object.
Aurel's avatar
Aurel committed
468
      """
469 470
      bt1_id = getattr(REQUEST, 'bt1', None)
      bt2_id = getattr(REQUEST, 'bt2', None)
471 472 473 474 475 476 477
      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
478
      else:
479 480 481 482 483
        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)
484

Vincent Pelletier's avatar
Vincent Pelletier committed
485 486 487 488
    security.declareProtected( 'Import/Export objects',
                               'updateRepositoryBusinessTemplateList' )

    def updateRepositoryBusinessTemplateList(self, repository_list,
489
        REQUEST=None, RESPONSE=None, genbt5list=0, **kw):
Vincent Pelletier's avatar
Vincent Pelletier committed
490 491
      """
        Update the information on Business Templates from repositories.
492 493 494

      For local repositories, if bt5list is missing or if genbt5list > 1,
      bt5list is automatically generated (but not saved on disk).
495 496
      """
      self.repository_dict = PersistentMapping()
497
      property_list = ('title', 'version', 'revision', 'description', 'license',
498
                       'dependency', 'test_dependency', 'provision', 'copyright')
Vincent Pelletier's avatar
Vincent Pelletier committed
499 500
      #LOG('updateRepositoryBusiessTemplateList', 0,
      #    'repository_list = %r' % (repository_list,))
501
      for repository in repository_list:
502 503 504 505 506 507 508 509 510 511 512 513 514
        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:
          bt5list = os.path.join(url, 'bt5list')
          if genbt5list > os.path.exists(bt5list):
            f = generateInformation(url)
            f.seek(0)
          else:
            f = open(bt5list, 'rb')
515
        try:
516 517 518 519 520 521 522 523 524 525 526
          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:
              raise RuntimeError, 'Invalid repository: %s' % repository
527
          try:
528
            property_dict_list = []
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
            root = doc.documentElement
            for template in root.getElementsByTagName("template"):
              id = template.getAttribute('id')
              if type(id) == type(u''):
                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
                      if type(value) == type(u''):
                        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
549 550
              property_dict['version'] = \
                  temp_property_dict.get('version', [''])[0]
Jérome Perrin's avatar
Jérome Perrin committed
551 552
              property_dict['revision'] = \
                  temp_property_dict.get('revision', [''])[0]
Vincent Pelletier's avatar
Vincent Pelletier committed
553 554 555 556 557 558
              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', ())
559 560
              property_dict['test_dependency_list'] = \
                  temp_property_dict.get('test_dependency', ())
561 562
              property_dict['provision_list'] = \
                  temp_property_dict.get('provision', ())
Vincent Pelletier's avatar
Vincent Pelletier committed
563 564
              property_dict['copyright_list'] = \
                  temp_property_dict.get('copyright', ())
565

566 567 568 569 570
              property_dict_list.append(property_dict)
          finally:
            doc.unlink()
        finally:
          f.close()
571

572
        self.repository_dict[repository] = tuple(property_dict_list)
573

574
      if REQUEST is not None:
575
        ret_url = self.absolute_url() + '/' + REQUEST.get('dialog_id', 'view')
Yusei Tahara's avatar
Yusei Tahara committed
576
        psm = translateString("Business templates updated successfully.")
577 578
        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))
579

Vincent Pelletier's avatar
Vincent Pelletier committed
580 581
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRepositoryList' )
582
    def getRepositoryList(self):
Vincent Pelletier's avatar
Vincent Pelletier committed
583 584
      """
        Get the list of repositories.
585 586
      """
      return self.repository_dict.keys()
587

588 589
    security.declarePublic( 'decodeRepositoryBusinessTemplateUid' )
    def decodeRepositoryBusinessTemplateUid(self, uid):
Vincent Pelletier's avatar
Vincent Pelletier committed
590 591 592
      """
        Decode the uid of a business template from a repository.
        Return a repository and an id.
593
      """
594
      return cPickle.loads(b64decode(uid))
595

596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
    security.declarePublic( 'encodeRepositoryBusinessTemplateUid' )
    def encodeRepositoryBusinessTemplateUid(self, repository, id):
      """
        encode the repository and the id of a business template.
        Return an uid.
      """
      return b64encode(cPickle.dumps((repository, id)))

    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;
      raise UnsupportedComparingOperator, 'Unsupported comparing operator: %s'%(operator,)
632

633 634 635 636 637 638 639 640 641 642 643 644 645 646
    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
647

648 649 650 651 652
    security.declareProtected(Permissions.AccessContentsInformation,
                               'getLastestBTOnRepos')
    def getLastestBTOnRepos(self, title, version_restriction=None):
      """
       It's possible we have different versions of the same BT
653
       available on various repositories or on the same repository.
654 655 656 657 658 659
       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
660
        for property_dict in property_dict_list:
661 662 663
          provision_list = property_dict.get('provision_list', [])
          if title in provision_list:
            raise BusinessTemplateIsMeta, 'Business Template %s is provided by another one'%(title,)
Jérome Perrin's avatar
Jérome Perrin committed
664
          if title == property_dict['title']:
665 666
            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
667
                result = (repository, property_dict['id'], property_dict['version'])
668 669 670 671
      if result is not None:
        return (result[0], result[1])
      else:
        raise BusinessTemplateUnknownError, 'Business Template %s (%s) could not be found in the repositories'%(title, version_restriction or '')
672

673 674 675 676 677 678 679 680 681 682 683 684 685 686
    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
687

688 689
    security.declareProtected(Permissions.AccessContentsInformation,
                               'getDependencyList')
690 691 692
    @transactional_cached(lambda self, bt, with_test_dependency_list=False:
                          (bt, with_test_dependency_list))
    def getDependencyList(self, bt, with_test_dependency_list=False):
693 694 695 696
      """
       Return the list of missing dependencies for a business
       template, given a tuple : (repository, id)
      """
697 698 699
      # We do not take into consideration the dependencies
      # for meta business templates
      if bt[0] != 'meta':
700 701 702 703 704
        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]:
705 706 707 708 709
                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])
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
                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:
                      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 '')
                    except BusinessTemplateIsMeta:
                      provider_list = self.getProviderList(dependency)
                      for provider in provider_list:
733
                        if self.getInstalledBusinessTemplate(provider) is not None:
734 735 736 737 738 739 740 741 742 743 744
                          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
        raise BusinessTemplateUnknownError, 'The Business Template %s could not be found on repository %s'%(bt[1], bt[0])
745
      return []
746

747 748 749 750 751 752 753 754 755 756 757
    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)
      raise BusinessTemplateUnknownError, 'Provider not found in bt_list'
758

759 760 761 762
    security.declareProtected(Permissions.AccessContentsInformation,
                              'sortBusinessTemplateList')
    def sortBusinessTemplateList(self, bt_list):
      """
763 764 765 766 767 768
      Sort a list of business template in repositories according to
      dependencies

      bt_list : list of (repository, id) tuple.
      """
      sorted_bt_list = []
769
      title_id_mapping = {}
770 771 772 773 774 775 776

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

777 778 779
      for repository, bt_id in bt_list:
        bt = [x for x in self.repository_dict[repository] \
              if x['id'] == bt_id][0]
780 781 782 783 784 785
        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]
786
        for provision in list(bt['provision_list']):
787 788
          provition_dict[provision] = bt_title
        undependent_list.append(bt_title)
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817

      # 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)
818 819 820
        if bt_id not in repository_dict:
          continue
        sorted_bt_list.insert(0, (repository_dict[bt_id], title_id_mapping[bt_id]))
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
        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):
        raise NotImplementedError, \
          "Circular dependencies on %s" % reverse_dependency_dict.keys()
      else:
        return sorted_bt_list
836

837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
    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
867 868
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRepositoryBusinessTemplateList' )
869
    def getRepositoryBusinessTemplateList(self, update_only=False,
870
             template_list=None, **kw):
871
      """Get the list of Business Templates in repositories.
872 873 874

         update_only: return only bt that needs to be updated
         template_list: only returns bt within the given list
875 876
      """
      from Products.ERP5Type.Document import newTempBusinessTemplate
877 878 879 880
      result_list = []
      template_set = None
      if template_list is not None:
        template_set = set(template_list)
881 882

      template_item_list = []
883 884 885 886 887 888 889 890 891 892
      # 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:
893
            if title not in template_item_dict:
Vincent Pelletier's avatar
Vincent Pelletier committed
894 895
              # If this is the first time to see this business template,
              # insert it.
896 897
              template_item_dict[title] = (repository, property_dict)
            else:
Vincent Pelletier's avatar
Vincent Pelletier committed
898 899 900 901
              # 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]
902 903
              if self.compareVersions(previous_property_dict['version'],
                                      property_dict['version']) < 0:
904
                template_item_dict[title] = (repository, property_dict)
905 906 907 908 909 910 911 912 913 914 915 916
      # 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'] \
917
                  and installed_bt.getRevision() != property_dict['revision']:
918 919
                    template_item_list.append((repository, property_dict))
          elif template_list is not None:
920 921 922 923 924
            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()
925
        id = filename = property_dict.pop('id')
926 927 928 929
        installed_bt = \
            self.getInstalledBusinessTemplate(property_dict['title'])
        if installed_bt is not None:
          installed_version = installed_bt.getVersion()
930 931
          installed_revision = installed_bt.getShortRevision()
          if installed_bt.getRevision() == property_dict['revision']:
932
            version_state = 'present'
933 934
          else:
            version_state = 'different'
935 936 937
        else:
          installed_version = ''
          installed_revision = ''
938
          version_state = 'new'
939
        uid = self.encodeRepositoryBusinessTemplateUid(repository, id)
940 941
        obj = newTempBusinessTemplate(self, 'temp_' + uid,
                                      version_state = version_state,
942
                                      version_state_title=version_state.title(),
943
                                      filename = filename,
944 945
                                      installed_version = installed_version,
                                      installed_revision = installed_revision,
946 947
                                      repository = repository, **property_dict)
        obj.setUid(uid)
948 949 950
        result_list.append(obj)
      result_list.sort(key=lambda x: x.getTitle())
      return result_list
951

Vincent Pelletier's avatar
Vincent Pelletier committed
952 953
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getUpdatedRepositoryBusinessTemplateList' )
954 955 956 957
    def getUpdatedRepositoryBusinessTemplateList(self, **kw):
      """Get the list of updated Business Templates in repositories.
      """
      #LOG('getUpdatedRepositoryBusinessTemplateList', 0, 'kw = %r' % (kw,))
958
      return self.getRepositoryBusinessTemplateList(update_only=True, **kw)
959

960
    def compareVersions(self, version1, version2):
Vincent Pelletier's avatar
Vincent Pelletier committed
961 962 963
      """
        Return negative if version1 < version2, 0 if version1 == version2,
        positive if version1 > version2.
964 965

      Here is the algorithm:
Vincent Pelletier's avatar
Vincent Pelletier committed
966 967
        - Non-alphanumeric characters are not significant, besides the function
          of delimiters.
968 969 970 971
        - 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
972
      This implements the following predicates:
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
        - 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
997

998 999 1000 1001 1002 1003 1004 1005
      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
1006

1007
    def _getBusinessTemplateUrlDict(self):
1008
      business_template_url_dict = {}
1009
      for bt in self.getRepositoryBusinessTemplateList():
1010
        url, name = self.decodeRepositoryBusinessTemplateUid(bt.getUid())
1011 1012 1013
        if name.endswith('.bt5'):
          name = name[:-4]
        business_template_url_dict[name] = {
Rafael Monnerat's avatar
Rafael Monnerat committed
1014
          'url': '%s/%s' % (url, bt.filename),
1015 1016 1017 1018 1019
          'revision': bt.getRevision()
          }
      return business_template_url_dict

    security.declareProtected(Permissions.ManagePortal,
Rafael Monnerat's avatar
Rafael Monnerat committed
1020
        'installBusinessTemplatesFromRepositories')
1021
    def installBusinessTemplatesFromRepositories(self, *args, **kw):
1022 1023
      """Deprecated.
      """
1024
      DeprecationWarning('installBusinessTemplatesFromRepositories is deprecated; Use self.installBusinessTemplateListFromRepository instead.', DeprecationWarning)
1025
      return self.installBusinessTemplateListFromRepository(*args, **kw)
1026

1027 1028
    security.declareProtected(Permissions.ManagePortal,
         'resolveBusinessTemplateListDependency')
1029 1030 1031
    def resolveBusinessTemplateListDependency(self,
                                              template_title_list,
                                              with_test_dependency_list=False):
1032
      available_bt5_list = self.getRepositoryBusinessTemplateList()
1033

1034
      template_title_list = set(template_title_list)
1035 1036
      installed_bt5_title_list = self.getInstalledBusinessTemplateTitleList()

1037
      bt5_set = set()
1038 1039
      for available_bt5 in available_bt5_list:
        if available_bt5.title in template_title_list:
1040
          template_title_list.remove(available_bt5.title)
1041 1042
          bt5 = self.decodeRepositoryBusinessTemplateUid(available_bt5.uid)
          bt5_set.add(bt5)
1043
          meta_dependency_set = set()
1044 1045 1046
          for dep_repository, dep_id in self.getDependencyList(
              bt5,
              with_test_dependency_list):
1047 1048 1049
            if dep_repository != 'meta':
              bt5_set.add((dep_repository, dep_id))
            else:
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
              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
1060
                for candidate in available_bt5_list:
1061
                  if candidate.title == provider:
1062 1063 1064
                    bt5_set.add(\
                      self.decodeRepositoryBusinessTemplateUid(
                          candidate.uid))
1065
                    break
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
                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:
              raise BusinessTemplateMissingDependency,\
                "Unable to resolve dependencies for %s, options are %s" \
                    % (dep_id, provider_list)
1081 1082 1083 1084

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

1087 1088 1089
    security.declareProtected(Permissions.ManagePortal,
        'installBusinessTemplateListFromRepository')
    def installBusinessTemplateListFromRepository(self, template_list,
1090
        only_different=True, update_catalog=False, activate=False,
1091
        install_dependency=False):
1092 1093 1094 1095
      """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
1096

1097 1098
      operation_log = []
      resolved_template_list = self.resolveBusinessTemplateListDependency(
1099
                   template_list)
1100 1101
      installed_bt5_dict = {x.getTitle(): x.getRevision()
        for x in self.getInstalledBusinessTemplateList()}
1102 1103
      if only_different:
        template_url_dict = self._getBusinessTemplateUrlDict()
1104 1105

      def checkAvailability(bt_title):
1106
        return bt_title in template_list or bt_title in installed_bt5_dict
1107 1108 1109 1110 1111 1112 1113
      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:
        raise BusinessTemplateMissingDependency,\
            "Impossible to install, please install the following dependencies before: %s" \
            % [x[1] for x in missing_dependency_list]
1114 1115

      activate_kw =  dict(activity="SQLQueue", tag="start_%s" % (time.time()))
1116
      for repository, bt_id in resolved_template_list:
1117 1118 1119
        if only_different:
          bt = template_url_dict.get(bt_id)
          if bt is not None and bt['revision'] == installed_bt5_dict.get(bt_id):
1120
            continue
1121
        bt_url = '%s/%s' % (repository, bt_id)
1122
        param_dict = dict(download_url=bt_url, only_different=only_different)
1123
        param_dict["update_catalog"] = update_catalog
1124 1125 1126 1127 1128 1129 1130

        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))
1131
        else:
1132 1133
          document = self.updateBusinessTemplateFromUrl(**param_dict)
          operation_log.append('Installed %s with revision %s' % (
1134
              document.getTitle(), document.getShortRevision()))
1135 1136

      return operation_log
1137

1138 1139 1140
    security.declareProtected(Permissions.ManagePortal,
            'updateBusinessTemplateFromUrl')
    def updateBusinessTemplateFromUrl(self, download_url, id=None,
1141 1142 1143
                                         keep_original_list=None,
                                         before_triggered_bt5_id_list=None,
                                         after_triggered_bt5_id_list=None,
1144
                                         update_catalog=False,
1145
                                         reinstall=False,
1146
                                         active_process=None,
Rafael Monnerat's avatar
Rafael Monnerat committed
1147
                                         force_keep_list=None,
1148
                                         only_different=True):
Rafael Monnerat's avatar
Rafael Monnerat committed
1149
      """
1150
        This method download and install a bt5, from a URL.
1151 1152 1153 1154 1155

        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
1156
      """
1157 1158 1159 1160 1161 1162 1163 1164
      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 = []
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
      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)
1178
      imported_bt5 = self.download(url = download_url, id = id)
1179 1180
      bt_title = imported_bt5.getTitle()

1181 1182 1183
      if reinstall:
        install_kw = None
      else:
1184 1185 1186 1187 1188 1189 1190
        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
1191 1192 1193

        install_kw = {}
        for listbox_line in imported_bt5.BusinessTemplate_getModifiedObject():
1194 1195
          item = listbox_line.object_id
          state = listbox_line.object_state
1196
          if state.startswith('Removed'):
1197 1198 1199 1200 1201 1202 1203 1204
            # 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
1205 1206 1207

          # For actions which suggest that item shall be kept and item is not
          # explicitely forced, keep the default -- do nothing
1208 1209
          # XXX: 'force_keep_list' variable is misnamed.
          should_keep = item not in force_keep_list and state in (
1210 1211
            'Modified but should be kept', 'Removed but should be kept')
          # If item is forced to be untouched, do not touch it
1212 1213
          if item in keep_original_list or should_keep:
            if not should_keep:
1214 1215 1216
              log('Item %r is in force_keep_list and keep_original_list,'
                  ' as keep_original_list has precedence item is NOT MODIFIED'
                  % item)
1217 1218 1219
            install_kw[item] = 'nothing'
          else:
            install_kw[item] = listbox_line.choice_item_list[0][1]
1220

1221 1222
      # Run before script list
      for before_triggered_bt5_id in before_triggered_bt5_id_list:
1223 1224 1225
        log('Execute %r' % before_triggered_bt5_id)
        imported_bt5.unrestrictedTraverse(before_triggered_bt5_id)()

1226 1227 1228 1229 1230 1231 1232
      # 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()

1233 1234
      imported_bt5.install(object_to_update=install_kw,
                           update_catalog=update_catalog)
1235

1236 1237
      # Run After script list
      for after_triggered_bt5_id in after_triggered_bt5_id_list:
1238 1239 1240 1241 1242 1243 1244 1245
        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))
1246

1247 1248
      return imported_bt5

1249 1250 1251 1252 1253 1254 1255
    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).
      """
1256 1257
      if base_url_list is None:
        base_url_list = self.getRepositoryList()
1258 1259 1260 1261 1262
      # 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
1263
          url = "file://%s/bt5/%s" % (getConfiguration().instancehome,
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
                                      bt5_title)
          LOG('ERP5', INFO, "TemplateTool: INSTANCE_HOME_REPOSITORY is %s." \
              % url)
        try:
          urllib2.urlopen(url)
          return url
        except (urllib2.HTTPError, OSError):
          # XXX Try again with ".bt5" in case the folder format be used
          # Instead tgz one.
          url = "%s.bt5" % url
          try:
            urllib2.urlopen(url)
            return url
          except (urllib2.HTTPError, OSError):
            pass
Rafael Monnerat's avatar
Rafael Monnerat committed
1279
      LOG('ERP5', INFO, 'TemplateTool: %s was not found into the url list: '
1280 1281 1282
                        '%s.' % (bt5_title, base_url_list))
      return None

1283 1284 1285
    security.declareProtected(Permissions.ManagePortal,
        'upgradeSite')
    def upgradeSite(self, bt5_list, deprecated_after_script_dict=None,
1286 1287
                    deprecated_reinstall_set=None, dry_run=False,
                    delete_orphaned=False,
1288 1289
                    keep_bt5_id_set=[],
                    update_catalog=False):
1290 1291 1292 1293 1294 1295 1296
      """
      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

1297 1298 1299
      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
1300 1301 1302 1303 1304

      deprecated_reinstall_set: this parameter needs to be removed
                                by setting it at business template level.
                                It list all business templates who needs
                                reinstall
1305 1306 1307 1308 1309 1310

      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.
1311
      """
1312
      # make sure that we updated information on repository
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
      self.updateRepositoryBusinessTemplateList(self.getRepositoryList())
      # do upgrade
      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)]
      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
1327 1328
        if (not(reinstall) and bt5.version_state == 'present') or \
            bt5.title in keep_bt5_id_set:
1329 1330 1331 1332 1333
          continue
        append("Update %s business template in state %s%s" % \
          (bt5.title, bt5.version_state, (reinstall and ' (reinstall)') or ''))
        if not(dry_run):
          bt5_url = "%s/%s" % (bt5.repository, bt5.title)
1334 1335
          self.updateBusinessTemplateFromUrl(bt5_url, reinstall=reinstall,
                                             update_catalog=update_catalog)
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
      if delete_orphaned:
        if keep_bt5_id_set is None:
          keep_bt5_id_set = set()
        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
          append("Uninstall business template %s" % bt.title)
1350
          if not(dry_run):
1351 1352 1353
            # XXX Here is missing parameters to really remove stuff
            bt.uninstall()

1354 1355
      return message_list

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