subversion/bindings/swig/python/tests/trac/versioncontrol/main.py

   1 #
   2 # Copyright (C) 2005 Edgewall Software
   3 # Copyright (C) 2005 Christopher Lenz <cmlenz@gmx.de>
   4 #
   5 # This software is licensed as described in the file
   6 # LICENSE_FOR_PYTHON_BINDINGS, which you should have received as part
   7 # of this distribution.  The terms are also available at
   8 # < http://subversion.tigris.org/license-for-python-bindings.html >.
   9 # If newer versions of this license are posted there, you may use a
  10 # newer version instead, at your option.
  11 #
  12 # Author: Christopher Lenz <cmlenz@gmx.de>
  13
  14 from __future__ import generators
  15
  16 class Repository(object):
  17     """
  18     Base class for a repository provided by a version control system.
  19     """
  20
  21     def __init__(self, authz):
  22         self.authz = authz or Authorizer()
  23
  24     def close(self):
  25         """
  26         Close the connection to the repository.
  27         """
  28         raise NotImplementedError
  29
  30     def get_changeset(self, rev):
  31         """
  32         Retrieve a Changeset object that describes the changes made in
  33         revision 'rev'.
  34         """
  35         raise NotImplementedError
  36
  37     def has_node(self, path, rev):
  38         """
  39         Tell if there's a node at the specified (path,rev) combination.
  40         """
  41         raise NotImplementedError
  42
  43     def get_node(self, path, rev=None):
  44         """
  45         Retrieve a Node (directory or file) from the repository at the
  46         given path. If the rev parameter is specified, the version of the
  47         node at that revision is returned, otherwise the latest version
  48         of the node is returned.
  49         """
  50         raise NotImplementedError
  51
  52     def get_oldest_rev(self):
  53         """
  54         Return the oldest revision stored in the repository.
  55         """
  56         raise NotImplementedError
  57     oldest_rev = property(lambda x: x.get_oldest_rev())
  58
  59     def get_youngest_rev(self):
  60         """
  61         Return the youngest revision in the repository.
  62         """
  63         raise NotImplementedError
  64     youngest_rev = property(lambda x: x.get_youngest_rev())
  65
  66     def previous_rev(self, rev):
  67         """
  68         Return the revision immediately preceding the specified revision.
  69         """
  70         raise NotImplementedError
  71
  72     def next_rev(self, rev):
  73         """
  74         Return the revision immediately following the specified revision.
  75         """
  76         raise NotImplementedError
  77
  78     def rev_older_than(self, rev1, rev2):
  79         """
  80         Return True if rev1 is older than rev2, i.e. if rev1 comes before rev2
  81         in the revision sequence.
  82         """
  83         raise NotImplementedError
  84
  85     def get_path_history(self, path, rev=None, limit=None):
  86         """
  87         Retrieve all the revisions containing this path (no newer than 'rev').
  88         The result format should be the same as the one of Node.get_history()
  89         """
  90         raise NotImplementedError
  91
  92     def normalize_path(self, path):
  93         """
  94         Return a canonical representation of path in the repos.
  95         """
  96         return NotImplementedError
  97
  98     def normalize_rev(self, rev):
  99         """
 100         Return a canonical representation of a revision in the repos.
 101         'None' is a valid revision value and represents the youngest revision.
 102         """
 103         return NotImplementedError
 104
 105     def get_deltas(self, old_path, old_rev, new_path, new_rev, ignore_ancestry=1):
 106         """
 107         Generator that yields change tuples (old_node, new_node, kind, change)
 108         for each node change between the two arbitrary (path,rev) pairs.
 109
 110         The old_node is assumed to be None when the change is an ADD,
 111         the new_node is assumed to be None when the change is a DELETE.
 112         """
 113         raise NotImplementedError
 114
 115
 116 class Node(object):
 117     """
 118     Represents a directory or file in the repository.
 119     """
 120
 121     DIRECTORY = "dir"
 122     FILE = "file"
 123
 124     def __init__(self, path, rev, kind):
 125         assert kind in (Node.DIRECTORY, Node.FILE), "Unknown node kind %s" % kind
 126         self.path = str(path)
 127         self.rev = rev
 128         self.kind = kind
 129
 130     def get_content(self):
 131         """
 132         Return a stream for reading the content of the node. This method
 133         will return None for directories. The returned object should provide
 134         a read([len]) function.
 135         """
 136         raise NotImplementedError
 137
 138     def get_entries(self):
 139         """
 140         Generator that yields the immediate child entries of a directory, in no
 141         particular order. If the node is a file, this method returns None.
 142         """
 143         raise NotImplementedError
 144
 145     def get_history(self, limit=None):
 146         """
 147         Generator that yields (path, rev, chg) tuples, one for each revision in which
 148         the node was changed. This generator will follow copies and moves of a
 149         node (if the underlying version control system supports that), which
 150         will be indicated by the first element of the tuple (i.e. the path)
 151         changing.
 152         Starts with an entry for the current revision.
 153         """
 154         raise NotImplementedError
 155
 156     def get_previous(self):
 157         """
 158         Return the (path, rev, chg) tuple corresponding to the previous
 159         revision for that node.
 160         """
 161         skip = True
 162         for p in self.get_history(2):
 163             if skip:
 164                 skip = False
 165             else:
 166                 return p
 167
 168     def get_properties(self):
 169         """
 170         Returns a dictionary containing the properties (meta-data) of the node.
 171         The set of properties depends on the version control system.
 172         """
 173         raise NotImplementedError
 174
 175     def get_content_length(self):
 176         raise NotImplementedError
 177     content_length = property(lambda x: x.get_content_length())
 178
 179     def get_content_type(self):
 180         raise NotImplementedError
 181     content_type = property(lambda x: x.get_content_type())
 182
 183     def get_name(self):
 184         return self.path.split('/')[-1]
 185     name = property(lambda x: x.get_name())
 186
 187     def get_last_modified(self):
 188         raise NotImplementedError
 189     last_modified = property(lambda x: x.get_last_modified())
 190
 191     isdir = property(lambda x: x.kind == Node.DIRECTORY)
 192     isfile = property(lambda x: x.kind == Node.FILE)
 193
 194
 195 class Changeset(object):
 196     """
 197     Represents a set of changes of a repository.
 198     """
 199
 200     ADD = 'add'
 201     COPY = 'copy'
 202     DELETE = 'delete'
 203     EDIT = 'edit'
 204     MOVE = 'move'
 205
 206     def __init__(self, rev, message, author, date):
 207         self.rev = rev
 208         self.message = message
 209         self.author = author
 210         self.date = date
 211
 212     def get_changes(self):
 213         """
 214         Generator that produces a (path, kind, change, base_rev, base_path)
 215         tuple for every change in the changeset, where change can be one of
 216         Changeset.ADD, Changeset.COPY, Changeset.DELETE, Changeset.EDIT or
 217         Changeset.MOVE, and kind is one of Node.FILE or Node.DIRECTORY.
 218         """
 219         raise NotImplementedError
 220
 221
 222 class PermissionDenied(Exception):
 223     """
 224     Exception raised by an authorizer if the user has insufficient permissions
 225     to view a specific part of the repository.
 226     """
 227     pass
 228
 229
 230 class Authorizer(object):
 231     """
 232     Base class for authorizers that are responsible to granting or denying
 233     access to view certain parts of a repository.
 234     """
 235
 236     def assert_permission(self, path):
 237         if not self.has_permission(path):
 238             raise PermissionDenied, \
 239                   'Insufficient permissions to access %s' % path
 240
 241     def has_permission(self, path):
 242         return 1
 243
 244     def has_permission_for_changeset(self, rev):
 245         return 1
 246