TemplateTool.py 35.6 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
#
# 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.
#
##############################################################################

29
from webdav.client import Resource
Jean-Paul Smets's avatar
Jean-Paul Smets committed
30

Yoshinori Okuji's avatar
Yoshinori Okuji committed
31
from App.config import getConfiguration
32
import os, tarfile
33
import shutil
Yoshinori Okuji's avatar
Yoshinori Okuji committed
34

35
from Acquisition import Implicit
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36
from AccessControl import ClassSecurityInfo
37
from Globals import InitializeClass, DTMLFile, PersistentMapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38
from Products.ERP5Type.Tool.BaseTool import BaseTool
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39
from Products.ERP5Type import Permissions
40
from Products.ERP5.Document.BusinessTemplate import BusinessTemplateMissingDependency
41
from tempfile import mkstemp, mkdtemp
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42
from Products.ERP5 import _dtmldir
Aurel's avatar
Aurel committed
43
from cStringIO import StringIO
44
from urllib import pathname2url, urlopen, splittype, urlretrieve
45 46 47 48
import re
from xml.dom.minidom import parse
import struct
import cPickle
49
import posixpath
50 51 52 53
try:
  from base64 import b64encode, b64decode
except ImportError:
  from base64 import encodestring as b64encode, decodestring as b64decode
54
from Products.ERP5Type.Message import Message
55 56
from zLOG import LOG, INFO

57
N_ = lambda msgid, **kw: Message('ui', msgid, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
58

59
WIN = os.name == 'nt'
60

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
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
77
class TemplateTool (BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
78
    """
79
      TemplateTool manages Business Templates.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
80

81 82 83 84 85 86
      TemplateTool provides some methods to deal with Business Templates:
        - download
        - publish
        - install
        - update
        - save
Jean-Paul Smets's avatar
Jean-Paul Smets committed
87 88
    """
    id = 'portal_templates'
89
    title = 'Template Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
90
    meta_type = 'ERP5 Template Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
91
    portal_type = 'Template Tool'
92
    allowed_types = ( 'ERP5 Business Template',)
93 94 95
    
    # This stores information on repositories.
    repository_dict = {}
Jean-Paul Smets's avatar
Jean-Paul Smets committed
96 97 98 99 100

    # Declarative Security
    security = ClassSecurityInfo()

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

103 104
    def getInstalledBusinessTemplate(self, title, **kw):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
105
        Return an installed version of business template of a certain title.
106 107
      """
      # This can be slow if, say, 10000 business templates are present.
Vincent Pelletier's avatar
Vincent Pelletier committed
108 109 110
      # 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.
111 112 113 114
      for bt in self.contentValues(filter={'portal_type':'Business Template'}):
        if bt.getInstallationState() == 'installed' and bt.getTitle() == title:
          return bt
      return None
115 116
        
    def getInstalledBusinessTemplatesList(self):
117 118 119 120 121 122 123
      """Deprecated.
      """
      DeprecationWarning('getInstalledBusinessTemplatesList is deprecated; Use getInstalledBusinessTemplateList instead.', DeprecationWarning)
      return self.getInstalledBusinessTemplateList()

    def getInstalledBusinessTemplateList(self):
      """Get the list of installed business templates.
124 125 126 127 128 129
      """
      installed_bts = []
      for bt in self.contentValues(filter={'portal_type':'Business Template'}):
        if bt.getInstallationState() == 'installed':
          installed_bts.append(bt)
      return installed_bts
130 131
        
    def getBuiltBusinessTemplatesList(self):
132 133 134 135 136 137 138
      """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.
139 140 141 142 143 144
      """
      built_bts = []
      for bt in self.contentValues(filter={'portal_type':'Business Template'}):
        if bt.getInstallationState() == 'not_installed' and bt.getBuildingState() == 'built':
          built_bts.append(bt)
      return built_bts
145

146
    security.declareProtected(Permissions.ManagePortal,
147 148
                              'getDefaultBusinessTemplateDownloadURL')
    def getDefaultBusinessTemplateDownloadURL(self):
149 150 151 152 153
      """Returns the default download URL for business templates.
      """
      return "file://%s/" % pathname2url(
                  os.path.join(getConfiguration().instancehome, 'bt5'))

154 155
    security.declareProtected( 'Import/Export objects', 'save' )
    def save(self, business_template, REQUEST=None, RESPONSE=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
156
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
157
        Save the BusinessTemplate in the servers's filesystem.
Yoshinori Okuji's avatar
Yoshinori Okuji committed
158 159
      """
      cfg = getConfiguration()
Vincent Pelletier's avatar
Vincent Pelletier committed
160 161
      path = os.path.join(cfg.clienthome,
                          '%s' % (business_template.getTitle(),))
162
      path = pathname2url(path)
Aurel's avatar
Aurel committed
163
      business_template.export(path=path, local=1)
164
      if REQUEST is not None:
165 166 167
        psm = N_('Saved+in+${path}+.',
                  mapping={'path': pathname2url(path)})
        ret_url = '%s/%s?portal_status_message=%s' % \
Vincent Pelletier's avatar
Vincent Pelletier committed
168
                  (business_template.absolute_url(),
169
                   REQUEST.get('form_id', 'view'), psm)
Vincent Pelletier's avatar
Vincent Pelletier committed
170 171 172
        if RESPONSE is None:
          RESPONSE = REQUEST.RESPONSE
        return REQUEST.RESPONSE.redirect( ret_url )
173 174 175 176

    security.declareProtected( 'Import/Export objects', 'export' )
    def export(self, business_template, REQUEST=None, RESPONSE=None):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
177 178
        Export the Business Template as a bt5 file and offer the user to
        download it.
179
      """
180
      path = business_template.getTitle()
181
      path = pathname2url(path)
182 183 184 185
      # XXX Why is it necessary to create a temporary directory?
      tmpdir_path = mkdtemp() 
      # XXX not thread safe
      current_directory = os.getcwd() 
186
      os.chdir(tmpdir_path)
Aurel's avatar
Aurel committed
187
      export_string = business_template.export(path=path)
188
      os.chdir(current_directory)
189
      if RESPONSE is not None:
190
        RESPONSE.setHeader('Content-type','tar/x-gzip')
191
        RESPONSE.setHeader('Content-Disposition',
192
                           'inline;filename=%s-%s.bt5' % \
193
                               (path, 
194
                                business_template.getVersion()))
Aurel's avatar
Aurel committed
195 196 197 198
      try:
        return export_string.getvalue()
      finally:
        export_string.close()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
199

200
    security.declareProtected( 'Import/Export objects', 'publish' )
201 202
    def publish(self, business_template, url, username=None, password=None):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
203
        Publish the given business template at the given URL.
204 205
      """
      business_template.build()
Vincent Pelletier's avatar
Vincent Pelletier committed
206 207
      export_string = self.manage_exportObject(id=business_template.getId(),
                                               download=1)
208
      bt = Resource(url, username=username, password=password)
Vincent Pelletier's avatar
Vincent Pelletier committed
209 210
      bt.put(file=export_string,
             content_type='application/x-erp5-business-template')
211
      business_template.setPublicationUrl(url)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
212

213 214
    def update(self, business_template):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
215
        Update an existing template from its publication URL.
216 217 218 219 220 221
      """
      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
222
      self._importObjectFromFile(StringIO(export_string), id=id)
223

Aurel's avatar
Aurel committed
224 225
    def _importBT(self, path=None, id=id):
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
226
        Import template from a temp file (as uploaded by the user)
Aurel's avatar
Aurel committed
227
      """
228
      file = open(path, 'rb')
229 230 231 232 233 234 235
      try:
        # read magic key to determine wich kind of bt we use
        file.seek(0)
        magic = file.read(5)
      finally:
        file.close()
        
Aurel's avatar
Aurel committed
236 237 238 239
      if magic == '<?xml': # old version
        self._importObjectFromFile(path, id=id)
        bt = self[id]
        bt.id = id # Make sure id is consistent
240
        bt.setProperty('template_format_version', 0, type='int')
Aurel's avatar
Aurel committed
241
      else: # new version
Vincent Pelletier's avatar
Vincent Pelletier committed
242 243
        # XXX: should really check for a magic and offer a falback if it
        # doens't correspond to anything handled.
Aurel's avatar
Aurel committed
244
        tar = tarfile.open(path, 'r:gz')
245 246
        try:
          # create bt object
247
          bt = self.newContent(portal_type='Business Template', id=id)
248 249
          prop_dict = {}
          for prop in bt.propertyMap():
Aurel's avatar
Aurel committed
250
            prop_type = prop['type']
251
            pid = prop['id']
252
            prop_path = posixpath.join(tar.members[0].name, 'bt', pid)
253 254 255 256 257
            try:
              info = tar.getmember(prop_path)
            except KeyError:
              continue
            value = tar.extractfile(info).read()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
258 259
            if prop_type == 'text' or prop_type == 'string' \
                                   or prop_type == 'int':
260
              prop_dict[pid] = value
Aurel's avatar
Aurel committed
261
            elif prop_type == 'lines' or prop_type == 'tokens':
262
              prop_dict[pid[:-5]] = value.splitlines()
263 264 265
          prop_dict.pop('id', '')
          bt.edit(**prop_dict)
          # import all other files from bt
266
          fobj = open(path, 'rb')
267
          try:
268 269 270 271 272
            bt.importFile(file=fobj)
          finally:
            fobj.close()
        finally:
          tar.close()
Aurel's avatar
Aurel committed
273 274
      return bt

275
    security.declareProtected( Permissions.ManagePortal, 'manage_download' )
276 277
    def manage_download(self, url, id=None, REQUEST=None):
      """The management interface for download.
278
      """
279 280
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
281

282
      bt = self.download(url, id=id)
283 284
            
      if REQUEST is not None:
285 286 287 288
        ret_url = bt.absolute_url() + '/view'
        psm = N_("Business+Template+Downloaded+Successfully")
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s" 
                                    % (ret_url, psm))
289
    
290 291 292 293 294
    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)
295 296 297 298 299 300 301 302 303 304
        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)
305

306
        file_list = []
307
        os.path.walk(path, callback, file_list)
Aurel's avatar
Aurel committed
308 309
        file_list.sort()
        # import bt object
310 311
        bt = self.newContent(portal_type='Business Template', id=bt_id)
        bt_path = os.path.join(path, 'bt')
Aurel's avatar
Aurel committed
312 313

        # import properties
314
        prop_dict = {}
Aurel's avatar
Aurel committed
315
        for prop in bt.propertyMap():
Aurel's avatar
Aurel committed
316
          prop_type = prop['type']
Aurel's avatar
Aurel committed
317
          pid = prop['id']
318 319 320
          prop_path = os.path.join('.', bt_path, pid)
          if not os.path.exists(prop_path):
            continue          
321
          value = open(prop_path, 'rb').read()
Aurel's avatar
Aurel committed
322
          if prop_type in ('text', 'string', 'int', 'boolean'):
323
            prop_dict[pid] = value
Aurel's avatar
Aurel committed
324
          elif prop_type in ('lines', 'tokens'):
325
            prop_dict[pid[:-5]] = value.splitlines()
326
        prop_dict.pop('id', '')
327
        bt.edit(**prop_dict)
Aurel's avatar
Aurel committed
328
        # import all others objects
329 330
        bt.importFile(dir=1, file=file_list, root_path=path)
        return bt
Aurel's avatar
Aurel committed
331
      else:
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
        # this should be a file
        return self._importBT(path, bt_id)

    def _download_url(self, url, bt_id):
      tempid, temppath = mkstemp()
      try:
        os.close(tempid) # Close the opened fd as soon as possible.    
        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)

    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)
      
      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)
      
      if urltype and urltype != 'file':
        bt = self._download_url(url, id)
      else:
        bt = self._download_local(name, id)

385
      bt.build(no_action=1)
386
      return bt
Jean-Paul Smets's avatar
Jean-Paul Smets committed
387

388 389
    def importFile(self, import_file=None, id=None, REQUEST=None, 
                   batch_mode=0, **kw):
390
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
391
        Import Business Template from one file
392
      """
393 394
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
395 396 397 398 399 400 401 402 403
      
      if id is None:
        id = self.generateNewId()

      if (import_file is None) or (len(import_file.read()) == 0):
        if REQUEST is not None:
          psm = N_('No+file+or+an+empty+file+was+specified')
          REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                    % (self.absolute_url(), psm))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
404 405
          return
        else :
406
          raise RuntimeError, 'No file or an empty file was specified'
Aurel's avatar
Aurel committed
407
      # copy to a temp location
Alexandre Boeglin's avatar
Alexandre Boeglin committed
408
      import_file.seek(0) #Rewind to the beginning of file
409
      tempid, temppath = mkstemp()
410 411
      try:
        os.close(tempid) # Close the opened fd as soon as possible
412
        tempfile = open(temppath, 'wb')
413 414 415 416 417 418 419
        try:
          tempfile.write(import_file.read())
        finally:
          tempfile.close()
        bt = self._importBT(temppath, id)
      finally:
        os.remove(temppath)
420
      bt.build(no_action=1)
Aurel's avatar
Aurel committed
421
      bt.reindexObject()
422

423 424
      if (batch_mode == 0) and \
         (REQUEST is not None):
425 426 427 428
        ret_url = bt.absolute_url() + '/view'
        psm = N_("Business+Templates+Imported+Successfully")
        REQUEST.RESPONSE.redirect("%s?portal_status_message=%s"
                                  % (ret_url, psm))
429 430
      elif (batch_mode == 1):
        return bt
431

432 433 434 435
    security.declareProtected(Permissions.ManagePortal, 'runUnitTestList')
    def runUnitTestList(self, test_list=[],
                        REQUEST=None, RESPONSE=None, **kwd):
      """Runs Unit Tests related to this Business Template
436
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
437 438
      # XXX: should check for file presence before trying to execute.
      # XXX: should check if the unit test file is configured in the BT
439
      from Products.ERP5Type.tests.runUnitTest import getUnitTestFile
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
      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')
      process = os.popen('/usr/bin/python %s %s 2>&1'
                      % (getUnitTestFile(), ' '.join(test_list)))
      while 1:
        try:
          outfile.write(process.next())
          outfile.flush()
        except StopIteration:
          break
      if hasattr(outfile, 'getvalue'):
        return outfile.getvalue()
458 459

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

Vincent Pelletier's avatar
Vincent Pelletier committed
480 481 482 483 484 485 486
    security.declareProtected( 'Import/Export objects',
                               'updateRepositoryBusinessTemplateList' )

    def updateRepositoryBusinessTemplateList(self, repository_list,
                                             REQUEST=None, RESPONSE=None, **kw):
      """
        Update the information on Business Templates from repositories.
487 488
      """
      self.repository_dict = PersistentMapping()
489
      property_list = ('title', 'version', 'revision', 'description', 'license',
490
                       'dependency', 'provision', 'copyright')
Vincent Pelletier's avatar
Vincent Pelletier committed
491 492
      #LOG('updateRepositoryBusiessTemplateList', 0,
      #    'repository_list = %r' % (repository_list,))
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
      for repository in repository_list:
        url = '/'.join([repository, 'bt5list'])
        f = urlopen(url)
        property_dict_list = []
        try:
          doc = parse(f)
          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
520 521
              property_dict['version'] = \
                  temp_property_dict.get('version', [''])[0]
Jérome Perrin's avatar
Jérome Perrin committed
522 523
              property_dict['revision'] = \
                  temp_property_dict.get('revision', [''])[0]
Vincent Pelletier's avatar
Vincent Pelletier committed
524 525 526 527 528 529
              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', ())
530 531
              property_dict['provision_list'] = \
                  temp_property_dict.get('provision', ())
Vincent Pelletier's avatar
Vincent Pelletier committed
532 533
              property_dict['copyright_list'] = \
                  temp_property_dict.get('copyright', ())
534 535 536 537 538 539 540 541 542 543
              
              property_dict_list.append(property_dict)
          finally:
            doc.unlink()
        finally:
          f.close()
        
        self.repository_dict[repository] = tuple(property_dict_list)
        
      if REQUEST is not None:
544
        ret_url = self.absolute_url() + '/' + REQUEST.get('dialog_id', 'view')
545
        psm = N_("Business+Templates+Updated+Successfully")
546 547
        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))
548
                
Vincent Pelletier's avatar
Vincent Pelletier committed
549 550
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRepositoryList' )
551
    def getRepositoryList(self):
Vincent Pelletier's avatar
Vincent Pelletier committed
552 553
      """
        Get the list of repositories.
554 555 556 557 558
      """
      return self.repository_dict.keys()
      
    security.declarePublic( 'decodeRepositoryBusinessTemplateUid' )
    def decodeRepositoryBusinessTemplateUid(self, uid):
Vincent Pelletier's avatar
Vincent Pelletier committed
559 560 561
      """
        Decode the uid of a business template from a repository.
        Return a repository and an id.
562
      """
563
      return cPickle.loads(b64decode(uid))
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
    
    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,)
    
    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
    
    security.declareProtected(Permissions.AccessContentsInformation,
                               'getLastestBTOnRepos')
    def getLastestBTOnRepos(self, title, version_restriction=None):
      """
       It's possible we have different versions of the same BT
       available on various repositories or on the same repository. 
       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
629
        for property_dict in property_dict_list:
630 631 632
          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
633
          if title == property_dict['title']:
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
            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 '')
    
    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
     
    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:
680 681 682 683
                  version_restriction = dependency_couple_list[1]
                  if version_restriction.startswith('('):
                    # Something like "(>= 1.0rc6)".
                    version_restriction = version_restriction[1:-1]
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 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 742 743 744 745 746 747 748 749 750
                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])
                
    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'
    
    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
    
Vincent Pelletier's avatar
Vincent Pelletier committed
751 752
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getRepositoryBusinessTemplateList' )
753 754 755
    def getRepositoryBusinessTemplateList(self, update_only=0, **kw):
      """Get the list of Business Templates in repositories.
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
756 757
      version_state_title_dict = { 'new' : 'New', 'present' : 'Present',
                                   'old' : 'Old' }
758 759 760 761 762 763 764 765 766 767 768 769

      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
770 771
              # If this is the first time to see this business template,
              # insert it.
772 773
              template_item_dict[title] = (repository, property_dict)
            else:
Vincent Pelletier's avatar
Vincent Pelletier committed
774 775 776 777
              # 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
778
              diff_version = self.compareVersions(previous_property_dict['version'],
779 780
                                                  property_dict['version'])
              if diff_version < 0:
781
                template_item_dict[title] = (repository, property_dict)
782
              elif diff_version == 0 \
Jérome Perrin's avatar
Jérome Perrin committed
783 784
                   and previous_property_dict['revision'] \
                   and property_dict['revision'] \
785
                   and int(previous_property_dict['revision']) < int(property_dict['revision']):
Jérome Perrin's avatar
Jérome Perrin committed
786
                      template_item_dict[title] = (repository, property_dict)
787 788
        # Next, select only updated business templates.
        for repository, property_dict in template_item_dict.values():
Vincent Pelletier's avatar
Vincent Pelletier committed
789 790
          installed_bt = \
              self.getInstalledBusinessTemplate(property_dict['title'])
791
          if installed_bt is not None:
Jérome Perrin's avatar
Jérome Perrin committed
792
            diff_version = self.compareVersions(installed_bt.getVersion(),
793 794
                                                property_dict['version'])
            if diff_version < 0:
795
              template_item_list.append((repository, property_dict))
Jérome Perrin's avatar
Jérome Perrin committed
796 797 798
            elif diff_version == 0 \
                 and installed_bt.getRevision() \
                 and property_dict['revision'] \
799
                 and int(installed_bt.getRevision()) < int(property_dict['revision']):
Jérome Perrin's avatar
Jérome Perrin committed
800
                   template_item_list.append((repository, property_dict))
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
      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'
        for bt in self.searchFolder(title = property_dict['title']):
          result = self.compareVersions(version, bt.getObject().getVersion())
          if result == 0:
            version_state = 'present'
            break
          elif result < 0:
            version_state = 'old'
        version_state_title = version_state_title_dict[version_state]
821
        uid = b64encode(cPickle.dumps((repository, id)))
822 823 824 825 826 827
        obj = newTempBusinessTemplate(self, 'temp_' + uid,
                                      version_state = version_state,
                                      version_state_title = version_state_title,
                                      repository = repository, **property_dict)
        obj.setUid(uid)
        template_list.append(obj)
828
      template_list.sort(lambda x,y:cmp(x.getTitle(), y.getTitle()))
829 830
      return template_list

Vincent Pelletier's avatar
Vincent Pelletier committed
831 832
    security.declareProtected( Permissions.AccessContentsInformation,
                               'getUpdatedRepositoryBusinessTemplateList' )
833 834 835 836 837 838 839
    def getUpdatedRepositoryBusinessTemplateList(self, **kw):
      """Get the list of updated Business Templates in repositories.
      """
      #LOG('getUpdatedRepositoryBusinessTemplateList', 0, 'kw = %r' % (kw,))
      return self.getRepositoryBusinessTemplateList(update_only=1, **kw)
      
    def compareVersions(self, version1, version2):
Vincent Pelletier's avatar
Vincent Pelletier committed
840 841 842
      """
        Return negative if version1 < version2, 0 if version1 == version2,
        positive if version1 > version2.
843 844

      Here is the algorithm:
Vincent Pelletier's avatar
Vincent Pelletier committed
845 846
        - Non-alphanumeric characters are not significant, besides the function
          of delimiters.
847 848 849 850
        - 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
851
      This implements the following predicates:
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
        - 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
        
      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
      
Jean-Paul Smets's avatar
Jean-Paul Smets committed
886
InitializeClass(TemplateTool)