Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 1 | |
| 2 | /* UNIX group file access module */ |
| 3 | |
Roger E. Masse | b2b44e5 | 1996-12-18 19:37:32 +0000 | [diff] [blame] | 4 | #include "Python.h" |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 5 | #include "structseq.h" |
Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 6 | |
| 7 | #include <sys/types.h> |
| 8 | #include <grp.h> |
| 9 | |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 10 | static PyStructSequence_Field struct_group_type_fields[] = { |
| 11 | {"gr_name", "group name"}, |
| 12 | {"gr_passwd", "password"}, |
| 13 | {"gr_gid", "group id"}, |
| 14 | {"gr_mem", "group memebers"}, |
| 15 | {0} |
| 16 | }; |
| 17 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 18 | PyDoc_STRVAR(struct_group__doc__, |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 19 | "grp.struct_group: Results from getgr*() routines.\n\n\ |
| 20 | This object may be accessed either as a tuple of\n\ |
| 21 | (gr_name,gr_passwd,gr_gid,gr_mem)\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 22 | or via the object attributes as named in the above tuple.\n"); |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 23 | |
| 24 | static PyStructSequence_Desc struct_group_type_desc = { |
| 25 | "grp.struct_group", |
| 26 | struct_group__doc__, |
| 27 | struct_group_type_fields, |
| 28 | 4, |
| 29 | }; |
| 30 | |
| 31 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 32 | static int initialized; |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 33 | static PyTypeObject StructGrpType; |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 34 | |
| 35 | static PyObject * |
| 36 | mkgrent(struct group *p) |
Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 37 | { |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 38 | int setIndex = 0; |
| 39 | PyObject *v = PyStructSequence_New(&StructGrpType), *w; |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 40 | char **member; |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 41 | |
| 42 | if (v == NULL) |
| 43 | return NULL; |
| 44 | |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 45 | if ((w = PyList_New(0)) == NULL) { |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 46 | Py_DECREF(v); |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 47 | return NULL; |
| 48 | } |
Martin v. Löwis | b6a748b | 2009-05-29 15:23:17 +0000 | [diff] [blame^] | 49 | #define FSDECODE(val) PyUnicode_Decode(val, strlen(val),\ |
| 50 | Py_FileSystemDefaultEncoding,\ |
| 51 | "surrogateescape") |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 52 | for (member = p->gr_mem; *member != NULL; member++) { |
Martin v. Löwis | b6a748b | 2009-05-29 15:23:17 +0000 | [diff] [blame^] | 53 | PyObject *x = FSDECODE(*member); |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 54 | if (x == NULL || PyList_Append(w, x) != 0) { |
| 55 | Py_XDECREF(x); |
| 56 | Py_DECREF(w); |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 57 | Py_DECREF(v); |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 58 | return NULL; |
| 59 | } |
| 60 | Py_DECREF(x); |
| 61 | } |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 62 | |
| 63 | #define SET(i,val) PyStructSequence_SET_ITEM(v, i, val) |
Martin v. Löwis | b6a748b | 2009-05-29 15:23:17 +0000 | [diff] [blame^] | 64 | SET(setIndex++, FSDECODE(p->gr_name)); |
Martin v. Löwis | c16f3bd | 2003-05-03 09:14:54 +0000 | [diff] [blame] | 65 | #ifdef __VMS |
| 66 | SET(setIndex++, Py_None); |
| 67 | Py_INCREF(Py_None); |
| 68 | #else |
Martin v. Löwis | ceb7c18 | 2002-09-17 07:05:25 +0000 | [diff] [blame] | 69 | if (p->gr_passwd) |
Martin v. Löwis | b6a748b | 2009-05-29 15:23:17 +0000 | [diff] [blame^] | 70 | SET(setIndex++, FSDECODE(p->gr_passwd)); |
Martin v. Löwis | ceb7c18 | 2002-09-17 07:05:25 +0000 | [diff] [blame] | 71 | else { |
| 72 | SET(setIndex++, Py_None); |
| 73 | Py_INCREF(Py_None); |
| 74 | } |
Martin v. Löwis | c16f3bd | 2003-05-03 09:14:54 +0000 | [diff] [blame] | 75 | #endif |
Christian Heimes | 217cfd1 | 2007-12-02 14:31:20 +0000 | [diff] [blame] | 76 | SET(setIndex++, PyLong_FromLong((long) p->gr_gid)); |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 77 | SET(setIndex++, w); |
| 78 | #undef SET |
| 79 | |
| 80 | if (PyErr_Occurred()) { |
| 81 | Py_DECREF(v); |
| 82 | Py_DECREF(w); |
| 83 | return NULL; |
| 84 | } |
| 85 | |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 86 | return v; |
Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 87 | } |
| 88 | |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 89 | static PyObject * |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 90 | grp_getgrgid(PyObject *self, PyObject *pyo_id) |
Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 91 | { |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 92 | PyObject *py_int_id; |
Guido van Rossum | 8ee3e5a | 2005-09-14 18:09:42 +0000 | [diff] [blame] | 93 | unsigned int gid; |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 94 | struct group *p; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 95 | |
Mark Dickinson | 17c7cd8 | 2009-01-17 21:57:11 +0000 | [diff] [blame] | 96 | py_int_id = PyNumber_Long(pyo_id); |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 97 | if (!py_int_id) |
| 98 | return NULL; |
Christian Heimes | 217cfd1 | 2007-12-02 14:31:20 +0000 | [diff] [blame] | 99 | gid = PyLong_AS_LONG(py_int_id); |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 100 | Py_DECREF(py_int_id); |
| 101 | |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 102 | if ((p = getgrgid(gid)) == NULL) { |
Barry Warsaw | c7a7709 | 2004-01-20 21:06:00 +0000 | [diff] [blame] | 103 | PyErr_Format(PyExc_KeyError, "getgrgid(): gid not found: %d", gid); |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 104 | return NULL; |
| 105 | } |
| 106 | return mkgrent(p); |
Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 107 | } |
| 108 | |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 109 | static PyObject * |
Martin v. Löwis | b6a748b | 2009-05-29 15:23:17 +0000 | [diff] [blame^] | 110 | grp_getgrnam(PyObject *self, PyObject *args) |
Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 111 | { |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 112 | char *name; |
| 113 | struct group *p; |
Martin v. Löwis | b6a748b | 2009-05-29 15:23:17 +0000 | [diff] [blame^] | 114 | PyObject *arg, *bytes, *retval = NULL; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 115 | |
Martin v. Löwis | b6a748b | 2009-05-29 15:23:17 +0000 | [diff] [blame^] | 116 | if (!PyArg_ParseTuple(args, "U:getgrnam", &arg)) |
| 117 | return NULL; |
| 118 | if ((bytes = PyUnicode_AsEncodedString(arg, Py_FileSystemDefaultEncoding, |
| 119 | "surrogateescape")) == NULL) |
| 120 | return NULL; |
| 121 | if (PyBytes_AsStringAndSize(bytes, &name, NULL) == -1) |
| 122 | goto out; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 123 | |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 124 | if ((p = getgrnam(name)) == NULL) { |
Barry Warsaw | c7a7709 | 2004-01-20 21:06:00 +0000 | [diff] [blame] | 125 | PyErr_Format(PyExc_KeyError, "getgrnam(): name not found: %s", name); |
Martin v. Löwis | b6a748b | 2009-05-29 15:23:17 +0000 | [diff] [blame^] | 126 | goto out; |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 127 | } |
Martin v. Löwis | b6a748b | 2009-05-29 15:23:17 +0000 | [diff] [blame^] | 128 | retval = mkgrent(p); |
| 129 | out: |
| 130 | Py_DECREF(bytes); |
| 131 | return retval; |
Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 132 | } |
| 133 | |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 134 | static PyObject * |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 135 | grp_getgrall(PyObject *self, PyObject *ignore) |
Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 136 | { |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 137 | PyObject *d; |
| 138 | struct group *p; |
| 139 | |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 140 | if ((d = PyList_New(0)) == NULL) |
| 141 | return NULL; |
| 142 | setgrent(); |
| 143 | while ((p = getgrent()) != NULL) { |
| 144 | PyObject *v = mkgrent(p); |
| 145 | if (v == NULL || PyList_Append(d, v) != 0) { |
| 146 | Py_XDECREF(v); |
| 147 | Py_DECREF(d); |
| 148 | return NULL; |
| 149 | } |
| 150 | Py_DECREF(v); |
| 151 | } |
Fred Drake | 8e68eb6 | 2001-03-11 03:03:07 +0000 | [diff] [blame] | 152 | endgrent(); |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 153 | return d; |
Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 154 | } |
| 155 | |
Roger E. Masse | b2b44e5 | 1996-12-18 19:37:32 +0000 | [diff] [blame] | 156 | static PyMethodDef grp_methods[] = { |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 157 | {"getgrgid", grp_getgrgid, METH_O, |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 158 | "getgrgid(id) -> tuple\n\ |
| 159 | Return the group database entry for the given numeric group ID. If\n\ |
| 160 | id is not valid, raise KeyError."}, |
Martin v. Löwis | b6a748b | 2009-05-29 15:23:17 +0000 | [diff] [blame^] | 161 | {"getgrnam", grp_getgrnam, METH_VARARGS, |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 162 | "getgrnam(name) -> tuple\n\ |
| 163 | Return the group database entry for the given group name. If\n\ |
| 164 | name is not valid, raise KeyError."}, |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 165 | {"getgrall", grp_getgrall, METH_NOARGS, |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 166 | "getgrall() -> list of tuples\n\ |
| 167 | Return a list of all available group entries, in arbitrary order."}, |
| 168 | {NULL, NULL} /* sentinel */ |
Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 169 | }; |
| 170 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 171 | PyDoc_STRVAR(grp__doc__, |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 172 | "Access to the Unix group database.\n\ |
| 173 | \n\ |
| 174 | Group entries are reported as 4-tuples containing the following fields\n\ |
| 175 | from the group database, in order:\n\ |
| 176 | \n\ |
| 177 | name - name of the group\n\ |
| 178 | passwd - group password (encrypted); often empty\n\ |
| 179 | gid - numeric ID of the group\n\ |
| 180 | mem - list of members\n\ |
| 181 | \n\ |
| 182 | The gid is an integer, name and password are strings. (Note that most\n\ |
| 183 | users are not explicitly listed as members of the groups they are in\n\ |
| 184 | according to the password database. Check both databases to get\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 185 | complete membership information.)"); |
Fred Drake | 51b6bc5 | 2000-07-08 16:56:26 +0000 | [diff] [blame] | 186 | |
| 187 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 188 | |
| 189 | static struct PyModuleDef grpmodule = { |
| 190 | PyModuleDef_HEAD_INIT, |
| 191 | "grp", |
| 192 | grp__doc__, |
| 193 | -1, |
| 194 | grp_methods, |
| 195 | NULL, |
| 196 | NULL, |
| 197 | NULL, |
| 198 | NULL |
| 199 | }; |
| 200 | |
Mark Hammond | fe51c6d | 2002-08-02 02:27:13 +0000 | [diff] [blame] | 201 | PyMODINIT_FUNC |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 202 | PyInit_grp(void) |
Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 203 | { |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 204 | PyObject *m, *d; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 205 | m = PyModule_Create(&grpmodule); |
Neal Norwitz | 1ac754f | 2006-01-19 06:09:39 +0000 | [diff] [blame] | 206 | if (m == NULL) |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 207 | return NULL; |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 208 | d = PyModule_GetDict(m); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 209 | if (!initialized) |
| 210 | PyStructSequence_InitType(&StructGrpType, &struct_group_type_desc); |
Martin v. Löwis | dbd55b3 | 2002-03-01 10:38:44 +0000 | [diff] [blame] | 211 | PyDict_SetItemString(d, "struct_group", (PyObject *) &StructGrpType); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 212 | initialized = 1; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 213 | return m; |
Guido van Rossum | 20882d5 | 1994-06-23 11:15:44 +0000 | [diff] [blame] | 214 | } |