← 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: Matt Giuca
  • Date: 2009-12-08 05:22:45 UTC
  • Revision ID: matt.giuca@gmail.com-20091208052245-04kgsqg1cva40iav
Added a script ivle-loadsampledata.
doc/man/sample: Instructions on using this script to load the sample data into
a fresh installation of IVLE.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/fileservice_lib/action.py
94
94
#       revision: The revision number to update to. If not provided this
95
95
#               defaults to HEAD.
96
96
#
 
97
# action=svnpublish: Set the "published" flag on a file to True.
 
98
#       path:   The path to the file to be published. Can be specified
 
99
#               multiple times.
 
100
#
 
101
# action=svnunpublish: Set the "published" flag on a file to False.
 
102
#       path:   The path to the file to be unpublished. Can be specified
 
103
#               multiple times.
 
104
#
97
105
# action=svncommit: Commit a file(s) or directory(s) to the repository.
98
106
#       path:   The path to the file or directory to be committed. Can be
99
107
#               specified multiple times. Directories are committed
136
144
from ivle import (util, studpath, zip)
137
145
from ivle.fileservice_lib.exceptions import WillNotOverwrite
138
146
import ivle.conf
139
 
import ivle.svn
140
 
 
141
 
# Make a Subversion client object (which will log in with this user's
142
 
# credentials, upon request)
143
 
svnclient = ivle.svn.create_auth_svn_client(username=ivle.conf.login,
144
 
                                            password=ivle.conf.svn_pass)
 
147
 
 
148
 
 
149
def get_login(_realm, existing_login, _may_save):
 
150
    """Callback function used by pysvn for authentication.
 
151
    realm, existing_login, _may_save: The 3 arguments passed by pysvn to
 
152
        callback_get_login.
 
153
        The following has been determined empirically, not from docs:
 
154
        existing_login will be the name of the user who owns the process on
 
155
        the first attempt, "" on subsequent attempts. We use this fact.
 
156
    """
 
157
    # Only provide credentials on the _first_ attempt.
 
158
    # If we're being asked again, then it means the credentials failed for
 
159
    # some reason and we should just fail. (This is not desirable, but it's
 
160
    # better than being asked an infinite number of times).
 
161
    return (existing_login != "", str(ivle.conf.login),
 
162
                                  str(ivle.conf.svn_pass), True)
 
163
 
 
164
# Make a Subversion client object
 
165
svnclient = pysvn.Client()
 
166
svnclient.callback_get_login = get_login
145
167
svnclient.exception_style = 0               # Simple (string) exceptions
146
168
 
147
169
DEFAULT_LOGMESSAGE = "No log message supplied."
317
339
    """
318
340
    frompath = fields.getfirst('from')
319
341
    topath = fields.getfirst('to')
320
 
    svn = fields.getfirst('svn')
321
 
    if svn:
322
 
        svn_movefile(req, frompath, topath)
323
 
    else:
324
 
        movefile(req, frompath, topath)
 
342
    movefile(req, frompath, topath)
325
343
 
326
344
def action_mkdir(req, fields):
327
345
    """Creates a directory with the given path.
576
594
    Reads fields: 'path' (multiple)
577
595
    """
578
596
    paths = fields.getlist('path')
579
 
    paths = map(lambda path: actionpath_to_local(req, path).decode('utf-8'),
580
 
                paths)
 
597
    paths = map(lambda path: actionpath_to_local(req, path), paths)
581
598
 
582
599
    try:
583
600
        svnclient.add(paths, recurse=True, force=True)
590
607
    Reads fields: 'path' (multiple)
591
608
    """
592
609
    paths = fields.getlist('path')
593
 
    paths = map(lambda path: actionpath_to_local(req, path).decode('utf-8'),
594
 
                paths)
 
610
    paths = map(lambda path: actionpath_to_local(req, path), paths)
595
611
 
596
612
    try:
597
613
        svnclient.remove(paths, force=True)
615
631
                    int(revision))
616
632
        except ValueError, e:
617
633
            raise ActionError("Bad revision number: '%s'"%revision,)
618
 
    path = actionpath_to_local(req, path).decode('utf-8')
 
634
    path = actionpath_to_local(req, path)
619
635
 
620
636
    try:
621
637
        svnclient.update(path, recurse=True, revision=revision)
630
646
    path = fields.getfirst('path')
631
647
    if path is None:
632
648
        raise ActionError("Required field missing")
633
 
    path = actionpath_to_local(req, path).decode('utf-8')
 
649
    path = actionpath_to_local(req, path)
634
650
 
635
651
    try:
636
652
        svnclient.resolved(path, recurse=True)
643
659
    Reads fields: 'path' (multiple)
644
660
    """
645
661
    paths = fields.getlist('path')
646
 
    paths = map(lambda path: actionpath_to_local(req, path).decode('utf-8'),
647
 
                paths)
 
662
    paths = map(lambda path: actionpath_to_local(req, path), paths)
648
663
 
649
664
    try:
650
665
        svnclient.revert(paths, recurse=True)
651
666
    except pysvn.ClientError, e:
652
667
        raise ActionError(str(e))
653
668
 
 
669
def action_svnpublish(req, fields):
 
670
    """Sets svn property "ivle:published" on each file specified.
 
671
    Should only be called on directories (only effective on directories
 
672
    anyway).
 
673
 
 
674
    Reads fields: 'path'
 
675
 
 
676
    XXX Currently unused by the client (calls action_publish instead, which
 
677
    has a completely different publishing model).
 
678
    """
 
679
    paths = fields.getlist('path')
 
680
    if len(paths):
 
681
        paths = map(lambda path: actionpath_to_local(req, path), paths)
 
682
    else:
 
683
        paths = [studpath.to_home_path(req.path)]
 
684
 
 
685
    try:
 
686
        for path in paths:
 
687
            # Note: Property value doesn't matter
 
688
            svnclient.propset("ivle:published", "", path, recurse=False)
 
689
    except pysvn.ClientError, e:
 
690
        raise ActionError("Directory could not be published")
 
691
 
 
692
def action_svnunpublish(req, fields):
 
693
    """Deletes svn property "ivle:published" on each file specified.
 
694
 
 
695
    Reads fields: 'path'
 
696
 
 
697
    XXX Currently unused by the client (calls action_unpublish instead, which
 
698
    has a completely different publishing model).
 
699
    """
 
700
    paths = fields.getlist('path')
 
701
    paths = map(lambda path: actionpath_to_local(req, path), paths)
 
702
 
 
703
    try:
 
704
        for path in paths:
 
705
            svnclient.propdel("ivle:published", path, recurse=False)
 
706
    except pysvn.ClientError, e:
 
707
        raise ActionError("Directory could not be unpublished")
 
708
 
654
709
def action_svncommit(req, fields):
655
710
    """Performs a "svn commit" to each file specified.
656
711
 
657
712
    Reads fields: 'path' (multiple), 'logmsg' (optional)
658
713
    """
659
714
    paths = fields.getlist('path')
660
 
    if len(paths):
661
 
        paths = map(lambda path:actionpath_to_local(req,path).decode('utf-8'),
662
 
                    paths)
663
 
    else:
664
 
        paths = [studpath.to_home_path(req.path).decode('utf-8')]
665
 
    logmsg = str(fields.getfirst('logmsg',
666
 
                 DEFAULT_LOGMESSAGE)).decode('utf-8')
 
715
    paths = map(lambda path: actionpath_to_local(req, str(path)), paths)
 
716
    logmsg = str(fields.getfirst('logmsg', DEFAULT_LOGMESSAGE))
667
717
    if logmsg == '': logmsg = DEFAULT_LOGMESSAGE
668
718
 
669
719
    try:
681
731
        raise ActionError("usage: svncheckout url local-path")
682
732
    url = ivle.conf.svn_addr + "/" + urllib.quote(paths[0])
683
733
    local_path = actionpath_to_local(req, str(paths[1]))
684
 
    url = url.decode('utf-8')
685
 
    local_path = local_path.decode('utf-8')
686
734
    try:
 
735
        svnclient.callback_get_login = get_login
687
736
        svnclient.checkout(url, local_path, recurse=True)
688
737
    except pysvn.ClientError, e:
689
738
        raise ActionError(str(e))
695
744
    """
696
745
    path = fields.getfirst('path')
697
746
    logmsg = fields.getfirst('logmsg')
698
 
    url = (ivle.conf.svn_addr + "/" + urllib.quote(path)).decode('utf-8')
 
747
    url = ivle.conf.svn_addr + "/" + path
699
748
    try:
 
749
        svnclient.callback_get_login = get_login
700
750
        svnclient.mkdir(url, log_message=logmsg)
701
751
    except pysvn.ClientError, e:
702
752
        raise ActionError(str(e))
709
759
    Reads fields: 'path'
710
760
    """
711
761
    path = fields.getfirst('path')
712
 
    url = (ivle.conf.svn_addr + "/" + urllib.quote(path)).decode('utf-8')
 
762
    url = ivle.conf.svn_addr + "/" + path
713
763
    svnclient.exception_style = 1
714
764
 
715
765
    try:
 
766
        svnclient.callback_get_login = get_login
716
767
        info = svnclient.info2(url,
717
768
            revision=pysvn.Revision(pysvn.opt_revision_kind.head))[0][1]
718
769
        return {'svnrevision': info['rev'].number
722
773
    except pysvn.ClientError, e:
723
774
        # Error code 170000 means ENOENT in this revision.
724
775
        if e[1][0][1] == 170000:
725
 
            req.status = 404
726
 
            raise ActionError('The specified repository path does not exist')
 
776
            raise util.IVLEError(404, 'The specified repository path does not exist')
727
777
        else:
728
778
            raise ActionError(str(e[0]))
729
779
 
736
786
    path = fields.getfirst('path')
737
787
    if path is None:
738
788
        raise ActionError("Required field missing")
739
 
    path = actionpath_to_local(req, path).decode('utf-8')
 
789
    path = actionpath_to_local(req, path)
740
790
 
741
791
    try:
742
792
        svnclient.cleanup(path)
762
812
    "svnupdate" : action_svnupdate,
763
813
    "svnresolved" : action_svnresolved,
764
814
    "svnrevert" : action_svnrevert,
 
815
    "svnpublish" : action_svnpublish,
 
816
    "svnunpublish" : action_svnunpublish,
765
817
    "svncommit" : action_svncommit,
766
818
    "svncheckout" : action_svncheckout,
767
819
    "svnrepomkdir" : action_svnrepomkdir,