TemplateTool.py 51.4 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
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 175 176
    def getInstalledBusinessTemplateRevision(self, title, **kw):
      """
        Return the revision of business template installed with the title
        given
      """
      bt = self.getInstalledBusinessTemplate(title)
      return bt.getRevision()

177
    def getBuiltBusinessTemplatesList(self):
178 179 180 181 182 183 184
      """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.
185 186
      """
      built_bts = []
187
      for bt in self.contentValues(portal_type='Business Template'):
188 189 190
        if bt.getInstallationState() == 'not_installed' and bt.getBuildingState() == 'built':
          built_bts.append(bt)
      return built_bts
191

192 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
    @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)
224

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

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

    security.declareProtected( 'Import/Export objects', 'export' )
    def export(self, business_template, REQUEST=None, RESPONSE=None):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
256 257
        Export the Business Template as a bt5 file and offer the user to
        download it.
258
      """
259
      path = business_template.getTitle()
260
      path = pathname2url(path)
261
      # XXX Why is it necessary to create a temporary directory?
262
      tmpdir_path = mkdtemp()
263
      # XXX not thread safe
264
      current_directory = os.getcwd()
265
      os.chdir(tmpdir_path)
266 267
      absolute_path = os.path.abspath(path)
      export_string = business_template.export(path=absolute_path)
268
      os.chdir(current_directory)
269
      if RESPONSE is not None:
270
        RESPONSE.setHeader('Content-type','tar/x-gzip')
271
        RESPONSE.setHeader('Content-Disposition',
272
                           'inline;filename=%s-%s.bt5' % \
273
                               (path,
274
                                business_template.getVersion()))
Aurel's avatar
Aurel committed
275 276 277 278
      try:
        return export_string.getvalue()
      finally:
        export_string.close()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
279

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

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

Aurel's avatar
Aurel committed
304 305
    def _importBT(self, path=None, id=id):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
306
        Import template from a temp file (as uploaded by the user)
Aurel's avatar
Aurel committed
307
      """
308
      file = open(path, 'rb')
309 310 311 312 313 314
      try:
        # read magic key to determine wich kind of bt we use
        file.seek(0)
        magic = file.read(5)
      finally:
        file.close()
315

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

360
    security.declareProtected( Permissions.ManagePortal, 'manage_download' )
361 362
    def manage_download(self, url, id=None, REQUEST=None):
      """The management interface for download.
363
      """
364 365
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
366

367
      bt = self.download(url, id=id)
368

369
      if REQUEST is not None:
370
        ret_url = bt.absolute_url() + '/view'
Yusei Tahara's avatar
Yusei Tahara committed
371
        psm = translateString("Business template downloaded successfully.")
372
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
373
                                    % (ret_url, psm))
374

375 376 377 378 379
    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)
380 381 382 383 384 385 386 387 388 389
        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)
390

391
        file_list = []
392
        os.path.walk(path, callback, file_list)
Aurel's avatar
Aurel committed
393 394
        file_list.sort()
        # import bt object
395 396
        bt = self.newContent(portal_type='Business Template', id=bt_id)
        bt_path = os.path.join(path, 'bt')
Aurel's avatar
Aurel committed
397 398

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

    def _download_url(self, url, bt_id):
      tempid, temppath = mkstemp()
      try:
431
        os.close(tempid) # Close the opened fd as soon as possible.
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
        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)

        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:
        import pysvn
        pysvn.Client().export(url, svn_checkout_dir)
        return self._download_local(svn_checkout_dir, bt_id)
      finally:
        shutil.rmtree(svn_checkout_tmp_dir)

452 453 454 455 456 457 458 459 460 461 462 463
    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))

464 465 466 467 468 469 470 471 472
    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)
473

474 475 476 477 478 479 480 481 482 483
      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)
484

485
      if urltype and urltype != 'file':
486
        if '/portal_templates/asRepository/' in url:
487 488 489 490 491
          # 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)]
492 493 494 495
        bt = self._download_url(url, id)
      else:
        bt = self._download_local(name, id)

496
      bt.build(no_action=True)
497
      return bt
Jean-Paul Smets's avatar
Jean-Paul Smets committed
498

499
    def importBase64EncodedText(self, file_data=None, id=None, REQUEST=None,
500
                                batch_mode=False, **kw):
501
      """
502 503 504
        Import Business Template from passed base64 encoded text.
      """
      import_file = StringIO(decodestring(file_data))
505
      return self.importFile(import_file = import_file, id = id, REQUEST = REQUEST,
506 507
                             batch_mode = batch_mode, **kw)

508
    def importFile(self, import_file=None, id=None, REQUEST=None,
509
                   batch_mode=False, **kw):
510
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
511
        Import Business Template from one file
512
      """
513 514
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
515

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

543
      if not batch_mode and \
544
         (REQUEST is not None):
545
        ret_url = bt.absolute_url() + '/view'
Yusei Tahara's avatar
Yusei Tahara committed
546
        psm = translateString("Business templates imported successfully.")
547 548
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                  % (ret_url, psm))
549
      elif batch_mode:
550
        return bt
551

552 553
    security.declareProtected(Permissions.ManagePortal, 'runUnitTestList')
    def runUnitTestList(self, test_list=[],
554
                        sql_connection_string='',
555
                        save=False, load=False,
556
                        repository_list=None,
557 558
                        REQUEST=None, RESPONSE=None, **kwd):
      """Runs Unit Tests related to this Business Template
559
      """
560 561
      if repository_list is None:
        repository_list = []
Vincent Pelletier's avatar
Vincent Pelletier committed
562 563
      # XXX: should check for file presence before trying to execute.
      # XXX: should check if the unit test file is configured in the BT
564
      site_configuration = getConfiguration()
565
      from Products.ERP5Type.tests.runUnitTest import getUnitTestFile
566
      import Products.ERP5
567 568 569 570 571 572 573 574
      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')
575 576
      current_sys_path = sys.path
      # add path with tests
577 578
      current_sys_path.append(os.path.join(site_configuration.instancehome,
        'tests'))
579

580
      test_cmd_args = [sys.executable, getUnitTestFile()]
581
      test_cmd_args += ['--erp5_sql_connection_string', sql_connection_string]
582 583 584 585
      if load:
        test_cmd_args += ['--load']
      if save:
        test_cmd_args += ['--save']
586
      # pass currently used product path to test runner
587 588 589 590 591 592
      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)]
593
      test_cmd_args += ['--sys_path', ','.join(current_sys_path)]
594
      bt5_path_list = []
595 596 597
      ## XXX-TODO: requires that asRepository works without security, maybe
      ##           with special key?
      # bt5_path_list.append(self.absolute_url() + '/asRepository/')
598 599 600
      # add passed repository list
      bt5_path_list.extend(repository_list)
      # adding locally saved Business Templates, not perfect, but helps some
601
      # people doing strict TTW development
Łukasz Nowak's avatar
Łukasz Nowak committed
602
      bt5_path_list.append(site_configuration.clienthome)
603
      test_cmd_args += ['--bt5_path', ','.join(bt5_path_list)]
604
      test_cmd_args += test_list
605 606 607 608 609 610 611 612 613
      # 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()
614 615 616 617
      process = subprocess.Popen(test_cmd_args,
                                 stdout=subprocess.PIPE,
                                 stderr=subprocess.STDOUT)

618 619 620 621
      # "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
622 623 624 625 626 627
      while True:
        line = process.stdout.readline()
        if not line:
          break
        outfile.write(line)
        outfile.flush()
628

629 630
      if hasattr(outfile, 'getvalue'):
        return outfile.getvalue()
631

632 633 634 635
    def getDiffFilterScriptList(self):
      """
      Return list of scripts usable to filter diff
      """
636 637 638 639 640 641 642
      # XXX, the or [] should not be there, the preference tool is
      # inconsistent, the called method should not return None when
      # nothing is selected
      script_id_list = self.getPortalObject().portal_preferences\
        .getPreferredDiffFilterScriptIdList() or []
          
      return [getattr(self, x) for x in script_id_list]
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664

    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()
      if len(diff_block_list):
        for script in self.getDiffFilterScriptList():
          for block, line_tuple in diff_block_list:
            if script(line_tuple[0], line_tuple[1]):
              diff_file_object.children.remove(block)
      # XXX-Aurel : this method should return a text diff but
      # DiffFile does not provide yet such feature
      return diff_file_object

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

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

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

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

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

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

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

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

781 782
    security.declarePublic( 'decodeRepositoryBusinessTemplateUid' )
    def decodeRepositoryBusinessTemplateUid(self, uid):
Vincent Pelletier's avatar
Vincent Pelletier committed
783 784 785
      """
        Decode the uid of a business template from a repository.
        Return a repository and an id.
786
      """
787
      return cPickle.loads(b64decode(uid))
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 824
    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,)
825

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

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

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

881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
    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:
904 905 906 907
                  version_restriction = dependency_couple_list[1]
                  if version_restriction.startswith('('):
                    # Something like "(>= 1.0rc6)".
                    version_restriction = version_restriction[1:-1]
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 943
                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])
944

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

957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
    security.declareProtected(Permissions.AccessContentsInformation,
                              'sortBusinessTemplateList')
    def sortBusinessTemplateList(self, bt_list):
      """
       Sort a list of bt according to dependencies
      """
      result_list = []
      for repository, id in bt_list:
        dependency_list = self.getDependencyList((repository, id))
        dependency_list.append((repository, id))
        for dependency in dependency_list:
          if dependency[0] == 'meta':
            provider_list = self.getProviderList(dependency[1])
            dependency = self.findProviderInBTList(provider_list, bt_list)
          if dependency not in result_list:
            result_list.append(dependency)
      return result_list
974

Vincent Pelletier's avatar
Vincent Pelletier committed
975 976
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRepositoryBusinessTemplateList' )
977
    def getRepositoryBusinessTemplateList(self, update_only=False, **kw):
978 979
      """Get the list of Business Templates in repositories.
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
980 981
      version_state_title_dict = { 'new' : 'New', 'present' : 'Present',
                                   'old' : 'Old' }
982 983 984 985 986 987 988 989 990 991 992 993

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

      template_item_list = []
      if update_only:
        # 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
994 995
              # If this is the first time to see this business template,
              # insert it.
996 997
              template_item_dict[title] = (repository, property_dict)
            else:
Vincent Pelletier's avatar
Vincent Pelletier committed
998 999 1000 1001
              # 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
1002
              diff_version = self.compareVersions(previous_property_dict['version'],
1003 1004
                                                  property_dict['version'])
              if diff_version < 0:
1005
                template_item_dict[title] = (repository, property_dict)
1006
              elif diff_version == 0 \
Jérome Perrin's avatar
Jérome Perrin committed
1007 1008
                   and previous_property_dict['revision'] \
                   and property_dict['revision'] \
1009
                   and int(previous_property_dict['revision']) < int(property_dict['revision']):
Jérome Perrin's avatar
Jérome Perrin committed
1010
                      template_item_dict[title] = (repository, property_dict)
1011 1012
        # Next, select only updated business templates.
        for repository, property_dict in template_item_dict.values():
Vincent Pelletier's avatar
Vincent Pelletier committed
1013
          installed_bt = \
1014
              self.getInstalledBusinessTemplate(property_dict['title'], strict=True)
1015
          if installed_bt is not None:
Jérome Perrin's avatar
Jérome Perrin committed
1016
            diff_version = self.compareVersions(installed_bt.getVersion(),
1017 1018
                                                property_dict['version'])
            if diff_version < 0:
1019
              template_item_list.append((repository, property_dict))
Jérome Perrin's avatar
Jérome Perrin committed
1020 1021 1022
            elif diff_version == 0 \
                 and installed_bt.getRevision() \
                 and property_dict['revision'] \
1023
                 and int(installed_bt.getRevision()) < int(property_dict['revision']):
Jérome Perrin's avatar
Jérome Perrin committed
1024
                   template_item_list.append((repository, property_dict))
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
      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']
        del property_dict['id']
        version = property_dict['version']
        version_state = 'new'
1037 1038 1039 1040 1041 1042
        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)
1043 1044 1045 1046
          if result == 0:
            version_state = 'present'
          elif result < 0:
            version_state = 'old'
1047 1048 1049
        else:
          installed_version = ''
          installed_revision = ''
1050
        version_state_title = version_state_title_dict[version_state]
1051
        uid = b64encode(cPickle.dumps((repository, id)))
1052 1053 1054
        obj = newTempBusinessTemplate(self, 'temp_' + uid,
                                      version_state = version_state,
                                      version_state_title = version_state_title,
1055 1056
                                      installed_version = installed_version,
                                      installed_revision = installed_revision,
1057 1058 1059
                                      repository = repository, **property_dict)
        obj.setUid(uid)
        template_list.append(obj)
1060
      template_list.sort(key=lambda x: x.getTitle())
1061 1062
      return template_list

Vincent Pelletier's avatar
Vincent Pelletier committed
1063 1064
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getUpdatedRepositoryBusinessTemplateList' )
1065 1066 1067 1068
    def getUpdatedRepositoryBusinessTemplateList(self, **kw):
      """Get the list of updated Business Templates in repositories.
      """
      #LOG('getUpdatedRepositoryBusinessTemplateList', 0, 'kw = %r' % (kw,))
1069
      return self.getRepositoryBusinessTemplateList(update_only=True, **kw)
1070

1071
    def compareVersions(self, version1, version2):
Vincent Pelletier's avatar
Vincent Pelletier committed
1072 1073 1074
      """
        Return negative if version1 < version2, 0 if version1 == version2,
        positive if version1 > version2.
1075 1076

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

1109 1110 1111 1112 1113 1114 1115 1116
      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
1117

1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
    def _getBusinessTemplateUrlDict(self):
      business_template_url_dict = {}
      for bt in self.getRepositoryBusinessTemplateList():
        url, name = self.decodeRepositoryBusinessTemplateUid(bt.getUid())
        business_template_url_dict[name[:-4]] = {
          'url':  '%s/%s' % (url, name),
          'revision': bt.getRevision()
          }
      return business_template_url_dict

    security.declareProtected(Permissions.ManagePortal,
        'installBusinessTemplatesFromRepositories' )
    def installBusinessTemplatesFromRepositories(self, template_list,
1131
        only_newer=True, update_catalog=_MARKER):
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
      """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 = []
      template_dict = self._getBusinessTemplateUrlDict()
      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'])
1146 1147 1148 1149
            if update_catalog is _MARKER:
              template_document.install()
            else:
              template_document.install(update_catalog=update_catalog)
1150 1151 1152 1153 1154 1155 1156 1157
            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

1158 1159 1160 1161 1162 1163
    security.declareProtected(Permissions.ManagePortal,
            'updateBusinessTemplateFromUrl')
    def updateBusinessTemplateFromUrl(self, download_url, id=None,
                                         keep_original_list=[],
                                         before_triggered_bt5_id_list=[],
                                         after_triggered_bt5_id_list=[],
1164 1165 1166
                                         update_catalog=0,
                                         reinstall=False,
                                         active_process=None):
1167 1168 1169
      """ 
        This method download and install a bt5, from a URL.
      """
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
      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)
1183
      imported_bt5 = self.download(url = download_url, id = id)
1184
      bt_title = imported_bt5.getTitle()
1185 1186
      BusinessTemplate_getModifiedObject = \
        aq_base(getattr(self, 'BusinessTemplate_getModifiedObject'))
1187

1188
      listbox_object_list = BusinessTemplate_getModifiedObject.__of__(imported_bt5)()
1189 1190 1191 1192 1193
      if reinstall:
        log('Reinstall all items')
        install_kw = dict.fromkeys(imported_bt5.getItemsList(), 'install')
      else:
        install_kw = {}
1194
      for listbox_line in listbox_object_list:
1195 1196 1197 1198
        item = listbox_line.object_id
        state = listbox_line.object_state
        removed = state.startswith('Removed')
        if removed:
1199 1200 1201 1202 1203 1204
          # The following condition could not be used to automatically decide
          # if an item must be kept or not. For example, this would not work
          # for items installed by PortalTypeWorkflowChainTemplateItem.
          maybe_moved = installed_dict.get(listbox_line.object_id, '')
          log('%s: %s%s' % (state, item,
            maybe_moved and ' (moved to %s ?)' % maybe_moved))
1205 1206
        else:
          installed_dict[item] = bt_title
1207
        # if a bt5 item is removed we may still want to keep it
1208 1209 1210 1211
        if ((removed or state in ('Modified', 'New'))
            and item in keep_original_list):
          install_kw[item] = 'nothing'
          log("Keep %r" % item)
1212
        else:
1213 1214
          install_kw[item] = listbox_line.choice_item_list[0][1]

1215 1216
      # Run before script list
      for before_triggered_bt5_id in before_triggered_bt5_id_list:
1217 1218 1219
        log('Execute %r' % before_triggered_bt5_id)
        imported_bt5.unrestrictedTraverse(before_triggered_bt5_id)()

1220 1221
      imported_bt5.install(object_to_update=install_kw,
                           update_catalog=update_catalog)
1222

1223 1224
      # Run After script list
      for after_triggered_bt5_id in after_triggered_bt5_id_list:
1225 1226 1227 1228 1229 1230 1231 1232
        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))
1233

1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
    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).
      """
      # 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
1266
InitializeClass(TemplateTool)