From 3e48adc322cdeef188edb900b9d4f6bc6013ffda Mon Sep 17 00:00:00 2001 From: Iustin Pop Date: Mon, 30 Jun 2008 23:03:46 +0200 Subject: [PATCH] Imported Upstream version 0.4.0 --- COPYING | 510 +++++++++++++++++++++ COPYING.LGPL-3 | 165 ------- MANIFEST | 7 - MANIFEST.in | 9 +- NEWS | 58 ++- PKG-INFO | 4 +- README | 29 +- epydoc.conf | 27 ++ pyxattr.egg-info/PKG-INFO | 4 +- pyxattr.egg-info/SOURCES.txt | 4 +- setup.py | 20 +- test/test_xattr.py | 268 +++++++++-- xattr.c | 839 +++++++++++++++++++++++++++++------ 13 files changed, 1580 insertions(+), 364 deletions(-) create mode 100644 COPYING delete mode 100644 COPYING.LGPL-3 delete mode 100644 MANIFEST create mode 100644 epydoc.conf diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..2d2d780 --- /dev/null +++ b/COPYING @@ -0,0 +1,510 @@ + + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations +below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it +becomes a de-facto standard. To achieve this, non-free programs must +be allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control +compilation and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at least + three years, to give the same user the materials specified in + Subsection 6a, above, for a charge no more than the cost of + performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply, and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License +may add an explicit geographical distribution limitation excluding those +countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms +of the ordinary General Public License). + + To apply these terms, attach the following notices to the library. +It is safest to attach them to the start of each source file to most +effectively convey the exclusion of warranty; and each file should +have at least the "copyright" line and a pointer to where the full +notice is found. + + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or +your school, if any, to sign a "copyright disclaimer" for the library, +if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James + Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/COPYING.LGPL-3 b/COPYING.LGPL-3 deleted file mode 100644 index fc8a5de..0000000 --- a/COPYING.LGPL-3 +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - - Each version is given a distinguishing version number. If the -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/MANIFEST b/MANIFEST deleted file mode 100644 index 5922d65..0000000 --- a/MANIFEST +++ /dev/null @@ -1,7 +0,0 @@ -NEWS -README -setup.cfg -setup.py -xattr.c -xattr.html -xattr.txt diff --git a/MANIFEST.in b/MANIFEST.in index 93e54f1..efa600a 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,7 @@ -include setup.cfg +include COPYING +include NEWS include README +include epydoc.conf +include setup.cfg +include test/test_xattr.py include xattr.c -include MANIFEST -include NEWS -include COPYING.LGPL-3 diff --git a/NEWS b/NEWS index 800d791..6c9ffbb 100644 --- a/NEWS +++ b/NEWS @@ -1,19 +1,49 @@ -v0.3.0 ------- +Version 0.4 +=========== - * change licence from GPL to LGPL (3 or later) - * change listxattr return type from tuple to a list - * developer-related: add unittests +API +--- -v0.2.2 ------- +The old functions ({get,set,list,remove}xattr) are deprecated and replaced with +a new API that is namespace-aware and hopefully will allow other OSes (e.g. +FreeBSD) to be supported more naturally. - * fix listing symlink xattrs +Both the old and the new API are supported in the 0.4 versions, however users +are encouraged to migrate to the new API. -News in 0.2.1 -------------- +New features +------------ - * fixed a bug when reading symlink EAs (you weren't able to - do it, actually) - * fix a possible memory leak when the actual read of the EA - failed but the call to get the length of the EA didn't +A new bulk get function called get_all() has been added that should be somewhat +faster in case of querying files which have many attributes. + +License +------- + +Since LGPLv3 is not compatible with GPLv2 (which unfortunately I didn't realize +before), the license was changed to LGPLv2.1 or later. + +Internals +--------- + +Unittest coverage was improved. + +Version 0.3 +=========== + +* changed licence from GPL to LGPL (3 or later) +* changed listxattr return type from tuple to a list +* developer-related: added unittests + +Version 0.2.2 +============= + +* fixed listing symlink xattrs + +Version 0.2.1 +============= + +* fixed a bug when reading symlink EAs (you weren't able to + do it, actually) +* fixed a possible memory leak when the actual read of the EA + failed but the call to get the length of the EA didn't diff --git a/PKG-INFO b/PKG-INFO index 25c5a63..22d8588 100644 --- a/PKG-INFO +++ b/PKG-INFO @@ -1,8 +1,8 @@ Metadata-Version: 1.0 Name: pyxattr -Version: 0.3.0 +Version: 0.4.0 Summary: Filesystem extended attributes for python -Home-page: http://pyxattr.sourceforge.net +Home-page: http://pyxattr.sourceforge.net/ Author: Iustin Pop Author-email: iusty@k1024.org License: LGPL diff --git a/README b/README index 73e68de..0bbf5e0 100644 --- a/README +++ b/README @@ -1,15 +1,32 @@ +pyxattr +======= + +About +----- + This is the pyxattr module, a Python extension module which gives access to the extended attributes for filesystem objects available in some operating systems. -For usage details, see the documentation of the module using pydoc. -The project web page is http://pyxattr.sourceforge.net +For usage details, see the documentation of the module using epydoc. +The project web page is http://pyxattr.sourceforge.net/ You need to have setuptools installed in order to build and install the module. -Author: Iustin Pop, +License +------- + +pyxattr is Copyright 2002-2008 Iustin Pop. + +pyxattr is free software; you can redistribute it and/or modify it under the +terms of the GNU Lesser General Public License as published by the Free +Software Foundation; either version 2.1 of the License, or (at your option) any +later version. See the COPYING file for the full license terms. + +Note that previous versions had different licenses: version 0.3 was licensed +under LGPL version 3 (which, I realized later, is not compatible with GPLv2, +hence the change to LGPL 2.1), and even older versions were licensed under GPL +v2 or later. -Starting with version 0.3, pyxattr is licensed under the GNU LGPL, -version 3 or any later version (see COPYING.LPGL-3). Previous versions -were licensed under GPL v2 or later. +Iustin Pop, diff --git a/epydoc.conf b/epydoc.conf new file mode 100644 index 0000000..f9c154f --- /dev/null +++ b/epydoc.conf @@ -0,0 +1,27 @@ +[epydoc] + +modules: xattr + +output: html + +target: html/ + +verbosity: 0 + +debug: 0 + +simple-term: 1 + +parse: no + +introspect: yes + +imports: no + +sourcecode: no + +name: Filesystem extended attributes for python + +url: http://pyxattr.sourceforge.net/ + +frames: yes diff --git a/pyxattr.egg-info/PKG-INFO b/pyxattr.egg-info/PKG-INFO index 25c5a63..22d8588 100644 --- a/pyxattr.egg-info/PKG-INFO +++ b/pyxattr.egg-info/PKG-INFO @@ -1,8 +1,8 @@ Metadata-Version: 1.0 Name: pyxattr -Version: 0.3.0 +Version: 0.4.0 Summary: Filesystem extended attributes for python -Home-page: http://pyxattr.sourceforge.net +Home-page: http://pyxattr.sourceforge.net/ Author: Iustin Pop Author-email: iusty@k1024.org License: LGPL diff --git a/pyxattr.egg-info/SOURCES.txt b/pyxattr.egg-info/SOURCES.txt index 0f89b98..31a43a3 100644 --- a/pyxattr.egg-info/SOURCES.txt +++ b/pyxattr.egg-info/SOURCES.txt @@ -1,8 +1,8 @@ -COPYING.LGPL-3 -MANIFEST +COPYING MANIFEST.in NEWS README +epydoc.conf setup.cfg setup.py xattr.c diff --git a/setup.py b/setup.py index ddb4381..02e4098 100755 --- a/setup.py +++ b/setup.py @@ -7,16 +7,24 @@ from setuptools import setup, Extension long_desc = """This is a C extension module for Python which implements extended attributes manipulation. It is a wrapper on top of the attr C library - see attr(5).""" -version = "0.3.0" - +version = "0.4.0" +author = "Iustin Pop" +author_email = "iusty@k1024.org" +macros = [ + ("_XATTR_VERSION", '"%s"' % version), + ("_XATTR_AUTHOR", '"%s"' % author), + ("_XATTR_EMAIL", '"%s"' % author_email), + ] setup(name = "pyxattr", version = version, description = "Filesystem extended attributes for python", long_description = long_desc, - author = "Iustin Pop", - author_email = "iusty@k1024.org", - url = "http://pyxattr.sourceforge.net", + author = author, + author_email = author_email, + url = "http://pyxattr.sourceforge.net/", license = "LGPL", - ext_modules = [Extension("xattr", ["xattr.c"], libraries=["attr"])], + ext_modules = [Extension("xattr", ["xattr.c"], + libraries=["attr"], + define_macros=macros)], test_suite = "test/test_xattr", ) diff --git a/test/test_xattr.py b/test/test_xattr.py index 58930ac..2f4abb0 100644 --- a/test/test_xattr.py +++ b/test/test_xattr.py @@ -7,10 +7,16 @@ import os import errno import xattr +from xattr import NS_USER, XATTR_CREATE, XATTR_REPLACE + +TEST_DIR = os.environ.get("TESTDIR", ".") + class xattrTest(unittest.TestCase): - USER_ATTR = "user.test" + USER_NN = "test" + USER_ATTR = "%s.%s" % (NS_USER, USER_NN) USER_VAL = "abc" + MANYOPS_COUNT = 131072 def setUp(self): """set up function""" @@ -20,36 +26,45 @@ class xattrTest(unittest.TestCase): def tearDown(self): """tear down function""" for fname in self.rmfiles: - os.unlink(fname) + try: + os.unlink(fname) + except EnvironmentError: + continue for dname in self.rmdirs: - os.rmdir(dname) + try: + os.rmdir(dname) + except EnvironmentError: + continue def _getfile(self): """create a temp file""" - fh, fname = tempfile.mkstemp(".test", "xattr-", ".") + fh, fname = tempfile.mkstemp(".test", "xattr-", TEST_DIR) self.rmfiles.append(fname) return fh, fname def _getdir(self): """create a temp dir""" - dname = tempfile.mkdtemp(".test", "xattr-", ".") + dname = tempfile.mkdtemp(".test", "xattr-", TEST_DIR) self.rmdirs.append(dname) return dname - def _getsymlink(self): + def _getsymlink(self, dangling=True): """create a symlink""" fh, fname = self._getfile() os.close(fh) - os.unlink(fname) - os.symlink(fname + ".non-existent", fname) - return fname + if dangling: + os.unlink(fname) + sname = fname + ".symlink" + os.symlink(fname, sname) + self.rmfiles.append(sname) + return fname, sname - def _checkListSetGet(self, item, symlink=False): - """check list, set, get operations against an item""" + def _checkDeprecated(self, item, symlink=False): + """check deprecated list, set, get operations against an item""" self.failUnlessEqual(xattr.listxattr(item, symlink), []) self.failUnlessRaises(EnvironmentError, xattr.setxattr, item, self.USER_ATTR, self.USER_VAL, - xattr.XATTR_REPLACE) + XATTR_REPLACE) try: xattr.setxattr(item, self.USER_ATTR, self.USER_VAL, 0, symlink) except IOError, err: @@ -60,45 +75,151 @@ class xattrTest(unittest.TestCase): raise self.failUnlessRaises(EnvironmentError, xattr.setxattr, item, self.USER_ATTR, self.USER_VAL, - xattr.XATTR_CREATE) + XATTR_CREATE) self.failUnlessEqual(xattr.listxattr(item, symlink), [self.USER_ATTR]) self.failUnlessEqual(xattr.getxattr(item, self.USER_ATTR, symlink), self.USER_VAL) + self.failUnlessEqual(xattr.get_all(item, nofollow=symlink), + [(self.USER_ATTR, self.USER_VAL)]) xattr.removexattr(item, self.USER_ATTR) self.failUnlessEqual(xattr.listxattr(item, symlink), []) + self.failUnlessEqual(xattr.get_all(item, nofollow=symlink), []) self.failUnlessRaises(EnvironmentError, xattr.removexattr, item, self.USER_ATTR) - def testNoXattr(self): - """test no attributes""" + def _checkListSetGet(self, item, symlink=False, use_ns=False): + """check list, set, get operations against an item""" + self.failUnlessEqual(xattr.list(item, symlink), []) + self.failUnlessRaises(EnvironmentError, xattr.set, item, + self.USER_ATTR, self.USER_VAL, + flags=XATTR_REPLACE) + self.failUnlessRaises(EnvironmentError, xattr.set, item, + self.USER_NN, self.USER_VAL, + flags=XATTR_REPLACE, + namespace=NS_USER) + try: + if use_ns: + xattr.set(item, self.USER_NN, self.USER_VAL, + namespace=NS_USER, + nofollow=symlink) + else: + xattr.set(item, self.USER_ATTR, self.USER_VAL, + nofollow=symlink) + except IOError, err: + if err.errno == errno.EPERM and symlink: + # symlinks may fail, in which case we abort the rest + # of the test for this case + return + raise + self.failUnlessRaises(EnvironmentError, xattr.set, item, + self.USER_ATTR, self.USER_VAL, + flags=XATTR_CREATE) + self.failUnlessRaises(EnvironmentError, xattr.set, item, + self.USER_NN, self.USER_VAL, + flags=XATTR_CREATE, + namespace=NS_USER) + self.failUnlessEqual(xattr.list(item, nofollow=symlink), + [self.USER_ATTR]) + self.failUnlessEqual(xattr.list(item, namespace=NS_USER, + nofollow=symlink), + [self.USER_NN]) + self.failUnlessEqual(xattr.get(item, self.USER_ATTR, nofollow=symlink), + self.USER_VAL) + self.failUnlessEqual(xattr.get(item, self.USER_NN, nofollow=symlink, + namespace=NS_USER), + self.USER_VAL) + self.failUnlessEqual(xattr.get_all(item, nofollow=symlink), + [(self.USER_ATTR, self.USER_VAL)]) + self.failUnlessEqual(xattr.get_all(item, nofollow=symlink, + namespace=NS_USER), + [(self.USER_NN, self.USER_VAL)]) + if use_ns: + xattr.remove(item, self.USER_NN, namespace=NS_USER) + else: + xattr.remove(item, self.USER_ATTR) + self.failUnlessEqual(xattr.list(item, symlink), []) + self.failUnlessEqual(xattr.get_all(item, nofollow=symlink), []) + self.failUnlessRaises(EnvironmentError, xattr.remove, + item, self.USER_ATTR, nofollow=symlink) + self.failUnlessRaises(EnvironmentError, xattr.remove, + item, self.USER_NN, namespace=NS_USER, + nofollow=symlink) + + def testNoXattrDeprecated(self): + """test no attributes (deprecated functions)""" fh, fname = self._getfile() self.failUnlessEqual(xattr.listxattr(fname), []) + self.failUnlessEqual(xattr.get_all(fname), []) dname = self._getdir() self.failUnlessEqual(xattr.listxattr(dname), []) - sname = self._getsymlink() + self.failUnlessEqual(xattr.get_all(dname), []) + _, sname = self._getsymlink() self.failUnlessEqual(xattr.listxattr(sname, True), []) + self.failUnlessEqual(xattr.get_all(sname, nofollow=True), []) + + def testNoXattr(self): + """test no attributes""" + fh, fname = self._getfile() + self.failUnlessEqual(xattr.list(fname), []) + self.failUnlessEqual(xattr.list(fname, namespace=NS_USER), []) + self.failUnlessEqual(xattr.get_all(fname), []) + self.failUnlessEqual(xattr.get_all(fname, namespace=NS_USER), []) + dname = self._getdir() + self.failUnlessEqual(xattr.list(dname), []) + self.failUnlessEqual(xattr.list(dname, namespace=NS_USER), []) + self.failUnlessEqual(xattr.get_all(dname), []) + self.failUnlessEqual(xattr.get_all(dname, namespace=NS_USER), []) + _, sname = self._getsymlink() + self.failUnlessEqual(xattr.list(sname, nofollow=True), []) + self.failUnlessEqual(xattr.list(sname, nofollow=True, + namespace=NS_USER), []) + self.failUnlessEqual(xattr.get_all(sname, nofollow=True), []) + self.failUnlessEqual(xattr.get_all(sname, nofollow=True, + namespace=NS_USER), []) + + def testFileByNameDeprecated(self): + """test set and retrieve one attribute by file name (deprecated)""" + fh, fname = self._getfile() + self._checkDeprecated(fname) + os.close(fh) def testFileByName(self): """test set and retrieve one attribute by file name""" fh, fname = self._getfile() self._checkListSetGet(fname) + self._checkListSetGet(fname, use_ns=True) + os.close(fh) + + def testFileByDescriptorDeprecated(self): + """test file descriptor operations (deprecated functions)""" + fh, fname = self._getfile() + self._checkDeprecated(fh) os.close(fh) def testFileByDescriptor(self): """test file descriptor operations""" fh, fname = self._getfile() self._checkListSetGet(fh) + self._checkListSetGet(fh, use_ns=True) os.close(fh) + def testFileByObjectDeprecated(self): + """test file descriptor operations (deprecated functions)""" + fh, fname = self._getfile() + fo = os.fdopen(fh) + self._checkDeprecated(fo) + fo.close() + def testFileByObject(self): """test file descriptor operations""" fh, fname = self._getfile() fo = os.fdopen(fh) self._checkListSetGet(fo) + self._checkListSetGet(fo, use_ns=True) fo.close() - def testMixedAccess(self): - """test mixed access to file""" + def testMixedAccessDeprecated(self): + """test mixed access to file (deprecated functions)""" fh, fname = self._getfile() fo = os.fdopen(fh) self.failUnlessEqual(xattr.listxattr(fname), []) @@ -106,35 +227,130 @@ class xattrTest(unittest.TestCase): self.failUnlessEqual(xattr.listxattr(fh), [self.USER_ATTR]) self.failUnlessEqual(xattr.getxattr(fo, self.USER_ATTR), self.USER_VAL) + self.failUnlessEqual(xattr.get_all(fo), + [(self.USER_ATTR, self.USER_VAL)]) + self.failUnlessEqual(xattr.get_all(fname), + [(self.USER_ATTR, self.USER_VAL)]) + + def testMixedAccess(self): + """test mixed access to file""" + fh, fname = self._getfile() + fo = os.fdopen(fh) + self.failUnlessEqual(xattr.list(fname), []) + xattr.set(fname, self.USER_ATTR, self.USER_VAL) + self.failUnlessEqual(xattr.list(fh), [self.USER_ATTR]) + self.failUnlessEqual(xattr.list(fh, namespace=NS_USER), + [self.USER_NN]) + self.failUnlessEqual(xattr.get(fo, self.USER_ATTR), + self.USER_VAL) + self.failUnlessEqual(xattr.get(fo, self.USER_NN, namespace=NS_USER), + self.USER_VAL) + self.failUnlessEqual(xattr.get_all(fo), + [(self.USER_ATTR, self.USER_VAL)]) + self.failUnlessEqual(xattr.get_all(fo, namespace=NS_USER), + [(self.USER_NN, self.USER_VAL)]) + self.failUnlessEqual(xattr.get_all(fname), + [(self.USER_ATTR, self.USER_VAL)]) + self.failUnlessEqual(xattr.get_all(fname, namespace=NS_USER), + [(self.USER_NN, self.USER_VAL)]) + + def testDirOpsDeprecated(self): + """test attribute setting on directories (deprecated functions)""" + dname = self._getdir() + self._checkDeprecated(dname) def testDirOps(self): """test attribute setting on directories""" dname = self._getdir() self._checkListSetGet(dname) + self._checkListSetGet(dname, use_ns=True) + + def testSymlinkOpsDeprecated(self): + """test symlink operations (deprecated functions)""" + _, sname = self._getsymlink() + self.failUnlessRaises(EnvironmentError, xattr.listxattr, sname) + self._checkDeprecated(sname, symlink=True) + target, sname = self._getsymlink(dangling=False) + xattr.setxattr(target, self.USER_ATTR, self.USER_VAL) + self.failUnlessEqual(xattr.listxattr(target), [self.USER_ATTR]) + self.failUnlessEqual(xattr.listxattr(sname, True), []) + self.failUnlessRaises(EnvironmentError, xattr.removexattr, sname, + self.USER_ATTR, True) + xattr.removexattr(sname, self.USER_ATTR, False) def testSymlinkOps(self): """test symlink operations""" - sname = self._getsymlink() - self.failUnlessRaises(EnvironmentError, xattr.listxattr, sname) + _, sname = self._getsymlink() + self.failUnlessRaises(EnvironmentError, xattr.list, sname) self._checkListSetGet(sname, symlink=True) + self._checkListSetGet(sname, symlink=True, use_ns=True) + target, sname = self._getsymlink(dangling=False) + xattr.set(target, self.USER_ATTR, self.USER_VAL) + self.failUnlessEqual(xattr.list(target), [self.USER_ATTR]) + self.failUnlessEqual(xattr.list(sname, nofollow=True), []) + self.failUnlessRaises(EnvironmentError, xattr.remove, sname, + self.USER_ATTR, nofollow=True) + xattr.remove(sname, self.USER_ATTR, nofollow=False) - def testBinaryPayload(self): - """test binary values""" + def testBinaryPayloadDeprecated(self): + """test binary values (deprecated functions)""" fh, fname = self._getfile() os.close(fh) BINVAL = "abc" + '\0' + "def" xattr.setxattr(fname, self.USER_ATTR, BINVAL) self.failUnlessEqual(xattr.listxattr(fname), [self.USER_ATTR]) self.failUnlessEqual(xattr.getxattr(fname, self.USER_ATTR), BINVAL) + self.failUnlessEqual(xattr.get_all(fname), [(self.USER_ATTR, BINVAL)]) xattr.removexattr(fname, self.USER_ATTR) - def testManyOps(self): - """test many ops""" + def testBinaryPayload(self): + """test binary values""" + fh, fname = self._getfile() + os.close(fh) + BINVAL = "abc" + '\0' + "def" + xattr.set(fname, self.USER_ATTR, BINVAL) + self.failUnlessEqual(xattr.list(fname), [self.USER_ATTR]) + self.failUnlessEqual(xattr.list(fname, namespace=NS_USER), + [self.USER_NN]) + self.failUnlessEqual(xattr.get(fname, self.USER_ATTR), BINVAL) + self.failUnlessEqual(xattr.get(fname, self.USER_NN, + namespace=NS_USER), BINVAL) + self.failUnlessEqual(xattr.get_all(fname), [(self.USER_ATTR, BINVAL)]) + self.failUnlessEqual(xattr.get_all(fname, namespace=NS_USER), + [(self.USER_NN, BINVAL)]) + xattr.remove(fname, self.USER_ATTR) + + def testManyOpsDeprecated(self): + """test many ops (deprecated functions)""" fh, fname = self._getfile() xattr.setxattr(fh, self.USER_ATTR, self.USER_VAL) VL = [self.USER_ATTR] - for i in range(131072): + for i in range(self.MANYOPS_COUNT): self.failUnlessEqual(xattr.listxattr(fh), VL) - for i in range(131072): + for i in range(self.MANYOPS_COUNT): self.failUnlessEqual(xattr.getxattr(fh, self.USER_ATTR), self.USER_VAL) + for i in range(self.MANYOPS_COUNT): + self.failUnlessEqual(xattr.get_all(fh), + [(self.USER_ATTR, self.USER_VAL)]) + + def testManyOps(self): + """test many ops""" + fh, fname = self._getfile() + xattr.set(fh, self.USER_ATTR, self.USER_VAL) + VL = [self.USER_ATTR] + VN = [self.USER_NN] + for i in range(self.MANYOPS_COUNT): + self.failUnlessEqual(xattr.list(fh), VL) + self.failUnlessEqual(xattr.list(fh, namespace=NS_USER), VN) + for i in range(self.MANYOPS_COUNT): + self.failUnlessEqual(xattr.get(fh, self.USER_ATTR), + self.USER_VAL) + self.failUnlessEqual(xattr.get(fh, self.USER_NN, + namespace=NS_USER), + self.USER_VAL) + for i in range(self.MANYOPS_COUNT): + self.failUnlessEqual(xattr.get_all(fh), + [(self.USER_ATTR, self.USER_VAL)]) + self.failUnlessEqual(xattr.get_all(fh, namespace=NS_USER), + [(self.USER_NN, self.USER_VAL)]) diff --git a/xattr.c b/xattr.c index 25bc169..9609fa3 100644 --- a/xattr.c +++ b/xattr.c @@ -1,61 +1,165 @@ +#define PY_SSIZE_T_CLEAN #include #include +#include + +/* Compatibility with python 2.4 regarding python size type (PEP 353) */ +#if PY_VERSION_HEX < 0x02050000 && !defined(PY_SSIZE_T_MIN) +typedef int Py_ssize_t; +#define PY_SSIZE_T_MAX INT_MAX +#define PY_SSIZE_T_MIN INT_MIN +#endif + +/* the estimated (startup) attribute buffer size in + multi-operations */ +#define ESTIMATE_ATTR_SIZE 256 + +typedef enum {T_FD, T_PATH, T_LINK} target_e; + +typedef struct { + target_e type; + union { + const char *name; + int fd; + }; +} target_t; /** Converts from a string, file or int argument to what we need. */ -static int convertObj(PyObject *myobj, int *ishandle, int *filehandle, - char **filename) { +static int convertObj(PyObject *myobj, target_t *tgt, int nofollow) { + int fd; if(PyString_Check(myobj)) { - *ishandle = 0; - *filename = PyString_AS_STRING(myobj); - } else if((*filehandle = PyObject_AsFileDescriptor(myobj)) != -1) { - *ishandle = 1; + tgt->type = nofollow ? T_LINK : T_PATH; + tgt->name = PyString_AS_STRING(myobj); + } else if((fd = PyObject_AsFileDescriptor(myobj)) != -1) { + tgt->type = T_FD; + tgt->fd = fd; } else { - PyErr_SetString(PyExc_TypeError, "argument 1 must be string or int"); + PyErr_SetString(PyExc_TypeError, "argument must be string or int"); return 0; } return 1; } +/* Combine a namespace string and an attribute name into a + fully-qualified name */ +static const char* merge_ns(const char *ns, const char *name, char **buf) { + if(ns != NULL) { + int cnt; + size_t new_size = strlen(ns) + 1 + strlen(name) + 1; + if((*buf = PyMem_Malloc(new_size)) == NULL) { + PyErr_NoMemory(); + return NULL; + } + cnt = snprintf(*buf, new_size, "%s.%s", ns, name); + if(cnt > new_size || cnt < 0) { + PyErr_SetString(PyExc_ValueError, + "can't format the attribute name"); + PyMem_Free(*buf); + return NULL; + } + return *buf; + } else { + *buf = NULL; + return name; + } +} + +static ssize_t _list_obj(target_t *tgt, char *list, size_t size) { + if(tgt->type == T_FD) + return flistxattr(tgt->fd, list, size); + else if (tgt->type == T_LINK) + return llistxattr(tgt->name, list, size); + else + return listxattr(tgt->name, list, size); +} + +static ssize_t _get_obj(target_t *tgt, const char *name, void *value, + size_t size) { + if(tgt->type == T_FD) + return fgetxattr(tgt->fd, name, value, size); + else if (tgt->type == T_LINK) + return lgetxattr(tgt->name, name, value, size); + else + return getxattr(tgt->name, name, value, size); +} + +static int _set_obj(target_t *tgt, const char *name, + const void *value, size_t size, int flags) { + if(tgt->type == T_FD) + return fsetxattr(tgt->fd, name, value, size, flags); + else if (tgt->type == T_LINK) + return lsetxattr(tgt->name, name, value, size, flags); + else + return setxattr(tgt->name, name, value, size, flags); +} + +static int _remove_obj(target_t *tgt, const char *name) { + if(tgt->type == T_FD) + return fremovexattr(tgt->fd, name); + else if (tgt->type == T_LINK) + return lremovexattr(tgt->name, name); + else + return removexattr(tgt->name, name); +} + +/* + Checks if an attribute name matches an optional namespace. + + If the namespace is NULL, it will return the name itself. If the + namespace is non-NULL and the name matches, it will return a + pointer to the offset in the name after the namespace and the + separator. If however the name doesn't match the namespace, it will + return NULL. +*/ +const char *matches_ns(const char *ns, const char *name) { + size_t ns_size; + if (ns == NULL) + return name; + ns_size = strlen(ns); + + if (strlen(name) > (ns_size+1) && !strncmp(name, ns, ns_size) && + name[ns_size] == '.') + return name + ns_size + 1; + return NULL; +} + /* Wrapper for getxattr */ static char __pygetxattr_doc__[] = - "Get the value of a given extended attribute.\n" + "Get the value of a given extended attribute (deprecated).\n" "\n" "Parameters:\n" - "\t- a string representing filename, or a file-like object,\n" - "\t or a file descriptor; this represents the file on \n" - "\t which to act\n" - "\t- a string, representing the attribute whose value to retrieve;\n" - "\t usually in form of system.posix_acl or user.mime_type\n" - "\t- (optional) a boolean value (defaults to false), which, if\n" - "\t the file name given is a symbolic link, makes the\n" - "\t function operate on the symbolic link itself instead\n" - "\t of its target;" + " - a string representing filename, or a file-like object,\n" + " or a file descriptor; this represents the file on \n" + " which to act\n" + " - a string, representing the attribute whose value to retrieve;\n" + " usually in form of system.posix_acl or user.mime_type\n" + " - (optional) a boolean value (defaults to false), which, if\n" + " the file name given is a symbolic link, makes the\n" + " function operate on the symbolic link itself instead\n" + " of its target;\n" + "@deprecated: since version 0.4, this function has been deprecated\n" + " by the L{get} function\n" ; static PyObject * pygetxattr(PyObject *self, PyObject *args) { PyObject *myarg; - char *file = NULL; - int filedes = -1, ishandle, dolink=0; + target_t tgt; + int nofollow=0; char *attrname; char *buf; - int nalloc, nret; + ssize_t nalloc, nret; PyObject *res; /* Parse the arguments */ - if (!PyArg_ParseTuple(args, "Os|i", &myarg, &attrname, &dolink)) + if (!PyArg_ParseTuple(args, "Os|i", &myarg, &attrname, &nofollow)) return NULL; - if(!convertObj(myarg, &ishandle, &filedes, &file)) + if(!convertObj(myarg, &tgt, nofollow)) return NULL; /* Find out the needed size of the buffer */ - nalloc = ishandle ? - fgetxattr(filedes, attrname, NULL, 0) : - dolink ? - lgetxattr(file, attrname, NULL, 0) : - getxattr(file, attrname, NULL, 0); - if(nalloc == -1) { + if((nalloc = _get_obj(&tgt, attrname, NULL, 0)) == -1) { return PyErr_SetFromErrno(PyExc_IOError); } @@ -66,12 +170,7 @@ pygetxattr(PyObject *self, PyObject *args) } /* Now retrieve the attribute value */ - nret = ishandle ? - fgetxattr(filedes, attrname, buf, nalloc) : - dolink ? - lgetxattr(file, attrname, buf, nalloc) : - getxattr(file, attrname, buf, nalloc); - if(nret == -1) { + if((nret = _get_obj(&tgt, attrname, buf, nalloc)) == -1) { PyMem_Free(buf); return PyErr_SetFromErrno(PyExc_IOError); } @@ -86,31 +185,260 @@ pygetxattr(PyObject *self, PyObject *args) return res; } +/* Wrapper for getxattr */ +static char __get_doc__[] = + "Get the value of a given extended attribute.\n" + "\n" + "Example:\n" + " >>> xattr.get('/path/to/file', 'user.comment')\n" + " 'test'\n" + " >>> xattr.get('/path/to/file', 'comment', namespace=xattr.NS_USER)\n" + " 'test'\n" + "\n" + "@param item: the item to query; either a string representing the\n" + " filename, or a file-like object, or a file descriptor\n" + "@param name: the attribute whose value to set; usually in form of\n" + " system.posix_acl or user.mime_type\n" + "@type name: string\n" + "@param nofollow: if given and True, and the function is passed a\n" + " filename that points to a symlink, the function will act on the\n" + " symlink itself instead of its target\n" + "@type nofollow: boolean\n" + "@param namespace: if given, the attribute must not contain the\n" + " namespace itself, but instead the namespace will be taken from\n" + " this parameter\n" + "@type namespace: string\n" + "@return: the value of the extended attribute (can contain NULLs)\n" + "@rtype: string\n" + "@raise EnvironmentError: caused by any system errors\n" + "@since: 0.4\n" + ; + +static PyObject * +xattr_get(PyObject *self, PyObject *args, PyObject *keywds) +{ + PyObject *myarg; + target_t tgt; + int nofollow=0; + char *attrname, *namebuf; + const char *fullname; + char *buf; + char *ns = NULL; + ssize_t nalloc, nret; + PyObject *res; + static char *kwlist[] = {"item", "name", "nofollow", "namespace", NULL}; + + /* Parse the arguments */ + if (!PyArg_ParseTupleAndKeywords(args, keywds, "Os|iz", kwlist, + &myarg, &attrname, &nofollow, &ns)) + return NULL; + if(!convertObj(myarg, &tgt, nofollow)) + return NULL; + + fullname = merge_ns(ns, attrname, &namebuf); + + /* Find out the needed size of the buffer */ + if((nalloc = _get_obj(&tgt, fullname, NULL, 0)) == -1) { + return PyErr_SetFromErrno(PyExc_IOError); + } + + /* Try to allocate the memory, using Python's allocator */ + if((buf = PyMem_Malloc(nalloc)) == NULL) { + PyMem_Free(namebuf); + PyErr_NoMemory(); + return NULL; + } + + /* Now retrieve the attribute value */ + if((nret = _get_obj(&tgt, fullname, buf, nalloc)) == -1) { + PyMem_Free(buf); + PyMem_Free(namebuf); + return PyErr_SetFromErrno(PyExc_IOError); + } + + /* Create the string which will hold the result */ + res = PyString_FromStringAndSize(buf, nret); + + /* Free the buffers, they are no longer needed */ + PyMem_Free(namebuf); + PyMem_Free(buf); + + /* Return the result */ + return res; +} + +/* Wrapper for getxattr */ +static char __get_all_doc__[] = + "Get all the extended attributes of an item.\n" + "\n" + "This function performs a bulk-get of all extended attribute names\n" + "and the corresponding value.\n" + "Example:\n" + " >>> xattr.get_all('/path/to/file')\n" + " [('user.mime-type', 'plain/text'), ('user.comment', 'test'),\n" + " ('system.posix_acl_access', '\\x02\\x00...')]\n" + " >>> xattr.get_all('/path/to/file', namespace=xattr.NS_USER)\n" + " [('mime-type', 'plain/text'), ('comment', 'test')]\n" + "\n" + "@param item: the item to query; either a string representing the\n" + " filename, or a file-like object, or a file descriptor\n" + "@keyword namespace: an optional namespace for filtering the\n" + " attributes; for example, querying all user attributes can be\n" + " accomplished by passing namespace=L{NS_USER}\n" + "@type namespace: string\n" + "@keyword nofollow: if passed and true, if the target file is a\n" + " symbolic link, the attributes for the link itself will be\n" + " returned, instead of the attributes of the target\n" + "@type nofollow: boolean\n" + "@return: list of tuples (name, value); note that if a namespace\n" + " argument was passed, it (and the separator) will be stripped from\n" + " the names returned\n" + "@rtype: list\n" + "@raise EnvironmentError: caused by any system errors\n" + "@note: Since reading the whole attribute list is not an atomic\n" + " operation, it might be possible that attributes are added\n" + " or removed between the initial query and the actual reading\n" + " of the attributes; the returned list will contain only the\n" + " attributes that were present at the initial listing of the\n" + " attribute names and that were still present when the read\n" + " attempt for the value is made.\n" + "@since: 0.4\n" + ; + +static PyObject * +get_all(PyObject *self, PyObject *args, PyObject *keywds) +{ + PyObject *myarg; + int dolink=0; + char *ns = NULL; + char *buf_list, *buf_val; + char *s; + size_t nalloc, nlist, nval; + PyObject *mylist; + target_t tgt; + static char *kwlist[] = {"item", "nofollow", "namespace", NULL}; + + /* Parse the arguments */ + if (!PyArg_ParseTupleAndKeywords(args, keywds, "O|iz", kwlist, + &myarg, &dolink, &ns)) + return NULL; + if(!convertObj(myarg, &tgt, dolink)) + return NULL; + + /* Compute first the list of attributes */ + + /* Find out the needed size of the buffer for the attribute list */ + nalloc = _list_obj(&tgt, NULL, 0); + + if(nalloc == -1) { + return PyErr_SetFromErrno(PyExc_IOError); + } + + /* Try to allocate the memory, using Python's allocator */ + if((buf_list = PyMem_Malloc(nalloc)) == NULL) { + PyErr_NoMemory(); + return NULL; + } + + /* Now retrieve the list of attributes */ + nlist = _list_obj(&tgt, buf_list, nalloc); + + if(nlist == -1) { + PyErr_SetFromErrno(PyExc_IOError); + goto free_buf_list; + } + + /* Create the list which will hold the result */ + mylist = PyList_New(0); + nalloc = ESTIMATE_ATTR_SIZE; + if((buf_val = PyMem_Malloc(nalloc)) == NULL) { + PyErr_NoMemory(); + goto free_list; + } + + /* Create and insert the attributes as strings in the list */ + for(s = buf_list; s - buf_list < nlist; s += strlen(s) + 1) { + PyObject *my_tuple; + int missing; + const char *name; + + if((name=matches_ns(ns, s))==NULL) + continue; + /* Now retrieve the attribute value */ + missing = 0; + while(1) { + nval = _get_obj(&tgt, s, buf_val, nalloc); + + if(nval == -1) { + if(errno == ERANGE) { + nval = _get_obj(&tgt, s, NULL, 0); + if((buf_val = PyMem_Realloc(buf_val, nval)) == NULL) + goto free_list; + nalloc = nval; + continue; + } else if(errno == ENODATA || errno == ENOATTR) { + /* this attribute has gone away since we queried + the attribute list */ + missing = 1; + break; + } + goto exit_errno; + } + break; + } + if(missing) + continue; + my_tuple = Py_BuildValue("ss#", name, buf_val, nval); + + PyList_Append(mylist, my_tuple); + Py_DECREF(my_tuple); + } + + /* Free the buffers, now they are no longer needed */ + PyMem_Free(buf_val); + PyMem_Free(buf_list); + + /* Return the result */ + return mylist; + exit_errno: + PyErr_SetFromErrno(PyExc_IOError); + PyMem_Free(buf_val); + free_list: + Py_DECREF(mylist); + free_buf_list: + PyMem_Free(buf_list); + return NULL; +} + + static char __pysetxattr_doc__[] = - "Set the value of a given extended attribute.\n" + "Set the value of a given extended attribute (deprecated).\n" + "\n" "Be carefull in case you want to set attributes on symbolic\n" "links, you have to use all the 5 parameters; use 0 for the \n" "flags value if you want the default behavior (create or " "replace)\n" "\n" "Parameters:\n" - "\t- a string representing filename, or a file-like object,\n" - "\t or a file descriptor; this represents the file on \n" - "\t which to act\n" - "\t- a string, representing the attribute whose value to set;\n" - "\t usually in form of system.posix_acl or user.mime_type\n" - "\t- a string, possibly with embedded NULLs; note that there\n" - "\t are restrictions regarding the size of the value, for\n" - "\t example, for ext2/ext3, maximum size is the block size\n" - "\t- (optional) flags; if 0 or ommited the attribute will be \n" - "\t created or replaced; if XATTR_CREATE, the attribute \n" - "\t will be created, giving an error if it already exists;\n" - "\t of XATTR_REPLACE, the attribute will be replaced,\n" - "\t giving an error if it doesn't exists;\n" - "\t- (optional) a boolean value (defaults to false), which, if\n" - "\t the file name given is a symbolic link, makes the\n" - "\t function operate on the symbolic link itself instead\n" - "\t of its target;" + " - a string representing filename, or a file-like object,\n" + " or a file descriptor; this represents the file on \n" + " which to act\n" + " - a string, representing the attribute whose value to set;\n" + " usually in form of system.posix_acl or user.mime_type\n" + " - a string, possibly with embedded NULLs; note that there\n" + " are restrictions regarding the size of the value, for\n" + " example, for ext2/ext3, maximum size is the block size\n" + " - (optional) flags; if 0 or ommited the attribute will be \n" + " created or replaced; if XATTR_CREATE, the attribute \n" + " will be created, giving an error if it already exists;\n" + " of XATTR_REPLACE, the attribute will be replaced,\n" + " giving an error if it doesn't exists;\n" + " - (optional) a boolean value (defaults to false), which, if\n" + " the file name given is a symbolic link, makes the\n" + " function operate on the symbolic link itself instead\n" + " of its target;\n" + "@deprecated: since version 0.4, this function has been deprecated\n" + " by the L{set} function\n" ; /* Wrapper for setxattr */ @@ -118,49 +446,122 @@ static PyObject * pysetxattr(PyObject *self, PyObject *args) { PyObject *myarg; - char *file; - int ishandle, filedes, dolink=0; + int nofollow=0; char *attrname; char *buf; - int bufsize, nret; + Py_ssize_t bufsize; + int nret; int flags = 0; + target_t tgt; /* Parse the arguments */ if (!PyArg_ParseTuple(args, "Oss#|bi", &myarg, &attrname, - &buf, &bufsize, &flags, &dolink)) + &buf, &bufsize, &flags, &nofollow)) return NULL; - if(!convertObj(myarg, &ishandle, &filedes, &file)) + if(!convertObj(myarg, &tgt, nofollow)) return NULL; /* Set the attribute's value */ - nret = ishandle ? - fsetxattr(filedes, attrname, buf, bufsize, flags) : - dolink ? - lsetxattr(file, attrname, buf, bufsize, flags) : - setxattr(file, attrname, buf, bufsize, flags); + if((nret = _set_obj(&tgt, attrname, buf, bufsize, flags)) == -1) { + return PyErr_SetFromErrno(PyExc_IOError); + } + + /* Return the result */ + Py_RETURN_NONE; +} + +static char __set_doc__[] = + "Set the value of a given extended attribute.\n" + "\n" + "Example:\n" + " >>> xattr.set('/path/to/file', 'user.comment', 'test')\n" + " >>> xattr.set('/path/to/file', 'comment', 'test'," + " namespace=xattr.NS_USER)\n" + "\n" + "@param item: the item to query; either a string representing the\n" + " filename, or a file-like object, or a file descriptor\n" + "@param name: the attribute whose value to set; usually in form of\n" + " system.posix_acl or user.mime_type\n" + "@type name: string\n" + "@param value: a string, possibly with embedded NULLs; note that there\n" + " are restrictions regarding the size of the value, for\n" + " example, for ext2/ext3, maximum size is the block size\n" + "@type value: string\n" + "@param flags: if 0 or ommited the attribute will be\n" + " created or replaced; if L{XATTR_CREATE}, the attribute\n" + " will be created, giving an error if it already exists;\n" + " if L{XATTR_REPLACE}, the attribute will be replaced,\n" + " giving an error if it doesn't exists;\n" + "@type flags: integer\n" + "@param nofollow: if given and True, and the function is passed a\n" + " filename that points to a symlink, the function will act on the\n" + " symlink itself instead of its target\n" + "@type nofollow: boolean\n" + "@param namespace: if given, the attribute must not contain the\n" + " namespace itself, but instead the namespace will be taken from\n" + " this parameter\n" + "@type namespace: string\n" + "@rtype: None\n" + "@raise EnvironmentError: caused by any system errors\n" + "@since: 0.4\n" + ; +/* Wrapper for setxattr */ +static PyObject * +xattr_set(PyObject *self, PyObject *args, PyObject *keywds) +{ + PyObject *myarg; + int nofollow=0; + char *attrname; + char *buf; + Py_ssize_t bufsize; + int nret; + int flags = 0; + target_t tgt; + char *ns = NULL; + char *newname; + const char *full_name; + static char *kwlist[] = {"item", "name", "value", "flags", + "nofollow", "namespace", NULL}; + + /* Parse the arguments */ + if (!PyArg_ParseTupleAndKeywords(args, keywds, "Oss#|iiz", kwlist, + &myarg, &attrname, + &buf, &bufsize, &flags, &nofollow, &ns)) + return NULL; + if(!convertObj(myarg, &tgt, nofollow)) + return NULL; + + full_name = merge_ns(ns, attrname, &newname); + /* Set the attribute's value */ + nret = _set_obj(&tgt, full_name, buf, bufsize, flags); + if(newname != NULL) + PyMem_Free(newname); if(nret == -1) { return PyErr_SetFromErrno(PyExc_IOError); } /* Return the result */ - Py_INCREF(Py_None); - return Py_None; + Py_RETURN_NONE; } + static char __pyremovexattr_doc__[] = - "Remove an attribute from a file\n" + "Remove an attribute from a file (deprecated).\n" "\n" "Parameters:\n" - "\t- a string representing filename, or a file-like object,\n" - "\t or a file descriptor; this represents the file on \n" - "\t which to act\n" - "\t- a string, representing the attribute to be removed;\n" - "\t usually in form of system.posix_acl or user.mime_type\n" - "\t- (optional) a boolean value (defaults to false), which, if\n" - "\t the file name given is a symbolic link, makes the\n" - "\t function operate on the symbolic link itself instead\n" - "\t of its target;" + " - a string representing filename, or a file-like object,\n" + " or a file descriptor; this represents the file on \n" + " which to act\n" + " - a string, representing the attribute to be removed;\n" + " usually in form of system.posix_acl or user.mime_type\n" + " - (optional) a boolean value (defaults to false), which, if\n" + " the file name given is a symbolic link, makes the\n" + " function operate on the symbolic link itself instead\n" + " of its target;\n" + "@deprecated: since version 0.4, this function has been deprecated\n" + " by the L{remove}" + " function\n" ; /* Wrapper for removexattr */ @@ -168,74 +569,123 @@ static PyObject * pyremovexattr(PyObject *self, PyObject *args) { PyObject *myarg; - char *file; - int ishandle, filedes, dolink=0; + int nofollow=0; char *attrname; int nret; + target_t tgt; /* Parse the arguments */ - if (!PyArg_ParseTuple(args, "Os|i", &myarg, &attrname, &dolink)) + if (!PyArg_ParseTuple(args, "Os|i", &myarg, &attrname, &nofollow)) return NULL; - if(!convertObj(myarg, &ishandle, &filedes, &file)) + if(!convertObj(myarg, &tgt, nofollow)) return NULL; /* Remove the attribute */ - nret = ishandle ? - fremovexattr(filedes, attrname) : - dolink ? - lremovexattr(file, attrname) : - removexattr(file, attrname); + if((nret = _remove_obj(&tgt, attrname)) == -1) { + return PyErr_SetFromErrno(PyExc_IOError); + } + + /* Return the result */ + Py_RETURN_NONE; +} + +static char __remove_doc__[] = + "Remove an attribute from a file.\n" + "\n" + "Example:\n" + " >>> xattr.remove('/path/to/file', 'user.comment')\n" + "\n" + "@param item: the item to query; either a string representing the\n" + " filename, or a file-like object, or a file descriptor\n" + "@param name: the attribute whose value to set; usually in form of\n" + " system.posix_acl or user.mime_type\n" + "@type name: string\n" + "@param nofollow: if given and True, and the function is passed a\n" + " filename that points to a symlink, the function will act on the\n" + " symlink itself instead of its target\n" + "@type nofollow: boolean\n" + "@param namespace: if given, the attribute must not contain the\n" + " namespace itself, but instead the namespace will be taken from\n" + " this parameter\n" + "@type namespace: string\n" + "@since: 0.4\n" + "@rtype: None\n" + "@raise EnvironmentError: caused by any system errors\n" + ; + +/* Wrapper for removexattr */ +static PyObject * +xattr_remove(PyObject *self, PyObject *args, PyObject *keywds) +{ + PyObject *myarg; + int nofollow=0; + char *attrname, *name_buf; + char *ns = NULL; + const char *full_name; + int nret; + target_t tgt; + static char *kwlist[] = {"item", "name", "nofollow", "namespace", NULL}; - if(nret == -1) + /* Parse the arguments */ + if (!PyArg_ParseTupleAndKeywords(args, keywds, "Os|iz", kwlist, + &myarg, &attrname, &nofollow, &ns)) + return NULL; + + if(!convertObj(myarg, &tgt, nofollow)) + return NULL; + full_name = merge_ns(ns, attrname, &name_buf); + if(full_name == NULL) + return NULL; + + /* Remove the attribute */ + nret = _remove_obj(&tgt, full_name); + PyMem_Free(name_buf); + if(nret == -1) { return PyErr_SetFromErrno(PyExc_IOError); + } /* Return the result */ - Py_INCREF(Py_None); - return Py_None; + Py_RETURN_NONE; } static char __pylistxattr_doc__[] = - "Return the list of attribute names for a file\n" + "Return the list of attribute names for a file (deprecated).\n" "\n" "Parameters:\n" - "\t- a string representing filename, or a file-like object,\n" - "\t or a file descriptor; this represents the file to \n" - "\t be queried\n" - "\t- (optional) a boolean value (defaults to false), which, if\n" - "\t the file name given is a symbolic link, makes the\n" - "\t function operate on the symbolic link itself instead\n" - "\t of its target;" + " - a string representing filename, or a file-like object,\n" + " or a file descriptor; this represents the file to \n" + " be queried\n" + " - (optional) a boolean value (defaults to false), which, if\n" + " the file name given is a symbolic link, makes the\n" + " function operate on the symbolic link itself instead\n" + " of its target;\n" + "@deprecated: since version 0.4, this function has been deprecated\n" + " by the L{list}" + " function\n" ; /* Wrapper for listxattr */ static PyObject * pylistxattr(PyObject *self, PyObject *args) { - char *file = NULL; - int filedes = -1; char *buf; - int ishandle, dolink=0; - int nalloc, nret; + int nofollow=0; + ssize_t nalloc, nret; PyObject *myarg; PyObject *mylist; - int nattrs; + Py_ssize_t nattrs; char *s; + target_t tgt; /* Parse the arguments */ - if (!PyArg_ParseTuple(args, "O|i", &myarg, &dolink)) + if (!PyArg_ParseTuple(args, "O|i", &myarg, &nofollow)) return NULL; - if(!convertObj(myarg, &ishandle, &filedes, &file)) + if(!convertObj(myarg, &tgt, nofollow)) return NULL; /* Find out the needed size of the buffer */ - nalloc = ishandle ? - flistxattr(filedes, NULL, 0) : - dolink ? - llistxattr(file, NULL, 0) : - listxattr(file, NULL, 0); - - if(nalloc == -1) { + if((nalloc = _list_obj(&tgt, NULL, 0)) == -1) { return PyErr_SetFromErrno(PyExc_IOError); } @@ -246,13 +696,8 @@ pylistxattr(PyObject *self, PyObject *args) } /* Now retrieve the list of attributes */ - nret = ishandle ? - flistxattr(filedes, buf, nalloc) : - dolink ? - llistxattr(file, buf, nalloc) : - listxattr(file, buf, nalloc); - - if(nret == -1) { + if((nret = _list_obj(&tgt, buf, nalloc)) == -1) { + PyMem_Free(buf); return PyErr_SetFromErrno(PyExc_IOError); } @@ -277,36 +722,157 @@ pylistxattr(PyObject *self, PyObject *args) return mylist; } +static char __list_doc__[] = + "Return the list of attribute names for a file.\n" + "\n" + "Example:\n" + " >>> xattr.list('/path/to/file')\n" + " ['user.test', 'user.comment', 'system.posix_acl_access']\n" + " >>> xattr.list('/path/to/file', namespace=xattr.NS_USER)\n" + " ['test', 'comment']\n" + "\n" + "@param item: the item to query; either a string representing the\n" + " filename, or a file-like object, or a file descriptor\n" + "@param nofollow: if given and True, and the function is passed a\n" + " filename that points to a symlink, the function will act on the\n" + " symlink itself instead of its target\n" + "@type nofollow: boolean\n" + "@param namespace: if given, the attribute must not contain the\n" + " namespace itself, but instead the namespace will be taken from\n" + " this parameter\n" + "@type namespace: string\n" + "@return: list of strings; note that if a namespace argument was\n" + " passed, it (and the separator) will be stripped from the names\n" + " returned\n" + "@rtype: list\n" + "@raise EnvironmentError: caused by any system errors\n" + "@since: 0.4\n" + ; + +/* Wrapper for listxattr */ +static PyObject * +xattr_list(PyObject *self, PyObject *args, PyObject *keywds) +{ + char *buf; + int nofollow=0; + ssize_t nalloc, nret; + PyObject *myarg; + PyObject *mylist; + char *ns = NULL; + Py_ssize_t nattrs; + char *s; + target_t tgt; + static char *kwlist[] = {"item", "nofollow", "namespace", NULL}; + + /* Parse the arguments */ + if (!PyArg_ParseTupleAndKeywords(args, keywds, "O|iz", kwlist, + &myarg, &nofollow, &ns)) + return NULL; + if(!convertObj(myarg, &tgt, nofollow)) + return NULL; + + /* Find out the needed size of the buffer */ + if((nalloc = _list_obj(&tgt, NULL, 0)) == -1) { + return PyErr_SetFromErrno(PyExc_IOError); + } + + /* Try to allocate the memory, using Python's allocator */ + if((buf = PyMem_Malloc(nalloc)) == NULL) { + PyErr_NoMemory(); + return NULL; + } + + /* Now retrieve the list of attributes */ + if((nret = _list_obj(&tgt, buf, nalloc)) == -1) { + PyMem_Free(buf); + return PyErr_SetFromErrno(PyExc_IOError); + } + + /* Compute the number of attributes in the list */ + for(s = buf, nattrs = 0; (s - buf) < nret; s += strlen(s) + 1) { + if(matches_ns(ns, s)!=NULL) + nattrs++; + } + /* Create the list which will hold the result */ + mylist = PyList_New(nattrs); + + /* Create and insert the attributes as strings in the list */ + for(s = buf, nattrs = 0; s - buf < nret; s += strlen(s) + 1) { + const char *name = matches_ns(ns, s); + if(name!=NULL) { + PyList_SET_ITEM(mylist, nattrs, PyString_FromString(name)); + nattrs++; + } + } + + /* Free the buffer, now it is no longer needed */ + PyMem_Free(buf); + + /* Return the result */ + return mylist; +} + static PyMethodDef xattr_methods[] = { {"getxattr", pygetxattr, METH_VARARGS, __pygetxattr_doc__ }, + {"get", (PyCFunction) xattr_get, METH_VARARGS | METH_KEYWORDS, + __get_doc__ }, + {"get_all", (PyCFunction) get_all, METH_VARARGS | METH_KEYWORDS, + __get_all_doc__ }, {"setxattr", pysetxattr, METH_VARARGS, __pysetxattr_doc__ }, + {"set", (PyCFunction) xattr_set, METH_VARARGS | METH_KEYWORDS, + __set_doc__ }, {"removexattr", pyremovexattr, METH_VARARGS, __pyremovexattr_doc__ }, + {"remove", (PyCFunction) xattr_remove, METH_VARARGS | METH_KEYWORDS, + __remove_doc__ }, {"listxattr", pylistxattr, METH_VARARGS, __pylistxattr_doc__ }, + {"list", (PyCFunction) xattr_list, METH_VARARGS | METH_KEYWORDS, + __list_doc__ }, {NULL, NULL, 0, NULL} /* Sentinel */ }; static char __xattr_doc__[] = \ - "Access extended filesystem attributes\n" + "Interface to extended filesystem attributes.\n" "\n" "This module gives access to the extended attributes present\n" "in some operating systems/filesystems. You can list attributes,\n" "get, set and remove them.\n" - "The last and optional parameter for all functions is a boolean \n" - "value which enables the 'l-' version of the functions - acting\n" - "on symbolic links and not their destination.\n" "\n" - "Example: \n" - ">>> import xattr\n" - ">>> xattr.listxattr(\"file.txt\")\n" - "('user.mime_type',)\n" - ">>> xattr.getxattr(\"file.txt\", \"user.mime_type\")\n" - "'text/plain'\n" - ">>> xattr.setxattr(\"file.txt\", \"user.comment\", \"Simple text file\")" + "The module exposes two sets of functions:\n" + " - the 'old' L{listxattr}, L{getxattr}, L{setxattr}, L{removexattr}\n" + " functions which are deprecated since version 0.4\n" + " - the new L{list}, L{get}, L{get_all}, L{set}, L{remove} functions\n" + " which expose a namespace-aware API and simplify a bit the calling\n" + " model by using keyword arguments\n" + "\n" + "Example: \n\n" + " >>> import xattr\n" + " >>> xattr.listxattr(\"file.txt\")\n" + " ['user.mime_type']\n" + " >>> xattr.getxattr(\"file.txt\", \"user.mime_type\")\n" + " 'text/plain'\n" + " >>> xattr.setxattr(\"file.txt\", \"user.comment\", " + "\"Simple text file\")\n" + " >>> xattr.listxattr(\"file.txt\")\n" + " ['user.mime_type', 'user.comment']\n" + " >>> xattr.removexattr (\"file.txt\", \"user.comment\")\n" "\n" - ">>> xattr.listxattr(\"file.txt\")\n" - "('user.mime_type', 'user.comment')\n" - ">>> xattr.removexattr (\"file.txt\", \"user.comment\")\n" - "" + "@note: Most or all errors reported by the system while using the xattr\n" + "library will be reported by raising a L{EnvironmentError}; under Linux,\n" + "the following C{errno} values are used:\n" + " - C{ENOATTR} and C{ENODATA} mean that the attribute name is invalid\n" + " - C{ENOTSUP} and C{EOPNOTSUPP} mean that the filesystem does not\n" + " support extended attributes, or that the namespace is invalid\n" + " - C{E2BIG} mean that the attribute value is too big\n" + " - C{ERANGE} mean that the attribute name is too big (it might also\n" + " mean an error in the xattr module itself)\n" + " - C{ENOSPC} and C{EDQUOT} are documented as meaning out of disk space\n" + " or out of disk space because of quota limits\n" + "\n" + "@group Deprecated API: *xattr\n" + "@group Namespace constants: NS_*\n" + "@group set function flags: XATTR_CREATE, XATTR_REPLACE\n" + "@sort: list, get, get_all, set, remove, listxattr, getxattr, setxattr\n" + " removexattr\n" ; void @@ -314,7 +880,20 @@ initxattr(void) { PyObject *m = Py_InitModule3("xattr", xattr_methods, __xattr_doc__); + PyModule_AddStringConstant(m, "__author__", _XATTR_AUTHOR); + PyModule_AddStringConstant(m, "__contact__", _XATTR_EMAIL); + PyModule_AddStringConstant(m, "__version__", _XATTR_VERSION); + PyModule_AddStringConstant(m, "__license__", + "GNU Lesser General Public License (LGPL)"); + PyModule_AddStringConstant(m, "__docformat__", "epytext en"); + PyModule_AddIntConstant(m, "XATTR_CREATE", XATTR_CREATE); PyModule_AddIntConstant(m, "XATTR_REPLACE", XATTR_REPLACE); + /* namespace constants */ + PyModule_AddStringConstant(m, "NS_SECURITY", "security"); + PyModule_AddStringConstant(m, "NS_SYSTEM", "system"); + PyModule_AddStringConstant(m, "NS_TRUSTED", "trusted"); + PyModule_AddStringConstant(m, "NS_USER", "user"); + } -- 2.39.5