Add ListMembers.

[invirt/packages/python-afs.git] / afs / _pts.pyx

diff --git a/afs/_pts.pyx b/afs/_pts.pyx
index 95bfe73..cce9256 100644 (file)
--- a/afs/_pts.pyx
+++ b/afs/_pts.pyx
@@ -3,11 +3,7 @@ from afs cimport *
 cdef import from "afs/ptuser.h":
     enum:
         PR_MAXNAMELEN
-
-    enum:
         PRGRP
-
-    enum:
         ANONYMOUSID
 
     ctypedef char prname[PR_MAXNAMELEN]
@@ -16,6 +12,10 @@ cdef import from "afs/ptuser.h":
         unsigned int namelist_len
         prname *namelist_val
 
+    struct prlist:
+        unsigned int prlist_len
+        afs_int32 *prlist_val
+
     struct idlist:
         unsigned int idlist_len
         afs_int32 *idlist_val
@@ -25,11 +25,34 @@ cdef import from "afs/ptuser.h":
     int ubik_PR_INewEntry(ubik_client *, afs_int32, char *, afs_int32, afs_int32)
     int ubik_PR_NewEntry(ubik_client *, afs_int32, char *, afs_int32, afs_int32, afs_int32 *)
     int ubik_PR_Delete(ubik_client *, afs_int32, afs_int32)
+    int ubik_PR_AddToGroup(ubik_client *, afs_int32, afs_int32, afs_int32)
+    int ubik_PR_RemoveFromGroup(ubik_client *, afs_int32, afs_int32, afs_int32)
+    int ubik_PR_ListElements(ubik_client *, afs_int32, afs_int32, prlist *, afs_int32 *)
+
+cdef import from "afs/pterror.h":
+    enum:
+        PRNOENT
+
+    void initialize_PT_error_table()
 
 cdef class PTS:
     cdef ubik_client * client
 
     def __cinit__(self, cell=None, sec=1):
+        """
+        Open a connection to the protection server. A PTS object is
+        essentially a handle to talk to the server in a given cell.
+
+        cell defaults to None. If no argument is passed for cell, PTS
+        connects to the home cell.
+
+        sec is the security level, an integer from 0 to 3:
+         - 0: unauthenticated connection
+         - 1: try authenticated, then fall back to unauthenticated
+         - 2: fail if an authenticated connection can't be established
+         - 3: same as 2, plus encrypt all traffic to the protection
+           server
+        """
         cdef afs_int32 code
         cdef afsconf_dir *cdir
         cdef afsconf_cell info
@@ -40,6 +63,8 @@ cdef class PTS:
         cdef rx_connection *serverconns[MAXSERVERS]
         cdef int i
 
+        initialize_PT_error_table()
+
         if cell is None:
             c_cell = NULL
         else:
@@ -104,6 +129,9 @@ cdef class PTS:
         rx_Finalize()
 
     def NameToId(self, name):
+        """
+        Converts a user or group to an AFS ID.
+        """
         cdef namelist lnames
         cdef idlist lids
         cdef afs_int32 code, id
@@ -118,11 +146,16 @@ cdef class PTS:
         if lids.idlist_val is not NULL:
             id = lids.idlist_val[0]
             free(lids.idlist_val)
+        if id == ANONYMOUSID:
+            code = PRNOENT
         if code != 0:
             raise Exception("Failed to lookup PTS name: %s" % afs_error_message(code))
         return id
 
     def IdToName(self, id):
+        """
+        Convert an AFS ID to the name of a user or group.
+        """
         cdef namelist lnames
         cdef idlist lids
         cdef afs_int32 code
@@ -139,11 +172,17 @@ cdef class PTS:
             free(lnames.namelist_val)
         if lids.idlist_val is not NULL:
             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))
         return name
 
     def CreateUser(self, name, id=None):
+        """
+        Create a new user in the protection database. If an ID is
+        provided, that one will be used.
+        """
         cdef afs_int32 code
         cdef afs_int32 cid
         name = name[:PR_MAXNAMELEN].lower()
@@ -161,12 +200,14 @@ cdef class PTS:
         return cid
 
     def CreateGroup(self, name, owner, id=None):
+        """
+        Create a new group in the protection database. If an ID is
+        provided, that one will be used.
+        """
         cdef afs_int32 code, cid
 
         name = name[:PR_MAXNAMELEN].lower()
         oid = self.NameToId(owner)
-        if oid == ANONYMOUSID:
-            raise Exception("Error creating group: owner does not exist")
 
         if id is not None:
             cid = id
@@ -179,8 +220,56 @@ cdef class PTS:
         return cid
 
     def Delete(self, id):
+        """
+        Delete the protection database entry with the provided ID.
+        """
         cdef afs_int32 code
 
         code = ubik_PR_Delete(self.client, 0, id)
         if code != 0:
             raise Exception("Failed to delete user: %s" % afs_error_message(code))
+
+    def AddToGroup(self, uid, gid):
+        """
+        Add the user with the given ID to the group with the given ID.
+        """
+        cdef afs_int32 code
+
+        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))
+
+    def RemoveFromGroup(self, uid, gid):
+        """
+        Remove the user with the given ID from the group with the given ID.
+        """
+        cdef afs_int32 code
+
+        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))
+
+    def ListMembers(self, gid):
+        """
+        Get the membership of the list with the given ID.
+
+        This returns a list of PTS IDs.
+        """
+        cdef afs_int32 code, over
+        cdef prlist alist
+        cdef int i
+        cdef object members = []
+
+        alist.prlist_len = 0
+        alist.prlist_val = NULL
+
+        code = ubik_PR_ListElements(self.client, 0, gid, &alist, &over)
+        if code != 0:
+            raise Exception("Failed to get group membership: %s" % afs_error_message(code))
+
+        for i in range(alist.prlist_len):
+            members.append(alist.prlist_val[i])
+        if alist.prlist_val is not NULL:
+            free(alist.prlist_val)
+
+        return members