commit d7be5a7fdf60512981e2b3e1887318068f7da784 Author: Cyrille L Date: Thu Mar 17 18:21:27 2022 +0100 Initial launch diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2a1caa8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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. + + GSL Statique Littérateur + Copyright (C) 2022 Libre en Communs / Commissions / Infrastructure + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..74bcdac --- /dev/null +++ b/README.md @@ -0,0 +1,157 @@ +# What is filebox + +filebox is an app script made to upload and download files from servers. + +I made this tool a long time ago to download files from my seedbox, but +i decided to rewrite it. filebox works on "any" server, and is not +intended to be used only with a seedbox. You can also use it to upload +and download any files to/from your servers... you could then, share your +server "upload" folder with your friends. + +# dependencies +- bash +- rsync +- sshfs + +# How to install ? +Create folders from list below and to avoid sudo for non root user, +use chown. Then, chmod 755 filebox so that it can be started + +``` +# Create and own folders +sudo mkdir -p /etc/filebox && chown -R $USER:$USER /etc/filebox +sudo mkdir -p /var/lib/filebox && chown -R $USER:$USER /var/lib/filebox + +# Copy executable filebox file: +sudp cp filebox /usr/local/bin/filebox +sudo chown $USER:$USER /usr/local/bin/filebox +sudo chmod 755 /usr/local/bin/filebox +``` + +# Files and Folders configuration +- /etc/filebox/ (file: filebox.conf (filebox configuration)) +- /var/lib/filebox/ (scripts, readme...) +- /usr/local/bin/ (file: filebox (executable)) + +# How to use it ? +Once installed, start configuring your server using: + +``` +filebox -C +``` + +You will be asked to add at first time only LOCAL Folders, one per +category file: +- Music +- Video (Private) +- Video (Public) +- Ebook +- Generic / Document + +And filebox will also ask you to add a default server and give its: +- user access +- IP +- Download server Folder +- Upload server folder +- Upload LOCAL Folder + +You can also add more servers, using your desired (server name), so that +you can + +``` +# if no (server name), filebox use (default) first configured server +filebox -C (server name) +``` + +The server password is not asked by filebox; you will have to write it +each time filebox needs to mount your server folders. + +# Private configurations files and folders (created by filebox) +- $HOME/.mnt/filebox/Downloads/(server name) < mount point +- $HOME/.mnt/filebox/Uploads/(server name) < mount point +- $HOME/.config/filebox < (config private files) + + +## Downloading files +To start downloading files from your server, type: + +``` +filebox -g +``` + +A file list will appear with item numbers. You can download one or several +files and folder by answering the question next to the list. If you want +to download item 1 to your local music folder and item 2 to your public +video folder, just answer: 1m 2p + +filebox will check for free space before downloading. A reserved 10Go +free space on your local HOME (configurable in /etc/filebox/filebox.conf) +is set. + +## Uploading files +To upload ALL files from your (Upload LOCAL Folder)/(server name), to +your specific server folder, type: + +``` +filebox -S +``` + +In that (Upload LOCAL Folder)/(server name) you could put all your +torrent files, but whatever you want, so they can be uploaded to your +server. + +filebox will check for free space on server before uploading. A reserved +5Go free space on your server (configurable in /etc/filebox/filebox.conf) +is set. + +Do not forget to unmount your mounted points using: + +``` +filebox -U [OPT] (server name) +``` + +# Help + +``` +$ filebox [ARGS] +: Upload/Download files to/from servers + It can be easily used with a seedbox + Reserved free space on local disk Default: 10G + Reserved free space on server disk Default: 5G +: No [NAME], use (default) + + [ARGS]: + help + : This Help + + config | -C [OPT] [NAME] + : Configure access to a server [NAME] + [OPT] + -l : edit file for local folders + -s : edit file for server configuration + + send | -s [OPT ][NAME] + : Move Files from (Upload LOCAL Folder)/[name] to Upload server folder + [OPT] + -k : Copy, not move + + unmount | -U [OPT] [NAME] + : Unmount directories + [OPT] + dl : Download directory only + ul : Upload Directory Only + + get | -g [NAME] + : List and choose files to download from server + +# Items Selector +: L > Load again the list + +# How to download items in specific folder according to categorie file +- Add a letter to number selected (i.e. 1e m3) +: d > Generic (also if no letter set) +: m > Music +: e > ebook +: v > Restricted Video +: p > Public Video +``` diff --git a/etc/filebox/filebox.conf b/etc/filebox/filebox.conf new file mode 100644 index 0000000..b8ccc38 --- /dev/null +++ b/etc/filebox/filebox.conf @@ -0,0 +1,36 @@ +#!/bin/bash +# file: filebox.conf +# Folder: /etc/filebox +# By echolib +# License: GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 + +# Reserved free space: 10G (Local) +fb_keep_hsize="10G" +fb_keep_bsize=10737418240 +# Reserved free space: 5Go (server) +fb_keep_sbsize=5368709120 + +# ------- +# Folders +# ------- +# Script config +fb_dir_conf_script="/etc/filebox" +# fbbox Config +fb_dir_conf_user="$HOME/.config/filebox" +# Scripts for exec +fb_dir_scripts="/var/lib/filebox/scripts" +# Mount Point +fb_dir_mnt_dl="$HOME/.mnt/filebox/Downloads" +fb_dir_mnt_ul="$HOME/.mnt/filebox/Uploads" + +# ----- +# Files +# ----- +# fbbox Config +fb_name_srv="default" +fb_file_conf_srv="$fb_dir_conf_user/filebox_srv." +fb_file_conf_loc="$fb_dir_conf_user/filebox_loc.conf" +# Listing Profile +fb_file_list="$fb_dir_conf_user/filelist" +# Profile file +fb_file_profile_list="$fb_dir_conf_user/profile" diff --git a/filebox_get.png b/filebox_get.png new file mode 100644 index 0000000..b068801 Binary files /dev/null and b/filebox_get.png differ diff --git a/usr/local/bin/filebox b/usr/local/bin/filebox new file mode 100755 index 0000000..9122989 --- /dev/null +++ b/usr/local/bin/filebox @@ -0,0 +1,152 @@ +#!/bin/bash +# version: 0.1 +# file: filebox +# Folder: /usr/local/bin +# By echolib +# License: GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 + +#====================================================================== +# Tool +#====================================================================== +# Check needed file and source if asked +if__file() { +if ! [[ -f "$1" ]];then + echo "! Missing file: $1" + case "$2" in + conf) + if__file "$fb_dir_scripts/add__filebox" source + filebox__add_server + ;; + *) + exit 1 + ;; + esac +fi + +case "$2" in + source) + source "$1" || exit 1 + ;; + read) + clear + cat "$1" + ;; +esac +} + +# Check Folder +if__folder() { +if ! [[ -d "$1" ]];then + case "$2" in + config) + echo "# Nothing here: $1" + exit 0 + ;; + *) + echo -e "$I_Yellow Missing folder: '$1'. Creating it..." + mkdir -p "$1" || exit 1 + ;; + esac +fi + +case "$2" in + cd) + cd "$1" + ;; +esac +} + +# Check Command +if__command() { +! [[ `command -v $1` ]] \ + && echo -e "$I_Red Missing $1 commnd" \ + && exit 1 +} + +#====================================================================== +# Main +#====================================================================== +# Main for script: Check/Source files & Create folders +if__file "/etc/filebox/filebox.conf" source +if__file "$fb_dir_scripts/tools" source +if__folder "$fb_dir_conf_user" + +# Check local folders +if__file "$fb_file_conf_loc" conf +if__file "$fb_file_conf_loc" source +# Save current folder +pwd_folder=${PWD} + +case "$1" in + config|-C) + case "$2" in + "") fb_conf_edit_srv=true ;; + -l) unset fb_conf_edit_srv;fb_conf_edit_loc=true ;; + *) + fb_conf_edit_srv=true + fb_name_srv="$2" + ;; + esac + if__file "$fb_dir_scripts/add__filebox" source + filebox__add_server + ;; + + send|-s) + while test "$2" + do + case "$2" in + -k) fb_send_keep=true ;; + "") true ;; + *) fb_name_srv="$2" ;; + esac + shift + done + if__file "$fb_file_conf_srv$fb_name_srv.conf" source + if__file "$fb_dir_scripts/mount__srv" source + if__file "$fb_dir_scripts/send__files" source + send__files + ;; + + unmount|-U) + if__file "$fb_dir_scripts/mount__srv" source + case "$2" in + ul) + case "$3" in + "") true ;; + *) fb_name_srv="$3" ;; + esac + if__folder "$fb_dir_mnt_ul/$fb_name_srv" config + if__file "$fb_file_conf_srv$fb_name_srv.conf" source + mount__srv ul -U + ;; + dl) + case "$3" in + "") true ;; + *) fb_name_srv="$3" ;; + esac + if__folder "$fb_dir_mnt_dl/$fb_name_srv" config + if__file "$fb_file_conf_srv$fb_name_srv.conf" source + mount__srv dl -U + ;; + *) + mount__srv ul -U + mount__srv dl -U + ;; + esac + ;; + + get|-g) + case "$2" in + "") true ;; + *) fb_name_srv="$2" ;; + esac + if__file "$fb_file_conf_srv$fb_name_srv.conf" source + if__file "$fb_dir_scripts/mount__srv" source + if__file "$fb_dir_scripts/get__files" source + get__files + ;; + + --help|-h|help|*) + if__file "$fb_dir_scripts/help" read + ;; +esac diff --git a/var/lib/filebox/LICENSE b/var/lib/filebox/LICENSE new file mode 100644 index 0000000..2a1caa8 --- /dev/null +++ b/var/lib/filebox/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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. + + GSL Statique Littérateur + Copyright (C) 2022 Libre en Communs / Commissions / Infrastructure + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/var/lib/filebox/README.md b/var/lib/filebox/README.md new file mode 100644 index 0000000..74bcdac --- /dev/null +++ b/var/lib/filebox/README.md @@ -0,0 +1,157 @@ +# What is filebox + +filebox is an app script made to upload and download files from servers. + +I made this tool a long time ago to download files from my seedbox, but +i decided to rewrite it. filebox works on "any" server, and is not +intended to be used only with a seedbox. You can also use it to upload +and download any files to/from your servers... you could then, share your +server "upload" folder with your friends. + +# dependencies +- bash +- rsync +- sshfs + +# How to install ? +Create folders from list below and to avoid sudo for non root user, +use chown. Then, chmod 755 filebox so that it can be started + +``` +# Create and own folders +sudo mkdir -p /etc/filebox && chown -R $USER:$USER /etc/filebox +sudo mkdir -p /var/lib/filebox && chown -R $USER:$USER /var/lib/filebox + +# Copy executable filebox file: +sudp cp filebox /usr/local/bin/filebox +sudo chown $USER:$USER /usr/local/bin/filebox +sudo chmod 755 /usr/local/bin/filebox +``` + +# Files and Folders configuration +- /etc/filebox/ (file: filebox.conf (filebox configuration)) +- /var/lib/filebox/ (scripts, readme...) +- /usr/local/bin/ (file: filebox (executable)) + +# How to use it ? +Once installed, start configuring your server using: + +``` +filebox -C +``` + +You will be asked to add at first time only LOCAL Folders, one per +category file: +- Music +- Video (Private) +- Video (Public) +- Ebook +- Generic / Document + +And filebox will also ask you to add a default server and give its: +- user access +- IP +- Download server Folder +- Upload server folder +- Upload LOCAL Folder + +You can also add more servers, using your desired (server name), so that +you can + +``` +# if no (server name), filebox use (default) first configured server +filebox -C (server name) +``` + +The server password is not asked by filebox; you will have to write it +each time filebox needs to mount your server folders. + +# Private configurations files and folders (created by filebox) +- $HOME/.mnt/filebox/Downloads/(server name) < mount point +- $HOME/.mnt/filebox/Uploads/(server name) < mount point +- $HOME/.config/filebox < (config private files) + + +## Downloading files +To start downloading files from your server, type: + +``` +filebox -g +``` + +A file list will appear with item numbers. You can download one or several +files and folder by answering the question next to the list. If you want +to download item 1 to your local music folder and item 2 to your public +video folder, just answer: 1m 2p + +filebox will check for free space before downloading. A reserved 10Go +free space on your local HOME (configurable in /etc/filebox/filebox.conf) +is set. + +## Uploading files +To upload ALL files from your (Upload LOCAL Folder)/(server name), to +your specific server folder, type: + +``` +filebox -S +``` + +In that (Upload LOCAL Folder)/(server name) you could put all your +torrent files, but whatever you want, so they can be uploaded to your +server. + +filebox will check for free space on server before uploading. A reserved +5Go free space on your server (configurable in /etc/filebox/filebox.conf) +is set. + +Do not forget to unmount your mounted points using: + +``` +filebox -U [OPT] (server name) +``` + +# Help + +``` +$ filebox [ARGS] +: Upload/Download files to/from servers + It can be easily used with a seedbox + Reserved free space on local disk Default: 10G + Reserved free space on server disk Default: 5G +: No [NAME], use (default) + + [ARGS]: + help + : This Help + + config | -C [OPT] [NAME] + : Configure access to a server [NAME] + [OPT] + -l : edit file for local folders + -s : edit file for server configuration + + send | -s [OPT ][NAME] + : Move Files from (Upload LOCAL Folder)/[name] to Upload server folder + [OPT] + -k : Copy, not move + + unmount | -U [OPT] [NAME] + : Unmount directories + [OPT] + dl : Download directory only + ul : Upload Directory Only + + get | -g [NAME] + : List and choose files to download from server + +# Items Selector +: L > Load again the list + +# How to download items in specific folder according to categorie file +- Add a letter to number selected (i.e. 1e m3) +: d > Generic (also if no letter set) +: m > Music +: e > ebook +: v > Restricted Video +: p > Public Video +``` diff --git a/var/lib/filebox/filebox_get.png b/var/lib/filebox/filebox_get.png new file mode 100644 index 0000000..b068801 Binary files /dev/null and b/var/lib/filebox/filebox_get.png differ diff --git a/var/lib/filebox/scripts/add__filebox b/var/lib/filebox/scripts/add__filebox new file mode 100644 index 0000000..48c6cec --- /dev/null +++ b/var/lib/filebox/scripts/add__filebox @@ -0,0 +1,215 @@ +#!/bin/bash +# file: add__filebox +# Folder: /var/lib/filebox/scripts +# By echolib +# License: GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 + +#====================================================================== +# Add server configuration +#====================================================================== +filebox__add_server() { +if ! [[ -f "$fb_file_conf_loc" ]];then + filebox__add_local_folders +else + [[ $fb_conf_edit_loc ]] \ + && $EDITOR "$fb_file_conf_loc" \ + && return +fi + +[[ $fb_conf_edit_srv ]] && \ +[[ -f "$fb_file_conf_srv$fb_name_srv.conf" ]] \ + && $EDITOR "$fb_file_conf_srv$fb_name_srv.conf" \ + && return + +# Server configuration +clear +[[ "$fb_name_srv" == "default" ]] \ + && fb_command_name="" \ + || fb_command_name="$fb_name_srv" +cat << EOSHOW +# Please, register some datas for your filebox server +# Answer C or ctrl+c to Cancel +# You'll be asked to confirm after resume + +# Server Name: $fb_name_srv +# Upload LOCAL Folder. filebox will: + - create [Upload LOCAL Folder]/$fb_name_srv +# With command filebox send $fb_command_name + - send files from [Upload LOCAL Folder]/$fb_name_srv to [Upload Server Folder] + +EOSHOW + +read -erp "- Upload LOCAL Folder: " fb_dir_files +[[ ${fb_dir_files: -1} == "/" ]] && fb_dir_files=${fb_dir_files%?} +filebox__local_folder "$fb_dir_files/$fb_name_srv" + +read -rp "- Server user (root): " fb_srv_user +case "$fb_srv_user" in + "") + fb_srv_user=root + ;; + C|c) + exit 1 + ;; +esac + +read -rp "- Server IP: " fb_srv_ip +case "$fb_srv_ip" in + C|c|"") + exit 1 + ;; +esac + +read -rp "- Upload Server Folder: " fb_srv_mnt_ul +[[ ${fb_srv_mnt_ul: -1} == "/" ]] && fb_srv_mnt_ul=${fb_srv_mnt_ul%?} +case "$fb_srv_mnt_ul" in + C|c|"") + exit 1 + ;; +esac + +read -rp "- Items Server Folder: " fb_srv_mnt_dl +[[ ${fb_srv_mnt_dl: -1} == "/" ]] && fb_srv_mnt_dl=${fb_srv_mnt_dl%?} +case "$fb_srv_mnt_dl" in + C|c|"") + exit 1 + ;; +esac + +# Resume +clear +cat << EORESUME +# Server Name : $fb_name_srv +# User : $fb_srv_user +# Server IP : $fb_srv_ip +# Uploaded Folder : $fb_srv_mnt_ul +# Downloaded Files: $fb_srv_mnt_dl +# Local Folder +# Files to upload : $fb_dir_files/$fb_name_srv + +EORESUME +filebox__add_confirm srv +} + + +#====================================================================== +# Check local folder and create it, if not exists +#====================================================================== +filebox__local_folder() { +case "$1" in + C|c|""|"/$fb_name_srv") + exit 1 + ;; + *) + if ! [[ -d "$1" ]];then + read -rp "! Create folder '$1' (y|N) ? " user_confirm_folder + case "$user_confirm_folder" in + Y|y) + mkdir -p "$1" || exit 1 + ;; + *) + exit 1 + ;; + esac + fi + ;; +esac +} + +#====================================================================== +# Create local folder configuration +#====================================================================== +filebox__add_local_folders() { +# Local Folders for categories files +cat << EOSHOW +# Please, register some LOCAL folders. One per category file (Music, Document...) +# You can use autocompletion +# If folder does not exist, you'll be asked to create it +# Answer C or ctrl+c to Cancel +# You'll be asked to confirm after resume + +# File: $fb_file_conf_loc +EOSHOW + +read -erp "- Music Folder: " fb_dir_music +[[ ${fb_dir_music: -1} == "/" ]] && fb_dir_music=${fb_dir_music%?} +filebox__local_folder "$fb_dir_music" + +read -erp "- Restricted Video Folder: " fb_dir_vid_v +[[ ${fb_dir_vid_v: -1} == "/" ]] && fb_dir_vid_v=${fb_dir_vid_v%?} +filebox__local_folder "$fb_dir_vid_v" + +read -erp "- Public Video Folder: " fb_dir_vid_p +[[ ${fb_dir_vid_p: -1} == "/" ]] && fb_dir_vid_p=${fb_dir_vid_p%?} +filebox__local_folder "$fb_dir_vid_p" + +read -erp "- Ebook Folder: " fb_dir_ebook +[[ ${fb_dir_ebook: -1} == "/" ]] && fb_dir_ebook=${fb_dir_ebook%?} +filebox__local_folder "$fb_dir_ebook" + +read -erp "- Generic Folder: " fb_dir_other +[[ ${fb_dir_other: -1} == "/" ]] && fb_dir_other=${fb_dir_other%?} +filebox__local_folder "$fb_dir_other" + +clear +cat << EORESUME +# Local Folders +# Music : $fb_dir_music +# Restricted Video: $fb_dir_vid_v +# Public Video : $fb_dir_vid_p +# Ebook : $fb_dir_ebook +# Generic download: $fb_dir_other + +EORESUME +filebox__add_confirm loc +} + +#====================================================================== +# Confirm Process +#====================================================================== +filebox__add_confirm() { +# Confirm +case "$1" in + loc) fb_create_file="$fb_file_conf_loc" ;; + srv) fb_create_file="$fb_file_conf_srv$fb_name_srv.conf" ;; +esac + +echo "# File: $fb_create_file" +read -rp "! Confirm writing config (y|N) ? " user_confirm_config +case "$user_confirm_config" in + Y|y) + touch "$fb_create_file" + case "$1" in + loc) + printf '%s\n%s\n%s\n%s\n%s\n%s\n%s\n' \ + "# file: $fb_create_file" \ + "# Local Categories folders" \ + "fb_dir_music=$fb_dir_music" \ + "fb_dir_vid_v=$fb_dir_vid_v" \ + "fb_dir_vid_p=$fb_dir_vid_p" \ + "fb_dir_ebook=$fb_dir_ebook" \ + "fb_dir_other=$fb_dir_other" \ + > "$fb_create_file" && \ + echo -e "\n$I_Green Configuration saved to $fb_create_file" + ;; + srv) + printf '%s\n%s\n%s\n%s\n%s\n%s\n%s\n%s\n' \ + "# file: $fb_create_file" \ + "# Server" \ + "fb_srv_user=$fb_srv_user" \ + "fb_srv_ip=$fb_srv_ip" \ + "fb_srv_mnt_ul=$fb_srv_mnt_ul" \ + "fb_srv_mnt_dl=$fb_srv_mnt_dl" \ + "# Local Upload folder" \ + "fb_dir_files=$fb_dir_files/$fb_name_srv" \ + > "$fb_create_file" && \ + echo -e "\n$I_Green Configuration saved to $fb_create_file" + ;; + esac + ;; + + *) + echo -e "$I_Yellow Configuration not saved" + ;; +esac +} diff --git a/var/lib/filebox/scripts/get__files b/var/lib/filebox/scripts/get__files new file mode 100644 index 0000000..6666413 --- /dev/null +++ b/var/lib/filebox/scripts/get__files @@ -0,0 +1,153 @@ +#!/bin/bash +# file: get__files +# Folder: /var/lib/filebox/scripts +# By echolib +# License: GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 + +#====================================================================== +# Mount Point and create lsit ; check for sum to avoid size calc +#====================================================================== +get__files() { +mount__srv dl +clear +if__folder "$fb_dir_mnt" cd + +# Server Stats +df -h \ + | grep "$fb_srv_mnt_dl" \ + | awk '{print \ + "# Space Total: "$2 \ + " | Used: "$3" ("$5")" \ + " | Free: "$4}' + +fb_dirs_nbr=`find . -maxdepth 1 -type d | wc -l` +fb_files_nbr=`find . -maxdepth 1 -type f | wc -l` +printf '%b%b%b\n' \ + "# $C_Yellow$fb_dirs_nbr folders$NC $Pp_Grey " \ + "$C_Cyan$fb_files_nbr files$NC " \ + "in '$fb_srv_mnt_dl'" + +# Create profile +touch "$fb_file_profile_list" +fb_profile_list=`ls -l | cksum | awk '{print $1}'` +if [[ `awk 'NR==1' "$fb_file_profile_list"` == "$fb_profile_list" ]];then + user__select +else + echo "$fb_profile_list" > "$fb_file_profile_list" + create__list + user__select +fi +} + +#====================================================================== +# Show items list and ask +#====================================================================== +user__select() { +echo -e "$C_Grey# Profile List:$NC $fb_profile_list\n" + +cat -n "$fb_file_list" | column -t -s'|' +fb_max_items=`cat "$fb_file_list" | wc -l` + +echo +read -rp "- Select files to download: " user_selections +case "$user_selections" in + "") return ;; + l|L) get__files ;; + *) get__selections ;; +esac +} + +#====================================================================== +# Get user selections +#====================================================================== +get__selections() { +user_select=(${user_selections[@]}) +user_select_n=${#user_select[@]} + +for item in `seq 0 $(( user_select_n - 1 ))` +do + + # Get filename from number + fb_line=`grep -oE "[[:digit:]]{1,}" <<<"${user_select[item]}"` + ! [[ $fb_line ]] || \ + (( $fb_line <= 0 )) || \ + (( $fb_line > $fb_max_items )) \ + && continue + fb_filename=` + cat -n "$fb_file_list" \ + | awk -F"|" -v l="$fb_line" 'NR==l {print $4}'` + + # Get dir from letter + fb_sdir=`grep -oE "[[:alpha:]]{1,}" <<<"${user_select[item]}"` + case "$fb_sdir" in + r|R) fb_local_dir="$fb_dir_vid_v" ;; + p|P) fb_local_dir="$fb_dir_vid_p" ;; + e|E) fb_local_dir="$fb_dir_ebook" ;; + m|M) fb_local_dir="$fb_dir_music" ;; + =) fb_local_dir="$fb_dir_other" ;; + esac + + download__file + +done +} + +#====================================================================== +# Check space and download selection +#====================================================================== +download__file() { +if__command rsync +if__command numfmt + +# Check free space +fb_file_bsize=`du -s -B1 "$fb_filename" | awk '{print $1}'` +fb_free_bsize=`df -B1 "$fb_local_dir" | awk 'NR==2 {print $4}'` +fb_file_keep_bsize=$(( fb_keep_bsize + fb_file_bsize )) + +fb_free_hdisk=`df -h "$fb_local_dir" | awk 'NR==2 {print $4}'` +fb_file_hsize=`echo $fb_file_bsize | numfmt --to=iec` + +if (( $fb_file_keep_bsize >= $fb_free_bsize ));then + printf '%b%b' \ + "$I_Red Not enough space on disk: " \ + "$fb_file_hsize > ($fb_free_hdisk - $fb_keep_hsize)" + return +fi + +# Download +printf '%b%b\n' \ + "- $fb_file_hsize < ($fb_free_hdisk - $fb_keep_hsize): " \ + "$fb_local_dir > $fb_filename" + +rsync -a --update --info=progress2 \ + "$fb_filename" "$fb_local_dir" +chmod -R go+rx "$fb_local_dir" +} + +#====================================================================== +# Create list items with usefull datas +#====================================================================== +create__list() { +[[ -f "$fb_file_list" ]] \ + && rm -f "$fb_file_list" + +touch "$fb_file_list" +echo -ne ": Checking files..." +while read -r "fb_rights" "b" "c" "d" "d" \ + "fb_date" \ + "fb_time" \ + "fb_file" +do + [[ "$fb_rights" =~ "d" ]] \ + && fb_color="$C_Yellow" \ + || fb_color="$C_Cyan" + + echo -ne "\r\033[2K: Checking files... $fb_file" + fb_file_hsize=`du -sh "$fb_file" | awk '{print $1}'` + + echo -e "$C_Grey$fb_date|$fb_time$NC|$fb_color$fb_file_hsize$NC|$fb_file" \ + >> "$fb_file_list" +done < <(command ls -lt --time-style=long-iso | awk 'NR > 1') + +echo -ne "\r\033[2K" +} diff --git a/var/lib/filebox/scripts/help b/var/lib/filebox/scripts/help new file mode 100644 index 0000000..d73d2e9 --- /dev/null +++ b/var/lib/filebox/scripts/help @@ -0,0 +1,41 @@ +$ filebox [ARGS] +: Upload/Download files to/from servers + It can be easily used with a seedbox + Reserved free space on local disk Default: 10G + Reserved free space on server disk Default: 5G +: No [NAME], use (default) + + [ARGS]: + help + : This Help + + config | -C [OPT] [NAME] + : Configure access to a server [NAME] + [OPT] + -l : edit file for local folders + -s : edit file for server configuration + + send | -s [OPT ][NAME] + : Move Files from (Upload LOCAL Folder)/[name] to Upload server folder + [OPT] + -k : Copy, not move + + unmount | -U [OPT] [NAME] + : Unmount directories + [OPT] + dl : Download directory only + ul : Upload Directory Only + + get | -g [NAME] + : List and choose files to download from server + +# Items Selector +: L > Load again the list + +# How to download items in specific folder according to categorie file +- Add a letter to number selected (i.e. 1e m3) +: d > Generic (also if no letter set) +: m > Music +: e > ebook +: v > Restricted Video +: p > Public Video diff --git a/var/lib/filebox/scripts/mount__srv b/var/lib/filebox/scripts/mount__srv new file mode 100644 index 0000000..7afab51 --- /dev/null +++ b/var/lib/filebox/scripts/mount__srv @@ -0,0 +1,49 @@ +#!/bin/bash +# file: mount__srv +# Folder: /var/lib/filebox/scripts +# By echolib +# License: GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 + +#====================================================================== +# Mount or Unmount points from OPT +#====================================================================== +mount__srv() { +case "$1" in + ul) + if__folder "$fb_dir_mnt_ul/$fb_name_srv" + fb_dir_mnt="$fb_dir_mnt_ul/$fb_name_srv" + fb_dir_srv="$fb_srv_mnt_ul" + ;; + dl) + if__folder "$fb_dir_mnt_dl/$fb_name_srv" + fb_dir_mnt="$fb_dir_mnt_dl/$fb_name_srv" + fb_dir_srv="$fb_srv_mnt_dl" + ;; +esac + +case "$2" in + -U) + echo -ne "$I_Yellow Unmounting: $fb_dir_mnt" + if [[ `df -h | grep "$fb_dir_mnt"` ]];then + fusermount -u "$fb_dir_mnt" && fusermount_rt="$?" + (( $fusermount_rt == 0 )) \ + && echo -ne " ${C_Green}Ok\n" \ + || echo -ne " ${C_Red}Error: $fusermount_rt\n" + else + echo -ne " ${C_Yellow}Not Mounted\n" + fi + return + ;; +esac + +# Check if folder srv is mounted +if ! [[ `command ls -A "$fb_dir_mnt"` ]];then + if__command "sshfs" + printf '%b\n%s\n%s\n' \ + "$I_Yellow Mounting Server: $fb_srv_user@$fb_srv_ip" \ + ": $fb_dir_srv/" \ + "> $fb_dir_mnt/" + sshfs "$fb_srv_user"@"$fb_srv_ip":"$fb_dir_srv/" "$fb_dir_mnt/" +fi +} + diff --git a/var/lib/filebox/scripts/send__files b/var/lib/filebox/scripts/send__files new file mode 100644 index 0000000..d3639c4 --- /dev/null +++ b/var/lib/filebox/scripts/send__files @@ -0,0 +1,39 @@ +#!/bin/bash +# file: send__files +# Folder: /var/lib/filebox/scripts +# By echolib +# License: GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 + +#====================================================================== +# Mpunt Point if needed, and Send files +#====================================================================== +send__files() { +if__folder "$fb_dir_files" cd +if__command rsync + +if [[ `command ls -A "$fb_dir_files"` ]];then + mount__srv ul + fb_server_bsize=` + df -B1 | grep "$fb_srv_mnt_ul" | awk 'NR==2 {print $4}'` + fb_server_rbsize=$(( fb_server_bsize + fb_keep_sbsize )) + clear + while read -r "item" + do + echo -n "- $item " + fb_item_size=`du -B1 "$item" | awk '{print $1}'` + (( $fb_item_size >= $fb_server_rbsize )) \ + && echo -ne "${C_Red}Error: Not enought space$NC" \ + && continue + + rsync -a "$item" "$fb_dir_mnt" && rsync_rt="$?" + if (( $rsync_rt == 0 ));then + echo -ne "${C_Green}Ok$NC\n" + ! [[ $fb_send_keep ]] && rm -f "$item" + else + echo -ne "${C_Red}Error: $rsync_rt$NC\n" + fi + done < <(ls -1) +else + echo -e "$I_YELLOW Nothing to upload in $fb_dir_files..." +fi +} diff --git a/var/lib/filebox/scripts/tools b/var/lib/filebox/scripts/tools new file mode 100644 index 0000000..c73f500 --- /dev/null +++ b/var/lib/filebox/scripts/tools @@ -0,0 +1,41 @@ +#!/bin/bash +# file: tools +# Folder: /var/lib/seedbox/scripts +# By echolib +# License: GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 + +# Tools for seedbox script + +#====================================================================== +# Set Colors +#====================================================================== +NC="\e[0m" +C_Blue="\e[34m" +C_Cyan="\e[36m" +C_Green="\e[32m" +C_Grey="\e[2m" +C_Pink="\e[35m" +C_Red="\e[31m" +C_White="\e[1m" +C_Yellow="\e[33m" + +#====================================================================== +# Set Separators / Markers Colors +#====================================================================== +I_Blue="\e[34m#\e[0m" +I_Cyan="\e[36m#\e[0m" +I_Green="\e[32m#\e[0m" +I_Grey="\e[2m#\e[0m" +I_Pink="\e[35m#\e[0m" +I_Red="\e[31m!\e[0m" +I_White="\e[1m#\e[0m" +I_Yellow="\e[33m#\e[0m" + +#====================================================================== +# Set Other markers colors +#====================================================================== +P_Grey="\e[2m%\e[0m" +Bo_Grey="\e[2m(\e[0m" +Bc_Grey="\e[2m)\e[0m" +Pp_Grey="\e[2m|\e[0m" +Dp_Grey="\e[2m:\e[0m"