From f958700eea4d759bf39eadf752659871748ddf5f Mon Sep 17 00:00:00 2001 From: Martin Eve Date: Fri, 16 Jul 2010 18:39:16 +0100 Subject: [PATCH] Initial commit --- COPYING | 674 +++++++++++++++++++++++++++ beetsplug/__init__.py | 2 + beetsplug/beetFs.py | 1002 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 1678 insertions(+) create mode 100644 COPYING create mode 100644 beetsplug/__init__.py create mode 100644 beetsplug/beetFs.py diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU 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. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, 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 +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state 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 program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/beetsplug/__init__.py b/beetsplug/__init__.py new file mode 100644 index 0000000..3ad9513 --- /dev/null +++ b/beetsplug/__init__.py @@ -0,0 +1,2 @@ +from pkgutil import extend_path +__path__ = extend_path(__path__, __name__) diff --git a/beetsplug/beetFs.py b/beetsplug/beetFs.py new file mode 100644 index 0000000..3a67f95 --- /dev/null +++ b/beetsplug/beetFs.py @@ -0,0 +1,1002 @@ +''' + beetFs + Copyright 2010 Martin Eve + + This file is part of beetFs. + + beetFs is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + beetFs 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with beetFs. If not, see . + +''' + +from beets.plugins import BeetsPlugin +from beets.ui import Subcommand +import beets +import logging +from string import Template +import operator +import os +import re +import fuse +import errno +import stat +import datetime +import time +import calendar +import mutagen +from mutagen import flac, id3 +from mutagen.flac import FLAC, Padding, MetadataBlock +from mutagen.id3 import ID3 + +path_format = "$artist/$album ($year) [$format_upper]/$track - $artist - $title.$format" + +beetFs_command = Subcommand('mount', help='Mount a beets filesystem') +log = logging.getLogger('beets') + + +# FUSE version at the time of writing. Be compatible with this version. +fuse.fuse_python_api = (0, 2) + +""" This is duplicated from Library. Ideally should be exposed from there. +""" + +metadata_rw_fields = [ + ('title', 'text'), + ('artist', 'text'), + ('album', 'text'), + ('genre', 'text'), + ('composer', 'text'), + ('grouping', 'text'), + ('year', 'int'), + ('month', 'int'), + ('day', 'int'), + ('track', 'int'), + ('tracktotal', 'int'), + ('disc', 'int'), + ('disctotal', 'int'), + ('lyrics', 'text'), + ('comments', 'text'), + ('bpm', 'int'), + ('comp', 'bool'), +] +metadata_fields = [ + ('length', 'real'), + ('bitrate', 'int'), +] + metadata_rw_fields + +metadata_keys = map(operator.itemgetter(0), metadata_fields) + + +def template_mapping(lib, item): + """ Builds a template substitution map. Taken from library.py. + """ + mapping = {} + for key in metadata_keys: + value = getattr(item, key) + # sanitize the value for inclusion in a path: + # replace / and leading . with _ + if isinstance(value, basestring): + value.replace(os.sep, '_') + value = re.sub(r'[\\/:]|^\.', '_', value) + elif key in ('track', 'tracktotal', 'disc', 'disctotal'): + # pad with zeros + value = '%02i' % value + else: + value = str(value) + mapping[key] = value + + format = os.path.splitext(item.path)[1][1:] + mapping['format'] = re.sub(r'[\\/:]|^\.', '_', format) + mapping['format_upper'] = re.sub(r'[\\/:]|^\.', '_', format).upper() + + # fix dud entries + if mapping['artist'] == '': + mapping['artist'] = 'Unknown Artist' + + if mapping['album'] == '': + mapping['album'] = 'Unknown Album' + + if mapping['year'] == '0': + mapping['year'] = 'Unknown Year' + + if mapping['title'] == '': + mapping['title'] = 'Unknown Track' + + return mapping + +def mount(lib, config, opts, args): + # check we have a command line argument + if not args: + raise beets.ui.UserError('no mountpoint specified') + + # build the in-memory folder structure + global structure_split + structure_split = path_format.split("/") + global structure_depth + structure_depth = len(structure_split) + root = {} + templates = {} + global library + library = lib + + # establish a blank dictionary at each level of depth + # also create templates for each level + for level in range(0, structure_depth): + #log.debug("Creating template %s" % structure_split[level]) + templates[level] = Template(structure_split[level]) + + global directory_structure + directory_structure = FSNode({}, {}) + + # iterate over items in library + for item in lib.items(): + # build the template map + mapping = template_mapping(lib, item) + + # do the substitutions + level_subbed = {} + for level in range(0, structure_depth): + level_subbed[level] = templates[level].substitute(mapping) + + # build a directory structure + sub_elements = [] + for level in range(0, structure_depth - 1): + # append the path up to the current depth, minus one, to elements + # this means that sub_elements contains the current path, except for the folder to be added + if level-1 in level_subbed: + sub_elements.append(level_subbed[level-1]) + # add this directory to the master structure + directory_structure.adddir(sub_elements, level_subbed[level]) + + # add this item as a file + + # First, compensate for 2 directories depth taken off above + # ie. sub_elements now contains the full folder path + sub_elements.append(level_subbed[structure_depth-3]) + sub_elements.append(level_subbed[structure_depth-2]) + + # do the actual add + directory_structure.addfile(sub_elements, level_subbed[structure_depth-1], item.id) + + #print directory_structure.listdir(["Fluke", "Hang Tough (381TP12) (2003) [MP3]"], False) + #path = "/.trash" + #pathsplit = path[1:].split('/') + #print pathsplit[len(pathsplit)-1] in directory_structure.getnode(pathsplit[0:len(pathsplit)-1]).dirs + #print directory_structure.getnode(pathsplit[0:len(pathsplit)-1]).dirs + server = beetFileSystem(version="%prog " + fuse.__version__, + usage="", dash_s_do='setsingle') + server.parse(errex=1) + + server.multithreaded = 0 + try: + server.main() + pass + except fuse.FuseError, e: + log.error(str(e)) + + +beetFs_command.func = mount + +class beetFs(BeetsPlugin): + """ The beets plugin hook + """ + def commands(self): + return [beetFs_command] + +import mutagen +from mutagen import flac +from mutagen.flac import FLAC, Padding, MetadataBlock + +def to_int_be(string): + """Convert an arbitrarily-long string to a long using big-endian + byte order.""" + return reduce(lambda a, b: (a << 8) + ord(b), string, 0L) + +class InterpolatedID3 (ID3): + def save(self, filename=None, v1=0): + """Save changes to a file. + + If no filename is given, the one most recently loaded is used. + + Keyword arguments: + v1 -- if 0, ID3v1 tags will be removed + if 1, ID3v1 tags will be updated but not added + if 2, ID3v1 tags will be created and/or updated + + The lack of a way to update only an ID3v1 tag is intentional. + """ + + # Sort frames by 'importance' + order = ["TIT2", "TPE1", "TRCK", "TALB", "TPOS", "TDRC", "TCON"] + order = dict(zip(order, range(len(order)))) + last = len(order) + frames = self.items() + frames.sort(lambda a, b: cmp(order.get(a[0][:4], last), + order.get(b[0][:4], last))) + + framedata = [self.__save_frame(frame) for (key, frame) in frames] + framedata.extend([data for data in self.unknown_frames + if len(data) > 10]) + + + framedata = ''.join(framedata) + framesize = len(framedata) + + if filename is None: filename = self.filename + f = open(filename, 'rb+') + try: + idata = f.read(10) + try: id3, vmaj, vrev, flags, insize = unpack('>3sBBB4s', idata) + except struct.error: id3, insize = '', 0 + insize = BitPaddedInt(insize) + if id3 != 'ID3': insize = -10 + + if insize >= framesize: outsize = insize + else: outsize = (framesize + 1023) & ~0x3FF + framedata += '\x00' * (outsize - framesize) + + framesize = BitPaddedInt.to_str(outsize, width=4) + flags = 0 + header = pack('>3sBBB4s', 'ID3', 4, 0, flags, framesize) + data = header + framedata + + if (insize < outsize): + insert_bytes(f, outsize-insize, insize+10) + f.seek(0) + + try: + f.seek(-128, 2) + except IOError, err: + from errno import EINVAL + if err.errno != EINVAL: raise + f.seek(0, 2) # ensure read won't get "TAG" + + if f.read(3) == "TAG": + f.seek(-128, 2) + if v1 > 0: f.write(MakeID3v1(self)) + else: f.truncate() + elif v1 == 2: + f.seek(0, 2) + f.write(MakeID3v1(self)) + + finally: + f.close() + +class InterpolatedFLAC (FLAC): + def get_header(self, filename=None): + """Save metadata blocks to a file. + + If no filename is given, the one most recently loaded is used. + """ + + if filename is None: filename = self.filename + f = open(filename, 'rb+') + + # Ensure we've got padding at the end, and only at the end. + # If adding makes it too large, we'll scale it down later. + self.metadata_blocks.append(Padding('\x00' * 1020)) + MetadataBlock.group_padding(self.metadata_blocks) + + header = self.__check_header(f) + available = self.__find_audio_offset(f) - header # "fLaC" and maybe ID3 + data = MetadataBlock.writeblocks(self.metadata_blocks) + + # Delete ID3v2 + #if deleteid3 and header > 4: + # available += header - 4 + # header = 4 + + if len(data) > available: + # If we have too much data, see if we can reduce padding. + padding = self.metadata_blocks[-1] + newlength = padding.length - (len(data) - available) + if newlength > 0: + padding.length = newlength + data = MetadataBlock.writeblocks(self.metadata_blocks) + assert len(data) == available + + elif len(data) < available: + # If we have too little data, increase padding. + self.metadata_blocks[-1].length += (available - len(data)) + data = MetadataBlock.writeblocks(self.metadata_blocks) + assert len(data) == available + + if len(data) != available: + # We couldn't reduce the padding enough. + diff = (len(data) - available) + #insert_bytes(f, diff, header) + + f.close() + + return("fLaC" + data) + + def offset(self): + return len(self.save()) + + def __find_audio_offset(self, fileobj): + byte = 0x00 + while not (byte >> 7) & 1: + byte = ord(fileobj.read(1)) + size = to_int_be(fileobj.read(3)) + fileobj.read(size) + return fileobj.tell() + + def __check_header(self, fileobj): + size = 4 + header = fileobj.read(4) + if header != "fLaC": + size = None + if header[:3] == "ID3": + size = 14 + BitPaddedInt(fileobj.read(6)[2:]) + fileobj.seek(size - 4) + if fileobj.read(4) != "fLaC": size = None + if size is None: + raise FLACNoHeaderError( + "%r is not a valid FLAC file" % fileobj.name) + return size + +class FSNode(object): + """A directory node. Contains directories (as a dictionary keyed + by directory name) and files (dictionary keyed by filename to id). + """ + def __init__(self, dirs, files): + self.dirs = dirs + self.files = files + + def getnode(self, elements, root=None): + if root == None: + root = self + + if elements: + topdir = elements.pop(0) + return self.getnode(elements, root=root.dirs[topdir]) + else: + # base case + return root + + def adddir(self, elements, directory, root=None): + if root == None: + root = self + + if len(elements) == 1 and elements[0] == '': + elements = [] + node = self.getnode(elements, root=root) + if not directory in node.dirs: + node.dirs[directory] = FSNode({}, {}) + + def addfile(self, elements, filename, id, root=None): + if root == None: + root = self + + if len(elements) == 1 and elements[0] == '': + elements = [] + node = self.getnode(elements, root=root) + node.files[filename] = id + + def listdir(self, elements, directories, root=None): + if root == None: + root = self + + if len(elements) == 1 and elements[0] == '': + elements = [] + node = self.getnode(elements, root=root) + if directories: + return node.dirs.keys() + else: + return node.files.keys() + +class FileHandler(object): + def __init__(self, path, lib): + self.path = path + self.lib = lib + + pathsplit = path[1:].split('/') + subdepth = path.count('/') + 1 + + # determine the real path + item = self.lib.items(query="id=%s" % directory_structure.getnode(pathsplit[0:structure_depth-1]).files[pathsplit[structure_depth-1]]) + self.real_path = item.path + + # open the on-disk file for reading + self.file_object = open(self.real_path, 'r+') + self.instance_count = 1 + + # now get the bounds of the file_class + #TODO: this needs to handle other file formats; use mutagen's detection procedure + format = os.path.splitext(path)[1][1:].lower() + + if format == "flac": + self.inf = InterpolatedFLAC(self.real_path) + self.header = self.inf.get_header() + self.bound = len(self.header) + self.music_offset = self.inf.offset() + elif format == "mp3": + pass + + def open(self): + # as init() handles actual opening, just increment instance count here + self.instance_count = self.instance_count + 1 + + def release(self): + # decrement the instance count + if self.instance_count > 0: + self.instance_count = self.instance_count - 1 + return False + else: + # if instance count is zero, close the physical file on disk + self.file_object.close() + return True + + def read(self, size, offset): + # check if read is within header boundary + if offset < self.bound: + + if offset + size < len(self.header): + # can just read from header + ret = self.header[offset:offset+size] + return ret + else: + # get the header + some data from file + ret = self.header[offset:len(self.header)] + self.file_object.seek(self.music_offset) + ret = ret + self.file_object.read(size-(len(self.header) - offset)) + return ret + + # otherwise, pass read call to underlying file system + self.file_object.seek(offset) + return self.file_object.read(size) + + def write(self, offset, buf): + # determine if offset is within header; if not, discard write + if offset < self.bound: + pass + +class Stat(fuse.Stat): + DIRSIZE = 4096 + + def __init__(self, st_mode, st_size, st_nlink=1, st_uid=None, st_gid=None, + dt_atime=None, dt_mtime=None, dt_ctime=None): + + self.st_mode = st_mode + self.st_ino = 0 + self.st_dev = 0 + self.st_nlink = st_nlink + if st_uid is None: + st_uid = os.getuid() + self.st_uid = st_uid + if st_gid is None: + st_gid = os.getgid() + self.st_gid = st_gid + self.st_size = st_size + now = datetime.datetime.utcnow() + self.dt_atime = dt_atime or now + self.dt_mtime = dt_mtime or now + self.dt_ctime = dt_ctime or now + + def _get_dt_atime(self): + return self.epoch_datetime(self.st_atime) + def _set_dt_atime(self, value): + self.st_atime = self.datetime_epoch(value) + dt_atime = property(_get_dt_atime, _set_dt_atime) + + def _get_dt_mtime(self): + return self.epoch_datetime(self.st_mtime) + def _set_dt_mtime(self, value): + self.st_mtime = self.datetime_epoch(value) + dt_mtime = property(_get_dt_mtime, _set_dt_mtime) + + def _get_dt_ctime(self): + return self.epoch_datetime(self.st_ctime) + def _set_dt_ctime(self, value): + self.st_ctime = self.datetime_epoch(value) + dt_ctime = property(_get_dt_ctime, _set_dt_ctime) + + @staticmethod + def datetime_epoch(dt): + return calendar.timegm(dt.timetuple()) + @staticmethod + def epoch_datetime(seconds): + return datetime.datetime.utcfromtimestamp(seconds) + +class beetFileSystem(fuse.Fuse): + def __init__(self, *args, **kwargs): + LOG_FILENAME = "LOG" + logging.basicConfig(filename=LOG_FILENAME,level=logging.INFO,) + + logging.info("Preparing to mount file system") + super(beetFileSystem, self).__init__(*args, **kwargs) + + def fsinit(self): + # called after filesystem is mounted + #self.lib = self.cmdline[1][0] + self.lib = library + + logging.info("Filesystem mounted") + + def fsdestroy(self): + logging.info("Unmounting file system") + + def statfs(self): + logging.info("statfs") + + # have no way of knowing where the music is stored + # (disparate locations), so using homedir to fill this in + return os.statvfs(os.path.expanduser("~")) + + + def getattr(self, path): + logging.info("getattr: %s" % path) + + try: + if path == "/": + logging.info("Returning /") + mode = stat.S_IFDIR | 0755 + st = Stat(st_mode=mode, st_size=Stat.DIRSIZE, st_nlink=2) + return st + else: + # determine if it's a directory or a file list + # Split path into components + pathsplit = path[1:].split('/') + + if len(pathsplit) == structure_depth: + # it's a file + logging.info("file") + + items = self.lib.get_path(id=directory_structure.getnode(pathsplit[0:structure_depth-1]).files[pathsplit[structure_depth-1]]) + logging.info("query") + item = items[0] + + if not item: + # file not found + logging.error("Returning ENOENT") + return -errno.ENOENT + elif item == '': + logging.error("Returning ENOENT") + return -errno.ENOENT + statinfo = os.stat(item) + st = Stat(st_mode=statinfo.st_mode, st_size=statinfo.st_size, st_uid=statinfo.st_uid, st_gid=statinfo.st_gid, st_nlink=statinfo.st_nlink, dt_atime=datetime.datetime.fromtimestamp(statinfo.st_atime), dt_mtime=datetime.datetime.fromtimestamp(statinfo.st_mtime), dt_ctime=datetime.datetime.fromtimestamp(statinfo.st_ctime)) + return st + else: + logging.info("dir") + # it's a directory + if not pathsplit[len(pathsplit)-1] in directory_structure.getnode(pathsplit[0:len(pathsplit)-1]).dirs: + # directory not found + logging.error("Returning ENOENT") + return -errno.ENOENT + else: + logging.info("gotdir") + mode = stat.S_IFDIR | 0544 + st = Stat(st_mode=mode, st_size=Stat.DIRSIZE, st_nlink=2) + return st + + except Exception as e: + logging.error(e) + return -errno.ENOENT + + # Note: utime is deprecated in favour of utimens. + # utimens takes precedence over utime, so having this here does nothing + # unless you delete utimens. + def utime(self, path, times): + + atime, mtime = times + logging.info("utime: %s (atime %s, mtime %s)" % (path, atime, mtime)) + return -errno.EOPNOTSUPP + + def utimens(self, path, atime, mtime): + + logging.info("utime: %s (atime %s:%s, mtime %s:%s)" + % (path,atime.tv_sec,atime.tv_nsec,mtime.tv_sec,mtime.tv_nsec)) + return -errno.EOPNOTSUPP + + def access(self, path, flags): + logging.info("access: %s (flags %s)" % (path, oct(flags))) + pathsplit = path[1:].split('/') + if path == "/": + return 0 + else: + is_dir = not len(pathsplit) == structure_depth + + # check for existence + if is_dir: + logging.info("dir") + if not pathsplit[len(pathsplit) - 1] in directory_structure.getnode(pathsplit[0:len(pathsplit)-1]).dirs: + return -errno.EACCES + else: + # if exists, always return allowed for directories + return 0 + else: + item = self.lib.get_path(id=directory_structure.getnode(pathsplit[0:structure_depth-1]).files[pathsplit[structure_depth-1]])[0] + if not item: + return -errno.EACCES + else: + # TODO: actually check the file permissions + # NB. existence is already tested (os.F_OK) + if flags | os.R_OK: + pass + if flags | os.W_OK: + pass + if flags | os.X_OK: + pass + + return 0 + + def readlink(self, path): + """ + Get the target of a symlink. + Returns a bytestring with the contents of a symlink (its target). + May also return an int error code. + """ + logging.info("readlink: %s" % path) + return -errno.EOPNOTSUPP + + def mknod(self, path, mode, rdev): + """ + Creates a non-directory file (or a device node). + mode: Unix file mode flags for the file being created. + rdev: Special properties for creation of character or block special + devices (I've never gotten this to work). + Always 0 for regular files or FIFO buffers. + """ + # Note: mode & 0770000 gives you the non-permission bits. + # Common ones: + # S_IFREG: 0100000 (A regular file) + # S_IFIFO: 010000 (A fifo buffer, created with mkfifo) + + # Potential ones (I have never seen them): + # Note that these could be made by copying special devices or sockets + # or using mknod, but I've never gotten FUSE to pass such a request + # along. + # S_IFCHR: 020000 (A character special device, created with mknod) + # S_IFBLK: 060000 (A block special device, created with mknod) + # S_IFSOCK: 0140000 (A socket, created with mkfifo) + + # Also note: You can use self.GetContext() to get a dictionary + # {'uid': ?, 'gid': ?}, which tells you the uid/gid of the user + # executing the current syscall. This should be handy when creating + # new files and directories, because they should be owned by this + # user/group. + logging.info("mknod: %s (mode %s, rdev %s)" % (path, oct(mode), rdev)) + return -errno.EOPNOTSUPP + + def mkdir(self, path, mode): + """ + Creates a directory. + mode: Unix file mode flags for the directory being created. + """ + # Note: mode & 0770000 gives you the non-permission bits. + # Should be S_IDIR (040000); I guess you can assume this. + # Also see note about self.GetContext() in mknod. + logging.info("mkdir: %s (mode %s)" % (path, oct(mode))) + return -errno.EOPNOTSUPP + + def unlink(self, path): + """Deletes a file.""" + logging.info("unlink: %s" % path) + return -errno.EOPNOTSUPP + + def rmdir(self, path): + """Deletes a directory.""" + logging.info("rmdir: %s" % path) + return -errno.EOPNOTSUPP + + def symlink(self, target, name): + """ + Creates a symbolic link from path to target. + + The 'name' is a regular path like any other method (absolute, but + relative to the filesystem root). + The 'target' is special - it works just like any symlink target. It + may be absolute, in which case it is absolute on the user's system, + NOT the mounted filesystem, or it may be relative. It should be + treated as an opaque string - the filesystem implementation should not + ever need to follow it (that is handled by the OS). + + Hence, if the operating system creates a link FROM this system TO + another system, it will call this method with a target pointing + outside the filesystem. + If the operating system creates a link FROM some other system TO this + system, it will not touch this system at all (symlinks do not depend + on the target system unless followed). + """ + logging.info("symlink: target %s, name: %s" % (target, name)) + return -errno.EOPNOTSUPP + + def link(self, target, name): + """ + Creates a hard link from name to target. Note that both paths are + relative to the mounted file system. Hard-links across systems are not + supported. + """ + logging.info("link: target %s, name: %s" % (target, name)) + return -errno.EOPNOTSUPP + + def rename(self, old, new): + """ + Moves a file from old to new. (old and new are both full paths, and + may not be in the same directory). + + Note that both paths are relative to the mounted file system. + If the operating system needs to move files across systems, it will + manually copy and delete the file, and this method will not be called. + """ + logging.info("rename: target %s, name: %s" % (old, new)) + return -errno.EOPNOTSUPP + + def chmod(self, path, mode): + """Changes the mode of a file or directory.""" + logging.info("chmod: %s (mode %s)" % (path, oct(mode))) + return -errno.EOPNOTSUPP + + def chown(self, path, uid, gid): + """Changes the owner of a file or directory.""" + logging.info("chown: %s (uid %s, gid %s)" % (path, uid, gid)) + return -errno.EOPNOTSUPP + + def truncate(self, path, size): + """ + Shrink or expand a file to a given size. + If 'size' is smaller than the existing file size, truncate it from the + end. + If 'size' if larger than the existing file size, extend it with null + bytes. + """ + logging.info("truncate: %s (size %s)" % (path, size)) + return -errno.EOPNOTSUPP + + ### DIRECTORY OPERATION METHODS ### + # Methods in this section are operations for opening directories and + # working on open directories. + # "opendir" is the method for opening directories. It *may* return an + # arbitrary Python object (not None or int), which is used as a dir + # handle by the methods for working on directories. + # All the other methods (readdir, fsyncdir, releasedir) are methods for + # working on directories. They should all be prepared to accept an + # optional dir-handle argument, which is whatever object "opendir" + # returned. + + def opendir(self, path): + """ + Checks permissions for listing a directory. + This should check the 'r' (read) permission on the directory. + + On success, *may* return an arbitrary Python object, which will be + used as the "fh" argument to all the directory operation methods on + the directory. Or, may just return None on success. + On failure, should return a negative errno code. + Should return -errno.EACCES if disallowed. + """ + logging.info("opendir: %s" % path) + pathsplit = path[1:].split('/') + if path == "/": + return directory_structure + else: + if not pathsplit[len(pathsplit) - 1] in directory_structure.getnode(pathsplit[0:len(pathsplit)-1]).dirs: + return -errno.EACCES + else: + return directory_structure.getnode(pathsplit[0:len(pathsplit)-1]).dirs[pathsplit[len(pathsplit) - 1]] + + def releasedir(self, path, dh=None): + """ + Closes an open directory. Allows filesystem to clean up. + """ + logging.info("releasedir: %s (dh %s)" % (path, dh)) + + def fsyncdir(self, path, datasync, dh=None): + """ + Synchronises an open directory. + datasync: If True, only flush user data, not metadata. + """ + logging.info("fsyncdir: %s (datasync %s, dh %s)" + % (path, datasync, dh)) + + def readdir(self, path, offset, dh=None): + """ + Generator function. Produces a directory listing. + Yields individual fuse.Direntry objects, one per file in the + directory. Should always yield at least "." and "..". + Should yield nothing if the file is not a directory or does not exist. + (Does not need to raise an error). + + offset: I don't know what this does, but I think it allows the OS to + request starting the listing partway through (which I clearly don't + yet support). Seems to always be 0 anyway. + """ + logging.info("readdir: %s (offset %s, dh %s)" % (path, offset, dh)) + + yield fuse.Direntry(".") + yield fuse.Direntry("..") + + try: + pathsplit = path[1:].split('/') + + + if dh == None: + if path == "/": + logging.info("dh assigned as root") + dh = directory_structure + else: + dh = directory_structure.getnode(pathsplit[0:len(pathsplit)-1]).dirs[pathsplit[len(pathsplit)]] + + + if len(pathsplit) == structure_depth - 1: + # files + logging.info("Yielding files: %s" % path) + for files in directory_structure.listdir(pathsplit, False): + logging.info("Yielding file: %s" % files.encode('utf-8')) + yield fuse.Direntry(files.encode('utf-8')) + else: + # directories + for files in directory_structure.listdir(pathsplit, True): + #logging.info("Yielding dir: %s" % files.encode('utf-8')) + yield fuse.Direntry(files.encode('utf-8')) + + except Exception as e: + logging.error(e) + + ### FILE OPERATION METHODS ### + # Methods in this section are operations for opening files and working on + # open files. + # "open" and "create" are methods for opening files. They *may* return an + # arbitrary Python object (not None or int), which is used as a file + # handle by the methods for working on files. + # All the other methods (fgetattr, release, read, write, fsync, flush, + # ftruncate and lock) are methods for working on files. They should all be + # prepared to accept an optional file-handle argument, which is whatever + # object "open" or "create" returned. + + def open(self, path, flags): + """ + Open a file for reading/writing, and check permissions. + flags: As described in man 2 open (Linux Programmer's Manual). + ORing of several access flags, including one of os.O_RDONLY, + os.O_WRONLY or os.O_RDWR. All other flags are in os as well. + + On success, *may* return an arbitrary Python object, which will be + used as the "fh" argument to all the file operation methods on the + file. Or, may just return None on success. + On failure, should return a negative errno code. + Should return -errno.EACCES if disallowed. + """ + logging.info("open: %s (flags %s)" % (path, oct(flags))) + + file_path = None + + try: + if path in self.files: + # get a file object + logging.info("Retrieving an existing File Handler for: %s" % path) + self.files[path].open() + else: + # create a file open + logging.info("Creating a File Handler for: %s" % path) + self.files[path] = FileHandler(path, self.lib) + + return self.files[path] + except Exception as e: + logging.info("Error creating a File Handler: %s" % e) + return -errno.EACCES + + + def create(self, path, mode, rdev): + """ + Creates a file and opens it for writing. + Will be called in favour of mknod+open, but it's optional (OS will + fall back on that sequence). + mode: Unix file mode flags for the file being created. + rdev: Special properties for creation of character or block special + devices (I've never gotten this to work). + Always 0 for regular files or FIFO buffers. + See "open" for return value. + """ + logging.info("create: %s (mode %s, rdev %s)" % (path,oct(mode),rdev)) + return -errno.EOPNOTSUPP + + def fgetattr(self, path, fh=None): + """ + Retrieves information about a file (the "stat" of a file). + Same as Fuse.getattr, but may be given a file handle to an open file, + so it can use that instead of having to look up the path. + """ + logging.info("fgetattr: %s (fh %s)" % (path, fh)) + # We could use fh for a more efficient lookup. Here we just call the + # non-file-handle version, getattr. + return self.getattr(path) + + def release(self, path, flags, fh=None): + """ + Closes an open file. Allows filesystem to clean up. + flags: The same flags the file was opened with (see open). + """ + logging.info("release: %s (flags %s, fh %s)" % (path, oct(flags), fh)) + if self.files[path].release(): + logging.info("Complete release: %s (flags %s, fh %s)" % (path, oct(flags), fh)) + del self.files[path] + + def fsync(self, path, datasync, fh=None): + """ + Synchronises an open file. + datasync: If True, only flush user data, not metadata. + """ + logging.info("fsync: %s (datasync %s, fh %s)" % (path, datasync, fh)) + + def flush(self, path, fh=None): + """ + Flush cached data to the file system. + This is NOT an fsync (I think the difference is fsync goes both ways, + while flush is just one-way). + """ + logging.info("flush: %s (fh %s)" % (path, fh)) + + def read(self, path, size, offset, fh=None): + """ + Get all or part of the contents of a file. + size: Size in bytes to read. + offset: Offset in bytes from the start of the file to read from. + Does not need to check access rights (operating system will always + call access or open first). + Returns a byte string with the contents of the file, with a length no + greater than 'size'. May also return an int error code. + + If the length of the returned string is 0, it indicates the end of the + file, and the OS will not request any more. If the length is nonzero, + the OS may request more bytes later. + To signal that it is NOT the end of file, but no bytes are presently + available (and it is a non-blocking read), return -errno.EAGAIN. + If it is a blocking read, just block until ready. + """ + logging.info("read: %s (size %s, offset %s, fh %s)" + % (path, size, offset, fh)) + + + if fh == None: + file_path = None + + try: + if self.files == None: + self.files = {"x":"y"} + self.files[path] = FileHandler(path, self.lib) + except: + return -errno.EPERM + + + return self.files[path].read(size, offset) + + def write(self, path, buf, offset, fh=None): + """ + Write over part of a file. + buf: Byte string containing the text to write. + offset: Offset in bytes from the start of the file to write to. + Does not need to check access rights (operating system will always + call access or open first). + Should only overwrite the part of the file from offset to + offset+len(buf). + + Must return an int: the number of bytes successfully written (should + be equal to len(buf) unless an error occured). May also be a negative + int, which is an errno code. + """ + logging.info("write: %s (offset %s, fh %s)" % (path, offset, fh)) + logging.debug(" buf: %r" % buf) + + return -errno.EOPNOTSUPP + + def ftruncate(self, path, size, fh=None): + """ + Shrink or expand a file to a given size. + Same as Fuse.truncate, but may be given a file handle to an open file, + so it can use that instead of having to look up the path. + """ + logging.info("ftruncate: %s (size %s, fh %s)" % (path, size, fh)) + return -errno.EOPNOTSUPP + +