SubversionTool.py 37.3 KB
Newer Older
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1 2 3 4
##############################################################################
#
# Copyright (c) 2005 Nexedi SARL and Contributors. All Rights Reserved.
#                    Yoshinori Okuji <yo@nexedi.com>
Christophe Dumez's avatar
Christophe Dumez committed
5
#                    Christophe Dumez <christophe@nexedi.com>
Yoshinori Okuji's avatar
Yoshinori Okuji 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 30
#
# 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.
#
##############################################################################

from Products.CMFCore.utils import UniqueObject
31
from Products.ERP5Type.Tool.BaseTool import BaseTool
Yoshinori Okuji's avatar
Yoshinori Okuji committed
32 33 34 35 36 37
from AccessControl import ClassSecurityInfo
from Globals import InitializeClass, DTMLFile
from Products.ERP5Type.Document.Folder import Folder
from Products.ERP5Type import Permissions
from Products.ERP5Subversion import _dtmldir
from Products.ERP5Subversion.SubversionClient import newSubversionClient
38
import os, re, commands, time, exceptions, thread
Yoshinori Okuji's avatar
Yoshinori Okuji committed
39 40 41 42
from DateTime import DateTime
from cPickle import dumps, loads
from App.config import getConfiguration
from zExceptions import Unauthorized
Christophe Dumez's avatar
Christophe Dumez committed
43 44
from OFS.Image import manage_addFile
from cStringIO import StringIO
45
from tempfile import mktemp
46
from shutil import copy
47
from zLOG import LOG
48
from Products.CMFCore.utils import getToolByName
Aurel's avatar
Aurel committed
49

50

Aurel's avatar
Aurel committed
51 52 53
try:
  from base64 import b64encode, b64decode
except ImportError:
54
  from base64 import encodestring as b64encode, decodestring as b64decode
55 56 57 58 59 60
  
# To keep compatibility with python 2.3
try:
  set
except NameError:
  from sets import Set as set
61 62 63 64

class Error(exceptions.EnvironmentError):
    pass

65 66 67 68 69 70 71 72 73 74
class SubversionPreferencesError(Exception):
  """The base exception class for the Subversion preferences.
  """
  pass
  
class SubversionUnknownBusinessTemplateError(Exception):
  """The base exception class when business template is unknown.
  """
  pass

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
def removeAll(entry):
  '''
    Remove all files and directories under 'entry'.
    XXX: This is defined here, because os.removedirs() is buggy.
  '''
  try:
    if os.path.isdir(entry) and not os.path.islink(entry):
      pwd = os.getcwd()
      os.chmod(entry, 0755)
      os.chdir(entry)
      for e in os.listdir(os.curdir):
        removeAll(e)
      os.chdir(pwd)
      os.rmdir(entry)
    else:
      if not os.path.islink(entry):
        os.chmod(entry, 0644)
      os.remove(entry)
  except OSError:
    pass
95 96
      
def copytree(src, dst, symlinks=False):
97
    """Recursively copy a directory tree using copy().
98 99

    If exception(s) occur, an Error is raised with a list of reasons.
100
    dst dir must exist
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116

    If the optional symlinks flag is true, symbolic links in the
    source tree result in symbolic links in the destination tree; if
    it is false, the contents of the files pointed to by symbolic
    links are copied.
    """
    names = os.listdir(src)
    errors = []
    for name in names:
        srcname = os.path.join(src, name)
        dstname = os.path.join(dst, name)
        try:
            if symlinks and os.path.islink(srcname):
                linkto = os.readlink(srcname)
                os.symlink(linkto, dstname)
            elif os.path.isdir(srcname):
117 118
                if not os.path.exists(dstname):
                  os.makedirs(dstname)
119 120
                copytree(srcname, dstname, symlinks)
            else:
121
                copy(srcname, dstname)
122
        except (IOError, os.error), why:
123
            errors.append((srcname, dstname, 'Error: ' + str(why.strerror)))
124 125
    if errors:
        raise Error, errors
126 127

  
128 129
class File :
  # Constructor
130 131 132
  def __init__(self, full_path, msg_status) :
    self.full_path = full_path
    self.msg_status = msg_status
133
    self.name = full_path.split(os.sep)[-1]
134 135 136 137
## End of File Class

class Dir :
  # Constructor
138 139 140
  def __init__(self, full_path, msg_status) :
    self.full_path = full_path
    self.msg_status = msg_status
141
    self.name = full_path.split(os.sep)[-1]
142
    self.sub_dirs = [] # list of sub directories
143 144 145

  # return a list of sub directories' names
  def getSubDirs(self) :
146
    return [d.name for d in self.sub_dirs]
147 148

  # return directory in subdirs given its name
149
  def getDir(self, name):
150
    for d in self.sub_dirs:
151
      if d.name == name:
152 153
        return d
## End of Dir Class
154 155 156 157 158 159 160 161

class DiffFile:
  # Members :
  # - path : path of the modified file
  # - children : sub codes modified
  # - old_revision
  # - new_revision

162
  def __init__(self, raw_diff):
163 164 165 166 167
    if '@@' not in raw_diff:
      self.binary=True
      return
    else:
      self.binary=False
168
    self.header = raw_diff.split('@@')[0][:-1]
169
    # Getting file path in header
170
    self.path = self.header.split('====')[0][:-1].strip()
171
    # Getting revisions in header
172
    for line in self.header.split(os.linesep):
173
      if line.startswith('--- '):
174
        tmp = re.search('\\([^)]+\\)$', line)
175
        self.old_revision = tmp.string[tmp.start():tmp.end()][1:-1].strip()
176
      if line.startswith('+++ '):
177
        tmp = re.search('\\([^)]+\\)$', line)
178
        self.new_revision = tmp.string[tmp.start():tmp.end()][1:-1].strip()
179
    # Splitting the body from the header
180
    self.body = os.linesep.join(raw_diff.strip().split(os.linesep)[4:])
181
    # Now splitting modifications
182
    self.children = []
183 184
    first = True
    tmp = []
185
    for line in self.body.split(os.linesep):
186 187
      if line:
        if line.startswith('@@') and not first:
188
          self.children.append(CodeBlock(os.linesep.join(tmp)))
189 190 191 192
          tmp = [line,]
        else:
          first = False
          tmp.append(line)
193
    self.children.append(CodeBlock(os.linesep.join(tmp)))
194 195
    

196
  def _escape(self, data):
197 198 199 200 201 202 203 204 205 206
    """
      Escape &, <, and > in a string of data.
      This is a copy of the xml.sax.saxutils.escape function.
    """
    if data:
      #data = data.replace("&", "&amp;")
      data = data.replace(">", "&gt;")
      data = data.replace("<", "&lt;")
      return data
    
207
  def toHTML(self):
208
    # Adding header of the table
209
    if self.binary:
210
      return '<b>Binary File or no changes!</b><br><br><br>'
211
    
Christophe Dumez's avatar
Christophe Dumez committed
212
    html = '''
213 214 215 216
    <table style="text-align: left; width: 100%%;" border="0" cellpadding="0" cellspacing="0">
  <tbody>
    <tr height="18px">
      <td style="background-color: grey"><b><center>%s</center></b></td>
Christophe Dumez's avatar
Christophe Dumez committed
217
      <td style="background-color: black;" width="2"></td>
218
      <td style="background-color: grey"><b><center>%s</center></b></td>
Christophe Dumez's avatar
Christophe Dumez committed
219
    </tr>'''%(self.old_revision, self.new_revision)
Christophe Dumez's avatar
Christophe Dumez committed
220
    header_color = 'grey'
221
    for child in self.children:
222
      # Adding line number of the modification
Christophe Dumez's avatar
Christophe Dumez committed
223 224 225 226 227 228
      html += '''<tr height="18px"><td style="background-color: %s">&nbsp;</td><td style="background-color: black;" width="2"></td><td style="background-color: %s">&nbsp;</td></tr>    <tr height="18px">
      <td style="background-color: rgb(68, 132, 255);"><b>Line %s</b></td>
      <td style="background-color: black;" width="2"></td>
      <td style="background-color: rgb(68, 132, 255);"><b>Line %s</b></td>
      </tr>'''%(header_color, header_color, child.old_line, child.new_line)
      header_color = 'white'
229 230 231 232 233 234
      # Adding diff of the modification
      old_code_list = child.getOldCodeList()
      new_code_list = child.getNewCodeList()
      i=0
      for old_line_tuple in old_code_list:
        new_line_tuple = new_code_list[i]
Christophe Dumez's avatar
Christophe Dumez committed
235 236
        new_line = new_line_tuple[0] or ' '
        old_line = old_line_tuple[0] or ' '
237 238
        i+=1
        html += '''    <tr height="18px">
Christophe Dumez's avatar
Christophe Dumez committed
239 240 241 242
        <td style="background-color: %s">%s</td>
        <td style="background-color: black;" width="2"></td>
        <td style="background-color: %s">%s</td>
        </tr>'''%(old_line_tuple[1], self._escape(old_line).replace(' ', '&nbsp;').replace('\t', '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'), new_line_tuple[1], self._escape(new_line).replace(' ', '&nbsp;').replace('\t', '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'))
243
    html += '''  </tbody>
Christophe Dumez's avatar
Christophe Dumez committed
244
</table><br><br>'''
245 246 247 248 249 250 251 252 253 254 255 256 257 258
    return html
      

# A code block contains several SubCodeBlocks
class CodeBlock:
  # Members :
  # - old_line : line in old code (before modif)
  # - new line : line in new code (after modif)
  #
  # Methods :
  # - getOldCodeList() : return code before modif
  # - getNewCodeList() : return code after modif
  # Note: the code returned is a list of tuples (code line, background color)

259
  def __init__(self, raw_diff):
260
    # Splitting body and header
261 262
    self.body = os.linesep.join(raw_diff.split(os.linesep)[1:])
    self.header = raw_diff.split(os.linesep)[0]
263
    # Getting modifications lines
264 265
    tmp = re.search('^@@ -\d+', self.header)
    self.old_line = tmp.string[tmp.start():tmp.end()][4:]
Christophe Dumez's avatar
Christophe Dumez committed
266 267
    tmp = re.search('\+\d+', self.header)
    self.new_line = tmp.string[tmp.start():tmp.end()][1:]
268 269
    # Splitting modifications in SubCodeBlocks
    in_modif = False
270
    self.children = []
271
    tmp=[]
272
    for line in self.body.split(os.linesep):
273 274 275 276 277
      if line:
        if (line.startswith('+') or line.startswith('-')):
          if in_modif:
            tmp.append(line)
          else:
278
            self.children.append(SubCodeBlock(os.linesep.join(tmp)))
279 280 281 282
            tmp = [line,]
            in_modif = True
        else:
            if in_modif:
283
              self.children.append(SubCodeBlock(os.linesep.join(tmp)))
284 285 286 287
              tmp = [line,]
              in_modif = False
            else:
              tmp.append(line)
288
    self.children.append(SubCodeBlock(os.linesep.join(tmp)))
289 290
    
  # Return code before modification
291
  def getOldCodeList(self):
292
    tmp = []
293
    for child in self.children:
294 295 296 297
      tmp.extend(child.getOldCodeList())
    return tmp
    
  # Return code after modification
298
  def getNewCodeList(self):
299
    tmp = []
300
    for child in self.children:
301 302 303 304 305
      tmp.extend(child.getNewCodeList())
    return tmp
    
# a SubCodeBlock contain 0 or 1 modification (not more)
class SubCodeBlock:
306
  def __init__(self, code):
307 308
    self.body = code
    self.modification = self._getModif()
Christophe Dumez's avatar
Christophe Dumez committed
309 310
    self.old_code_length = self._getOldCodeLength()
    self.new_code_length = self._getNewCodeLength()
311
    # Choosing background color
312 313 314 315 316 317
    if self.modification == 'none':
      self.color = 'white'
    elif self.modification == 'change':
      self.color = 'rgb(253, 228, 6);'#light orange
    elif self.modification == 'deletion':
      self.color = 'rgb(253, 117, 74);'#light red
Christophe Dumez's avatar
Christophe Dumez committed
318
    else: # addition
319
      self.color = 'rgb(83, 253, 74);'#light green
320
    
321
  def _getModif(self):
322 323
    nb_plus = 0
    nb_minus = 0
324
    for line in self.body.split(os.linesep):
325 326 327 328 329 330
      if line.startswith("-"):
        nb_minus-=1
      elif line.startswith("+"):
        nb_plus+=1
    if (nb_plus==0 and nb_minus==0):
      return 'none'
Christophe Dumez's avatar
Christophe Dumez committed
331 332 333 334
    if (nb_minus==0):
      return 'addition'
    if (nb_plus==0):
      return 'deletion'
335
    return 'change'
Christophe Dumez's avatar
Christophe Dumez committed
336 337 338
      
  def _getOldCodeLength(self):
    nb_lines = 0
339
    for line in self.body.split(os.linesep):
Christophe Dumez's avatar
Christophe Dumez committed
340 341 342 343 344 345
      if not line.startswith("+"):
        nb_lines+=1
    return nb_lines
      
  def _getNewCodeLength(self):
    nb_lines = 0
346
    for line in self.body.split(os.linesep):
Christophe Dumez's avatar
Christophe Dumez committed
347 348 349
      if not line.startswith("-"):
        nb_lines+=1
    return nb_lines
350
  
351
  # Return code before modification
352 353
  def getOldCodeList(self):
    if self.modification=='none':
354
      old_code = [(x, 'white') for x in self.body.split(os.linesep)]
Christophe Dumez's avatar
Christophe Dumez committed
355
    elif self.modification=='change':
356
      old_code = [self._getOldCodeList(x) for x in self.body.split(os.linesep) if self._getOldCodeList(x)[0]]
Christophe Dumez's avatar
Christophe Dumez committed
357 358 359 360
      # we want old_code_list and new_code_list to have the same length
      if(self.old_code_length < self.new_code_length):
        filling = [(None, self.color)]*(self.new_code_length-self.old_code_length)
        old_code.extend(filling)
361
    else: # deletion or addition
362
      old_code = [self._getOldCodeList(x) for x in self.body.split(os.linesep)]
363
    return old_code
364
  
365
  def _getOldCodeList(self, line):
366
    if line.startswith('+'):
367
      return (None, self.color)
368
    if line.startswith('-'):
369 370
      return (' '+line[1:], self.color)
    return (line, self.color)
371 372
  
  # Return code after modification
373 374
  def getNewCodeList(self):
    if self.modification=='none':
375
      new_code = [(x, 'white') for x in self.body.split(os.linesep)]
Christophe Dumez's avatar
Christophe Dumez committed
376
    elif self.modification=='change':
377
      new_code = [self._getNewCodeList(x) for x in self.body.split(os.linesep) if self._getNewCodeList(x)[0]]
Christophe Dumez's avatar
Christophe Dumez committed
378 379 380 381
      # we want old_code_list and new_code_list to have the same length
      if(self.new_code_length < self.old_code_length):
        filling = [(None, self.color)]*(self.old_code_length-self.new_code_length)
        new_code.extend(filling)
382
    else: # deletion or addition
383
      new_code = [self._getNewCodeList(x) for x in self.body.split(os.linesep)]
384
    return new_code
385
  
386
  def _getNewCodeList(self, line):
387
    if line.startswith('-'):
388
      return (None, self.color)
389
    if line.startswith('+'):
390 391
      return (' '+line[1:], self.color)
    return (line, self.color)
392
  
393
class SubversionTool(BaseTool, UniqueObject, Folder):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
394 395 396 397 398 399 400 401 402 403
  """The SubversionTool provides a Subversion interface to ERP5.
  """
  id = 'portal_subversion'
  meta_type = 'ERP5 Subversion Tool'
  portal_type = 'Subversion Tool'
  allowed_types = ()

  login_cookie_name = 'erp5_subversion_login'
  ssl_trust_cookie_name = 'erp5_subversion_ssl_trust'
  top_working_path = os.path.join(getConfiguration().instancehome, 'svn')
404

Yoshinori Okuji's avatar
Yoshinori Okuji committed
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
  # Declarative Security
  security = ClassSecurityInfo()

  #
  #   ZMI methods
  #
  manage_options = ( ( { 'label'      : 'Overview'
                        , 'action'     : 'manage_overview'
                        }
                      ,
                      )
                    + Folder.manage_options
                    )

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

  # Filter content (ZMI))
  def __init__(self):
      return Folder.__init__(self, SubversionTool.id)

  # Filter content (ZMI))
  def filtered_meta_types(self, user=None):
      # Filters the list of available meta types.
      all = SubversionTool.inheritedAttribute('filtered_meta_types')(self)
      meta_types = []
      for meta_type in self.all_meta_types():
          if meta_type['name'] in self.allowed_types:
              meta_types.append(meta_type)
      return meta_types

  def getTopWorkingPath(self):
    return self.top_working_path

  def _getWorkingPath(self, path):
    path = os.path.abspath(path)
    if not path.startswith(self.top_working_path):
      raise Unauthorized, 'unauthorized access to path %s' % path
    return path
444 445 446 447
    
  def setWorkingDirectory(self, path):
    self.workingDirectory = path
    os.chdir(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
448 449 450 451 452 453 454 455

  def getDefaultUserName(self):
    """Return a default user name.
    """
    name = self.portal_preferences.getPreferredSubversionUserName()
    if not name:
      name = self.portal_membership.getAuthenticatedMember().getUserName()
    return name
Yoshinori Okuji's avatar
Yoshinori Okuji committed
456
    
Christophe Dumez's avatar
Christophe Dumez committed
457 458
  
  # path is the path in svn working copy
459 460
  # return edit_path in zodb to edit it
  # return '#' if no zodb path is found
Christophe Dumez's avatar
Christophe Dumez committed
461 462
  def editPath(self, bt, path):
    """Return path to edit file
463
       path can be relative or absolute
Christophe Dumez's avatar
Christophe Dumez committed
464
    """
465
    path = self.relativeToAbsolute(path, bt).replace('\\', '/')
466
    if 'bt' in path.split('/'):
467
      # not in zodb
Christophe Dumez's avatar
Christophe Dumez committed
468
      return '#'
469 470 471
    # if file have been deleted then not in zodb
    if not os.path.exists(path):
      return '#'
472
    svn_path = self.getSubversionPath(bt).replace('\\', '/')
Christophe Dumez's avatar
Christophe Dumez committed
473
    edit_path = path.replace(svn_path, '')
474 475 476
    if edit_path.strip() == '':
      # not in zodb 
      return '#'
477
    if edit_path[0] == '/':
478
      edit_path = edit_path[1:]
479
    edit_path = '/'.join(edit_path.split('/')[1:])
480 481 482
    if edit_path.strip() == '':
      # not in zodb 
      return '#'
483
    # remove file extension
Christophe Dumez's avatar
Christophe Dumez committed
484 485 486
    tmp = re.search('\\.[\w]+$', edit_path)
    if tmp:
      extension = tmp.string[tmp.start():tmp.end()].strip()
487
      edit_path = edit_path[:-len(extension)]
488
    edit_path = bt.REQUEST["BASE2"] + '/' + edit_path + '/manage_main'
Christophe Dumez's avatar
Christophe Dumez committed
489 490
    return edit_path
    
Yoshinori Okuji's avatar
Yoshinori Okuji committed
491 492 493 494 495 496 497
  def _encodeLogin(self, realm, user, password):
    # Encode login information.
    return b64encode(dumps((realm, user, password)))

  def _decodeLogin(self, login):
    # Decode login information.
    return loads(b64decode(login))
498 499 500 501
  
  def goToWorkingCopy(self, bt):
      working_path = self.getSubversionPath(bt)
      os.chdir(working_path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
502
    
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
  def setLogin(self, realm, user, password):
    """Set login information.
    """
    # Get existing login information. Filter out old information.
    login_list = []
    request = self.REQUEST
    cookie = request.get(self.login_cookie_name)
    if cookie:
      for login in cookie.split(','):
        if self._decodeLogin(login)[0] != realm:
          login_list.append(login)
    # Set the cookie.
    response = request.RESPONSE
    login_list.append(self._encodeLogin(realm, user, password))
    value = ','.join(login_list)
Christophe Dumez's avatar
Christophe Dumez committed
518
    expires = (DateTime() + 7).toZone('GMT').rfc822()
519
    request.set(self.login_cookie_name, value)
520
    response.setCookie(self.login_cookie_name, value, path = '/', expires = expires)
521

Yoshinori Okuji's avatar
Yoshinori Okuji committed
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
  def _getLogin(self, target_realm):
    request = self.REQUEST
    cookie = request.get(self.login_cookie_name)
    if cookie:
      for login in cookie.split(','):
        realm, user, password = self._decodeLogin(login)
        if target_realm == realm:
          return user, password
    return None, None

  def _encodeSSLTrust(self, trust_dict, permanent=False):
    # Encode login information.
    key_list = trust_dict.keys()
    key_list.sort()
    trust_item_list = tuple([(key, trust_dict[key]) for key in key_list])
    return b64encode(dumps((trust_item_list, permanent)))

  def _decodeSSLTrust(self, trust):
    # Decode login information.
Christophe Dumez's avatar
Christophe Dumez committed
541
    trust_item_list, permanent = loads(b64decode(trust))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
542
    return dict(trust_item_list), permanent
543
  
544 545
  def diffHTML(self, file_path, bt, revision1=None, revision2=None):
    raw_diff = self.diff(file_path, bt, revision1, revision2)
546
    return DiffFile(raw_diff).toHTML()
Christophe Dumez's avatar
Christophe Dumez committed
547 548
  
  # Display a file content in HTML
Christophe Dumez's avatar
Christophe Dumez committed
549
  def fileHTML(self, bt, file_path):
550
    file_path = self.relativeToAbsolute(file_path, bt)
551 552 553
    if os.path.exists(file_path):
      if os.path.isdir(file_path):
        text = "<b>"+file_path+"</b><hr>"
554
        text += file_path +" is a folder!"
555 556 557
      else:
        head = "<b>"+file_path+"</b>  <a href='"+self.editPath(bt, file_path)+"'><img src='imgs/edit.png' border='0'></a><hr>"
        text = commands.getoutput('enscript -B --color --line-numbers --highlight=html --language=html -o - %s'%file_path)
558
        text = head + os.linesep.join(text.split(os.linesep)[10:-4])
559 560 561
      return text
    else:
      # see if tmp file is here (svn deleted file)
562
      if file_path[-1]==os.sep:
563
        file_path=file_path[:-1]
564 565
      filename = file_path.split(os.sep)[-1]
      tmp_path = os.sep.join(file_path.split(os.sep)[:-1])
566 567
      tmp_path = os.path.join(tmp_path,'.svn','text-base',filename+'.svn-base')
      LOG('path_HD', 1, tmp_path)
568 569 570
      if os.path.exists(tmp_path):
        head = "<b>"+tmp_path+"</b> (svn temporary file)<hr>"
        text = commands.getoutput('enscript -B --color --line-numbers --highlight=html --language=html -o - %s'%tmp_path)
571
        text = head + os.linesep.join(text.split(os.linesep)[10:-4])
572 573
      else : # does not exist
        text = "<b>"+file_path+"</b><hr>"
574
        text += file_path +" does not exist!"
575 576
      return text
      
Yoshinori Okuji's avatar
Yoshinori Okuji committed
577 578 579 580 581 582 583 584 585
  security.declareProtected(Permissions.ManagePortal, 'acceptSSLServer')
  def acceptSSLServer(self, trust_dict, permanent=False):
    """Accept a SSL server.
    """
    # Get existing trust information.
    trust_list = []
    request = self.REQUEST
    cookie = request.get(self.ssl_trust_cookie_name)
    if cookie:
Christophe Dumez's avatar
Christophe Dumez committed
586
      trust_list.append(cookie)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
587 588 589 590
    # Set the cookie.
    response = request.RESPONSE
    trust_list.append(self._encodeSSLTrust(trust_dict, permanent))
    value = ','.join(trust_list)
Christophe Dumez's avatar
Christophe Dumez committed
591
    expires = (DateTime() + 7).toZone('GMT').rfc822()
592
    request.set(self.ssl_trust_cookie_name, value)
593
    response.setCookie(self.ssl_trust_cookie_name, value, path = '/', expires = expires)
Christophe Dumez's avatar
Christophe Dumez committed
594 595 596
    
  def acceptSSLPerm(self, trust_dict):
    self.acceptSSLServer(self, trust_dict, True)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613

  def _trustSSLServer(self, target_trust_dict):
    request = self.REQUEST
    cookie = request.get(self.ssl_trust_cookie_name)
    if cookie:
      for trust in cookie.split(','):
        trust_dict, permanent = self._decodeSSLTrust(trust)
        for key in target_trust_dict.keys():
          if target_trust_dict[key] != trust_dict.get(key):
            continue
        else:
          return True, permanent
    return False, False
    
  def _getClient(self, **kw):
    # Get the svn client object.
    return newSubversionClient(self, **kw)
614 615 616 617 618 619 620 621 622
  
  security.declareProtected('Import/Export objects', 'getSubversionPath')
  # with_name : with business template name at the end of the path
  def getSubversionPath(self, bt, with_name=True):
    # return the working copy path corresponding to
    # the given business template browsing
    # working copy list in preferences (looking
    # only at first level of directories)
    wc_list = self.getPortalObject().portal_preferences.getPreferredSubversionWorkingCopyList()
623 624 625
    if not wc_list:
      wc_list = self.getPortalObject().portal_preferences.default_site_preference.getPreferredSubversionWorkingCopyList()
      if not wc_list:
626
        raise SubversionPreferencesError, 'Please set at least one Subversion Working Copy in preferences first.'
627 628
    bt_name = bt.getTitle()
    if len(wc_list) == 0 :
629
      raise SubversionPreferencesError, 'Please set at least one Subversion Working Copy in preferences first.'
630 631 632 633 634 635 636 637
    for wc in wc_list:
      if bt_name in os.listdir(wc) :
        wc_path = os.path.join(wc, bt_name)
        if os.path.isdir(wc_path):
          if with_name:
            return wc_path
          else:
            return os.sep.join(wc_path.split(os.sep)[:-1])
638
    raise SubversionUnknownBusinessTemplateError, "Could not find '"+bt_name+"' at first level of working copies."
639
    
Yoshinori Okuji's avatar
Yoshinori Okuji committed
640
  security.declareProtected('Import/Export objects', 'update')
641
  def update(self, bt):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
642 643
    """Update a working copy.
    """
644
    path = self.getSubversionPath(bt)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
645
    client = self._getClient()
646 647 648 649 650
    # Revert first to import a "pure" BT after update
    self.revert(path=path, recurse=True)
    # Update from SVN
    client.update(path)
    # Import in zodb
Christophe Dumez's avatar
Christophe Dumez committed
651
    return self.importBT(bt)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
652 653

  security.declareProtected('Import/Export objects', 'add')
654 655
  # path can be a list or not (relative or absolute)
  def add(self, path, bt=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
656 657
    """Add a file or a directory.
    """
Christophe Dumez's avatar
Christophe Dumez committed
658
    if bt is not None:
659 660 661 662
      if isinstance(path, list) :
        path = [self.relativeToAbsolute(x, bt) for x in path]
      else:
        path = self.relativeToAbsolute(path, bt)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
663
    client = self._getClient()
664
    return client.add(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
665

666
  security.declareProtected('Import/Export objects', 'info')
667
  def info(self, bt):
668 669
    """return info of working copy
    """
670
    working_copy = self.getSubversionPath(bt)
671 672 673
    client = self._getClient()
    return client.info(working_copy)
  
Christophe Dumez's avatar
Christophe Dumez committed
674
  security.declareProtected('Import/Export objects', 'log')
675 676
  # path can be absolute or relative
  def log(self, path, bt):
Christophe Dumez's avatar
Christophe Dumez committed
677 678 679
    """return log of a file or dir
    """
    client = self._getClient()
680
    return client.log(self.relativeToAbsolute(path, bt))
Christophe Dumez's avatar
Christophe Dumez committed
681
  
682
  security.declareProtected('Import/Export objects', 'cleanup')
683
  def cleanup(self, bt):
684 685
    """remove svn locks in working copy
    """
686
    working_copy = self.getSubversionPath(bt)
687 688 689
    client = self._getClient()
    return client.cleanup(working_copy)

Yoshinori Okuji's avatar
Yoshinori Okuji committed
690
  security.declareProtected('Import/Export objects', 'remove')
691 692
  # path can be a list or not (relative or absolute)
  def remove(self, path, bt=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
693 694
    """Remove a file or a directory.
    """
Christophe Dumez's avatar
Christophe Dumez committed
695
    if bt is not None:
696 697 698 699
      if isinstance(path, list) :
        path = [self.relativeToAbsolute(x, bt) for x in path]
      else:
        path = self.relativeToAbsolute(path, bt)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
700
    client = self._getClient()
701
    return client.remove(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
702 703 704 705 706 707 708 709

  security.declareProtected('Import/Export objects', 'move')
  def move(self, src, dest):
    """Move/Rename a file or a directory.
    """
    client = self._getClient()
    return client.move(src, dest)

Christophe Dumez's avatar
Christophe Dumez committed
710
  security.declareProtected('Import/Export objects', 'ls')
711 712
  # path can be relative or absolute
  def ls(self, path, bt):
Christophe Dumez's avatar
Christophe Dumez committed
713 714 715
    """Display infos about a file.
    """
    client = self._getClient()
716
    return client.ls(self.relativeToAbsolute(path, bt))
Christophe Dumez's avatar
Christophe Dumez committed
717

Yoshinori Okuji's avatar
Yoshinori Okuji committed
718
  security.declareProtected('Import/Export objects', 'diff')
719 720
  # path can be relative or absolute
  def diff(self, path, bt, revision1=None, revision2=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
721 722 723
    """Make a diff for a file or a directory.
    """
    client = self._getClient()
724
    return client.diff(self.relativeToAbsolute(path, bt), revision1, revision2)
725
  
Yoshinori Okuji's avatar
Yoshinori Okuji committed
726
  security.declareProtected('Import/Export objects', 'revert')
727
  # path can be absolute or relative
728
  def revert(self, path, bt=None, recurse=False):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
729 730 731
    """Revert local changes in a file or a directory.
    """
    client = self._getClient()
732 733
    if not isinstance(path, list) :
      path = [path]
Christophe Dumez's avatar
Christophe Dumez committed
734
    if bt is not None:
735
      path = [self.relativeToAbsolute(x, bt) for x in path]
Christophe Dumez's avatar
Christophe Dumez committed
736
    client.revert(path, recurse)
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766

  security.declareProtected('Import/Export objects', 'revertZODB')
  # path can be absolute or relative
  def revertZODB(self, bt, added_files=None, other_files=None, recurse=False):
    """Revert local changes in a file or a directory
       in ZODB and on hard drive
    """
    client = self._getClient()
    object_to_update = {}
    if not added_files :
      added_files = []
    if not other_files :
      other_files = []
    if not isinstance(added_files, list) :
      added_files=[added_files]
    if not isinstance(other_files, list) :
      other_files=[other_files]
    
    # Reinstall removed or modified files
    for p in other_files :
      path_list = p.split(os.sep)
      if 'bt' not in path_list:
        if len(path_list) > 2 :
          tmp = os.sep.join(path_list[2:])
          # Remove file extension
          tmp2 = re.search('\\.[\w]+$', tmp)
          if tmp2:
            extension = tmp2.string[tmp2.start():tmp2.end()].strip()
            tmp=tmp[:-len(extension)]
          object_to_update[tmp] = 'install'
767
    path_added_list = []
768 769 770 771 772 773 774 775 776 777 778
    # remove added files
    for p in added_files :
      path_list = p.split(os.sep)
      if 'bt' not in path_list:
        if len(path_list) > 2 :
          tmp = os.sep.join(path_list[2:])
          # Remove file extension
          tmp2 = re.search('\\.[\w]+$', tmp)
          if tmp2:
            extension = tmp2.string[tmp2.start():tmp2.end()].strip()
            tmp=tmp[:-len(extension)]
779 780 781 782 783 784 785 786 787 788 789 790 791 792
            path_added_list.append(tmp)
    ## hack to remove objects
    # Create a temporary bt with objects to delete
    tmp_bt = getToolByName(bt, 'portal_templates').newContent(portal_type="Business Template")
    tmp_bt.setTemplatePathList(path_added_list)
    tmp_bt.setTitle('tmp_bt_revert')
    # Build bt
    tmp_bt.edit()
    tmp_bt.build()
    # Install then uninstall it to remove objects from ZODB
    tmp_bt.install()
    tmp_bt.uninstall()
    # Remove it from portal template
    bt.portal_templates.manage_delObjects(ids=tmp_bt.getId())
793 794 795 796 797 798
    #revert changes
    added_files.extend(other_files)
    to_revert = [self.relativeToAbsolute(x, bt) for x in added_files]
    if len(to_revert) != 0 :
      client.revert(to_revert, recurse)
      # Partially reinstall installed bt
799
      installed_bt = bt.portal_templates.getInstalledBusinessTemplate(                                                          bt.getTitle())
800
      installed_bt.reinstall(object_to_update=object_to_update, force=0)
Christophe Dumez's avatar
Christophe Dumez committed
801 802 803 804 805 806 807 808 809 810 811 812
    
  security.declareProtected('Import/Export objects', 'resolved')
  # path can be absolute or relative
  def resolved(self, path, bt):
    """remove conflicted status
    """
    client = self._getClient()
    if isinstance(path, list) :
      path = [self.relativeToAbsolute(x, bt) for x in path]
    else:
      path = self.relativeToAbsolute(path, bt)
    return client.resolved(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
813

814 815 816 817 818 819 820 821 822 823
  def relativeToAbsolute(self, path, bt) :
    if path[0] == os.sep:
      # already absolute
      return path
    # relative path
    if path.split(os.sep)[0] == bt.getTitle():
      return os.path.join(self.getSubversionPath(bt, False), path)
    else:
      return os.path.join(self.getSubversionPath(bt), path)

Yoshinori Okuji's avatar
Yoshinori Okuji committed
824
  security.declareProtected('Import/Export objects', 'checkin')
825 826
  # path can be relative or absolute (can be a list of paths too)
  def checkin(self, path, bt, log_message=None, recurse=True):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
827 828
    """Commit local changes.
    """
829 830 831 832
    if isinstance(path, list) :
      path = [self.relativeToAbsolute(x, bt) for x in path]
    else:
      path = self.relativeToAbsolute(path, bt)
833
    client = self._getClient()
834
    return client.checkin(path, log_message, recurse)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
835 836 837 838 839 840

  security.declareProtected('Import/Export objects', 'status')
  def status(self, path, **kw):
    """Get status.
    """
    client = self._getClient()
Christophe Dumez's avatar
Christophe Dumez committed
841
    return client.status(path, **kw)
842
  
843 844 845 846 847 848 849 850 851 852 853 854 855 856
  security.declareProtected('Import/Export objects', 'unversionedFiles')
  def unversionedFiles(self, path, **kw):
    """Return unversioned files
    """
    client = self._getClient()
    status_list = client.status(path, **kw)
    unversioned_list = []
    for statusObj in status_list:
      if str(statusObj.getTextStatus()) == "unversioned":
        my_dict = {}
        my_dict['uid'] = statusObj.getPath()
        unversioned_list.append(my_dict)
    return unversioned_list
      
857 858 859 860 861 862 863 864 865 866 867 868 869 870
  security.declareProtected('Import/Export objects', 'conflictedFiles')
  def conflictedFiles(self, path, **kw):
    """Return unversioned files
    """
    client = self._getClient()
    status_list = client.status(path, **kw)
    conflicted_list = []
    for statusObj in status_list:
      if str(statusObj.getTextStatus()) == "conflicted":
        my_dict = {}
        my_dict['uid'] = statusObj.getPath()
        conflicted_list.append(my_dict)
    return conflicted_list

871 872 873 874 875 876 877
  security.declareProtected('Import/Export objects', 'removeAllInList')
  def removeAllInList(self, list):
    """Remove all files and folders in list
    """
    for file in list:
      removeAll(file)
    
878
  def getModifiedTree(self, bt) :
Christophe Dumez's avatar
Christophe Dumez committed
879
    # Remove trailing slash if it's present
880
    path = self.getSubversionPath(bt)
Christophe Dumez's avatar
Christophe Dumez committed
881
    root = Dir(path, "normal")
882
    somethingModified = False
883
    
884
    for statusObj in self.status(path) :
885
      # can be (normal, added, modified, deleted, conflicted, unversioned)
886
      msg_status = statusObj.getTextStatus()
887
      if str(msg_status) != "normal" and str(msg_status) != "unversioned":
888
        somethingModified = True
Christophe Dumez's avatar
Christophe Dumez committed
889
        full_path = statusObj.getPath()
890
        full_path_list = full_path.split(os.sep)[1:]
Christophe Dumez's avatar
Christophe Dumez committed
891
        relative_path = full_path[len(path)+1:]
892
        relative_path_list = relative_path.split(os.sep)
893
        # Processing entry
Christophe Dumez's avatar
Christophe Dumez committed
894 895 896
        filename = relative_path_list[-1]
        # Needed or files will be both File & Dir objects
        relative_path_list = relative_path_list[:-1]
897
        parent = root
898
        i = len(path.split(os.sep))-1
Christophe Dumez's avatar
Christophe Dumez committed
899 900 901 902
        
        for d in relative_path_list :
          i += 1
          if d :
903
            full_pathOfd = os.sep+os.sep.join(full_path_list[:i]).strip()
904
            if d not in parent.getSubDirs() :
905
              parent.sub_dirs.append(Dir(full_pathOfd, "normal"))
906
            parent = parent.getDir(d)
Christophe Dumez's avatar
Christophe Dumez committed
907
        if os.path.isdir(full_path) :
908 909
          if full_path == parent.full_path :
            parent.msg_status = str(msg_status)
910 911
          elif filename not in parent.getSubDirs() :
            parent.sub_dirs.append(Dir(filename, str(msg_status)))
Christophe Dumez's avatar
Christophe Dumez committed
912
          else :
913
            tmp = parent.getDir(filename)
914
            tmp.msg_status = str(msg_status)
Christophe Dumez's avatar
Christophe Dumez committed
915
        else :
Christophe Dumez's avatar
Christophe Dumez committed
916
          parent.sub_dirs.append(File(full_path, str(msg_status)))
917
    return somethingModified and root
918
  
919
  def extractBT(self, bt):
920
    bt.build()
921
    svn_path = self.getSubversionPath(bt) + os.sep
922
    path = mktemp()  +os.sep
923 924
    bt.export(path=path, local=1)
    # svn del deleted files
925
    self.deleteOldFiles(svn_path, path, bt)
926
    # add new files and copy
927
    self.addNewFiles(svn_path, path, bt)
928
    self.goToWorkingCopy(bt)
929
    # Clean up
930
    self.activate().removeAllInList([path,])
931 932
    
  def importBT(self, bt):
933
    return bt.download(self.getSubversionPath(bt))
934 935 936 937 938 939 940 941
  
  # Get a list of files and keep only parents
  # Necessary before recursively commit removals
  def cleanChildrenInList(self, list):
    res = list
    for file in list:
      res = [x for x in res if file == x or file not in x]
    return res
942

943 944
  # return a set with directories present in the directory
  def getSetDirsForDir(self, directory):
945 946 947 948 949 950 951
    dir_set = set()
    for root, dirs, files in os.walk(directory):
      # don't visit SVN directories
      if '.svn' in dirs:
        dirs.remove('.svn')
      # get Directories
      for name in dirs:
952
        i = root.replace(directory, '').count(os.sep)
953
        f = os.path.join(root, name)
954
        dir_set.add((i, f.replace(directory,'')))
955 956 957 958 959 960 961 962 963
    return dir_set
      
  # return a set with files present in the directory
  def getSetFilesForDir(self, directory):
    dir_set = set()
    for root, dirs, files in os.walk(directory):
      # don't visit SVN directories
      if '.svn' in dirs:
        dirs.remove('.svn')
964
      # get Files
965 966
      for name in files:
        i = root.replace(directory, '').count(os.sep)
967
        f = os.path.join(root, name)
968
        dir_set.add((i, f.replace(directory,'')))
969
    return dir_set
970
  
971
  # return files present in new_dir but not in old_dir
972 973
  # return a set of relative paths
  def getNewFiles(self, old_dir, new_dir):
974 975 976 977
    if old_dir[-1] != os.sep:
      old_dir += os.sep
    if new_dir[-1] != os.sep:
      new_dir += os.sep
978 979
    old_set = self.getSetFilesForDir(old_dir)
    new_set = self.getSetFilesForDir(new_dir)
980 981
    return new_set.difference(old_set)

982 983 984 985 986 987 988 989 990 991 992
  # return dirs present in new_dir but not in old_dir
  # return a set of relative paths
  def getNewDirs(self, old_dir, new_dir):
    if old_dir[-1] != os.sep:
      old_dir += os.sep
    if new_dir[-1] != os.sep:
      new_dir += os.sep
    old_set = self.getSetDirsForDir(old_dir)
    new_set = self.getSetDirsForDir(new_dir)
    return new_set.difference(old_set)
    
993
  # svn del files that have been removed in new dir
994
  def deleteOldFiles(self, old_dir, new_dir, bt):
995
    # detect removed files
996
    files_set = self.getNewFiles(new_dir, old_dir)
997 998
    # detect removed directories
    dirs_set = self.getNewDirs(new_dir, old_dir)
999
    # svn del
1000 1001 1002 1003 1004 1005
    list = [x for x in files_set]
    list.sort()
    self.remove([os.path.join(old_dir, x[1]) for x in list])
    list = [x for x in dirs_set]
    list.sort()
    self.remove([os.path.join(old_dir, x[1]) for x in list])
1006
  
1007 1008
  # copy files and add new files
  def addNewFiles(self, old_dir, new_dir, bt):
1009
    # detect created files
1010
    files_set = self.getNewFiles(old_dir, new_dir)
1011 1012
    # detect created directories
    dirs_set = self.getNewDirs(old_dir, new_dir)
1013
    # Copy files
1014
    copytree(new_dir, old_dir)
1015
    # svn add
1016 1017 1018 1019 1020 1021
    list = [x for x in dirs_set]
    list.sort()
    self.add([os.path.join(old_dir, x[1]) for x in list])
    list = [x for x in files_set]
    list.sort()
    self.add([os.path.join(old_dir, x[1]) for x in list])
1022
  
1023 1024
  def treeToXML(self, item, bt) :
    working_copy = self.getSubversionPath(bt, False) + os.sep
1025 1026
    output = "<?xml version='1.0' encoding='iso-8859-1'?>"+ os.linesep
    output += "<tree id='0'>" + os.linesep
1027
    output = self._treeToXML(item, working_copy, output, 1, True)
1028 1029
    output += "</tree>" + os.linesep
    return output
1030
  
1031
  def _treeToXML(self, item, working_copy, output, ident, first) :
1032
    # Choosing a color coresponding to the status
1033
    itemStatus = item.msg_status
Christophe Dumez's avatar
Christophe Dumez committed
1034 1035
    if itemStatus == 'added' :
      itemColor='green'
1036
    elif itemStatus == 'modified' or  itemStatus == 'replaced' :
Christophe Dumez's avatar
Christophe Dumez committed
1037 1038 1039
      itemColor='orange'
    elif itemStatus == 'deleted' :
      itemColor='red'
1040 1041
    elif itemStatus == 'conflicted' :
      itemColor='grey'
Christophe Dumez's avatar
Christophe Dumez committed
1042 1043
    else :
      itemColor='black'
1044 1045
    if isinstance(item, Dir) :
      for i in range(ident) :
1046
        output += '\t'
Christophe Dumez's avatar
Christophe Dumez committed
1047
      if first :
1048
        output += '<item open="1" text="%s" id="%s" aCol="%s" '\
Christophe Dumez's avatar
Christophe Dumez committed
1049
        'im0="folder.png" im1="folder_open.png" '\
1050 1051
        'im2="folder.png">'%(item.name, item.full_path.replace(working_copy, ''), itemColor,) + os.linesep
        first = False
Christophe Dumez's avatar
Christophe Dumez committed
1052
      else :
1053
        output += '<item text="%s" id="%s" aCol="%s" im0="folder.png" ' \
1054
      'im1="folder_open.png" im2="folder.png">'%(item.name,
1055
item.full_path.replace(working_copy, ''), itemColor,) + os.linesep
1056
      for it in item.sub_dirs:
1057
        ident += 1
1058
        output = self._treeToXML(item.getDir(it.name), working_copy, output, ident,
Christophe Dumez's avatar
Christophe Dumez committed
1059
first)
1060 1061
        ident -= 1
      for i in range(ident) :
1062 1063
        output += '\t'
      output += '</item>' + os.linesep
1064 1065
    else :
      for i in range(ident) :
1066 1067
        output += '\t'
      output += '<item text="%s" id="%s" aCol="%s" im0="document.png"/>'\
1068
                %(item.name, item.full_path.replace(working_copy, ''), itemColor,) + os.linesep
1069
    return output
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1070 1071
    
InitializeClass(SubversionTool)