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

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

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

65 66
_MARKER = []

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
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
83
class TemplateTool (BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
84
    """
85
      TemplateTool manages Business Templates.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
86

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

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

    # Declarative Security
    security = ClassSecurityInfo()

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

109 110
    def getInstalledBusinessTemplate(self, title, **kw):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
111
        Return an installed version of business template of a certain title.
112 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
        template in a transaction replacing an existing business template
116 117
      """
      # This can be slow if, say, 10000 business templates are present.
Vincent Pelletier's avatar
Vincent Pelletier committed
118 119 120
      # 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.
121 122
      replaced_list = []
      replaced_list_append = replaced_list.append
123
      for bt in self.contentValues(filter={'portal_type':'Business Template'}):
124 125 126 127 128 129 130 131 132 133
        if bt.getTitle() == title:
          installation_state = bt.getInstallationState()
          if installation_state == 'installed':
            return bt
          elif installation_state == 'replaced':
            replaced_list_append((bt.getId(), bt.getRevision()))
      # still there means that we might search for a replaced bt
      if len(replaced_list):
        replaced_list.sort(key=lambda x: -int(x[1]))
        return self._getOb(replaced_list[0][0])
134
      return None
135

136
    def getInstalledBusinessTemplatesList(self):
137 138 139 140 141
      """Deprecated.
      """
      DeprecationWarning('getInstalledBusinessTemplatesList is deprecated; Use getInstalledBusinessTemplateList instead.', DeprecationWarning)
      return self.getInstalledBusinessTemplateList()

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

154 155 156 157 158 159 160 161 162 163
    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)

164 165 166 167 168 169 170 171
    def getInstalledBusinessTemplateRevision(self, title, **kw):
      """
        Return the revision of business template installed with the title
        given
      """
      bt = self.getInstalledBusinessTemplate(title)
      return bt.getRevision()

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

187 188 189 190 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
    @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)
219

220
    security.declareProtected(Permissions.ManagePortal,
221 222
                              'getDefaultBusinessTemplateDownloadURL')
    def getDefaultBusinessTemplateDownloadURL(self):
223 224 225 226 227
      """Returns the default download URL for business templates.
      """
      return "file://%s/" % pathname2url(
                  os.path.join(getConfiguration().instancehome, 'bt5'))

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

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

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

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

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

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

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

362
      bt = self.download(url, id=id)
363

364
      if REQUEST is not None:
365
        ret_url = bt.absolute_url() + '/view'
Yusei Tahara's avatar
Yusei Tahara committed
366
        psm = translateString("Business template downloaded successfully.")
367
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
368
                                    % (ret_url, psm))
369

370 371 372 373 374
    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)
375 376 377 378 379 380 381 382 383 384
        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)
385

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

        # import properties
394
        prop_dict = {}
Aurel's avatar
Aurel committed
395
        for prop in bt.propertyMap():
Aurel's avatar
Aurel committed
396
          prop_type = prop['type']
Aurel's avatar
Aurel committed
397
          pid = prop['id']
398 399
          prop_path = os.path.join('.', bt_path, pid)
          if not os.path.exists(prop_path):
400
            continue
401
          value = open(prop_path, 'rb').read()
402 403 404 405 406
          if value is 'None':
            # At export time, we used to export non-existent properties:
            #   str(obj.getProperty('non-existing')) == 'None'
            # Discard them
            continue
Aurel's avatar
Aurel committed
407
          if prop_type in ('text', 'string', 'int', 'boolean'):
408
            prop_dict[pid] = value
Aurel's avatar
Aurel committed
409
          elif prop_type in ('lines', 'tokens'):
410
            prop_dict[pid[:-5]] = value.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 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
        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)

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() + '/view'
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 548
                        REQUEST=None, RESPONSE=None, **kwd):
      """Runs Unit Tests related to this Business Template
549
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
550 551
      # XXX: should check for file presence before trying to execute.
      # XXX: should check if the unit test file is configured in the BT
552
      from Products.ERP5Type.tests.runUnitTest import getUnitTestFile
553 554 555 556 557 558 559 560
      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')
561
      test_cmd_args = [sys.executable, getUnitTestFile()]
562
      test_cmd_args += ['--erp5_sql_connection_string', sql_connection_string]
563 564 565 566 567
      test_cmd_args += test_list
      process = subprocess.Popen(test_cmd_args,
                                 stdout=subprocess.PIPE,
                                 stderr=subprocess.STDOUT)

568 569 570 571
      # "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
572 573 574 575 576 577
      while True:
        line = process.stdout.readline()
        if not line:
          break
        outfile.write(line)
        outfile.flush()
578

579 580
      if hasattr(outfile, 'getvalue'):
        return outfile.getvalue()
581

582 583 584 585 586 587 588 589
    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()

590
    def diffObject(self, REQUEST, **kw):
Aurel's avatar
Aurel committed
591
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
592 593
        Make diff between two objects, whose paths are stored in values bt1
        and bt2 in the REQUEST object.
Aurel's avatar
Aurel committed
594
      """
595 596
      bt1_id = getattr(REQUEST, 'bt1', None)
      bt2_id = getattr(REQUEST, 'bt2', None)
597 598 599 600 601 602 603
      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
604
      else:
605 606 607 608 609
        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)
610

Vincent Pelletier's avatar
Vincent Pelletier committed
611 612 613 614 615 616 617
    security.declareProtected( 'Import/Export objects',
                               'updateRepositoryBusinessTemplateList' )

    def updateRepositoryBusinessTemplateList(self, repository_list,
                                             REQUEST=None, RESPONSE=None, **kw):
      """
        Update the information on Business Templates from repositories.
618 619
      """
      self.repository_dict = PersistentMapping()
620
      property_list = ('title', 'version', 'revision', 'description', 'license',
621
                       'dependency', 'provision', 'copyright')
Vincent Pelletier's avatar
Vincent Pelletier committed
622 623
      #LOG('updateRepositoryBusiessTemplateList', 0,
      #    'repository_list = %r' % (repository_list,))
624 625 626 627 628
      for repository in repository_list:
        url = '/'.join([repository, 'bt5list'])
        f = urlopen(url)
        property_dict_list = []
        try:
629 630 631 632 633 634 635 636 637 638 639
          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
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
          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
661 662
              property_dict['version'] = \
                  temp_property_dict.get('version', [''])[0]
Jérome Perrin's avatar
Jérome Perrin committed
663 664
              property_dict['revision'] = \
                  temp_property_dict.get('revision', [''])[0]
Vincent Pelletier's avatar
Vincent Pelletier committed
665 666 667 668 669 670
              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', ())
671 672
              property_dict['provision_list'] = \
                  temp_property_dict.get('provision', ())
Vincent Pelletier's avatar
Vincent Pelletier committed
673 674
              property_dict['copyright_list'] = \
                  temp_property_dict.get('copyright', ())
675

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

682
        self.repository_dict[repository] = tuple(property_dict_list)
683

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

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

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

706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
    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,)
742

743 744 745 746 747 748 749 750 751 752 753 754 755 756
    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
757

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

783 784 785 786 787 788 789 790 791 792 793 794 795 796
    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
797

798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
    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:
821 822 823 824
                  version_restriction = dependency_couple_list[1]
                  if version_restriction.startswith('('):
                    # Something like "(>= 1.0rc6)".
                    version_restriction = version_restriction[1:-1]
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
                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])
861

862 863 864 865 866 867 868 869 870 871 872
    def findProviderInBTList(self, provider_list, bt_list):
      """
       Find one provider in provider_list which is present in
       bt_list and returns the found tuple (repository, id)
       in bt_list.
      """
      for provider in provider_list:
        for repository, id in bt_list:
          if id.startswith(provider):
            return (repository, id)
      raise BusinessTemplateUnknownError, 'Provider not found in bt_list'
873

874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
    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
891

Vincent Pelletier's avatar
Vincent Pelletier committed
892 893
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRepositoryBusinessTemplateList' )
894
    def getRepositoryBusinessTemplateList(self, update_only=False, **kw):
895 896
      """Get the list of Business Templates in repositories.
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
897 898
      version_state_title_dict = { 'new' : 'New', 'present' : 'Present',
                                   'old' : 'Old' }
899 900 901 902 903 904 905 906 907 908 909 910

      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
911 912
              # If this is the first time to see this business template,
              # insert it.
913 914
              template_item_dict[title] = (repository, property_dict)
            else:
Vincent Pelletier's avatar
Vincent Pelletier committed
915 916 917 918
              # 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
919
              diff_version = self.compareVersions(previous_property_dict['version'],
920 921
                                                  property_dict['version'])
              if diff_version < 0:
922
                template_item_dict[title] = (repository, property_dict)
923
              elif diff_version == 0 \
Jérome Perrin's avatar
Jérome Perrin committed
924 925
                   and previous_property_dict['revision'] \
                   and property_dict['revision'] \
926
                   and int(previous_property_dict['revision']) < int(property_dict['revision']):
Jérome Perrin's avatar
Jérome Perrin committed
927
                      template_item_dict[title] = (repository, property_dict)
928 929
        # Next, select only updated business templates.
        for repository, property_dict in template_item_dict.values():
Vincent Pelletier's avatar
Vincent Pelletier committed
930 931
          installed_bt = \
              self.getInstalledBusinessTemplate(property_dict['title'])
932
          if installed_bt is not None:
Jérome Perrin's avatar
Jérome Perrin committed
933
            diff_version = self.compareVersions(installed_bt.getVersion(),
934 935
                                                property_dict['version'])
            if diff_version < 0:
936
              template_item_list.append((repository, property_dict))
Jérome Perrin's avatar
Jérome Perrin committed
937 938 939
            elif diff_version == 0 \
                 and installed_bt.getRevision() \
                 and property_dict['revision'] \
940
                 and int(installed_bt.getRevision()) < int(property_dict['revision']):
Jérome Perrin's avatar
Jérome Perrin committed
941
                   template_item_list.append((repository, property_dict))
942 943 944 945 946 947 948 949 950 951 952 953
      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'
954 955 956 957 958 959
        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)
960 961 962 963
          if result == 0:
            version_state = 'present'
          elif result < 0:
            version_state = 'old'
964 965 966
        else:
          installed_version = ''
          installed_revision = ''
967
        version_state_title = version_state_title_dict[version_state]
968
        uid = b64encode(cPickle.dumps((repository, id)))
969 970 971
        obj = newTempBusinessTemplate(self, 'temp_' + uid,
                                      version_state = version_state,
                                      version_state_title = version_state_title,
972 973
                                      installed_version = installed_version,
                                      installed_revision = installed_revision,
974 975 976
                                      repository = repository, **property_dict)
        obj.setUid(uid)
        template_list.append(obj)
977
      template_list.sort(key=lambda x: x.getTitle())
978 979
      return template_list

Vincent Pelletier's avatar
Vincent Pelletier committed
980 981
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getUpdatedRepositoryBusinessTemplateList' )
982 983 984 985
    def getUpdatedRepositoryBusinessTemplateList(self, **kw):
      """Get the list of updated Business Templates in repositories.
      """
      #LOG('getUpdatedRepositoryBusinessTemplateList', 0, 'kw = %r' % (kw,))
986
      return self.getRepositoryBusinessTemplateList(update_only=True, **kw)
987

988
    def compareVersions(self, version1, version2):
Vincent Pelletier's avatar
Vincent Pelletier committed
989 990 991
      """
        Return negative if version1 < version2, 0 if version1 == version2,
        positive if version1 > version2.
992 993

      Here is the algorithm:
Vincent Pelletier's avatar
Vincent Pelletier committed
994 995
        - Non-alphanumeric characters are not significant, besides the function
          of delimiters.
996 997 998 999
        - 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
1000
      This implements the following predicates:
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
        - 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
1025

1026 1027 1028 1029 1030 1031 1032 1033
      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
1034

1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
    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,
1048
        only_newer=True, update_catalog=_MARKER):
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
      """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'])
1063 1064 1065 1066
            if update_catalog is _MARKER:
              template_document.install()
            else:
              template_document.install(update_catalog=update_catalog)
1067 1068 1069 1070 1071 1072 1073 1074
            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

1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
    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=[],
                                         update_catalog=0):
      """ 
        This method download and install a bt5, from a URL.
      """
      imported_bt5 = self.download(url = download_url, id = id)
      BusinessTemplate_getModifiedObject = \
        aq_base(getattr(self, 'BusinessTemplate_getModifiedObject'))
  
      install_kw = {}
      listbox_object_list = BusinessTemplate_getModifiedObject.__of__(imported_bt5)()
      for listbox_line in listbox_object_list:
        # if a bt5 item is removed we may still want to keep it
        if (listbox_line.object_state in ('Removed', 'Removed but used', 'Modified', 'New') and
            listbox_line.object_id in keep_original_list):
          install_kw[listbox_line.object_id] = 'nothing' #Keep original
        else:
          install_kw[listbox_line.object_id] = listbox_line.choice_item_list[0][1]
  
      # Run before script list
      for before_triggered_bt5_id in before_triggered_bt5_id_list:
        getattr(imported_bt5, before_triggered_bt5_id)()
  
      imported_bt5.install(object_to_update=install_kw,
                           update_catalog=update_catalog)
  
      # Run After script list
      for after_triggered_bt5_id in after_triggered_bt5_id_list:
        getattr(imported_bt5, after_triggered_bt5_id)()
      LOG('ERP5', INFO, "Updated %s from %s" %(imported_bt5.getTitle(), download_url))

1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
    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
1143
InitializeClass(TemplateTool)