← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/svn.py

  • Committer: Matt Giuca
  • Date: 2009-12-15 04:44:25 UTC
  • Revision ID: matt.giuca@gmail.com-20091215044425-uxzmdrd89s2d5ax6
doc: Added dev/faq, with some helpful tips on creating certain objects.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/svn.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2008 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
# Module: Subversion utilities
 
19
# Author: William Grant
 
20
# Date:   16/07/2008
 
21
 
 
22
import stat
 
23
 
 
24
import pysvn
 
25
 
 
26
def create_auth_svn_client(username, password):
 
27
    """Create a new pysvn client which is set up to automatically authenticate
 
28
    with the supplied credentials.
 
29
    """
 
30
    username = str(username)
 
31
    password = str(password)
 
32
    def get_login(_realm, existing_login, _may_save):
 
33
        """Callback function used by pysvn for authentication.
 
34
        realm, existing_login, _may_save: The 3 arguments passed by pysvn to
 
35
            callback_get_login.
 
36
            The following has been determined empirically, not from docs:
 
37
            existing_login will be the name of the user who owns the process on
 
38
            the first attempt, "" on subsequent attempts. We use this fact.
 
39
        """
 
40
        # Only provide credentials on the _first_ attempt.
 
41
        # If we're being asked again, then it means the credentials failed for
 
42
        # some reason and we should just fail. (This is not desirable, but it's
 
43
        # better than being asked an infinite number of times).
 
44
        return (existing_login != "", username, password, True)
 
45
 
 
46
    svnclient = pysvn.Client()
 
47
    svnclient.callback_get_login = get_login
 
48
    return svnclient
 
49
 
 
50
def revision_from_string(r_str):
 
51
    if r_str is None:
 
52
        pass
 
53
    elif r_str == "HEAD":
 
54
        return pysvn.Revision( pysvn.opt_revision_kind.head )
 
55
    elif r_str == "WORKING":
 
56
        return pysvn.Revision( pysvn.opt_revision_kind.working )
 
57
    elif r_str == "BASE":
 
58
        return pysvn.Revision( pysvn.opt_revision_kind.base )
 
59
    else:
 
60
        # Is it a number?
 
61
        try:
 
62
            r = int(r_str)
 
63
            return pysvn.Revision( pysvn.opt_revision_kind.number, r)
 
64
        except:
 
65
            pass
 
66
    return None
 
67
 
 
68
def revision_exists(client, path, revision):
 
69
    try:
 
70
        client.list(path, revision=revision)
 
71
        return True
 
72
    except pysvn.ClientError:
 
73
        return False
 
74
 
 
75
def revision_is_dir(client, path, revision):
 
76
    """Returns True if the given path+revision is a directory.
 
77
    @raises a pysvn.ClientError if it does not exist.
 
78
    """
 
79
    # XXX I *think* the first element of the list is the requested object, and
 
80
    # subsequent items are its possible children (so ignore them).
 
81
    list_object, _ = client.list(path, revision=revision)[0]
 
82
    # list_object is a PySvnList object
 
83
    return list_object.kind == pysvn.node_kind.dir
 
84
 
 
85
class PysvnListStatWrapper:
 
86
    '''Wrap a pysvn listing object to look somewhat like a result of
 
87
       os.stat.
 
88
    '''
 
89
    def __init__(self, pysvn_list):
 
90
        self.pysvn_list = pysvn_list
 
91
 
 
92
    def __getattr__(self, name):
 
93
        try:
 
94
            if name == 'st_mode':
 
95
                # Special magic needed.
 
96
                if self.pysvn_list.kind == pysvn.node_kind.dir:
 
97
                    return stat.S_IFDIR
 
98
                else:
 
99
                    return stat.S_IFREG
 
100
                return value
 
101
            return getattr(self.pysvn_list,
 
102
                           {'st_mtime': 'time',
 
103
                            'st_size': 'size',
 
104
                           }[name])
 
105
        except AttributeError, KeyError:
 
106
            raise AttributeError, name