acl.c

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