← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/fileservice_lib/action.py

  • Committer: William Grant
  • Date: 2009-06-29 03:44:08 UTC
  • mto: This revision was merged to the branch mainline in revision 1322.
  • Revision ID: grantw@unimelb.edu.au-20090629034408-qsb04s1ta1n5zr0y
Document user creation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/fileservice_lib/action.py
91
91
# action=svnupdate: Bring a file up to date with the head revision.
92
92
#       path:   The path to the file to be updated. Only one file may be
93
93
#               specified.
94
 
#       revision: The revision number to update to. If not provided this
95
 
#               defaults to HEAD.
96
94
#
97
95
# action=svnpublish: Set the "published" flag on a file to True.
98
96
#       path:   The path to the file to be published. Can be specified
121
119
#       path:   The path to the directory to be checked (under the IVLE
122
120
#               repository base).
123
121
#
124
 
# action=svncleanup: Recursively clean up the working copy, removing locks,
125
 
#   resuming unfinished operations, etc.
126
 
#       path:   The path to the directory to be cleaned
127
 
#
128
122
# TODO: Implement the following actions:
129
123
#   svnupdate (done?)
130
124
# TODO: Implement ZIP unpacking in putfiles (done?).
144
138
from ivle import (util, studpath, zip)
145
139
from ivle.fileservice_lib.exceptions import WillNotOverwrite
146
140
import ivle.conf
147
 
import ivle.svn
148
 
 
149
 
# Make a Subversion client object (which will log in with this user's
150
 
# credentials, upon request)
151
 
svnclient = ivle.svn.create_auth_svn_client(username=ivle.conf.login,
152
 
                                            password=ivle.conf.svn_pass)
 
141
 
 
142
 
 
143
def get_login(_realm, existing_login, _may_save):
 
144
    """Callback function used by pysvn for authentication.
 
145
    realm, existing_login, _may_save: The 3 arguments passed by pysvn to
 
146
        callback_get_login.
 
147
        The following has been determined empirically, not from docs:
 
148
        existing_login will be the name of the user who owns the process on
 
149
        the first attempt, "" on subsequent attempts. We use this fact.
 
150
    """
 
151
    # Only provide credentials on the _first_ attempt.
 
152
    # If we're being asked again, then it means the credentials failed for
 
153
    # some reason and we should just fail. (This is not desirable, but it's
 
154
    # better than being asked an infinite number of times).
 
155
    return (existing_login != "", str(ivle.conf.login),
 
156
                                  str(ivle.conf.svn_pass), True)
 
157
 
 
158
# Make a Subversion client object
 
159
svnclient = pysvn.Client()
 
160
svnclient.callback_get_login = get_login
153
161
svnclient.exception_style = 0               # Simple (string) exceptions
154
162
 
155
163
DEFAULT_LOGMESSAGE = "No log message supplied."
603
611
def action_svnupdate(req, fields):
604
612
    """Performs a "svn update" to each file specified.
605
613
 
606
 
    Reads fields: 'path' and 'revision'
 
614
    Reads fields: 'path'
607
615
    """
608
616
    path = fields.getfirst('path')
609
 
    revision = fields.getfirst('revision')
610
617
    if path is None:
611
618
        raise ActionError("Required field missing")
612
 
    if revision is None:
613
 
        revision = pysvn.Revision( pysvn.opt_revision_kind.head )
614
 
    else:
615
 
        try:
616
 
            revision = pysvn.Revision(pysvn.opt_revision_kind.number,
617
 
                    int(revision))
618
 
        except ValueError, e:
619
 
            raise ActionError("Bad revision number: '%s'"%revision,)
620
619
    path = actionpath_to_local(req, path)
621
620
 
622
621
    try:
623
 
        svnclient.update(path, recurse=True, revision=revision)
 
622
        svnclient.update(path, recurse=True)
624
623
    except pysvn.ClientError, e:
625
624
        raise ActionError(str(e))
626
625
 
718
717
    url = ivle.conf.svn_addr + "/" + urllib.quote(paths[0])
719
718
    local_path = actionpath_to_local(req, str(paths[1]))
720
719
    try:
 
720
        svnclient.callback_get_login = get_login
721
721
        svnclient.checkout(url, local_path, recurse=True)
722
722
    except pysvn.ClientError, e:
723
723
        raise ActionError(str(e))
729
729
    """
730
730
    path = fields.getfirst('path')
731
731
    logmsg = fields.getfirst('logmsg')
732
 
    url = ivle.conf.svn_addr + "/" + urllib.quote(path)
 
732
    url = ivle.conf.svn_addr + "/" + path
733
733
    try:
 
734
        svnclient.callback_get_login = get_login
734
735
        svnclient.mkdir(url, log_message=logmsg)
735
736
    except pysvn.ClientError, e:
736
737
        raise ActionError(str(e))
743
744
    Reads fields: 'path'
744
745
    """
745
746
    path = fields.getfirst('path')
746
 
    url = ivle.conf.svn_addr + "/" + urllib.quote(path)
 
747
    url = ivle.conf.svn_addr + "/" + path
747
748
    svnclient.exception_style = 1
748
749
 
749
750
    try:
 
751
        svnclient.callback_get_login = get_login
750
752
        info = svnclient.info2(url,
751
753
            revision=pysvn.Revision(pysvn.opt_revision_kind.head))[0][1]
752
754
        return {'svnrevision': info['rev'].number
759
761
            raise util.IVLEError(404, 'The specified repository path does not exist')
760
762
        else:
761
763
            raise ActionError(str(e[0]))
762
 
 
763
 
 
764
 
def action_svncleanup(req, fields):
765
 
    """Recursively clean up the working copy, removing locks, resuming 
766
 
    unfinished operations, etc.
767
 
        path:   The path to be cleaned"""
768
 
 
769
 
    path = fields.getfirst('path')
770
 
    if path is None:
771
 
        raise ActionError("Required field missing")
772
 
    path = actionpath_to_local(req, path)
773
 
 
774
 
    try:
775
 
        svnclient.cleanup(path)
776
 
    except pysvn.ClientError, e:
777
 
        raise ActionError(str(e))
778
 
 
 
764
            
779
765
 
780
766
# Table of all action functions #
781
767
# Each function has the interface f(req, fields).
801
787
    "svncheckout" : action_svncheckout,
802
788
    "svnrepomkdir" : action_svnrepomkdir,
803
789
    "svnrepostat" : action_svnrepostat,
804
 
    "svncleanup" : action_svncleanup,
805
790
}