SubversionTool.py 37.2 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 Products.CMFCore.utils import getToolByName
48
from Products.ERP5.Document.BusinessTemplate import removeAll
49
from xml.sax.saxutils import escape
Aurel's avatar
Aurel committed
50

51

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

class Error(exceptions.EnvironmentError):
    pass

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
      
def copytree(src, dst, symlinks=False):
77
    """Recursively copy a directory tree using copy().
78 79

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

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

  
108 109
class File :
  # Constructor
110 111 112
  def __init__(self, full_path, msg_status) :
    self.full_path = full_path
    self.msg_status = msg_status
113
    self.name = os.path.basename(full_path)
114 115 116 117
## End of File Class

class Dir :
  # Constructor
118 119 120
  def __init__(self, full_path, msg_status) :
    self.full_path = full_path
    self.msg_status = msg_status
121
    self.name = os.path.basename(full_path)
122
    self.sub_dirs = [] # list of sub directories
123 124 125

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

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

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

142
  def __init__(self, raw_diff):
143 144 145 146 147
    if '@@' not in raw_diff:
      self.binary=True
      return
    else:
      self.binary=False
148
    self.header = raw_diff.split('@@')[0][:-1]
149
    # Getting file path in header
150
    self.path = self.header.split('====')[0][:-1].strip()
151
    # Getting revisions in header
152
    for line in self.header.split(os.linesep):
153
      if line.startswith('--- '):
154
        tmp = re.search('\\([^)]+\\)$', line)
155
        self.old_revision = tmp.string[tmp.start():tmp.end()][1:-1].strip()
156
      if line.startswith('+++ '):
157
        tmp = re.search('\\([^)]+\\)$', line)
158
        self.new_revision = tmp.string[tmp.start():tmp.end()][1:-1].strip()
159
    # Splitting the body from the header
160
    self.body = os.linesep.join(raw_diff.strip().split(os.linesep)[4:])
161
    # Now splitting modifications
162
    self.children = []
163 164
    first = True
    tmp = []
165
    for line in self.body.split(os.linesep):
166 167
      if line:
        if line.startswith('@@') and not first:
168
          self.children.append(CodeBlock(os.linesep.join(tmp)))
169 170 171 172
          tmp = [line,]
        else:
          first = False
          tmp.append(line)
173
    self.children.append(CodeBlock(os.linesep.join(tmp)))
174
    
175
  def toHTML(self):
176
    # Adding header of the table
177
    if self.binary:
Christophe Dumez's avatar
Christophe Dumez committed
178
      return '<b>Folder or binary file or just no changes!</b><br><br><br>'
179
    
Christophe Dumez's avatar
Christophe Dumez committed
180
    html = '''
181 182 183 184
    <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
185
      <td style="background-color: black;" width="2"></td>
186
      <td style="background-color: grey"><b><center>%s</center></b></td>
Christophe Dumez's avatar
Christophe Dumez committed
187
    </tr>'''%(self.old_revision, self.new_revision)
Christophe Dumez's avatar
Christophe Dumez committed
188
    header_color = 'grey'
189
    for child in self.children:
190
      # Adding line number of the modification
Christophe Dumez's avatar
Christophe Dumez committed
191 192 193 194 195 196
      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'
197 198 199 200 201 202
      # 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
203 204
        new_line = new_line_tuple[0] or ' '
        old_line = old_line_tuple[0] or ' '
205 206
        i+=1
        html += '''    <tr height="18px">
Christophe Dumez's avatar
Christophe Dumez committed
207 208 209
        <td style="background-color: %s">%s</td>
        <td style="background-color: black;" width="2"></td>
        <td style="background-color: %s">%s</td>
210
        </tr>'''%(old_line_tuple[1], escape(old_line).replace(' ', '&nbsp;').replace('\t', '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'), new_line_tuple[1], escape(new_line).replace(' ', '&nbsp;').replace('\t', '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'))
211
    html += '''  </tbody>
Christophe Dumez's avatar
Christophe Dumez committed
212
</table><br><br>'''
213 214 215 216 217 218 219 220 221 222 223 224 225 226
    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)

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
373 374 375 376 377 378 379 380 381 382 383 384 385 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
  # 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
412 413 414 415
    
  def setWorkingDirectory(self, path):
    self.workingDirectory = path
    os.chdir(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
416 417 418 419 420 421 422 423

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
490 491 492 493 494 495 496 497 498
  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
499 500 501 502 503 504 505 506
      
  def getHeader(self, bt, file):
    file = self.relativeToAbsolute(file, bt)
    header = "<b><a href='BusinessTemplate_viewSvnShowFile?file="+file+"'>" + file + "</a></b>"
    edit_path = self.editPath(bt, file)
    if edit_path != '#':
      header += "&nbsp;&nbsp;<a href='"+self.editPath(bt, file)+"'><img src='imgs/edit.png' border='0'></a>"
    return header
Yoshinori Okuji's avatar
Yoshinori Okuji committed
507 508 509 510 511 512 513 514 515 516

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

  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)
590 591 592 593 594 595 596 597 598
  
  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()
599 600 601
    if not wc_list:
      wc_list = self.getPortalObject().portal_preferences.default_site_preference.getPreferredSubversionWorkingCopyList()
      if not wc_list:
602
        raise SubversionPreferencesError, 'Please set at least one Subversion Working Copy in preferences first.'
603 604
    bt_name = bt.getTitle()
    if len(wc_list) == 0 :
605
      raise SubversionPreferencesError, 'Please set at least one Subversion Working Copy in preferences first.'
606 607 608 609 610 611 612 613
    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])
614
    raise SubversionUnknownBusinessTemplateError, "Could not find '"+bt_name+"' at first level of working copies."
615
    
Yoshinori Okuji's avatar
Yoshinori Okuji committed
616
  security.declareProtected('Import/Export objects', 'update')
617
  def update(self, bt):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
618 619
    """Update a working copy.
    """
620
    path = self.getSubversionPath(bt)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
621
    client = self._getClient()
622 623 624 625 626
    # 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
627
    return self.importBT(bt)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
628

629 630 631 632 633 634
  security.declareProtected('Import/Export objects', 'switch')
  def switch(self, bt, url):
    """switch SVN repository for a working copy.
    """
    path = self.getSubversionPath(bt)
    client = self._getClient()
635 636
    if url[-1] == '/' :
      url = url[:-1]
637
    # Update from SVN
638
    client.switch(path=path, url=url)
639
  
Yoshinori Okuji's avatar
Yoshinori Okuji committed
640
  security.declareProtected('Import/Export objects', 'add')
641 642
  # path can be a list or not (relative or absolute)
  def add(self, path, bt=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
643 644
    """Add a file or a directory.
    """
Christophe Dumez's avatar
Christophe Dumez committed
645
    if bt is not None:
646 647 648 649
      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
650
    client = self._getClient()
651
    return client.add(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
652

653
  security.declareProtected('Import/Export objects', 'info')
654
  def info(self, bt):
655 656
    """return info of working copy
    """
657
    working_copy = self.getSubversionPath(bt)
658 659 660
    client = self._getClient()
    return client.info(working_copy)
  
Christophe Dumez's avatar
Christophe Dumez committed
661
  security.declareProtected('Import/Export objects', 'log')
662 663
  # path can be absolute or relative
  def log(self, path, bt):
Christophe Dumez's avatar
Christophe Dumez committed
664 665 666
    """return log of a file or dir
    """
    client = self._getClient()
667
    return client.log(self.relativeToAbsolute(path, bt))
Christophe Dumez's avatar
Christophe Dumez committed
668
  
669
  security.declareProtected('Import/Export objects', 'cleanup')
670
  def cleanup(self, bt):
671 672
    """remove svn locks in working copy
    """
673
    working_copy = self.getSubversionPath(bt)
674 675 676
    client = self._getClient()
    return client.cleanup(working_copy)

Yoshinori Okuji's avatar
Yoshinori Okuji committed
677
  security.declareProtected('Import/Export objects', 'remove')
678 679
  # path can be a list or not (relative or absolute)
  def remove(self, path, bt=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
680 681
    """Remove a file or a directory.
    """
Christophe Dumez's avatar
Christophe Dumez committed
682
    if bt is not None:
683 684 685 686
      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
687
    client = self._getClient()
688
    return client.remove(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
689 690 691 692 693 694 695 696

  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
697
  security.declareProtected('Import/Export objects', 'ls')
698 699
  # path can be relative or absolute
  def ls(self, path, bt):
Christophe Dumez's avatar
Christophe Dumez committed
700 701 702
    """Display infos about a file.
    """
    client = self._getClient()
703
    return client.ls(self.relativeToAbsolute(path, bt))
Christophe Dumez's avatar
Christophe Dumez committed
704

Yoshinori Okuji's avatar
Yoshinori Okuji committed
705
  security.declareProtected('Import/Export objects', 'diff')
706 707
  # path can be relative or absolute
  def diff(self, path, bt, revision1=None, revision2=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
708 709 710
    """Make a diff for a file or a directory.
    """
    client = self._getClient()
711
    return client.diff(self.relativeToAbsolute(path, bt), revision1, revision2)
712
  
Yoshinori Okuji's avatar
Yoshinori Okuji committed
713
  security.declareProtected('Import/Export objects', 'revert')
714
  # path can be absolute or relative
715
  def revert(self, path, bt=None, recurse=False):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
716 717 718
    """Revert local changes in a file or a directory.
    """
    client = self._getClient()
719 720
    if not isinstance(path, list) :
      path = [path]
Christophe Dumez's avatar
Christophe Dumez committed
721
    if bt is not None:
722
      path = [self.relativeToAbsolute(x, bt) for x in path]
Christophe Dumez's avatar
Christophe Dumez committed
723
    client.revert(path, recurse)
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753

  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'
754
    path_added_list = []
755 756 757 758 759 760 761 762 763 764 765
    # 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)]
766 767 768 769 770 771 772 773 774 775 776 777 778 779
            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())
780 781 782 783 784 785
    #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
786
      installed_bt = bt.portal_templates.getInstalledBusinessTemplate(                                                          bt.getTitle())
787
      installed_bt.reinstall(object_to_update=object_to_update, force=0)
Christophe Dumez's avatar
Christophe Dumez committed
788 789 790 791 792 793 794 795 796 797 798 799
    
  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
800

801 802 803 804 805 806 807 808 809 810
  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
811
  security.declareProtected('Import/Export objects', 'checkin')
812 813
  # 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
814 815
    """Commit local changes.
    """
816 817 818 819
    if isinstance(path, list) :
      path = [self.relativeToAbsolute(x, bt) for x in path]
    else:
      path = self.relativeToAbsolute(path, bt)
820
    client = self._getClient()
821
    return client.checkin(path, log_message, recurse)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
822 823 824 825 826 827

  security.declareProtected('Import/Export objects', 'status')
  def status(self, path, **kw):
    """Get status.
    """
    client = self._getClient()
Christophe Dumez's avatar
Christophe Dumez committed
828
    return client.status(path, **kw)
829
  
830 831 832 833 834 835 836 837 838 839 840 841 842 843
  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
      
844 845 846 847 848 849 850 851 852 853 854 855 856 857
  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

858 859 860 861 862 863 864
  security.declareProtected('Import/Export objects', 'removeAllInList')
  def removeAllInList(self, list):
    """Remove all files and folders in list
    """
    for file in list:
      removeAll(file)
    
865
  def getModifiedTree(self, bt) :
Christophe Dumez's avatar
Christophe Dumez committed
866
    # Remove trailing slash if it's present
867
    path = self.getSubversionPath(bt)
Christophe Dumez's avatar
Christophe Dumez committed
868
    root = Dir(path, "normal")
869
    somethingModified = False
870
    
871
    for statusObj in self.status(path) :
872
      # can be (normal, added, modified, deleted, conflicted, unversioned)
873
      msg_status = statusObj.getTextStatus()
874
      if str(msg_status) != "normal" and str(msg_status) != "unversioned":
875
        somethingModified = True
Christophe Dumez's avatar
Christophe Dumez committed
876
        full_path = statusObj.getPath()
877
        full_path_list = full_path.split(os.sep)[1:]
Christophe Dumez's avatar
Christophe Dumez committed
878
        relative_path = full_path[len(path)+1:]
879
        relative_path_list = relative_path.split(os.sep)
880
        # Processing entry
Christophe Dumez's avatar
Christophe Dumez committed
881 882 883
        filename = relative_path_list[-1]
        # Needed or files will be both File & Dir objects
        relative_path_list = relative_path_list[:-1]
884
        parent = root
885
        i = len(path.split(os.sep))-1
Christophe Dumez's avatar
Christophe Dumez committed
886 887 888 889
        
        for d in relative_path_list :
          i += 1
          if d :
890
            full_pathOfd = os.sep+os.sep.join(full_path_list[:i]).strip()
891
            if d not in parent.getSubDirs() :
892
              parent.sub_dirs.append(Dir(full_pathOfd, "normal"))
893
            parent = parent.getDir(d)
Christophe Dumez's avatar
Christophe Dumez committed
894
        if os.path.isdir(full_path) :
895 896
          if full_path == parent.full_path :
            parent.msg_status = str(msg_status)
897 898
          elif filename not in parent.getSubDirs() :
            parent.sub_dirs.append(Dir(filename, str(msg_status)))
Christophe Dumez's avatar
Christophe Dumez committed
899
          else :
900
            tmp = parent.getDir(filename)
901
            tmp.msg_status = str(msg_status)
Christophe Dumez's avatar
Christophe Dumez committed
902
        else :
Christophe Dumez's avatar
Christophe Dumez committed
903
          parent.sub_dirs.append(File(full_path, str(msg_status)))
904
    return somethingModified and root
905
  
906
  def extractBT(self, bt):
907
    bt.build()
908
    svn_path = self.getSubversionPath(bt) + os.sep
909
    path = mktemp()  +os.sep
910 911
    bt.export(path=path, local=1)
    # svn del deleted files
912
    self.deleteOldFiles(svn_path, path, bt)
913
    # add new files and copy
914
    self.addNewFiles(svn_path, path, bt)
915
    self.goToWorkingCopy(bt)
916
    # Clean up
917
    self.activate().removeAllInList([path,])
918 919
    
  def importBT(self, bt):
920
    return bt.download(self.getSubversionPath(bt))
921 922 923 924 925 926 927 928
  
  # 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
929

930 931
  # return a set with directories present in the directory
  def getSetDirsForDir(self, directory):
932 933 934 935 936 937 938
    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:
939
        i = root.replace(directory, '').count(os.sep)
940
        f = os.path.join(root, name)
941
        dir_set.add((i, f.replace(directory,'')))
942 943 944 945 946 947 948 949 950
    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')
951
      # get Files
952 953
      for name in files:
        i = root.replace(directory, '').count(os.sep)
954
        f = os.path.join(root, name)
955
        dir_set.add((i, f.replace(directory,'')))
956
    return dir_set
957
  
958
  # return files present in new_dir but not in old_dir
959 960
  # return a set of relative paths
  def getNewFiles(self, old_dir, new_dir):
961 962 963 964
    if old_dir[-1] != os.sep:
      old_dir += os.sep
    if new_dir[-1] != os.sep:
      new_dir += os.sep
965 966
    old_set = self.getSetFilesForDir(old_dir)
    new_set = self.getSetFilesForDir(new_dir)
967 968
    return new_set.difference(old_set)

969 970 971 972 973 974 975 976 977 978 979
  # 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)
    
980
  # svn del files that have been removed in new dir
981
  def deleteOldFiles(self, old_dir, new_dir, bt):
982
    # detect removed files
983
    files_set = self.getNewFiles(new_dir, old_dir)
984 985
    # detect removed directories
    dirs_set = self.getNewDirs(new_dir, old_dir)
986
    # svn del
987 988 989 990 991 992
    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])
993
  
994 995
  # copy files and add new files
  def addNewFiles(self, old_dir, new_dir, bt):
996
    # detect created files
997
    files_set = self.getNewFiles(old_dir, new_dir)
998 999
    # detect created directories
    dirs_set = self.getNewDirs(old_dir, new_dir)
1000
    # Copy files
1001
    copytree(new_dir, old_dir)
1002
    # svn add
1003 1004 1005 1006 1007 1008
    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])
1009
  
1010 1011
  def treeToXML(self, item, bt) :
    working_copy = self.getSubversionPath(bt, False) + os.sep
1012 1013
    output = "<?xml version='1.0' encoding='iso-8859-1'?>"+ os.linesep
    output += "<tree id='0'>" + os.linesep
1014
    output = self._treeToXML(item, working_copy, output, 1, True)
1015 1016
    output += "</tree>" + os.linesep
    return output
1017
  
1018
  def _treeToXML(self, item, working_copy, output, ident, first) :
1019
    # Choosing a color coresponding to the status
1020
    itemStatus = item.msg_status
Christophe Dumez's avatar
Christophe Dumez committed
1021 1022
    if itemStatus == 'added' :
      itemColor='green'
1023
    elif itemStatus == 'modified' or  itemStatus == 'replaced' :
Christophe Dumez's avatar
Christophe Dumez committed
1024 1025 1026
      itemColor='orange'
    elif itemStatus == 'deleted' :
      itemColor='red'
1027 1028
    elif itemStatus == 'conflicted' :
      itemColor='grey'
Christophe Dumez's avatar
Christophe Dumez committed
1029 1030
    else :
      itemColor='black'
1031 1032
    if isinstance(item, Dir) :
      for i in range(ident) :
1033
        output += '\t'
Christophe Dumez's avatar
Christophe Dumez committed
1034
      if first :
1035
        output += '<item open="1" text="%s" id="%s" aCol="%s" '\
Christophe Dumez's avatar
Christophe Dumez committed
1036
        'im0="folder.png" im1="folder_open.png" '\
1037 1038
        'im2="folder.png">'%(item.name, item.full_path.replace(working_copy, ''), itemColor,) + os.linesep
        first = False
Christophe Dumez's avatar
Christophe Dumez committed
1039
      else :
1040
        output += '<item text="%s" id="%s" aCol="%s" im0="folder.png" ' \
1041
      'im1="folder_open.png" im2="folder.png">'%(item.name,
1042
item.full_path.replace(working_copy, ''), itemColor,) + os.linesep
1043
      for it in item.sub_dirs:
1044
        ident += 1
1045
        output = self._treeToXML(item.getDir(it.name), working_copy, output, ident,
Christophe Dumez's avatar
Christophe Dumez committed
1046
first)
1047 1048
        ident -= 1
      for i in range(ident) :
1049 1050
        output += '\t'
      output += '</item>' + os.linesep
1051 1052
    else :
      for i in range(ident) :
1053 1054
        output += '\t'
      output += '<item text="%s" id="%s" aCol="%s" im0="document.png"/>'\
1055
                %(item.name, item.full_path.replace(working_copy, ''), itemColor,) + os.linesep
1056
    return output
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1057 1058
    
InitializeClass(SubversionTool)