~azzar1/unity/add-show-desktop-key

# IVLE - Informatics Virtual Learning Environment

# Copyright (C) 2008 The University of Melbourne

#

# 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

# Module: Subversion utilities

# Author: William Grant

# Date:   16/07/2008

import stat

import pysvn

def create_auth_svn_client_autopass(username, save_credentials=False):

    """Create a new pysvn client which is set up to automatically authenticate

    with the supplied user. The user's Subversion password is automatically

    looked up in the database.

    (Requires database access -- can't be used inside the jail.)

    @param username: IVLE/Subversion username.

    @param save_credentials: Save the user's credentials. Should be False when

        outside the jail.

    """

    # Note: Must do this inside the function, since this file may be used in

    # the jail, and importing ivle.database crashes in the jail.

    from ivle.config import Config

    import ivle.database

    from ivle.database import User

    store = ivle.database.get_store(Config())

    user = store.find(User, User.login==unicode(username)).one()

    return create_auth_svn_client(username, user.svn_pass, save_credentials)

def create_auth_svn_client(username, password, save_credentials=True):

    """Create a new pysvn client which is set up to automatically authenticate

    with the supplied credentials.

    @param username: IVLE/Subversion username.

    @param password: Subversion password.

    @param save_credentials: Save the user's credentials. Should be False when

        outside the jail.

    """

    username = str(username)

    password = str(password)

    def get_login(_realm, existing_login, _may_save):

        """Callback function used by pysvn for authentication.

        realm, existing_login, _may_save: The 3 arguments passed by pysvn to

            callback_get_login.

            The following has been determined empirically, not from docs:

            existing_login will be the name of the user who owns the process on

            the first attempt, "" on subsequent attempts. We use this fact.

        """

        # Only provide credentials on the _first_ attempt.

        # If we're being asked again, then it means the credentials failed for

        # some reason and we should just fail. (This is not desirable, but it's

        # better than being asked an infinite number of times).

        return (existing_login != "", username, password, save_credentials)

    svnclient = pysvn.Client()

    svnclient.callback_get_login = get_login

    return svnclient

def revision_from_string(r_str):

    if r_str is None:

        pass

    elif r_str == "HEAD":

        return pysvn.Revision( pysvn.opt_revision_kind.head )

    elif r_str == "WORKING":

        return pysvn.Revision( pysvn.opt_revision_kind.working )

    elif r_str == "BASE":

        return pysvn.Revision( pysvn.opt_revision_kind.base )

    else:

        # Is it a number?

        try:

            r = int(r_str)

            return pysvn.Revision( pysvn.opt_revision_kind.number, r)

        except:

            pass

    return None

def revision_exists(client, path, revision):

    try:

        client.list(path, revision=revision)

        return True

    except pysvn.ClientError:

        return False

def revision_is_dir(client, path, revision):

    """Returns True if the given path+revision is a directory.

    @raises a pysvn.ClientError if it does not exist.

    """

    # XXX I *think* the first element of the list is the requested object, and

    # subsequent items are its possible children (so ignore them).

    list_object, _ = client.list(path, revision=revision)[0]

    # list_object is a PySvnList object

    return list_object.kind == pysvn.node_kind.dir

class PysvnListStatWrapper:

    '''Wrap a pysvn listing object to look somewhat like a result of

       os.stat.

    '''

    def __init__(self, pysvn_list):

        self.pysvn_list = pysvn_list

    def __getattr__(self, name):

        try:

            if name == 'st_mode':

                # Special magic needed.

                if self.pysvn_list.kind == pysvn.node_kind.dir:

                    return stat.S_IFDIR

                else:

		    return stat.S_IFREG

                return value

            return getattr(self.pysvn_list,

                           {'st_mtime': 'time',

                            'st_size': 'size',

                           }[name])

        except AttributeError, KeyError:

            raise AttributeError, name