# -*- coding: utf-8 -*- ############################################################################## # # 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 Acquisition import Implicit import time import os import sys from DateTime import DateTime from Products.ERP5Type.Utils import convertToUpperCase from MethodObject import Method from Products.ERP5Type.Globals import InitializeClass from Products.ERP5Type.TransactionalVariable import getTransactionalVariable from AccessControl import ClassSecurityInfo from AccessControl.SecurityInfo import ModuleSecurityInfo from Products.PythonScripts.Utility import allow_class from tempfile import mkdtemp import shutil class getTransactionalDirectory(str): """Returns a temporary directory that is automatically deleted when transaction ends """ def __new__(cls, tv_key): tv = getTransactionalVariable() try: return str(tv[tv_key]) except KeyError: path = mkdtemp() tv[tv_key] = str.__new__(cls, path) return path def __del__(self): shutil.rmtree(str(self)) class SubversionError(Exception): """The base exception class for the Subversion interface. """ pass class SubversionInstallationError(SubversionError): """Raised when an installation is broken. """ pass class SubversionTimeoutError(SubversionError): """Raised when a Subversion transaction is too long. """ pass class SubversionLoginError(SubversionError): """Raised when an authentication is required. """ # Declarative Security security = ClassSecurityInfo() def __init__(self, realm = None): self._realm = realm security.declarePublic('getRealm') def getRealm(self): return self._realm InitializeClass(SubversionLoginError) ModuleSecurityInfo(__name__).declarePublic('SubversionLoginError') class SubversionSSLTrustError(SubversionError): """Raised when a SSL certificate is not trusted. """ # Declarative Security security = ClassSecurityInfo() def __init__(self, trust_dict = None): self._trust_dict = trust_dict security.declarePublic('getTrustDict') def getTrustDict(self): return self._trust_dict InitializeClass(SubversionSSLTrustError) ModuleSecurityInfo(__name__).declarePublic('SubversionSSLTrustError') try: import pysvn class Callback: """The base class for callback functions. """ def __init__(self, client): self.client = client def __call__(self, *args): pass class CancelCallback(Callback): def __call__(self): current_time = time.time() if current_time - self.client.creation_time > self.client.getTimeout(): raise SubversionTimeoutError, 'too long transaction' #return True return False class GetLogMessageCallback(Callback): def __call__(self): message = self.client.getLogMessage() if message: return True, message return False, '' class GetLoginCallback(Callback): def __call__(self, realm, username, may_save): user, password = self.client.getLogin(realm) if not username or not password: self.client.setException(SubversionLoginError(realm)) return False, '', '', False # BBB. support older versions of pysvn <= 1.6.3 if isinstance(user, unicode): user = user.encode('utf-8') if isinstance(password, unicode): password = password.encode('utf-8') return True, user, password, False class NotifyCallback(Callback): def __call__(self, event_dict): # FIXME: should accumulate information for the user pass class SSLServerTrustPromptCallback(Callback): def __call__(self, trust_dict): if not self.client.trustSSLServer(trust_dict): self.client.setException(SubversionSSLTrustError(trust_dict)) return False, 0, False # XXX SSL server certificate failure bits are not defined in pysvn. # 0x8 means that the CA is unknown. return True, 0x8, False class SSLServerPromptCallback(Callback): def __call__(self): return class SSLClientCertPromptCallback(Callback): def __call__(self): return class SSLClientCertPasswordPromptCallback(Callback): def __call__(self): return # Wrap objects defined in pysvn so that skins # have access to attributes in the ERP5 way. class Getter(Method): def __init__(self, key): self._key = key def __call__(self, instance): value = getattr(instance._obj, self._key) if type(value) == type(u''): value = value.encode('utf-8') #elif isinstance(value, pysvn.Entry): elif str(type(value)) == "<type 'entry'>": value = Entry(value) #elif isinstance(value, pysvn.Revision): elif str(type(value)) == "<type 'revision'>": value = Revision(value) return value def initializeAccessors(klass): klass.security = ClassSecurityInfo() klass.security.declareObjectPublic() for attr in klass.attribute_list: name = 'get' + convertToUpperCase(attr) setattr(klass, name, Getter(attr)) klass.security.declarePublic(name) InitializeClass(klass) class ObjectWrapper(Implicit): attribute_list = () def __init__(self, obj): self._obj = obj class Status(ObjectWrapper): # XXX Big Hack to fix a bug __allow_access_to_unprotected_subobjects__ = 1 attribute_list = ('path', 'entry', 'is_versioned', 'is_locked', \ 'is_copied', 'is_switched', 'prop_status', 'text_status', \ 'repos_prop_status', 'repos_text_status') initializeAccessors(Status) class Entry(ObjectWrapper): attribute_list = ('checksum', 'commit_author', 'commit_revision', \ 'commit_time', 'conflict_new', 'conflict_old', 'conflict_work', \ 'copy_from_revision', 'copy_from_url', 'is_absent', 'is_copied', \ 'is_deleted', 'is_valid', 'kind', 'name', 'properties_time', \ 'property_reject_file', 'repos', 'revision', 'schedule', \ 'text_time', 'url', 'uuid') class Revision(ObjectWrapper): attribute_list = ('kind', 'date', 'number') initializeAccessors(Revision) class SubversionClient(Implicit): """This class wraps pysvn's Client class. """ log_message = None timeout = 60 * 5 def __init__(self, container, **kw): self.client = pysvn.Client() self.client.set_auth_cache(0) obj = self.__of__(container) self.client.exception_style = 1 self.client.callback_cancel = CancelCallback(obj) self.client.callback_get_log_message = GetLogMessageCallback(obj) self.client.callback_get_login = GetLoginCallback(obj) self.client.callback_notify = NotifyCallback(obj) self.client.callback_ssl_server_trust_prompt = \ SSLServerTrustPromptCallback(obj) self.client.callback_ssl_server_prompt = SSLServerPromptCallback(obj) self.client.callback_ssl_client_cert_prompt = SSLClientCertPromptCallback(obj) self.client.callback_ssl_client_cert_password_prompt = SSLClientCertPasswordPromptCallback(obj) self.creation_time = time.time() self.__dict__.update(kw) self.exception = None def getLogMessage(self): return self.log_message def getLogin(self, realm): return self.aq_parent._getLogin(realm) def getTimeout(self): return self.timeout def trustSSLServer(self, trust_dict): return self.aq_parent._trustSSLServer(trust_dict) def setException(self, exc): self.exception = exc def getException(self): return self.exception def checkin(self, path, log_message, recurse): try: return Revision(self.client.checkin(path, log_message=log_message or 'none', recurse=recurse)) except pysvn.ClientError, error: excep = self.getException() if excep: raise excep else: raise error def update(self, path): try: return [Revision(x) for x in self.client.update(path)] except pysvn.ClientError, error: excep = self.getException() if excep: raise excep else: raise error def status(self, path, **kw): # Since plain Python classes are not convenient in # Zope, convert the objects. try: status_list = [Status(x) for x in self.client.status(path=path, **kw)] except pysvn.ClientError, error: excep = self.getException() if excep: raise excep else: raise error # XXX: seems that pysvn return a list that is # upside-down, we reverse it... status_list.reverse() return status_list def diff(self, path, revision1=None, revision2=None): tmp_path = getTransactionalDirectory('SubversionClient.diff:tmp_dir') if revision1 and revision2: return self.client.diff(tmp_path, url_or_path=path, recurse=False, revision1=pysvn.Revision(pysvn.opt_revision_kind.number,revision1), revision2=pysvn.Revision(pysvn.opt_revision_kind.number,revision2)) else: return self.client.diff(tmp_path, url_or_path=path, recurse=False) def revert(self, path, recurse=False): return self.client.revert(path, recurse) def switch(self, path, url): return self.client.switch(path=path, url=url) def checkout(self, path, url): return self.client.checkout(path, url) def export(self, path, url): return self.client.export(path, url) def log(self, path): try: log_list = self.client.log(path) except pysvn.ClientError, error: if 'path not found' in error.args[0]: return excep = self.getException() if excep: raise excep else: raise error # Edit list to make it more usable in zope revision_log_list = [] for rev_dict in log_list: rev_log_dict = {} rev_log_dict['message'] = rev_dict.message rev_log_dict['author'] = rev_dict.author rev_log_dict['revision'] = rev_dict['revision'].number rev_log_dict['date'] = DateTime(rev_dict['date']) revision_log_list.append(rev_log_dict) return revision_log_list def add(self, path): self.client.add(path=path, force=True) def resolved(self, path): return self.client.resolved(path=path) def info(self, path): if not os.path.exists(path): raise ValueError, "Repository %s does not exist" % path # symlinks are not well supported by pysvn if os.path.islink(path): path = os.path.realpath(path) try: entry = self.client.info(path=path) except pysvn.ClientError, error: excep = self.getException() if excep: raise excep else: raise error if entry is None: raise ValueError, "Could not open SVN repository %s" % path # transform entry to dict to make it more usable in zope members_tuple = ('url', 'uuid', 'revision', 'kind', \ 'commit_author', 'commit_revision', 'commit_time',) entry_dict = dict([(member, getattr(entry, member)) \ for member in members_tuple]) entry_dict['revision'] = entry_dict['revision'].number entry_dict['commit_revision'] = entry_dict['commit_revision'].number entry_dict['commit_time'] = DateTime(entry_dict['commit_time']) return entry_dict def ls(self, path): try: dict_list = self.client.ls(url_or_path=path, recurse=False) except pysvn.ClientError, error: if 'non-existent' in error.args[0]: return excep = self.getException() if excep: raise excep else: raise error #Modify the list to make it more usable in zope for dictionary in dict_list: dictionary['created_rev'] = dictionary['created_rev'].number dictionary['time'] = DateTime(dictionary['time']) return dict_list def cleanup(self, path): return self.client.cleanup(path=path) def remove(self, path): self.client.remove(url_or_path=path, force=True) def cat(self, *args, **kw): return self.client.cat(*args, **kw) def newSubversionClient(container, **kw): return SubversionClient(container, **kw).__of__(container) except ImportError: from zLOG import LOG, WARNING LOG('Subversion', WARNING, 'could not import pysvn; until pysvn is installed properly,' ' this tool will not work.', error=sys.exc_info()) def newSubversionClient(container, **kw): raise SubversionInstallationError, 'pysvn library is not installed'