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

52

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

class Error(exceptions.EnvironmentError):
    pass

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

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
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 412
  # 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
413 414 415 416
    
  def setWorkingDirectory(self, path):
    self.workingDirectory = path
    os.chdir(path)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
417 418 419 420 421 422 423 424

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
491 492 493 494 495 496 497 498 499
  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
500 501 502 503 504 505 506 507
      
  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
508 509 510 511 512 513 514 515 516 517

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

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

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

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

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

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

Yoshinori Okuji's avatar
Yoshinori Okuji committed
706
  security.declareProtected('Import/Export objects', 'diff')
707 708
  # path can be relative or absolute
  def diff(self, path, bt, revision1=None, revision2=None):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
709 710 711
    """Make a diff for a file or a directory.
    """
    client = self._getClient()
712
    return client.diff(self.relativeToAbsolute(path, bt), revision1, revision2)
713
  
Yoshinori Okuji's avatar
Yoshinori Okuji committed
714
  security.declareProtected('Import/Export objects', 'revert')
715
  # path can be absolute or relative
716
  def revert(self, path, bt=None, recurse=False):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
717 718 719
    """Revert local changes in a file or a directory.
    """
    client = self._getClient()
720 721
    if not isinstance(path, list) :
      path = [path]
Christophe Dumez's avatar
Christophe Dumez committed
722
    if bt is not None:
723
      path = [self.relativeToAbsolute(x, bt) for x in path]
Christophe Dumez's avatar
Christophe Dumez committed
724
    client.revert(path, recurse)
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 754

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

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

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

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

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

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