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

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

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

66 67
_MARKER = []

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
84
class TemplateTool (BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
85
    """
86
      TemplateTool manages Business Templates.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
87

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

101 102
    # This stores information on repositories.
    repository_dict = {}
Jean-Paul Smets's avatar
Jean-Paul Smets committed
103 104 105 106 107

    # Declarative Security
    security = ClassSecurityInfo()

    security.declareProtected( Permissions.ManagePortal, 'manage_overview' )
Aurel's avatar
Aurel committed
108
    manage_overview = DTMLFile( 'explainTemplateTool', _dtmldir )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
109

110
    def getInstalledBusinessTemplate(self, title, strict=False, **kw):
111
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
112
        Return an installed version of business template of a certain title.
113 114 115

        It not "installed" business template is found, look at replaced ones.
        This is mostly usefull if we are looking for the installed business
116 117
        template in a transaction replacing an existing business template.
        If strict is true, we do not take care of "replaced" business templates.
118 119
      """
      # This can be slow if, say, 10000 business templates are present.
Vincent Pelletier's avatar
Vincent Pelletier committed
120 121 122
      # 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.
123 124
      latest_bt = None
      latest_revision = 0
125
      for bt in self.contentValues(filter={'portal_type':'Business Template'}):
126 127 128
        if bt.getTitle() == title:
          installation_state = bt.getInstallationState()
          if installation_state == 'installed':
129 130
            latest_bt = bt
            break
131
          elif strict is False and installation_state == 'replaced':
132 133 134 135 136
            revision = bt.getRevision()
            try:
              revision = int(revision)
            except ValueError:
              continue
137 138 139
            if revision > latest_revision:
              latest_bt = bt
      return latest_bt
140

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

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

159 160 161 162 163 164 165 166 167 168
    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)

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

179
    def getBuiltBusinessTemplatesList(self):
180 181 182 183 184 185 186
      """Deprecated.
      """
      DeprecationWarning('getBuiltBusinessTemplatesList is deprecated; Use getBuiltBusinessTemplateList instead.', DeprecationWarning)
      return self.getBuiltBusinessTemplateList()

    def getBuiltBusinessTemplateList(self):
      """Get the list of built and not installed business templates.
187 188
      """
      built_bts = []
189
      for bt in self.contentValues(portal_type='Business Template'):
190 191 192
        if bt.getInstallationState() == 'not_installed' and bt.getBuildingState() == 'built':
          built_bts.append(bt)
      return built_bts
193

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
    @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
        revision of a business template with a URL like:
          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()
            revision = int(bt.getRevision())
            if last_bt[0] < revision and bt.getInstallationState() != 'deleted':
              last_bt = revision, bt
          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)
226

227
    security.declareProtected(Permissions.ManagePortal,
228 229
                              'getDefaultBusinessTemplateDownloadURL')
    def getDefaultBusinessTemplateDownloadURL(self):
230 231 232 233 234
      """Returns the default download URL for business templates.
      """
      return "file://%s/" % pathname2url(
                  os.path.join(getConfiguration().instancehome, 'bt5'))

235 236
    security.declareProtected( 'Import/Export objects', 'save' )
    def save(self, business_template, REQUEST=None, RESPONSE=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
237
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
238
        Save the BusinessTemplate in the servers's filesystem.
Yoshinori Okuji's avatar
Yoshinori Okuji committed
239 240
      """
      cfg = getConfiguration()
Vincent Pelletier's avatar
Vincent Pelletier committed
241 242
      path = os.path.join(cfg.clienthome,
                          '%s' % (business_template.getTitle(),))
243
      path = pathname2url(path)
244
      business_template.export(path=path, local=True)
245
      if REQUEST is not None:
246
        psm = translateString('Saved in ${path} .',
247
                              mapping={'path':pathname2url(path)})
248
        ret_url = '%s/%s?portal_status_message=%s' % \
Vincent Pelletier's avatar
Vincent Pelletier committed
249
                  (business_template.absolute_url(),
250
                   REQUEST.get('form_id', 'view'), psm)
Vincent Pelletier's avatar
Vincent Pelletier committed
251 252 253
        if RESPONSE is None:
          RESPONSE = REQUEST.RESPONSE
        return REQUEST.RESPONSE.redirect( ret_url )
254 255 256 257

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

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

284 285
    def update(self, business_template):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
286
        Update an existing template from its publication URL.
287 288 289 290 291 292
      """
      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
293
      self._importObjectFromFile(StringIO(export_string), id=id)
294

Aurel's avatar
Aurel committed
295 296
    def _importBT(self, path=None, id=id):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
297
        Import template from a temp file (as uploaded by the user)
Aurel's avatar
Aurel committed
298
      """
299
      file = open(path, 'rb')
300 301 302 303 304 305
      try:
        # read magic key to determine wich kind of bt we use
        file.seek(0)
        magic = file.read(5)
      finally:
        file.close()
306

Aurel's avatar
Aurel committed
307 308 309 310
      if magic == '<?xml': # old version
        self._importObjectFromFile(path, id=id)
        bt = self[id]
        bt.id = id # Make sure id is consistent
311
        bt.setProperty('template_format_version', 0, type='int')
Aurel's avatar
Aurel committed
312
      else: # new version
Vincent Pelletier's avatar
Vincent Pelletier committed
313 314
        # XXX: should really check for a magic and offer a falback if it
        # doens't correspond to anything handled.
Aurel's avatar
Aurel committed
315
        tar = tarfile.open(path, 'r:gz')
316 317
        try:
          # create bt object
318
          bt = self.newContent(portal_type='Business Template', id=id)
319 320
          prop_dict = {}
          for prop in bt.propertyMap():
Aurel's avatar
Aurel committed
321
            prop_type = prop['type']
322
            pid = prop['id']
323
            prop_path = posixpath.join(tar.members[0].name, 'bt', pid)
324 325
            try:
              info = tar.getmember(prop_path)
326
              value = tar.extractfile(info).read()
327
            except KeyError:
328
              value = None
329 330 331 332 333
            if value is 'None':
              # At export time, we used to export non-existent properties:
              #   str(obj.getProperty('non-existing')) == 'None'
              # Discard them
              continue
334 335 336 337 338 339
            if prop_type in ('text', 'string'):
              prop_dict[pid] = value or ''
            elif prop_type in ('int', 'boolean'):
              prop_dict[pid] = value or 0
            elif prop_type in ('lines', 'tokens'):
              prop_dict[pid[:-5]] = (value or '').splitlines()
340 341 342
          prop_dict.pop('id', '')
          bt.edit(**prop_dict)
          # import all other files from bt
343
          fobj = open(path, 'rb')
344
          try:
345 346 347 348 349
            bt.importFile(file=fobj)
          finally:
            fobj.close()
        finally:
          tar.close()
Aurel's avatar
Aurel committed
350 351
      return bt

352
    security.declareProtected( Permissions.ManagePortal, 'manage_download' )
353 354
    def manage_download(self, url, id=None, REQUEST=None):
      """The management interface for download.
355
      """
356 357
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
358

359
      bt = self.download(url, id=id)
360

361
      if REQUEST is not None:
362
        ret_url = bt.absolute_url()
Yusei Tahara's avatar
Yusei Tahara committed
363
        psm = translateString("Business template downloaded successfully.")
364
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
365
                                    % (ret_url, psm))
366

367 368 369 370 371
    def _download_local(self, path, bt_id):
      """Download Business Template from local directory or file
      """
      if os.path.isdir(os.path.normpath(path)):
        path = os.path.normpath(path)
372 373 374 375 376 377 378 379 380 381
        def callback(file_list, directory, files):
          for excluded_directory in ('CVS', '.svn'):
            try:
              files.remove(excluded_directory)
            except ValueError:
              pass
          for file in files:
            absolute_path = os.path.join(directory, file)
            if os.path.isfile(absolute_path):
              file_list.append(absolute_path)
382

383
        file_list = []
384
        os.path.walk(path, callback, file_list)
Aurel's avatar
Aurel committed
385 386
        file_list.sort()
        # import bt object
387 388
        bt = self.newContent(portal_type='Business Template', id=bt_id)
        bt_path = os.path.join(path, 'bt')
Aurel's avatar
Aurel committed
389 390

        # import properties
391
        prop_dict = {}
Aurel's avatar
Aurel committed
392
        for prop in bt.propertyMap():
Aurel's avatar
Aurel committed
393
          prop_type = prop['type']
Aurel's avatar
Aurel committed
394
          pid = prop['id']
395 396
          prop_path = os.path.join('.', bt_path, pid)
          if not os.path.exists(prop_path):
397 398 399
            value = None
          else:
            value = open(prop_path, 'rb').read()
400 401 402 403
          if value is 'None':
            # At export time, we used to export non-existent properties:
            #   str(obj.getProperty('non-existing')) == 'None'
            # Discard them
404 405 406
            value = None
          if prop_type in ('text', 'string'):
            prop_dict[pid] = value or ''
407
          elif prop_type in ('int', 'boolean'):
408
            prop_dict[pid] = value or 0
Aurel's avatar
Aurel committed
409
          elif prop_type in ('lines', 'tokens'):
410
            prop_dict[pid[:-5]] = (value or '').splitlines()
411
        prop_dict.pop('id', '')
412
        bt.edit(**prop_dict)
Aurel's avatar
Aurel committed
413
        # import all others objects
414
        bt.importFile(dir=True, file=file_list, root_path=path)
415
        return bt
Aurel's avatar
Aurel committed
416
      else:
417 418 419 420 421 422
        # this should be a file
        return self._importBT(path, bt_id)

    def _download_url(self, url, bt_id):
      tempid, temppath = mkstemp()
      try:
423
        os.close(tempid) # Close the opened fd as soon as possible.
424 425 426 427 428
        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
429
        
430 431 432 433 434 435 436 437
        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:
438 439
        from Products.ERP5VCS.WorkingCopy import getVcsTool
        getVcsTool('svn').__of__(self).export(url, svn_checkout_dir)
440 441 442 443
        return self._download_local(svn_checkout_dir, bt_id)
      finally:
        shutil.rmtree(svn_checkout_tmp_dir)

444 445 446 447 448 449 450 451 452 453 454 455
    def assertBtPathExists(self, url):
      """
      Check if bt is present on the system
      """
      urltype, name = splittype(url)
      # Windows compatibility
      if WIN:
        if os.path.isdir(os.path.normpath(url)) or \
           os.path.isfile(os.path.normpath(url)):
          name = os.path.normpath(url)
      return os.path.exists(os.path.normpath(name))

456 457 458 459 460 461 462 463 464
    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)
465

466 467 468 469 470 471 472 473 474 475
      if id is None:
        id = self.generateNewId()

      urltype, name = splittype(url)
      # Windows compatibility
      if WIN:
        if os.path.isdir(os.path.normpath(url)) or \
           os.path.isfile(os.path.normpath(url)):
          urltype = 'file'
          name = os.path.normpath(url)
476

477
      if urltype and urltype != 'file':
478
        if '/portal_templates/asRepository/' in url:
479 480 481 482 483
          # 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)]
484 485 486 487
        bt = self._download_url(url, id)
      else:
        bt = self._download_local(name, id)

488
      bt.build(no_action=True)
489
      return bt
Jean-Paul Smets's avatar
Jean-Paul Smets committed
490

491
    def importBase64EncodedText(self, file_data=None, id=None, REQUEST=None,
492
                                batch_mode=False, **kw):
493
      """
494 495 496
        Import Business Template from passed base64 encoded text.
      """
      import_file = StringIO(decodestring(file_data))
497
      return self.importFile(import_file = import_file, id = id, REQUEST = REQUEST,
498 499
                             batch_mode = batch_mode, **kw)

500
    def importFile(self, import_file=None, id=None, REQUEST=None,
501
                   batch_mode=False, **kw):
502
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
503
        Import Business Template from one file
504
      """
505 506
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
507

508 509 510 511 512
      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
513
          psm = translateString('No file or an empty file was specified.')
514 515
          REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                    % (self.absolute_url(), psm))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
516 517
          return
        else :
518
          raise RuntimeError, 'No file or an empty file was specified'
Aurel's avatar
Aurel committed
519
      # copy to a temp location
Alexandre Boeglin's avatar
Alexandre Boeglin committed
520
      import_file.seek(0) #Rewind to the beginning of file
521
      tempid, temppath = mkstemp()
522 523
      try:
        os.close(tempid) # Close the opened fd as soon as possible
524
        tempfile = open(temppath, 'wb')
525 526 527 528 529 530 531
        try:
          tempfile.write(import_file.read())
        finally:
          tempfile.close()
        bt = self._importBT(temppath, id)
      finally:
        os.remove(temppath)
532
      bt.build(no_action=True)
Aurel's avatar
Aurel committed
533
      bt.reindexObject()
534

535
      if not batch_mode and \
536
         (REQUEST is not None):
537
        ret_url = bt.absolute_url()
Yusei Tahara's avatar
Yusei Tahara committed
538
        psm = translateString("Business templates imported successfully.")
539 540
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                  % (ret_url, psm))
541
      elif batch_mode:
542
        return bt
543

544 545
    security.declareProtected(Permissions.ManagePortal, 'runUnitTestList')
    def runUnitTestList(self, test_list=[],
546
                        sql_connection_string='',
547
                        save=False, load=False,
548
                        repository_list=None,
549 550
                        REQUEST=None, RESPONSE=None, **kwd):
      """Runs Unit Tests related to this Business Template
551
      """
552 553
      if repository_list is None:
        repository_list = []
Vincent Pelletier's avatar
Vincent Pelletier committed
554 555
      # XXX: should check for file presence before trying to execute.
      # XXX: should check if the unit test file is configured in the BT
556
      site_configuration = getConfiguration()
557
      from Products.ERP5Type.tests.runUnitTest import getUnitTestFile
558
      import Products.ERP5
559 560 561 562 563 564 565 566
      if RESPONSE is not None:
        outfile = RESPONSE
      elif REQUEST is not None:
        outfile = RESPONSE = REQUEST.RESPONSE
      else:
        outfile =  StringIO()
      if RESPONSE is not None:
        RESPONSE.setHeader('Content-type', 'text/plain')
567 568
      current_sys_path = sys.path
      # add path with tests
569 570
      current_sys_path.append(os.path.join(site_configuration.instancehome,
        'tests'))
571

572
      test_cmd_args = [sys.executable, getUnitTestFile()]
573
      test_cmd_args += ['--erp5_sql_connection_string', sql_connection_string]
574 575 576 577
      if load:
        test_cmd_args += ['--load']
      if save:
        test_cmd_args += ['--save']
578
      # pass currently used product path to test runner
579 580 581 582 583 584
      products_path_list = site_configuration.products
      # add products from Zope, as some sites are not providing it
      zope_products_path = os.path.join(site_configuration.softwarehome, 'Products')
      if zope_products_path not in products_path_list:
        products_path_list.append(zope_products_path)
      test_cmd_args += ['--products_path', ','.join(products_path_list)]
585
      test_cmd_args += ['--sys_path', ','.join(current_sys_path)]
586
      bt5_path_list = []
587 588 589
      ## XXX-TODO: requires that asRepository works without security, maybe
      ##           with special key?
      # bt5_path_list.append(self.absolute_url() + '/asRepository/')
590 591 592
      # add passed repository list
      bt5_path_list.extend(repository_list)
      # adding locally saved Business Templates, not perfect, but helps some
593
      # people doing strict TTW development
Łukasz Nowak's avatar
Łukasz Nowak committed
594
      bt5_path_list.append(site_configuration.clienthome)
595
      test_cmd_args += ['--bt5_path', ','.join(bt5_path_list)]
596
      test_cmd_args += test_list
597 598 599 600 601 602 603 604 605
      # prepare message - intentionally without any additional formatting, as
      # only developer will read it, and they will have to understand issues in
      # case of test failures
      invoke_command_message = 'Running tests using command: %r'% test_cmd_args
      # as it is like using external interface, log what is send there
      LOG('TemplateTool.runUnitTestList', INFO, invoke_command_message)
      # inform developer how test are invoked
      outfile.write(invoke_command_message + '\n')
      outfile.flush()
606 607 608 609
      process = subprocess.Popen(test_cmd_args,
                                 stdout=subprocess.PIPE,
                                 stderr=subprocess.STDOUT)

610 611 612 613
      # "for line in process.stdout" is cleaner but is buffered,
      # see http://bugs.python.org/issue3907
      # We use this ugly construct to avoid waiting for test
      # termination before printing content
614 615 616 617 618 619
      while True:
        line = process.stdout.readline()
        if not line:
          break
        outfile.write(line)
        outfile.flush()
620

621 622
      if hasattr(outfile, 'getvalue'):
        return outfile.getvalue()
623

624 625 626 627
    def getDiffFilterScriptList(self):
      """
      Return list of scripts usable to filter diff
      """
628
      # XXX, the "or ()" should not be there, the preference tool is
629 630
      # inconsistent, the called method should not return None when
      # nothing is selected
631
      portal = self.getPortalObject()
632 633 634 635 636 637 638 639
      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
640 641 642 643 644 645 646 647 648 649 650 651 652

    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()
653 654 655 656
      if diff_block_list:
        script_list = self.getDiffFilterScriptList()
        for block, line_tuple in diff_block_list:
          for script in script_list:
657 658
            if script(line_tuple[0], line_tuple[1]):
              diff_file_object.children.remove(block)
659
              break
660 661 662 663
      # XXX-Aurel : this method should return a text diff but
      # DiffFile does not provide yet such feature
      return diff_file_object

664 665 666
    def diffObjectAsHTML(self, REQUEST, **kw):
      """
        Convert diff into a HTML format before reply
667
        This is compatible with ERP5VCS look and feel but
668 669 670 671
        it is preferred in future we use more difflib python library.
      """
      return DiffFile(self.diffObject(REQUEST, **kw)).toHTML()

672
    def diffObject(self, REQUEST, **kw):
Aurel's avatar
Aurel committed
673
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
674 675
        Make diff between two objects, whose paths are stored in values bt1
        and bt2 in the REQUEST object.
Aurel's avatar
Aurel committed
676
      """
677 678
      bt1_id = getattr(REQUEST, 'bt1', None)
      bt2_id = getattr(REQUEST, 'bt2', None)
679 680 681 682 683 684 685
      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
686
      else:
687 688 689 690 691
        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)
692

Vincent Pelletier's avatar
Vincent Pelletier committed
693 694 695 696 697 698 699
    security.declareProtected( 'Import/Export objects',
                               'updateRepositoryBusinessTemplateList' )

    def updateRepositoryBusinessTemplateList(self, repository_list,
                                             REQUEST=None, RESPONSE=None, **kw):
      """
        Update the information on Business Templates from repositories.
700 701
      """
      self.repository_dict = PersistentMapping()
702
      property_list = ('title', 'version', 'revision', 'description', 'license',
703
                       'dependency', 'provision', 'copyright')
Vincent Pelletier's avatar
Vincent Pelletier committed
704 705
      #LOG('updateRepositoryBusiessTemplateList', 0,
      #    'repository_list = %r' % (repository_list,))
706 707 708 709 710
      for repository in repository_list:
        url = '/'.join([repository, 'bt5list'])
        f = urlopen(url)
        property_dict_list = []
        try:
711 712 713 714 715 716 717 718 719 720 721
          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
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
          try:
            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
743 744
              property_dict['version'] = \
                  temp_property_dict.get('version', [''])[0]
Jérome Perrin's avatar
Jérome Perrin committed
745 746
              property_dict['revision'] = \
                  temp_property_dict.get('revision', [''])[0]
Vincent Pelletier's avatar
Vincent Pelletier committed
747 748 749 750 751 752
              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', ())
753 754
              property_dict['provision_list'] = \
                  temp_property_dict.get('provision', ())
Vincent Pelletier's avatar
Vincent Pelletier committed
755 756
              property_dict['copyright_list'] = \
                  temp_property_dict.get('copyright', ())
757

758 759 760 761 762
              property_dict_list.append(property_dict)
          finally:
            doc.unlink()
        finally:
          f.close()
763

764
        self.repository_dict[repository] = tuple(property_dict_list)
765

766
      if REQUEST is not None:
767
        ret_url = self.absolute_url() + '/' + REQUEST.get('dialog_id', 'view')
Yusei Tahara's avatar
Yusei Tahara committed
768
        psm = translateString("Business templates updated successfully.")
769 770
        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))
771

Vincent Pelletier's avatar
Vincent Pelletier committed
772 773
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRepositoryList' )
774
    def getRepositoryList(self):
Vincent Pelletier's avatar
Vincent Pelletier committed
775 776
      """
        Get the list of repositories.
777 778
      """
      return self.repository_dict.keys()
779

780 781
    security.declarePublic( 'decodeRepositoryBusinessTemplateUid' )
    def decodeRepositoryBusinessTemplateUid(self, uid):
Vincent Pelletier's avatar
Vincent Pelletier committed
782 783 784
      """
        Decode the uid of a business template from a repository.
        Return a repository and an id.
785
      """
786
      return cPickle.loads(b64decode(uid))
787

788 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 818 819 820 821 822 823
    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,)
824

825 826 827 828 829 830 831 832 833 834 835 836 837 838
    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
839

840 841 842 843 844
    security.declareProtected(Permissions.AccessContentsInformation,
                               'getLastestBTOnRepos')
    def getLastestBTOnRepos(self, title, version_restriction=None):
      """
       It's possible we have different versions of the same BT
845
       available on various repositories or on the same repository.
846 847 848 849 850 851
       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
852
        for property_dict in property_dict_list:
853 854 855
          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
856
          if title == property_dict['title']:
857 858 859 860 861 862 863
            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):
                result = (repository,  property_dict['id'], property_dict['version'])
      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 '')
864

865 866 867 868 869 870 871 872 873 874 875 876 877 878
    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
879

880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
    security.declareProtected(Permissions.AccessContentsInformation,
                               'getDependencyList')
    def getDependencyList(self, bt):
      """
       Return the list of missing dependencies for a business
       template, given a tuple : (repository, id)
      """
      # We do not take into consideration the dependencies
      # for meta business templates
      if bt[0] == 'meta':
        return []
      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]:
              dependency_list = property_dict['dependency_list']
              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:
903 904 905 906
                  version_restriction = dependency_couple_list[1]
                  if version_restriction.startswith('('):
                    # Something like "(>= 1.0rc6)".
                    version_restriction = version_restriction[1:-1]
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 933 934 935 936 937 938 939 940 941 942
                require_update = False
                installed_bt = self.portal_templates.getInstalledBusinessTemplate(dependency)
                if version_restriction is not None:
                  if installed_bt is not None:
                    # Check if the installed version require an update
                    if not self.compareVersionStrings(installed_bt.getVersion(), version_restriction):
                      operator = version_restriction.split(' ')[0]
                      if operator in ('<', '<<', '<='):
                        raise BusinessTemplateMissingDependency, '%s (%s) is present but %s require: %s (%s)'%(dependency, installed_bt.getVersion(), property_dict['title'], dependency, version_restriction)
                      else:
                        require_update = True
                if (require_update or installed_bt is None) \
                  and dependency not in result_list:
                  # Get the lastest version of the dependency on the
                  # repository that meet the version restriction
                  provider_installed = False
                  try:
                    bt_dep = self.getLastestBTOnRepos(dependency, version_restriction)
                  except BusinessTemplateUnknownError:
                    raise BusinessTemplateMissingDependency, 'The following dependency could not be satisfied: %s (%s)\nReason: Business Template could not be found in the repositories'%(dependency, version_restriction or '')
                  except BusinessTemplateIsMeta:
                    provider_list = self.getProviderList(dependency)
                    for provider in provider_list:
                      if self.portal_templates.getInstalledBusinessTemplate(provider) is not None:
                        provider_installed = True
                        break
                    if not provider_installed:
                      bt_dep = ('meta', dependency)
                  if not provider_installed:
                    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])
943

944 945 946 947 948 949 950 951 952 953 954
    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'
955

956 957 958 959
    security.declareProtected(Permissions.AccessContentsInformation,
                              'sortBusinessTemplateList')
    def sortBusinessTemplateList(self, bt_list):
      """
960 961 962 963 964 965
      Sort a list of business template in repositories according to
      dependencies

      bt_list : list of (repository, id) tuple.
      """
      sorted_bt_list = []
966
      title_id_mapping = {}
967 968 969 970 971 972 973

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

974 975 976
      for repository, bt_id in bt_list:
        bt = [x for x in self.repository_dict[repository] \
              if x['id'] == bt_id][0]
977 978 979 980 981 982
        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]
983
        for provision in list(bt['provision_list']):
984 985
          provition_dict[provision] = bt_title
        undependent_list.append(bt_title)
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014

      # 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)
1015 1016 1017
        if bt_id not in repository_dict:
          continue
        sorted_bt_list.insert(0, (repository_dict[bt_id], title_id_mapping[bt_id]))
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
        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
1033

1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
    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
1064 1065
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRepositoryBusinessTemplateList' )
1066 1067
    def getRepositoryBusinessTemplateList(self, update_only=False,
                                          newest_only=False, **kw):
1068 1069
      """Get the list of Business Templates in repositories.
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
1070 1071
      version_state_title_dict = { 'new' : 'New', 'present' : 'Present',
                                   'old' : 'Old' }
1072 1073 1074 1075 1076

      from Products.ERP5Type.Document import newTempBusinessTemplate
      template_list = []

      template_item_list = []
1077
      if update_only or newest_only:
1078 1079 1080 1081 1082 1083
        # 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 title not in template_item_dict:
Vincent Pelletier's avatar
Vincent Pelletier committed
1084 1085
              # If this is the first time to see this business template,
              # insert it.
1086 1087
              template_item_dict[title] = (repository, property_dict)
            else:
Vincent Pelletier's avatar
Vincent Pelletier committed
1088 1089 1090 1091
              # 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]
Jérome Perrin's avatar
Jérome Perrin committed
1092
              diff_version = self.compareVersions(previous_property_dict['version'],
1093 1094
                                                  property_dict['version'])
              if diff_version < 0:
1095
                template_item_dict[title] = (repository, property_dict)
1096
              elif diff_version == 0 \
Jérome Perrin's avatar
Jérome Perrin committed
1097 1098
                   and previous_property_dict['revision'] \
                   and property_dict['revision'] \
1099
                   and int(previous_property_dict['revision']) < int(property_dict['revision']):
Jérome Perrin's avatar
Jérome Perrin committed
1100
                      template_item_dict[title] = (repository, property_dict)
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
        if update_only:
          # Next, select only updated business templates.
          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 installed_bt.getRevision() \
                   and property_dict['revision'] \
                   and int(installed_bt.getRevision()) < int(property_dict['revision']):
                     template_item_list.append((repository, property_dict))
        else:
          template_item_list = template_item_dict.values()
1118 1119 1120 1121 1122 1123 1124 1125 1126
      else:
        for repository, property_dict_list in self.repository_dict.items():
          for property_dict in property_dict_list:
            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()
        id = property_dict['id']
1127
        filename = property_dict['id']
1128 1129 1130
        del property_dict['id']
        version = property_dict['version']
        version_state = 'new'
1131 1132 1133 1134 1135 1136
        installed_bt = \
            self.getInstalledBusinessTemplate(property_dict['title'])
        if installed_bt is not None:
          installed_version = installed_bt.getVersion()
          installed_revision = installed_bt.getRevision()
          result = self.compareVersions(version, installed_version)
1137 1138 1139 1140
          if result == 0:
            version_state = 'present'
          elif result < 0:
            version_state = 'old'
1141 1142 1143
        else:
          installed_version = ''
          installed_revision = ''
1144
        version_state_title = version_state_title_dict[version_state]
1145
        uid = self.encodeRepositoryBusinessTemplateUid(repository, id)
1146 1147 1148
        obj = newTempBusinessTemplate(self, 'temp_' + uid,
                                      version_state = version_state,
                                      version_state_title = version_state_title,
1149
                                      filename = filename,
1150 1151
                                      installed_version = installed_version,
                                      installed_revision = installed_revision,
1152 1153 1154
                                      repository = repository, **property_dict)
        obj.setUid(uid)
        template_list.append(obj)
1155
      template_list.sort(key=lambda x: x.getTitle())
1156 1157
      return template_list

Vincent Pelletier's avatar
Vincent Pelletier committed
1158 1159
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getUpdatedRepositoryBusinessTemplateList' )
1160 1161 1162 1163
    def getUpdatedRepositoryBusinessTemplateList(self, **kw):
      """Get the list of updated Business Templates in repositories.
      """
      #LOG('getUpdatedRepositoryBusinessTemplateList', 0, 'kw = %r' % (kw,))
1164
      return self.getRepositoryBusinessTemplateList(update_only=True, **kw)
1165

1166
    def compareVersions(self, version1, version2):
Vincent Pelletier's avatar
Vincent Pelletier committed
1167 1168 1169
      """
        Return negative if version1 < version2, 0 if version1 == version2,
        positive if version1 > version2.
1170 1171

      Here is the algorithm:
Vincent Pelletier's avatar
Vincent Pelletier committed
1172 1173
        - Non-alphanumeric characters are not significant, besides the function
          of delimiters.
1174 1175 1176 1177
        - 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
1178
      This implements the following predicates:
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
        - 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
1203

1204 1205 1206 1207 1208 1209 1210 1211
      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
1212

1213
    def _getBusinessTemplateUrlDict(self, newest_only=False):
1214
      business_template_url_dict = {}
1215 1216
      for bt in self.getRepositoryBusinessTemplateList(\
                                    newest_only=newest_only):
1217
        url, name = self.decodeRepositoryBusinessTemplateUid(bt.getUid())
1218 1219 1220
        if name.endswith('.bt5'):
          name = name[:-4]
        business_template_url_dict[name] = {
1221
          'url':  '%s/%s' % (url, bt.filename),
1222 1223 1224 1225 1226
          'revision': bt.getRevision()
          }
      return business_template_url_dict

    security.declareProtected(Permissions.ManagePortal,
Rafael Monnerat's avatar
Rafael Monnerat committed
1227
        'installBusinessTemplatesFromRepositories')
1228
    def installBusinessTemplatesFromRepositories(self, template_list,
1229
        only_newer=True, update_catalog=_MARKER):
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
      """Deprecated.
      """
      DeprecationWarning('getInstalledBusinessTemplatesList is deprecated; Use getInstalledBusinessTemplateList instead.', DeprecationWarning)
      return self.installBusinessTemplateListFromRepository(template_list,
        only_newer, update_catalog, activate=False)

    security.declareProtected(Permissions.ManagePortal,
        'installBusinessTemplateListFromRepository')
    def installBusinessTemplateListFromRepository(self, template_list,
        only_newer=True, update_catalog=_MARKER, activate=False):
1240 1241 1242 1243 1244
      """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
      opreation_log = []
1245
      template_dict = self._getBusinessTemplateUrlDict(only_newer)
1246 1247 1248 1249 1250 1251 1252 1253
      for template_name in template_list:
        if template_name in template_dict:
          installed_bt = self.getInstalledBusinessTemplate(template_name)
          if installed_bt is None or not only_newer or \
              installed_bt.getRevision() < template_dict[
              template_name]['revision']:
            template_document = self.download(template_dict[template_name][
              'url'])
1254 1255 1256 1257
            if update_catalog is _MARKER:
              template_document.install()
            else:
              template_document.install(update_catalog=update_catalog)
1258 1259 1260 1261 1262 1263 1264 1265
            opreation_log.append('Installed %s with revision %s' % (
              template_document.getTitle(), template_document.getRevision()))
          else:
            opreation_log.append('Skipped %s' % template_name)
        else:
          opreation_log.append('Not found in repositories %s' % template_name)
      return opreation_log

1266 1267 1268
    security.declareProtected(Permissions.ManagePortal,
            'updateBusinessTemplateFromUrl')
    def updateBusinessTemplateFromUrl(self, download_url, id=None,
1269 1270 1271
                                         keep_original_list=None,
                                         before_triggered_bt5_id_list=None,
                                         after_triggered_bt5_id_list=None,
1272
                                         update_catalog=_MARKER,
1273
                                         reinstall=False,
1274
                                         active_process=None,
1275
                                         force_keep_list=None):
1276 1277
      """ 
        This method download and install a bt5, from a URL.
1278 1279 1280 1281 1282

        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
1283
      """
1284 1285 1286 1287 1288 1289 1290 1291
      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 = []
1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
      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)
1305
      imported_bt5 = self.download(url = download_url, id = id)
1306 1307
      bt_title = imported_bt5.getTitle()

1308
      if not reinstall:
1309
        previous_bt5 = self.getInstalledBusinessTemplate(bt_title)
1310 1311 1312 1313
        if previous_bt5 is not None:
          try:
            imported_revision = int(imported_bt5.getRevision())
            previous_revision = int(previous_bt5.getRevision())
1314 1315 1316 1317 1318
            if imported_revision <= previous_revision:
              log("%s is already installed with revision %i, which is same or "
                  "newer revision than new revision %i." % (bt_title,
                    previous_revision, imported_revision))
              return imported_bt5
1319
          except ValueError:
1320 1321 1322 1323
            pass

        install_kw = {}
        for listbox_line in imported_bt5.BusinessTemplate_getModifiedObject():
1324 1325
          item = listbox_line.object_id
          state = listbox_line.object_state
1326
          if state.startswith('Removed'):
1327 1328 1329 1330 1331 1332 1333 1334
            # 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
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345

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

1350 1351
      # Run before script list
      for before_triggered_bt5_id in before_triggered_bt5_id_list:
1352 1353 1354
        log('Execute %r' % before_triggered_bt5_id)
        imported_bt5.unrestrictedTraverse(before_triggered_bt5_id)()

1355 1356 1357 1358
      update_catalog_kw = {}
      if update_catalog is not _MARKER:
        update_catalog_kw = dict(update_catalog=update_catalog)

1359
      if reinstall:
1360
        imported_bt5.install(force=True,**update_catalog_kw)
1361 1362
      else:
        imported_bt5.install(object_to_update=install_kw,
1363
                             **update_catalog_kw)
1364

1365 1366
      # Run After script list
      for after_triggered_bt5_id in after_triggered_bt5_id_list:
1367 1368 1369 1370 1371 1372 1373 1374
        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))
1375

1376 1377
      return imported_bt5

1378 1379 1380 1381 1382 1383 1384
    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).
      """
1385 1386
      if base_url_list is None:
        base_url_list = self.getRepositoryList()
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411
      # 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":
          url = "file://%s/bt5/%s" % (getConfiguration().instancehome, 
                                      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
      LOG('ERP5', INFO, 'TemplateTool: %s was not found into the url list: ' 
                        '%s.' % (bt5_title, base_url_list))
      return None

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