Apply no-unitialised-objects to Permset as well
[pylibacl.git] / acl.c
1 /*
2     posix1e - a python module exposing the posix acl functions
3
4     Copyright (C) 2002-2009, 2012, 2014, 2015 Iustin Pop <iustin@k1024.org>
5
6     This library is free software; you can redistribute it and/or
7     modify it under the terms of the GNU Lesser General Public
8     License as published by the Free Software Foundation; either
9     version 2.1 of the License, or (at your option) any later version.
10
11     This library is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14     Lesser General Public License for more details.
15
16     You should have received a copy of the GNU Lesser General Public
17     License along with this library; if not, write to the Free Software
18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19     02110-1301  USA
20
21 */
22
23 #include <Python.h>
24
25 #include <sys/types.h>
26 #include <sys/acl.h>
27
28 #ifdef HAVE_LINUX
29 #include <acl/libacl.h>
30 #define get_perm acl_get_perm
31 #elif HAVE_FREEBSD
32 #define get_perm acl_get_perm_np
33 #endif
34
35 /* Used for cpychecker: */
36 /* The checker automatically defines this preprocessor name when creating
37    the custom attribute: */
38 #if defined(WITH_CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF_ATTRIBUTE)
39 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(typename) \
40   __attribute__((cpychecker_type_object_for_typedef(typename)))
41 #else
42 /* This handles the case where we're compiling with a "vanilla"
43    compiler that doesn't supply this attribute: */
44 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(typename)
45 #endif
46
47 /* The checker automatically defines this preprocessor name when creating
48    the custom attribute: */
49 #if defined(WITH_CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION_ATTRIBUTE)
50    #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION \
51 __attribute__((cpychecker_negative_result_sets_exception))
52    #else
53    #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
54 #endif
55
56 static PyTypeObject ACL_Type
57   CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("ACL_Object");
58 static PyObject* ACL_applyto(PyObject* obj, PyObject* args);
59 static PyObject* ACL_valid(PyObject* obj, PyObject* args);
60
61 #ifdef HAVE_ACL_COPY_EXT
62 static PyObject* ACL_get_state(PyObject *obj, PyObject* args);
63 static PyObject* ACL_set_state(PyObject *obj, PyObject* args);
64 #endif
65
66 #ifdef HAVE_LEVEL2
67 static PyTypeObject Entry_Type
68   CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("Entry_Object");
69 static PyTypeObject Permset_Type
70   CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("Permset_Object");
71 static PyObject* Permset_new(PyTypeObject* type, PyObject* args,
72                              PyObject *keywds);
73 #endif
74
75 static acl_perm_t holder_ACL_EXECUTE = ACL_EXECUTE;
76 static acl_perm_t holder_ACL_READ = ACL_READ;
77 static acl_perm_t holder_ACL_WRITE = ACL_WRITE;
78
79 typedef struct {
80     PyObject_HEAD
81     acl_t acl;
82 #ifdef HAVE_LEVEL2
83     int entry_id;
84 #endif
85 } ACL_Object;
86
87 #ifdef HAVE_LEVEL2
88
89 typedef struct {
90     PyObject_HEAD
91     PyObject *parent_acl; /* The parent acl, so it won't run out on us */
92     acl_entry_t entry;
93 } Entry_Object;
94
95 typedef struct {
96     PyObject_HEAD
97     PyObject *parent_entry; /* The parent entry, so it won't run out on us */
98     acl_permset_t permset;
99 } Permset_Object;
100
101 #endif
102
103 /* Creation of a new ACL instance */
104 static PyObject* ACL_new(PyTypeObject* type, PyObject* args,
105                          PyObject *keywds) {
106     PyObject* newacl;
107
108     newacl = type->tp_alloc(type, 0);
109
110     if(newacl != NULL) {
111         ((ACL_Object*)newacl)->acl = NULL;
112 #ifdef HAVEL_LEVEL2
113         ((ACL_Object*)newacl)->entry_id = ACL_FIRST_ENTRY;
114 #endif
115     }
116
117     return newacl;
118 }
119
120 /* Initialization of a new ACL instance */
121 static int ACL_init(PyObject* obj, PyObject* args, PyObject *keywds) {
122     ACL_Object* self = (ACL_Object*) obj;
123 #ifdef HAVE_LINUX
124     static char *kwlist[] = { "file", "fd", "text", "acl", "filedef",
125                               "mode", NULL };
126     char *format = "|etisO!si";
127     int mode = -1;
128 #else
129     static char *kwlist[] = { "file", "fd", "text", "acl", "filedef", NULL };
130     char *format = "|etisO!s";
131 #endif
132     char *file = NULL;
133     char *filedef = NULL;
134     char *text = NULL;
135     int fd = -1;
136     ACL_Object* thesrc = NULL;
137
138     if(!PyTuple_Check(args) || PyTuple_Size(args) != 0 ||
139        (keywds != NULL && PyDict_Check(keywds) && PyDict_Size(keywds) > 1)) {
140         PyErr_SetString(PyExc_ValueError, "a max of one keyword argument"
141                         " must be passed");
142         return -1;
143     }
144     if(!PyArg_ParseTupleAndKeywords(args, keywds, format, kwlist,
145                                     NULL, &file, &fd, &text, &ACL_Type,
146                                     &thesrc, &filedef
147 #ifdef HAVE_LINUX
148                                     , &mode
149 #endif
150                                     ))
151         return -1;
152
153     /* Free the old acl_t without checking for error, we don't
154      * care right now */
155     if(self->acl != NULL)
156         acl_free(self->acl);
157
158     if(file != NULL)
159         self->acl = acl_get_file(file, ACL_TYPE_ACCESS);
160     else if(text != NULL)
161         self->acl = acl_from_text(text);
162     else if(fd != -1)
163         self->acl = acl_get_fd(fd);
164     else if(thesrc != NULL)
165         self->acl = acl_dup(thesrc->acl);
166     else if(filedef != NULL)
167         self->acl = acl_get_file(filedef, ACL_TYPE_DEFAULT);
168 #ifdef HAVE_LINUX
169     else if(mode != -1)
170         self->acl = acl_from_mode(mode);
171 #endif
172     else
173         self->acl = acl_init(0);
174
175     if(self->acl == NULL) {
176         PyErr_SetFromErrno(PyExc_IOError);
177         return -1;
178     }
179
180     return 0;
181 }
182
183 /* Standard type functions */
184 static void ACL_dealloc(PyObject* obj) {
185     ACL_Object *self = (ACL_Object*) obj;
186     PyObject *err_type, *err_value, *err_traceback;
187     int have_error = PyErr_Occurred() ? 1 : 0;
188
189     if (have_error)
190         PyErr_Fetch(&err_type, &err_value, &err_traceback);
191     if(self->acl != NULL && acl_free(self->acl) != 0)
192         PyErr_WriteUnraisable(obj);
193     if (have_error)
194         PyErr_Restore(err_type, err_value, err_traceback);
195     PyObject_DEL(self);
196 }
197
198 /* Converts the acl to a text format */
199 static PyObject* ACL_str(PyObject *obj) {
200     char *text;
201     ACL_Object *self = (ACL_Object*) obj;
202     PyObject *ret;
203
204     text = acl_to_text(self->acl, NULL);
205     if(text == NULL) {
206         return PyErr_SetFromErrno(PyExc_IOError);
207     }
208     ret = PyUnicode_FromString(text);
209     if(acl_free(text) != 0) {
210         Py_XDECREF(ret);
211         return PyErr_SetFromErrno(PyExc_IOError);
212     }
213     return ret;
214 }
215
216 #ifdef HAVE_LINUX
217 static char __to_any_text_doc__[] =
218   "to_any_text([prefix='', separator='n', options=0])\n"
219   "Convert the ACL to a custom text format.\n"
220   "\n"
221   "This method encapsulates the ``acl_to_any_text()`` function.\n"
222   "It allows a customized text format to be generated for the ACL. See\n"
223   ":manpage:`acl_to_any_text(3)` for more details.\n"
224   "\n"
225   ":param string prefix: if given, this string will be pre-pended to\n"
226   "   all lines\n"
227   ":param string separator: a single character (defaults to '\\n'); this will"
228     " be used to separate the entries in the ACL\n"
229   ":param options: a bitwise combination of:\n\n"
230   "    - :py:data:`TEXT_ABBREVIATE`: use 'u' instead of 'user', 'g' \n"
231   "      instead of 'group', etc.\n"
232   "    - :py:data:`TEXT_NUMERIC_IDS`: User and group IDs are included as\n"
233   "      decimal numbers instead of names\n"
234   "    - :py:data:`TEXT_SOME_EFFECTIVE`: Include comments denoting the\n"
235   "      effective permissions when some are masked\n"
236   "    - :py:data:`TEXT_ALL_EFFECTIVE`: Include comments after all ACL\n"
237   "      entries affected by an ACL_MASK entry\n"
238   "    - :py:data:`TEXT_SMART_INDENT`: Used in combination with the\n"
239   "      _EFFECTIVE options, this will ensure that comments are aligned\n"
240   "      to the fourth tab position (assuming one tab equals eight spaces)\n"
241   ":rtype: string\n"
242   ;
243
244 /* Converts the acl to a custom text format */
245 static PyObject* ACL_to_any_text(PyObject *obj, PyObject *args,
246                                  PyObject *kwds) {
247     char *text;
248     ACL_Object *self = (ACL_Object*) obj;
249     PyObject *ret;
250     const char *arg_prefix = NULL;
251     char arg_separator = '\n';
252     int arg_options = 0;
253     static char *kwlist[] = {"prefix", "separator", "options", NULL};
254
255     if (!PyArg_ParseTupleAndKeywords(args, kwds, "|sci", kwlist, &arg_prefix,
256                                      &arg_separator, &arg_options))
257       return NULL;
258
259     text = acl_to_any_text(self->acl, arg_prefix, arg_separator, arg_options);
260     if(text == NULL) {
261         return PyErr_SetFromErrno(PyExc_IOError);
262     }
263     ret = PyBytes_FromString(text);
264     if(acl_free(text) != 0) {
265         Py_XDECREF(ret);
266         return PyErr_SetFromErrno(PyExc_IOError);
267     }
268     return ret;
269 }
270
271 static char __check_doc__[] =
272     "Check the ACL validity.\n"
273     "\n"
274     "This is a non-portable, Linux specific extension that allow more\n"
275     "information to be retrieved in case an ACL is not valid than via the\n"
276     ":py:func:`valid` method.\n"
277     "\n"
278     "This method will return either False (the ACL is valid), or a tuple\n"
279     "with two elements. The first element is one of the following\n"
280     "constants:\n\n"
281     "  - :py:data:`ACL_MULTI_ERROR`: The ACL contains multiple entries that\n"
282     "    have a tag type that may occur at most once\n"
283     "  - :py:data:`ACL_DUPLICATE_ERROR`: The ACL contains multiple \n"
284     "    :py:data:`ACL_USER` or :py:data:`ACL_GROUP` entries with the\n"
285     "    same ID\n"
286     "  - :py:data:`ACL_MISS_ERROR`: A required entry is missing\n"
287     "  - :py:data:`ACL_ENTRY_ERROR`: The ACL contains an invalid entry\n"
288     "    tag type\n"
289     "\n"
290     "The second element of the tuple is the index of the entry that is\n"
291     "invalid (in the same order as by iterating over the ACL entry)\n"
292     ;
293
294 /* The acl_check method */
295 static PyObject* ACL_check(PyObject* obj, PyObject* args) {
296     ACL_Object *self = (ACL_Object*) obj;
297     int result;
298     int eindex;
299
300     if((result = acl_check(self->acl, &eindex)) == -1)
301         return PyErr_SetFromErrno(PyExc_IOError);
302     if(result == 0) {
303         Py_RETURN_FALSE;
304     }
305     return Py_BuildValue("(ii)", result, eindex);
306 }
307
308 /* Implementation of the rich compare for ACLs */
309 static PyObject* ACL_richcompare(PyObject* o1, PyObject* o2, int op) {
310     ACL_Object *acl1, *acl2;
311     int n;
312     PyObject *ret;
313
314     if(!PyObject_IsInstance(o2, (PyObject*)&ACL_Type)) {
315         if(op == Py_EQ)
316             Py_RETURN_FALSE;
317         if(op == Py_NE)
318             Py_RETURN_TRUE;
319         PyErr_SetString(PyExc_TypeError, "can only compare to an ACL");
320         return NULL;
321     }
322
323     acl1 = (ACL_Object*)o1;
324     acl2 = (ACL_Object*)o2;
325     if((n=acl_cmp(acl1->acl, acl2->acl))==-1)
326         return PyErr_SetFromErrno(PyExc_IOError);
327     switch(op) {
328     case Py_EQ:
329         ret = n == 0 ? Py_True : Py_False;
330         break;
331     case Py_NE:
332         ret = n == 1 ? Py_True : Py_False;
333         break;
334     default:
335         PyErr_SetString(PyExc_TypeError, "ACLs are not orderable");
336         return NULL;
337     }
338     Py_INCREF(ret);
339     return ret;
340 }
341
342 static char __equiv_mode_doc__[] =
343     "Return the octal mode the ACL is equivalent to.\n"
344     "\n"
345     "This is a non-portable, Linux specific extension that checks\n"
346     "if the ACL is a basic ACL and returns the corresponding mode.\n"
347     "\n"
348     ":rtype: integer\n"
349     ":raise IOError: An IOerror exception will be raised if the ACL is\n"
350     "    an extended ACL.\n"
351     ;
352
353 /* The acl_equiv_mode method */
354 static PyObject* ACL_equiv_mode(PyObject* obj, PyObject* args) {
355     ACL_Object *self = (ACL_Object*) obj;
356     mode_t mode;
357
358     if(acl_equiv_mode(self->acl, &mode) == -1)
359         return PyErr_SetFromErrno(PyExc_IOError);
360     return PyLong_FromLong(mode);
361 }
362 #endif
363
364 /* Custom methods */
365 static char __applyto_doc__[] =
366     "applyto(item[, flag=ACL_TYPE_ACCESS])\n"
367     "Apply the ACL to a file or filehandle.\n"
368     "\n"
369     ":param item: either a filename or a file-like object or an integer;\n"
370     "    this represents the filesystem object on which to act\n"
371     ":param flag: optional flag representing the type of ACL to set, either\n"
372     "    :py:data:`ACL_TYPE_ACCESS` (default) or :py:data:`ACL_TYPE_DEFAULT`\n"
373     ;
374
375 /* Applies the ACL to a file */
376 static PyObject* ACL_applyto(PyObject* obj, PyObject* args) {
377     ACL_Object *self = (ACL_Object*) obj;
378     PyObject *target, *tmp;
379     acl_type_t type = ACL_TYPE_ACCESS;
380     int nret;
381     int fd;
382
383     if (!PyArg_ParseTuple(args, "O|I", &target, &type))
384         return NULL;
385     if ((fd = PyObject_AsFileDescriptor(target)) != -1) {
386         if((nret = acl_set_fd(fd, self->acl)) == -1) {
387           PyErr_SetFromErrno(PyExc_IOError);
388         }
389     } else {
390       // PyObject_AsFileDescriptor sets an error when failing, so clear
391       // it such that further code works; some method lookups fail if an
392       // error already occured when called, which breaks at least
393       // PyOS_FSPath (called by FSConverter).
394       PyErr_Clear();
395       if(PyUnicode_FSConverter(target, &tmp)) {
396         char *filename = PyBytes_AS_STRING(tmp);
397         if ((nret = acl_set_file(filename, type, self->acl)) == -1) {
398             PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
399         }
400         Py_DECREF(tmp);
401       } else {
402         nret = -1;
403       }
404     }
405     if (nret < 0) {
406         return NULL;
407     } else {
408         Py_INCREF(Py_None);
409         return Py_None;
410     }
411 }
412
413 static char __valid_doc__[] =
414     "Test the ACL for validity.\n"
415     "\n"
416     "This method tests the ACL to see if it is a valid ACL\n"
417     "in terms of the file-system. More precisely, it checks that:\n"
418     "\n"
419     "The ACL contains exactly one entry with each of the\n"
420     ":py:data:`ACL_USER_OBJ`, :py:data:`ACL_GROUP_OBJ`, and \n"
421     ":py:data:`ACL_OTHER` tag types. Entries\n"
422     "with :py:data:`ACL_USER` and :py:data:`ACL_GROUP` tag types may\n"
423     "appear zero or more\n"
424     "times in an ACL. An ACL that contains entries of :py:data:`ACL_USER` or\n"
425     ":py:data:`ACL_GROUP` tag types must contain exactly one entry of the \n"
426     ":py:data:`ACL_MASK` tag type. If an ACL contains no entries of\n"
427     ":py:data:`ACL_USER` or :py:data:`ACL_GROUP` tag types, the\n"
428     ":py:data:`ACL_MASK` entry is optional.\n"
429     "\n"
430     "All user ID qualifiers must be unique among all entries of\n"
431     "the :py:data:`ACL_USER` tag type, and all group IDs must be unique\n"
432     "among all entries of :py:data:`ACL_GROUP` tag type.\n"
433     "\n"
434     "The method will return 1 for a valid ACL and 0 for an invalid one.\n"
435     "This has been chosen because the specification for\n"
436     ":manpage:`acl_valid(3)`\n"
437     "in the POSIX.1e standard documents only one possible value for errno\n"
438     "in case of an invalid ACL, so we can't differentiate between\n"
439     "classes of errors. Other suggestions are welcome.\n"
440     "\n"
441     ":return: 0 or 1\n"
442     ":rtype: integer\n"
443     ;
444
445 /* Checks the ACL for validity */
446 static PyObject* ACL_valid(PyObject* obj, PyObject* args) {
447     ACL_Object *self = (ACL_Object*) obj;
448
449     if(acl_valid(self->acl) == -1) {
450         Py_RETURN_FALSE;
451     } else {
452         Py_RETURN_TRUE;
453     }
454 }
455
456 #ifdef HAVE_ACL_COPY_EXT
457 static PyObject* ACL_get_state(PyObject *obj, PyObject* args) {
458     ACL_Object *self = (ACL_Object*) obj;
459     PyObject *ret;
460     ssize_t size, nsize;
461     char *buf;
462
463     size = acl_size(self->acl);
464     if(size == -1)
465         return PyErr_SetFromErrno(PyExc_IOError);
466
467     if((ret = PyBytes_FromStringAndSize(NULL, size)) == NULL)
468         return NULL;
469     buf = PyBytes_AsString(ret);
470
471     if((nsize = acl_copy_ext(buf, self->acl, size)) == -1) {
472         Py_DECREF(ret);
473         return PyErr_SetFromErrno(PyExc_IOError);
474     }
475
476     return ret;
477 }
478
479 static PyObject* ACL_set_state(PyObject *obj, PyObject* args) {
480     ACL_Object *self = (ACL_Object*) obj;
481     const void *buf;
482     int bufsize;
483     acl_t ptr;
484
485     /* Parse the argument */
486     if (!PyArg_ParseTuple(args, "s#", &buf, &bufsize))
487         return NULL;
488
489     /* Try to import the external representation */
490     if((ptr = acl_copy_int(buf)) == NULL)
491         return PyErr_SetFromErrno(PyExc_IOError);
492
493     /* Free the old acl. Should we ignore errors here? */
494     if(self->acl != NULL) {
495         if(acl_free(self->acl) == -1)
496             return PyErr_SetFromErrno(PyExc_IOError);
497     }
498
499     self->acl = ptr;
500
501     /* Return the result */
502     Py_INCREF(Py_None);
503     return Py_None;
504 }
505 #endif
506
507 #ifdef HAVE_LEVEL2
508
509 /* tp_iter for the ACL type; since it can be iterated only
510  * destructively, the type is its iterator
511  */
512 static PyObject* ACL_iter(PyObject *obj) {
513     ACL_Object *self = (ACL_Object*)obj;
514     self->entry_id = ACL_FIRST_ENTRY;
515     Py_INCREF(obj);
516     return obj;
517 }
518
519 /* the tp_iternext function for the ACL type */
520 static PyObject* ACL_iternext(PyObject *obj) {
521     ACL_Object *self = (ACL_Object*)obj;
522     acl_entry_t the_entry_t;
523     Entry_Object *the_entry_obj;
524     int nerr;
525
526     nerr = acl_get_entry(self->acl, self->entry_id, &the_entry_t);
527     self->entry_id = ACL_NEXT_ENTRY;
528     if(nerr == -1)
529         return PyErr_SetFromErrno(PyExc_IOError);
530     else if(nerr == 0) {
531         /* Docs says this is not needed */
532         /*PyErr_SetObject(PyExc_StopIteration, Py_None);*/
533         return NULL;
534     }
535
536     the_entry_obj = (Entry_Object*) PyType_GenericNew(&Entry_Type, NULL, NULL);
537     if(the_entry_obj == NULL)
538         return NULL;
539
540     the_entry_obj->entry = the_entry_t;
541
542     the_entry_obj->parent_acl = obj;
543     Py_INCREF(obj); /* For the reference we have in entry->parent */
544
545     return (PyObject*)the_entry_obj;
546 }
547
548 static char __ACL_delete_entry_doc__[] =
549     "delete_entry(entry)\n"
550     "Deletes an entry from the ACL.\n"
551     "\n"
552     ".. note:: Only available with level 2.\n"
553     "\n"
554     ":param entry: the Entry object which should be deleted; note that after\n"
555     "    this function is called, that object is unusable any longer\n"
556     "    and should be deleted\n"
557     ;
558
559 /* Deletes an entry from the ACL */
560 static PyObject* ACL_delete_entry(PyObject *obj, PyObject *args) {
561     ACL_Object *self = (ACL_Object*)obj;
562     Entry_Object *e;
563
564     if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &e))
565         return NULL;
566
567     if(acl_delete_entry(self->acl, e->entry) == -1)
568         return PyErr_SetFromErrno(PyExc_IOError);
569
570     /* Return the result */
571     Py_INCREF(Py_None);
572     return Py_None;
573 }
574
575 static char __ACL_calc_mask_doc__[] =
576     "Compute the file group class mask.\n"
577     "\n"
578     "The calc_mask() method calculates and sets the permissions \n"
579     "associated with the :py:data:`ACL_MASK` Entry of the ACL.\n"
580     "The value of the new permissions is the union of the permissions \n"
581     "granted by all entries of tag type :py:data:`ACL_GROUP`, \n"
582     ":py:data:`ACL_GROUP_OBJ`, or \n"
583     ":py:data:`ACL_USER`. If the ACL already contains an :py:data:`ACL_MASK`\n"
584     "entry, its \n"
585     "permissions are overwritten; if it does not contain an \n"
586     ":py:data:`ACL_MASK` Entry, one is added.\n"
587     "\n"
588     "The order of existing entries in the ACL is undefined after this \n"
589     "function.\n"
590     ;
591
592 /* Updates the mask entry in the ACL */
593 static PyObject* ACL_calc_mask(PyObject *obj, PyObject *args) {
594     ACL_Object *self = (ACL_Object*)obj;
595
596     if(acl_calc_mask(&self->acl) == -1)
597         return PyErr_SetFromErrno(PyExc_IOError);
598
599     /* Return the result */
600     Py_INCREF(Py_None);
601     return Py_None;
602 }
603
604 static char __ACL_append_doc__[] =
605     "append([entry])\n"
606     "Append a new Entry to the ACL and return it.\n"
607     "\n"
608     "This is a convenience function to create a new Entry \n"
609     "and append it to the ACL.\n"
610     "If a parameter of type Entry instance is given, the \n"
611     "entry will be a copy of that one (as if copied with \n"
612     ":py:func:`Entry.copy`), otherwise, the new entry will be empty.\n"
613     "\n"
614     ":rtype: :py:class:`Entry`\n"
615     ":returns: the newly created entry\n"
616     ;
617
618 /* Convenience method to create a new Entry */
619 static PyObject* ACL_append(PyObject *obj, PyObject *args) {
620     ACL_Object* self = (ACL_Object*) obj;
621     Entry_Object* newentry;
622     Entry_Object* oldentry = NULL;
623     int nret;
624
625     newentry = (Entry_Object*)PyType_GenericNew(&Entry_Type, NULL, NULL);
626     if(newentry == NULL) {
627         return NULL;
628     }
629
630     if (!PyArg_ParseTuple(args, "|O!", &Entry_Type, &oldentry)) {
631         Py_DECREF(newentry);
632         return NULL;
633     }
634
635     nret = acl_create_entry(&self->acl, &newentry->entry);
636     if(nret == -1) {
637         Py_DECREF(newentry);
638         return PyErr_SetFromErrno(PyExc_IOError);
639     }
640
641     if(oldentry != NULL) {
642         nret = acl_copy_entry(newentry->entry, oldentry->entry);
643         if(nret == -1) {
644             Py_DECREF(newentry);
645             return PyErr_SetFromErrno(PyExc_IOError);
646         }
647     }
648
649     newentry->parent_acl = obj;
650     Py_INCREF(obj);
651
652     return (PyObject*)newentry;
653 }
654
655 /***** Entry type *****/
656
657 typedef struct {
658     acl_tag_t tag;
659     union {
660         uid_t uid;
661         gid_t gid;
662     };
663 } tag_qual;
664
665 /* Pre-declaring the function is more friendly to cpychecker, sigh. */
666 static int get_tag_qualifier(acl_entry_t entry, tag_qual *tq)
667   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
668
669 /* Helper function to get the tag and qualifier of an Entry at the
670    same time. This is "needed" because the acl_get_qualifier function
671    returns a pointer to different types, based on the tag value, and
672    thus it's not straightforward to get the right type.
673
674    It sets a Python exception if an error occurs, and returns -1 in
675    this case. If successful, the tag is set to the tag type, the
676    qualifier (if any) to either the uid or the gid entry in the
677    tag_qual structure, and the return value is 0.
678 */
679 static int get_tag_qualifier(acl_entry_t entry, tag_qual *tq) {
680     void *p;
681
682     if(acl_get_tag_type(entry, &tq->tag) == -1) {
683         PyErr_SetFromErrno(PyExc_IOError);
684         return -1;
685     }
686     if (tq->tag == ACL_USER || tq->tag == ACL_GROUP) {
687         if((p = acl_get_qualifier(entry)) == NULL) {
688             PyErr_SetFromErrno(PyExc_IOError);
689             return -1;
690         }
691         if (tq->tag == ACL_USER) {
692             tq->uid = *(uid_t*)p;
693         } else {
694             tq->gid = *(gid_t*)p;
695         }
696         acl_free(p);
697     }
698     return 0;
699 }
700
701 #define ENTRY_SET_CHECK(self, attr, value)         \
702     if (value == NULL) { \
703         PyErr_SetString(PyExc_TypeError, \
704                         attr " deletion is not supported"); \
705         return -1; \
706     }
707
708 /* Creation of a new Entry instance */
709 static PyObject* Entry_new(PyTypeObject* type, PyObject* args,
710                            PyObject *keywds) {
711     PyObject* newentry;
712     Entry_Object* entry;
713     ACL_Object* parent = NULL;
714
715     if (!PyArg_ParseTuple(args, "O!", &ACL_Type, &parent))
716         return NULL;
717
718     newentry = PyType_GenericNew(type, args, keywds);
719
720     if(newentry == NULL) {
721         return NULL;
722     }
723
724     entry = (Entry_Object*)newentry;
725
726     if(acl_create_entry(&parent->acl, &entry->entry) == -1) {
727         PyErr_SetFromErrno(PyExc_IOError);
728         Py_DECREF(newentry);
729         return NULL;
730     }
731     Py_INCREF(parent);
732     entry->parent_acl = (PyObject*)parent;
733     return newentry;
734 }
735
736 /* Initialization of a new Entry instance */
737 static int Entry_init(PyObject* obj, PyObject* args, PyObject *keywds) {
738     Entry_Object* self = (Entry_Object*) obj;
739     ACL_Object* parent = NULL;
740
741     if (!PyArg_ParseTuple(args, "O!", &ACL_Type, &parent))
742         return -1;
743
744     if ((PyObject*)parent != self->parent_acl) {
745         PyErr_SetString(PyExc_ValueError,
746                         "Can't reinitialize with a different parent");
747         return -1;
748     }
749     return 0;
750 }
751
752 /* Free the Entry instance */
753 static void Entry_dealloc(PyObject* obj) {
754     Entry_Object *self = (Entry_Object*) obj;
755     PyObject *err_type, *err_value, *err_traceback;
756     int have_error = PyErr_Occurred() ? 1 : 0;
757
758     if (have_error)
759         PyErr_Fetch(&err_type, &err_value, &err_traceback);
760     if(self->parent_acl != NULL) {
761         Py_DECREF(self->parent_acl);
762         self->parent_acl = NULL;
763     }
764     if (have_error)
765         PyErr_Restore(err_type, err_value, err_traceback);
766     PyObject_DEL(self);
767 }
768
769 /* Converts the entry to a text format */
770 static PyObject* Entry_str(PyObject *obj) {
771     PyObject *format, *kind;
772     Entry_Object *self = (Entry_Object*) obj;
773     tag_qual tq;
774
775     if(get_tag_qualifier(self->entry, &tq) < 0) {
776         return NULL;
777     }
778
779     format = PyUnicode_FromString("ACL entry for ");
780     if(format == NULL)
781         return NULL;
782     switch(tq.tag) {
783     case ACL_UNDEFINED_TAG:
784         kind = PyUnicode_FromString("undefined type");
785         break;
786     case ACL_USER_OBJ:
787         kind = PyUnicode_FromString("the owner");
788         break;
789     case ACL_GROUP_OBJ:
790         kind = PyUnicode_FromString("the group");
791         break;
792     case ACL_OTHER:
793         kind = PyUnicode_FromString("the others");
794         break;
795     case ACL_USER:
796         /* FIXME: here and in the group case, we're formatting with
797            unsigned, because there's no way to automatically determine
798            the signed-ness of the types; on Linux(glibc) they're
799            unsigned, so we'll go along with that */
800         kind = PyUnicode_FromFormat("user with uid %u", tq.uid);
801         break;
802     case ACL_GROUP:
803         kind = PyUnicode_FromFormat("group with gid %u", tq.gid);
804         break;
805     case ACL_MASK:
806         kind = PyUnicode_FromString("the mask");
807         break;
808     default:
809         kind = PyUnicode_FromString("UNKNOWN_TAG_TYPE!");
810         break;
811     }
812     if (kind == NULL) {
813         Py_DECREF(format);
814         return NULL;
815     }
816     PyObject *ret = PyUnicode_Concat(format, kind);
817     Py_DECREF(format);
818     Py_DECREF(kind);
819     return ret;
820 }
821
822 /* Sets the tag type of the entry */
823 static int Entry_set_tag_type(PyObject* obj, PyObject* value, void* arg) {
824     Entry_Object *self = (Entry_Object*) obj;
825
826     ENTRY_SET_CHECK(self, "tag type", value);
827
828     if(!PyLong_Check(value)) {
829         PyErr_SetString(PyExc_TypeError,
830                         "tag type must be integer");
831         return -1;
832     }
833     if(acl_set_tag_type(self->entry, (acl_tag_t)PyLong_AsLong(value)) == -1) {
834         PyErr_SetFromErrno(PyExc_IOError);
835         return -1;
836     }
837
838     return 0;
839 }
840
841 /* Returns the tag type of the entry */
842 static PyObject* Entry_get_tag_type(PyObject *obj, void* arg) {
843     Entry_Object *self = (Entry_Object*) obj;
844     acl_tag_t value;
845
846     if(acl_get_tag_type(self->entry, &value) == -1) {
847         PyErr_SetFromErrno(PyExc_IOError);
848         return NULL;
849     }
850
851     return PyLong_FromLong(value);
852 }
853
854 /* Sets the qualifier (either uid_t or gid_t) for the entry,
855  * usable only if the tag type if ACL_USER or ACL_GROUP
856  */
857 static int Entry_set_qualifier(PyObject* obj, PyObject* value, void* arg) {
858     Entry_Object *self = (Entry_Object*) obj;
859     long uidgid;
860     uid_t uid;
861     gid_t gid;
862     void *p;
863     acl_tag_t tag;
864
865     ENTRY_SET_CHECK(self, "qualifier", value);
866
867     if(!PyLong_Check(value)) {
868         PyErr_SetString(PyExc_TypeError,
869                         "qualifier must be integer");
870         return -1;
871     }
872     if((uidgid = PyLong_AsLong(value)) == -1) {
873         if(PyErr_Occurred() != NULL) {
874             return -1;
875         }
876     }
877     /* Due to how acl_set_qualifier takes its argument, we have to do
878        this ugly dance with two variables and a pointer that will
879        point to one of them. */
880     if(acl_get_tag_type(self->entry, &tag) == -1) {
881         PyErr_SetFromErrno(PyExc_IOError);
882         return -1;
883     }
884     uid = uidgid;
885     gid = uidgid;
886     switch(tag) {
887     case ACL_USER:
888       if((long)uid != uidgid) {
889         PyErr_SetString(PyExc_OverflowError, "Can't assign given qualifier");
890         return -1;
891       } else {
892         p = &uid;
893       }
894       break;
895     case ACL_GROUP:
896       if((long)gid != uidgid) {
897         PyErr_SetString(PyExc_OverflowError, "Can't assign given qualifier");
898         return -1;
899       } else {
900         p = &gid;
901       }
902       break;
903     default:
904       PyErr_SetString(PyExc_TypeError,
905                       "Can only set qualifiers on ACL_USER or ACL_GROUP entries");
906       return -1;
907     }
908     if(acl_set_qualifier(self->entry, p) == -1) {
909         PyErr_SetFromErrno(PyExc_IOError);
910         return -1;
911     }
912
913     return 0;
914 }
915
916 /* Returns the qualifier of the entry */
917 static PyObject* Entry_get_qualifier(PyObject *obj, void* arg) {
918     Entry_Object *self = (Entry_Object*) obj;
919     long value;
920     tag_qual tq;
921
922     if (self->entry == NULL) {
923         PyErr_SetString(PyExc_ValueError, "Can't get qualifier on uninitalized Entry object");
924         return NULL;
925     }
926     if(get_tag_qualifier(self->entry, &tq) < 0) {
927         return NULL;
928     }
929     if (tq.tag == ACL_USER) {
930         value = tq.uid;
931     } else if (tq.tag == ACL_GROUP) {
932         value = tq.gid;
933     } else {
934         PyErr_SetString(PyExc_TypeError,
935                         "Given entry doesn't have an user or"
936                         " group tag");
937         return NULL;
938     }
939     return PyLong_FromLong(value);
940 }
941
942 /* Returns the parent ACL of the entry */
943 static PyObject* Entry_get_parent(PyObject *obj, void* arg) {
944     Entry_Object *self = (Entry_Object*) obj;
945
946     Py_INCREF(self->parent_acl);
947     return self->parent_acl;
948 }
949
950 /* Returns the a new Permset representing the permset of the entry
951  * FIXME: Should return a new reference to the same object, which
952  * should be created at init time!
953  */
954 static PyObject* Entry_get_permset(PyObject *obj, void* arg) {
955     PyObject *p;
956
957     PyObject *perm_arglist = Py_BuildValue("(O)", obj);
958     if (perm_arglist == NULL) {
959         return NULL;
960     }
961     p = PyObject_CallObject((PyObject*)&Permset_Type, perm_arglist);
962     Py_DECREF(perm_arglist);
963     return p;
964 }
965
966 /* Sets the permset of the entry to the passed Permset */
967 static int Entry_set_permset(PyObject* obj, PyObject* value, void* arg) {
968     Entry_Object *self = (Entry_Object*)obj;
969     Permset_Object *p;
970
971     ENTRY_SET_CHECK(self, "permset", value);
972
973     if(!PyObject_IsInstance(value, (PyObject*)&Permset_Type)) {
974         PyErr_SetString(PyExc_TypeError, "argument 1 must be posix1e.Permset");
975         return -1;
976     }
977     p = (Permset_Object*)value;
978     if(acl_set_permset(self->entry, p->permset) == -1) {
979         PyErr_SetFromErrno(PyExc_IOError);
980         return -1;
981     }
982     return 0;
983 }
984
985 static char __Entry_copy_doc__[] =
986     "copy(src)\n"
987     "Copies an ACL entry.\n"
988     "\n"
989     "This method sets all the parameters to those of another\n"
990     "entry (either of the same ACL or belonging to another ACL).\n"
991     "\n"
992     ":param Entry src: instance of type Entry\n"
993     ;
994
995 /* Sets all the entry parameters to another entry */
996 static PyObject* Entry_copy(PyObject *obj, PyObject *args) {
997     Entry_Object *self = (Entry_Object*)obj;
998     Entry_Object *other;
999
1000     if(!PyArg_ParseTuple(args, "O!", &Entry_Type, &other))
1001         return NULL;
1002
1003     if(acl_copy_entry(self->entry, other->entry) == -1)
1004         return PyErr_SetFromErrno(PyExc_IOError);
1005
1006     Py_INCREF(Py_None);
1007     return Py_None;
1008 }
1009
1010 /**** Permset type *****/
1011
1012 /* Creation of a new Permset instance */
1013 static PyObject* Permset_new(PyTypeObject* type, PyObject* args,
1014                              PyObject *keywds) {
1015     PyObject* newpermset;
1016     Permset_Object* permset;
1017     Entry_Object* parent = NULL;
1018
1019     if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &parent)) {
1020         return NULL;
1021     }
1022
1023     newpermset = PyType_GenericNew(type, args, keywds);
1024
1025     if(newpermset == NULL) {
1026         return NULL;
1027     }
1028
1029     permset = (Permset_Object*)newpermset;
1030
1031     if(acl_get_permset(parent->entry, &permset->permset) == -1) {
1032         PyErr_SetFromErrno(PyExc_IOError);
1033         Py_DECREF(newpermset);
1034         return NULL;
1035     }
1036
1037     permset->parent_entry = (PyObject*)parent;
1038     Py_INCREF(parent);
1039
1040     return newpermset;
1041 }
1042
1043 /* Initialization of a new Permset instance */
1044 static int Permset_init(PyObject* obj, PyObject* args, PyObject *keywds) {
1045     Permset_Object* self = (Permset_Object*) obj;
1046     Entry_Object* parent = NULL;
1047
1048     if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &parent))
1049         return -1;
1050
1051     if ((PyObject*)parent != self->parent_entry) {
1052         PyErr_SetString(PyExc_ValueError,
1053                         "Can't reinitialize with a different parent");
1054         return -1;
1055     }
1056
1057     return 0;
1058 }
1059
1060 /* Free the Permset instance */
1061 static void Permset_dealloc(PyObject* obj) {
1062     Permset_Object *self = (Permset_Object*) obj;
1063     PyObject *err_type, *err_value, *err_traceback;
1064     int have_error = PyErr_Occurred() ? 1 : 0;
1065
1066     if (have_error)
1067         PyErr_Fetch(&err_type, &err_value, &err_traceback);
1068     if(self->parent_entry != NULL) {
1069         Py_DECREF(self->parent_entry);
1070         self->parent_entry = NULL;
1071     }
1072     if (have_error)
1073         PyErr_Restore(err_type, err_value, err_traceback);
1074     PyObject_DEL(self);
1075 }
1076
1077 /* Permset string representation */
1078 static PyObject* Permset_str(PyObject *obj) {
1079     Permset_Object *self = (Permset_Object*) obj;
1080     char pstr[3];
1081
1082     pstr[0] = get_perm(self->permset, ACL_READ) ? 'r' : '-';
1083     pstr[1] = get_perm(self->permset, ACL_WRITE) ? 'w' : '-';
1084     pstr[2] = get_perm(self->permset, ACL_EXECUTE) ? 'x' : '-';
1085     return PyUnicode_FromStringAndSize(pstr, 3);
1086 }
1087
1088 static char __Permset_clear_doc__[] =
1089     "Clears all permissions from the permission set.\n"
1090     ;
1091
1092 /* Clears all permissions from the permset */
1093 static PyObject* Permset_clear(PyObject* obj, PyObject* args) {
1094     Permset_Object *self = (Permset_Object*) obj;
1095
1096     if(acl_clear_perms(self->permset) == -1)
1097         return PyErr_SetFromErrno(PyExc_IOError);
1098
1099     /* Return the result */
1100     Py_INCREF(Py_None);
1101     return Py_None;
1102 }
1103
1104 static PyObject* Permset_get_right(PyObject *obj, void* arg) {
1105     Permset_Object *self = (Permset_Object*) obj;
1106
1107     if(get_perm(self->permset, *(acl_perm_t*)arg)) {
1108         Py_RETURN_TRUE;
1109     } else {
1110         Py_RETURN_FALSE;
1111     }
1112 }
1113
1114 static int Permset_set_right(PyObject* obj, PyObject* value, void* arg) {
1115     Permset_Object *self = (Permset_Object*) obj;
1116     int on;
1117     int nerr;
1118
1119     if(!PyLong_Check(value)) {
1120         PyErr_SetString(PyExc_ValueError, "invalid argument, an integer"
1121                         " is expected");
1122         return -1;
1123     }
1124     on = PyLong_AsLong(value);
1125     if(on)
1126         nerr = acl_add_perm(self->permset, *(acl_perm_t*)arg);
1127     else
1128         nerr = acl_delete_perm(self->permset, *(acl_perm_t*)arg);
1129     if(nerr == -1) {
1130         PyErr_SetFromErrno(PyExc_IOError);
1131         return -1;
1132     }
1133     return 0;
1134 }
1135
1136 static char __Permset_add_doc__[] =
1137     "add(perm)\n"
1138     "Add a permission to the permission set.\n"
1139     "\n"
1140     "This function adds the permission contained in \n"
1141     "the argument perm to the permission set.  An attempt \n"
1142     "to add a permission that is already contained in the \n"
1143     "permission set is not considered an error.\n"
1144     "\n"
1145     ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1146     "   :py:data:`ACL_EXECUTE`, ...)\n"
1147     ":raises IOError: in case the argument is not a valid descriptor\n"
1148     ;
1149
1150 static PyObject* Permset_add(PyObject* obj, PyObject* args) {
1151     Permset_Object *self = (Permset_Object*) obj;
1152     int right;
1153
1154     if (!PyArg_ParseTuple(args, "i", &right))
1155         return NULL;
1156
1157     if(acl_add_perm(self->permset, (acl_perm_t) right) == -1)
1158         return PyErr_SetFromErrno(PyExc_IOError);
1159
1160     /* Return the result */
1161     Py_INCREF(Py_None);
1162     return Py_None;
1163 }
1164
1165 static char __Permset_delete_doc__[] =
1166     "delete(perm)\n"
1167     "Delete a permission from the permission set.\n"
1168     "\n"
1169     "This function deletes the permission contained in \n"
1170     "the argument perm from the permission set. An attempt \n"
1171     "to delete a permission that is not contained in the \n"
1172     "permission set is not considered an error.\n"
1173     "\n"
1174     ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1175     "   :py:data:`ACL_EXECUTE`, ...)\n"
1176     ":raises IOError: in case the argument is not a valid descriptor\n"
1177     ;
1178
1179 static PyObject* Permset_delete(PyObject* obj, PyObject* args) {
1180     Permset_Object *self = (Permset_Object*) obj;
1181     int right;
1182
1183     if (!PyArg_ParseTuple(args, "i", &right))
1184         return NULL;
1185
1186     if(acl_delete_perm(self->permset, (acl_perm_t) right) == -1)
1187         return PyErr_SetFromErrno(PyExc_IOError);
1188
1189     /* Return the result */
1190     Py_INCREF(Py_None);
1191     return Py_None;
1192 }
1193
1194 static char __Permset_test_doc__[] =
1195     "test(perm)\n"
1196     "Test if a permission exists in the permission set.\n"
1197     "\n"
1198     "The test() function tests if the permission represented by\n"
1199     "the argument perm exists in the permission set.\n"
1200     "\n"
1201     ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1202     "   :py:data:`ACL_EXECUTE`, ...)\n"
1203     ":rtype: Boolean\n"
1204     ":raises IOError: in case the argument is not a valid descriptor\n"
1205     ;
1206
1207 static PyObject* Permset_test(PyObject* obj, PyObject* args) {
1208     Permset_Object *self = (Permset_Object*) obj;
1209     int right;
1210     int ret;
1211
1212     if (!PyArg_ParseTuple(args, "i", &right))
1213         return NULL;
1214
1215     ret = get_perm(self->permset, (acl_perm_t) right);
1216     if(ret == -1)
1217         return PyErr_SetFromErrno(PyExc_IOError);
1218
1219     if(ret) {
1220         Py_RETURN_TRUE;
1221     } else {
1222         Py_RETURN_FALSE;
1223     }
1224 }
1225
1226 #endif
1227
1228 static char __ACL_Type_doc__[] =
1229     "Type which represents a POSIX ACL\n"
1230     "\n"
1231     ".. note:: only one keyword parameter should be provided\n"
1232     "\n"
1233     ":param string file: creates an ACL representing\n"
1234     "    the access ACL of the specified file.\n"
1235     ":param string filedef: creates an ACL representing\n"
1236     "    the default ACL of the given directory.\n"
1237     ":param int fd: creates an ACL representing\n"
1238     "    the access ACL of the given file descriptor.\n"
1239     ":param string text: creates an ACL from a \n"
1240     "    textual description; note the ACL must be valid, which\n"
1241     "    means including a mask for extended ACLs, similar to\n"
1242     "    ``setfacl --no-mask``\n"
1243     ":param ACL acl: creates a copy of an existing ACL instance.\n"
1244     ":param int mode: creates an ACL from a numeric mode\n"
1245     "    (e.g. ``mode=0644``); this is valid only when the C library\n"
1246     "    provides the ``acl_from_mode call``, and\n"
1247     "    note that no validation is done on the given value.\n"
1248     "\n"
1249     "If no parameters are passed, an empty ACL will be created; this\n"
1250     "makes sense only when your OS supports ACL modification\n"
1251     "(i.e. it implements full POSIX.1e support), otherwise the ACL won't\n"
1252     "be useful.\n"
1253     ;
1254
1255 /* ACL type methods */
1256 static PyMethodDef ACL_methods[] = {
1257     {"applyto", ACL_applyto, METH_VARARGS, __applyto_doc__},
1258     {"valid", ACL_valid, METH_NOARGS, __valid_doc__},
1259 #ifdef HAVE_LINUX
1260     {"to_any_text", (PyCFunction)ACL_to_any_text, METH_VARARGS | METH_KEYWORDS,
1261      __to_any_text_doc__},
1262     {"check", ACL_check, METH_NOARGS, __check_doc__},
1263     {"equiv_mode", ACL_equiv_mode, METH_NOARGS, __equiv_mode_doc__},
1264 #endif
1265 #ifdef HAVE_ACL_COPY_EXT
1266     {"__getstate__", ACL_get_state, METH_NOARGS,
1267      "Dumps the ACL to an external format."},
1268     {"__setstate__", ACL_set_state, METH_VARARGS,
1269      "Loads the ACL from an external format."},
1270 #endif
1271 #ifdef HAVE_LEVEL2
1272     {"delete_entry", ACL_delete_entry, METH_VARARGS, __ACL_delete_entry_doc__},
1273     {"calc_mask", ACL_calc_mask, METH_NOARGS, __ACL_calc_mask_doc__},
1274     {"append", ACL_append, METH_VARARGS, __ACL_append_doc__},
1275 #endif
1276     {NULL, NULL, 0, NULL}
1277 };
1278
1279
1280 /* The definition of the ACL Type */
1281 static PyTypeObject ACL_Type = {
1282     PyVarObject_HEAD_INIT(NULL, 0)
1283     "posix1e.ACL",
1284     sizeof(ACL_Object),
1285     0,
1286     ACL_dealloc,        /* tp_dealloc */
1287     0,                  /* tp_print */
1288     0,                  /* tp_getattr */
1289     0,                  /* tp_setattr */
1290     0,                  /* formerly tp_compare, in 3.0 deprecated, in
1291                            3.5 tp_as_async */
1292     0,                  /* tp_repr */
1293     0,                  /* tp_as_number */
1294     0,                  /* tp_as_sequence */
1295     0,                  /* tp_as_mapping */
1296     0,                  /* tp_hash */
1297     0,                  /* tp_call */
1298     ACL_str,            /* tp_str */
1299     0,                  /* tp_getattro */
1300     0,                  /* tp_setattro */
1301     0,                  /* tp_as_buffer */
1302     Py_TPFLAGS_DEFAULT, /* tp_flags */
1303     __ACL_Type_doc__,   /* tp_doc */
1304     0,                  /* tp_traverse */
1305     0,                  /* tp_clear */
1306 #ifdef HAVE_LINUX
1307     ACL_richcompare,    /* tp_richcompare */
1308 #else
1309     0,                  /* tp_richcompare */
1310 #endif
1311     0,                  /* tp_weaklistoffset */
1312 #ifdef HAVE_LEVEL2
1313     ACL_iter,
1314     ACL_iternext,
1315 #else
1316     0,                  /* tp_iter */
1317     0,                  /* tp_iternext */
1318 #endif
1319     ACL_methods,        /* tp_methods */
1320     0,                  /* tp_members */
1321     0,                  /* tp_getset */
1322     0,                  /* tp_base */
1323     0,                  /* tp_dict */
1324     0,                  /* tp_descr_get */
1325     0,                  /* tp_descr_set */
1326     0,                  /* tp_dictoffset */
1327     ACL_init,           /* tp_init */
1328     0,                  /* tp_alloc */
1329     ACL_new,            /* tp_new */
1330 };
1331
1332 #ifdef HAVE_LEVEL2
1333
1334 /* Entry type methods */
1335 static PyMethodDef Entry_methods[] = {
1336     {"copy", Entry_copy, METH_VARARGS, __Entry_copy_doc__},
1337     {NULL, NULL, 0, NULL}
1338 };
1339
1340 static char __Entry_tagtype_doc__[] =
1341     "The tag type of the current entry\n"
1342     "\n"
1343     "This is one of:\n"
1344     " - :py:data:`ACL_UNDEFINED_TAG`\n"
1345     " - :py:data:`ACL_USER_OBJ`\n"
1346     " - :py:data:`ACL_USER`\n"
1347     " - :py:data:`ACL_GROUP_OBJ`\n"
1348     " - :py:data:`ACL_GROUP`\n"
1349     " - :py:data:`ACL_MASK`\n"
1350     " - :py:data:`ACL_OTHER`\n"
1351     ;
1352
1353 static char __Entry_qualifier_doc__[] =
1354     "The qualifier of the current entry\n"
1355     "\n"
1356     "If the tag type is :py:data:`ACL_USER`, this should be a user id.\n"
1357     "If the tag type if :py:data:`ACL_GROUP`, this should be a group id.\n"
1358     "Else it doesn't matter.\n"
1359     ;
1360
1361 static char __Entry_parent_doc__[] =
1362     "The parent ACL of this entry\n"
1363     ;
1364
1365 static char __Entry_permset_doc__[] =
1366     "The permission set of this ACL entry\n"
1367     ;
1368
1369 /* Entry getset */
1370 static PyGetSetDef Entry_getsets[] = {
1371     {"tag_type", Entry_get_tag_type, Entry_set_tag_type,
1372      __Entry_tagtype_doc__},
1373     {"qualifier", Entry_get_qualifier, Entry_set_qualifier,
1374      __Entry_qualifier_doc__},
1375     {"parent", Entry_get_parent, NULL, __Entry_parent_doc__},
1376     {"permset", Entry_get_permset, Entry_set_permset, __Entry_permset_doc__},
1377     {NULL}
1378 };
1379
1380 static char __Entry_Type_doc__[] =
1381     "Type which represents an entry in an ACL.\n"
1382     "\n"
1383     "The type exists only if the OS has full support for POSIX.1e\n"
1384     "Can be created either by:\n"
1385     "\n"
1386     "  >>> e = posix1e.Entry(myACL) # this creates a new entry in the ACL\n"
1387     "  >>> e = myACL.append() # another way for doing the same thing\n"
1388     "\n"
1389     "or by:\n"
1390     "\n"
1391     "  >>> for entry in myACL:\n"
1392     "  ...     print entry\n"
1393     "\n"
1394     "Note that the Entry keeps a reference to its ACL, so even if \n"
1395     "you delete the ACL, it won't be cleaned up and will continue to \n"
1396     "exist until its Entry(ies) will be deleted.\n"
1397     ;
1398 /* The definition of the Entry Type */
1399 static PyTypeObject Entry_Type = {
1400     PyVarObject_HEAD_INIT(NULL, 0)
1401     "posix1e.Entry",
1402     sizeof(Entry_Object),
1403     0,
1404     Entry_dealloc,      /* tp_dealloc */
1405     0,                  /* tp_print */
1406     0,                  /* tp_getattr */
1407     0,                  /* tp_setattr */
1408     0,                  /* tp_compare */
1409     0,                  /* tp_repr */
1410     0,                  /* tp_as_number */
1411     0,                  /* tp_as_sequence */
1412     0,                  /* tp_as_mapping */
1413     0,                  /* tp_hash */
1414     0,                  /* tp_call */
1415     Entry_str,          /* tp_str */
1416     0,                  /* tp_getattro */
1417     0,                  /* tp_setattro */
1418     0,                  /* tp_as_buffer */
1419     Py_TPFLAGS_DEFAULT, /* tp_flags */
1420     __Entry_Type_doc__, /* tp_doc */
1421     0,                  /* tp_traverse */
1422     0,                  /* tp_clear */
1423     0,                  /* tp_richcompare */
1424     0,                  /* tp_weaklistoffset */
1425     0,                  /* tp_iter */
1426     0,                  /* tp_iternext */
1427     Entry_methods,      /* tp_methods */
1428     0,                  /* tp_members */
1429     Entry_getsets,      /* tp_getset */
1430     0,                  /* tp_base */
1431     0,                  /* tp_dict */
1432     0,                  /* tp_descr_get */
1433     0,                  /* tp_descr_set */
1434     0,                  /* tp_dictoffset */
1435     Entry_init,         /* tp_init */
1436     0,                  /* tp_alloc */
1437     Entry_new,          /* tp_new */
1438 };
1439
1440 /* Permset type methods */
1441 static PyMethodDef Permset_methods[] = {
1442     {"clear", Permset_clear, METH_NOARGS, __Permset_clear_doc__, },
1443     {"add", Permset_add, METH_VARARGS, __Permset_add_doc__, },
1444     {"delete", Permset_delete, METH_VARARGS, __Permset_delete_doc__, },
1445     {"test", Permset_test, METH_VARARGS, __Permset_test_doc__, },
1446     {NULL, NULL, 0, NULL}
1447 };
1448
1449 static char __Permset_execute_doc__[] =
1450     "Execute permission property\n"
1451     "\n"
1452     "This is a convenience method of retrieving and setting the execute\n"
1453     "permission in the permission set; the \n"
1454     "same effect can be achieved using the functions\n"
1455     "add(), test(), delete(), and those can take any \n"
1456     "permission defined by your platform.\n"
1457     ;
1458
1459 static char __Permset_read_doc__[] =
1460     "Read permission property\n"
1461     "\n"
1462     "This is a convenience method of retrieving and setting the read\n"
1463     "permission in the permission set; the \n"
1464     "same effect can be achieved using the functions\n"
1465     "add(), test(), delete(), and those can take any \n"
1466     "permission defined by your platform.\n"
1467     ;
1468
1469 static char __Permset_write_doc__[] =
1470     "Write permission property\n"
1471     "\n"
1472     "This is a convenience method of retrieving and setting the write\n"
1473     "permission in the permission set; the \n"
1474     "same effect can be achieved using the functions\n"
1475     "add(), test(), delete(), and those can take any \n"
1476     "permission defined by your platform.\n"
1477     ;
1478
1479 /* Permset getset */
1480 static PyGetSetDef Permset_getsets[] = {
1481     {"execute", Permset_get_right, Permset_set_right,
1482      __Permset_execute_doc__, &holder_ACL_EXECUTE},
1483     {"read", Permset_get_right, Permset_set_right,
1484      __Permset_read_doc__, &holder_ACL_READ},
1485     {"write", Permset_get_right, Permset_set_right,
1486      __Permset_write_doc__, &holder_ACL_WRITE},
1487     {NULL}
1488 };
1489
1490 static char __Permset_Type_doc__[] =
1491     "Type which represents the permission set in an ACL entry\n"
1492     "\n"
1493     "The type exists only if the OS has full support for POSIX.1e\n"
1494     "Can be retrieved either by:\n\n"
1495     ">>> perms = myEntry.permset\n"
1496     "\n"
1497     "or by:\n\n"
1498     ">>> perms = posix1e.Permset(myEntry)\n"
1499     "\n"
1500     "Note that the Permset keeps a reference to its Entry, so even if \n"
1501     "you delete the entry, it won't be cleaned up and will continue to \n"
1502     "exist until its Permset will be deleted.\n"
1503     ;
1504
1505 /* The definition of the Permset Type */
1506 static PyTypeObject Permset_Type = {
1507     PyVarObject_HEAD_INIT(NULL, 0)
1508     "posix1e.Permset",
1509     sizeof(Permset_Object),
1510     0,
1511     Permset_dealloc,    /* tp_dealloc */
1512     0,                  /* tp_print */
1513     0,                  /* tp_getattr */
1514     0,                  /* tp_setattr */
1515     0,                  /* tp_compare */
1516     0,                  /* tp_repr */
1517     0,                  /* tp_as_number */
1518     0,                  /* tp_as_sequence */
1519     0,                  /* tp_as_mapping */
1520     0,                  /* tp_hash */
1521     0,                  /* tp_call */
1522     Permset_str,        /* tp_str */
1523     0,                  /* tp_getattro */
1524     0,                  /* tp_setattro */
1525     0,                  /* tp_as_buffer */
1526     Py_TPFLAGS_DEFAULT, /* tp_flags */
1527     __Permset_Type_doc__,/* tp_doc */
1528     0,                  /* tp_traverse */
1529     0,                  /* tp_clear */
1530     0,                  /* tp_richcompare */
1531     0,                  /* tp_weaklistoffset */
1532     0,                  /* tp_iter */
1533     0,                  /* tp_iternext */
1534     Permset_methods,    /* tp_methods */
1535     0,                  /* tp_members */
1536     Permset_getsets,    /* tp_getset */
1537     0,                  /* tp_base */
1538     0,                  /* tp_dict */
1539     0,                  /* tp_descr_get */
1540     0,                  /* tp_descr_set */
1541     0,                  /* tp_dictoffset */
1542     Permset_init,       /* tp_init */
1543     0,                  /* tp_alloc */
1544     Permset_new,        /* tp_new */
1545 };
1546
1547 #endif
1548
1549 /* Module methods */
1550
1551 static char __deletedef_doc__[] =
1552     "delete_default(path)\n"
1553     "Delete the default ACL from a directory.\n"
1554     "\n"
1555     "This function deletes the default ACL associated with\n"
1556     "a directory (the ACL which will be ANDed with the mode\n"
1557     "parameter to the open, creat functions).\n"
1558     "\n"
1559     ":param string path: the directory whose default ACL should be deleted\n"
1560     ;
1561
1562 /* Deletes the default ACL from a directory */
1563 static PyObject* aclmodule_delete_default(PyObject* obj, PyObject* args) {
1564     char *filename;
1565
1566     /* Parse the arguments */
1567     if (!PyArg_ParseTuple(args, "et", NULL, &filename))
1568         return NULL;
1569
1570     if(acl_delete_def_file(filename) == -1) {
1571         return PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
1572     }
1573
1574     /* Return the result */
1575     Py_INCREF(Py_None);
1576     return Py_None;
1577 }
1578
1579 #ifdef HAVE_LINUX
1580 static char __has_extended_doc__[] =
1581     "has_extended(item)\n"
1582     "Check if a file or file handle has an extended ACL.\n"
1583     "\n"
1584     ":param item: either a file name or a file-like object or an integer;\n"
1585     "  it represents the file-system object on which to act\n"
1586     ;
1587
1588 /* Check for extended ACL a file or fd */
1589 static PyObject* aclmodule_has_extended(PyObject* obj, PyObject* args) {
1590     PyObject *item, *tmp;
1591     int nret;
1592     int fd;
1593
1594     if (!PyArg_ParseTuple(args, "O", &item))
1595         return NULL;
1596
1597     if((fd = PyObject_AsFileDescriptor(item)) != -1) {
1598         if((nret = acl_extended_fd(fd)) == -1) {
1599             PyErr_SetFromErrno(PyExc_IOError);
1600         }
1601     } else {
1602       // PyObject_AsFileDescriptor sets an error when failing, so clear
1603       // it such that further code works; some method lookups fail if an
1604       // error already occured when called, which breaks at least
1605       // PyOS_FSPath (called by FSConverter).
1606       PyErr_Clear();
1607       if(PyUnicode_FSConverter(item, &tmp)) {
1608         char *filename = PyBytes_AS_STRING(tmp);
1609         if ((nret = acl_extended_file(filename)) == -1) {
1610             PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
1611         }
1612         Py_DECREF(tmp);
1613       } else {
1614           nret = -1;
1615       }
1616     }
1617
1618     if (nret < 0) {
1619         return NULL;
1620     } else {
1621         return PyBool_FromLong(nret);
1622     }
1623 }
1624 #endif
1625
1626 /* The module methods */
1627 static PyMethodDef aclmodule_methods[] = {
1628     {"delete_default", aclmodule_delete_default, METH_VARARGS,
1629      __deletedef_doc__},
1630 #ifdef HAVE_LINUX
1631     {"has_extended", aclmodule_has_extended, METH_VARARGS,
1632      __has_extended_doc__},
1633 #endif
1634     {NULL, NULL, 0, NULL}
1635 };
1636
1637 static char __posix1e_doc__[] =
1638     "POSIX.1e ACLs manipulation\n"
1639     "==========================\n"
1640     "\n"
1641     "This module provides support for manipulating POSIX.1e ACLS\n"
1642     "\n"
1643     "Depending on the operating system support for POSIX.1e, \n"
1644     "the ACL type will have more or less capabilities:\n\n"
1645     "  - level 1, only basic support, you can create\n"
1646     "    ACLs from files and text descriptions;\n"
1647     "    once created, the type is immutable\n"
1648     "  - level 2, complete support, you can alter\n"
1649     "    the ACL once it is created\n"
1650     "\n"
1651     "Also, in level 2, more types are available, corresponding\n"
1652     "to acl_entry_t (the Entry type), acl_permset_t (the Permset type).\n"
1653     "\n"
1654     "The existence of level 2 support and other extensions can be\n"
1655     "checked by the constants:\n\n"
1656     "  - :py:data:`HAS_ACL_ENTRY` for level 2 and the Entry/Permset classes\n"
1657     "  - :py:data:`HAS_ACL_FROM_MODE` for ``ACL(mode=...)`` usage\n"
1658     "  - :py:data:`HAS_ACL_CHECK` for the :py:func:`ACL.check` function\n"
1659     "  - :py:data:`HAS_EXTENDED_CHECK` for the module-level\n"
1660     "    :py:func:`has_extended` function\n"
1661     "  - :py:data:`HAS_EQUIV_MODE` for the :py:func:`ACL.equiv_mode` method\n"
1662     "  - :py:data:`HAS_COPY_EXT` for the :py:func:`ACL.__getstate__` and\n"
1663     "    :py:func:`ACL.__setstate__` functions (pickle protocol)\n"
1664     "\n"
1665     "Example:\n"
1666     "\n"
1667     ">>> import posix1e\n"
1668     ">>> acl1 = posix1e.ACL(file=\"file.txt\") \n"
1669     ">>> print acl1\n"
1670     "user::rw-\n"
1671     "group::rw-\n"
1672     "other::r--\n"
1673     ">>>\n"
1674     ">>> b = posix1e.ACL(text=\"u::rx,g::-,o::-\")\n"
1675     ">>> print b\n"
1676     "user::r-x\n"
1677     "group::---\n"
1678     "other::---\n"
1679     ">>>\n"
1680     ">>> b.applyto(\"file.txt\")\n"
1681     ">>> print posix1e.ACL(file=\"file.txt\")\n"
1682     "user::r-x\n"
1683     "group::---\n"
1684     "other::---\n"
1685     ">>>\n"
1686     "\n"
1687     ".. py:data:: ACL_USER\n\n"
1688     "   Denotes a specific user entry in an ACL.\n"
1689     "\n"
1690     ".. py:data:: ACL_USER_OBJ\n\n"
1691     "   Denotes the user owner entry in an ACL.\n"
1692     "\n"
1693     ".. py:data:: ACL_GROUP\n\n"
1694     "   Denotes the a group entry in an ACL.\n"
1695     "\n"
1696     ".. py:data:: ACL_GROUP_OBJ\n\n"
1697     "   Denotes the group owner entry in an ACL.\n"
1698     "\n"
1699     ".. py:data:: ACL_OTHER\n\n"
1700     "   Denotes the 'others' entry in an ACL.\n"
1701     "\n"
1702     ".. py:data:: ACL_MASK\n\n"
1703     "   Denotes the mask entry in an ACL, representing the maximum\n"
1704     "   access granted other users, the owner group and other groups.\n"
1705     "\n"
1706     ".. py:data:: ACL_UNDEFINED_TAG\n\n"
1707     "   An undefined tag in an ACL.\n"
1708     "\n"
1709     ".. py:data:: ACL_READ\n\n"
1710     "   Read permission in a permission set.\n"
1711     "\n"
1712     ".. py:data:: ACL_WRITE\n\n"
1713     "   Write permission in a permission set.\n"
1714     "\n"
1715     ".. py:data:: ACL_EXECUTE\n\n"
1716     "   Execute permission in a permission set.\n"
1717     "\n"
1718     ".. py:data:: HAS_ACL_ENTRY\n\n"
1719     "   denotes support for level 2 and the Entry/Permset classes\n"
1720     "\n"
1721     ".. py:data:: HAS_ACL_FROM_MODE\n\n"
1722     "   denotes support for building an ACL from an octal mode\n"
1723     "\n"
1724     ".. py:data:: HAS_ACL_CHECK\n\n"
1725     "   denotes support for extended checks of an ACL's validity\n"
1726     "\n"
1727     ".. py:data:: HAS_EXTENDED_CHECK\n\n"
1728     "   denotes support for checking whether an ACL is basic or extended\n"
1729     "\n"
1730     ".. py:data:: HAS_EQUIV_MODE\n\n"
1731     "   denotes support for the equiv_mode function\n"
1732     "\n"
1733     ".. py:data:: HAS_COPY_EXT\n\n"
1734     "   denotes support for __getstate__()/__setstate__() on an ACL\n"
1735     "\n"
1736     ;
1737
1738 static struct PyModuleDef posix1emodule = {
1739     PyModuleDef_HEAD_INIT,
1740     "posix1e",
1741     __posix1e_doc__,
1742     0,
1743     aclmodule_methods,
1744 };
1745
1746 PyMODINIT_FUNC
1747 PyInit_posix1e(void)
1748 {
1749     PyObject *m, *d;
1750
1751     Py_TYPE(&ACL_Type) = &PyType_Type;
1752     if(PyType_Ready(&ACL_Type) < 0)
1753         return NULL;
1754
1755 #ifdef HAVE_LEVEL2
1756     Py_TYPE(&Entry_Type) = &PyType_Type;
1757     if(PyType_Ready(&Entry_Type) < 0)
1758         return NULL;
1759
1760     Py_TYPE(&Permset_Type) = &PyType_Type;
1761     if(PyType_Ready(&Permset_Type) < 0)
1762         return NULL;
1763 #endif
1764
1765     m = PyModule_Create(&posix1emodule);
1766     if (m==NULL)
1767         return NULL;
1768
1769     d = PyModule_GetDict(m);
1770     if (d == NULL)
1771         return NULL;
1772
1773     Py_INCREF(&ACL_Type);
1774     if (PyDict_SetItemString(d, "ACL",
1775                              (PyObject *) &ACL_Type) < 0)
1776         return NULL;
1777
1778     /* 23.3.6 acl_type_t values */
1779     PyModule_AddIntConstant(m, "ACL_TYPE_ACCESS", ACL_TYPE_ACCESS);
1780     PyModule_AddIntConstant(m, "ACL_TYPE_DEFAULT", ACL_TYPE_DEFAULT);
1781
1782
1783 #ifdef HAVE_LEVEL2
1784     Py_INCREF(&Entry_Type);
1785     if (PyDict_SetItemString(d, "Entry",
1786                              (PyObject *) &Entry_Type) < 0)
1787         return NULL;
1788
1789     Py_INCREF(&Permset_Type);
1790     if (PyDict_SetItemString(d, "Permset",
1791                              (PyObject *) &Permset_Type) < 0)
1792         return NULL;
1793
1794     /* 23.2.2 acl_perm_t values */
1795     PyModule_AddIntConstant(m, "ACL_READ", ACL_READ);
1796     PyModule_AddIntConstant(m, "ACL_WRITE", ACL_WRITE);
1797     PyModule_AddIntConstant(m, "ACL_EXECUTE", ACL_EXECUTE);
1798
1799     /* 23.2.5 acl_tag_t values */
1800     PyModule_AddIntConstant(m, "ACL_UNDEFINED_TAG", ACL_UNDEFINED_TAG);
1801     PyModule_AddIntConstant(m, "ACL_USER_OBJ", ACL_USER_OBJ);
1802     PyModule_AddIntConstant(m, "ACL_USER", ACL_USER);
1803     PyModule_AddIntConstant(m, "ACL_GROUP_OBJ", ACL_GROUP_OBJ);
1804     PyModule_AddIntConstant(m, "ACL_GROUP", ACL_GROUP);
1805     PyModule_AddIntConstant(m, "ACL_MASK", ACL_MASK);
1806     PyModule_AddIntConstant(m, "ACL_OTHER", ACL_OTHER);
1807
1808     /* Document extended functionality via easy-to-use constants */
1809     PyModule_AddIntConstant(m, "HAS_ACL_ENTRY", 1);
1810 #else
1811     PyModule_AddIntConstant(m, "HAS_ACL_ENTRY", 0);
1812 #endif
1813
1814 #ifdef HAVE_LINUX
1815     /* Linux libacl specific acl_to_any_text constants */
1816     PyModule_AddIntConstant(m, "TEXT_ABBREVIATE", TEXT_ABBREVIATE);
1817     PyModule_AddIntConstant(m, "TEXT_NUMERIC_IDS", TEXT_NUMERIC_IDS);
1818     PyModule_AddIntConstant(m, "TEXT_SOME_EFFECTIVE", TEXT_SOME_EFFECTIVE);
1819     PyModule_AddIntConstant(m, "TEXT_ALL_EFFECTIVE", TEXT_ALL_EFFECTIVE);
1820     PyModule_AddIntConstant(m, "TEXT_SMART_INDENT", TEXT_SMART_INDENT);
1821
1822     /* Linux libacl specific acl_check constants */
1823     PyModule_AddIntConstant(m, "ACL_MULTI_ERROR", ACL_MULTI_ERROR);
1824     PyModule_AddIntConstant(m, "ACL_DUPLICATE_ERROR", ACL_DUPLICATE_ERROR);
1825     PyModule_AddIntConstant(m, "ACL_MISS_ERROR", ACL_MISS_ERROR);
1826     PyModule_AddIntConstant(m, "ACL_ENTRY_ERROR", ACL_ENTRY_ERROR);
1827
1828 #define LINUX_EXT_VAL 1
1829 #else
1830 #define LINUX_EXT_VAL 0
1831 #endif
1832     /* declare the Linux extensions */
1833     PyModule_AddIntConstant(m, "HAS_ACL_FROM_MODE", LINUX_EXT_VAL);
1834     PyModule_AddIntConstant(m, "HAS_ACL_CHECK", LINUX_EXT_VAL);
1835     PyModule_AddIntConstant(m, "HAS_EXTENDED_CHECK", LINUX_EXT_VAL);
1836     PyModule_AddIntConstant(m, "HAS_EQUIV_MODE", LINUX_EXT_VAL);
1837
1838     PyModule_AddIntConstant(m, "HAS_COPY_EXT",
1839 #ifdef HAVE_ACL_COPY_EXT
1840                             1
1841 #else
1842                             0
1843 #endif
1844                             );
1845     return m;
1846 }