Use pyafs_error everywhere in afs._pts instead of raising Exceptions
[invirt/packages/python-afs.git] / afs / _pts.pyx
index 640fcc2..c18ef0f 100644 (file)
@@ -1,10 +1,16 @@
 from afs cimport *
 from afs cimport *
+from afs import pyafs_error
 
 cdef import from "afs/ptuser.h":
     enum:
         PR_MAXNAMELEN
         PRGRP
 
 cdef import from "afs/ptuser.h":
     enum:
         PR_MAXNAMELEN
         PRGRP
+        PRUSERS
+        PRGROUPS
         ANONYMOUSID
         ANONYMOUSID
+        PR_SF_ALLBITS
+        PR_SF_NGROUPS
+        PR_SF_NUSERS
 
     ctypedef char prname[PR_MAXNAMELEN]
 
 
     ctypedef char prname[PR_MAXNAMELEN]
 
@@ -28,6 +34,21 @@ cdef import from "afs/ptuser.h":
         afs_int32 ngroups
         afs_int32 nusers
         afs_int32 count
         afs_int32 ngroups
         afs_int32 nusers
         afs_int32 count
+        char name[PR_MAXNAMELEN]
+
+    struct prlistentries:
+        afs_int32 flags
+        afs_int32 id
+        afs_int32 owner
+        afs_int32 creator
+        afs_int32 ngroups
+        afs_int32 nusers
+        afs_int32 count
+        char name[PR_MAXNAMELEN]
+
+    struct prentries:
+        unsigned int prentries_len
+        prlistentries *prentries_val
 
     int ubik_PR_NameToID(ubik_client *, afs_int32, namelist *, idlist *)
     int ubik_PR_IDToName(ubik_client *, afs_int32, idlist *, namelist *)
 
     int ubik_PR_NameToID(ubik_client *, afs_int32, namelist *, idlist *)
     int ubik_PR_IDToName(ubik_client *, afs_int32, idlist *, namelist *)
@@ -43,14 +64,14 @@ cdef import from "afs/ptuser.h":
     int ubik_PR_IsAMemberOf(ubik_client *, afs_int32, afs_int32, afs_int32, afs_int32 *)
     int ubik_PR_ListMax(ubik_client *, afs_int32, afs_int32 *, afs_int32 *)
     int ubik_PR_SetMax(ubik_client *, afs_int32, afs_int32, afs_int32)
     int ubik_PR_IsAMemberOf(ubik_client *, afs_int32, afs_int32, afs_int32, afs_int32 *)
     int ubik_PR_ListMax(ubik_client *, afs_int32, afs_int32 *, afs_int32 *)
     int ubik_PR_SetMax(ubik_client *, afs_int32, afs_int32, afs_int32)
+    int ubik_PR_ListEntries(ubik_client *, afs_int32, afs_int32, afs_int32, prentries *, afs_int32 *)
+    int ubik_PR_SetFieldsEntry(ubik_client *, afs_int32, afs_int32, afs_int32, afs_int32, afs_int32, afs_int32, afs_int32, afs_int32)
 
 cdef import from "afs/pterror.h":
     enum:
         PRNOENT
         PRTOOMANY
 
 
 cdef import from "afs/pterror.h":
     enum:
         PRNOENT
         PRTOOMANY
 
-    void initialize_PT_error_table()
-
 cdef class PTEntry:
     cdef public afs_int32 flags
     cdef public afs_int32 id
 cdef class PTEntry:
     cdef public afs_int32 flags
     cdef public afs_int32 id
@@ -59,8 +80,15 @@ cdef class PTEntry:
     cdef public afs_int32 ngroups
     cdef public afs_int32 nusers
     cdef public afs_int32 count
     cdef public afs_int32 ngroups
     cdef public afs_int32 nusers
     cdef public afs_int32 count
+    cdef public object name
 
 
-cdef int _ptentry_from_c(PTEntry p_entry, prcheckentry c_entry) except -1:
+    def __repr__(self):
+        if self.name != '':
+            return '<PTEntry: %s>' % self.name
+        else:
+            return '<PTEntry: PTS ID %s>' % self.id
+
+cdef int _ptentry_from_c(PTEntry p_entry, prcheckentry * c_entry) except -1:
     if p_entry is None:
         raise TypeError
         return -1
     if p_entry is None:
         raise TypeError
         return -1
@@ -72,6 +100,7 @@ cdef int _ptentry_from_c(PTEntry p_entry, prcheckentry c_entry) except -1:
     p_entry.ngroups = c_entry.ngroups
     p_entry.nusers = c_entry.nusers
     p_entry.count = c_entry.count
     p_entry.ngroups = c_entry.ngroups
     p_entry.nusers = c_entry.nusers
     p_entry.count = c_entry.count
+    p_entry.name = c_entry.name
     return 0
 
 cdef int _ptentry_to_c(prcheckentry * c_entry, PTEntry p_entry) except -1:
     return 0
 
 cdef int _ptentry_to_c(prcheckentry * c_entry, PTEntry p_entry) except -1:
@@ -86,6 +115,7 @@ cdef int _ptentry_to_c(prcheckentry * c_entry, PTEntry p_entry) except -1:
     c_entry.ngroups = p_entry.ngroups
     c_entry.nusers = p_entry.nusers
     c_entry.count = p_entry.count
     c_entry.ngroups = p_entry.ngroups
     c_entry.nusers = p_entry.nusers
     c_entry.count = p_entry.count
+    strncpy(c_entry.name, p_entry.name, sizeof(c_entry.name))
     return 0
 
 cdef class PTS:
     return 0
 
 cdef class PTS:
@@ -135,8 +165,7 @@ cdef class PTS:
                           "Error opening configuration directory (%s): %s" % \
                               (AFSDIR_CLIENT_ETC_DIRPATH, strerror(errno)))
         code = afsconf_GetCellInfo(cdir, c_cell, "afsprot", &info)
                           "Error opening configuration directory (%s): %s" % \
                               (AFSDIR_CLIENT_ETC_DIRPATH, strerror(errno)))
         code = afsconf_GetCellInfo(cdir, c_cell, "afsprot", &info)
-        if code != 0:
-            raise Exception(code, "GetCellInfo: %s" % afs_error_message(code))
+        pyafs_error(code)
 
         if sec > 0:
             strncpy(prin.cell, info.name, sizeof(prin.cell))
 
         if sec > 0:
             strncpy(prin.cell, info.name, sizeof(prin.cell))
@@ -147,7 +176,7 @@ cdef class PTS:
             if code != 0:
                 if sec >= 2:
                     # No really - we wanted authentication
             if code != 0:
                 if sec >= 2:
                     # No really - we wanted authentication
-                    raise Exception(code, "Failed to get token for service AFS: %s" % afs_error_message(code))
+                    pyafs_error(code)
                 sec = 0
             else:
                 if sec == 3:
                 sec = 0
             else:
                 if sec == 3:
@@ -172,8 +201,7 @@ cdef class PTS:
                                               sec)
 
         code = ubik_ClientInit(serverconns, &self.client)
                                               sec)
 
         code = ubik_ClientInit(serverconns, &self.client)
-        if code != 0:
-            raise Exception("Failed to initialize ubik connection to Protection server: %s" % afs_error_message(code))
+        pyafs_error(code)
 
         code = rxs_Release(sc)
 
 
         code = rxs_Release(sc)
 
@@ -181,6 +209,17 @@ cdef class PTS:
         ubik_ClientDestroy(self.client)
         rx_Finalize()
 
         ubik_ClientDestroy(self.client)
         rx_Finalize()
 
+    def NameOrId(self, ident):
+        """
+        Given an identifier, convert it to a PTS ID by looking up the
+        name if it's a string, or otherwise just converting it to an
+        integer.
+        """
+        if isinstance(ident, (str, unicode)):
+            return self.NameToId(ident)
+        else:
+            return int(ident)
+
     def NameToId(self, name):
         """
         Converts a user or group to an AFS ID.
     def NameToId(self, name):
         """
         Converts a user or group to an AFS ID.
@@ -201,8 +240,7 @@ cdef class PTS:
             free(lids.idlist_val)
         if id == ANONYMOUSID:
             code = PRNOENT
             free(lids.idlist_val)
         if id == ANONYMOUSID:
             code = PRNOENT
-        if code != 0:
-            raise Exception("Failed to lookup PTS name: %s" % afs_error_message(code))
+        pyafs_error(code)
         return id
 
     def IdToName(self, id):
         return id
 
     def IdToName(self, id):
@@ -227,8 +265,7 @@ cdef class PTS:
             free(lids.idlist_val)
         if name == str(id):
             code = PRNOENT
             free(lids.idlist_val)
         if name == str(id):
             code = PRNOENT
-        if code != 0:
-            raise Exception("Failed to lookup PTS ID: %s" % afs_error_message(code))
+        pyafs_error(code)
         return name
 
     def CreateUser(self, name, id=None):
         return name
 
     def CreateUser(self, name, id=None):
@@ -248,8 +285,7 @@ cdef class PTS:
         else:
             code = ubik_PR_NewEntry(self.client, 0, name, 0, 0, &cid)
 
         else:
             code = ubik_PR_NewEntry(self.client, 0, name, 0, 0, &cid)
 
-        if code != 0:
-            raise Exception("Failed to create user: %s" % afs_error_message(code))
+        pyafs_error(code)
         return cid
 
     def CreateGroup(self, name, owner, id=None):
         return cid
 
     def CreateGroup(self, name, owner, id=None):
@@ -260,7 +296,7 @@ cdef class PTS:
         cdef afs_int32 code, cid
 
         name = name[:PR_MAXNAMELEN].lower()
         cdef afs_int32 code, cid
 
         name = name[:PR_MAXNAMELEN].lower()
-        oid = self.NameToId(owner)
+        oid = self.NameOrId(owner)
 
         if id is not None:
             cid = id
 
         if id is not None:
             cid = id
@@ -268,49 +304,49 @@ cdef class PTS:
         else:
             code = ubik_PR_NewEntry(self.client, 0, name, PRGRP, oid, &cid)
 
         else:
             code = ubik_PR_NewEntry(self.client, 0, name, PRGRP, oid, &cid)
 
-        if code != 0:
-            raise Exception("Failed to create group: %s" % afs_error_message(code))
+        pyafs_error(code)
         return cid
 
         return cid
 
-    def Delete(self, id):
+    def Delete(self, ident):
         """
         """
-        Delete the protection database entry with the provided ID.
+        Delete the protection database entry with the provided
+        identifier.
         """
         cdef afs_int32 code
         """
         cdef afs_int32 code
+        cdef afs_int32 id = self.NameOrId(ident)
 
         code = ubik_PR_Delete(self.client, 0, id)
 
         code = ubik_PR_Delete(self.client, 0, id)
-        if code != 0:
-            raise Exception("Failed to delete user: %s" % afs_error_message(code))
+        pyafs_error(code)
 
 
-    def AddToGroup(self, uid, gid):
+    def AddToGroup(self, user, group):
         """
         """
-        Add the user with the given ID to the group with the given ID.
+        Add the given user to the given group.
         """
         cdef afs_int32 code
         """
         cdef afs_int32 code
+        cdef afs_int32 uid = self.NameOrId(user), gid = self.NameOrId(group)
 
         code = ubik_PR_AddToGroup(self.client, 0, uid, gid)
 
         code = ubik_PR_AddToGroup(self.client, 0, uid, gid)
-        if code != 0:
-            raise Exception("Failed to add user to group: %s" % afs_error_message(code))
+        pyafs_error(code)
 
 
-    def RemoveFromGroup(self, uid, gid):
+    def RemoveFromGroup(self, user, group):
         """
         """
-        Remove the user with the given ID from the group with the given ID.
+        Remove the given user from the given group.
         """
         cdef afs_int32 code
         """
         cdef afs_int32 code
+        cdef afs_int32 uid = self.NameOrId(user), gid = self.NameOrId(group)
 
         code = ubik_PR_RemoveFromGroup(self.client, 0, uid, gid)
 
         code = ubik_PR_RemoveFromGroup(self.client, 0, uid, gid)
-        if code != 0:
-            raise Exception("Failed to remove user from group: %s" % afs_error_message(code))
+        pyafs_error(code)
 
 
-    def ListMembers(self, id):
+    def ListMembers(self, ident):
         """
         Get the membership of an entity.
 
         """
         Get the membership of an entity.
 
-        If id is a group ID, this returns the users that are in that
+        If id is a group, this returns the users that are in that
         group.
 
         group.
 
-        If id is a user ID, this returns the list of groups that user
-        is on.
+        If id is a user, this returns the list of groups that user is
+        on.
 
         This returns a list of PTS IDs.
         """
 
         This returns a list of PTS IDs.
         """
@@ -319,6 +355,8 @@ cdef class PTS:
         cdef int i
         cdef object members = []
 
         cdef int i
         cdef object members = []
 
+        cdef afs_int32 id = self.NameOrId(ident)
+
         alist.prlist_len = 0
         alist.prlist_val = NULL
 
         alist.prlist_len = 0
         alist.prlist_val = NULL
 
@@ -331,12 +369,11 @@ cdef class PTS:
 
         if over:
             code = PRTOOMANY
 
         if over:
             code = PRTOOMANY
-        if code != 0:
-            raise Exception("Failed to get group membership: %s" % afs_error_message(code))
+        pyafs_error(code)
 
         return members
 
 
         return members
 
-    def ListOwned(self, oid):
+    def ListOwned(self, owner):
         """
         Get all groups owned by an entity.
         """
         """
         Get all groups owned by an entity.
         """
@@ -345,6 +382,8 @@ cdef class PTS:
         cdef int i
         cdef object owned = []
 
         cdef int i
         cdef object owned = []
 
+        cdef afs_int32 oid = self.NameOrId(owner)
+
         alist.prlist_len = 0
         alist.prlist_val = NULL
 
         alist.prlist_len = 0
         alist.prlist_val = NULL
 
@@ -357,28 +396,28 @@ cdef class PTS:
 
         if over:
             code = PRTOOMANY
 
         if over:
             code = PRTOOMANY
-        if code != 0:
-            raise Exception("Failed to get owned entities: %s" % afs_error_message(code))
+        pyafs_error(code)
 
         return owned
 
 
         return owned
 
-    def ListEntry(self, id):
+    def ListEntry(self, ident):
         """
         Load a PTEntry instance with information about the provided
         """
         Load a PTEntry instance with information about the provided
-        ID.
+        entity.
         """
         cdef afs_int32 code
         cdef prcheckentry centry
         cdef object entry = PTEntry()
 
         """
         cdef afs_int32 code
         cdef prcheckentry centry
         cdef object entry = PTEntry()
 
+        cdef afs_int32 id = self.NameOrId(ident)
+
         code = ubik_PR_ListEntry(self.client, 0, id, &centry)
         code = ubik_PR_ListEntry(self.client, 0, id, &centry)
-        if code != 0:
-            raise Exception("Error getting entity info: %s" % afs_error_message(code))
+        pyafs_error(code)
 
 
-        _ptentry_from_c(entry, centry)
+        _ptentry_from_c(entry, &centry)
         return entry
 
         return entry
 
-    def ChangeEntry(self, id, newname=None, newid=None, newoid=None):
+    def ChangeEntry(self, ident, newname=None, newid=None, newoid=None):
         """
         Change the name, ID, and/or owner of a PTS entity.
 
         """
         Change the name, ID, and/or owner of a PTS entity.
 
@@ -389,6 +428,8 @@ cdef class PTS:
         cdef afs_int32 c_newid = 0, c_newoid = 0
         cdef char * c_newname
 
         cdef afs_int32 c_newid = 0, c_newoid = 0
         cdef char * c_newname
 
+        cdef afs_int32 id = self.NameOrId(ident)
+
         if newname is None:
             newname = self.IdToName(id)
         c_newname = newname
         if newname is None:
             newname = self.IdToName(id)
         c_newname = newname
@@ -398,19 +439,19 @@ cdef class PTS:
             c_newoid = newoid
 
         code = ubik_PR_ChangeEntry(self.client, 0, id, c_newname, c_newoid, c_newid)
             c_newoid = newoid
 
         code = ubik_PR_ChangeEntry(self.client, 0, id, c_newname, c_newoid, c_newid)
-        if code != 0:
-            raise Exception("Error changing entity info: %s" % afs_error_message(code))
+        pyafs_error(code)
 
 
-    def IsAMemberOf(self, uid, gid):
+    def IsAMemberOf(self, user, group):
         """
         """
-        Return True if the given uid is a member of the given gid.
+        Return True if the given user is a member of the given group.
         """
         cdef afs_int32 code
         cdef afs_int32 flag
 
         """
         cdef afs_int32 code
         cdef afs_int32 flag
 
+        cdef afs_int32 uid = self.NameOrId(user), gid = self.NameOrId(group)
+
         code = ubik_PR_IsAMemberOf(self.client, 0, uid, gid, &flag)
         code = ubik_PR_IsAMemberOf(self.client, 0, uid, gid, &flag)
-        if code != 0:
-            raise Exception("Error testing membership: %s" % afs_error_message(code))
+        pyafs_error(code)
 
         return bool(flag)
 
 
         return bool(flag)
 
@@ -422,8 +463,7 @@ cdef class PTS:
         cdef afs_int32 code, uid, gid
 
         code = ubik_PR_ListMax(self.client, 0, &uid, &gid)
         cdef afs_int32 code, uid, gid
 
         code = ubik_PR_ListMax(self.client, 0, &uid, &gid)
-        if code != 0:
-            raise Exception("Error looking up max uid/gid: %s" % afs_error_message(code))
+        pyafs_error(code)
 
         return (uid, gid)
 
 
         return (uid, gid)
 
@@ -435,8 +475,7 @@ cdef class PTS:
         cdef afs_int32 code
 
         code = ubik_PR_SetMax(self.client, 0, id, 0)
         cdef afs_int32 code
 
         code = ubik_PR_SetMax(self.client, 0, id, 0)
-        if code != 0:
-            raise Exception("Error setting max uid: %s" % afs_error_message(code))
+        pyafs_error(code)
 
     def SetMaxGroupId(self, id):
         """
 
     def SetMaxGroupId(self, id):
         """
@@ -446,5 +485,69 @@ cdef class PTS:
         cdef afs_int32 code
 
         code = ubik_PR_SetMax(self.client, 0, id, PRGRP)
         cdef afs_int32 code
 
         code = ubik_PR_SetMax(self.client, 0, id, PRGRP)
-        if code != 0:
-            raise Exception("Error setting max gid: %s" % afs_error_message(code))
+        pyafs_error(code)
+
+    def ListEntries(self, users=None, groups=None):
+        """
+        Return a list of PTEntry instances representing all entries in
+        the PRDB.
+
+        Returns just users by default, but can return just users, just
+        groups, or both.
+        """
+        cdef afs_int32 code
+        cdef afs_int32 flag = 0, startindex = 0, nentries, nextstartindex
+        cdef prentries centries
+        cdef unsigned int i
+
+        cdef object entries = []
+
+        if groups is None or users is True:
+            flag |= PRUSERS
+        if groups:
+            flag |= PRGROUPS
+
+        while startindex != -1:
+            centries.prentries_val = NULL
+            centries.prentries_len = 0
+            nextstartindex = -1
+
+            code = ubik_PR_ListEntries(self.client, 0, flag, startindex, &centries, &nextstartindex)
+            if centries.prentries_val is not NULL:
+                for i in range(centries.prentries_len):
+                    e = PTEntry()
+                    _ptentry_from_c(e, <prcheckentry *>&centries.prentries_val[i])
+                    entries.append(e)
+                free(centries.prentries_val)
+            pyafs_error(code)
+
+            startindex = nextstartindex
+
+        return entries
+
+    def SetFields(self, ident, access=None, groups=None, users=None):
+        """
+        Update the fields for an entry.
+
+        Valid fields are the privacy flags (access), the group quota
+        (groups), or the "foreign user quota" (users), which doesn't
+        actually seem to do anything, but is included for
+        completeness.
+        """
+        cdef afs_int32 code
+        cdef afs_int32 mask = 0, flags = 0, nusers = 0, ngroups = 0
+
+        cdef afs_int32 id = self.NameOrId(ident)
+
+        if access is not None:
+            flags = access
+            mask |= PR_SF_ALLBITS
+        if groups is not None:
+            ngroups = groups
+            mask |= PR_SF_NGROUPS
+        if users is not None:
+            nusers = users
+            mask |= PR_SF_NGROUPS
+
+        code = ubik_PR_SetFieldsEntry(self.client, 0, id, mask, flags, ngroups, nusers, 0, 0)
+        pyafs_error(code)