SubversionTool.py

##############################################################################
#
# Copyright (c) 2005 Nexedi SARL and Contributors. All Rights Reserved.
#                    Yoshinori Okuji <yo@nexedi.com>
#                    Christophe Dumez <christophe@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from Products.CMFCore.utils import UniqueObject
from Products.ERP5Type.Tool.BaseTool import BaseTool
from AccessControl import ClassSecurityInfo
from Products.ERP5Type.Globals import InitializeClass, DTMLFile
from Products.ERP5Type.Core.Folder import Folder
from Products.ERP5Type import Permissions
from Products.ERP5Subversion import _dtmldir
from Products.ERP5Type.DiffUtils import DiffFile
from Products.ERP5Subversion.SubversionClient import newSubversionClient
import os, re
from DateTime import DateTime
from cPickle import dumps, loads
from App.config import getConfiguration
from tempfile import gettempdir, mkdtemp
from Products.CMFCore.utils import getToolByName
import shutil
from xml.sax.saxutils import escape
from dircache import listdir
from OFS.Traversable import NotFound
import transaction

try:
  import pysvn
except ImportError:
  pysvn = None

from base64 import b64encode, b64decode
from warnings import warn

NBSP = '&nbsp;'
NBSP_TAB = NBSP*8

class File(object):
  """ Class that represents a file in memory
  """
  __slots__ = ('status','name')
  # Constructor
  def __init__(self, name, status) :
    self.status = status
    self.name = name
## End of File Class

class Dir(object):
  """ Class that reprensents a folder in memory
  """
  __slots__ = ('status', 'name', 'sub_dirs', 'sub_files')
  # Constructor
  def __init__(self, name, status) :
    self.status = status
    self.name = name
    self.sub_dirs = [] # list of sub directories
    self.sub_files = [] # list of sub files

  def getSubDirsNameList(self) :
    """ return a list of sub directories' names
    """
    return [d.name for d in self.sub_dirs]

  def getDirFromName(self, name):
    """ return directory in subdirs given its name
    """
    for directory in self.sub_dirs:
      if directory.name == name:
        return directory
      
  def getObjectFromName(self, name):
    """ return dir object given its name
    """
    for directory in self.sub_dirs:
      if directory.name == name:
        return directory
    for sub_file in self.sub_files:
      if sub_file.name == name:
        return sub_file
      
  def getContent(self):
    """ return content for directory
    """
    content = self.sub_dirs
    content.extend(self.sub_files)
    return content
## End of Dir Class

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

class SubversionNotAWorkingCopyError(Exception):
  """The base exception class when directory is not a working copy
  """
  pass

class SubversionConflictError(Exception):
  """The base exception class when there is a conflict
  """
  pass

class SubversionSecurityError(Exception): pass

class SubversionBusinessTemplateNotInstalled(Exception):
  """ Exception called when the business template is not installed
  """
  pass

class UnauthorizedAccessToPath(Exception):
  """ When path is not in zope home instance
  """
  pass

    
def colorizeTag(tag):
  "Return html colored item"
  text = tag.group()
  if text.startswith('#') :
    color = 'grey'
  elif text.startswith('\"') :
    color = 'red'
  elif 'string' in text:
    color = 'green'
  elif 'tuple' in text:
    color = 'orange'
  elif 'dictionary' in text:
    color = 'brown'
  elif 'item' in text:
    color = '#a1559a' #light purple
  elif 'value' in text:
    color = 'purple'
  elif 'key' in text:
    color = '#0c4f0c'#dark green
  else:
    color = 'blue'
  return "<span style='color: %s'>%s</span>" % (color, text, )
    
def colorize(text):
  """Return HTML Code with syntax hightlighting
  """
  # Escape xml before adding html tags
  html = escape(text)
  html = html.replace(' ', NBSP)
  html = html.replace('\t', NBSP_TAB)
  # Colorize comments
  pattern = re.compile(r'#.*')
  html = pattern.sub(colorizeTag, html)
  # Colorize tags
  pattern = re.compile(r'&lt;.*?&gt;')
  html = pattern.sub(colorizeTag, html)
  # Colorize strings
  pattern = re.compile(r'\".*?\"')
  html = pattern.sub(colorizeTag, html)
  html = html.replace(os.linesep, os.linesep+"<br/>")
  return html

class SubversionTool(BaseTool):
  """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 = getConfiguration().instancehome
  
  # Declarative Security
  security = ClassSecurityInfo()

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

  # path is the path in svn working copy
  # return edit_path in zodb to edit it
  # return '#' if no zodb path is found
  def editPath(self, business_template, path):
    """Return path to edit file
       path can be relative or absolute
    """
    path = self.relativeToAbsolute(path, business_template).replace('\\', '/')
    if 'bt' in path.split('/'):
      # not in zodb
      return '#'
    # if file have been deleted then not in zodb
    if not os.path.exists(path):
      return '#'
    svn_path = self.getSubversionPath(business_template).replace('\\', '/')
    edit_path = path.replace(svn_path, '').strip()
    if edit_path == '':
      # not in zodb 
      return '#'
    if edit_path[0] == '/':
      edit_path = edit_path[1:]
    edit_path = '/'.join(edit_path.split('/')[1:]).strip()
    if edit_path == '':
      # not in zodb 
      return '#'
    # remove file extension
    edit_path = os.path.splitext(edit_path)[0]
    # Add beginning and end of url
    edit_path = os.path.join(business_template.REQUEST["BASE2"], \
    edit_path, 'manage_main')
    return edit_path
    
  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))
  
  def goToWorkingCopy(self, business_template):
    """ Change to business template directory
    """
    working_path = self.getSubversionPath(business_template)
    os.chdir(working_path)
    
  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)
    expires = (DateTime() + 1).toZone('GMT').rfc822()
    request.set(self.login_cookie_name, value)
    response.setCookie(self.login_cookie_name, value, path = '/', \
    expires = expires)

  def _getLogin(self, target_realm):
    request = self.REQUEST
    cookie = request.get(self.login_cookie_name)
    if cookie:
      for login in cookie.split(','):
        realm, user, password = self._decodeLogin(login)
        if target_realm == realm:
          return user, password
    return None, None
      
  def getHeader(self, business_template, file_path):
    file_path = self._getWorkingPath(self.relativeToAbsolute(file_path, business_template))
    header = '<a style="font-weight: bold" href="BusinessTemplate_viewSvnShowFile?file=' + \
    file_path + '">' + file_path + '</a>'
    edit_path = self.editPath(business_template, file_path)
    if edit_path != '#':
      header += '&nbsp;&nbsp;<a href="'+self.editPath(business_template, \
      file_path) + '"><img src="imgs/edit.png" style="border: 0" alt="edit" /></a>'
    return header

  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.
    trust_item_list, permanent = loads(b64decode(trust))
    return dict(trust_item_list), permanent
  
  def getPreferredUsername(self):
    """return username in preferences if set of the current username
    """
    username = self.getPortalObject().portal_preferences\
    .getPreferredSubversionUserName()
    if username is None or username.strip() == "":
      # not set in preferences, then we get the current username in zope
      username = self.portal_membership.getAuthenticatedMember().getUserName()
    return username
  
  def diffHTML(self, file_path, business_template, revision1=None, \
  revision2=None):
    """ Return HTML diff
    """
    raw_diff = self.diff(file_path, business_template, revision1, revision2)
    return DiffFile(raw_diff).toHTML()
  
  def fileHTML(self, business_template, file_path):
    """ Display a file content in HTML with syntax highlighting
    """
    file_path = self._getWorkingPath(self.relativeToAbsolute(file_path, business_template))
    if os.path.exists(file_path):
      if os.path.isdir(file_path):
        text = "<span style='font-weight: bold; color: black;'>"+file_path+"</span><hr/>"
        text += file_path +" is a folder!"
      else:
        input_file = open(file_path, 'rU')
        head = "<span style='font-weight: bold; color: black;'>"+file_path+'</span>  <a href="' + \
        self.editPath(business_template, file_path) + \
        '"><img src="ERP5Subversion_imgs/edit.png" style="border: 0" alt="edit" /></a><hr/>'
        text = head + colorize(input_file.read())
        input_file.close()
    else:
      # see if tmp file is here (svn deleted file)
      if file_path[-1] == os.sep:
        file_path = file_path[:-1]
      filename = file_path.split(os.sep)[-1]
      tmp_path = os.sep.join(file_path.split(os.sep)[:-1])
      tmp_path = os.path.join(tmp_path, '.svn', 'text-base', \
      filename+'.svn-base')
      if os.path.exists(tmp_path):
        input_file = open(tmp_path, 'rU')
        head = "<span style='font-weight: bold'>"+tmp_path+"</span> (svn temporary file)<hr/>"
        text = head + colorize(input_file.read())
        input_file.close()
      else : # does not exist
        text = "<span style='font-weight: bold'>"+file_path+"</span><hr/>"
        text += file_path +" does not exist!"
    return text
      
  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:
      trust_list.append(cookie)
    # Set the cookie.
    response = request.RESPONSE
    trust_list.append(self._encodeSSLTrust(trust_dict, permanent))
    value = ','.join(trust_list)
    expires = (DateTime() + 1).toZone('GMT').rfc822()
    request.set(self.ssl_trust_cookie_name, value)
    response.setCookie(self.ssl_trust_cookie_name, value, path = '/', \
    expires = expires)
    
  def acceptSSLPerm(self, trust_dict):
    """ Accept SSL server permanently
    """
    self.acceptSSLServer(self, trust_dict, True)

  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)
  
  security.declareProtected('Import/Export objects', 'createSubversionPath')
  def createSubversionPath(self, working_copy, business_template):
    """
     create the working copy path corresponding to the given business
     template, checking it is in the working copy list in preferences
    """
    bt_name = business_template.getTitle()
    assert bt_name == os.path.basename(bt_name), 'Invalid bt_name'
    working_copy = self._getWorkingPath(working_copy)
    wc_path = os.path.join(working_copy, bt_name)
    os.mkdir(wc_path)
    client = self._getClient()
    client.add([wc_path])

  security.declareProtected('Import/Export objects', 'getSubversionPath')
  def getSubversionPath(self, business_template, 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)
     
     with_name : with business template name at the end of the path
    """
    wc_list = self.getPortalObject().portal_preferences\
    .getPreferredSubversionWorkingCopyList()
    if not wc_list or len(wc_list) == 0 :
      raise SubversionPreferencesError, \
      'Please set at least one Subversion Working Copy in preferences first.'
    bt_name = business_template.getTitle()
    for working_copy in wc_list:
      working_copy = self._getWorkingPath(working_copy)
      if bt_name in listdir(working_copy) :
        wc_path = os.path.join(working_copy, 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])
    raise SubversionUnknownBusinessTemplateError, \
        "Could not find '%s' at first level of working copies." % (bt_name, )

  def _getWorkingPath(self, path):
    """ Check if the given path is reachable (allowed)
    """
    real_path = os.path.abspath(path)
    if not real_path.startswith(self.top_working_path) and \
        not real_path.startswith(gettempdir()):
      raise UnauthorizedAccessToPath, 'Unauthorized access to path %s.' \
          'It is NOT in your Zope home instance.' % real_path
    return real_path
    
  security.declareProtected('Import/Export objects', 'update')
  def update(self, business_template):
    """
     Update a working copy / business template, 
     reverting all local changes
    """
    path = self._getWorkingPath(self.getSubversionPath(business_template))
    # First remove unversioned in working copy that could conflict
    self.removeAllInList([x['uid'] for x in self.unversionedFiles(path)])
    client = self._getClient()
    # Revert local changes in working copy first
    # to import a "pure" BT after update
    self.revert(path=path, recurse=True)
    # removed unversioned files due to former added files that were reverted
    self.removeAllInList([x['uid'] for x in self.unversionedFiles(path)])
    # Update from SVN
    client.update(path)
    # Import in zodb
    return self.importBT(business_template)
  
  security.declareProtected('Import/Export objects', 'updateKeep')
  def updateKeep(self, business_template):
    """
     Update a working copy / business template, 
     keeping all local changes (appart from revision)
    """
    path = self._getWorkingPath(self.getSubversionPath(business_template))
    client = self._getClient()
    # Revert revision file so that it does not conflict
    revision_path = os.path.join(path, 'bt', 'revision')
    if os.path.exists(revision_path):
      self.revert(path=revision_path, recurse=False)
    # remove unversioned files in working copy that could be annoying
    self.removeAllInList([x['uid'] for x in self.unversionedFiles(path)])
    # Update from SVN
    client.update(path)
    # Check if some files are conflicted to raise an exception
    conflicted_list = self.conflictedFiles(self.getSubversionPath(business_template))
    if len(conflicted_list) != 0:
      raise SubversionConflictError, 'The following files conflicts (%s), please resolve manually.' % repr(conflicted_list)
    # Import in zodb
    return self.importBT(business_template)

  security.declareProtected('Import/Export objects', 'switch')
  def switch(self, business_template, url):
    """switch SVN repository for a working copy.
    """
    path = self._getWorkingPath(self.getSubversionPath(business_template))
    client = self._getClient()
    if url[-1] == '/' :
      url = url[:-1]
    # Update from SVN
    client.switch(path=path, url=url)

  security.declareProtected('Import/Export objects', 'checkout')
  def checkout(self, business_template, url):
    """ Checkout business configuration from SVN into 
        the first Preferres Subversion Working Copy.
    """
    wc_list = self.getPortalObject().portal_preferences\
    .getPreferredSubversionWorkingCopyList()
    if not wc_list or len(wc_list) == 0 :
      raise SubversionPreferencesError, \
      'Please set at least one Subversion Working Copy in preferences first.'
    bt_name = business_template.getTitle()
    wc_path = os.path.join(wc_list[0], bt_name)
    path = self._getWorkingPath(wc_path)
    client = self._getClient()
    if url[-1] != '/' :
      url += '/' 
    url += bt_name
    client.checkout(path=path, url=url)

  security.declareProtected('Import/Export objects', 'add')
  # path can be a list or not (relative or absolute)
  def add(self, path, business_template=None):
    """Add a file or a directory.
    """
    if business_template is not None:
      if isinstance(path, list) :
        path = [self._getWorkingPath(self.relativeToAbsolute(x, \
        business_template)) for x in path]
      else:
        path = self._getWorkingPath(self.relativeToAbsolute(path, \
        business_template))
    client = self._getClient()
    return client.add(path)

  security.declareProtected('Import/Export objects', 'info')
  def info(self, business_template):
    """return info of working copy
    """
    working_copy = self._getWorkingPath(self\
    .getSubversionPath(business_template))
    client = self._getClient()
    return client.info(working_copy)
  
  security.declareProtected('Import/Export objects', 'log')
  # path can be absolute or relative
  def log(self, path, business_template):
    """return log of a file or dir
    """
    client = self._getClient()
    return client.log(self._getWorkingPath(self\
    .relativeToAbsolute(path, business_template)))
  
  security.declareProtected('Import/Export objects', 'cleanup')
  def cleanup(self, business_template):
    """remove svn locks in working copy
    """
    working_copy = self._getWorkingPath(self\
    .getSubversionPath(business_template))
    client = self._getClient()
    return client.cleanup(working_copy)

  security.declareProtected('Import/Export objects', 'remove')
  # path can be a list or not (relative or absolute)
  def remove(self, path, business_template=None):
    """Remove a file or a directory.
    """
    if business_template is not None:
      if isinstance(path, list) :
        path = [self._getWorkingPath(self\
        .relativeToAbsolute(x, business_template)) for x in path]
      else:
        path = self._getWorkingPath(self.relativeToAbsolute(path, \
        business_template))
    client = self._getClient()
    return client.remove(path)

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

  security.declareProtected('Import/Export objects', 'ls')
  # path can be relative or absolute
  def ls(self, path, business_template):
    """Display infos about a file.
    """
    client = self._getClient()
    return client.ls(self._getWorkingPath(self\
    .relativeToAbsolute(path, business_template)))

  security.declareProtected('Import/Export objects', 'diff')
  # path can be relative or absolute
  def diff(self, path, business_template, revision1=None, revision2=None):
    """Make a diff for a file or a directory.
    """
    client = self._getClient()
    return client.diff(self._getWorkingPath(self.relativeToAbsolute(path, \
    business_template)), revision1, revision2)
  
  security.declareProtected('Import/Export objects', 'revert')
  # path can be absolute or relative
  def revert(self, path, business_template=None,
                   recurse=False, exclude_list=()):
    """Revert local changes in a file or a directory.
    """
    client = self._getClient()
    if isinstance(path, basestring):
      path = [path]
    if business_template is not None:
      path = [self._getWorkingPath(self.relativeToAbsolute(x,
        business_template)) for x in path]
    if recurse and exclude_list:
      exclude_list = frozenset(self._getWorkingPath(self.relativeToAbsolute(x,
        business_template)) for x in exclude_list)
      added_set = set()
      other_list = []
      for path in path:
        for status in client.status(path):
          path = status.getPath()
          if path not in exclude_list:
            status = str(status.getTextStatus())
            if status == 'added':
              added_set.add(path)
            elif status != 'normal':
              other_list.append(path)
      client.revert(other_list, False)
      path = [x for x in added_set if os.path.dirname(x) not in added_set]
    client.revert(path, recurse)

  security.declareProtected('Import/Export objects', 'revertZODB')
  # path can be absolute or relative
  def revertZODB(self,
      business_template,
      added_file_list=None,
      other_file_list=None,
      recurse=False,
      # deprecated:
      added_files=None,
      other_files=None,
      ):
    """Revert local changes in a file or a directory
       in ZODB and on hard drive
    """
    if added_files is not None:
      warn('Parameter added_files is deprecated, used added_file_list ' \
           'instead.', DeprecationWarning)
      added_file_list = added_files
    if other_files is not None:
      warn('Parameter other_files is deprecated, used other_file_list ' \
           'instead.', DeprecationWarning)
      other_file_list = other_files

    client = self._getClient()
    object_to_update = {}
    # Transform params to list if they are not already lists
    if not added_file_list:
      added_file_list = []
    if not other_file_list:
      other_file_list = []
    if not isinstance(added_file_list, list) :
      added_file_list = [added_file_list]
    if not isinstance(other_file_list, list) :
      other_file_list = [other_file_list]
      
    # Reinstall removed or modified files
    for path in other_file_list :
      # security check
      self._getWorkingPath(self.relativeToAbsolute(path, business_template))
      path_list = path.split(os.sep)
      if 'bt' not in path_list:
        if len(path_list) > 2 :
          tmp = os.sep.join(path_list[2:])
          # Remove file extension
          tmp = os.path.splitext(tmp)[0]
          object_to_update[tmp] = 'install'
    path_added_list = []
    # remove added files
    for path in added_file_list :
      # security check
      self._getWorkingPath(self.relativeToAbsolute(path, business_template))
      path_list = path.split(os.sep)
      if 'bt' not in path_list:
        if len(path_list) > 2 :
          tmp = os.sep.join(path_list[2:])
          # Remove file extension
          tmp = os.path.splitext(tmp)[0]
          path_added_list.append(tmp)
    ## hack to remove objects
    # Create a temporary bt with objects to delete
    tmp_bt = getToolByName(business_template.getPortalObject(), '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
    business_template.portal_templates.manage_delObjects(ids=tmp_bt.getId())
    #revert changes
    added_file_list.extend(other_file_list)
    to_revert = [self.relativeToAbsolute(x, business_template) \
    for x in added_file_list]
    if len(to_revert) != 0 :
      client.revert(to_revert, recurse)
      # Partially reinstall installed bt
      installed_bt = business_template.portal_templates\
      .getInstalledBusinessTemplate(business_template.getTitle())
      if installed_bt is None:
        raise SubversionBusinessTemplateNotInstalled, "Revert won't work if the business template is not installed. Please install it first."
      installed_bt.reinstall(object_to_update=object_to_update, force=0)
    
  security.declareProtected('Import/Export objects', 'resolved')
  # path can be absolute or relative
  def resolved(self, path, business_template):
    """remove conflicted status
    """
    client = self._getClient()
    if isinstance(path, list) :
      path = [self._getWorkingPath(self.relativeToAbsolute(x, \
      business_template)) for x in path]
    else:
      path = self._getWorkingPath(self.relativeToAbsolute(path, \
      business_template))
    return client.resolved(path)

  def relativeToAbsolute(self, path, business_template):
    """ Return an absolute path given the absolute one
        and the business template
    """
    if path[0] == os.sep:
      # already absolute
      return path
    # relative path
    if path.split(os.sep)[0] == business_template.getTitle():
      return os.path.join(self.getSubversionPath(business_template, \
      False), path)
    else:
      return os.path.join(self.getSubversionPath(business_template), path)

  security.declareProtected('Import/Export objects', 'checkin')
  # path can be relative or absolute (can be a list of paths too)
  def checkin(self, path, business_template, log_message=None, recurse=True):
    """Commit local changes.
    """
    if isinstance(path, list) :
      path = [self._getWorkingPath(self.relativeToAbsolute(x, \
      business_template)) for x in path]
    else:
      path = self._getWorkingPath(self.relativeToAbsolute(path, \
      business_template))
    client = self._getClient()
    # Pysvn wants unicode objects
    if isinstance(log_message, str):
      log_message = log_message.decode('utf8')
    return client.checkin(path, log_message, recurse)

  security.declareProtected('Import/Export objects', 'getLastChangelog')
  def getLastChangelog(self, business_template):
    """Return last changelog of a business template
    """
    bt_path = self._getWorkingPath(self.getSubversionPath(business_template))
    changelog_path = bt_path + os.sep + 'bt' + os.sep + 'change_log'
    changelog = ""
    if os.path.exists(changelog_path):
      changelog_file = open(changelog_path, 'r')
      changelog_lines = changelog_file.readlines()
      changelog_file.close()
      for line in changelog_lines:
        if line.strip() == '':
          break
        changelog += line
    return changelog
    

  security.declareProtected('Import/Export objects', 'status')
  def status(self, path, **kw):
    """Get status.
    """
    client = self._getClient()
    return client.status(self._getWorkingPath(path), **kw)
  
  security.declareProtected('Import/Export objects', 'unversionedFiles')
  def unversionedFiles(self, path, **kw):
    """Return unversioned files
    """
    client = self._getClient()
    status_list = client.status(self._getWorkingPath(path), **kw)
    unversioned_list = []
    for status_obj in status_list:
      if str(status_obj.getTextStatus()) == "unversioned":
        my_dict = {}
        my_dict['uid'] = status_obj.getPath()
        unversioned_list.append(my_dict)
    return unversioned_list
      
  security.declareProtected('Import/Export objects', 'conflictedFiles')
  def conflictedFiles(self, path, **kw):
    """Return unversioned files
    """
    client = self._getClient()
    status_list = client.status(self._getWorkingPath(path), **kw)
    conflicted_list = []
    for status_obj in status_list:
      if str(status_obj.getTextStatus()) == "conflicted":
        my_dict = {}
        my_dict['uid'] = status_obj.getPath()
        conflicted_list.append(my_dict)
    return conflicted_list

  security.declareProtected('Import/Export objects', 'removeAllInList')
  def removeAllInList(self, path_list, REQUEST=None):
    """Remove all files and folders in list
    """
    if REQUEST is not None:
      # Security hole fix
      raise SubversionSecurityError, 'You are not allowed to delete these files'
    for file_path in path_list:
      real_path = self._getWorkingPath(file_path)
      if os.path.isdir(real_path):
        shutil.rmtree(real_path)
      elif os.path.isfile(real_path):
        os.remove(real_path)
    
  def getModifiedTree(self, business_template, show_unmodified=False) :
    """ Return tree of files returned by svn status
    """
    # Get subversion path without business template name at the end
    bt_path = self._getWorkingPath(self.getSubversionPath(business_template, \
    False))
    if bt_path[-1] != os.sep:
      bt_path += os.sep
    # Business template root directory is the root of the tree
    root = Dir(business_template.getTitle(), "normal")
    something_modified = False
    template_tool = self.getPortalObject().portal_templates
    if template_tool.getDiffFilterScriptList():
      client_diff = self._getClient().diff
      def hasDiff(path):
        return template_tool.getFilteredDiff(client_diff(path, None, None))
    else:
      def hasDiff(path):
        return True
    statusObj_list = self.status(os.path.join(bt_path, \
    business_template.getTitle()), update=False)
    # We browse the files returned by svn status
    for status_obj in statusObj_list :
      # can be (normal, added, modified, deleted, conflicted, unversioned)
      if str(status_obj.getReposTextStatus()) != 'none':
        status = "outdated"
      else:
        status = str(status_obj.getTextStatus())
        if status == "unversioned" or \
           status == "normal" and not show_unmodified:
          continue
      full_path = status_obj.getPath()
      if status != "modified" or hasDiff(full_path):
        something_modified = True
        # Get object path
        relative_path = full_path.replace(bt_path, '')
        filename = os.path.basename(relative_path)

        # Always start from root
        parent = root
        
        # First we add the directories present in the path to the tree
        # if it does not already exist
        for directory in relative_path.split(os.sep)[1:-1] :
          if directory :
            if directory not in parent.getSubDirsNameList() :
              parent.sub_dirs.append(Dir(directory, "normal"))
            parent = parent.getDirFromName(directory)
        
        # Consider the whole path which can be a folder or a file
        # We add it the to the tree if it does not already exist
        if os.path.isdir(full_path) :
          if filename == parent.name :
            parent.status = status
          elif filename not in parent.getSubDirsNameList() :
            # Add new dir to the tree
            parent.sub_dirs.append(Dir(filename, str(status)))
          else :
            # update msg status
            tmp = parent.getDirFromName(filename)
            tmp.status = str(status)
        else :
          # add new file to the tree
          parent.sub_files.append(File(filename, str(status)))
    return something_modified and root

  def extractBT(self, business_template):
    """ 
     Extract business template to hard drive
     and do svn add/del stuff comparing it
     to local working copy
    """
    if business_template.getBuildingState() == 'draft':
      business_template.edit()
    business_template.build()
    svn_path = self._getWorkingPath(self.getSubversionPath(business_template) \
    + os.sep)
    old_cwd = os.getcwd()
    path = mkdtemp()
    try:
      # XXX: Big hack to make export work as expected.
      transaction.commit()
      business_template.export(path=path, local=1)
      self.goToWorkingCopy(business_template)
      self._reimportTree(path)
    finally:
      # Clean up
      shutil.rmtree(path)
      os.chdir(old_cwd)

  def importBT(self, business_template):
    """
     Import business template from local
     working copy
    """
    return business_template.download(self._getWorkingPath(self\
    .getSubversionPath(business_template)))
    
  # Get a list of files and keep only parents
  # Necessary before recursively commit removals
  def cleanChildrenInList(self, path_list):
    """
     Get a list of files and keep only parents
     Necessary before recursively commit removals
    """
    res = path_list
    for path in path_list:
      path = path + '/'
      res = [x for x in res if not x.startswith(path)]
    return res

  def _reimportTree(self, path):
    """Overwrite working copy with the tree pointed to by 'path'

    Current directory must be the destination working copy
    """
    client = self._getClient()
    # Dicts to track svn status in case it is not consistent with existing
    # files and directories
    versioned_dict = dict((x.getPath(), x) for x in client.status('.')
      if str(x.getTextStatus()) not in ('ignored', 'unversioned'))
    del versioned_dict['.']
    added_set = set()

    # Walk current tree
    svn_file_set = set()
    svn_dir_set = set()
    prefix_length = len(os.path.join('.', ''))
    for dirpath, dirnames, filenames in os.walk('.'):
      dirpath = dirpath[prefix_length:]
      for i in xrange(len(dirnames) - 1, -1, -1):
        d = dirnames[i]
        if d[0] == '.':
          # Ignore hidden directories (in particular '.svn')
          del dirnames[i]
        else:
          svn_dir_set.add(os.path.join(dirpath, d))
      for f in filenames:
        svn_file_set.add(os.path.join(dirpath, f))

    # Copy new files/dirs from 'path' to working copy
    # Note: we don't use 'copytree' to avoid excessive disk writes
    prefix_length = len(os.path.join(path, ''))
    for dirpath, dirnames, filenames in os.walk(path):
      dirpath = dirpath[prefix_length:]
      for d in dirnames:
        d = os.path.join(dirpath, d)
        status = versioned_dict.pop(d, None)
        if status is None:
          added_set.add(d)
        elif str(status.getTextStatus()) == 'deleted':
          client.revert(d)
        if d in svn_dir_set:
          svn_dir_set.remove(d)
        else:
          os.mkdir(d)
      for f in filenames:
        f = os.path.join(dirpath, f)
        status = versioned_dict.pop(f, None)
        if status is None:
          added_set.add(f)
        elif str(status.getTextStatus()) == 'deleted':
          client.revert(f)
          svn_file_set.add(f)
        # copy file unless unchanged
        file = open(os.path.join(path, f), 'rb')
        try:
          text = file.read()
        finally:
          file.close()
        try:
          if f in svn_file_set:
            svn_file_set.remove(f)
            file = open(f, 'r+b')
            old_size = os.fstat(file.fileno()).st_size
            if len(text) == old_size and text == file.read():
              continue
            file.seek(0)
          else:
            file = open(f, 'wb')
          file.write(text)
          file.truncate()
        finally:
          file.close()

    # Remove dangling files/dirs
    svn_file_set.difference_update(versioned_dict) # what is in versioned_dict
    svn_dir_set.difference_update(versioned_dict)  #  is removed after
    for x in svn_file_set:
      if os.path.dirname(x) not in svn_dir_set:
        os.remove(x)
    for x in svn_dir_set:
      if os.path.dirname(x) not in svn_dir_set:
        shutil.rmtree(x)

    # Remove deleted files/dirs
    client.remove([x for x in versioned_dict
                     if os.path.dirname(x) not in versioned_dict])
    # Add new files/dirs
    client.add([x for x in added_set
                  if os.path.dirname(x) not in added_set])

  def treeToXML(self, item, business_template) :
    """ Convert tree in memory to XML
    """
    output = '<?xml version="1.0" encoding="UTF-8"?>'+ os.linesep
    output += "<tree id='0'>" + os.linesep
    output = self._treeToXML(item, output, business_template.getTitle(), True)
    output += '</tree>' + os.linesep
    return output
  
  def _treeToXML(self, item, output, relative_path, first) :
    """
     Private function to convert recursively tree 
     in memory to XML
    """
    # Choosing a color coresponding to the status
    status = item.status
    if status == 'added' :
      color = 'green'
    elif status == 'modified' or  status == 'replaced' :
      color = 'orange'
    elif status == 'deleted' :
      color = 'red'
    elif status == 'conflicted' :
      color = 'grey'
    elif status == 'outdated' :
      color = 'purple'
    else :
      color = 'black'
    if isinstance(item, Dir) :
      if first :
        output += '<item open="1" text="%s" id="%s" aCol="%s" '\
        'im0="folder.png" im1="folder_open.png" '\
        'im2="folder.png">'%(item.name, relative_path, color) + os.linesep
        first = False
      else :
        output += '<item text="%s" id="%s" aCol="%s" im0="folder.png" ' \
        'im1="folder_open.png" im2="folder.png">'%(item.name,
        relative_path, color) + os.linesep
      for it in item.getContent():
        output = self._treeToXML(item.getObjectFromName(it.name), output, \
        os.path.join(relative_path,it.name),first)
      output += '</item>' + os.linesep
    else :
      output += '<item text="%s" id="%s" aCol="%s" im0="document.png"/>'\
                %(item.name, relative_path, color) + os.linesep
    return output
    
InitializeClass(SubversionTool)