diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index dee03ea..6c9ca46 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ Transmission for YunoHost ------------------------- +[Yunohost project](https://yunohost.org/#/) + +Un client BitTorrent libre et rapide + http://www.transmissionbt.com/ + +**Voir l'état du package:** +*[Dernier rapport hebdomadaire](https://forum.yunohost.org/t/rapport-hebdomadaire-dintegration-continue/2297)* +*[Dernier test d'intégration continue](https://ci-apps.yunohost.org/jenkins/job/transmission%20%28Official%29/lastBuild/consoleFull)* diff --git a/check_process b/check_process index b86cb88..c71b420 100644 --- a/check_process +++ b/check_process @@ -13,21 +13,22 @@ upgrade=1 backup_restore=1 multi_instance=0 - wrong_user=1 - wrong_path=1 incorrect_path=1 - corrupt_source=0 - fail_download_source=0 - port_already_use=0 - final_path_already_use=0 + port_already_use=1 (9091) + change_url=0 ;;; Levels Level 1=auto Level 2=auto Level 3=auto Level 4=na +# Level 4: Level 5=auto +# Level 5: Level 6=auto Level 7=auto Level 8=0 Level 9=0 Level 10=0 +;;; Options +Email= +Notification=down diff --git a/conf/nginx.conf b/conf/nginx.conf index d7e7aea..ef2b411 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,14 +1,16 @@ -location PATHTOCHANGE/transmission { - proxy_pass http://127.0.0.1:9091PATHTOCHANGE/transmission; +location __PATH__transmission { + proxy_pass http://127.0.0.1:__PORT____PATH__transmission; # Include SSOWAT user panel. include conf.d/yunohost_panel.conf.inc; more_clear_input_headers 'Accept-Encoding'; } -location PATHTOCHANGE/ { - proxy_pass http://127.0.0.1:9091/; + +location __PATH__ { + proxy_pass http://127.0.0.1:__PORT__/; } -location PATHTOCHANGE/downloads { + +location __PATH__downloads { alias /home/yunohost.transmission/completed/; autoindex on; autoindex_exact_size off; diff --git a/conf/settings.json b/conf/settings.json index 36808fc..f921a01 100644 --- a/conf/settings.json +++ b/conf/settings.json @@ -1,72 +1,73 @@ { - "alt-speed-down": 50, - "alt-speed-enabled": false, - "alt-speed-time-begin": 540, - "alt-speed-time-day": 127, - "alt-speed-time-enabled": false, - "alt-speed-time-end": 1020, - "alt-speed-up": 50, - "bind-address-ipv4": "0.0.0.0", - "bind-address-ipv6": "::", - "blocklist-enabled": false, - "blocklist-url": "http://www.example.com/blocklist", - "cache-size-mb": 4, - "dht-enabled": true, - "download-dir": "/home/yunohost.transmission/completed", - "download-limit": 100, - "download-limit-enabled": 0, - "download-queue-enabled": true, - "download-queue-size": 5, - "encryption": 1, - "idle-seeding-limit": 30, - "idle-seeding-limit-enabled": false, - "incomplete-dir": "/home/yunohost.transmission/progress", + "alt-speed-down": 50, + "alt-speed-enabled": false, + "alt-speed-time-begin": 540, + "alt-speed-time-day": 127, + "alt-speed-time-enabled": false, + "alt-speed-time-end": 1020, + "alt-speed-up": 50, + "bind-address-ipv4": "0.0.0.0", + "bind-address-ipv6": "::", + "blocklist-enabled": false, + "blocklist-url": "http://www.example.com/blocklist", + "cache-size-mb": 4, + "dht-enabled": true, + "download-dir": "/home/yunohost.transmission/completed", + "download-limit": 100, + "download-limit-enabled": 0, + "download-queue-enabled": true, + "download-queue-size": 5, + "encryption": 1, + "idle-seeding-limit": 30, + "idle-seeding-limit-enabled": false, + "incomplete-dir": "/home/yunohost.transmission/progress", "incomplete-dir-enabled": true, "lpd-enabled": false, - "max-peers-global": 200, - "message-level": 2, - "peer-congestion-algorithm": "", - "peer-limit-global": 240, - "peer-limit-per-torrent": 60, - "peer-port": 51413, - "peer-port-random-high": 65535, + "max-peers-global": 200, + "message-level": 1, + "peer-congestion-algorithm": "", + "peer-id-ttl-hours": 6, + "peer-limit-global": 200, + "peer-limit-per-torrent": 50, + "peer-port": __PEER_PORT__, + "peer-port-random-high": 65535, "peer-port-random-low": 49152, - "peer-port-random-on-start": false, + "peer-port-random-on-start": false, "peer-socket-tos": "default", "pex-enabled": true, - "port-forwarding-enabled": false, + "port-forwarding-enabled": false, "preallocation": 1, - "prefetch-enabled": 1, - "queue-stalled-enabled": true, + "prefetch-enabled": 1, + "queue-stalled-enabled": true, "queue-stalled-minutes": 30, "ratio-limit": 2, - "ratio-limit-enabled": false, - "rename-partial-files": true, - "rpc-authentication-required": false, + "ratio-limit-enabled": false, + "rename-partial-files": true, + "rpc-authentication-required": false, "rpc-bind-address": "127.0.0.1", - "rpc-enabled": true, - "rpc-password": "RPCPASSWORDTOCHANGE", - "rpc-port": 9091, - "rpc-url": "PATHTOCHANGE/transmission/", - "rpc-username": "transmission", - "rpc-whitelist": "127.0.0.1", - "rpc-whitelist-enabled": false, - "scrape-paused-torrents-enabled": true, - "script-torrent-done-enabled": false, - "script-torrent-done-filename": "", - "seed-queue-enabled": false, - "seed-queue-size": 10, - "speed-limit-down": 100, - "speed-limit-down-enabled": false, - "speed-limit-up": 100, - "speed-limit-up-enabled": false, - "start-added-torrents": true, - "trash-original-torrent-files": false, - "umask": 18, - "upload-limit": 100, - "upload-limit-enabled": 0, - "upload-slots-per-torrent": 14, - "utp-enabled": true, - "watch-dir": "/home/yunohost.transmission/watched", + "rpc-enabled": true, + "rpc-password": "__RPC_PASSWORD_TO_CHANGE__", + "rpc-port": __PORT__, + "rpc-url": "__PATH__transmission/", + "rpc-username": "transmission", + "rpc-whitelist": "127.0.0.1", + "rpc-whitelist-enabled": false, + "scrape-paused-torrents-enabled": true, + "script-torrent-done-enabled": false, + "script-torrent-done-filename": "", + "seed-queue-enabled": false, + "seed-queue-size": 10, + "speed-limit-down": 100, + "speed-limit-down-enabled": false, + "speed-limit-up": 100, + "speed-limit-up-enabled": false, + "start-added-torrents": true, + "trash-original-torrent-files": false, + "umask": 18, + "upload-limit": 100, + "upload-limit-enabled": 0, + "upload-slots-per-torrent": 14, + "utp-enabled": true, + "watch-dir": "/home/yunohost.transmission/watched", "watch-dir-enabled": true } diff --git a/manifest.json b/manifest.json index 2474f37..9ad34b1 100644 --- a/manifest.json +++ b/manifest.json @@ -1,43 +1,43 @@ { - "name": "Transmission", - "id": "transmission", - "packaging_format": 1, - "requirements": { - "yunohost": ">= 2.4.0" - }, - "description": { - "en": "A Fast, Easy, and Free BitTorrent Client", - "fr": "Un client BitTorrent libre et rapide" - }, - "url": "https://www.transmissionbt.com/", - "maintainer": { - "name": "kload", - "email": "kload@kload.fr" - }, - "multi_instance": "false", - "services": [ - "nginx", - "transmission-daemon" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain", - "ask": { - "en": "Choose a domain for Transmission" - }, - "example": "domain.org" - }, - { - "name": "path", - "type": "path", - "ask": { - "en": "Choose a path for Transmission" - }, - "example": "/torrent", - "default": "/torrent" - } - ] - } + "name": "Transmission", + "id": "transmission", + "packaging_format": 1, + "requirements": { + "yunohost": ">= 2.4.0" + }, + "description": { + "en": "A Fast, Easy, and Free BitTorrent Client", + "fr": "Un client BitTorrent libre et rapide" + }, + "url": "https://www.transmissionbt.com/", + "license": " GPL-3.0", + "maintainer": { + "name": "Groupe Apps", + "email": "apps_group@yunohost.org" + }, + "multi_instance": false, + "services": [ + "nginx" + ], + "arguments": { + "install": [ + { + "name": "domain", + "type": "domain", + "ask": { + "en": "Choose a domain for Transmission" + }, + "example": "domain.org" + }, + { + "name": "path", + "type": "path", + "ask": { + "en": "Choose a path for Transmission" + }, + "example": "/torrent", + "default": "/torrent" + } + ] + } } diff --git a/scripts/_common.sh b/scripts/_common.sh new file mode 100755 index 0000000..381ee0a --- /dev/null +++ b/scripts/_common.sh @@ -0,0 +1,345 @@ +#!/bin/bash + +#================================================= +#================================================= +# TESTING +#================================================= +#================================================= + +ynh_nginx_config () { + finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf" + ynh_backup_if_checksum_is_different "$finalnginxconf" 1 + sudo cp ../conf/nginx.conf "$finalnginxconf" + + # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. + # Substitute in a nginx config file only if the variable is not empty + if test -n "${path_url:-}"; then + ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf" + fi + if test -n "${domain:-}"; then + ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf" + fi + if test -n "${port:-}"; then + ynh_replace_string "__PORT__" "$port" "$finalnginxconf" + fi + if test -n "${app:-}"; then + ynh_replace_string "__NAME__" "$app" "$finalnginxconf" + fi + if test -n "${final_path:-}"; then + ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf" + fi + ynh_store_file_checksum "$finalnginxconf" + + sudo systemctl reload nginx +} + +ynh_remove_nginx_config () { + ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf" + sudo systemctl reload nginx +} + +#================================================= +#================================================= + +#================================================= +# CHECKING +#================================================= + +CHECK_DOMAINPATH () { # Vérifie la disponibilité du path et du domaine. + if sudo yunohost app --help | grep --quiet url-available + then + # Check availability of a web path + ynh_webpath_available $domain $path_url + # Register/book a web path for an app + ynh_webpath_register $app $domain $path_url + else + # Use the legacy command + sudo yunohost app checkurl $domain$path_url -a $app + fi +} + +#================================================= +# DISPLAYING +#================================================= + +# NO_PRINT () { # Supprime l'affichage dans stdout pour la commande en argument. +# set +x +# $@ +# set -x +# } + +WARNING () { # Écrit sur le canal d'erreur pour passer en warning. + $@ >&2 +} + +# SUPPRESS_WARNING () { # Force l'écriture sur la sortie standard +# $@ 2>&1 +# } + +# QUIET () { # Redirige la sortie standard dans /dev/null +# $@ > /dev/null +# } + +ALL_QUIET () { # Redirige la sortie standard et d'erreur dans /dev/null + $@ > /dev/null 2>&1 +} + +#================================================= +# BACKUP +#================================================= + +BACKUP_FAIL_UPGRADE () { + WARNING echo "Upgrade failed." + app_bck=${app//_/-} # Replace all '_' by '-' + if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$backup_number; then # Vérifie l'existence de l'archive avant de supprimer l'application et de restaurer + sudo yunohost app remove $app # Supprime l'application avant de la restaurer. + sudo yunohost backup restore --ignore-hooks $app_bck-pre-upgrade$backup_number --apps $app --force # Restore the backup if upgrade failed + ynh_die "The app was restored to the way it was before the failed upgrade." + fi +} + +BACKUP_BEFORE_UPGRADE () { # Backup the current version of the app, restore it if the upgrade fails + backup_number=1 + old_backup_number=2 + app_bck=${app//_/-} # Replace all '_' by '-' + if sudo yunohost backup list | grep -q $app_bck-pre-upgrade1; then # Vérifie l'existence d'une archive déjà numéroté à 1. + backup_number=2 # Et passe le numéro de l'archive à 2 + old_backup_number=1 + fi + + sudo yunohost backup create --ignore-hooks --apps $app --name $app_bck-pre-upgrade$backup_number # Créer un backup différent de celui existant. + if [ "$?" -eq 0 ]; then # Si le backup est un succès, supprime l'archive précédente. + if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$old_backup_number; then # Vérifie l'existence de l'ancienne archive avant de la supprimer, pour éviter une erreur. + QUIET sudo yunohost backup delete $app_bck-pre-upgrade$old_backup_number + fi + else # Si le backup a échoué + ynh_die "Backup failed, the upgrade process was aborted." + fi +} + +HUMAN_SIZE () { # Transforme une taille en Ko en une taille lisible pour un humain + human=$(numfmt --to=iec --from-unit=1K $1) + echo $human +} + +CHECK_SIZE () { # Vérifie avant chaque backup que l'espace est suffisant + file_to_analyse=$1 + backup_size=$(sudo du --summarize "$file_to_analyse" | cut -f1) + free_space=$(sudo df --output=avail "/home/yunohost.backup" | sed 1d) + + if [ $free_space -le $backup_size ] + then + WARNING echo "Espace insuffisant pour sauvegarder $file_to_analyse." + WARNING echo "Espace disponible: $(HUMAN_SIZE $free_space)" + ynh_die "Espace nécessaire: $(HUMAN_SIZE $backup_size)" + fi +} + +# Ce helper est temporaire et sert de remplacement à la véritable fonction ynh_restore_file. Le temps qu'elle arrive... +ynh_restore_file () { + if [ -f "$1" ]; then + ynh_die "There is already a file at this path: $1" + fi + sudo cp -a "${YNH_APP_BACKUP_DIR}$1" "$1" +} + +#================================================= +#================================================= +# FUTUR YNH HELPERS +#================================================= +# Importer ce fichier de fonction avant celui des helpers officiel +# Ainsi, les officiels prendront le pas sur ceux-ci le cas échéant +#================================================= + +# Normalize the url path syntax +# Handle the slash at the beginning of path and its absence at ending +# Return a normalized url path +# +# example: url_path=$(ynh_normalize_url_path $url_path) +# ynh_normalize_url_path example -> /example +# ynh_normalize_url_path /example -> /example +# ynh_normalize_url_path /example/ -> /example +# ynh_normalize_url_path / -> / +# +# usage: ynh_normalize_url_path path_to_normalize +# | arg: url_path_to_normalize - URL path to normalize before using it +ynh_normalize_url_path () { + path_url=$1 + test -n "$path_url" || ynh_die "ynh_normalize_url_path expect a URL path as first argument and received nothing." + if [ "${path_url:0:1}" != "/" ]; then # If the first character is not a / + path_url="/$path_url" # Add / at begin of path variable + fi + if [ "${path_url:${#path_url}-1}" == "/" ] && [ ${#path_url} -gt 1 ]; then # If the last character is a / and that not the only character. + path_url="${path_url:0:${#path_url}-1}" # Delete the last character + fi + echo $path_url +} + +# Manage a fail of the script +# +# Print a warning to inform that the script was failed +# Execute the ynh_clean_setup function if used in the app script +# +# usage of ynh_clean_setup function +# This function provide a way to clean some residual of installation that not managed by remove script. +# To use it, simply add in your script: +# ynh_clean_setup () { +# instructions... +# } +# This function is optionnal. +# +# Usage: ynh_exit_properly is used only by the helper ynh_abort_if_errors. +# You must not use it directly. +ynh_exit_properly () { + exit_code=$? + if [ "$exit_code" -eq 0 ]; then + exit 0 # Exit without error if the script ended correctly + fi + + trap '' EXIT # Ignore new exit signals + set +eu # Do not exit anymore if a command fail or if a variable is empty + + echo -e "!!\n $app's script has encountered an error. Its execution was cancelled.\n!!" >&2 + + if type -t ynh_clean_setup > /dev/null; then # Check if the function exist in the app script. + ynh_clean_setup # Call the function to do specific cleaning for the app. + fi + + ynh_die # Exit with error status +} + +# Exit if an error occurs during the execution of the script. +# +# Stop immediatly the execution if an error occured or if a empty variable is used. +# The execution of the script is derivate to ynh_exit_properly function before exit. +# +# Usage: ynh_abort_if_errors +ynh_abort_if_errors () { + set -eu # Exit if a command fail, and if a variable is used unset. + trap ynh_exit_properly EXIT # Capturing exit signals on shell script +} + +# Find a free port and return it +# +# example: port=$(ynh_find_port 8080) +# +# usage: ynh_find_port begin_port +# | arg: begin_port - port to start to search +ynh_find_port () { + port=$1 + test -n "$port" || ynh_die "The argument of ynh_find_port must be a valid port." + while netcat -z 127.0.0.1 $port # Check if the port is free + do + port=$((port+1)) # Else, pass to next port + done + echo $port +} + +# Substitute/replace a string by another in a file +# +# usage: ynh_replace_string match_string replace_string target_file +# | arg: match_string - String to be searched and replaced in the file +# | arg: replace_string - String that will replace matches +# | arg: target_file - File in which the string will be replaced. +ynh_replace_string () { + delimit=@ + match_string=${1//${delimit}/"\\${delimit}"} # Escape the delimiter if it's in the string. + replace_string=${2//${delimit}/"\\${delimit}"} + workfile=$3 + + sudo sed --in-place "s${delimit}${match_string}${delimit}${replace_string}${delimit}g" "$workfile" +} + +# Remove a file or a directory securely +# +# usage: ynh_secure_remove path_to_remove +# | arg: path_to_remove - File or directory to remove +ynh_secure_remove () { + path_to_remove=$1 + forbidden_path=" \ + /var/www \ + /home/yunohost.app" + + if [[ "$forbidden_path" =~ "$path_to_remove" \ + # Match all paths or subpaths in $forbidden_path + || "$path_to_remove" =~ ^/[[:alnum:]]+$ \ + # Match all first level paths from / (Like /var, /root, etc...) + || "${path_to_remove:${#path_to_remove}-1}" = "/" ]] + # Match if the path finishes by /. Because it seems there is an empty variable + then + echo "Avoid deleting $path_to_remove." >&2 + else + if [ -e "$path_to_remove" ] + then + sudo rm -R "$path_to_remove" + else + echo "$path_to_remove wasn't deleted because it doesn't exist." >&2 + fi + fi +} + +# Check availability of a web path +# +# example: ynh_webpath_available some.domain.tld /coffee +# +# usage: ynh_webpath_available domain path +# | arg: domain - the domain/host of the url +# | arg: path - the web path to check the availability of +ynh_webpath_available () { + local domain=$1 + local path=$2 + sudo yunohost domain url-available $domain $path +} + +# Register/book a web path for an app +# +# example: ynh_webpath_register wordpress some.domain.tld /coffee +# +# usage: ynh_webpath_register app domain path +# | arg: app - the app for which the domain should be registered +# | arg: domain - the domain/host of the web path +# | arg: path - the web path to be registered +ynh_webpath_register () { + local app=$1 + local domain=$2 + local path=$3 + sudo yunohost app register-url $app $domain $path +} + +# Calculate and store a file checksum into the app settings +# +# $app should be defined when calling this helper +# +# usage: ynh_store_file_checksum file +# | arg: file - The file on which the checksum will performed, then stored. +ynh_store_file_checksum () { + local checksum_setting_name=checksum_${1//[\/ ]/_} # Replace all '/' and ' ' by '_' + ynh_app_setting_set $app $checksum_setting_name $(sudo md5sum "$1" | cut -d' ' -f1) +} + +# Verify the checksum and backup the file if it's different +# This helper is primarily meant to allow to easily backup personalised/manually +# modified config files. +# +# $app should be defined when calling this helper +# +# usage: ynh_backup_if_checksum_is_different file +# | arg: file - The file on which the checksum test will be perfomed. +# +# | ret: Return the name a the backup file, or nothing +ynh_backup_if_checksum_is_different () { + local file=$1 + local checksum_setting_name=checksum_${file//[\/ ]/_} # Replace all '/' and ' ' by '_' + local checksum_value=$(ynh_app_setting_get $app $checksum_setting_name) + if [ -n "$checksum_value" ] + then # Proceed only if a value was stored into the app settings + if ! echo "$checksum_value $file" | sudo md5sum -c --status + then # If the checksum is now different + backup_file="/home/yunohost.conf/backup/$file.backup.$(date '+%Y%m%d.%H%M%S')" + sudo mkdir -p "$(dirname "$backup_file")" + sudo cp -a "$file" "$backup_file" # Backup the current file + echo "File $file has been manually modified since the installation or last upgrade. So it has been duplicated in $backup_file" >&2 + echo "$backup_file" # Return the name of the backup file + fi + fi +} diff --git a/scripts/backup b/scripts/backup index e9f0027..f8a1d0a 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,25 +1,62 @@ #!/bin/bash +#================================================= +# GENERIC STARTING +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= + # Exit on command errors and treat unset variables as an error set -eu -# Source YNH helpers -. /usr/share/yunohost/helpers +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +if [ ! -e _common.sh ]; then + # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant + sudo cp ../settings/scripts/_common.sh ./_common.sh + sudo chmod a+rx _common.sh +fi +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# LOAD SETTINGS +#================================================= -# Get app instance name app=$YNH_APP_INSTANCE_NAME -# Retrieve arguments -domain=$(sudo yunohost app setting $app domain) +domain=$(ynh_app_setting_get $app domain) -# Backup directory location for the app from where the script is executed and -# which will be compressed afterward -backup_dir=$YNH_APP_BACKUP_DIR +#================================================= +# STANDARD BACKUP STEPS +#================================================= +# BACKUP OF THE NGINX CONFIGURATION +#================================================= -# Backup sources & data -ynh_backup "/home/yunohost.transmission" "data" -ynh_backup "/usr/share/transmission" "sources" +ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "${YNH_APP_BACKUP_DIR}/etc/nginx/conf.d/$domain.d/$app.conf" -# Copy configuration files -ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "conf/nginx.conf" -ynh_backup "/etc/transmission-daemon/settings.json" "conf/transmission.json" +#================================================= +# SPECIFIC BACKUP +#================================================= +# BACKUP TRANSMISSION CONFIGURATION +#================================================= + +ynh_backup "/etc/transmission-daemon/settings.json" "${YNH_APP_BACKUP_DIR}/etc/transmission-daemon/settings.json" + +#================================================= +# BACKUP DATA +#================================================= + +CHECK_SIZE "/usr/share/transmission" +ynh_backup "/usr/share/transmission" "${YNH_APP_BACKUP_DIR}/usr/share/transmission" + +backup_core_only=$(ynh_app_setting_get $app backup_core_only) +if [ -z $backup_core_only ] # Si backup_core_only a une valeur dans le fichier settings.yml, ne sauvegarde pas le dossier data +then + CHECK_SIZE "/home/yunohost.transmission" + ynh_backup "/home/yunohost.transmission" "${YNH_APP_BACKUP_DIR}/home/yunohost.transmission" +else + echo "Data dir will not saved, because backup_core_only is set." >&2 +fi diff --git a/scripts/install b/scripts/install index af1a22b..9572635 100644 --- a/scripts/install +++ b/scripts/install @@ -1,52 +1,117 @@ #!/bin/bash -# Exit on command errors and treat unset variables as an error -set -eu +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= + +ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. + +#================================================= +# RETRIEVE ARGUMENTS FROM THE MANIFEST +#================================================= + +domain=$YNH_APP_ARG_DOMAIN +path_url=$YNH_APP_ARG_PATH -# Get app instance name app=$YNH_APP_INSTANCE_NAME -# Source app helpers -. /usr/share/yunohost/helpers +#================================================= +# CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS +#================================================= -# Retrieve arguments -domain=$YNH_APP_ARG_DOMAIN -path=$YNH_APP_ARG_PATH +path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path. +CHECK_DOMAINPATH # Vérifie la disponibilité du path et du domaine. -sudo yunohost app checkurl $domain$path -a $app -if [[ ! $? -eq 0 ]]; then - exit 1 -fi +#================================================= +# STORE SETTINGS FROM MANIFEST +#================================================= -# Remove trailing "/" for next commands -path=${path%/} +ynh_app_setting_set $app domain $domain +ynh_app_setting_set $app path $path_url -# Check port availability -sudo yunohost app checkport 9091 -if [[ ! $? -eq 0 ]]; then - exit 1 -fi -sudo yunohost app checkport 51413 -if [[ ! $? -eq 0 ]]; then - exit 1 -fi +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# FIND AND OPEN PORTS +#================================================= -# Open port in firewall -sudo yunohost firewall allow TCP 51413 > /dev/null 2>&1 +port=$(ynh_find_port 9091) # Cherche un port libre. +# Ouvre le port dans le firewall +ALL_QUIET sudo yunohost firewall allow --no-upnp TCP $port +ynh_app_setting_set $app port $port -# Install official debian package -sudo apt-get install transmission-daemon -y -qq +peer_port=$(ynh_find_port 51413) # Cherche un port libre. +# Ouvre le port dans le firewall +ALL_QUIET sudo yunohost firewall allow TCP $peer_port +ynh_app_setting_set $app peer_port $peer_port + +#================================================= +# INSTALL TRANSMISSION +#================================================= + +ynh_package_install transmission-daemon + +#================================================= +# NGINX CONFIGURATION +#================================================= + +# Add a "/" at the end of path_url for next commands +[ "$path_url" = "/" ] || path_url=${path_url}/ +ynh_nginx_config + +#================================================= +# SPECIFIC SETUP +#================================================= +# CREATE DIRECTORIES +#================================================= -# Make directories and set rights sudo mkdir -p /home/yunohost.transmission/{progress,completed,watched} -sudo chown -R debian-transmission:www-data /home/yunohost.transmission/ -sudo chown -R debian-transmission:debian-transmission /home/yunohost.transmission/progress /home/yunohost.transmission/watched -sudo find /home/yunohost.transmission/ -type f | while read LINE; do sudo chmod 640 "$LINE" ; done -sudo find /home/yunohost.transmission/ -type d | while read LINE; do sudo chmod 750 "$LINE" ; done -sudo find /home/yunohost.transmission/watched -type d | while read LINE; do sudo chmod 770 "$LINE" ; done -ynh_app_setting_set "$app" watchdir "/home/yunohost.transmission/watched" -# YunoHost multimedia +#================================================= +# SECURING FILES AND DIRECTORIES +#================================================= + +sudo chown -R debian-transmission:www-data /home/yunohost.transmission/ +sudo chown -R debian-transmission: /home/yunohost.transmission/{progress,watched} +sudo chmod -R 640 /home/yunohost.transmission +sudo chmod -R 777 /home/yunohost.transmission/watched + +#================================================= +# CONFIGURE TRANSMISSION +#================================================= + +# Transmission has to be stopped before modifying its config +sudo systemctl stop transmission-daemon + +# Create a RPC password +rpcpassword=$(ynh_string_random) +ynh_app_setting_set $app rpcpassword "$rpcpassword" + +ynh_replace_string "__RPC_PASSWORD_TO_CHANGE__" "$rpcpassword" ../conf/settings.json +ynh_replace_string "__PATH__" "$path_url" ../conf/settings.json +ynh_replace_string "__PEER_PORT__" "$peer_port" ../conf/settings.json +ynh_replace_string "__PORT__" "$port" ../conf/settings.json +sudo cp ../conf/settings.json /etc/transmission-daemon/settings.json + +#================================================= +# STORE THE CHECKSUM OF THE CONFIG FILE +#================================================= + +ynh_store_file_checksum /etc/transmission-daemon/settings.json + +#================================================= +# YUNOHOST MULTIMEDIA INTEGRATION +#================================================= + wget -qq https://github.com/YunoHost-Apps/yunohost.multimedia/archive/master.zip unzip -qq master.zip sudo ./yunohost.multimedia-master/script/ynh_media_build.sh @@ -54,27 +119,33 @@ sudo ./yunohost.multimedia-master/script/ynh_media_build.sh sudo ./yunohost.multimedia-master/script/ynh_media_addfolder.sh --source="/home/yunohost.transmission" --dest="share/Torrents" # And share completed directory sudo ./yunohost.multimedia-master/script/ynh_media_addfolder.sh --source="/home/yunohost.transmission/completed" --dest="share/Torrents" +# Share also watched directory, to allow to use it easily +sudo ./yunohost.multimedia-master/script/ynh_media_addfolder.sh --source="/home/yunohost.transmission/watched" --dest="share/Torrent to download" -# Create RPC password -rpcpassword=$(ynh_string_random) -ynh_app_setting_set "$app" rpcpassword "$rpcpassword" +#================================================= +# PATCH SOURCE TO ADD A DOWNLOAD BUTTON +#================================================= -# Configure Transmission and reload -sudo service transmission-daemon stop -sed -i "s@RPCPASSWORDTOCHANGE@$rpcpassword@g" ../conf/settings.json -sed -i "s@PATHTOCHANGE@$path@g" ../conf/settings.json -sudo cp ../conf/settings.json /etc/transmission-daemon/settings.json -sudo service transmission-daemon start +sudo cp ../sources/extra_files/app/toolbar-downloads.png /usr/share/transmission/web/style/transmission/images/toolbar-downloads.png +sudo bash -c 'cat ../sources/extra_files/app/ynh_common.css >> /usr/share/transmission/web/style/transmission/common.css' +ynh_replace_string "
" "
" /usr/share/transmission/web/index.html + +#================================================= +# GENERIC FINALISATION +#================================================= +# ENABLE SERVICE IN ADMIN PANEL +#================================================= -# Monitor service sudo yunohost service add transmission-daemon -# Patch sources to add a download button -sudo cp ../sources/toolbar-downloads.png /usr/share/transmission/web/style/transmission/images/toolbar-downloads.png -sudo bash -c 'cat ../sources/ynh_common.css >> /usr/share/transmission/web/style/transmission/common.css' -sudo sed -i "s@
@
@g" /usr/share/transmission/web/index.html +#================================================= +# START TRANSMISSION +#================================================= -# Configure Nginx and reload -sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf -sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf -sudo service nginx reload +sudo systemctl start transmission-daemon + +#================================================= +# RELOAD NGINX +#================================================= + +sudo systemctl reload nginx diff --git a/scripts/remove b/scripts/remove index 3db43c4..c5e9c44 100644 --- a/scripts/remove +++ b/scripts/remove @@ -1,26 +1,69 @@ #!/bin/bash -# Retreive app settings +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# LOAD SETTINGS +#================================================= + app=$YNH_APP_INSTANCE_NAME -domain=$(sudo yunohost app setting $app domain) -# Stop service -sudo service transmission-daemon stop -sudo yunohost service remove transmission-daemon +domain=$(ynh_app_setting_get $app domain) +port=$(ynh_app_setting_get $app port) +peer_port=$(ynh_app_setting_get $app peer_port) -# Disallow specific port -sudo yunohost firewall disallow TCP 51413 +#================================================= +# STANDARD REMOVE +#================================================= +# REMOVE TRANSMISSION-DAEMON +#================================================= -# Remove nginx configuration -sudo rm /etc/nginx/conf.d/$domain.d/$app.conf +sudo apt-get -y purge transmission-daemon -# Remove data -sudo rm -rf /home/yunohost.transmission +#================================================= +# DISABLE SERVICE IN ADMIN PANEL +#================================================= -# Remove Debian package -sudo apt-get remove -y -qq transmission-daemon -# sudo rm -rf /usr/share/transmission -# sudo rm -rf /etc/transmission-daemon/settings.json +if sudo yunohost service status | grep -q transmission-daemon # Test l'existence du service dans Yunohost +then + echo "Remove transmission-daemon service" + sudo yunohost service remove transmission-daemon +fi -# Reload nginx -sudo service nginx reload +#================================================= +# CLOSE THE PORTS +#================================================= + +ALL_QUIET sudo yunohost firewall disallow TCP $port +ALL_QUIET sudo yunohost firewall disallow TCP $peer_port + +#================================================= +# REMOVE THE NGINX CONFIGURATION +#================================================= + +ynh_remove_nginx_config # Suppression de la configuration nginx + +#================================================= +# SPECIFIC REMOVE +#================================================= +# REMOVE DATA +#================================================= + +backup_core_only=$(ynh_app_setting_get $app backup_core_only) +if [ -z $backup_core_only ] # Si backup_core_only a une valeur dans le fichier settings.yml, ne supprime pas le dossier data +then + ynh_secure_remove /home/yunohost.transmission +fi + +# And remove the link in yunohost.multimedia +sudo rm "/home/yunohost.multimedia/share/Torrents" +sudo rm "/home/yunohost.multimedia/share/Torrent to download" + +ynh_secure_remove /usr/share/transmission diff --git a/scripts/restore b/scripts/restore index e482564..cc36b0f 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,78 +1,123 @@ #!/bin/bash +#================================================= +# GENERIC STARTING +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= + # Exit on command errors and treat unset variables as an error set -eu -# Source YNH helpers -. /usr/share/yunohost/helpers +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +if [ ! -e _common.sh ]; then + # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant + sudo cp ../settings/scripts/_common.sh ./_common.sh + sudo chmod a+rx _common.sh +fi +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# LOAD SETTINGS +#================================================= -# Get app instance name app=$YNH_APP_INSTANCE_NAME -# Retrieve arguments -domain=$(sudo yunohost app setting $app domain) -path=$(sudo yunohost app setting $app path) +domain=$(ynh_app_setting_get $app domain) +path_url=$(ynh_app_setting_get $app path) +port=$(ynh_app_setting_get $app port) +peer_port=$(ynh_app_setting_get $app peer_port) -# Check domain/path availability -sudo yunohost app checkurl $domain$path -a $app -if [[ ! $? -eq 0 ]]; then - echo "There is already an app on this URL : $domain$path" | sudo tee /dev/stderr - exit 1 +#================================================= +# CHECK IF THE APP CAN BE RESTORED +#================================================= + +sudo yunohost app checkurl "${domain}${path_url}" -a "$app" \ + || ynh_die "Path not available: ${domain}${path_url}" + +#================================================= +# STANDARD RESTORE STEPS +#================================================= +# RESTORE OF THE NGINX CONFIGURATION +#================================================= + +ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf" + +#================================================= +# OPEN PORTS +#================================================= + +ALL_QUIET sudo yunohost firewall allow --no-upnp TCP $port +ALL_QUIET sudo yunohost firewall allow TCP $peer_port + +#================================================= +# SPECIFIC RESTORE +#================================================= +# REINSTALL TRANSMISSION +#================================================= + +ynh_package_install transmission-daemon + +#================================================= +# RESTORE TRANSMISSION CONFIGURATION +#================================================= + +# Transmission has to be stopped before modifying its config +sudo systemctl stop transmission-daemon + +sudo rm /etc/transmission-daemon/settings.json +ynh_restore_file "/etc/transmission-daemon/settings.json" + +#================================================= +# RESTORE DATA +#================================================= + +ynh_restore_file "/usr/share/transmission" + +if [ -d "${YNH_APP_BACKUP_DIR}/home/yunohost.transmission" ] # Le dossier data est restauré seulement si il existe. Si le backup a été fait avec l'option backup_core_only, ce dossier n'a pas été sauvegardé. +then + ynh_restore_file "/home/yunohost.transmission" +else + sudo mkdir -p /home/yunohost.transmission/{progress,completed,watched} + sudo chown -R debian-transmission:www-data /home/yunohost.transmission/ + sudo chown -R debian-transmission: /home/yunohost.transmission/{progress,watched} + sudo chmod -R 640 /home/yunohost.transmission + sudo chmod -R 777 /home/yunohost.transmission/watched fi +ynh_app_setting_delete $app backup_core_only # Retire l'option backup_core_only du fichier settings.yml le cas échéant -sources_path=/usr/share/transmission -# Do not check for empty source_path because 'apt-get remove' does not clean everything -# if [ -d $sources_path ]; then -# echo "There is already a directory: $sources_path " | sudo tee /dev/stderr -# exit 1 -# fi +#================================================= +# YUNOHOST MULTIMEDIA INTEGRATION +#================================================= -data_path=/home/yunohost.transmission -if [ -d $data_path ]; then - echo "There is already a directory: $data_path " | sudo tee /dev/stderr - exit 1 -fi +wget -qq https://github.com/YunoHost-Apps/yunohost.multimedia/archive/master.zip +unzip -qq master.zip +sudo ./yunohost.multimedia-master/script/ynh_media_build.sh +# Set rights on transmission directory (parent need to be readable by other, and progress need to be writable by multimedia. Because files will move) +sudo ./yunohost.multimedia-master/script/ynh_media_addfolder.sh --source="/home/yunohost.transmission" --dest="share/Torrents" +# And share completed directory +sudo ./yunohost.multimedia-master/script/ynh_media_addfolder.sh --source="/home/yunohost.transmission/completed" --dest="share/Torrents" +# Share also watched directory, to allow to use it easily +sudo ./yunohost.multimedia-master/script/ynh_media_addfolder.sh --source="/home/yunohost.transmission/watched" --dest="share/Torrent to download" -nginx_conf=/etc/nginx/conf.d/$domain.d/$app.conf -if [ -f $nginx_conf ]; then - echo "There is already a nginx conf file at this path: $nginx_conf " | sudo tee /dev/stderr - exit 1 -fi +#================================================= +# ENABLE SERVICE IN ADMIN PANEL +#================================================= -app_conf=/etc/transmission-daemon/settings.json -# Do not check for empty app_conf because 'apt-get remove' does not clean everything -# if [ -f $app_conf ]; then -# echo "There is already a PHP-FPM conf file at this path: $app_conf " | sudo tee /dev/stderr -# exit 1 -# fi - -# Open port in firewall -sudo yunohost firewall allow TCP 51413 > /dev/null 2>&1 - -# Install official debian package -sudo apt-get install transmission-daemon -y -qq - -# Make directories and set rights -sudo mkdir -p /home/yunohost.transmission/{progress,completed,watched} -sudo chown -R debian-transmission:www-data /home/yunohost.transmission/ -sudo chown -R debian-transmission:debian-transmission /home/yunohost.transmission/progress /home/yunohost.transmission/watched -sudo find /home/yunohost.transmission/ -type f | while read LINE; do sudo chmod 640 "$LINE" ; done -sudo find /home/yunohost.transmission/ -type d | while read LINE; do sudo chmod 750 "$LINE" ; done -sudo find /home/yunohost.transmission/watched -type d | while read LINE; do sudo chmod 770 "$LINE" ; done - -# Reload transmission service -sudo service transmission-daemon reload - -# Monitor service sudo yunohost service add transmission-daemon -# Restore sources & data -sudo cp -a "./sources" $sources_path -sudo cp -a "./data" $data_path +#================================================= +# START TRANSMISSION +#================================================= -# Restore conf files -sudo cp -a "./conf/nginx.conf" $nginx_conf -sudo cp -a "./conf/transmission.json" $app_conf +sudo systemctl start transmission-daemon -# Reload Nginx -sudo service nginx reload +#================================================= +# RELOAD NGINX +#================================================= + +sudo systemctl reload nginx diff --git a/scripts/upgrade b/scripts/upgrade index e4d9cec..c3a1ff4 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,42 +1,110 @@ #!/bin/bash -# Exit on command errors and treat unset variables as an error -set -eu +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# LOAD SETTINGS +#================================================= -# Get app instance name app=$YNH_APP_INSTANCE_NAME -# Source app helpers -. /usr/share/yunohost/helpers +domain=$(ynh_app_setting_get $app domain) +path_url=$(ynh_app_setting_get $app path) +port=$(ynh_app_setting_get $app port) +peer_port=$(ynh_app_setting_get $app peer_port) -# Retrieve arguments -domain=$(ynh_app_setting_get "$app" domain) -path=$(ynh_app_setting_get "$app" path) -rpcpassword=$(ynh_app_setting_get "$app" rpcpassword) -watchdir=$(ynh_app_setting_get "$app" watchdir) +#================================================= +# FIX OLD THINGS +#================================================= -# Remove trailing "/" for next commands -path=${path%/} - -# Open port in firewall -sudo yunohost firewall allow TCP 51413 > /dev/null 2>&1 - -# Upgrade official debian package -sudo apt-get install transmission-daemon -y -qq - -# Make directories and set rights -sudo mkdir -p /home/yunohost.transmission/{progress,completed,watched} -sudo chown -R debian-transmission:www-data /home/yunohost.transmission/ -sudo chown -R debian-transmission:debian-transmission /home/yunohost.transmission/progress /home/yunohost.transmission/watched -sudo find /home/yunohost.transmission/ -type f | while read LINE; do sudo chmod 640 "$LINE" ; done -sudo find /home/yunohost.transmission/ -type d | while read LINE; do sudo chmod 750 "$LINE" ; done -sudo find /home/yunohost.transmission/watched -type d | while read LINE; do sudo chmod 770 "$LINE" ; done -# Add watchdir in settings if it does not exist yet (previous versions) -if [ -z "$watchdir" ]; then - ynh_app_setting_set "$app" watchdir "/home/yunohost.transmission/watched" +if [ -z $port ]; then + ynh_app_setting_set $app port 9091 +fi +if [ -z $peer_port ]; then + ynh_app_setting_set $app peer_port 51413 fi -# YunoHost multimedia +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= + +ynh_app_setting_set $app backup_core_only 1 # Indique au backup/restore de ne pas sauvegarder le dossier de data. +BACKUP_BEFORE_UPGRADE # Backup the current version of the app +ynh_clean_setup () { + BACKUP_FAIL_UPGRADE # restore it if the upgrade fails +} +ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. + +#================================================= +# CHECK THE PATH +#================================================= + +path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path. + +#================================================= +# STANDARD UPGRADE STEPS +#================================================= +# NGINX CONFIGURATION +#================================================= + +# Add a "/" at the end of path_url for next commands +[ "$path_url" = "/" ] || path_url=${path_url}/ +ynh_nginx_config + +#================================================= +# SPECIFIC UPGRADE +#================================================= +# CREATE DIRECTORIES +#================================================= + +sudo mkdir -p /home/yunohost.transmission/{progress,completed,watched} + +#================================================= +# SECURING FILES AND DIRECTORIES +#================================================= + +sudo chown -R debian-transmission:www-data /home/yunohost.transmission/ +sudo chown -R debian-transmission: /home/yunohost.transmission/{progress,watched} +sudo chmod -R 640 /home/yunohost.transmission +sudo chmod -R 777 /home/yunohost.transmission/watched + +#================================================= +# CONFIGURE TRANSMISSION +#================================================= + +# Transmission has to be stopped before modifying its config +sudo systemctl stop transmission-daemon + +# Créé un backup du fichier de config si il a été modifié. +ynh_backup_if_checksum_is_different /etc/transmission-daemon/settings.json + +# Create a RPC password +rpcpassword=$(ynh_string_random) +ynh_app_setting_set $app rpcpassword "$rpcpassword" + +ynh_replace_string "__RPC_PASSWORD_TO_CHANGE__" "$rpcpassword" ../conf/settings.json +ynh_replace_string "__PATH__" "$path_url" ../conf/settings.json +ynh_replace_string "__PEER_PORT__" "$peer_port" ../conf/settings.json +ynh_replace_string "__PORT__" "$port" ../conf/settings.json +sudo cp ../conf/settings.json /etc/transmission-daemon/settings.json + +#================================================= +# STORE THE CHECKSUM OF THE CONFIG FILE +#================================================= + +ynh_store_file_checksum /etc/transmission-daemon/settings.json + +#================================================= +# YUNOHOST MULTIMEDIA INTEGRATION +#================================================= + wget -qq https://github.com/YunoHost-Apps/yunohost.multimedia/archive/master.zip unzip -qq master.zip sudo ./yunohost.multimedia-master/script/ynh_media_build.sh @@ -44,29 +112,34 @@ sudo ./yunohost.multimedia-master/script/ynh_media_build.sh sudo ./yunohost.multimedia-master/script/ynh_media_addfolder.sh --source="/home/yunohost.transmission" --dest="share/Torrents" # And share completed directory sudo ./yunohost.multimedia-master/script/ynh_media_addfolder.sh --source="/home/yunohost.transmission/completed" --dest="share/Torrents" +# Share also watched directory, to allow to use it easily +sudo ./yunohost.multimedia-master/script/ynh_media_addfolder.sh --source="/home/yunohost.transmission/watched" --dest="share/Torrent to download" -# Create RPC password if none exists -if [ -z "$rpcpassword" ]; then - rpcpassword=$(ynh_string_random) - ynh_app_setting_set "$app" rpcpassword "$rpcpassword" +#================================================= +# PATCH SOURCE TO ADD A DOWNLOAD BUTTON +#================================================= + +sudo cp ../sources/extra_files/app/toolbar-downloads.png /usr/share/transmission/web/style/transmission/images/toolbar-downloads.png +if ! grep --quiet "Inserted by Yunohost install script" /usr/share/transmission/web/style/transmission/common.css +then + sudo bash -c 'cat ../sources/extra_files/app/ynh_common.css >> /usr/share/transmission/web/style/transmission/common.css' fi +ynh_replace_string "
$" "
" /usr/share/transmission/web/index.html -# Configure Transmission and reload -sudo service transmission-daemon stop -sed -i "s@RPCPASSWORDTOCHANGE@$rpcpassword@g" ../conf/settings.json -sed -i "s@PATHTOCHANGE@$path@g" ../conf/settings.json -sudo cp ../conf/settings.json /etc/transmission-daemon/settings.json -sudo service transmission-daemon start +#================================================= +# START TRANSMISSION +#================================================= -# Patch sources to add a download button -if ! grep 'toolbar-downloads' /usr/share/transmission/web/index.html --quiet; then +sudo systemctl start transmission-daemon - sudo cp ../sources/toolbar-downloads.png /usr/share/transmission/web/style/transmission/images/toolbar-downloads.png - sudo bash -c 'cat ../sources/ynh_common.css >> /usr/share/transmission/web/style/transmission/common.css' - sudo sed -i "s@
@
@g" /usr/share/transmission/web/index.html -fi +#================================================= +# RELOAD NGINX +#================================================= -# Configure Nginx and reload -sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf -sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf -sudo service nginx reload +sudo systemctl reload nginx + +#================================================= +# REMOVE BACKUP_CORE_ONLY +#================================================= + +ynh_app_setting_delete $app backup_core_only diff --git a/sources/toolbar-downloads.png b/sources/extra_files/app/toolbar-downloads.png similarity index 100% rename from sources/toolbar-downloads.png rename to sources/extra_files/app/toolbar-downloads.png diff --git a/sources/ynh_common.css b/sources/extra_files/app/ynh_common.css similarity index 100% rename from sources/ynh_common.css rename to sources/extra_files/app/ynh_common.css