grpmodule.c 4.43 KB
Newer Older
1 2 3

/* UNIX group file access module */

Roger E. Masse's avatar
Roger E. Masse committed
4
#include "Python.h"
5
#include "structseq.h"
6 7 8 9

#include <sys/types.h>
#include <grp.h>

10 11 12 13 14 15 16 17
static PyStructSequence_Field struct_group_type_fields[] = {
   {"gr_name", "group name"},
   {"gr_passwd", "password"},
   {"gr_gid", "group id"}, 
   {"gr_mem", "group memebers"}, 
   {0}
};

18
PyDoc_STRVAR(struct_group__doc__,
19 20 21
"grp.struct_group: Results from getgr*() routines.\n\n\
This object may be accessed either as a tuple of\n\
  (gr_name,gr_passwd,gr_gid,gr_mem)\n\
22
or via the object attributes as named in the above tuple.\n");
23 24 25 26 27 28 29 30 31 32

static PyStructSequence_Desc struct_group_type_desc = {
   "grp.struct_group",
   struct_group__doc__,
   struct_group_type_fields,
   4,
};


static PyTypeObject StructGrpType;
33 34 35

static PyObject *
mkgrent(struct group *p)
36
{
37 38
    int setIndex = 0;
    PyObject *v = PyStructSequence_New(&StructGrpType), *w;
39
    char **member;
40 41 42 43

    if (v == NULL)
        return NULL;

44
    if ((w = PyList_New(0)) == NULL) {
45
        Py_DECREF(v);
46 47 48 49 50 51 52
        return NULL;
    }
    for (member = p->gr_mem; *member != NULL; member++) {
        PyObject *x = PyString_FromString(*member);
        if (x == NULL || PyList_Append(w, x) != 0) {
            Py_XDECREF(x);
            Py_DECREF(w);
53
            Py_DECREF(v);
54 55 56 57
            return NULL;
        }
        Py_DECREF(x);
    }
58 59 60

#define SET(i,val) PyStructSequence_SET_ITEM(v, i, val)
    SET(setIndex++, PyString_FromString(p->gr_name));
61 62 63 64
#ifdef __VMS
    SET(setIndex++, Py_None);
    Py_INCREF(Py_None);
#else
65 66 67 68 69 70
    if (p->gr_passwd)
	    SET(setIndex++, PyString_FromString(p->gr_passwd));
    else {
	    SET(setIndex++, Py_None);
	    Py_INCREF(Py_None);
    }
71
#endif
72 73 74 75 76 77 78 79 80 81
    SET(setIndex++, PyInt_FromLong((long) p->gr_gid));
    SET(setIndex++, w);
#undef SET

    if (PyErr_Occurred()) {
        Py_DECREF(v);
        Py_DECREF(w);
        return NULL;
    }

82
    return v;
83 84
}

85 86
static PyObject *
grp_getgrgid(PyObject *self, PyObject *args)
87
{
88 89 90 91 92
    int gid;
    struct group *p;
    if (!PyArg_ParseTuple(args, "i:getgrgid", &gid))
        return NULL;
    if ((p = getgrgid(gid)) == NULL) {
93
	PyErr_Format(PyExc_KeyError, "getgrgid(): gid not found: %d", gid);
94 95 96
        return NULL;
    }
    return mkgrent(p);
97 98
}

99 100
static PyObject *
grp_getgrnam(PyObject *self, PyObject *args)
101
{
102 103 104 105 106
    char *name;
    struct group *p;
    if (!PyArg_ParseTuple(args, "s:getgrnam", &name))
        return NULL;
    if ((p = getgrnam(name)) == NULL) {
107
	PyErr_Format(PyExc_KeyError, "getgrnam(): name not found: %s", name);
108 109 110
        return NULL;
    }
    return mkgrent(p);
111 112
}

113 114
static PyObject *
grp_getgrall(PyObject *self, PyObject *args)
115
{
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
    PyObject *d;
    struct group *p;

    if (!PyArg_ParseTuple(args, ":getgrall"))
        return NULL;
    if ((d = PyList_New(0)) == NULL)
        return NULL;
    setgrent();
    while ((p = getgrent()) != NULL) {
        PyObject *v = mkgrent(p);
        if (v == NULL || PyList_Append(d, v) != 0) {
            Py_XDECREF(v);
            Py_DECREF(d);
            return NULL;
        }
        Py_DECREF(v);
    }
133
    endgrent();
134
    return d;
135 136
}

Roger E. Masse's avatar
Roger E. Masse committed
137
static PyMethodDef grp_methods[] = {
138 139 140 141 142 143 144 145 146 147 148 149
    {"getgrgid",	grp_getgrgid,	METH_VARARGS,
     "getgrgid(id) -> tuple\n\
Return the group database entry for the given numeric group ID.  If\n\
id is not valid, raise KeyError."},
    {"getgrnam",	grp_getgrnam,	METH_VARARGS,
     "getgrnam(name) -> tuple\n\
Return the group database entry for the given group name.  If\n\
name is not valid, raise KeyError."},
    {"getgrall",	grp_getgrall,	METH_VARARGS,
     "getgrall() -> list of tuples\n\
Return a list of all available group entries, in arbitrary order."},
    {NULL,		NULL}		/* sentinel */
150 151
};

152
PyDoc_STRVAR(grp__doc__,
153 154 155 156 157 158 159 160 161 162 163 164 165
"Access to the Unix group database.\n\
\n\
Group entries are reported as 4-tuples containing the following fields\n\
from the group database, in order:\n\
\n\
  name   - name of the group\n\
  passwd - group password (encrypted); often empty\n\
  gid    - numeric ID of the group\n\
  mem    - list of members\n\
\n\
The gid is an integer, name and password are strings.  (Note that most\n\
users are not explicitly listed as members of the groups they are in\n\
according to the password database.  Check both databases to get\n\
166
complete membership information.)");
167 168


169
PyMODINIT_FUNC
170
initgrp(void)
171
{
172 173 174 175 176
    PyObject *m, *d;
    m = Py_InitModule3("grp", grp_methods, grp__doc__);
    d = PyModule_GetDict(m);
    PyStructSequence_InitType(&StructGrpType, &struct_group_type_desc);
    PyDict_SetItemString(d, "struct_group", (PyObject *) &StructGrpType);
177
}