2 xattr - a python module for manipulating filesystem extended attributes
4 Copyright (C) 2002, 2003, 2006, 2008, 2012, 2013, 2015
5 Iustin Pop <iustin@k1024.org>
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or (at your option) any later version.
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 #define PY_SSIZE_T_CLEAN
26 #if defined(__APPLE__) || defined(__linux__)
27 #include <sys/xattr.h>
32 ":param item: a string representing a file-name, a file-like\n" \
33 " object, a file descriptor, or (in Python 3.6+) a path-like\n" \
34 " object; this represents the file on which to act\n"
36 #define NOFOLLOW_DOC \
37 ":param nofollow: if true and if\n" \
38 " the file name given is a symbolic link, the\n" \
39 " function will operate on the symbolic link itself instead\n" \
40 " of its target; defaults to false\n" \
41 ":type nofollow: boolean, optional\n" \
44 ":param namespace: if given, the attribute must not contain the\n" \
45 " namespace, but instead it will be taken from this parameter\n" \
46 ":type namespace: bytes\n"
48 #define NAME_GET_DOC \
49 ":param string name: the attribute whose value to retrieve;\n" \
50 " usually in the form of ``system.posix_acl`` or ``user.mime_type``\n"
52 #define NAME_SET_DOC \
53 ":param string name: the attribute whose value to set;\n" \
54 " usually in the form of ``system.posix_acl`` or ``user.mime_type``\n"
56 #define NAME_REMOVE_DOC \
57 ":param string name: the attribute to remove;\n" \
58 " usually in the form of ``system.posix_acl`` or \n" \
59 " ``user.mime_type``\n"
62 ":param string value: possibly with embedded NULLs; note that there\n" \
63 " are restrictions regarding the size of the value, for\n" \
64 " example, for ext2/ext3, maximum size is the block size\n" \
67 ":param flags: if 0 or omitted the attribute will be\n" \
68 " created or replaced; if :const:`XATTR_CREATE`, the attribute\n" \
69 " will be created, giving an error if it already exists;\n" \
70 " if :const:`XATTR_REPLACE`, the attribute will be replaced,\n" \
71 " giving an error if it doesn't exist;\n" \
72 ":type flags: integer\n"
74 #define NS_CHANGED_DOC \
75 ".. versionchanged:: 0.5.1\n" \
76 " The namespace argument, if passed, cannot be None anymore; to\n" \
77 " explicitly specify an empty namespace, pass an empty\n" \
78 " string (byte string under Python 3)."
81 /* The initial I/O buffer size for list and get operations; if the
82 * actual values will be smaller than this, we save a syscall out of
83 * two and allocate more memory upfront than needed, otherwise we
84 * incur three syscalls (get with ENORANGE, get with 0 to compute
85 * actual size, final get). The test suite is marginally faster (5%)
86 * with this, so it seems worth doing.
88 #define ESTIMATE_ATTR_SIZE 1024
90 typedef enum {T_FD, T_PATH, T_LINK} target_e;
101 /* Cleans up a tgt structure */
102 static void free_tgt(target_t *tgt) {
103 if (tgt->tmp != NULL) {
108 /* Used for cpychecker: */
109 /* The checker automatically defines this preprocessor name when creating
110 the custom attribute: */
111 #if defined(WITH_CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION_ATTRIBUTE)
112 #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION \
113 __attribute__((cpychecker_negative_result_sets_exception))
115 #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
118 static int convert_obj(PyObject *myobj, target_t *tgt, int nofollow)
119 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
121 static int merge_ns(const char *ns, const char *name,
122 const char **result, char **buf)
123 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
126 /** Converts from a string, file or int argument to what we need.
128 * Returns -1 on failure, 0 on success.
130 static int convert_obj(PyObject *myobj, target_t *tgt, int nofollow) {
133 if((fd = PyObject_AsFileDescriptor(myobj)) != -1) {
138 // PyObject_AsFileDescriptor sets an error when failing, so clear
139 // it such that further code works; some method lookups fail if an
140 // error already occured when called, which breaks at least
141 // PyOS_FSPath (called by FSConverter).
144 if(PyUnicode_FSConverter(myobj, &(tgt->tmp))) {
145 tgt->type = nofollow ? T_LINK : T_PATH;
146 tgt->name = PyBytes_AS_STRING(tgt->tmp);
149 // Don't set our own exception type, since we'd ignore the
150 // FSConverter-generated one.
157 /* Combine a namespace string and an attribute name into a
158 fully-qualified name */
159 static int merge_ns(const char *ns, const char *name,
160 const char **result, char **buf) {
161 if(ns != NULL && *ns != '\0') {
163 /* The value of new_size is related to/must be kept in-sync
164 with the format string below */
165 size_t new_size = strlen(ns) + 1 + strlen(name) + 1;
166 if((*buf = PyMem_Malloc(new_size)) == NULL) {
170 cnt = snprintf(*buf, new_size, "%s.%s", ns, name);
171 if((size_t) cnt >= new_size || cnt < 0) {
172 PyErr_SetString(PyExc_ValueError,
173 "unexpected: can't format the attribute name");
185 #if defined(__APPLE__)
186 static inline ssize_t _listxattr(const char *path, char *namebuf, size_t size) {
187 return listxattr(path, namebuf, size, 0);
189 static inline ssize_t _llistxattr(const char *path, char *namebuf, size_t size) {
190 return listxattr(path, namebuf, size, XATTR_NOFOLLOW);
192 static inline ssize_t _flistxattr(int fd, char *namebuf, size_t size) {
193 return flistxattr(fd, namebuf, size, 0);
196 static inline ssize_t _getxattr (const char *path, const char *name, void *value, size_t size) {
197 return getxattr(path, name, value, size, 0, 0);
199 static inline ssize_t _lgetxattr (const char *path, const char *name, void *value, size_t size) {
200 return getxattr(path, name, value, size, 0, XATTR_NOFOLLOW);
202 static inline ssize_t _fgetxattr (int filedes, const char *name, void *value, size_t size) {
203 return fgetxattr(filedes, name, value, size, 0, 0);
206 // [fl]setxattr: Both OS X and Linux define XATTR_CREATE and XATTR_REPLACE for the last option.
207 static inline int _setxattr(const char *path, const char *name, const void *value, size_t size, int flags) {
208 return setxattr(path, name, value, size, 0, flags);
210 static inline int _lsetxattr(const char *path, const char *name, const void *value, size_t size, int flags) {
211 return setxattr(path, name, value, size, 0, flags | XATTR_NOFOLLOW);
213 static inline int _fsetxattr(int filedes, const char *name, const void *value, size_t size, int flags) {
214 return fsetxattr(filedes, name, value, size, 0, flags);
217 static inline int _removexattr(const char *path, const char *name) {
218 return removexattr(path, name, 0);
220 static inline int _lremovexattr(const char *path, const char *name) {
221 return removexattr(path, name, XATTR_NOFOLLOW);
223 static inline int _fremovexattr(int filedes, const char *name) {
224 return fremovexattr(filedes, name, 0);
227 #elif defined(__linux__)
228 #define _listxattr(path, list, size) listxattr(path, list, size)
229 #define _llistxattr(path, list, size) llistxattr(path, list, size)
230 #define _flistxattr(fd, list, size) flistxattr(fd, list, size)
232 #define _getxattr(path, name, value, size) getxattr(path, name, value, size)
233 #define _lgetxattr(path, name, value, size) lgetxattr(path, name, value, size)
234 #define _fgetxattr(fd, name, value, size) fgetxattr(fd, name, value, size)
236 #define _setxattr(path, name, value, size, flags) setxattr(path, name, value, size, flags)
237 #define _lsetxattr(path, name, value, size, flags) lsetxattr(path, name, value, size, flags)
238 #define _fsetxattr(fd, name, value, size, flags) fsetxattr(fd, name, value, size, flags)
240 #define _removexattr(path, name) removexattr(path, name)
241 #define _lremovexattr(path, name) lremovexattr(path, name)
242 #define _fremovexattr(fd, name) fremovexattr(fd, name)
246 typedef ssize_t (*buf_getter)(target_t *tgt, const char *name,
247 void *output, size_t size);
249 static ssize_t _list_obj(target_t *tgt, const char *unused, void *list,
253 Py_BEGIN_ALLOW_THREADS;
254 if(tgt->type == T_FD)
255 ret = _flistxattr(tgt->fd, list, size);
256 else if (tgt->type == T_LINK)
257 ret = _llistxattr(tgt->name, list, size);
259 ret = _listxattr(tgt->name, list, size);
260 Py_END_ALLOW_THREADS;
264 static ssize_t _get_obj(target_t *tgt, const char *name, void *value,
267 Py_BEGIN_ALLOW_THREADS;
268 if(tgt->type == T_FD)
269 ret = _fgetxattr(tgt->fd, name, value, size);
270 else if (tgt->type == T_LINK)
271 ret = _lgetxattr(tgt->name, name, value, size);
273 ret = _getxattr(tgt->name, name, value, size);
274 Py_END_ALLOW_THREADS;
278 static int _set_obj(target_t *tgt, const char *name,
279 const void *value, size_t size, int flags) {
281 Py_BEGIN_ALLOW_THREADS;
282 if(tgt->type == T_FD)
283 ret = _fsetxattr(tgt->fd, name, value, size, flags);
284 else if (tgt->type == T_LINK)
285 ret = _lsetxattr(tgt->name, name, value, size, flags);
287 ret = _setxattr(tgt->name, name, value, size, flags);
288 Py_END_ALLOW_THREADS;
292 static int _remove_obj(target_t *tgt, const char *name) {
294 Py_BEGIN_ALLOW_THREADS;
295 if(tgt->type == T_FD)
296 ret = _fremovexattr(tgt->fd, name);
297 else if (tgt->type == T_LINK)
298 ret = _lremovexattr(tgt->name, name);
300 ret = _removexattr(tgt->name, name);
301 Py_END_ALLOW_THREADS;
305 /* Perform a get/list operation with appropriate buffer size,
306 * determined dynamically.
309 * - getter: the function that actually does the I/O.
310 * - tgt, name: passed to the getter.
311 * - buffer: pointer to either an already allocated memory area (in
312 * which case size contains its current size), or NULL to
313 * allocate. In all cases (success or failure), the caller should
314 * deallocate the buffer, using PyMem_Free().
315 * - size: either size of current buffer (if non-NULL), or size for
316 * initial allocation; zero means use a hardcoded initial buffer
317 * size (ESTIMATE_ATTR_SIZE). The value will be updated upon return
318 * with the current buffer size.
319 * - io_errno: if non-NULL, the actual errno will be recorded here; if
320 * zero, the call was successful and the output/size/nval are valid.
322 * Return value: if positive or zero, buffer will contain the read
323 * value. Otherwise, io_errno will contain the I/O errno, or zero
324 * to signify a Python-level error. In all cases, the Python-level
325 * error is set to the appropriate value.
327 static ssize_t _generic_get(buf_getter getter, target_t *tgt,
332 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
334 static ssize_t _generic_get(buf_getter getter, target_t *tgt,
340 /* Clear errno for now, will only set it when it fails in I/O. */
341 if (io_errno != NULL) {
345 #define EXIT_IOERROR() \
347 if (io_errno != NULL) { \
350 PyErr_SetFromErrno(PyExc_IOError); \
354 /* Initialize the buffer, if needed. */
355 if (*buffer == NULL) {
357 *size = ESTIMATE_ATTR_SIZE;
358 if((*buffer = PyMem_Malloc(*size)) == NULL) {
363 // Try to get the value, while increasing the buffer if too small.
364 while((res = getter(tgt, name, *buffer, *size)) == -1) {
365 if(errno == ERANGE) {
366 ssize_t realloc_size_s = getter(tgt, name, NULL, 0);
367 /* ERANGE + proper size _should_ not fail, but... */
368 if(realloc_size_s == -1) {
371 size_t realloc_size = (size_t) realloc_size_s;
373 if((tmp_buf = PyMem_Realloc(*buffer, realloc_size)) == NULL) {
378 *size = realloc_size;
381 /* else we're dealing with a different error, which we
382 don't know how to handle nicely, so we return */
391 Checks if an attribute name matches an optional namespace.
393 If the namespace is NULL or an empty string, it will return the
394 name itself. If the namespace is non-NULL and the name matches, it
395 will return a pointer to the offset in the name after the namespace
396 and the separator. If however the name doesn't match the namespace,
400 const char *matches_ns(const char *ns, const char *name) {
402 if (ns == NULL || *ns == '\0')
404 ns_size = strlen(ns);
406 if (strlen(name) > (ns_size+1) && !strncmp(name, ns, ns_size) &&
407 name[ns_size] == '.')
408 return name + ns_size + 1;
412 /* Wrapper for getxattr */
413 static char __pygetxattr_doc__[] =
414 "getxattr(item, attribute[, nofollow=False])\n"
415 "Get the value of a given extended attribute (deprecated).\n"
421 ".. deprecated:: 0.4\n"
422 " this function has been deprecated\n"
423 " by the :func:`get` function.\n"
427 pygetxattr(PyObject *self, PyObject *args)
432 char *attrname = NULL;
438 /* Parse the arguments */
439 if (!PyArg_ParseTuple(args, "Oet|i", &myarg, NULL, &attrname, &nofollow))
441 if(convert_obj(myarg, &tgt, nofollow) < 0) {
446 nret = _generic_get(_get_obj, &tgt, attrname, &buf, &nalloc, NULL);
451 /* Create the string which will hold the result */
452 res = PyBytes_FromStringAndSize(buf, nret);
455 /* Free the buffer, now it is no longer needed */
459 PyMem_Free(attrname);
461 /* Return the result */
465 /* Wrapper for getxattr */
466 static char __get_doc__[] =
467 "get(item, name[, nofollow=False, namespace=None])\n"
468 "Get the value of a given extended attribute.\n"
471 " >>> xattr.get('/path/to/file', 'user.comment')\n"
473 " >>> xattr.get('/path/to/file', 'comment', namespace=xattr.NS_USER)\n"
480 ":return: the value of the extended attribute (can contain NULLs)\n"
482 ":raises EnvironmentError: caused by any system errors\n"
484 ".. versionadded:: 0.4\n"
489 xattr_get(PyObject *self, PyObject *args, PyObject *keywds)
494 char *attrname = NULL, *namebuf;
495 const char *fullname;
497 const char *ns = NULL;
500 PyObject *res = NULL;
501 static char *kwlist[] = {"item", "name", "nofollow", "namespace", NULL};
503 /* Parse the arguments */
504 if (!PyArg_ParseTupleAndKeywords(args, keywds, "Oet|iy", kwlist,
505 &myarg, NULL, &attrname, &nofollow, &ns))
508 if(convert_obj(myarg, &tgt, nofollow) < 0) {
512 if(merge_ns(ns, attrname, &fullname, &namebuf) < 0) {
516 nret = _generic_get(_get_obj, &tgt, fullname, &buf, &nalloc, NULL);
521 /* Create the string which will hold the result */
522 res = PyBytes_FromStringAndSize(buf, nret);
524 /* Free the buffers, they are no longer needed */
531 PyMem_Free(attrname);
533 /* Return the result */
537 /* Wrapper for getxattr */
538 static char __get_all_doc__[] =
539 "get_all(item[, nofollow=False, namespace=None])\n"
540 "Get all the extended attributes of an item.\n"
542 "This function performs a bulk-get of all extended attribute names\n"
543 "and the corresponding value.\n"
546 " >>> xattr.get_all('/path/to/file')\n"
547 " [('user.mime-type', 'plain/text'), ('user.comment', 'test'),\n"
548 " ('system.posix_acl_access', '\\x02\\x00...')]\n"
549 " >>> xattr.get_all('/path/to/file', namespace=xattr.NS_USER)\n"
550 " [('mime-type', 'plain/text'), ('comment', 'test')]\n"
553 ":keyword namespace: an optional namespace for filtering the\n"
554 " attributes; for example, querying all user attributes can be\n"
555 " accomplished by passing namespace=:const:`NS_USER`\n"
556 ":type namespace: string\n"
558 ":return: list of tuples (name, value); note that if a namespace\n"
559 " argument was passed, it (and the separator) will be stripped from\n"
560 " the names returned\n"
562 ":raises EnvironmentError: caused by any system errors\n"
564 ".. note:: Since reading the whole attribute list is not an atomic\n"
565 " operation, it might be possible that attributes are added\n"
566 " or removed between the initial query and the actual reading\n"
567 " of the attributes; the returned list will contain only the\n"
568 " attributes that were present at the initial listing of the\n"
569 " attribute names and that were still present when the read\n"
570 " attempt for the value is made.\n"
571 ".. versionadded:: 0.4\n"
576 get_all(PyObject *self, PyObject *args, PyObject *keywds)
578 PyObject *myarg, *res;
580 const char *ns = NULL;
581 char *buf_list = NULL, *buf_val = NULL;
587 static char *kwlist[] = {"item", "nofollow", "namespace", NULL};
590 /* Parse the arguments */
591 if (!PyArg_ParseTupleAndKeywords(args, keywds, "O|iy", kwlist,
592 &myarg, &nofollow, &ns))
594 if(convert_obj(myarg, &tgt, nofollow) < 0)
598 /* Compute first the list of attributes */
599 nlist = _generic_get(_list_obj, &tgt, NULL, &buf_list,
602 /* We can't handle any errors, and the Python error is already
603 set, just bail out. */
607 /* Create the list which will hold the result. */
608 mylist = PyList_New(0);
614 /* Create and insert the attributes as strings in the list */
615 for(s = buf_list; s - buf_list < nlist; s += strlen(s) + 1) {
619 if((name = matches_ns(ns, s)) == NULL)
621 /* Now retrieve the attribute value */
622 nval = _generic_get(_get_obj, &tgt, s, &buf_val, &nalloc, &io_errno);
624 if (io_errno == ENODATA) {
632 my_tuple = Py_BuildValue("yy#", name, buf_val, nval);
633 if (my_tuple == NULL) {
637 int lappend_ret = PyList_Append(mylist, my_tuple);
639 if(lappend_ret < 0) {
645 /* Successful exit */
652 PyMem_Free(buf_list);
657 /* Return the result */
662 static char __pysetxattr_doc__[] =
663 "setxattr(item, name, value[, flags=0, nofollow=False])\n"
664 "Set the value of a given extended attribute (deprecated).\n"
666 "Be careful in case you want to set attributes on symbolic\n"
667 "links, you have to use all the 5 parameters; use 0 for the \n"
668 "flags value if you want the default behaviour (create or "
677 ".. deprecated:: 0.4\n"
678 " this function has been deprecated\n"
679 " by the :func:`set` function.\n"
682 /* Wrapper for setxattr */
684 pysetxattr(PyObject *self, PyObject *args)
686 PyObject *myarg, *res;
688 char *attrname = NULL;
690 Py_ssize_t bufsize_s;
696 /* Parse the arguments */
697 if (!PyArg_ParseTuple(args, "Oetet#|ii", &myarg, NULL, &attrname,
698 NULL, &buf, &bufsize_s, &flags, &nofollow))
702 PyErr_SetString(PyExc_ValueError,
703 "negative value size?!");
707 bufsize = (size_t) bufsize_s;
709 if(convert_obj(myarg, &tgt, nofollow) < 0) {
714 /* Set the attribute's value */
715 nret = _set_obj(&tgt, attrname, buf, bufsize, flags);
720 res = PyErr_SetFromErrno(PyExc_IOError);
728 PyMem_Free(attrname);
731 /* Return the result */
735 static char __set_doc__[] =
736 "set(item, name, value[, flags=0, namespace=None])\n"
737 "Set the value of a given extended attribute.\n"
741 " >>> xattr.set('/path/to/file', 'user.comment', 'test')\n"
742 " >>> xattr.set('/path/to/file', 'comment', 'test',"
743 " namespace=xattr.NS_USER)\n"
752 ":raises EnvironmentError: caused by any system errors\n"
754 ".. versionadded:: 0.4\n"
758 /* Wrapper for setxattr */
760 xattr_set(PyObject *self, PyObject *args, PyObject *keywds)
762 PyObject *myarg, *res;
764 char *attrname = NULL;
766 Py_ssize_t bufsize_s;
771 const char *ns = NULL;
773 const char *full_name;
774 static char *kwlist[] = {"item", "name", "value", "flags",
775 "nofollow", "namespace", NULL};
777 /* Parse the arguments */
778 if (!PyArg_ParseTupleAndKeywords(args, keywds, "Oetet#|iiy",
779 kwlist, &myarg, NULL, &attrname, NULL,
780 &buf, &bufsize_s, &flags, &nofollow, &ns))
784 PyErr_SetString(PyExc_ValueError,
785 "negative value size?!");
789 bufsize = (size_t) bufsize_s;
791 if(convert_obj(myarg, &tgt, nofollow) < 0) {
796 if(merge_ns(ns, attrname, &full_name, &newname) < 0) {
801 /* Set the attribute's value */
802 nret = _set_obj(&tgt, full_name, buf, bufsize, flags);
809 res = PyErr_SetFromErrno(PyExc_IOError);
817 PyMem_Free(attrname);
820 /* Return the result */
825 static char __pyremovexattr_doc__[] =
826 "removexattr(item, name[, nofollow])\n"
827 "Remove an attribute from a file (deprecated).\n"
833 ".. deprecated:: 0.4\n"
834 " this function has been deprecated by the :func:`remove` function.\n"
837 /* Wrapper for removexattr */
839 pyremovexattr(PyObject *self, PyObject *args)
841 PyObject *myarg, *res;
843 char *attrname = NULL;
847 /* Parse the arguments */
848 if (!PyArg_ParseTuple(args, "Oet|i", &myarg, NULL, &attrname, &nofollow))
851 if(convert_obj(myarg, &tgt, nofollow) < 0) {
856 /* Remove the attribute */
857 nret = _remove_obj(&tgt, attrname);
862 res = PyErr_SetFromErrno(PyExc_IOError);
870 PyMem_Free(attrname);
872 /* Return the result */
876 static char __remove_doc__[] =
877 "remove(item, name[, nofollow=False, namespace=None])\n"
878 "Remove an attribute from a file.\n"
882 " >>> xattr.remove('/path/to/file', 'user.comment')\n"
889 ":raises EnvironmentError: caused by any system errors\n"
891 ".. versionadded:: 0.4\n"
895 /* Wrapper for removexattr */
897 xattr_remove(PyObject *self, PyObject *args, PyObject *keywds)
899 PyObject *myarg, *res;
901 char *attrname = NULL, *name_buf;
902 const char *ns = NULL;
903 const char *full_name;
906 static char *kwlist[] = {"item", "name", "nofollow", "namespace", NULL};
908 /* Parse the arguments */
909 if (!PyArg_ParseTupleAndKeywords(args, keywds, "Oet|iy", kwlist,
910 &myarg, NULL, &attrname, &nofollow, &ns))
913 if(convert_obj(myarg, &tgt, nofollow) < 0) {
918 if(merge_ns(ns, attrname, &full_name, &name_buf) < 0) {
923 /* Remove the attribute */
924 nret = _remove_obj(&tgt, full_name);
926 PyMem_Free(name_buf);
931 res = PyErr_SetFromErrno(PyExc_IOError);
939 PyMem_Free(attrname);
941 /* Return the result */
945 static char __pylistxattr_doc__[] =
946 "listxattr(item[, nofollow=False])\n"
947 "Return the list of attribute names for a file (deprecated).\n"
952 ".. deprecated:: 0.4\n"
953 " this function has been deprecated by the :func:`list` function.\n"
956 /* Wrapper for listxattr */
958 pylistxattr(PyObject *self, PyObject *args)
970 /* Parse the arguments */
971 if (!PyArg_ParseTuple(args, "O|i", &myarg, &nofollow))
973 if(convert_obj(myarg, &tgt, nofollow) < 0)
976 nret = _generic_get(_list_obj, &tgt, NULL, &buf, &nalloc, NULL);
982 /* Compute the number of attributes in the list */
983 for(s = buf, nattrs = 0; (s - buf) < nret; s += strlen(s) + 1) {
987 /* Create the list which will hold the result */
988 mylist = PyList_New(nattrs);
993 /* Create and insert the attributes as strings in the list */
994 for(s = buf, nattrs = 0; s - buf < nret; s += strlen(s) + 1) {
995 PyObject *item = PyBytes_FromString(s);
1001 PyList_SET_ITEM(mylist, nattrs, item);
1006 /* Free the buffer, now it is no longer needed */
1010 /* Return the result */
1014 static char __list_doc__[] =
1015 "list(item[, nofollow=False, namespace=None])\n"
1016 "Return the list of attribute names for a file.\n"
1020 " >>> xattr.list('/path/to/file')\n"
1021 " ['user.test', 'user.comment', 'system.posix_acl_access']\n"
1022 " >>> xattr.list('/path/to/file', namespace=xattr.NS_USER)\n"
1023 " ['test', 'comment']\n"
1028 ":returns: the list of attributes; note that if a namespace \n"
1029 " argument was passed, it (and the separator) will be stripped\n"
1033 ":raises EnvironmentError: caused by any system errors\n"
1035 ".. versionadded:: 0.4\n"
1039 /* Wrapper for listxattr */
1041 xattr_list(PyObject *self, PyObject *args, PyObject *keywds)
1049 const char *ns = NULL;
1053 static char *kwlist[] = {"item", "nofollow", "namespace", NULL};
1055 /* Parse the arguments */
1056 if (!PyArg_ParseTupleAndKeywords(args, keywds, "O|iy", kwlist,
1057 &myarg, &nofollow, &ns))
1060 if(convert_obj(myarg, &tgt, nofollow) < 0) {
1063 nret = _generic_get(_list_obj, &tgt, NULL, &buf, &nalloc, NULL);
1068 /* Compute the number of attributes in the list */
1069 for(s = buf, nattrs = 0; (s - buf) < nret; s += strlen(s) + 1) {
1070 if(matches_ns(ns, s) != NULL)
1074 /* Create the list which will hold the result */
1075 if((res = PyList_New(nattrs)) == NULL) {
1079 /* Create and insert the attributes as strings in the list */
1080 for(s = buf, nattrs = 0; s - buf < nret; s += strlen(s) + 1) {
1081 const char *name = matches_ns(ns, s);
1083 PyObject *item = PyBytes_FromString(name);
1089 PyList_SET_ITEM(res, nattrs, item);
1095 /* Free the buffer, now it is no longer needed */
1102 /* Return the result */
1106 static PyMethodDef xattr_methods[] = {
1107 {"getxattr", pygetxattr, METH_VARARGS, __pygetxattr_doc__ },
1108 {"get", (PyCFunction) xattr_get, METH_VARARGS | METH_KEYWORDS,
1110 {"get_all", (PyCFunction) get_all, METH_VARARGS | METH_KEYWORDS,
1112 {"setxattr", pysetxattr, METH_VARARGS, __pysetxattr_doc__ },
1113 {"set", (PyCFunction) xattr_set, METH_VARARGS | METH_KEYWORDS,
1115 {"removexattr", pyremovexattr, METH_VARARGS, __pyremovexattr_doc__ },
1116 {"remove", (PyCFunction) xattr_remove, METH_VARARGS | METH_KEYWORDS,
1118 {"listxattr", pylistxattr, METH_VARARGS, __pylistxattr_doc__ },
1119 {"list", (PyCFunction) xattr_list, METH_VARARGS | METH_KEYWORDS,
1121 {NULL, NULL, 0, NULL} /* Sentinel */
1124 static char __xattr_doc__[] = \
1125 "This module gives access to the extended attributes present\n"
1126 "in some operating systems/filesystems. You can list attributes,\n"
1127 "get, set and remove them.\n"
1129 "The module exposes two sets of functions:\n"
1130 " - the 'old' :func:`listxattr`, :func:`getxattr`, :func:`setxattr`,\n"
1131 " :func:`removexattr`\n"
1132 " functions which are deprecated since version 0.4\n"
1133 " - the new :func:`list`, :func:`get`, :func:`get_all`, :func:`set`,\n"
1134 " :func:`remove` functions\n"
1135 " which expose a namespace-aware API and simplify a bit the calling\n"
1136 " model by using keyword arguments\n"
1139 " >>> import xattr\n"
1140 " >>> xattr.listxattr(\"file.txt\")\n"
1141 " ['user.mime_type']\n"
1142 " >>> xattr.getxattr(\"file.txt\", \"user.mime_type\")\n"
1144 " >>> xattr.setxattr(\"file.txt\", \"user.comment\", "
1145 "\"Simple text file\")\n"
1146 " >>> xattr.listxattr(\"file.txt\")\n"
1147 " ['user.mime_type', 'user.comment']\n"
1148 " >>> xattr.removexattr (\"file.txt\", \"user.comment\")\n"
1150 ".. note:: Most or all errors reported by the system while using\n"
1151 " the ``xattr`` library will be reported by raising\n"
1152 " a :exc:`EnvironmentError`; under\n"
1153 " Linux, the following ``errno`` values are used:\n"
1155 " - ``ENODATA`` means that the attribute name is invalid\n"
1156 " - ``ENOTSUP`` and ``EOPNOTSUPP`` mean that the filesystem does not\n"
1157 " support extended attributes, or that the namespace is invalid\n"
1158 " - ``E2BIG`` mean that the attribute value is too big\n"
1159 " - ``ERANGE`` mean that the attribute name is too big (it might also\n"
1160 " mean an error in the xattr module itself)\n"
1161 " - ``ENOSPC`` and ``EDQUOT`` are documented as meaning out of disk\n"
1162 " space or out of disk space because of quota limits\n"
1163 ".. note:: Under Python 3, the namespace argument is a byte string,\n"
1164 " not a unicode string.\n"
1168 static struct PyModuleDef xattrmodule = {
1169 PyModuleDef_HEAD_INIT,
1176 #define INITERROR return NULL
1182 PyObject *ns_security = NULL;
1183 PyObject *ns_system = NULL;
1184 PyObject *ns_trusted = NULL;
1185 PyObject *ns_user = NULL;
1186 PyObject *m = PyModule_Create(&xattrmodule);
1190 PyModule_AddStringConstant(m, "__author__", _XATTR_AUTHOR);
1191 PyModule_AddStringConstant(m, "__contact__", _XATTR_EMAIL);
1192 PyModule_AddStringConstant(m, "__version__", _XATTR_VERSION);
1193 PyModule_AddStringConstant(m, "__license__",
1194 "GNU Lesser General Public License (LGPL)");
1195 PyModule_AddStringConstant(m, "__docformat__", "restructuredtext en");
1197 PyModule_AddIntConstant(m, "XATTR_CREATE", XATTR_CREATE);
1198 PyModule_AddIntConstant(m, "XATTR_REPLACE", XATTR_REPLACE);
1200 /* namespace constants */
1201 if((ns_security = PyBytes_FromString("security")) == NULL)
1203 if((ns_system = PyBytes_FromString("system")) == NULL)
1205 if((ns_trusted = PyBytes_FromString("trusted")) == NULL)
1207 if((ns_user = PyBytes_FromString("user")) == NULL)
1210 /* Add the new objects to the module */
1211 /* TODO: after switching to min 3.10, use the *Ref version, and simplify
1212 the error handling. */
1213 if(PyModule_AddObject(m, "NS_SECURITY", ns_security) < 0)
1216 if(PyModule_AddObject(m, "NS_SYSTEM", ns_system) < 0)
1219 if(PyModule_AddObject(m, "NS_TRUSTED", ns_trusted) < 0)
1222 if(PyModule_AddObject(m, "NS_USER", ns_user) < 0)
1229 Py_XDECREF(ns_user);
1230 Py_XDECREF(ns_trusted);
1231 Py_XDECREF(ns_system);
1232 Py_XDECREF(ns_security);