From 399c9b3abd460946b3d76d3f8cbbc59b04438c69 Mon Sep 17 00:00:00 2001 From: deadc0de6 Date: Thu, 14 Dec 2017 19:37:31 +0100 Subject: [PATCH] first commit --- .gitignore | 2 + .travis.yml | 17 ++ LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 232 +++++++++++++++ catcli/__init__.py | 15 + catcli/catalog.py | 86 ++++++ catcli/catcli.py | 169 +++++++++++ catcli/logger.py | 94 ++++++ catcli/noder.py | 210 ++++++++++++++ catcli/utils.py | 51 ++++ catcli/walker.py | 44 +++ requirements.txt | 3 + setup.py | 39 +++ tests.sh | 10 + tests/__init__.py | 0 tests/helpers.py | 176 ++++++++++++ tests/test_find.py | 47 +++ tests/test_index.py | 82 ++++++ tests/test_ls.py | 61 ++++ tests/test_rm.py | 53 ++++ 20 files changed, 2065 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 catcli/__init__.py create mode 100644 catcli/catalog.py create mode 100755 catcli/catcli.py create mode 100644 catcli/logger.py create mode 100644 catcli/noder.py create mode 100644 catcli/utils.py create mode 100644 catcli/walker.py create mode 100644 requirements.txt create mode 100644 setup.py create mode 100755 tests.sh create mode 100644 tests/__init__.py create mode 100644 tests/helpers.py create mode 100644 tests/test_find.py create mode 100644 tests/test_index.py create mode 100644 tests/test_ls.py create mode 100644 tests/test_rm.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..004a8d7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*.pyc +.coverage diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..1470343 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,17 @@ +language: python +python: + - "3.3" + - "3.4" + - "3.5" + - "3.6" + - "nightly" +install: + - "pip install pycodestyle" + - "pip install nose" + - "pip install coverage" + - "pip install coveralls" + - "pip install -r requirements.txt" +script: + ./tests.sh +after_success: + coveralls diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cecc1d --- /dev/null +++ b/LICENSE @@ -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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + 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/README.md b/README.md new file mode 100644 index 0000000..6a84c64 --- /dev/null +++ b/README.md @@ -0,0 +1,232 @@ +# CATCLI + +[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) + +*The command line catalog tool for your offline data* + +Did you ever wanted to find back that specific file that should be on one of your +backup DVDs or one of your external hard drives ? You usually go through all +of them hoping to find the right one on the first try ? +Well [catcli](https://github.com/deadc0de6/catcli) indexes external media +in a catalog and allows to quickly find specific files or even navigate in the +catalog of indexed files while these are not connected to your host. + +Features: + + * Index any directories in a catalog + * Ability to search for files by name in the catalog + * Ability to navigate through indexed data à la `ls` + * Save catalog to json for easy versioning with git + * Command line interface FTW + * Store files and folders sizes + * Store md5 hash of files + +Quick start: + +```bash +# index a directory in the catalog +catcli index -u --meta='some description' log /var/log +# display the content +catcli tree +# navigate +catcli ls log +# find files/folders named '*log*' +catcli find log +``` + +see [usage](#usage) for specific info. + +## Why catcli ? + +[Catcli](https://github.com/deadc0de6/catcli) gives the ability to navigate, explore and find your files +that are stored on external media (DVDs, hard drives, USB sticks, ...) when those are not connected. +Catcli can just as easily index any arbitrary directories. + +See the [example](#example) for an overview of the available features. + +--- + +**Table of Contents** + +* [Installation](#installation) +* [Usage](#usage) + + * [Index data](#index-data) + * [Walk indexed files with ls](#walk-indexed-files-with-ls) + * [Find files](#find-files) + * [Display entire tree](#display-entire-tree) + +* [Example](#example) +* [Contribution](#contribution) + +# Installation + +```bash +$ cd /tmp; git clone https://github.com/deadc0de6/catcli && cd catcli +$ sudo python3 setup.py install +$ catcli --help +``` + +To work with catcli without installing it, you can do the following +```bash +$ cd /tmp; git clone https://github.com/deadc0de6/catcli && cd catcli +$ python3 -m catcli.catcli --help +``` + +or install it in a virtualenv +```bash +$ cd /tmp; git clone https://github.com/deadc0de6/catcli && cd catcli +$ virtualenv env +$ source env/bin/activate +$ python setup.py install +$ catcli --help +``` + +# Usage + +Each indexed directory is stored in the catalog. Multiple directories can be indexed +and they are all available through the command line interface of catcli. + +Four different types of entry are present in a catalog: + + * *top node*: this is the root of the tree + * *storage node*: this represents some indexed storage (a DVD, an external + hard drive, an USB drive, some arbitrary directory, ...) + * *dir node*: this is a directory + * *file node*: this is a file + +## Index data + +Let's say the DVD or external hard drive that needs to be indexed +is mounted on `/media/mnt`. The following command +will index the entire directory `/media/mnt` +and store that in your catalog under the name ``. + +```bash +$ catcli index --meta= -u /media/mnt +``` + +If not specified otherwise (switch `--catalog`), the catalog is saved in the current +directory under `catcli.catalog`. + +The `--meta` switch allows to add any additional information to store along in +the catalog like for example `the blue disk in my office`. + +## Walk indexed files with ls + +A catalog can be walked using the command ls as if the media +was mounted. + +File/folder separator is `/` +```bash +$ catcli ls tmp/a/b/c +``` + +See the [example](#example) for more. + +## Find files + +Files and directories can be found based on their names. + +See the [example](#example) for more. + +## Display entire tree + +The entire catalog can be shown using the `tree` command. + +See the [example](#example) for more. + +# Example + +Let's first create some files and directories: +```bash +$ mkdir -p /tmp/test/{a,b,c} +$ touch /tmp/test/a/{1,2,3} +$ touch /tmp/test/b/{4,5,6} +$ touch /tmp/test/c/{7,8,9} +$ ls -R /tmp/test +/tmp/test: +a b c + +/tmp/test/a: +1 2 3 + +/tmp/test/b: +4 5 6 + +/tmp/test/c: +7 8 9 +``` + +First this directory is indexed by catcli as if it was some kind of +external storage: +```bash +$ catcli index --meta='my test directory' -u tmptest /tmp/test +``` + +Catcli has created its catalog in the current directory as `catcli.catalog`. + +Printing the entire catalog as a tree is done with the command `tree` +```bash +$ catcli tree +top +└── storage: tmptest (free:183.7G, total:200.0G) (my test directory) + ├── b [nbfiles:3] + │ ├── 4 [size:0] + │ ├── 5 [size:0] + │ └── 6 [size:0] + ├── a [nbfiles:3] + │ ├── 1 [size:0] + │ ├── 3 [size:0] + │ └── 2 [size:0] + └── c [nbfiles:3] + ├── 7 [size:0] + ├── 8 [size:0] + └── 9 [size:0] +``` + +The catalog can be walked with `ls` as if it was a normal directory +```bash +$ catcli ls +top +- storage: tmptest (free:2.6G, total:2.6G) (my test directory) + +$ catcli ls tmptest +storage: tmptest (free:3.7G, total:3.7G) (my test directory) +- a [nbfiles:3] +- b [nbfiles:3] +- c [nbfiles:3] + +$ catcli ls tmptest/b +b [nbfiles:3] +- 4 [size:0] +- 5 [size:0] +- 6 [size:0] +``` + +And files can be found using the command `find` +```bash +$ catcli find 9 +test/c/9 [size:0] +``` + +When using the `-s` switch, a one-liner is generated +that allows to handle the found file(s) +```bash +$ catcli find 9 -s +test/c/9 [size:0] +op=file; source=/media/mnt; $op ${source}/test/c/9 +``` + +# Contribution + +If you are having trouble installing or using catcli, open an issue. + +If you want to contribute, feel free to do a PR (please follow PEP8). + +The `tests.sh` script can be run to check the code. + +# License + +This project is licensed under the terms of the GPLv3 license. + diff --git a/catcli/__init__.py b/catcli/__init__.py new file mode 100644 index 0000000..11c4a51 --- /dev/null +++ b/catcli/__init__.py @@ -0,0 +1,15 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +Copyright (c) 2017, deadc0de6 +""" + +import sys + +__version__ = '0.1' + + +def main(): + import catcli.catcli + if catcli.catcli.main(): + sys.exit(0) + sys.exit(1) diff --git a/catcli/catalog.py b/catcli/catalog.py new file mode 100644 index 0000000..9c16c84 --- /dev/null +++ b/catcli/catalog.py @@ -0,0 +1,86 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +Copyright (c) 2017, deadc0de6 + +Class that represents the catcli catalog +""" + +import os +import pickle +from anytree.exporter import JsonExporter +from anytree.importer import JsonImporter + +# local imports +import catcli.utils as utils +from catcli.logger import Logger + + +class Catalog: + + def __init__(self, path, pickle=False, verbose=False, force=False): + self.path = path # catalog path + self.verbose = verbose # verbosity + self.force = force # force overwrite if exists + # prefer json for git versioning + self.pickle = pickle + + def restore(self): + ''' restore the catalog ''' + if not self.path: + return None + if not os.path.exists(self.path): + return None + if self.pickle: + return self._restore_pickle() + return self._restore_json(open(self.path, 'r').read()) + + def save(self, node): + ''' save the catalog ''' + if not self.path: + Logger.err('Path not defined') + return False + d = os.path.dirname(self.path) + if d and not os.path.exists(d): + os.makedirs(d) + elif os.path.exists(self.path) and not self.force: + if not utils.ask('Overwrite \"{}\"'.format(self.path)): + Logger.info('Catalog not saved') + return False + if d and not os.path.exists(d): + Logger.err('Cannot write to \"{}\"'.format(d)) + return False + if self.pickle: + return self._save_pickle(node) + return self._save_json(node) + + def _save_pickle(self, node): + ''' pickle the catalog''' + pickle.dump(node, open(self.path, 'wb')) + if self.verbose: + Logger.info('Catalog saved to pickle \"{}\"'.format(self.path)) + return True + + def _save_json(self, node): + ''' export the catalog in json ''' + exp = JsonExporter(indent=2, sort_keys=True) + with open(self.path, 'w') as f: + exp.write(node, f) + if self.verbose: + Logger.info('Catalog saved to json \"{}\"'.format(self.path)) + return True + + def _restore_pickle(self): + ''' restore the pickled tree ''' + root = pickle.load(open(self.path, 'rb')) + if self.verbose: + m = 'Catalog imported from pickle \"{}\"'.format(self.path) + Logger.info(m) + return root + + def _restore_json(self, string): + ''' restore the tree from json ''' + imp = JsonImporter() + root = imp.import_(string) + if self.verbose: + Logger.info('Catalog imported from json \"{}\"'.format(self.path)) + return root diff --git a/catcli/catcli.py b/catcli/catcli.py new file mode 100755 index 0000000..dc4f73f --- /dev/null +++ b/catcli/catcli.py @@ -0,0 +1,169 @@ +#!/usr/bin/env python3 +# author: deadc0de6 + +""" +author: deadc0de6 (https://github.com/deadc0de6) +Copyright (c) 2017, deadc0de6 + +Catcli command line interface +""" + +import sys +import os +import datetime +from docopt import docopt + +# local imports +from . import __version__ as VERSION +from .logger import Logger +from .catalog import Catalog +from .walker import Walker +from .noder import Noder + +NAME = 'catcli' +CUR = os.path.dirname(os.path.abspath(__file__)) +CATALOGPATH = NAME+'.catalog' +GRAPHPATH = '/tmp/'+NAME+'.dot' +SEPARATOR = '/' +WILD = '*' + +BANNER = """ +-+-+-+-+-+-+ + |c|a|t|c|l|i| + +-+-+-+-+-+-+ v{}""".format(VERSION) + +USAGE = """ +{0} + +Usage: + {1} index [--catalog=] [--meta=...] [-fcuV] + {1} ls [--catalog=] [-rV] [] + {1} find [--catalog=] [-sV] + {1} rm [--catalog=] [-fV] + {1} tree [--catalog=] [-V] + {1} graph [--catalog=] [-V] [] + {1} --help + {1} --version + +Options: + --catalog= Path to the catalog [default: {2}]. + --meta= Additional attribute to store [default: ]. + -u --subsize Store size of folders [default: False]. + -f --force Force overwrite [default: False]. + -s --script Output script to manage found file(s) [default: False]. + -c --hash Calculate md5 hash [default: False]. + -r --recursive Recursive [default: False]. + -V --verbose Be verbose [default: False]. + -v --version Show version. + -h --help Show this screen. +""".format(BANNER, NAME, CATALOGPATH) + + +def cmd_index(args, noder, catalog, top): + path = args[''] + name = args[''] + nohash = not args['--hash'] + subsize = args['--subsize'] + if not os.path.exists(path): + Logger.err('\"{}\" does not exist'.format(path)) + return False + if name in noder.get_storage_names(top): + Logger.err('storage named \"{}\" already exist'.format(name)) + return False + start = datetime.datetime.now() + walker = Walker(noder, nohash=nohash) + root = noder.storage_node(name, path, parent=top, attr=args['--meta']) + _, cnt = walker.index(path, name, parent=root, parentpath=path) + if subsize: + noder.rec_size(root) + stop = datetime.datetime.now() + Logger.info('Indexed {} file(s) in {}'.format(cnt, stop-start)) + catalog.save(top) + + +def cmd_ls(args, noder, top): + path = args[''] + if not path: + path = SEPARATOR + if not path.startswith(SEPARATOR): + path = SEPARATOR + path + pre = '{}{}'.format(SEPARATOR, noder.TOPNAME) + if not path.startswith(pre): + path = pre + path + if not path.endswith(SEPARATOR): + path += SEPARATOR + if not path.endswith(WILD): + path += WILD + return noder.walk(top, path, rec=args['--recursive']) + + +def cmd_rm(args, noder, catalog, top): + what = args[''] + storages = list(x.name for x in top.children) + if what in storages: + node = next(filter(lambda x: x.name == what, top.children)) + node.parent = None + catalog.save(top) + else: + Logger.err('Storage named \"{}\" does not exist'.format(what)) + return top + + +def cmd_find(args, noder, top): + return noder.find_name(top, args[''], script=args['--script']) + + +def cmd_tree(args, noder, top): + noder.print_tree(top) + + +def cmd_graph(args, noder, top): + path = args[''] + if not path: + path = GRAPHPATH + cmd = noder.to_dot(top, path) + Logger.info('create graph with \"{}\" (you need graphviz)'.format(cmd)) + + +def banner(): + Logger.log(BANNER) + Logger.log("") + + +def main(): + args = docopt(USAGE, version=VERSION) + + # print banner + banner() + + # init noder + noder = Noder(verbose=args['--verbose']) + # init catalog + catalog = Catalog(args['--catalog'], verbose=args['--verbose'], + force=args['--force']) + # init top node + top = catalog.restore() + if not top: + top = noder.new_top_node() + + # parse command + if args['index']: + cmd_index(args, noder, catalog, top) + elif args['find']: + cmd_find(args, noder, top) + elif args['tree']: + cmd_tree(args, noder, top) + elif args['ls']: + cmd_ls(args, noder, top) + elif args['rm']: + cmd_rm(args, noder, catalog, top) + elif args['graph']: + cmd_graph(args, noder, top) + + return True + + +if __name__ == '__main__': + ''' entry point ''' + if main(): + sys.exit(0) + sys.exit(1) diff --git a/catcli/logger.py b/catcli/logger.py new file mode 100644 index 0000000..891a343 --- /dev/null +++ b/catcli/logger.py @@ -0,0 +1,94 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +Copyright (c) 2017, deadc0de6 + +Logging helper +""" + +import sys + + +class Logger: + + RED = '\033[91m' + GREEN = '\033[92m' + YELLOW = '\033[93m' + PURPLE = '\033[1;35m' + BLUE = '\033[94m' + GRAY = '\033[0;37m' + MAGENTA = '\033[95m' + RESET = '\033[0m' + EMPH = '\033[33m' + UND = '\033[4m' + + def __init__(self): + pass + + ###################################################################### + # node specific output + ###################################################################### + def storage(pre, name, attr): + ''' print a storage node ''' + end = '' + if attr: + end = ' {}({}){}'.format(Logger.GRAY, ','.join(attr), Logger.RESET) + s = '{}{}storage{}:'.format(pre, Logger.UND, Logger.RESET) + s += ' {}{}{}{}'.format(Logger.PURPLE, name, Logger.RESET, end) + sys.stdout.write(s+'\n') + + def file(pre, name, attr): + ''' print a file node ''' + s = '{}{}'.format(pre, name) + s += ' {}[{}]{}'.format(Logger.GRAY, attr, Logger.RESET) + sys.stdout.write(s+'\n') + + def dir(pre, name, depth='', attr=None): + ''' print a directory node ''' + end = [] + if depth != '': + end.append('nbfiles:{}'.format(depth)) + if attr: + end.append(' '.join(['{}:{}'.format(x, y) for x, y in attr])) + if end: + end = ' [{}]'.format(', '.join(end)) + s = '{}{}{}{}'.format(pre, Logger.BLUE, name, Logger.RESET) + s += '{}{}{}'.format(Logger.GRAY, end, Logger.RESET) + sys.stdout.write(s+'\n') + + ###################################################################### + # generic output + ###################################################################### + def out(string): + ''' to stdout ''' + sys.stdout.write(string+'\n') + + def log(string): + ''' to stderr ''' + sys.stderr.write(string+'\n') + + def info(string): + ''' to stderr in color ''' + s = '{}{}{}'.format(Logger.MAGENTA, string, Logger.RESET) + sys.stderr.write(s+'\n') + + def err(string): + ''' to stderr in RED ''' + s = '{}{}{}'.format(Logger.RED, string, Logger.RESET) + sys.stderr.write(s+'\n') + + def clog(string, color, stdout=True): + ''' generic printer wrapper for colored text ''' + s = '{}{}{}'.format(color, string, Logger.RESET) + if stdout: + sys.stdout.write(s+'\n') + else: + sys.stderr.write(s+'\n') + + def progr(string): + ''' print progress ''' + sys.stderr.write('{}\r'.format(string)) + sys.stderr.flush() + + def get(string, color): + ''' get color formatted text ''' + return '{}{}{}'.format(color, string, Logger.RESET) diff --git a/catcli/noder.py b/catcli/noder.py new file mode 100644 index 0000000..3b62b1e --- /dev/null +++ b/catcli/noder.py @@ -0,0 +1,210 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +Copyright (c) 2017, deadc0de6 + +Class that represents a node in the catalog tree +""" + +import os +import anytree +import psutil +import time + +# local imports +import catcli.utils as utils +from catcli.logger import Logger + +''' +There are 4 types of node: + * "top" node representing the top node (generic node) + * "storage" node representing a storage + * "dir" node representing a directory + * "file" node representing a file +''' + + +class Noder: + + TOPNAME = 'top' + TYPE_TOP = 'top' # tip top ;-) + TYPE_FILE = 'file' + TYPE_DIR = 'dir' + TYPE_STORAGE = 'storage' + + def __init__(self, verbose=False): + self.hash = True + self.verbose = verbose + + def set_hashing(self, val): + self.hash = val + + def get_storage_names(self, top): + ''' return a list of all storage names ''' + return [x.name for x in list(top.children)] + + ############################################################### + # node creationg + ############################################################### + def new_top_node(self): + ''' create a new top node''' + return anytree.AnyNode(name=self.TOPNAME, type=self.TYPE_TOP) + + def file_node(self, name, path, parent, storagepath): + ''' create a new node representing a file ''' + path = os.path.abspath(path) + st = os.lstat(path) + md5 = None + if self.hash: + md5 = utils.md5sum(path) + relpath = os.path.join(os.path.basename(storagepath), + os.path.relpath(path, start=storagepath)) + return self._node(name, self.TYPE_FILE, relpath, parent, + size=st.st_size, md5=md5) + + def dir_node(self, name, path, parent, storagepath): + ''' create a new node representing a directory ''' + path = os.path.abspath(path) + relpath = os.path.relpath(path, start=storagepath) + return self._node(name, self.TYPE_DIR, relpath, parent) + + def storage_node(self, name, path, parent, attr=None): + ''' create a new node representing a storage ''' + path = os.path.abspath(path) + free = psutil.disk_usage(path).free + total = psutil.disk_usage(path).total + epoch = time.time() + return anytree.AnyNode(name=name, type=self.TYPE_STORAGE, free=free, + total=total, parent=parent, attr=attr, ts=epoch) + + def _node(self, name, type, relpath, parent, size=None, md5=None): + ''' generic node creation ''' + return anytree.AnyNode(name=name, type=type, relpath=relpath, + parent=parent, size=size, md5=md5) + + ############################################################### + # printing + ############################################################### + def _print_node(self, node, pre='', withpath=False, withdepth=False): + ''' print a node ''' + if node.type == self.TYPE_TOP: + Logger.out('{}{}'.format(pre, node.name)) + elif node.type == self.TYPE_FILE: + name = node.name + if withpath: + name = node.relpath + attr = '' + if node.md5: + attr = ', md5:{}'.format(node.md5) + compl = 'size:{}{}'.format(utils.human(node.size), attr) + Logger.file(pre, name, compl) + elif node.type == self.TYPE_DIR: + name = node.name + if withpath: + name = node.relpath + depth = '' + if withdepth: + depth = len(node.children) + attr = None + if node.size: + attr = [['totsize', utils.human(node.size)]] + Logger.dir(pre, name, depth=depth, attr=attr) + elif node.type == self.TYPE_STORAGE: + hf = utils.human(node.free) + ht = utils.human(node.total) + name = '{} (free:{}, total:{})'.format(node.name, hf, ht) + Logger.storage(pre, name, node.attr) + else: + Logger.err('Weird node encountered: {}'.format(node)) + # Logger.out('{}{}'.format(pre, node.name)) + + def print_tree(self, node, style=anytree.ContRoundStyle()): + ''' print the tree similar to unix tool "tree" ''' + for pre, fill, node in anytree.RenderTree(node, childiter=self.sort_tree): + self._print_node(node, pre=pre, withdepth=True) + + ############################################################### + # searching + ############################################################### + def find_name(self, root, key, script=False): + ''' find files based on their names ''' + if self.verbose: + Logger.info('searching for \"{}\"'.format(key)) + self.term = key + found = anytree.findall(root, filter_=self._find_name) + paths = [] + for f in found: + if f.type == self.TYPE_STORAGE: + # ignore storage nodes + continue + self._print_node(f, withpath=True, withdepth=True) + paths.append(f.relpath) + if script: + tmp = ['${source}/'+x for x in paths] + cmd = 'op=file; source=/media/mnt; $op {}'.format(' '.join(tmp)) + Logger.info(cmd) + return found + + def _find_name(self, node): + ''' callback for finding files ''' + if self.term.lower() in node.name.lower(): + return True + return False + + ############################################################### + # climbing + ############################################################### + def walk(self, root, path, rec=False): + ''' walk the tree for ls based on names ''' + if self.verbose: + Logger.info('walking path: \"{}\"'.format(path)) + r = anytree.resolver.Resolver('name') + found = [] + try: + found = r.glob(root, path) + if len(found) < 1: + return [] + if rec: + self.print_tree(found[0].parent) + return + found = sorted(found, key=self.sort_walk) + self._print_node(found[0].parent, + withpath=False, withdepth=True) + for f in found: + self._print_node(f, withpath=False, pre='- ', withdepth=True) + except anytree.resolver.ChildResolverError: + pass + return found + + ############################################################### + # diverse + ############################################################### + def sort_tree(self, items): + ''' sorting a list of items ''' + return sorted(items, key=self.sort_walk) + + def sort_walk(self, n): + ''' for sorting a node ''' + return (n.type, n.name.lstrip('\.').lower()) + + def to_dot(self, node, path='tree.dot'): + ''' export to dot for graphing ''' + anytree.exporter.DotExporter(node).to_dotfile(path) + Logger.info('dot file created under \"{}\"'.format(path)) + return 'dot {} -T png -o /tmp/tree.png'.format(path) + + def rec_size(self, node): + ''' recursively traverse tree and store dir size ''' + if self.verbose: + Logger.info('getting folder size recursively') + if node.type == self.TYPE_FILE: + return node.size + size = 0 + for i in node.children: + if node.type == self.TYPE_DIR: + size += self.rec_size(i) + if node.type == self.TYPE_STORAGE: + self.rec_size(i) + else: + continue + node.size = size + return size diff --git a/catcli/utils.py b/catcli/utils.py new file mode 100644 index 0000000..7fe0e6a --- /dev/null +++ b/catcli/utils.py @@ -0,0 +1,51 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +Copyright (c) 2017, deadc0de6 + +helpers +""" + +import os +import hashlib + +# local imports +from catcli.logger import Logger + + +def md5sum(path): + ''' calculate md5 sum of a file ''' + p = os.path.realpath(path) + if not os.path.exists(p): + Logger.err('\nunable to get md5sum on {}'.format(path)) + return None + try: + with open(p, mode='rb') as f: + d = hashlib.md5() + while True: + buf = f.read(4096) + if not buf: + break + d.update(buf) + return d.hexdigest() + except PermissionError: + pass + return None + + +def human(size): + ''' human readable size ''' + div = 1024. + suf = ['B', 'K', 'M', 'G', 'T', 'P'] + if size < div: + return '{}'.format(size) + for i in suf: + if size < div: + return '{:.1f}{}'.format(size, i) + size = size / div + return '{:.1f}{}'.format(size, suf[-1]) + + +def ask(question): + ''' ask the user what to do ''' + resp = input('{} [y|N] ? '.format(question)) + return resp.lower() == 'y' diff --git a/catcli/walker.py b/catcli/walker.py new file mode 100644 index 0000000..0d79ff9 --- /dev/null +++ b/catcli/walker.py @@ -0,0 +1,44 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +Copyright (c) 2017, deadc0de6 + +Catcli filesystem indexer +""" + +import os +import anytree + +# local imports +from catcli.noder import Noder +from catcli.logger import Logger + + +class Walker: + + def __init__(self, noder, nohash=False): + self.noder = noder + self.noder.set_hashing(not nohash) + + def index(self, path, name, parentpath=None, parent=None, isdir=False): + ''' index a folder and store in tree ''' + if not parent: + parent = noder.dir_node(name, path, parent) + + cnt = 0 + for (root, dirs, files) in os.walk(path): + for f in files: + sub = os.path.join(root, f) + Logger.progr('indexing: {:80}'.format(f)) + self.noder.file_node(os.path.basename(f), sub, + parent, parentpath) + cnt += 1 + for d in dirs: + base = os.path.basename(d) + sub = os.path.join(root, d) + dummy = self.noder.dir_node(base, sub, parent, parentpath) + _, cnt2 = self.index(sub, base, + parent=dummy, parentpath=parentpath) + cnt += cnt2 + break + + return parent, cnt diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..b9d29a1 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +docopt; python_version >= '3.0' +anytree; python_version >= '3.0' +psutil; python_version >= '3.0' diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..dd07abf --- /dev/null +++ b/setup.py @@ -0,0 +1,39 @@ +from setuptools import setup, find_packages +from codecs import open +from os import path +import catcli + +here = path.abspath(path.dirname(__file__)) + +# Get the long description from the README file +with open(path.join(here, 'README.md'), encoding='utf-8') as f: + long_description = f.read() + +setup( + name='catcli', + version=catcli.__version__, + + description='The command line catalog tool for your offline data', + long_description=long_description, + url='https://github.com/deadc0de6/catcli', + + author='deadc0de6', + author_email='deadc0de6@foo', + + license='GPLv3', + + keywords='catalog commandline indexer offline', + packages=find_packages(exclude=['tests*']), + install_requires=['docopt', 'anytree','psutil'], + + extras_require={ + 'dev': ['check-manifest'], + 'test': ['coverage', 'pytest', 'pytest-cov'], + }, + + entry_points={ + 'console_scripts': [ + 'catcli=catcli:main', + ], + }, +) diff --git a/tests.sh b/tests.sh new file mode 100755 index 0000000..010a885 --- /dev/null +++ b/tests.sh @@ -0,0 +1,10 @@ +#!/bin/sh +# author: deadc0de6 (https://github.com/deadc0de6) +# Copyright (c) 2017, deadc0de6 + +# stop on first error +set -ev + +pycodestyle catcli/ +pycodestyle tests/ +PYTHONPATH=catcli python3 -m nose -s --with-coverage --cover-package=catcli diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/helpers.py b/tests/helpers.py new file mode 100644 index 0000000..45f0943 --- /dev/null +++ b/tests/helpers.py @@ -0,0 +1,176 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +Copyright (c) 2017, deadc0de6 + +Helpers for the unittests +""" + +import os +import string +import random +import tempfile +import shutil + +TMPSUFFIX = '.catcli' + +############################################################ +# generic helpers +############################################################ + + +def get_rnd_string(length): + '''Get a random string of specific length ''' + alpha = string.ascii_uppercase + string.digits + return ''.join(random.choice(alpha) for _ in range(length)) + + +def clean(path): + '''Delete file or folder.''' + if not os.path.exists(path): + return + if os.path.islink(path): + os.remove(path) + elif os.path.isdir(path): + shutil.rmtree(path) + else: + os.remove(path) + +############################################################ +# catcli specific +############################################################ + + +def create_tree(): + ''' create a random tree of files and directories ''' + dirpath = get_tempdir() + # create 3 files + create_rnd_file(dirpath, get_rnd_string(5)) + create_rnd_file(dirpath, get_rnd_string(5)) + create_rnd_file(dirpath, get_rnd_string(5)) + + # create 2 directories + d1 = create_dir(dirpath, get_rnd_string(3)) + d2 = create_dir(dirpath, get_rnd_string(3)) + + # fill directories + create_rnd_file(d1, get_rnd_string(4)) + create_rnd_file(d1, get_rnd_string(4)) + create_rnd_file(d2, get_rnd_string(6)) + + return dirpath + +############################################################ +# files and directories +############################################################ + + +def get_tempdir(): + '''Get a temporary directory ''' + return tempfile.mkdtemp(suffix=TMPSUFFIX) + + +def create_dir(path, dirname): + '''Create a directory ''' + fpath = os.path.join(path, dirname) + if not os.path.exists(fpath): + os.mkdir(fpath) + return fpath + + +def create_rnd_file(path, filename, content=None): + '''Create the file filename in path with random content if None ''' + if not content: + content = get_rnd_string(100) + fpath = os.path.join(path, filename) + with open(fpath, 'w') as f: + f.write(content) + return fpath + + +############################################################ +# fake tree in json +############################################################ +FAKECATALOG = ''' +{ + "children": [ + { + "attr": null, + "children": [ + { + "md5": null, + "name": "7544G", + "relpath": "tmpj5602ih7.catcli/7544G", + "size": 100, + "type": "file" + }, + { + "md5": null, + "name": "KF2ZC", + "relpath": "tmpj5602ih7.catcli/KF2ZC", + "size": 100, + "type": "file" + }, + { + "md5": null, + "name": "Z9OII", + "relpath": "tmpj5602ih7.catcli/Z9OII", + "size": 100, + "type": "file" + }, + { + "children": [ + { + "md5": null, + "name": "M592O9", + "relpath": "tmpj5602ih7.catcli/VNN/M592O9", + "size": 100, + "type": "file" + } + ], + "md5": null, + "name": "VNN", + "relpath": "VNN", + "size": 100, + "type": "dir" + }, + { + "children": [ + { + "md5": null, + "name": "X37H", + "relpath": "tmpj5602ih7.catcli/P4C/X37H", + "size": 100, + "type": "file" + }, + { + "md5": null, + "name": "I566", + "relpath": "tmpj5602ih7.catcli/P4C/I566", + "size": 100, + "type": "file" + } + ], + "md5": null, + "name": "P4C", + "relpath": "P4C", + "size": 200, + "type": "dir" + } + ], + "free": 100000000000, + "name": "tmpdir", + "size": 0, + "total": 200000000000, + "ts": 1500000000.0000000, + "type": "storage" + } + ], + "name": "top", + "type": "top" +} +''' + + +def get_fakecatalog(): + # catalog constructed through test_index + return FAKECATALOG diff --git a/tests/test_find.py b/tests/test_find.py new file mode 100644 index 0000000..a04df14 --- /dev/null +++ b/tests/test_find.py @@ -0,0 +1,47 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +Copyright (c) 2017, deadc0de6 + +Basic unittest for find +""" + +import unittest + +import catcli + +from catcli.catcli import * +from catcli.noder import Noder +from catcli.walker import Walker +from catcli.catalog import Catalog +from catcli.logger import Logger +from catcli.utils import * +from tests.helpers import * + + +class TestFind(unittest.TestCase): + + def test_find(self): + # init + catalog = Catalog('fake', force=True, verbose=False) + top = catalog._restore_json(get_fakecatalog()) + noder = Noder() + + # create fake args + args = {'': '7544G', '--script': False} + + # try to find something + found = cmd_find(args, noder, top) + self.assertTrue(len(found) > 0) + + # try to find something that does not exist + args[''] = 'verynotfoundnote' + found = cmd_find(args, noder, top) + self.assertTrue(len(found) == 0) + + +def main(): + unittest.main() + + +if __name__ == '__main__': + main() diff --git a/tests/test_index.py b/tests/test_index.py new file mode 100644 index 0000000..aab31d3 --- /dev/null +++ b/tests/test_index.py @@ -0,0 +1,82 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +Copyright (c) 2017, deadc0de6 + +Basic unittest for indexing +""" + +import unittest + +from catcli.catcli import * +from catcli.noder import Noder +from catcli.walker import Walker +from catcli.catalog import Catalog +from tests.helpers import * + + +class TestIndexing(unittest.TestCase): + + def test_index(self): + # init + workingdir = get_tempdir() + catalogpath = create_rnd_file(workingdir, 'catalog.json', content='') + self.addCleanup(clean, workingdir) + + dirpath = get_tempdir() + self.addCleanup(clean, dirpath) + + # create 3 files + f1 = create_rnd_file(dirpath, get_rnd_string(5)) + f2 = create_rnd_file(dirpath, get_rnd_string(5)) + f3 = create_rnd_file(dirpath, get_rnd_string(5)) + + # create 2 directories + d1 = create_dir(dirpath, get_rnd_string(3)) + d2 = create_dir(dirpath, get_rnd_string(3)) + + # fill directories with files + d1f1 = create_rnd_file(d1, get_rnd_string(4)) + d1f2 = create_rnd_file(d1, get_rnd_string(4)) + d2f1 = create_rnd_file(d2, get_rnd_string(6)) + + noder = Noder() + top = noder.new_top_node() + walker = Walker(noder) + catalog = Catalog(catalogpath, force=True, verbose=False) + + # create fake args + tmpdirname = 'tmpdir' + args = {'': dirpath, '': tmpdirname, + '--hash': True, '--meta': 'some meta', + '--subsize': True} + + # index the directory + cmd_index(args, noder, catalog, top) + self.assertTrue(os.stat(catalogpath).st_size != 0) + + # explore the top node to find all nodes + self.assertTrue(len(top.children) == 1) + storage = top.children[0] + self.assertTrue(len(storage.children) == 5) + + # ensures files and directories are in + names = [x.name for x in storage.children] + self.assertTrue(os.path.basename(f1) in names) + self.assertTrue(os.path.basename(f2) in names) + self.assertTrue(os.path.basename(f3) in names) + self.assertTrue(os.path.basename(d1) in names) + self.assertTrue(os.path.basename(d2) in names) + + for node in storage.children: + if node.name == os.path.basename(d1): + self.assertTrue(len(node.children) == 2) + elif node.name == os.path.basename(d2): + self.assertTrue(len(node.children) == 1) + + +def main(): + unittest.main() + + +if __name__ == '__main__': + main() diff --git a/tests/test_ls.py b/tests/test_ls.py new file mode 100644 index 0000000..1d1f4e7 --- /dev/null +++ b/tests/test_ls.py @@ -0,0 +1,61 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +Copyright (c) 2017, deadc0de6 + +Basic unittest for ls +""" + +import unittest + +from catcli.catcli import * +from catcli.noder import Noder +from catcli.walker import Walker +from catcli.catalog import Catalog +from tests.helpers import * + + +class TestWalking(unittest.TestCase): + + def test_ls(self): + # init + path = 'fake' + self.addCleanup(clean, path) + catalog = Catalog(path, force=True, verbose=False) + top = catalog._restore_json(get_fakecatalog()) + noder = Noder() + + # create fake args + args = {'': '', '--recursive': False} + + # list root + args[''] = '' + found = cmd_ls(args, noder, top) + self.assertTrue(len(found) > 0) + + # list tmpdir that should have 5 children + args[''] = '/tmpdir' + found = cmd_ls(args, noder, top) + self.assertTrue(len(found) == 5) + + # list folder that should have 2 children + args[''] = '/tmpdir/P4C' + found = cmd_ls(args, noder, top) + self.assertTrue(len(found) == 2) + + # list folder that should have 1 children + args[''] = '/tmpdir/VNN' + found = cmd_ls(args, noder, top) + self.assertTrue(len(found) == 1) + + # test not existing path + args[''] = 'itdoesnotexist' + found = cmd_ls(args, noder, top) + self.assertTrue(len(found) == 0) + + +def main(): + unittest.main() + + +if __name__ == '__main__': + main() diff --git a/tests/test_rm.py b/tests/test_rm.py new file mode 100644 index 0000000..c62c05f --- /dev/null +++ b/tests/test_rm.py @@ -0,0 +1,53 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +Copyright (c) 2017, deadc0de6 + +Basic unittest for rm +""" + +import unittest + +from catcli.catcli import * +from catcli.noder import Noder +from catcli.walker import Walker +from catcli.catalog import Catalog +from tests.helpers import * + + +class TestRm(unittest.TestCase): + + def test_rm(self): + # init + path = 'fake' + self.addCleanup(clean, path) + catalog = Catalog(path, force=True, verbose=False) + top = catalog._restore_json(get_fakecatalog()) + noder = Noder() + + # create fake args dict + args = {'': '', '--recursive': False} + + # list files and make sure there are children + args[''] = '' + found = cmd_ls(args, noder, top) + self.assertTrue(len(found) > 0) + self.assertTrue(len(top.children) == 1) + + # rm a not existing storage + args[''] = 'abc' + top = cmd_rm(args, noder, catalog, top) + + # rm a storage + args[''] = 'tmpdir' + top = cmd_rm(args, noder, catalog, top) + + # ensure there no children anymore + self.assertTrue(len(top.children) == 0) + + +def main(): + unittest.main() + + +if __name__ == '__main__': + main()