Add leading underscores to afs._pts.PTS when it calls around within itself.

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

diff --git a/afs/_pts.pyx b/afs/_pts.pyx
index 05d0877..4a40bd0 100644 (file)
--- a/afs/_pts.pyx
+++ b/afs/_pts.pyx
@@ -1,4 +1,5 @@
 from afs cimport *
 from afs cimport *

+from afs import pyafs_error

 
 cdef import from "afs/ptuser.h":
     enum:
 
 cdef import from "afs/ptuser.h":
     enum:

@@ -7,6 +8,9 @@ cdef import from "afs/ptuser.h":
         PRUSERS
         PRGROUPS
         ANONYMOUSID
         PRUSERS
         PRGROUPS
         ANONYMOUSID

+        PR_SF_ALLBITS
+        PR_SF_NGROUPS
+        PR_SF_NUSERS

 
     ctypedef char prname[PR_MAXNAMELEN]
 
 
     ctypedef char prname[PR_MAXNAMELEN]
 

@@ -61,14 +65,13 @@ cdef import from "afs/ptuser.h":
     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_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

@@ -80,39 +83,12 @@ cdef class PTEntry:
     cdef public object name
 
     def __repr__(self):
     cdef public object name
 
     def __repr__(self):

-        return '<PTEntry: %s>' % self.id
-
-cdef int _ptentry_from_checkentry(PTEntry p_entry, prcheckentry c_entry) except -1:
-    if p_entry is None:
-        raise TypeError
-        return -1
-
-    p_entry.flags = c_entry.flags
-    p_entry.id = c_entry.id
-    p_entry.owner = c_entry.owner
-    p_entry.creator = c_entry.creator
-    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_checkentry(prcheckentry * c_entry, PTEntry p_entry) except -1:
-    if p_entry is None:
-        raise TypeError
-        return -1
-
-    c_entry.flags = p_entry.flags
-    c_entry.id = p_entry.id
-    c_entry.owner = p_entry.owner
-    c_entry.creator = p_entry.creator
-    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
+        if self.name != '':
+            return '<PTEntry: %s>' % self.name
+        else:
+            return '<PTEntry: PTS ID %s>' % self.id

 
 

-cdef int _ptentry_from_listentry(PTEntry p_entry, prlistentries c_entry) except -1:
+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

@@ -127,7 +103,7 @@ cdef int _ptentry_from_listentry(PTEntry p_entry, prlistentries c_entry) except
     p_entry.name = c_entry.name
     return 0
 
     p_entry.name = c_entry.name
     return 0
 

-cdef int _ptentry_to_listentry(prlistentries * c_entry, PTEntry p_entry) except -1:
+cdef int _ptentry_to_c(prcheckentry * c_entry, PTEntry p_entry) except -1:

     if p_entry is None:
         raise TypeError
         return -1
     if p_entry is None:
         raise TypeError
         return -1

@@ -158,6 +134,7 @@ cdef class PTS:
         server
     """
     cdef ubik_client * client
         server
     """
     cdef ubik_client * client

+    cdef readonly object cell

 
     def __cinit__(self, cell=None, sec=1):
         cdef afs_int32 code
 
     def __cinit__(self, cell=None, sec=1):
         cdef afs_int32 code

@@ -189,8 +166,9 @@ 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)
+
+        self.cell = info.name

 
         if sec > 0:
             strncpy(prin.cell, info.name, sizeof(prin.cell))
 
         if sec > 0:
             strncpy(prin.cell, info.name, sizeof(prin.cell))

@@ -201,7 +179,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:

@@ -226,8 +204,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)
 

@@ -235,13 +212,24 @@ cdef class PTS:
         ubik_ClientDestroy(self.client)
         rx_Finalize()
 
         ubik_ClientDestroy(self.client)
         rx_Finalize()
 

-    def NameToId(self, name):
+    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.
         """
         cdef namelist lnames
         cdef idlist lids
         """
         Converts a user or group to an AFS ID.
         """
         cdef namelist lnames
         cdef idlist lids

-        cdef afs_int32 code, id
+        cdef afs_int32 code, id = ANONYMOUSID

         name = name.lower()
 
         lids.idlist_len = 0
         name = name.lower()
 
         lids.idlist_len = 0

@@ -255,11 +243,10 @@ 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
 
         return id
 

-    def IdToName(self, id):
+    def _IdToName(self, id):

         """
         Convert an AFS ID to the name of a user or group.
         """
         """
         Convert an AFS ID to the name of a user or group.
         """

@@ -281,11 +268,10 @@ 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
 
         return name
 

-    def CreateUser(self, name, id=None):
+    def _CreateUser(self, name, id=None):

         """
         Create a new user in the protection database. If an ID is
         provided, that one will be used.
         """
         Create a new user in the protection database. If an ID is
         provided, that one will be used.

@@ -302,11 +288,10 @@ 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
 
         return cid
 

-    def CreateGroup(self, name, owner, id=None):
+    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.
         """
         Create a new group in the protection database. If an ID is
         provided, that one will be used.

@@ -314,7 +299,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

@@ -322,49 +307,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.
         """

@@ -373,6 +358,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
 

@@ -385,12 +372,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.
         """

@@ -399,6 +385,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
 

@@ -411,28 +399,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_checkentry(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.
 

@@ -443,8 +431,10 @@ 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:
         if newname is None:

-            newname = self.IdToName(id)
+            newname = self._IdToName(id)

         c_newname = newname
         if newid is not None:
             c_newid = newid
         c_newname = newname
         if newid is not None:
             c_newid = newid

@@ -452,23 +442,23 @@ 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)
 

-    def ListMax(self):
+    def _ListMax(self):

         """
         Return a tuple of the maximum user ID and the maximum group
         ID currently assigned.
         """
         Return a tuple of the maximum user ID and the maximum group
         ID currently assigned.

@@ -476,12 +466,11 @@ 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)
 

-    def SetMaxUserId(self, id):
+    def _SetMaxUserId(self, id):

         """
         Set the maximum currently assigned user ID (the next
         automatically assigned UID will be id + 1)
         """
         Set the maximum currently assigned user ID (the next
         automatically assigned UID will be id + 1)

@@ -489,10 +478,9 @@ 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):

         """
         Set the maximum currently assigned user ID (the next
         automatically assigned UID will be id + 1)
         """
         Set the maximum currently assigned user ID (the next
         automatically assigned UID will be id + 1)

@@ -500,10 +488,9 @@ 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):
+    def _ListEntries(self, users=None, groups=None):

         """
         Return a list of PTEntry instances representing all entries in
         the PRDB.
         """
         Return a list of PTEntry instances representing all entries in
         the PRDB.

@@ -532,12 +519,38 @@ cdef class PTS:
             if centries.prentries_val is not NULL:
                 for i in range(centries.prentries_len):
                     e = PTEntry()
             if centries.prentries_val is not NULL:
                 for i in range(centries.prentries_len):
                     e = PTEntry()

-                    _ptentry_from_listentry(e, centries.prentries_val[i])
+                    _ptentry_from_c(e, <prcheckentry *>&centries.prentries_val[i])

                     entries.append(e)
                 free(centries.prentries_val)
                     entries.append(e)
                 free(centries.prentries_val)

-            if code != 0:
-                raise Exception("Unable to list entries: %s" % afs_error_message(code))
+            pyafs_error(code)

 
             startindex = nextstartindex
 
         return entries
 
             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)