TemplateTool.py 62.1 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
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42
from Products.ERP5Type.Tool.BaseTool import BaseTool
43
from Products.ERP5Type.Cache import transactional_cached
44
from Products.ERP5Type import Permissions
45
from Products.ERP5.Document.BusinessTemplate import BusinessTemplateMissingDependency
46
from Products.ERP5.genbt5list import generateInformation
47
from Acquisition import aq_base
48
from tempfile import mkstemp, mkdtemp
Jean-Paul Smets's avatar
Jean-Paul Smets committed
49
from Products.ERP5 import _dtmldir
Aurel's avatar
Aurel committed
50
from cStringIO import StringIO
51
from urllib import pathname2url, urlopen, splittype, urlretrieve
52
import urllib2
53 54
import re
from xml.dom.minidom import parse
55
from xml.parsers.expat import ExpatError
56 57
import struct
import cPickle
58
from base64 import b64encode, b64decode
59
from Products.ERP5Type.Message import translateString
60
from zLOG import LOG, INFO, WARNING
61
from base64 import decodestring
62
import subprocess
63
import time
Jean-Paul Smets's avatar
Jean-Paul Smets committed
64

65
WIN = os.name == 'nt'
66

67 68
CATALOG_UPDATABLE = object()
ModuleSecurityInfo(__name__).declarePublic('CATALOG_UPDATABLE')
69

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

86 87
ModuleSecurityInfo(__name__).declarePublic('BusinessTemplateUnknownError')

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

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

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

    # Declarative Security
    security = ClassSecurityInfo()

111 112
    security.declareProtected(Permissions.ManagePortal, 'manage_overview')
    manage_overview = DTMLFile('explainTemplateTool', _dtmldir)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
113

114 115
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getInstalledBusinessTemplate')
116
    def getInstalledBusinessTemplate(self, title, strict=False, **kw):
117
      """Returns an installed version of business template of a given title.
118

119
        Returns None if business template is not installed or has been uninstalled.
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
          state = bt.getInstallationState()
          if state == 'installed':
            return bt
135 136 137 138 139 140 141 142 143
          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:
144 145 146 147 148 149
            t = bt.workflow_history \
              ['business_template_installation_workflow'][-1]['time']
            if last_time < t:
              last_bt = bt
              last_time = t
      return last_bt
150

151 152
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getInstalledBusinessTemplatesList')
153
    def getInstalledBusinessTemplatesList(self):
154 155 156 157 158
      """Deprecated.
      """
      DeprecationWarning('getInstalledBusinessTemplatesList is deprecated; Use getInstalledBusinessTemplateList instead.', DeprecationWarning)
      return self.getInstalledBusinessTemplateList()

159
    def _getInstalledBusinessTemplateList(self, only_title=0):
160
      """Get the list of installed business templates.
161 162
      """
      installed_bts = []
163
      for bt in self.contentValues(portal_type='Business Template'):
164
        if bt.getInstallationState() == 'installed':
165 166 167 168
          bt5 = bt
          if only_title:
            bt5 = bt.getTitle()
          installed_bts.append(bt5)
169
      return installed_bts
170

171 172
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getInstalledBusinessTemplateList')
173 174 175 176 177
    def getInstalledBusinessTemplateList(self):
      """Get the list of installed business templates.
      """
      return self._getInstalledBusinessTemplateList(only_title=0)

178 179
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getInstalledBusinessTemplateTitleList')
180 181 182 183 184
    def getInstalledBusinessTemplateTitleList(self):
      """Get the list of installed business templates.
      """
      return self._getInstalledBusinessTemplateList(only_title=1)

185 186
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getInstalledBusinessTemplateRevision')
187 188 189 190 191 192
    def getInstalledBusinessTemplateRevision(self, title, **kw):
      """
        Return the revision of business template installed with the title
        given
      """
      bt = self.getInstalledBusinessTemplate(title)
193 194 195
      if bt is not None:
        return bt.getRevision()
      return None
196

197 198
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getBuiltBusinessTemplateList')
199 200
    def getBuiltBusinessTemplateList(self):
      """Get the list of built and not installed business templates.
201
      """
202 203 204
      return [bt for bt in self.objectValues(portal_type='Business Template')
                 if bt.getInstallationState() == 'not_installed' and
                    bt.getBuildingState() == 'built']
205

206 207 208 209 210 211
    @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
212
        edited business template with a URL like:
213 214 215 216 217 218 219 220 221 222 223
          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()
224 225 226
            modified = bt.getModificationDate()
            if last_bt[0] < modified and bt.getInstallationState() != 'deleted':
              last_bt = modified, bt
227 228 229 230 231 232 233 234 235 236 237
          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)
238

239
    security.declareProtected(Permissions.ManagePortal,
240 241
                              'getDefaultBusinessTemplateDownloadURL')
    def getDefaultBusinessTemplateDownloadURL(self):
242 243 244 245 246
      """Returns the default download URL for business templates.
      """
      return "file://%s/" % pathname2url(
                  os.path.join(getConfiguration().instancehome, 'bt5'))

247
    security.declareProtected('Import/Export objects', 'save')
248
    def save(self, business_template, REQUEST=None, RESPONSE=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
249
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
250
        Save the BusinessTemplate in the servers's filesystem.
Yoshinori Okuji's avatar
Yoshinori Okuji committed
251 252
      """
      cfg = getConfiguration()
Vincent Pelletier's avatar
Vincent Pelletier committed
253 254
      path = os.path.join(cfg.clienthome,
                          '%s' % (business_template.getTitle(),))
255
      path = pathname2url(path)
256
      business_template.export(path=path, local=True)
257
      if REQUEST is not None:
258
        psm = translateString('Saved in ${path} .',
259
                              mapping={'path':pathname2url(path)})
260
        ret_url = '%s/%s?portal_status_message=%s' % \
Vincent Pelletier's avatar
Vincent Pelletier committed
261
                  (business_template.absolute_url(),
262
                   REQUEST.get('form_id', 'view'), psm)
Vincent Pelletier's avatar
Vincent Pelletier committed
263 264 265
        if RESPONSE is None:
          RESPONSE = REQUEST.RESPONSE
        return REQUEST.RESPONSE.redirect( ret_url )
266 267 268 269

    security.declareProtected( 'Import/Export objects', 'export' )
    def export(self, business_template, REQUEST=None, RESPONSE=None):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
270 271
        Export the Business Template as a bt5 file and offer the user to
        download it.
272
      """
273
      export_string = business_template.export()
Aurel's avatar
Aurel committed
274
      try:
275 276 277 278
        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
279 280 281
        return export_string.getvalue()
      finally:
        export_string.close()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
282

283
    security.declareProtected( 'Import/Export objects', 'publish' )
284 285
    def publish(self, business_template, url, username=None, password=None):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
286
        Publish the given business template at the given URL.
287 288
      """
      business_template.build()
Vincent Pelletier's avatar
Vincent Pelletier committed
289
      export_string = self.manage_exportObject(id=business_template.getId(),
290
                                               download=True)
291
      bt = Resource(url, username=username, password=password)
Vincent Pelletier's avatar
Vincent Pelletier committed
292 293
      bt.put(file=export_string,
             content_type='application/x-erp5-business-template')
294
      business_template.setPublicationUrl(url)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
295

296
    security.declareProtected(Permissions.ManagePortal, 'update')
297 298
    def update(self, business_template):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
299
        Update an existing template from its publication URL.
300 301 302 303 304 305
      """
      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
306
      self._importObjectFromFile(StringIO(export_string), id=id)
307

308
    security.declareProtected( Permissions.ManagePortal, 'manage_download' )
309 310
    def manage_download(self, url, id=None, REQUEST=None):
      """The management interface for download.
311
      """
312 313
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
314

315
      bt = self.download(url, id=id)
316

317
      if REQUEST is not None:
318
        ret_url = bt.absolute_url()
Yusei Tahara's avatar
Yusei Tahara committed
319
        psm = translateString("Business template downloaded successfully.")
320
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
321
                                    % (ret_url, psm))
322

323 324 325
    def _download_local(self, path, bt_id):
      """Download Business Template from local directory or file
      """
326 327
      bt = self.newContent(bt_id, 'Business Template')
      bt.importFile(path)
328
      return bt
329 330 331 332

    def _download_url(self, url, bt_id):
      tempid, temppath = mkstemp()
      try:
333
        os.close(tempid) # Close the opened fd as soon as possible.
334
        file_path, headers = urlretrieve(url, temppath)
335
        if re.search(r'<title>.*Revision \d+:', open(file_path, 'r').read()):
336 337 338
          # 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)
339

340 341 342 343 344
        return self._download_local(file_path, bt_id)
      finally:
        os.remove(temppath)

    def _download_svn(self, url, bt_id):
345 346 347 348 349
      try:
        from erp5.component.module.WorkingCopy import getVcsTool
      except ImportError:
        raise RuntimeError("VCS features require 'erp5_forge' bt5")

350 351 352
      svn_checkout_tmp_dir = mkdtemp()
      svn_checkout_dir = os.path.join(svn_checkout_tmp_dir, 'bt')
      try:
353
        getVcsTool('svn').__of__(self).export(url, svn_checkout_dir)
354 355 356 357 358 359 360 361 362 363 364 365 366
        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)
367

368 369 370
      if id is None:
        id = self.generateNewId()

371 372
      urltype, path = splittype(url)
      if WIN and urltype and '\\' in path:
373
        urltype = None
374
        path = url
375
      if urltype and urltype != 'file':
376
        if '/portal_templates/asRepository/' in url:
377 378 379 380 381
          # 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)]
382 383
        bt = self._download_url(url, id)
      else:
384 385
        path = os.path.normpath(os.path.expanduser(path))
        bt = self._download_local(path, id)
386

387
      bt.build(no_action=True)
388
      return bt
Jean-Paul Smets's avatar
Jean-Paul Smets committed
389

390
    security.declareProtected('Import/Export objects', 'importBase64EncodedText')
391
    def importBase64EncodedText(self, file_data=None, id=None, REQUEST=None,
392
                                batch_mode=False, **kw):
393
      """
394 395 396
        Import Business Template from passed base64 encoded text.
      """
      import_file = StringIO(decodestring(file_data))
397
      return self.importFile(import_file = import_file, id = id, REQUEST = REQUEST,
398 399
                             batch_mode = batch_mode, **kw)

400
    security.declareProtected('Import/Export objects', 'importFile')
401
    def importFile(self, import_file=None, id=None, REQUEST=None,
402
                   batch_mode=False, **kw):
403
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
404
        Import Business Template from one file
405
      """
406 407
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
408

409 410 411 412 413
      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
414
          psm = translateString('No file or an empty file was specified.')
415 416
          REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                    % (self.absolute_url(), psm))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
417 418
          return
        else :
419
          raise RuntimeError, 'No file or an empty file was specified'
Aurel's avatar
Aurel committed
420
      # copy to a temp location
Alexandre Boeglin's avatar
Alexandre Boeglin committed
421
      import_file.seek(0) #Rewind to the beginning of file
422
      tempid, temppath = mkstemp()
423 424
      try:
        os.close(tempid) # Close the opened fd as soon as possible
425
        with open(temppath, 'wb') as tempfile:
426
          tempfile.write(import_file.read())
427
        bt = self._download_local(temppath, id)
428 429
      finally:
        os.remove(temppath)
430
      bt.build(no_action=True)
Aurel's avatar
Aurel committed
431
      bt.reindexObject()
432

433
      if not batch_mode and \
434
         (REQUEST is not None):
435
        ret_url = bt.absolute_url()
Yusei Tahara's avatar
Yusei Tahara committed
436
        psm = translateString("Business templates imported successfully.")
437 438
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                  % (ret_url, psm))
439
      elif batch_mode:
440
        return bt
441

442
    security.declareProtected(Permissions.ManagePortal, 'getDiffFilterScriptList')
443 444 445 446
    def getDiffFilterScriptList(self):
      """
      Return list of scripts usable to filter diff
      """
447
      # XXX, the "or ()" should not be there, the preference tool is
448 449
      # inconsistent, the called method should not return None when
      # nothing is selected
450
      portal = self.getPortalObject()
451 452 453 454 455 456 457 458
      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
459

460
    security.declareProtected(Permissions.ManagePortal, 'getFilteredDiffAsHTML')
461 462 463 464 465 466
    def getFilteredDiffAsHTML(self, diff):
      """
      Return the diff filtered by python scripts into html format
      """
      return self.getFilteredDiff(diff).toHTML()

467
    def _cleanUpTemplateFolder(self, folder_path):
468 469
      file_object_list = [x for x in os.listdir(folder_path)]
      for file_object in file_object_list:
470 471 472 473 474 475
        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)

476 477
    security.declareProtected( 'Import/Export objects', 'importAndReExportBusinessTemplateFromPath' )
    def importAndReExportBusinessTemplateFromPath(self, template_path):
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
      """
        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)
500 501 502 503 504
        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)
505 506 507 508 509
      except:
        raise
      finally:
        shutil.rmtree(export_dir)

510 511
    security.declareProtected( 'Import/Export objects', 'importAndReExportBusinessTemplateListFromPath' )
    def importAndReExportBusinessTemplateListFromPath(self, repository_list, REQUEST=None, **kw):
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
      """
        Migrate business templates to new format where files like .py or .html
        are exported seprately than the xml.
      """
      repository_list = filter(bool, repository_list)

      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
        
      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'))
                                    
      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:
537 538
              self.activate(activity='SQLQueue').\
                importAndReExportBusinessTemplateFromPath(template_path)
539

540
    security.declareProtected(Permissions.ManagePortal, 'getFilteredDiff')
541 542 543 544
    def getFilteredDiff(self, diff):
      """
      Filter the diff using python scripts
      """
545
      from erp5.component.module.DiffUtils import DiffFile
546 547
      diff_file_object = DiffFile(diff)
      diff_block_list = diff_file_object.getModifiedBlockList()
548 549 550 551
      if diff_block_list:
        script_list = self.getDiffFilterScriptList()
        for block, line_tuple in diff_block_list:
          for script in script_list:
552 553
            if script(line_tuple[0], line_tuple[1]):
              diff_file_object.children.remove(block)
554
              break
555 556 557 558
      # XXX-Aurel : this method should return a text diff but
      # DiffFile does not provide yet such feature
      return diff_file_object

559
    security.declareProtected(Permissions.ManagePortal, 'diffObjectAsHTML')
560 561 562
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
563
        This is compatible with ERP5VCS look and feel but
564 565
        it is preferred in future we use more difflib python library.
      """
566
      from erp5.component.module.DiffUtils import DiffFile
567 568
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

569
    security.declareProtected(Permissions.ManagePortal, 'diffObject')
570
    def diffObject(self, REQUEST, **kw):
Aurel's avatar
Aurel committed
571
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
572 573
        Make diff between two objects, whose paths are stored in values bt1
        and bt2 in the REQUEST object.
Aurel's avatar
Aurel committed
574
      """
575 576
      bt1_id = getattr(REQUEST, 'bt1', None)
      bt2_id = getattr(REQUEST, 'bt2', None)
577 578 579 580 581 582 583
      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
584
      else:
585 586 587 588 589
        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)
590

Vincent Pelletier's avatar
Vincent Pelletier committed
591 592 593 594
    security.declareProtected( 'Import/Export objects',
                               'updateRepositoryBusinessTemplateList' )

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

599 600 601 602
      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
603 604
      """
      self.repository_dict = PersistentMapping()
605
      property_list = ('title', 'version', 'revision', 'description', 'license',
606 607
                       'dependency', 'test_dependency', 'provision', 'copyright',
                       'force_install')
Vincent Pelletier's avatar
Vincent Pelletier committed
608 609
      #LOG('updateRepositoryBusiessTemplateList', 0,
      #    'repository_list = %r' % (repository_list,))
610
      for repository in repository_list:
611 612 613 614 615 616 617
        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:
618
          url = os.path.expanduser(url)
619 620 621 622 623 624
          bt5list = os.path.join(url, 'bt5list')
          if genbt5list > os.path.exists(bt5list):
            f = generateInformation(url)
            f.seek(0)
          else:
            f = open(bt5list, 'rb')
625
        try:
626 627 628 629 630 631 632 633 634 635 636
          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
637
          try:
638
            property_dict_list = []
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
            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
659 660
              property_dict['version'] = \
                  temp_property_dict.get('version', [''])[0]
Jérome Perrin's avatar
Jérome Perrin committed
661 662
              property_dict['revision'] = \
                  temp_property_dict.get('revision', [''])[0]
Vincent Pelletier's avatar
Vincent Pelletier committed
663 664 665 666 667 668
              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', ())
669 670
              property_dict['test_dependency_list'] = \
                  temp_property_dict.get('test_dependency', ())
671 672
              property_dict['provision_list'] = \
                  temp_property_dict.get('provision', ())
Vincent Pelletier's avatar
Vincent Pelletier committed
673 674
              property_dict['copyright_list'] = \
                  temp_property_dict.get('copyright', ())
675 676
              property_dict['force_install'] = \
                  int(temp_property_dict.get('force_install', [0])[0])
677

678 679 680 681 682
              property_dict_list.append(property_dict)
          finally:
            doc.unlink()
        finally:
          f.close()
683

684
        self.repository_dict[repository] = tuple(property_dict_list)
685

686
      if REQUEST is not None:
687
        ret_url = self.absolute_url() + '/' + REQUEST.get('dialog_id', 'view')
Yusei Tahara's avatar
Yusei Tahara committed
688
        psm = translateString("Business templates updated successfully.")
689 690
        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))
691

Vincent Pelletier's avatar
Vincent Pelletier committed
692 693
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRepositoryList' )
694
    def getRepositoryList(self):
Vincent Pelletier's avatar
Vincent Pelletier committed
695 696
      """
        Get the list of repositories.
697 698
      """
      return self.repository_dict.keys()
699

700 701
    security.declarePublic( 'decodeRepositoryBusinessTemplateUid' )
    def decodeRepositoryBusinessTemplateUid(self, uid):
Vincent Pelletier's avatar
Vincent Pelletier committed
702 703 704
      """
        Decode the uid of a business template from a repository.
        Return a repository and an id.
705
      """
706
      return cPickle.loads(b64decode(uid))
707

708 709 710 711 712 713 714 715
    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)))

716
    security.declarePublic('compareVersionStrings')
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
    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,)
745

746 747 748 749 750 751 752 753 754 755 756 757 758 759
    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
760

761 762 763 764 765
    security.declareProtected(Permissions.AccessContentsInformation,
                               'getLastestBTOnRepos')
    def getLastestBTOnRepos(self, title, version_restriction=None):
      """
       It's possible we have different versions of the same BT
766
       available on various repositories or on the same repository.
767 768 769 770 771 772
       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
773
        for property_dict in property_dict_list:
774 775 776
          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
777
          if title == property_dict['title']:
778 779
            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):
780
                result = (repository, property_dict['id'], property_dict['version'])
781 782 783 784
      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 '')
785

786 787 788 789 790 791 792 793 794 795 796 797 798 799
    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
800

801 802
    security.declareProtected(Permissions.AccessContentsInformation,
                               'getDependencyList')
803 804 805
    @transactional_cached(lambda self, bt, with_test_dependency_list=False:
                          (bt, with_test_dependency_list))
    def getDependencyList(self, bt, with_test_dependency_list=False):
806 807 808 809
      """
       Return the list of missing dependencies for a business
       template, given a tuple : (repository, id)
      """
810 811 812
      # We do not take into consideration the dependencies
      # for meta business templates
      if bt[0] != 'meta':
813 814 815 816 817
        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]:
818 819 820 821 822
                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])
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
                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:
846
                        if self.getInstalledBusinessTemplate(provider) is not None:
847 848 849 850 851 852 853 854 855 856 857
                          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])
858
      return []
859

860 861
    security.declareProtected(Permissions.ManagePortal,
                              'findProviderInBTList')
862 863 864 865 866 867 868 869 870 871 872
    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'
873

874 875 876 877
    security.declareProtected(Permissions.AccessContentsInformation,
                              'sortBusinessTemplateList')
    def sortBusinessTemplateList(self, bt_list):
      """
878 879 880 881 882 883
      Sort a list of business template in repositories according to
      dependencies

      bt_list : list of (repository, id) tuple.
      """
      sorted_bt_list = []
884
      title_id_mapping = {}
885 886 887 888 889 890 891

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

892 893 894
      for repository, bt_id in bt_list:
        bt = [x for x in self.repository_dict[repository] \
              if x['id'] == bt_id][0]
895 896 897 898 899 900
        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]
901
        for provision in list(bt['provision_list']):
902 903
          provition_dict[provision] = bt_title
        undependent_list.append(bt_title)
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932

      # 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)
933 934 935
        if bt_id not in repository_dict:
          continue
        sorted_bt_list.insert(0, (repository_dict[bt_id], title_id_mapping[bt_id]))
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
        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
951

952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
    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
982 983
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRepositoryBusinessTemplateList' )
984
    def getRepositoryBusinessTemplateList(self, update_only=False,
985
             template_list=None, **kw):
986
      """Get the list of Business Templates in repositories.
987 988 989

         update_only: return only bt that needs to be updated
         template_list: only returns bt within the given list
990
      """
991 992 993 994
      result_list = []
      template_set = None
      if template_list is not None:
        template_set = set(template_list)
995 996

      template_item_list = []
997 998 999 1000 1001 1002 1003 1004 1005 1006
      # 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:
1007
            if title not in template_item_dict:
Vincent Pelletier's avatar
Vincent Pelletier committed
1008 1009
              # If this is the first time to see this business template,
              # insert it.
1010 1011
              template_item_dict[title] = (repository, property_dict)
            else:
Vincent Pelletier's avatar
Vincent Pelletier committed
1012 1013 1014 1015
              # 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]
1016 1017
              if self.compareVersions(previous_property_dict['version'],
                                      property_dict['version']) < 0:
1018
                template_item_dict[title] = (repository, property_dict)
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
      # 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'] \
1031
                  and installed_bt.getRevision() != property_dict['revision']:
1032 1033
                    template_item_list.append((repository, property_dict))
          elif template_list is not None:
1034 1035 1036 1037 1038
            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()
1039
        id = filename = property_dict.pop('id')
1040 1041 1042 1043
        installed_bt = \
            self.getInstalledBusinessTemplate(property_dict['title'])
        if installed_bt is not None:
          installed_version = installed_bt.getVersion()
1044 1045
          installed_revision = installed_bt.getShortRevision()
          if installed_bt.getRevision() == property_dict['revision']:
1046
            version_state = 'present'
1047 1048
          else:
            version_state = 'different'
1049 1050 1051
        else:
          installed_version = ''
          installed_revision = ''
1052
          version_state = 'new'
1053
        uid = self.encodeRepositoryBusinessTemplateUid(repository, id)
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
        obj = self.newContent(temp_object=True,
                              portal_type='Business Template',
                              id='temp_' + uid,
                              version_state=version_state,
                              version_state_title=version_state.title(),
                              filename=filename,
                              installed_version=installed_version,
                              installed_revision=installed_revision,
                              repository=repository,
                              **property_dict)
1064
        obj.setUid(uid)
1065 1066 1067
        result_list.append(obj)
      result_list.sort(key=lambda x: x.getTitle())
      return result_list
1068

Vincent Pelletier's avatar
Vincent Pelletier committed
1069 1070
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getUpdatedRepositoryBusinessTemplateList' )
1071 1072 1073 1074
    def getUpdatedRepositoryBusinessTemplateList(self, **kw):
      """Get the list of updated Business Templates in repositories.
      """
      #LOG('getUpdatedRepositoryBusinessTemplateList', 0, 'kw = %r' % (kw,))
1075
      return self.getRepositoryBusinessTemplateList(update_only=True, **kw)
1076

1077
    security.declarePublic('compareVersions')
1078
    def compareVersions(self, version1, version2):
Vincent Pelletier's avatar
Vincent Pelletier committed
1079 1080 1081
      """
        Return negative if version1 < version2, 0 if version1 == version2,
        positive if version1 > version2.
1082 1083

      Here is the algorithm:
Vincent Pelletier's avatar
Vincent Pelletier committed
1084 1085
        - Non-alphanumeric characters are not significant, besides the function
          of delimiters.
1086 1087 1088 1089
        - 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
1090
      This implements the following predicates:
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
        - 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
1115

1116 1117 1118 1119 1120 1121 1122 1123
      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
1124

1125
    def _getBusinessTemplateUrlDict(self):
1126
      business_template_url_dict = {}
1127
      for bt in self.getRepositoryBusinessTemplateList():
1128
        url, name = self.decodeRepositoryBusinessTemplateUid(bt.getUid())
1129 1130 1131
        if name.endswith('.bt5'):
          name = name[:-4]
        business_template_url_dict[name] = {
1132
          'url': '%s/%s' % (url, bt.filename),
1133 1134 1135 1136 1137
          'revision': bt.getRevision()
          }
      return business_template_url_dict

    security.declareProtected(Permissions.ManagePortal,
Rafael Monnerat's avatar
Rafael Monnerat committed
1138
        'installBusinessTemplatesFromRepositories')
1139
    def installBusinessTemplatesFromRepositories(self, *args, **kw):
1140 1141
      """Deprecated.
      """
1142
      DeprecationWarning('installBusinessTemplatesFromRepositories is deprecated; Use self.installBusinessTemplateListFromRepository instead.', DeprecationWarning)
1143
      return self.installBusinessTemplateListFromRepository(*args, **kw)
1144

1145 1146
    security.declareProtected(Permissions.ManagePortal,
         'resolveBusinessTemplateListDependency')
1147 1148 1149
    def resolveBusinessTemplateListDependency(self,
                                              template_title_list,
                                              with_test_dependency_list=False):
1150
      available_bt5_list = self.getRepositoryBusinessTemplateList()
1151

1152
      template_title_list = set(template_title_list)
1153 1154
      installed_bt5_title_list = self.getInstalledBusinessTemplateTitleList()

1155
      bt5_set = set()
1156 1157
      for available_bt5 in available_bt5_list:
        if available_bt5.title in template_title_list:
1158
          template_title_list.remove(available_bt5.title)
1159 1160
          bt5 = self.decodeRepositoryBusinessTemplateUid(available_bt5.uid)
          bt5_set.add(bt5)
1161
          meta_dependency_set = set()
1162 1163 1164
          for dep_repository, dep_id in self.getDependencyList(
              bt5,
              with_test_dependency_list):
1165 1166 1167
            if dep_repository != 'meta':
              bt5_set.add((dep_repository, dep_id))
            else:
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
              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
1178
                for candidate in available_bt5_list:
1179
                  if candidate.title == provider:
1180 1181 1182
                    bt5_set.add(\
                      self.decodeRepositoryBusinessTemplateUid(
                          candidate.uid))
1183
                    break
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
                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)
1199 1200 1201 1202

      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())
1203 1204
      return self.sortBusinessTemplateList(list(bt5_set))

1205 1206 1207
    security.declareProtected(Permissions.ManagePortal,
        'installBusinessTemplateListFromRepository')
    def installBusinessTemplateListFromRepository(self, template_list,
1208
        only_different=True, update_catalog=False, activate=False,
1209
        install_dependency=False):
1210 1211 1212 1213
      """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
1214

1215 1216
      operation_log = []
      resolved_template_list = self.resolveBusinessTemplateListDependency(
1217
                   template_list)
1218 1219
      installed_bt5_dict = {x.getTitle(): x.getRevision()
        for x in self.getInstalledBusinessTemplateList()}
1220 1221
      if only_different:
        template_url_dict = self._getBusinessTemplateUrlDict()
1222 1223

      def checkAvailability(bt_title):
1224
        return bt_title in template_list or bt_title in installed_bt5_dict
1225 1226 1227 1228 1229 1230 1231
      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]
1232 1233

      activate_kw =  dict(activity="SQLQueue", tag="start_%s" % (time.time()))
1234
      for repository, bt_id in resolved_template_list:
1235 1236 1237
        if only_different:
          bt = template_url_dict.get(bt_id)
          if bt is not None and bt['revision'] == installed_bt5_dict.get(bt_id):
1238
            continue
1239
        bt_url = '%s/%s' % (repository, bt_id)
1240
        param_dict = dict(download_url=bt_url, only_different=only_different)
1241
        param_dict["update_catalog"] = update_catalog
1242 1243 1244 1245 1246 1247 1248

        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))
1249
        else:
1250 1251
          document = self.updateBusinessTemplateFromUrl(**param_dict)
          operation_log.append('Installed %s with revision %s' % (
1252
              document.getTitle(), document.getShortRevision()))
1253 1254

      return operation_log
1255

1256 1257 1258
    security.declareProtected(Permissions.ManagePortal,
            'updateBusinessTemplateFromUrl')
    def updateBusinessTemplateFromUrl(self, download_url, id=None,
1259 1260 1261
                                         keep_original_list=None,
                                         before_triggered_bt5_id_list=None,
                                         after_triggered_bt5_id_list=None,
1262
                                         update_catalog=False,
1263
                                         reinstall=False,
1264
                                         active_process=None,
1265
                                         force_keep_list=None,
1266
                                         only_different=True):
1267
      """
1268
        This method download and install a bt5, from a URL.
1269 1270 1271 1272 1273

        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
1274
      """
1275 1276 1277 1278 1279 1280 1281 1282
      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 = []
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
      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)
1296
      imported_bt5 = self.download(url = download_url, id = id)
1297 1298
      bt_title = imported_bt5.getTitle()

1299 1300 1301
      if reinstall:
        install_kw = None
      else:
1302 1303 1304 1305 1306 1307 1308
        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
1309 1310 1311

        install_kw = {}
        for listbox_line in imported_bt5.BusinessTemplate_getModifiedObject():
1312 1313
          item = listbox_line.object_id
          state = listbox_line.object_state
1314
          if state.startswith('Removed'):
1315 1316 1317 1318 1319 1320 1321 1322
            # 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