X-Git-Url: http://xvm.mit.edu/gitweb/invirt/packages/python-afs.git/blobdiff_plain/e7d461670886e71b6e93b55778bf96b594a559d4..8d2728f99cd4e073aac44163f608145c88f0f695:/afs/_pts.pyx

diff --git a/afs/_pts.pyx b/afs/_pts.pyx
index 95bfe73..85395bd 100644
--- 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]
@@ -26,10 +22,30 @@ cdef import from "afs/ptuser.h":
     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)
 
+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 +56,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 +122,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 +139,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 +165,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 +193,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,6 +213,9 @@ 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)