TemplateTool.py 11.7 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 30
import cStringIO
from webdav.client import Resource
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31 32
from Products.CMFCore.utils import UniqueObject

Yoshinori Okuji's avatar
Yoshinori Okuji committed
33
from App.config import getConfiguration
Aurel's avatar
Aurel committed
34
import os, tarfile, string, commands
Yoshinori Okuji's avatar
Yoshinori Okuji committed
35

36
from Acquisition import Implicit
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37
from AccessControl import ClassSecurityInfo
38
from Globals import InitializeClass, DTMLFile, PersistentMapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39
from Products.ERP5Type.Tool.BaseTool import BaseTool
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40
from Products.ERP5Type import Permissions
Aurel's avatar
Aurel committed
41
from tempfile import mkstemp
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42 43 44 45
from Products.ERP5 import _dtmldir

from zLOG import LOG

46 47 48 49 50 51 52 53 54 55
class LocalConfiguration(Implicit):
  """
    Holds local configuration information
  """
  def __init__(self, **kw):
    self.__dict__.update(kw)

  def update(self, **kw):
    self.__dict__.update(kw)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
56
class TemplateTool (BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
57
    """
58
      TemplateTool manages Business Templates.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
59

60
      TemplateTool provides some methods to deal with Business Templates:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
61

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

64
        - publish
Jean-Paul Smets's avatar
Jean-Paul Smets committed
65

66
        - install
Jean-Paul Smets's avatar
Jean-Paul Smets committed
67

68
        - update
Jean-Paul Smets's avatar
Jean-Paul Smets committed
69

70
        - save
Jean-Paul Smets's avatar
Jean-Paul Smets committed
71 72 73
    """
    id = 'portal_templates'
    meta_type = 'ERP5 Template Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
74
    portal_type = 'Template Tool'
75
    allowed_types = ( 'ERP5 Business Template',)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
76 77 78 79 80 81 82

    # Declarative Security
    security = ClassSecurityInfo()

    security.declareProtected( Permissions.ManagePortal, 'manage_overview' )
    manage_overview = DTMLFile( 'explainRuleTool', _dtmldir )

83 84 85 86 87 88 89 90 91 92 93 94
    def getInstalledBusinessTemplate(self, title, **kw):
      """
        Return a installed business template if any.
      """
      # This can be slow if, say, 10000 business templates are present.
      # 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.
      for bt in self.contentValues(filter={'portal_type':'Business Template'}):
        if bt.getInstallationState() == 'installed' and bt.getTitle() == title:
          return bt
      return None
95

96 97
    # Import a business template
    def importURL(self, url):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
98
      """
99
        Import a business template
Jean-Paul Smets's avatar
Jean-Paul Smets committed
100
      """
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
      # Copy it to import directory
      # and import in self

    def updateLocalConfiguration(self, template, **kw):
      template_id = template.getId()
      if not hasattr(self, '_local_configuration'): self._local_configuration = PersistentMapping()
      if not self._local_configuration.has_key(template_id):
        self._local_configuration[template_id] = LocalConfiguration(**kw)
      else:
        self._local_configuration[template_id].update(**kw)

    def getLocalConfiguration(self, template):
      template_id = template.getId()
      if not hasattr(self, '_local_configuration'): self._local_configuration = PersistentMapping()
      local_configuration = self._local_configuration.get(template_id, None)
      if local_configuration is not None:
        return local_configuration.__of__(self)
      return None

120 121
    security.declareProtected( 'Import/Export objects', 'save' )
    def save(self, business_template, REQUEST=None, RESPONSE=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
122
      """
Aurel's avatar
Aurel committed
123
        Save BT in folder format
Yoshinori Okuji's avatar
Yoshinori Okuji committed
124 125
      """
      cfg = getConfiguration()
Aurel's avatar
Aurel committed
126 127
      path = os.path.join(cfg.clienthome, '%s' % (business_template.getTitle(),))
      business_template.export(path=path, local=1)
128 129 130 131 132 133 134 135 136
      if REQUEST is not None:
        ret_url = business_template.absolute_url() + '/' + REQUEST.get('form_id', 'view')
        qs = '?portal_status_message=Saved+in+%s+.' % path
        if RESPONSE is None: RESPONSE = REQUEST.RESPONSE
        return REQUEST.RESPONSE.redirect( ret_url + qs )

    security.declareProtected( 'Import/Export objects', 'export' )
    def export(self, business_template, REQUEST=None, RESPONSE=None):
      """
Aurel's avatar
Aurel committed
137
        Export BT in tarball format 
138
      """
Aurel's avatar
Aurel committed
139 140
      path = './'+business_template.getTitle()
      export_string = business_template.export(path=path)
141
      if RESPONSE is not None:
Aurel's avatar
Aurel committed
142
        RESPONSE.setHeader('Content-type','tar/x-gzip') # must be tar/x-gzip
143
        RESPONSE.setHeader('Content-Disposition',
144
                           'inline;filename=%s-%s.bt5' % (business_template.getTitle(), business_template.getVersion()))
Aurel's avatar
Aurel committed
145 146 147 148
      try:
        return export_string.getvalue()
      finally:
        export_string.close()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
149

150 151 152 153 154 155 156
    def publish(self, business_template, url, username=None, password=None):
      """
        Publish in a format or another
      """
      business_template.build()
      export_string = self.manage_exportObject(id=business_template.getId(), download=1)
      bt = Resource(url, username=username, password=password)
157
      bt.put(file=export_string, content_type='application/x-erp5-business-template')
158
      business_template.setPublicationUrl(url)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
159

160 161 162 163 164 165 166 167 168 169 170
    def update(self, business_template):
      """
        Update an existing template
      """
      url = business_template.getPublicationUrl()
      id = business_template.getId()
      bt = Resource(url)
      export_string = bt.get().get_body()
      self.deleteContent(id)
      self._importObjectFromFile(cStringIO.StringIO(export_string), id=id)

Aurel's avatar
Aurel committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
    def _importBT(self, path=None, id=id):
      """
        Import template from a temp file
      """
      file = open(path, 'r')
      # read magic key to determine wich kind of bt we use
      file.seek(0)
      magic = file.read(5)
      file.close()
      if magic == '<?xml': # old version
        self._importObjectFromFile(path, id=id)
        bt = self[id]
        bt.id = id # Make sure id is consistent
        bt._tarfile = 0        
      else: # new version
        tar = tarfile.open(path, 'r:gz')
        # create bt object
        self.newContent(portal_type='Business Template', id=id)
        bt = self._getOb(id)
        for prop in bt.propertyMap():
          type = prop['type']
          pid = prop['id']
          if pid in ('uid', 'id'):
            continue
195
          prop_path = os.path.join(tar.members[0].name, 'bt', pid)
Aurel's avatar
Aurel committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
          info = tar.getmember(prop_path)
          value = tar.extractfile(info).read()
          if type == 'text' or type == 'string' or type == 'int':
            bt.setProperty(pid, value, type)
          elif type == 'lines' or type == 'tokens':
            bt.setProperty(pid[:-5], value.split('\n'), type)

        # import all other files from bt
        fobj = open(path, 'r')
        bt.importFile(file=fobj)
        fobj.close()
        tar.close()
      os.remove(path)
      return bt

    def _importBusinesstemplateObject(self, name):
      """
        Create the object business template
      """
      bt_file = os.path.join(name, 'bt.xml')
      btf = open(bt_file, 'r')
      self._importObjectFromFile(btf, id=id)
      pass
    

Jean-Paul Smets's avatar
Jean-Paul Smets committed
221
    def download(self, url, id=None, REQUEST=None):
222
      """
Aurel's avatar
Aurel committed
223
        Download Business template, can be file or local directory
224
      """
225 226 227
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
        
Aurel's avatar
Aurel committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
      path = string.split(url, ":")
      if len(path) == 2:  # use of file:/... or http://...
        name = path[1]
      else:
        name = path[0]
      if os.path.isdir(name): # new version of business template in plain format (folder)
        file_list = commands.getoutput('find %r' %name) # use os.path.walk instead
        file_list = string.split(file_list, '\n')
        file_list.sort()
        # import bt object
        self.newContent(portal_type='Business Template', id=id)
        bt = self._getOb(id)
        bt_path = os.path.join(name, 'bt')

        # import properties
        for prop in bt.propertyMap():
          type = prop['type']
          pid = prop['id']
          if pid in ('uid', 'id'):
            continue
          prop_path = os.path.join(bt_path, pid)
          value = open(prop_path, 'r').read()
          if type == 'text' or type == 'string' or type == 'int':
            bt.setProperty(pid, value, type)
          elif type == 'lines' or type == 'tokens':
            bt.setProperty(pid[:-5], value.split('\n'), type)
          
        # import all others objects
        bt.importFile(dir=1, file=file_list, root_path=name)
      else:
        from urllib import urlretrieve
        tempid, temppath = mkstemp()      
        file, headers = urlretrieve(url, temppath)
        bt = self._importBT(temppath, id)
262
      bt.reindexObject()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
263 264 265 266

      if REQUEST is not None:
        REQUEST.RESPONSE.redirect("%s?portal_status_message=Business+Template+Downloaded+Successfully"
                           % self.absolute_url())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
267

Alexandre Boeglin's avatar
Alexandre Boeglin committed
268
    def importFile(self, import_file=None, id=None, REQUEST=None, **kw):
269
      """
Aurel's avatar
Aurel committed
270
        Import Business template from one file
271
      """
272 273 274
      if REQUEST is None:
        REQUEST = getattr(self, 'REQUEST', None)
        
Alexandre Boeglin's avatar
Alexandre Boeglin committed
275 276 277 278 279 280 281
      if (import_file is None) or (len(import_file.read()) == 0) :
        if REQUEST is not None :
          REQUEST.RESPONSE.redirect("%s?portal_status_message=No+file+or+an+empty+file+was+specified"
              % self.absolute_url())
          return
        else :
          raise 'Error', 'No file or an empty file was specified'
Aurel's avatar
Aurel committed
282 283
        
      # copy to a temp location
Alexandre Boeglin's avatar
Alexandre Boeglin committed
284
      import_file.seek(0) #Rewind to the beginning of file
285 286
      tempid, temppath = mkstemp()
      tempfile = open(temppath, 'w')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
287
      tempfile.write(import_file.read())
288
      tempfile.close()
Aurel's avatar
Aurel committed
289 290 291
      
      bt = self._importBT(temppath, id)      
      bt.reindexObject()
292 293

      if REQUEST is not None:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
294
        REQUEST.RESPONSE.redirect("%s?portal_status_message=Business+Template+Imported+Successfully"
295 296
                           % self.absolute_url())

297 298 299 300 301 302 303 304
    def runUnitTestList(self, test_list=[], **kwd) :
      """
        Runs Unit Tests related to this Business Template
      """
      
      from Products.ERP5Type.tests.runUnitTest import getUnitTestFile
      return os.popen('/usr/bin/python %s %s 2>&1' % (getUnitTestFile(), ' '.join(test_list))).read()

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
    security.declareProtected(Permissions.DeletePortalContent, 'deleteBackupObjects')

    def deleteBackupObjects(self, dry_run=1) :
      """
      removes 'btsave' objects from the ZODB
      """
      import re
      backup_re = re.compile('_btsave_[0-9]+$')
      backup_list = []

      portal = self.getPortalObject()
      for module in portal.objectValues() :
        if backup_re.search(module.getId()) :
          backup_list.append((module.getId(), portal))
        else :
          for oid in module.objectIds() :
            if backup_re.search(oid) :
              backup_list.append((oid, module))
      if dry_run :
        return '\n'.join(['%s in %s' % e for e in backup_list])
      else :
        for oid, module in backup_list :
          module.manage_delObjects(oid)

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