SubversionTool.py 32.7 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 31 32 33 34 35 36
#
# 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
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
37
import os, re, commands, time, exceptions, thread
Yoshinori Okuji's avatar
Yoshinori Okuji committed
38 39 40 41
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
42 43
from OFS.Image import manage_addFile
from cStringIO import StringIO
44
from tempfile import mktemp
45
from shutil import copy
46
from zLOG import LOG
Aurel's avatar
Aurel committed
47 48 49 50

try:
  from base64 import b64encode, b64decode
except ImportError:
51
  from base64 import encodestring as b64encode, decodestring as b64decode
52 53 54 55

class Error(exceptions.EnvironmentError):
    pass

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
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
76 77
      
def copytree(src, dst, symlinks=False):
78
    """Recursively copy a directory tree using copy().
79 80

    If exception(s) occur, an Error is raised with a list of reasons.
81
    dst dir must exist
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

    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):
98 99
                if not os.path.exists(dstname):
                  os.makedirs(dstname)
100 101
                copytree(srcname, dstname, symlinks)
            else:
102
                copy(srcname, dstname)
103
        except (IOError, os.error), why:
104
            errors.append((srcname, dstname, 'Error: ' + str(why.strerror)))
105 106
    if errors:
        raise Error, errors
107 108

  
109 110
class File :
  # Constructor
111 112 113
  def __init__(self, full_path, msg_status) :
    self.full_path = full_path
    self.msg_status = msg_status
114
    self.name = full_path.split(os.sep)[-1]
115 116 117 118
## End of File Class

class Dir :
  # Constructor
119 120 121
  def __init__(self, full_path, msg_status) :
    self.full_path = full_path
    self.msg_status = msg_status
122
    self.name = full_path.split(os.sep)[-1]
123
    self.sub_dirs = [] # list of sub directories
124 125 126

  # return a list of sub directories' names
  def getSubDirs(self) :
127
    return [d.name for d in self.sub_dirs]
128 129

  # return directory in subdirs given its name
130
  def getDir(self, name):
131
    for d in self.sub_dirs:
132
      if d.name == name:
133 134
        return d
## End of Dir Class
135 136 137 138 139 140 141 142

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

143
  def __init__(self, raw_diff):
144 145 146 147 148
    if '@@' not in raw_diff:
      self.binary=True
      return
    else:
      self.binary=False
149
    self.header = raw_diff.split('@@')[0][:-1]
150
    # Getting file path in header
151
    self.path = self.header.split('====')[0][:-1].strip()
152
    # Getting revisions in header
153
    for line in self.header.split(os.linesep):
154
      if line.startswith('--- '):
155
        tmp = re.search('\\([^)]+\\)$', line)
156
        self.old_revision = tmp.string[tmp.start():tmp.end()][1:-1].strip()
157
      if line.startswith('+++ '):
158
        tmp = re.search('\\([^)]+\\)$', line)
159
        self.new_revision = tmp.string[tmp.start():tmp.end()][1:-1].strip()
160
    # Splitting the body from the header
161
    self.body = os.linesep.join(raw_diff.strip().split(os.linesep)[4:])
162
    # Now splitting modifications
163
    self.children = []
164 165
    first = True
    tmp = []
166
    for line in self.body.split(os.linesep):
167 168
      if line:
        if line.startswith('@@') and not first:
169
          self.children.append(CodeBlock(os.linesep.join(tmp)))
170 171 172 173
          tmp = [line,]
        else:
          first = False
          tmp.append(line)
174
    self.children.append(CodeBlock(os.linesep.join(tmp)))
175 176
    

177
  def _escape(self, data):
178 179 180 181 182 183 184 185 186 187
    """
      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
    
188
  def toHTML(self):
189
    # Adding header of the table
190
    if self.binary:
191
      return '<b>Binary File or no changes!</b><br><br><br>'
192
    
Christophe Dumez's avatar
Christophe Dumez committed
193
    html = '''
194 195 196 197
    <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
198
      <td style="background-color: black;" width="2"></td>
199
      <td style="background-color: grey"><b><center>%s</center></b></td>
Christophe Dumez's avatar
Christophe Dumez committed
200
    </tr>'''%(self.old_revision, self.new_revision)
Christophe Dumez's avatar
Christophe Dumez committed
201
    header_color = 'grey'
202
    for child in self.children:
203
      # Adding line number of the modification
Christophe Dumez's avatar
Christophe Dumez committed
204 205 206 207 208 209
      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'
210 211 212 213 214 215
      # 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
216 217
        new_line = new_line_tuple[0] or ' '
        old_line = old_line_tuple[0] or ' '
218 219
        i+=1
        html += '''    <tr height="18px">
Christophe Dumez's avatar
Christophe Dumez committed
220 221 222 223
        <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;'))
224
    html += '''  </tbody>
Christophe Dumez's avatar
Christophe Dumez committed
225
</table><br><br>'''
226 227 228 229 230 231 232 233 234 235 236 237 238 239
    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)

240
  def __init__(self, raw_diff):
241
    # Splitting body and header
242 243
    self.body = os.linesep.join(raw_diff.split(os.linesep)[1:])
    self.header = raw_diff.split(os.linesep)[0]
244
    # Getting modifications lines
245 246
    tmp = re.search('^@@ -\d+', self.header)
    self.old_line = tmp.string[tmp.start():tmp.end()][4:]
Christophe Dumez's avatar
Christophe Dumez committed
247 248
    tmp = re.search('\+\d+', self.header)
    self.new_line = tmp.string[tmp.start():tmp.end()][1:]
249 250
    # Splitting modifications in SubCodeBlocks
    in_modif = False
251
    self.children = []
252
    tmp=[]
253
    for line in self.body.split(os.linesep):
254 255 256 257 258
      if line:
        if (line.startswith('+') or line.startswith('-')):
          if in_modif:
            tmp.append(line)
          else:
259
            self.children.append(SubCodeBlock(os.linesep.join(tmp)))
260 261 262 263
            tmp = [line,]
            in_modif = True
        else:
            if in_modif:
264
              self.children.append(SubCodeBlock(os.linesep.join(tmp)))
265 266 267 268
              tmp = [line,]
              in_modif = False
            else:
              tmp.append(line)
269
    self.children.append(SubCodeBlock(os.linesep.join(tmp)))
270 271
    
  # Return code before modification
272
  def getOldCodeList(self):
273
    tmp = []
274
    for child in self.children:
275 276 277 278
      tmp.extend(child.getOldCodeList())
    return tmp
    
  # Return code after modification
279
  def getNewCodeList(self):
280
    tmp = []
281
    for child in self.children:
282 283 284 285 286
      tmp.extend(child.getNewCodeList())
    return tmp
    
# a SubCodeBlock contain 0 or 1 modification (not more)
class SubCodeBlock:
287
  def __init__(self, code):
288 289
    self.body = code
    self.modification = self._getModif()
Christophe Dumez's avatar
Christophe Dumez committed
290 291
    self.old_code_length = self._getOldCodeLength()
    self.new_code_length = self._getNewCodeLength()
292
    # Choosing background color
293 294 295 296 297 298
    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
299
    else: # addition
300
      self.color = 'rgb(83, 253, 74);'#light green
301
    
302
  def _getModif(self):
303 304
    nb_plus = 0
    nb_minus = 0
305
    for line in self.body.split(os.linesep):
306 307 308 309 310 311
      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
312 313 314 315
    if (nb_minus==0):
      return 'addition'
    if (nb_plus==0):
      return 'deletion'
316
    return 'change'
Christophe Dumez's avatar
Christophe Dumez committed
317 318 319
      
  def _getOldCodeLength(self):
    nb_lines = 0
320
    for line in self.body.split(os.linesep):
Christophe Dumez's avatar
Christophe Dumez committed
321 322 323 324 325 326
      if not line.startswith("+"):
        nb_lines+=1
    return nb_lines
      
  def _getNewCodeLength(self):
    nb_lines = 0
327
    for line in self.body.split(os.linesep):
Christophe Dumez's avatar
Christophe Dumez committed
328 329 330
      if not line.startswith("-"):
        nb_lines+=1
    return nb_lines
331
  
332
  # Return code before modification
333 334
  def getOldCodeList(self):
    if self.modification=='none':
335
      old_code = [(x, 'white') for x in self.body.split(os.linesep)]
Christophe Dumez's avatar
Christophe Dumez committed
336
    elif self.modification=='change':
337
      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
338 339 340 341
      # 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)
342
    else: # deletion or addition
343
      old_code = [self._getOldCodeList(x) for x in self.body.split(os.linesep)]
344
    return old_code
345
  
346
  def _getOldCodeList(self, line):
347
    if line.startswith('+'):
348
      return (None, self.color)
349
    if line.startswith('-'):
350 351
      return (' '+line[1:], self.color)
    return (line, self.color)
352 353
  
  # Return code after modification
354 355
  def getNewCodeList(self):
    if self.modification=='none':
356
      new_code = [(x, 'white') for x in self.body.split(os.linesep)]
Christophe Dumez's avatar
Christophe Dumez committed
357
    elif self.modification=='change':
358
      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
359 360 361 362
      # 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)
363
    else: # deletion or addition
364
      new_code = [self._getNewCodeList(x) for x in self.body.split(os.linesep)]
365
    return new_code
366
  
367
  def _getNewCodeList(self, line):
368
    if line.startswith('-'):
369
      return (None, self.color)
370
    if line.startswith('+'):
371 372
      return (' '+line[1:], self.color)
    return (line, self.color)
373
  
Yoshinori Okuji's avatar
Yoshinori Okuji committed
374 375 376 377 378 379 380 381 382 383 384
class SubversionTool(UniqueObject, Folder):
  """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')
385

Yoshinori Okuji's avatar
Yoshinori Okuji committed
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
  # 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
425 426 427 428
    
  def setWorkingDirectory(self, path):
    self.workingDirectory = path
    os.chdir(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
429 430 431 432 433 434 435 436

  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
437
    
Christophe Dumez's avatar
Christophe Dumez committed
438 439
  
  # path is the path in svn working copy
440 441
  # return edit_path in zodb to edit it
  # return '#' if no zodb path is found
Christophe Dumez's avatar
Christophe Dumez committed
442 443
  def editPath(self, bt, path):
    """Return path to edit file
444
       path can be relative or absolute
Christophe Dumez's avatar
Christophe Dumez committed
445
    """
446
    path = self.relativeToAbsolute(path, bt).replace('\\', '/')
447
    if 'bt' in path.split('/'):
448
      # not in zodb
Christophe Dumez's avatar
Christophe Dumez committed
449
      return '#'
450 451 452
    # if file have been deleted then not in zodb
    if not os.path.exists(path):
      return '#'
453
    svn_path = self.getSubversionPath(bt).replace('\\', '/')
Christophe Dumez's avatar
Christophe Dumez committed
454
    edit_path = path.replace(svn_path, '')
455 456 457
    if edit_path.strip() == '':
      # not in zodb 
      return '#'
458
    if edit_path[0] == '/':
459
      edit_path = edit_path[1:]
460
    edit_path = '/'.join(edit_path.split('/')[1:])
461 462 463
    if edit_path.strip() == '':
      # not in zodb 
      return '#'
Christophe Dumez's avatar
Christophe Dumez committed
464 465 466 467
    tmp = re.search('\\.[\w]+$', edit_path)
    if tmp:
      extension = tmp.string[tmp.start():tmp.end()].strip()
      edit_path = edit_path.replace(extension, '')
468
    edit_path = bt.REQUEST["BASE2"] + '/' + edit_path + '/manage_main'
Christophe Dumez's avatar
Christophe Dumez committed
469 470
    return edit_path
    
Yoshinori Okuji's avatar
Yoshinori Okuji committed
471 472 473 474 475 476 477
  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))
478 479 480 481
  
  def goToWorkingCopy(self, bt):
      working_path = self.getSubversionPath(bt)
      os.chdir(working_path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
482
    
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
  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
498
    expires = (DateTime() + 7).toZone('GMT').rfc822()
499
    request.set(self.login_cookie_name, value)
500
    response.setCookie(self.login_cookie_name, value, path = '/', expires = expires)
501

Yoshinori Okuji's avatar
Yoshinori Okuji committed
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
  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
521
    trust_item_list, permanent = loads(b64decode(trust))
Yoshinori Okuji's avatar
Yoshinori Okuji committed
522
    return dict(trust_item_list), permanent
523
  
524 525
  def diffHTML(self, file_path, bt, revision1=None, revision2=None):
    raw_diff = self.diff(file_path, bt, revision1, revision2)
526
    return DiffFile(raw_diff).toHTML()
Christophe Dumez's avatar
Christophe Dumez committed
527 528
  
  # Display a file content in HTML
Christophe Dumez's avatar
Christophe Dumez committed
529
  def fileHTML(self, bt, file_path):
530
    file_path = self.relativeToAbsolute(file_path, bt)
531 532 533
    if os.path.exists(file_path):
      if os.path.isdir(file_path):
        text = "<b>"+file_path+"</b><hr>"
534
        text += file_path +" is a folder!"
535 536 537
      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)
538
        text = head + os.linesep.join(text.split(os.linesep)[10:-4])
539 540 541
      return text
    else:
      # see if tmp file is here (svn deleted file)
542
      if file_path[-1]==os.sep:
543
        file_path=file_path[:-1]
544 545
      filename = file_path.split(os.sep)[-1]
      tmp_path = os.sep.join(file_path.split(os.sep)[:-1])
546 547
      tmp_path = os.path.join(tmp_path,'.svn','text-base',filename+'.svn-base')
      LOG('path_HD', 1, tmp_path)
548 549 550
      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)
551
        text = head + os.linesep.join(text.split(os.linesep)[10:-4])
552 553
      else : # does not exist
        text = "<b>"+file_path+"</b><hr>"
554
        text += file_path +" does not exist!"
555 556
      return text
      
Yoshinori Okuji's avatar
Yoshinori Okuji committed
557 558 559 560 561 562 563 564 565
  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
566
      trust_list.append(cookie)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
567 568 569 570
    # 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
571
    expires = (DateTime() + 7).toZone('GMT').rfc822()
572
    request.set(self.ssl_trust_cookie_name, value)
573
    response.setCookie(self.ssl_trust_cookie_name, value, path = '/', expires = expires)
Christophe Dumez's avatar
Christophe Dumez committed
574 575 576
    
  def acceptSSLPerm(self, trust_dict):
    self.acceptSSLServer(self, trust_dict, True)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593

  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)
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
  
  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()
    bt_name = bt.getTitle()
    if len(wc_list) == 0 :
      raise 'Preferences Error', 'Please set at least one Subversion Working Copy in preferences first!'
    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):
          LOG("wc path", 1, wc_path);
          if with_name:
            return wc_path
          else:
            return os.sep.join(wc_path.split(os.sep)[:-1])
    raise 'Unknown Business Template', "Could not find '"+bt_name+"' at first level of working copies!"
    
Yoshinori Okuji's avatar
Yoshinori Okuji committed
617 618 619 620 621
  security.declareProtected('Import/Export objects', 'update')
  def update(self, path):
    """Update a working copy.
    """
    client = self._getClient()
622
    return client.update(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
623 624

  security.declareProtected('Import/Export objects', 'add')
625 626
  # path can be a list or not (relative or absolute)
  def add(self, path, bt=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
627 628
    """Add a file or a directory.
    """
629 630 631 632 633
    if bt:
      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
634
    client = self._getClient()
635
    return client.add(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
636

637
  security.declareProtected('Import/Export objects', 'info')
638
  def info(self, bt):
639 640
    """return info of working copy
    """
641
    working_copy = self.getSubversionPath(bt)
642 643 644
    client = self._getClient()
    return client.info(working_copy)
  
Christophe Dumez's avatar
Christophe Dumez committed
645
  security.declareProtected('Import/Export objects', 'log')
646 647
  # path can be absolute or relative
  def log(self, path, bt):
Christophe Dumez's avatar
Christophe Dumez committed
648 649 650
    """return log of a file or dir
    """
    client = self._getClient()
651
    return client.log(self.relativeToAbsolute(path, bt))
Christophe Dumez's avatar
Christophe Dumez committed
652
  
653
  security.declareProtected('Import/Export objects', 'cleanup')
654
  def cleanup(self, bt):
655 656
    """remove svn locks in working copy
    """
657
    working_copy = self.getSubversionPath(bt)
658 659 660
    client = self._getClient()
    return client.cleanup(working_copy)

Yoshinori Okuji's avatar
Yoshinori Okuji committed
661
  security.declareProtected('Import/Export objects', 'remove')
662 663
  # path can be a list or not (relative or absolute)
  def remove(self, path, bt=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
664 665
    """Remove a file or a directory.
    """
666 667 668 669 670
    if bt:
      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
671
    client = self._getClient()
672
    return client.remove(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
673 674 675 676 677 678 679 680

  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
681
  security.declareProtected('Import/Export objects', 'ls')
682 683
  # path can be relative or absolute
  def ls(self, path, bt):
Christophe Dumez's avatar
Christophe Dumez committed
684 685 686
    """Display infos about a file.
    """
    client = self._getClient()
687
    return client.ls(self.relativeToAbsolute(path, bt))
Christophe Dumez's avatar
Christophe Dumez committed
688

Yoshinori Okuji's avatar
Yoshinori Okuji committed
689
  security.declareProtected('Import/Export objects', 'diff')
690 691
  # path can be relative or absolute
  def diff(self, path, bt, revision1=None, revision2=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
692 693 694
    """Make a diff for a file or a directory.
    """
    client = self._getClient()
695
    return client.diff(self.relativeToAbsolute(path, bt), revision1, revision2)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
696 697

  security.declareProtected('Import/Export objects', 'revert')
698 699
  # path can be absolute or relative
  def revert(self, path, bt):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
700 701 702
    """Revert local changes in a file or a directory.
    """
    client = self._getClient()
703 704 705 706
    if isinstance(path, list) :
      path = [self.relativeToAbsolute(x, bt) for x in path]
    else:
      path = self.relativeToAbsolute(path, bt)
Christophe Dumez's avatar
Christophe Dumez committed
707
    return client.revert(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
708

709 710 711 712 713 714 715 716 717 718
  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
719
  security.declareProtected('Import/Export objects', 'checkin')
720 721
  # 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
722 723
    """Commit local changes.
    """
724 725 726 727
    if isinstance(path, list) :
      path = [self.relativeToAbsolute(x, bt) for x in path]
    else:
      path = self.relativeToAbsolute(path, bt)
728
    client = self._getClient()
729
    return client.checkin(path, log_message, recurse)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
730 731 732 733 734 735

  security.declareProtected('Import/Export objects', 'status')
  def status(self, path, **kw):
    """Get status.
    """
    client = self._getClient()
Christophe Dumez's avatar
Christophe Dumez committed
736
    return client.status(path, **kw)
737
  
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
  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
      
  security.declareProtected('Import/Export objects', 'removeAllInList')
  def removeAllInList(self, list):
    """Remove all files and folders in list
    """
    for file in list:
      removeAll(file)
    
759
  def getModifiedTree(self, bt) :
Christophe Dumez's avatar
Christophe Dumez committed
760
    # Remove trailing slash if it's present
761
    path = self.getSubversionPath(bt)
Christophe Dumez's avatar
Christophe Dumez committed
762
    root = Dir(path, "normal")
763
    somethingModified = False
764
    
765
    for statusObj in self.status(path) :
766
      # can be (normal, added, modified, deleted, conflicted, unversioned)
767
      msg_status = statusObj.getTextStatus()
768
      if str(msg_status) != "normal" and str(msg_status) != "unversioned":
769
        somethingModified = True
Christophe Dumez's avatar
Christophe Dumez committed
770
        full_path = statusObj.getPath()
771
        full_path_list = full_path.split(os.sep)[1:]
Christophe Dumez's avatar
Christophe Dumez committed
772
        relative_path = full_path[len(path)+1:]
773
        relative_path_list = relative_path.split(os.sep)
774
        # Processing entry
Christophe Dumez's avatar
Christophe Dumez committed
775 776 777
        filename = relative_path_list[-1]
        # Needed or files will be both File & Dir objects
        relative_path_list = relative_path_list[:-1]
778
        parent = root
779
        i = len(path.split(os.sep))-1
Christophe Dumez's avatar
Christophe Dumez committed
780 781 782 783
        
        for d in relative_path_list :
          i += 1
          if d :
784
            full_pathOfd = os.sep+os.sep.join(full_path_list[:i]).strip()
785
            if d not in parent.getSubDirs() :
786
              parent.sub_dirs.append(Dir(full_pathOfd, "normal"))
787
            parent = parent.getDir(d)
Christophe Dumez's avatar
Christophe Dumez committed
788
        if os.path.isdir(full_path) :
789 790
          if full_path == parent.full_path :
            parent.msg_status = str(msg_status)
791 792
          elif filename not in parent.getSubDirs() :
            parent.sub_dirs.append(Dir(filename, str(msg_status)))
Christophe Dumez's avatar
Christophe Dumez committed
793
          else :
794
            tmp = parent.getDir(filename)
795
            tmp.msg_status = str(msg_status)
Christophe Dumez's avatar
Christophe Dumez committed
796
        else :
Christophe Dumez's avatar
Christophe Dumez committed
797
          parent.sub_dirs.append(File(full_path, str(msg_status)))
798
    return somethingModified and root
799
  
800
  def extractBT(self, bt):
801
    path = mktemp()  +os.sep
802
    bt.export(path=path, local=1)
803
    svn_path = self.getSubversionPath(bt) + os.sep
804
    # svn del deleted files
805
    self.deleteOldFiles(svn_path, path, bt)
806
    # add new files and copy
807
    self.addNewFiles(svn_path, path, bt)
808
    self.goToWorkingCopy(bt)
809
    # Clean up
810
    self.activate().removeAllInList([path,])
811

812 813
  # return a set with directories present in the directory
  def getSetDirsForDir(self, directory):
814 815 816 817 818 819 820
    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:
821
        i = root.replace(directory, '').count(os.sep)
822
        f = os.path.join(root, name)
823
        dir_set.add((i, f.replace(directory,'')))
824 825 826 827 828 829 830 831 832
    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')
833
      # get Files
834 835
      for name in files:
        i = root.replace(directory, '').count(os.sep)
836
        f = os.path.join(root, name)
837
        dir_set.add((i, f.replace(directory,'')))
838
    return dir_set
839
  
840
  # return files present in new_dir but not in old_dir
841 842
  # return a set of relative paths
  def getNewFiles(self, old_dir, new_dir):
843 844 845 846
    if old_dir[-1] != os.sep:
      old_dir += os.sep
    if new_dir[-1] != os.sep:
      new_dir += os.sep
847 848
    old_set = self.getSetFilesForDir(old_dir)
    new_set = self.getSetFilesForDir(new_dir)
849 850
    return new_set.difference(old_set)

851 852 853 854 855 856 857 858 859 860 861
  # 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)
    
862
  # svn del files that have been removed in new dir
863
  def deleteOldFiles(self, old_dir, new_dir, bt):
864
    # detect removed files
865
    files_set = self.getNewFiles(new_dir, old_dir)
866 867
    # detect removed directories
    dirs_set = self.getNewDirs(new_dir, old_dir)
868
    # svn del
869 870 871 872 873 874
    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])
875
  
876 877
  # copy files and add new files
  def addNewFiles(self, old_dir, new_dir, bt):
878
    # detect created files
879
    files_set = self.getNewFiles(old_dir, new_dir)
880 881
    # detect created directories
    dirs_set = self.getNewDirs(old_dir, new_dir)
882
    # Copy files
883
    copytree(new_dir, old_dir)
884
    # svn add
885 886 887 888 889 890
    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])
891
  
892 893
  def treeToXML(self, item, bt) :
    working_copy = self.getSubversionPath(bt, False) + os.sep
894 895
    output = "<?xml version='1.0' encoding='iso-8859-1'?>"+ os.linesep
    output += "<tree id='0'>" + os.linesep
896
    output = self._treeToXML(item, working_copy, output, 1, True)
897 898
    output += "</tree>" + os.linesep
    return output
899
  
900
  def _treeToXML(self, item, working_copy, output, ident, first) :
901
    # Choosing a color coresponding to the status
902
    itemStatus = item.msg_status
Christophe Dumez's avatar
Christophe Dumez committed
903 904
    if itemStatus == 'added' :
      itemColor='green'
905
    elif itemStatus == 'modified' or  itemStatus == 'replaced' :
Christophe Dumez's avatar
Christophe Dumez committed
906 907 908
      itemColor='orange'
    elif itemStatus == 'deleted' :
      itemColor='red'
909 910
    elif itemStatus == 'conflicted' :
      itemColor='grey'
Christophe Dumez's avatar
Christophe Dumez committed
911 912
    else :
      itemColor='black'
913 914
    if isinstance(item, Dir) :
      for i in range(ident) :
915
        output += '\t'
Christophe Dumez's avatar
Christophe Dumez committed
916
      if first :
917
        output += '<item open="1" text="%s" id="%s" aCol="%s" '\
Christophe Dumez's avatar
Christophe Dumez committed
918
        'im0="folder.png" im1="folder_open.png" '\
919 920
        'im2="folder.png">'%(item.name, item.full_path.replace(working_copy, ''), itemColor,) + os.linesep
        first = False
Christophe Dumez's avatar
Christophe Dumez committed
921
      else :
922
        output += '<item text="%s" id="%s" aCol="%s" im0="folder.png" ' \
923
      'im1="folder_open.png" im2="folder.png">'%(item.name,
924
item.full_path.replace(working_copy, ''), itemColor,) + os.linesep
925
      for it in item.sub_dirs:
926
        ident += 1
927
        output = self._treeToXML(item.getDir(it.name), working_copy, output, ident,
Christophe Dumez's avatar
Christophe Dumez committed
928
first)
929 930
        ident -= 1
      for i in range(ident) :
931 932
        output += '\t'
      output += '</item>' + os.linesep
933 934
    else :
      for i in range(ident) :
935 936
        output += '\t'
      output += '<item text="%s" id="%s" aCol="%s" im0="document.png"/>'\
937
                %(item.name, item.full_path.replace(working_copy, ''), itemColor,) + os.linesep
938
    return output
Yoshinori Okuji's avatar
Yoshinori Okuji committed
939 940
    
InitializeClass(SubversionTool)