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     ACL_Object *acl;
 108
 109     newacl = type->tp_alloc(type, 0);
 110
 111     if(newacl == NULL) {
 112         return NULL;
 113     }
 114     acl = (ACL_Object*) newacl;
 115
 116     acl->acl = acl_init(0);
 117     if (acl->acl == NULL) {
 118         PyErr_SetFromErrno(PyExc_IOError);
 119         Py_DECREF(newacl);
 120         return NULL;
 121     }
 122 #ifdef HAVEL_LEVEL2
 123     acl->entry_id = ACL_FIRST_ENTRY;
 124 #endif
 125
 126     return newacl;
 127 }
 128
 129 /* Initialization of a new ACL instance */
 130 static int ACL_init(PyObject* obj, PyObject* args, PyObject *keywds) {
 131     ACL_Object* self = (ACL_Object*) obj;
 132 #ifdef HAVE_LINUX
 133     static char *kwlist[] = { "file", "fd", "text", "acl", "filedef",
 134                               "mode", NULL };
 135     char *format = "|etisO!si";
 136     int mode = -1;
 137 #else
 138     static char *kwlist[] = { "file", "fd", "text", "acl", "filedef", NULL };
 139     char *format = "|etisO!s";
 140 #endif
 141     char *file = NULL;
 142     char *filedef = NULL;
 143     char *text = NULL;
 144     int fd = -1;
 145     ACL_Object* thesrc = NULL;
 146
 147     if(!PyTuple_Check(args) || PyTuple_Size(args) != 0 ||
 148        (keywds != NULL && PyDict_Check(keywds) && PyDict_Size(keywds) > 1)) {
 149         PyErr_SetString(PyExc_ValueError, "a max of one keyword argument"
 150                         " must be passed");
 151         return -1;
 152     }
 153     if(!PyArg_ParseTupleAndKeywords(args, keywds, format, kwlist,
 154                                     NULL, &file, &fd, &text, &ACL_Type,
 155                                     &thesrc, &filedef
 156 #ifdef HAVE_LINUX
 157                                     , &mode
 158 #endif
 159                                     ))
 160         return -1;
 161
 162     /* Free the old acl_t without checking for error, we don't
 163      * care right now */
 164     if(self->acl != NULL)
 165         acl_free(self->acl);
 166
 167     if(file != NULL)
 168         self->acl = acl_get_file(file, ACL_TYPE_ACCESS);
 169     else if(text != NULL)
 170         self->acl = acl_from_text(text);
 171     else if(fd != -1)
 172         self->acl = acl_get_fd(fd);
 173     else if(thesrc != NULL)
 174         self->acl = acl_dup(thesrc->acl);
 175     else if(filedef != NULL)
 176         self->acl = acl_get_file(filedef, ACL_TYPE_DEFAULT);
 177 #ifdef HAVE_LINUX
 178     else if(mode != -1)
 179         self->acl = acl_from_mode(mode);
 180 #endif
 181     else
 182         self->acl = acl_init(0);
 183
 184     if(self->acl == NULL) {
 185         PyErr_SetFromErrno(PyExc_IOError);
 186         return -1;
 187     }
 188
 189     return 0;
 190 }
 191
 192 /* Standard type functions */
 193 static void ACL_dealloc(PyObject* obj) {
 194     ACL_Object *self = (ACL_Object*) obj;
 195     PyObject *err_type, *err_value, *err_traceback;
 196     int have_error = PyErr_Occurred() ? 1 : 0;
 197
 198     if (have_error)
 199         PyErr_Fetch(&err_type, &err_value, &err_traceback);
 200     if(self->acl != NULL && acl_free(self->acl) != 0)
 201         PyErr_WriteUnraisable(obj);
 202     if (have_error)
 203         PyErr_Restore(err_type, err_value, err_traceback);
 204     PyObject_DEL(self);
 205 }
 206
 207 /* Converts the acl to a text format */
 208 static PyObject* ACL_str(PyObject *obj) {
 209     char *text;
 210     ACL_Object *self = (ACL_Object*) obj;
 211     PyObject *ret;
 212
 213     text = acl_to_text(self->acl, NULL);
 214     if(text == NULL) {
 215         return PyErr_SetFromErrno(PyExc_IOError);
 216     }
 217     ret = PyUnicode_FromString(text);
 218     if(acl_free(text) != 0) {
 219         Py_XDECREF(ret);
 220         return PyErr_SetFromErrno(PyExc_IOError);
 221     }
 222     return ret;
 223 }
 224
 225 #ifdef HAVE_LINUX
 226 static char __to_any_text_doc__[] =
 227   "to_any_text([prefix='', separator='n', options=0])\n"
 228   "Convert the ACL to a custom text format.\n"
 229   "\n"
 230   "This method encapsulates the ``acl_to_any_text()`` function.\n"
 231   "It allows a customized text format to be generated for the ACL. See\n"
 232   ":manpage:`acl_to_any_text(3)` for more details.\n"
 233   "\n"
 234   ":param string prefix: if given, this string will be pre-pended to\n"
 235   "   all lines\n"
 236   ":param string separator: a single character (defaults to '\\n'); this will"
 237     " be used to separate the entries in the ACL\n"
 238   ":param options: a bitwise combination of:\n\n"
 239   "    - :py:data:`TEXT_ABBREVIATE`: use 'u' instead of 'user', 'g' \n"
 240   "      instead of 'group', etc.\n"
 241   "    - :py:data:`TEXT_NUMERIC_IDS`: User and group IDs are included as\n"
 242   "      decimal numbers instead of names\n"
 243   "    - :py:data:`TEXT_SOME_EFFECTIVE`: Include comments denoting the\n"
 244   "      effective permissions when some are masked\n"
 245   "    - :py:data:`TEXT_ALL_EFFECTIVE`: Include comments after all ACL\n"
 246   "      entries affected by an ACL_MASK entry\n"
 247   "    - :py:data:`TEXT_SMART_INDENT`: Used in combination with the\n"
 248   "      _EFFECTIVE options, this will ensure that comments are aligned\n"
 249   "      to the fourth tab position (assuming one tab equals eight spaces)\n"
 250   ":rtype: string\n"
 251   ;
 252
 253 /* Converts the acl to a custom text format */
 254 static PyObject* ACL_to_any_text(PyObject *obj, PyObject *args,
 255                                  PyObject *kwds) {
 256     char *text;
 257     ACL_Object *self = (ACL_Object*) obj;
 258     PyObject *ret;
 259     const char *arg_prefix = NULL;
 260     char arg_separator = '\n';
 261     int arg_options = 0;
 262     static char *kwlist[] = {"prefix", "separator", "options", NULL};
 263
 264     if (!PyArg_ParseTupleAndKeywords(args, kwds, "|sci", kwlist, &arg_prefix,
 265                                      &arg_separator, &arg_options))
 266       return NULL;
 267
 268     text = acl_to_any_text(self->acl, arg_prefix, arg_separator, arg_options);
 269     if(text == NULL) {
 270         return PyErr_SetFromErrno(PyExc_IOError);
 271     }
 272     ret = PyBytes_FromString(text);
 273     if(acl_free(text) != 0) {
 274         Py_XDECREF(ret);
 275         return PyErr_SetFromErrno(PyExc_IOError);
 276     }
 277     return ret;
 278 }
 279
 280 static char __check_doc__[] =
 281     "Check the ACL validity.\n"
 282     "\n"
 283     "This is a non-portable, Linux specific extension that allow more\n"
 284     "information to be retrieved in case an ACL is not valid than via the\n"
 285     ":py:func:`valid` method.\n"
 286     "\n"
 287     "This method will return either False (the ACL is valid), or a tuple\n"
 288     "with two elements. The first element is one of the following\n"
 289     "constants:\n\n"
 290     "  - :py:data:`ACL_MULTI_ERROR`: The ACL contains multiple entries that\n"
 291     "    have a tag type that may occur at most once\n"
 292     "  - :py:data:`ACL_DUPLICATE_ERROR`: The ACL contains multiple \n"
 293     "    :py:data:`ACL_USER` or :py:data:`ACL_GROUP` entries with the\n"
 294     "    same ID\n"
 295     "  - :py:data:`ACL_MISS_ERROR`: A required entry is missing\n"
 296     "  - :py:data:`ACL_ENTRY_ERROR`: The ACL contains an invalid entry\n"
 297     "    tag type\n"
 298     "\n"
 299     "The second element of the tuple is the index of the entry that is\n"
 300     "invalid (in the same order as by iterating over the ACL entry)\n"
 301     ;
 302
 303 /* The acl_check method */
 304 static PyObject* ACL_check(PyObject* obj, PyObject* args) {
 305     ACL_Object *self = (ACL_Object*) obj;
 306     int result;
 307     int eindex;
 308
 309     if((result = acl_check(self->acl, &eindex)) == -1)
 310         return PyErr_SetFromErrno(PyExc_IOError);
 311     if(result == 0) {
 312         Py_RETURN_FALSE;
 313     }
 314     return Py_BuildValue("(ii)", result, eindex);
 315 }
 316
 317 /* Implementation of the rich compare for ACLs */
 318 static PyObject* ACL_richcompare(PyObject* o1, PyObject* o2, int op) {
 319     ACL_Object *acl1, *acl2;
 320     int n;
 321     PyObject *ret;
 322
 323     if(!PyObject_IsInstance(o2, (PyObject*)&ACL_Type)) {
 324         if(op == Py_EQ)
 325             Py_RETURN_FALSE;
 326         if(op == Py_NE)
 327             Py_RETURN_TRUE;
 328         PyErr_SetString(PyExc_TypeError, "can only compare to an ACL");
 329         return NULL;
 330     }
 331
 332     acl1 = (ACL_Object*)o1;
 333     acl2 = (ACL_Object*)o2;
 334     if((n=acl_cmp(acl1->acl, acl2->acl))==-1)
 335         return PyErr_SetFromErrno(PyExc_IOError);
 336     switch(op) {
 337     case Py_EQ:
 338         ret = n == 0 ? Py_True : Py_False;
 339         break;
 340     case Py_NE:
 341         ret = n == 1 ? Py_True : Py_False;
 342         break;
 343     default:
 344         PyErr_SetString(PyExc_TypeError, "ACLs are not orderable");
 345         return NULL;
 346     }
 347     Py_INCREF(ret);
 348     return ret;
 349 }
 350
 351 static char __equiv_mode_doc__[] =
 352     "Return the octal mode the ACL is equivalent to.\n"
 353     "\n"
 354     "This is a non-portable, Linux specific extension that checks\n"
 355     "if the ACL is a basic ACL and returns the corresponding mode.\n"
 356     "\n"
 357     ":rtype: integer\n"
 358     ":raise IOError: An IOerror exception will be raised if the ACL is\n"
 359     "    an extended ACL.\n"
 360     ;
 361
 362 /* The acl_equiv_mode method */
 363 static PyObject* ACL_equiv_mode(PyObject* obj, PyObject* args) {
 364     ACL_Object *self = (ACL_Object*) obj;
 365     mode_t mode;
 366
 367     if(acl_equiv_mode(self->acl, &mode) == -1)
 368         return PyErr_SetFromErrno(PyExc_IOError);
 369     return PyLong_FromLong(mode);
 370 }
 371 #endif
 372
 373 /* Custom methods */
 374 static char __applyto_doc__[] =
 375     "applyto(item[, flag=ACL_TYPE_ACCESS])\n"
 376     "Apply the ACL to a file or filehandle.\n"
 377     "\n"
 378     ":param item: either a filename or a file-like object or an integer;\n"
 379     "    this represents the filesystem object on which to act\n"
 380     ":param flag: optional flag representing the type of ACL to set, either\n"
 381     "    :py:data:`ACL_TYPE_ACCESS` (default) or :py:data:`ACL_TYPE_DEFAULT`\n"
 382     ;
 383
 384 /* Applies the ACL to a file */
 385 static PyObject* ACL_applyto(PyObject* obj, PyObject* args) {
 386     ACL_Object *self = (ACL_Object*) obj;
 387     PyObject *target, *tmp;
 388     acl_type_t type = ACL_TYPE_ACCESS;
 389     int nret;
 390     int fd;
 391
 392     if (!PyArg_ParseTuple(args, "O|I", &target, &type))
 393         return NULL;
 394     if ((fd = PyObject_AsFileDescriptor(target)) != -1) {
 395         if((nret = acl_set_fd(fd, self->acl)) == -1) {
 396           PyErr_SetFromErrno(PyExc_IOError);
 397         }
 398     } else {
 399       // PyObject_AsFileDescriptor sets an error when failing, so clear
 400       // it such that further code works; some method lookups fail if an
 401       // error already occured when called, which breaks at least
 402       // PyOS_FSPath (called by FSConverter).
 403       PyErr_Clear();
 404       if(PyUnicode_FSConverter(target, &tmp)) {
 405         char *filename = PyBytes_AS_STRING(tmp);
 406         if ((nret = acl_set_file(filename, type, self->acl)) == -1) {
 407             PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
 408         }
 409         Py_DECREF(tmp);
 410       } else {
 411         nret = -1;
 412       }
 413     }
 414     if (nret < 0) {
 415         return NULL;
 416     } else {
 417         Py_RETURN_NONE;
 418     }
 419 }
 420
 421 static char __valid_doc__[] =
 422     "Test the ACL for validity.\n"
 423     "\n"
 424     "This method tests the ACL to see if it is a valid ACL\n"
 425     "in terms of the file-system. More precisely, it checks that:\n"
 426     "\n"
 427     "The ACL contains exactly one entry with each of the\n"
 428     ":py:data:`ACL_USER_OBJ`, :py:data:`ACL_GROUP_OBJ`, and \n"
 429     ":py:data:`ACL_OTHER` tag types. Entries\n"
 430     "with :py:data:`ACL_USER` and :py:data:`ACL_GROUP` tag types may\n"
 431     "appear zero or more\n"
 432     "times in an ACL. An ACL that contains entries of :py:data:`ACL_USER` or\n"
 433     ":py:data:`ACL_GROUP` tag types must contain exactly one entry of the \n"
 434     ":py:data:`ACL_MASK` tag type. If an ACL contains no entries of\n"
 435     ":py:data:`ACL_USER` or :py:data:`ACL_GROUP` tag types, the\n"
 436     ":py:data:`ACL_MASK` entry is optional.\n"
 437     "\n"
 438     "All user ID qualifiers must be unique among all entries of\n"
 439     "the :py:data:`ACL_USER` tag type, and all group IDs must be unique\n"
 440     "among all entries of :py:data:`ACL_GROUP` tag type.\n"
 441     "\n"
 442     "The method will return 1 for a valid ACL and 0 for an invalid one.\n"
 443     "This has been chosen because the specification for\n"
 444     ":manpage:`acl_valid(3)`\n"
 445     "in the POSIX.1e standard documents only one possible value for errno\n"
 446     "in case of an invalid ACL, so we can't differentiate between\n"
 447     "classes of errors. Other suggestions are welcome.\n"
 448     "\n"
 449     ":return: 0 or 1\n"
 450     ":rtype: integer\n"
 451     ;
 452
 453 /* Checks the ACL for validity */
 454 static PyObject* ACL_valid(PyObject* obj, PyObject* args) {
 455     ACL_Object *self = (ACL_Object*) obj;
 456
 457     if(acl_valid(self->acl) == -1) {
 458         Py_RETURN_FALSE;
 459     } else {
 460         Py_RETURN_TRUE;
 461     }
 462 }
 463
 464 #ifdef HAVE_ACL_COPY_EXT
 465 static PyObject* ACL_get_state(PyObject *obj, PyObject* args) {
 466     ACL_Object *self = (ACL_Object*) obj;
 467     PyObject *ret;
 468     ssize_t size, nsize;
 469     char *buf;
 470
 471     size = acl_size(self->acl);
 472     if(size == -1)
 473         return PyErr_SetFromErrno(PyExc_IOError);
 474
 475     if((ret = PyBytes_FromStringAndSize(NULL, size)) == NULL)
 476         return NULL;
 477     buf = PyBytes_AsString(ret);
 478
 479     if((nsize = acl_copy_ext(buf, self->acl, size)) == -1) {
 480         Py_DECREF(ret);
 481         return PyErr_SetFromErrno(PyExc_IOError);
 482     }
 483
 484     return ret;
 485 }
 486
 487 static PyObject* ACL_set_state(PyObject *obj, PyObject* args) {
 488     ACL_Object *self = (ACL_Object*) obj;
 489     const void *buf;
 490     int bufsize;
 491     acl_t ptr;
 492
 493     /* Parse the argument */
 494     if (!PyArg_ParseTuple(args, "s#", &buf, &bufsize))
 495         return NULL;
 496
 497     /* Try to import the external representation */
 498     if((ptr = acl_copy_int(buf)) == NULL)
 499         return PyErr_SetFromErrno(PyExc_IOError);
 500
 501     /* Free the old acl. Should we ignore errors here? */
 502     if(self->acl != NULL) {
 503         if(acl_free(self->acl) == -1)
 504             return PyErr_SetFromErrno(PyExc_IOError);
 505     }
 506
 507     self->acl = ptr;
 508
 509     Py_RETURN_NONE;
 510 }
 511 #endif
 512
 513 #ifdef HAVE_LEVEL2
 514
 515 /* tp_iter for the ACL type; since it can be iterated only
 516  * destructively, the type is its iterator
 517  */
 518 static PyObject* ACL_iter(PyObject *obj) {
 519     ACL_Object *self = (ACL_Object*)obj;
 520     self->entry_id = ACL_FIRST_ENTRY;
 521     Py_INCREF(obj);
 522     return obj;
 523 }
 524
 525 /* the tp_iternext function for the ACL type */
 526 static PyObject* ACL_iternext(PyObject *obj) {
 527     ACL_Object *self = (ACL_Object*)obj;
 528     acl_entry_t the_entry_t;
 529     Entry_Object *the_entry_obj;
 530     int nerr;
 531
 532     nerr = acl_get_entry(self->acl, self->entry_id, &the_entry_t);
 533     self->entry_id = ACL_NEXT_ENTRY;
 534     if(nerr == -1)
 535         return PyErr_SetFromErrno(PyExc_IOError);
 536     else if(nerr == 0) {
 537         /* Docs says this is not needed */
 538         /*PyErr_SetObject(PyExc_StopIteration, Py_None);*/
 539         return NULL;
 540     }
 541
 542     the_entry_obj = (Entry_Object*) PyType_GenericNew(&Entry_Type, NULL, NULL);
 543     if(the_entry_obj == NULL)
 544         return NULL;
 545
 546     the_entry_obj->entry = the_entry_t;
 547
 548     the_entry_obj->parent_acl = obj;
 549     Py_INCREF(obj); /* For the reference we have in entry->parent */
 550
 551     return (PyObject*)the_entry_obj;
 552 }
 553
 554 static char __ACL_delete_entry_doc__[] =
 555     "delete_entry(entry)\n"
 556     "Deletes an entry from the ACL.\n"
 557     "\n"
 558     ".. note:: Only available with level 2.\n"
 559     "\n"
 560     ":param entry: the Entry object which should be deleted; note that after\n"
 561     "    this function is called, that object is unusable any longer\n"
 562     "    and should be deleted\n"
 563     ;
 564
 565 /* Deletes an entry from the ACL */
 566 static PyObject* ACL_delete_entry(PyObject *obj, PyObject *args) {
 567     ACL_Object *self = (ACL_Object*)obj;
 568     Entry_Object *e;
 569
 570     if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &e))
 571         return NULL;
 572
 573     if (e->parent_acl != obj) {
 574         PyErr_SetString(PyExc_ValueError,
 575                         "Can't remove un-owned entry");
 576         return NULL;
 577     }
 578     if(acl_delete_entry(self->acl, e->entry) == -1)
 579         return PyErr_SetFromErrno(PyExc_IOError);
 580
 581     Py_RETURN_NONE;
 582 }
 583
 584 static char __ACL_calc_mask_doc__[] =
 585     "Compute the file group class mask.\n"
 586     "\n"
 587     "The calc_mask() method calculates and sets the permissions \n"
 588     "associated with the :py:data:`ACL_MASK` Entry of the ACL.\n"
 589     "The value of the new permissions is the union of the permissions \n"
 590     "granted by all entries of tag type :py:data:`ACL_GROUP`, \n"
 591     ":py:data:`ACL_GROUP_OBJ`, or \n"
 592     ":py:data:`ACL_USER`. If the ACL already contains an :py:data:`ACL_MASK`\n"
 593     "entry, its \n"
 594     "permissions are overwritten; if it does not contain an \n"
 595     ":py:data:`ACL_MASK` Entry, one is added.\n"
 596     "\n"
 597     "The order of existing entries in the ACL is undefined after this \n"
 598     "function.\n"
 599     ;
 600
 601 /* Updates the mask entry in the ACL */
 602 static PyObject* ACL_calc_mask(PyObject *obj, PyObject *args) {
 603     ACL_Object *self = (ACL_Object*)obj;
 604
 605     if(acl_calc_mask(&self->acl) == -1)
 606         return PyErr_SetFromErrno(PyExc_IOError);
 607
 608     Py_RETURN_NONE;
 609 }
 610
 611 static char __ACL_append_doc__[] =
 612     "append([entry])\n"
 613     "Append a new Entry to the ACL and return it.\n"
 614     "\n"
 615     "This is a convenience function to create a new Entry \n"
 616     "and append it to the ACL.\n"
 617     "If a parameter of type Entry instance is given, the \n"
 618     "entry will be a copy of that one (as if copied with \n"
 619     ":py:func:`Entry.copy`), otherwise, the new entry will be empty.\n"
 620     "\n"
 621     ":rtype: :py:class:`Entry`\n"
 622     ":returns: the newly created entry\n"
 623     ;
 624
 625 /* Convenience method to create a new Entry */
 626 static PyObject* ACL_append(PyObject *obj, PyObject *args) {
 627     ACL_Object* self = (ACL_Object*) obj;
 628     Entry_Object* newentry;
 629     Entry_Object* oldentry = NULL;
 630     int nret;
 631
 632     newentry = (Entry_Object*)PyType_GenericNew(&Entry_Type, NULL, NULL);
 633     if(newentry == NULL) {
 634         return NULL;
 635     }
 636
 637     if (!PyArg_ParseTuple(args, "|O!", &Entry_Type, &oldentry)) {
 638         Py_DECREF(newentry);
 639         return NULL;
 640     }
 641
 642     nret = acl_create_entry(&self->acl, &newentry->entry);
 643     if(nret == -1) {
 644         Py_DECREF(newentry);
 645         return PyErr_SetFromErrno(PyExc_IOError);
 646     }
 647
 648     if(oldentry != NULL) {
 649         nret = acl_copy_entry(newentry->entry, oldentry->entry);
 650         if(nret == -1) {
 651             Py_DECREF(newentry);
 652             return PyErr_SetFromErrno(PyExc_IOError);
 653         }
 654     }
 655
 656     newentry->parent_acl = obj;
 657     Py_INCREF(obj);
 658
 659     return (PyObject*)newentry;
 660 }
 661
 662 /***** Entry type *****/
 663
 664 typedef struct {
 665     acl_tag_t tag;
 666     union {
 667         uid_t uid;
 668         gid_t gid;
 669     };
 670 } tag_qual;
 671
 672 /* Pre-declaring the function is more friendly to cpychecker, sigh. */
 673 static int get_tag_qualifier(acl_entry_t entry, tag_qual *tq)
 674   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
 675
 676 /* Helper function to get the tag and qualifier of an Entry at the
 677    same time. This is "needed" because the acl_get_qualifier function
 678    returns a pointer to different types, based on the tag value, and
 679    thus it's not straightforward to get the right type.
 680
 681    It sets a Python exception if an error occurs, and returns -1 in
 682    this case. If successful, the tag is set to the tag type, the
 683    qualifier (if any) to either the uid or the gid entry in the
 684    tag_qual structure, and the return value is 0.
 685 */
 686 static int get_tag_qualifier(acl_entry_t entry, tag_qual *tq) {
 687     void *p;
 688
 689     if(acl_get_tag_type(entry, &tq->tag) == -1) {
 690         PyErr_SetFromErrno(PyExc_IOError);
 691         return -1;
 692     }
 693     if (tq->tag == ACL_USER || tq->tag == ACL_GROUP) {
 694         if((p = acl_get_qualifier(entry)) == NULL) {
 695             PyErr_SetFromErrno(PyExc_IOError);
 696             return -1;
 697         }
 698         if (tq->tag == ACL_USER) {
 699             tq->uid = *(uid_t*)p;
 700         } else {
 701             tq->gid = *(gid_t*)p;
 702         }
 703         acl_free(p);
 704     }
 705     return 0;
 706 }
 707
 708 #define ENTRY_SET_CHECK(self, attr, value)         \
 709     if (value == NULL) { \
 710         PyErr_SetString(PyExc_TypeError, \
 711                         attr " deletion is not supported"); \
 712         return -1; \
 713     }
 714
 715 /* Creation of a new Entry instance */
 716 static PyObject* Entry_new(PyTypeObject* type, PyObject* args,
 717                            PyObject *keywds) {
 718     PyObject* newentry;
 719     Entry_Object* entry;
 720     ACL_Object* parent = NULL;
 721
 722     if (!PyArg_ParseTuple(args, "O!", &ACL_Type, &parent))
 723         return NULL;
 724
 725     newentry = PyType_GenericNew(type, args, keywds);
 726
 727     if(newentry == NULL) {
 728         return NULL;
 729     }
 730
 731     entry = (Entry_Object*)newentry;
 732
 733     if(acl_create_entry(&parent->acl, &entry->entry) == -1) {
 734         PyErr_SetFromErrno(PyExc_IOError);
 735         Py_DECREF(newentry);
 736         return NULL;
 737     }
 738     Py_INCREF(parent);
 739     entry->parent_acl = (PyObject*)parent;
 740     return newentry;
 741 }
 742
 743 /* Initialization of a new Entry instance */
 744 static int Entry_init(PyObject* obj, PyObject* args, PyObject *keywds) {
 745     Entry_Object* self = (Entry_Object*) obj;
 746     ACL_Object* parent = NULL;
 747
 748     if (!PyArg_ParseTuple(args, "O!", &ACL_Type, &parent))
 749         return -1;
 750
 751     if ((PyObject*)parent != self->parent_acl) {
 752         PyErr_SetString(PyExc_ValueError,
 753                         "Can't reinitialize with a different parent");
 754         return -1;
 755     }
 756     return 0;
 757 }
 758
 759 /* Free the Entry instance */
 760 static void Entry_dealloc(PyObject* obj) {
 761     Entry_Object *self = (Entry_Object*) obj;
 762     PyObject *err_type, *err_value, *err_traceback;
 763     int have_error = PyErr_Occurred() ? 1 : 0;
 764
 765     if (have_error)
 766         PyErr_Fetch(&err_type, &err_value, &err_traceback);
 767     if(self->parent_acl != NULL) {
 768         Py_DECREF(self->parent_acl);
 769         self->parent_acl = NULL;
 770     }
 771     if (have_error)
 772         PyErr_Restore(err_type, err_value, err_traceback);
 773     PyObject_DEL(self);
 774 }
 775
 776 /* Converts the entry to a text format */
 777 static PyObject* Entry_str(PyObject *obj) {
 778     PyObject *format, *kind;
 779     Entry_Object *self = (Entry_Object*) obj;
 780     tag_qual tq;
 781
 782     if(get_tag_qualifier(self->entry, &tq) < 0) {
 783         return NULL;
 784     }
 785
 786     format = PyUnicode_FromString("ACL entry for ");
 787     if(format == NULL)
 788         return NULL;
 789     switch(tq.tag) {
 790     case ACL_UNDEFINED_TAG:
 791         kind = PyUnicode_FromString("undefined type");
 792         break;
 793     case ACL_USER_OBJ:
 794         kind = PyUnicode_FromString("the owner");
 795         break;
 796     case ACL_GROUP_OBJ:
 797         kind = PyUnicode_FromString("the group");
 798         break;
 799     case ACL_OTHER:
 800         kind = PyUnicode_FromString("the others");
 801         break;
 802     case ACL_USER:
 803         /* FIXME: here and in the group case, we're formatting with
 804            unsigned, because there's no way to automatically determine
 805            the signed-ness of the types; on Linux(glibc) they're
 806            unsigned, so we'll go along with that */
 807         kind = PyUnicode_FromFormat("user with uid %u", tq.uid);
 808         break;
 809     case ACL_GROUP:
 810         kind = PyUnicode_FromFormat("group with gid %u", tq.gid);
 811         break;
 812     case ACL_MASK:
 813         kind = PyUnicode_FromString("the mask");
 814         break;
 815     default:
 816         kind = PyUnicode_FromString("UNKNOWN_TAG_TYPE!");
 817         break;
 818     }
 819     if (kind == NULL) {
 820         Py_DECREF(format);
 821         return NULL;
 822     }
 823     PyObject *ret = PyUnicode_Concat(format, kind);
 824     Py_DECREF(format);
 825     Py_DECREF(kind);
 826     return ret;
 827 }
 828
 829 /* Sets the tag type of the entry */
 830 static int Entry_set_tag_type(PyObject* obj, PyObject* value, void* arg) {
 831     Entry_Object *self = (Entry_Object*) obj;
 832
 833     ENTRY_SET_CHECK(self, "tag type", value);
 834
 835     if(!PyLong_Check(value)) {
 836         PyErr_SetString(PyExc_TypeError,
 837                         "tag type must be integer");
 838         return -1;
 839     }
 840     if(acl_set_tag_type(self->entry, (acl_tag_t)PyLong_AsLong(value)) == -1) {
 841         PyErr_SetFromErrno(PyExc_IOError);
 842         return -1;
 843     }
 844
 845     return 0;
 846 }
 847
 848 /* Returns the tag type of the entry */
 849 static PyObject* Entry_get_tag_type(PyObject *obj, void* arg) {
 850     Entry_Object *self = (Entry_Object*) obj;
 851     acl_tag_t value;
 852
 853     if(acl_get_tag_type(self->entry, &value) == -1) {
 854         PyErr_SetFromErrno(PyExc_IOError);
 855         return NULL;
 856     }
 857
 858     return PyLong_FromLong(value);
 859 }
 860
 861 /* Sets the qualifier (either uid_t or gid_t) for the entry,
 862  * usable only if the tag type if ACL_USER or ACL_GROUP
 863  */
 864 static int Entry_set_qualifier(PyObject* obj, PyObject* value, void* arg) {
 865     Entry_Object *self = (Entry_Object*) obj;
 866     long uidgid;
 867     uid_t uid;
 868     gid_t gid;
 869     void *p;
 870     acl_tag_t tag;
 871
 872     ENTRY_SET_CHECK(self, "qualifier", value);
 873
 874     if(!PyLong_Check(value)) {
 875         PyErr_SetString(PyExc_TypeError,
 876                         "qualifier must be integer");
 877         return -1;
 878     }
 879     if((uidgid = PyLong_AsLong(value)) == -1) {
 880         if(PyErr_Occurred() != NULL) {
 881             return -1;
 882         }
 883     }
 884     /* Due to how acl_set_qualifier takes its argument, we have to do
 885        this ugly dance with two variables and a pointer that will
 886        point to one of them. */
 887     if(acl_get_tag_type(self->entry, &tag) == -1) {
 888         PyErr_SetFromErrno(PyExc_IOError);
 889         return -1;
 890     }
 891     uid = uidgid;
 892     gid = uidgid;
 893     switch(tag) {
 894     case ACL_USER:
 895       if((long)uid != uidgid) {
 896         PyErr_SetString(PyExc_OverflowError, "Can't assign given qualifier");
 897         return -1;
 898       } else {
 899         p = &uid;
 900       }
 901       break;
 902     case ACL_GROUP:
 903       if((long)gid != uidgid) {
 904         PyErr_SetString(PyExc_OverflowError, "Can't assign given qualifier");
 905         return -1;
 906       } else {
 907         p = &gid;
 908       }
 909       break;
 910     default:
 911       PyErr_SetString(PyExc_TypeError,
 912                       "Can only set qualifiers on ACL_USER or ACL_GROUP entries");
 913       return -1;
 914     }
 915     if(acl_set_qualifier(self->entry, p) == -1) {
 916         PyErr_SetFromErrno(PyExc_IOError);
 917         return -1;
 918     }
 919
 920     return 0;
 921 }
 922
 923 /* Returns the qualifier of the entry */
 924 static PyObject* Entry_get_qualifier(PyObject *obj, void* arg) {
 925     Entry_Object *self = (Entry_Object*) obj;
 926     long value;
 927     tag_qual tq;
 928
 929     if (self->entry == NULL) {
 930         PyErr_SetString(PyExc_ValueError, "Can't get qualifier on uninitalized Entry object");
 931         return NULL;
 932     }
 933     if(get_tag_qualifier(self->entry, &tq) < 0) {
 934         return NULL;
 935     }
 936     if (tq.tag == ACL_USER) {
 937         value = tq.uid;
 938     } else if (tq.tag == ACL_GROUP) {
 939         value = tq.gid;
 940     } else {
 941         PyErr_SetString(PyExc_TypeError,
 942                         "Given entry doesn't have an user or"
 943                         " group tag");
 944         return NULL;
 945     }
 946     return PyLong_FromLong(value);
 947 }
 948
 949 /* Returns the parent ACL of the entry */
 950 static PyObject* Entry_get_parent(PyObject *obj, void* arg) {
 951     Entry_Object *self = (Entry_Object*) obj;
 952
 953     Py_INCREF(self->parent_acl);
 954     return self->parent_acl;
 955 }
 956
 957 /* Returns the a new Permset representing the permset of the entry
 958  * FIXME: Should return a new reference to the same object, which
 959  * should be created at init time!
 960  */
 961 static PyObject* Entry_get_permset(PyObject *obj, void* arg) {
 962     PyObject *p;
 963
 964     PyObject *perm_arglist = Py_BuildValue("(O)", obj);
 965     if (perm_arglist == NULL) {
 966         return NULL;
 967     }
 968     p = PyObject_CallObject((PyObject*)&Permset_Type, perm_arglist);
 969     Py_DECREF(perm_arglist);
 970     return p;
 971 }
 972
 973 /* Sets the permset of the entry to the passed Permset */
 974 static int Entry_set_permset(PyObject* obj, PyObject* value, void* arg) {
 975     Entry_Object *self = (Entry_Object*)obj;
 976     Permset_Object *p;
 977
 978     ENTRY_SET_CHECK(self, "permset", value);
 979
 980     if(!PyObject_IsInstance(value, (PyObject*)&Permset_Type)) {
 981         PyErr_SetString(PyExc_TypeError, "argument 1 must be posix1e.Permset");
 982         return -1;
 983     }
 984     p = (Permset_Object*)value;
 985     if(acl_set_permset(self->entry, p->permset) == -1) {
 986         PyErr_SetFromErrno(PyExc_IOError);
 987         return -1;
 988     }
 989     return 0;
 990 }
 991
 992 static char __Entry_copy_doc__[] =
 993     "copy(src)\n"
 994     "Copies an ACL entry.\n"
 995     "\n"
 996     "This method sets all the parameters to those of another\n"
 997     "entry (either of the same ACL or belonging to another ACL).\n"
 998     "\n"
 999     ":param Entry src: instance of type Entry\n"
1000     ;
1001
1002 /* Sets all the entry parameters to another entry */
1003 static PyObject* Entry_copy(PyObject *obj, PyObject *args) {
1004     Entry_Object *self = (Entry_Object*)obj;
1005     Entry_Object *other;
1006
1007     if(!PyArg_ParseTuple(args, "O!", &Entry_Type, &other))
1008         return NULL;
1009
1010     if(acl_copy_entry(self->entry, other->entry) == -1)
1011         return PyErr_SetFromErrno(PyExc_IOError);
1012
1013     Py_RETURN_NONE;
1014 }
1015
1016 /**** Permset type *****/
1017
1018 /* Creation of a new Permset instance */
1019 static PyObject* Permset_new(PyTypeObject* type, PyObject* args,
1020                              PyObject *keywds) {
1021     PyObject* newpermset;
1022     Permset_Object* permset;
1023     Entry_Object* parent = NULL;
1024
1025     if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &parent)) {
1026         return NULL;
1027     }
1028
1029     newpermset = PyType_GenericNew(type, args, keywds);
1030
1031     if(newpermset == NULL) {
1032         return NULL;
1033     }
1034
1035     permset = (Permset_Object*)newpermset;
1036
1037     if(acl_get_permset(parent->entry, &permset->permset) == -1) {
1038         PyErr_SetFromErrno(PyExc_IOError);
1039         Py_DECREF(newpermset);
1040         return NULL;
1041     }
1042
1043     permset->parent_entry = (PyObject*)parent;
1044     Py_INCREF(parent);
1045
1046     return newpermset;
1047 }
1048
1049 /* Initialization of a new Permset instance */
1050 static int Permset_init(PyObject* obj, PyObject* args, PyObject *keywds) {
1051     Permset_Object* self = (Permset_Object*) obj;
1052     Entry_Object* parent = NULL;
1053
1054     if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &parent))
1055         return -1;
1056
1057     if ((PyObject*)parent != self->parent_entry) {
1058         PyErr_SetString(PyExc_ValueError,
1059                         "Can't reinitialize with a different parent");
1060         return -1;
1061     }
1062
1063     return 0;
1064 }
1065
1066 /* Free the Permset instance */
1067 static void Permset_dealloc(PyObject* obj) {
1068     Permset_Object *self = (Permset_Object*) obj;
1069     PyObject *err_type, *err_value, *err_traceback;
1070     int have_error = PyErr_Occurred() ? 1 : 0;
1071
1072     if (have_error)
1073         PyErr_Fetch(&err_type, &err_value, &err_traceback);
1074     if(self->parent_entry != NULL) {
1075         Py_DECREF(self->parent_entry);
1076         self->parent_entry = NULL;
1077     }
1078     if (have_error)
1079         PyErr_Restore(err_type, err_value, err_traceback);
1080     PyObject_DEL(self);
1081 }
1082
1083 /* Permset string representation */
1084 static PyObject* Permset_str(PyObject *obj) {
1085     Permset_Object *self = (Permset_Object*) obj;
1086     char pstr[3];
1087
1088     pstr[0] = get_perm(self->permset, ACL_READ) ? 'r' : '-';
1089     pstr[1] = get_perm(self->permset, ACL_WRITE) ? 'w' : '-';
1090     pstr[2] = get_perm(self->permset, ACL_EXECUTE) ? 'x' : '-';
1091     return PyUnicode_FromStringAndSize(pstr, 3);
1092 }
1093
1094 static char __Permset_clear_doc__[] =
1095     "Clears all permissions from the permission set.\n"
1096     ;
1097
1098 /* Clears all permissions from the permset */
1099 static PyObject* Permset_clear(PyObject* obj, PyObject* args) {
1100     Permset_Object *self = (Permset_Object*) obj;
1101
1102     if(acl_clear_perms(self->permset) == -1)
1103         return PyErr_SetFromErrno(PyExc_IOError);
1104
1105     Py_RETURN_NONE;
1106 }
1107
1108 static PyObject* Permset_get_right(PyObject *obj, void* arg) {
1109     Permset_Object *self = (Permset_Object*) obj;
1110
1111     if(get_perm(self->permset, *(acl_perm_t*)arg)) {
1112         Py_RETURN_TRUE;
1113     } else {
1114         Py_RETURN_FALSE;
1115     }
1116 }
1117
1118 static int Permset_set_right(PyObject* obj, PyObject* value, void* arg) {
1119     Permset_Object *self = (Permset_Object*) obj;
1120     int on;
1121     int nerr;
1122
1123     if(!PyLong_Check(value)) {
1124         PyErr_SetString(PyExc_ValueError, "invalid argument, an integer"
1125                         " is expected");
1126         return -1;
1127     }
1128     on = PyLong_AsLong(value);
1129     if(on)
1130         nerr = acl_add_perm(self->permset, *(acl_perm_t*)arg);
1131     else
1132         nerr = acl_delete_perm(self->permset, *(acl_perm_t*)arg);
1133     if(nerr == -1) {
1134         PyErr_SetFromErrno(PyExc_IOError);
1135         return -1;
1136     }
1137     return 0;
1138 }
1139
1140 static char __Permset_add_doc__[] =
1141     "add(perm)\n"
1142     "Add a permission to the permission set.\n"
1143     "\n"
1144     "This function adds the permission contained in \n"
1145     "the argument perm to the permission set.  An attempt \n"
1146     "to add a permission that is already contained in the \n"
1147     "permission set is not considered an error.\n"
1148     "\n"
1149     ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1150     "   :py:data:`ACL_EXECUTE`, ...)\n"
1151     ":raises IOError: in case the argument is not a valid descriptor\n"
1152     ;
1153
1154 static PyObject* Permset_add(PyObject* obj, PyObject* args) {
1155     Permset_Object *self = (Permset_Object*) obj;
1156     int right;
1157
1158     if (!PyArg_ParseTuple(args, "i", &right))
1159         return NULL;
1160
1161     if(acl_add_perm(self->permset, (acl_perm_t) right) == -1)
1162         return PyErr_SetFromErrno(PyExc_IOError);
1163
1164     Py_RETURN_NONE;
1165 }
1166
1167 static char __Permset_delete_doc__[] =
1168     "delete(perm)\n"
1169     "Delete a permission from the permission set.\n"
1170     "\n"
1171     "This function deletes the permission contained in \n"
1172     "the argument perm from the permission set. An attempt \n"
1173     "to delete a permission that is not contained in the \n"
1174     "permission set is not considered an error.\n"
1175     "\n"
1176     ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1177     "   :py:data:`ACL_EXECUTE`, ...)\n"
1178     ":raises IOError: in case the argument is not a valid descriptor\n"
1179     ;
1180
1181 static PyObject* Permset_delete(PyObject* obj, PyObject* args) {
1182     Permset_Object *self = (Permset_Object*) obj;
1183     int right;
1184
1185     if (!PyArg_ParseTuple(args, "i", &right))
1186         return NULL;
1187
1188     if(acl_delete_perm(self->permset, (acl_perm_t) right) == -1)
1189         return PyErr_SetFromErrno(PyExc_IOError);
1190
1191     Py_RETURN_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     Py_RETURN_NONE;
1575 }
1576
1577 #ifdef HAVE_LINUX
1578 static char __has_extended_doc__[] =
1579     "has_extended(item)\n"
1580     "Check if a file or file handle has an extended ACL.\n"
1581     "\n"
1582     ":param item: either a file name or a file-like object or an integer;\n"
1583     "  it represents the file-system object on which to act\n"
1584     ;
1585
1586 /* Check for extended ACL a file or fd */
1587 static PyObject* aclmodule_has_extended(PyObject* obj, PyObject* args) {
1588     PyObject *item, *tmp;
1589     int nret;
1590     int fd;
1591
1592     if (!PyArg_ParseTuple(args, "O", &item))
1593         return NULL;
1594
1595     if((fd = PyObject_AsFileDescriptor(item)) != -1) {
1596         if((nret = acl_extended_fd(fd)) == -1) {
1597             PyErr_SetFromErrno(PyExc_IOError);
1598         }
1599     } else {
1600       // PyObject_AsFileDescriptor sets an error when failing, so clear
1601       // it such that further code works; some method lookups fail if an
1602       // error already occured when called, which breaks at least
1603       // PyOS_FSPath (called by FSConverter).
1604       PyErr_Clear();
1605       if(PyUnicode_FSConverter(item, &tmp)) {
1606         char *filename = PyBytes_AS_STRING(tmp);
1607         if ((nret = acl_extended_file(filename)) == -1) {
1608             PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
1609         }
1610         Py_DECREF(tmp);
1611       } else {
1612           nret = -1;
1613       }
1614     }
1615
1616     if (nret < 0) {
1617         return NULL;
1618     } else {
1619         return PyBool_FromLong(nret);
1620     }
1621 }
1622 #endif
1623
1624 /* The module methods */
1625 static PyMethodDef aclmodule_methods[] = {
1626     {"delete_default", aclmodule_delete_default, METH_VARARGS,
1627      __deletedef_doc__},
1628 #ifdef HAVE_LINUX
1629     {"has_extended", aclmodule_has_extended, METH_VARARGS,
1630      __has_extended_doc__},
1631 #endif
1632     {NULL, NULL, 0, NULL}
1633 };
1634
1635 static char __posix1e_doc__[] =
1636     "POSIX.1e ACLs manipulation\n"
1637     "==========================\n"
1638     "\n"
1639     "This module provides support for manipulating POSIX.1e ACLS\n"
1640     "\n"
1641     "Depending on the operating system support for POSIX.1e, \n"
1642     "the ACL type will have more or less capabilities:\n\n"
1643     "  - level 1, only basic support, you can create\n"
1644     "    ACLs from files and text descriptions;\n"
1645     "    once created, the type is immutable\n"
1646     "  - level 2, complete support, you can alter\n"
1647     "    the ACL once it is created\n"
1648     "\n"
1649     "Also, in level 2, more types are available, corresponding\n"
1650     "to acl_entry_t (the Entry type), acl_permset_t (the Permset type).\n"
1651     "\n"
1652     "The existence of level 2 support and other extensions can be\n"
1653     "checked by the constants:\n\n"
1654     "  - :py:data:`HAS_ACL_ENTRY` for level 2 and the Entry/Permset classes\n"
1655     "  - :py:data:`HAS_ACL_FROM_MODE` for ``ACL(mode=...)`` usage\n"
1656     "  - :py:data:`HAS_ACL_CHECK` for the :py:func:`ACL.check` function\n"
1657     "  - :py:data:`HAS_EXTENDED_CHECK` for the module-level\n"
1658     "    :py:func:`has_extended` function\n"
1659     "  - :py:data:`HAS_EQUIV_MODE` for the :py:func:`ACL.equiv_mode` method\n"
1660     "  - :py:data:`HAS_COPY_EXT` for the :py:func:`ACL.__getstate__` and\n"
1661     "    :py:func:`ACL.__setstate__` functions (pickle protocol)\n"
1662     "\n"
1663     "Example:\n"
1664     "\n"
1665     ">>> import posix1e\n"
1666     ">>> acl1 = posix1e.ACL(file=\"file.txt\") \n"
1667     ">>> print acl1\n"
1668     "user::rw-\n"
1669     "group::rw-\n"
1670     "other::r--\n"
1671     ">>>\n"
1672     ">>> b = posix1e.ACL(text=\"u::rx,g::-,o::-\")\n"
1673     ">>> print b\n"
1674     "user::r-x\n"
1675     "group::---\n"
1676     "other::---\n"
1677     ">>>\n"
1678     ">>> b.applyto(\"file.txt\")\n"
1679     ">>> print posix1e.ACL(file=\"file.txt\")\n"
1680     "user::r-x\n"
1681     "group::---\n"
1682     "other::---\n"
1683     ">>>\n"
1684     "\n"
1685     ".. py:data:: ACL_USER\n\n"
1686     "   Denotes a specific user entry in an ACL.\n"
1687     "\n"
1688     ".. py:data:: ACL_USER_OBJ\n\n"
1689     "   Denotes the user owner entry in an ACL.\n"
1690     "\n"
1691     ".. py:data:: ACL_GROUP\n\n"
1692     "   Denotes the a group entry in an ACL.\n"
1693     "\n"
1694     ".. py:data:: ACL_GROUP_OBJ\n\n"
1695     "   Denotes the group owner entry in an ACL.\n"
1696     "\n"
1697     ".. py:data:: ACL_OTHER\n\n"
1698     "   Denotes the 'others' entry in an ACL.\n"
1699     "\n"
1700     ".. py:data:: ACL_MASK\n\n"
1701     "   Denotes the mask entry in an ACL, representing the maximum\n"
1702     "   access granted other users, the owner group and other groups.\n"
1703     "\n"
1704     ".. py:data:: ACL_UNDEFINED_TAG\n\n"
1705     "   An undefined tag in an ACL.\n"
1706     "\n"
1707     ".. py:data:: ACL_READ\n\n"
1708     "   Read permission in a permission set.\n"
1709     "\n"
1710     ".. py:data:: ACL_WRITE\n\n"
1711     "   Write permission in a permission set.\n"
1712     "\n"
1713     ".. py:data:: ACL_EXECUTE\n\n"
1714     "   Execute permission in a permission set.\n"
1715     "\n"
1716     ".. py:data:: HAS_ACL_ENTRY\n\n"
1717     "   denotes support for level 2 and the Entry/Permset classes\n"
1718     "\n"
1719     ".. py:data:: HAS_ACL_FROM_MODE\n\n"
1720     "   denotes support for building an ACL from an octal mode\n"
1721     "\n"
1722     ".. py:data:: HAS_ACL_CHECK\n\n"
1723     "   denotes support for extended checks of an ACL's validity\n"
1724     "\n"
1725     ".. py:data:: HAS_EXTENDED_CHECK\n\n"
1726     "   denotes support for checking whether an ACL is basic or extended\n"
1727     "\n"
1728     ".. py:data:: HAS_EQUIV_MODE\n\n"
1729     "   denotes support for the equiv_mode function\n"
1730     "\n"
1731     ".. py:data:: HAS_COPY_EXT\n\n"
1732     "   denotes support for __getstate__()/__setstate__() on an ACL\n"
1733     "\n"
1734     ;
1735
1736 static struct PyModuleDef posix1emodule = {
1737     PyModuleDef_HEAD_INIT,
1738     "posix1e",
1739     __posix1e_doc__,
1740     0,
1741     aclmodule_methods,
1742 };
1743
1744 PyMODINIT_FUNC
1745 PyInit_posix1e(void)
1746 {
1747     PyObject *m, *d;
1748
1749     Py_TYPE(&ACL_Type) = &PyType_Type;
1750     if(PyType_Ready(&ACL_Type) < 0)
1751         return NULL;
1752
1753 #ifdef HAVE_LEVEL2
1754     Py_TYPE(&Entry_Type) = &PyType_Type;
1755     if(PyType_Ready(&Entry_Type) < 0)
1756         return NULL;
1757
1758     Py_TYPE(&Permset_Type) = &PyType_Type;
1759     if(PyType_Ready(&Permset_Type) < 0)
1760         return NULL;
1761 #endif
1762
1763     m = PyModule_Create(&posix1emodule);
1764     if (m==NULL)
1765         return NULL;
1766
1767     d = PyModule_GetDict(m);
1768     if (d == NULL)
1769         return NULL;
1770
1771     Py_INCREF(&ACL_Type);
1772     if (PyDict_SetItemString(d, "ACL",
1773                              (PyObject *) &ACL_Type) < 0)
1774         return NULL;
1775
1776     /* 23.3.6 acl_type_t values */
1777     PyModule_AddIntConstant(m, "ACL_TYPE_ACCESS", ACL_TYPE_ACCESS);
1778     PyModule_AddIntConstant(m, "ACL_TYPE_DEFAULT", ACL_TYPE_DEFAULT);
1779
1780
1781 #ifdef HAVE_LEVEL2
1782     Py_INCREF(&Entry_Type);
1783     if (PyDict_SetItemString(d, "Entry",
1784                              (PyObject *) &Entry_Type) < 0)
1785         return NULL;
1786
1787     Py_INCREF(&Permset_Type);
1788     if (PyDict_SetItemString(d, "Permset",
1789                              (PyObject *) &Permset_Type) < 0)
1790         return NULL;
1791
1792     /* 23.2.2 acl_perm_t values */
1793     PyModule_AddIntConstant(m, "ACL_READ", ACL_READ);
1794     PyModule_AddIntConstant(m, "ACL_WRITE", ACL_WRITE);
1795     PyModule_AddIntConstant(m, "ACL_EXECUTE", ACL_EXECUTE);
1796
1797     /* 23.2.5 acl_tag_t values */
1798     PyModule_AddIntConstant(m, "ACL_UNDEFINED_TAG", ACL_UNDEFINED_TAG);
1799     PyModule_AddIntConstant(m, "ACL_USER_OBJ", ACL_USER_OBJ);
1800     PyModule_AddIntConstant(m, "ACL_USER", ACL_USER);
1801     PyModule_AddIntConstant(m, "ACL_GROUP_OBJ", ACL_GROUP_OBJ);
1802     PyModule_AddIntConstant(m, "ACL_GROUP", ACL_GROUP);
1803     PyModule_AddIntConstant(m, "ACL_MASK", ACL_MASK);
1804     PyModule_AddIntConstant(m, "ACL_OTHER", ACL_OTHER);
1805
1806     /* Document extended functionality via easy-to-use constants */
1807     PyModule_AddIntConstant(m, "HAS_ACL_ENTRY", 1);
1808 #else
1809     PyModule_AddIntConstant(m, "HAS_ACL_ENTRY", 0);
1810 #endif
1811
1812 #ifdef HAVE_LINUX
1813     /* Linux libacl specific acl_to_any_text constants */
1814     PyModule_AddIntConstant(m, "TEXT_ABBREVIATE", TEXT_ABBREVIATE);
1815     PyModule_AddIntConstant(m, "TEXT_NUMERIC_IDS", TEXT_NUMERIC_IDS);
1816     PyModule_AddIntConstant(m, "TEXT_SOME_EFFECTIVE", TEXT_SOME_EFFECTIVE);
1817     PyModule_AddIntConstant(m, "TEXT_ALL_EFFECTIVE", TEXT_ALL_EFFECTIVE);
1818     PyModule_AddIntConstant(m, "TEXT_SMART_INDENT", TEXT_SMART_INDENT);
1819
1820     /* Linux libacl specific acl_check constants */
1821     PyModule_AddIntConstant(m, "ACL_MULTI_ERROR", ACL_MULTI_ERROR);
1822     PyModule_AddIntConstant(m, "ACL_DUPLICATE_ERROR", ACL_DUPLICATE_ERROR);
1823     PyModule_AddIntConstant(m, "ACL_MISS_ERROR", ACL_MISS_ERROR);
1824     PyModule_AddIntConstant(m, "ACL_ENTRY_ERROR", ACL_ENTRY_ERROR);
1825
1826 #define LINUX_EXT_VAL 1
1827 #else
1828 #define LINUX_EXT_VAL 0
1829 #endif
1830     /* declare the Linux extensions */
1831     PyModule_AddIntConstant(m, "HAS_ACL_FROM_MODE", LINUX_EXT_VAL);
1832     PyModule_AddIntConstant(m, "HAS_ACL_CHECK", LINUX_EXT_VAL);
1833     PyModule_AddIntConstant(m, "HAS_EXTENDED_CHECK", LINUX_EXT_VAL);
1834     PyModule_AddIntConstant(m, "HAS_EQUIV_MODE", LINUX_EXT_VAL);
1835
1836     PyModule_AddIntConstant(m, "HAS_COPY_EXT",
1837 #ifdef HAVE_ACL_COPY_EXT
1838                             1
1839 #else
1840                             0
1841 #endif
1842                             );
1843     return m;
1844 }