commit f239fa1fd290b9e45f7f0313ea2701b305f5c7e0 Author: Snipees Date: Mon Aug 24 00:15:52 2015 +0200 :package: init diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..55b5b7e --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..31ac610 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +## couchpotato_ynh + +[![Latest Version](https://img.shields.io/badge/version-_--_-green.svg?style=flat)](https://github.com/Snipees/couchpotato_ynh/releases) +[![Status](https://img.shields.io/badge/status-in_progress-yellow.svg?style=flat)](https://github.com/Snipees/couchpotato_ynh/milestones) +[![Dependencies](https://img.shields.io/badge/dependencies-includes-lightgrey.svg?style=flat)](https://github.com/Snipees/couchpotato_ynh#dependencies) +[![GitHub license](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat)](https://raw.githubusercontent.com/Snipees/couchpotato_ynh/master/LICENSE) +[![Yunohost version](https://img.shields.io/badge/yunohost-2.2.0_tested-orange.svg?style=flat)](https://github.com/YunoHost/yunohost) +[![GitHub issues](https://img.shields.io/github/issues/Snipees/couchpotato_ynh.svg?style=flat)](https://github.com/Snipees/couchpotato_ynh/issues) + +[ **CouchPotato Integration for Yunohost** ] +This install script uses a Git-fork as sources for a local installation. +Otherwise the script sets a reverse-proxy to a remote instance. + + +### How to install: +- Use **Install software** option from Yunohost admin panel +- Find textbox tagged as **Install custom App from github** +- Copy and paste: https://github.com/Snipees/couchpotato_ynh +- Choose an host for the instance, keep ***127.0.0.1*** to make a local installation +- Choose the listening port, local installation will use this port but will not be reachable +- Choose a fork as sources for local installation + + +### More information about: +- CouchPotato : https://couchpota.to +- Yunohost : https://yunohost.org + + +#### Special Thanks to the Yunohost Community: +[anaqreon](https://github.com/anaqreon), +[aymhce](https://github.com/aymhce), +[beudbeud](https://github.com/abeudin), +[Chao-Man](https://github.com/Chao-Man), +[chtixof](https://github.com/chtixof), +[CotzaDev](https://github.com/CotzaDev), +[courgette](https://github.com/courgette), +[Jérôme](https://github.com/jeromelebleu), +[JocelynD](https://github.com/JocelynDelalande), +[Ju](https://github.com/julienmalik), +[Le Kload](https://github.com/Kloadut), +[lunarok](https://github.com/lunarok), +[maniackcrudelis](https://github.com/maniackcrudelis), +[Matlink](https://github.com/matlink), +[Moul](https://github.com/M5oul), +[polytan02](https://github.com/polytan02), +[scith](https://github.com/scith), +[tifred](https://github.com/drfred1981), +... :dizzy: diff --git a/conf/config.ini b/conf/config.ini new file mode 100644 index 0000000..388a7b5 --- /dev/null +++ b/conf/config.ini @@ -0,0 +1,598 @@ +[core] +api_key = +username = +ssl_key = +ssl_cert = +data_dir = DATADIRTOCHANGE +permission_folder = 0755 +development = 0 +url_base = PATHTOCHANGE +debug = 0 +launch_browser = False +password = +port = PORTTOCHANGE +permission_file = 0755 +show_wizard = 1 + +[download_providers] + +[updater] +notification = True +enabled = False +git_command = git +automatic = False + +[automation] +rating = 7.0 +votes = 1000 +hour = 12 +required_genres = +year = 2011 +ignored_genres = + +[manage] +startup_scan = True +library_refresh_interval = 0 +cleanup = True +enabled = False +library = + +[renamer] +nfo_name = .orig. +from = +force_every = 2 +move_leftover = False +to = +file_name = . +enabled = False +next_on_failed = True +unrar = False +rename_nfo = True +cleanup = False +separator = +folder_name = () +run_every = 1 +foldersep = +file_action = link +ntfs_permission = False + +[subtitle] +languages = +force = False +enabled = False + +[trailer] +quality = 720p +enabled = False +name = -trailer + +[blackhole] +directory = +manual = 0 +enabled = 0 +create_subdir = 0 +use_for = both + +[deluge] +username = +delete_failed = True +completed_directory = +manual = 0 +enabled = 0 +label = +paused = False +host = localhost:58846 +delete_files = True +directory = +remove_complete = True +password = + +[nzbget] +username = nzbget +category = Movies +delete_failed = True +manual = 0 +enabled = 0 +priority = 0 +ssl = 0 +host = localhost:6789 +password = + +[nzbvortex] +delete_failed = True +manual = False +enabled = 0 +ssl = 1 +host = localhost:4321 +api_key = + +[pneumatic] +directory = +manual = 0 +enabled = 0 + +[qbittorrent] +username = +manual = 0 +enabled = 0 +paused = False +host = http://localhost:8080/ +delete_files = True +remove_complete = False +password = + +[rtorrent] +username = +rpc_url = RPC2 +manual = 0 +enabled = 0 +label = +paused = False +ssl = 0 +host = localhost:80 +delete_files = True +directory = +remove_complete = False +password = + +[sabnzbd] +category = +delete_failed = True +manual = False +enabled = 0 +priority = 0 +ssl = 0 +host = localhost:8080 +remove_complete = False +api_key = + +[synology] +username = +manual = 0 +destination = +enabled = 0 +host = localhost:5000 +password = +use_for = both + +[transmission] +username = +stalled_as_failed = True +delete_failed = True +rpc_url = transmission +manual = 0 +enabled = 0 +paused = False +host = localhost:9091 +delete_files = True +directory = +remove_complete = True +password = + +[utorrent] +username = +delete_failed = True +manual = 0 +enabled = 0 +label = +paused = False +host = localhost:8000 +delete_files = True +remove_complete = True +password = + +[notification_providers] + +[boxcar2] +token = +enabled = 0 +on_snatch = 0 + +[email] +starttls = 0 +smtp_pass = +on_snatch = 0 +from = +to = +smtp_port = 25 +enabled = 0 +smtp_server = +smtp_user = +ssl = 0 + +[growl] +password = +on_snatch = False +hostname = +enabled = 0 +port = + +[nmj] +host = localhost +enabled = 0 +mount = +database = + +[notifymyandroid] +priority = 0 +dev_key = +api_key = +enabled = 0 +on_snatch = 0 + +[notifymywp] +priority = 0 +dev_key = +api_key = +enabled = 0 +on_snatch = 0 + +[plex] +on_snatch = 0 +clients = +enabled = 0 +media_server = localhost + +[prowl] +priority = 0 +on_snatch = 0 +api_key = +enabled = 0 + +[pushalot] +auth_token = +important = 0 +enabled = 0 +silent = 0 +on_snatch = 0 + +[pushbullet] +on_snatch = 0 +api_key = +enabled = 0 +devices = + +[pushover] +sound = +on_snatch = 0 +user_key = +enabled = 0 +priority = 0 +api_token = YkxHMYDZp285L265L3IwH3LmzkTaCy + +[synoindex] +enabled = 0 + +[toasty] +on_snatch = 0 +api_key = +enabled = 0 + +[trakt] +remove_watchlist_enabled = False +notification_enabled = False +automation_password = +automation_enabled = False +automation_username = +automation_api_key = + +[twitter] +on_snatch = 0 +screen_name = +enabled = 0 +access_token_key = +mention = +access_token_secret = +direct_message = 0 + +[xbmc] +username = xbmc +on_snatch = False +force_full_scan = 0 +only_first = 0 +enabled = 0 +remote_dir_scan = 0 +host = localhost:8080 +password = +meta_disc_art_name = disc.png +meta_extra_thumbs_name = extrathumbs/thumb.jpg +meta_thumbnail = True +meta_extra_fanart = False +meta_logo = False +meta_enabled = False +meta_landscape_name = landscape.jpg +meta_nfo_name = %s.nfo +meta_banner_name = banner.jpg +meta_landscape = False +meta_extra_fanart_name = extrafanart/extrafanart.jpg +meta_nfo = True +meta_fanart = True +meta_thumbnail_name = %s.tbn +meta_url_only = False +meta_fanart_name = %s-fanart.jpg +meta_logo_name = logo.png +meta_banner = False +meta_clear_art = False +meta_clear_art_name = clearart.png +meta_extra_thumbs = False +meta_disc_art = False + +[xmpp] +username = +on_snatch = 0 +hostname = talk.google.com +enabled = 0 +to = +password = +port = 5222 + +[nzb_providers] + +[binsearch] +enabled = +extra_score = 0 + +[newznab] +use = 0,0,0,0,0,0 +extra_score = 0,0,0,0,0,0 +enabled = True +host = api.nzb.su,api.dognzb.cr,nzbs.org,https://index.nzbgeek.info, https://smackdownonyou.com, https://www.nzbfinder.ws +custom_tag = ,,,,, +api_key = ,,,,, + +[nzbclub] +enabled = +extra_score = 0 + +[nzbindex] +enabled = True +extra_score = 0 + +[omgwtfnzbs] +username = +api_key = +enabled = +extra_score = 20 + +[torrent_providers] + +[awesomehd] +seed_time = 40 +extra_score = 20 +only_internal = 1 +passkey = +enabled = False +favor = both +prefer_internal = 1 +seed_ratio = 1 + +[bithdtv] +username = +seed_time = 40 +extra_score = 20 +enabled = False +password = +seed_ratio = 1 + +[bitsoup] +username = +seed_time = 40 +extra_score = 20 +enabled = False +password = +seed_ratio = 1 + +[hdbits] +username = +seed_time = 40 +extra_score = 0 +passkey = +enabled = False +seed_ratio = 1 + +[ilovetorrents] +username = +seed_time = 40 +extra_score = 0 +enabled = False +password = +seed_ratio = 1 + +[iptorrents] +username = +freeleech = 0 +extra_score = 0 +enabled = False +seed_time = 40 +password = +seed_ratio = 1 + +[kickasstorrents] +domain = +seed_time = 40 +extra_score = 0 +enabled = True +only_verified = False +seed_ratio = 1 + +[passthepopcorn] +username = +domain = +seed_time = 40 +extra_score = 20 +passkey = +prefer_scene = 0 +enabled = False +prefer_golden = 1 +require_approval = 0 +password = +seed_ratio = 1 + +[sceneaccess] +username = +seed_time = 40 +extra_score = 20 +enabled = False +password = +seed_ratio = 1 + +[thepiratebay] +seed_time = 40 +domain = +enabled = False +seed_ratio = 1 +extra_score = 0 + +[torrentbytes] +username = +seed_time = 40 +extra_score = 20 +enabled = False +password = +seed_ratio = 1 + +[torrentday] +username = +seed_time = 40 +extra_score = 0 +enabled = False +password = +seed_ratio = 1 + +[torrentleech] +username = +seed_time = 40 +extra_score = 20 +enabled = False +password = +seed_ratio = 1 + +[torrentpotato] +use = +seed_time = 40 +name = +extra_score = 0 +enabled = False +host = +pass_key = , +seed_ratio = 1 + +[torrentshack] +username = +seed_time = 40 +extra_score = 0 +enabled = False +scene_only = False +password = +seed_ratio = 1 + +[torrentz] +verified_only = True +extra_score = 0 +minimal_seeds = 1 +enabled = True +seed_time = 40 +seed_ratio = 1 + +[yify] +seed_time = 40 +domain = +enabled = False +seed_ratio = 1 +extra_score = 0 + +[searcher] +preferred_method = both +required_words = +ignored_words = german, dutch, french, truefrench, danish, swedish, spanish, italian, korean, dubbed, swesub, korsub, dksubs, vain +preferred_words = + +[nzb] +retention = 1500 + +[charts] +hide_wanted = False +update_interval = 12 +hide_library = False +max_items = 5 + +[automation_providers] + +[bluray] +automation_enabled = False +chart_display_enabled = True +backlog = False + +[flixster] +automation_ids_use = +automation_enabled = False +automation_ids = + +[goodfilms] +automation_enabled = False +automation_username = + +[imdb] +automation_charts_top250 = False +chart_display_boxoffice = True +chart_display_top250 = False +automation_enabled = False +chart_display_rentals = True +automation_urls_use = +automation_urls = +automation_providers_enabled = False +automation_charts_rentals = True +chart_display_theater = False +automation_charts_theater = True +chart_display_enabled = True +automation_charts_boxoffice = True + +[itunes] +automation_enabled = False +automation_urls_use = , +automation_urls = https://itunes.apple.com/rss/topmovies/limit=25/xml, + +[kinepolis] +automation_enabled = False + +[letterboxd] +automation_enabled = False +automation_urls_use = +automation_urls = + +[moviemeter] +automation_enabled = False + +[moviesio] +automation_enabled = False +automation_urls_use = +automation_urls = + +[popularmovies] +automation_enabled = False + +[rottentomatoes] +automation_enabled = False +tomatometer_percent = 80 +automation_urls_use = 1 +automation_urls = http://www.rottentomatoes.com/syndication/rss/in_theaters.xml + +[themoviedb] +api_key = 9b939aee0aaafc12a65bf448e4af9543 + +[mediabrowser] +meta_enabled = False + +[sonyps3] +meta_enabled = False + +[windowsmediacenter] +meta_enabled = False + +[moviesearcher] +cron_day = * +cron_hour = 12 +cron_minute = 42 +always_search = False +run_on_launch = 0 +search_on_add = 1 \ No newline at end of file diff --git a/conf/couchpotato b/conf/couchpotato new file mode 100644 index 0000000..cf57cc2 --- /dev/null +++ b/conf/couchpotato @@ -0,0 +1,15 @@ +# COPY THIS FILE TO /etc/default/couchpotato +# OPTIONS: CP_HOME, CP_USER, CP_DATA, CP_PIDFILE, PYTHON_BIN, CP_OPTS, SSD_OPTS, CP_PORT + +## EXAMPLE if want to run as different user +## add CP_USER=username to /etc/default/couchpotato +## otherwise default couchpotato is used + +CP_USER=USERTOCHANGE #$RUN_AS, username to run couchpotato under, the default is couchpotato +CP_HOME=APPDIRTOCHANGE #$APP_PATH, the location of couchpotato.py, the default is /opt/couchpotato +CP_DATA=DATADIRTOCHANGE #$DATA_DIR, the location of couchpotato.db, cache, logs, the default is /opt/couchpotato +CP_PIDFILE=PIDFILETOCHANGE #$PID_FILE, the location of couchpotato.pid, the default is /var/run/couchpotato/couchpotato.pid +PYTHON_BIN=PYTBINTOCHANGE #$DAEMON, the location of the python binary, the default is /usr/bin/python +CP_OPTS=" --config=OPTSTOCHANGE" #$EXTRA_DAEMON_OPTS, extra cli option for couchpotato, i.e. " --config_file=/home/couchpotato/couchpotato.ini" +#SSD_OPTS=SSDTOCHANGE #$EXTRA_SSD_OPTS, extra start-stop-daemon option like " --group=users" +#CP_PORT=PORTTOCHANGE #$PORT_OPTS, hardcoded port for the webserver, overrides value in couchpotato.ini \ No newline at end of file diff --git a/conf/nginx.conf b/conf/nginx.conf new file mode 100644 index 0000000..29ac99e --- /dev/null +++ b/conf/nginx.conf @@ -0,0 +1,15 @@ +location PATHTOCHANGE { + proxy_http_version 1.1; + proxy_pass_header Server; + proxy_pass http://IPTOCHANGE:PORTTOCHANGEPATHTOCHANGE; + proxy_redirect off; + proxy_set_header Host $http_host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Scheme $scheme; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; + + # Include SSOWAT user panel. + include conf.d/yunohost_panel.conf.inc; + more_clear_input_headers 'Accept-Encoding'; +} \ No newline at end of file diff --git a/manifest.json b/manifest.json new file mode 100644 index 0000000..12c2578 --- /dev/null +++ b/manifest.json @@ -0,0 +1,63 @@ +{ + "name": "CouchPotato", + "id": "couchpotato", + "description": { + "en": "Automatic movie downloader", + "fr": "Téléchargement automatisé de film" + }, + "license": "GPL-3", + "maintainer": { + "name": "Snipees", + "email": "snipees@wareziens.net", + "url": "https://github.com/Snipees" + }, + "multi_instance": "false", + "arguments": { + "install": [ + { + "name": "domain", + "ask": { + "en": "Choose a domain for CouchPotato", + "fr": "Choisissez un domaine pour CouchPotato" + }, + "example": "mydomain.org" + }, + { + "name": "path", + "ask": { + "en": "Choose a path for CouchPotato", + "fr": "Choisissez un chemin pour CouchPotato" + }, + "example": "/couchpotato", + "default": "/couchpotato" + }, + { + "name": "host", + "ask": { + "en": "Choose host for app (keep 127.0.0.1 for localhost installation)", + "fr": "Choisissez un hôte pour l'application (laissez 127.0.0.1 pour une installation locale)" + }, + "example": "192.168.1.100", + "default": "127.0.0.1" + }, + { + "name": "port", + "ask": { + "en": "Choose the listening port of the app (not used for localhost installation)", + "fr": "Choisissez le port d'écoute de l'application (non utilisé pour une installation locale)" + }, + "example": "5050", + "default": "5050" + }, + { + "name": "fork", + "ask": { + "en": "Source URL of GIT to use (used only for localhost installation)", + "fr": "URL du GIT source à utiliser (uniquement pour une installation locale)" + }, + "example": "https://github.com/Adelscott/CouchPotatoServer", + "default": "https://github.com/RuudBurger/CouchPotatoServer" + } + ] + } +} diff --git a/scripts/backup b/scripts/backup new file mode 100644 index 0000000..8b1020b --- /dev/null +++ b/scripts/backup @@ -0,0 +1,35 @@ +#!/bin/bash + +# Set variables +app_id=couchpotato +app_user=couchpotato +app_install_dir=/opt/yunohost/$app_id +app_data_dir=/home/yunohost.app/$app_id +app_host=$(sudo yunohost app setting $app_id host) +app_domain=$(sudo yunohost app setting $app_id domain) + +# The parameter $1 is the backup directory location +# which will be compressed afterward +app_backup_dir=$1/apps/$app_id +mkdir -p $app_backup_dir + + +# Backup files if localhost installation +if [[ $app_host == "127.0.0.1" ]]; then + + # Backup sources + sudo cp -a $app_install_dir/. $app_backup_dir/sources + + # Backup data + sudo cp -a $app_data_dir/. $app_backup_dir/data + + # Backup daemon config + sudo cp -a /etc/default/$app_id $app_backup_dir/conf/$app_id.default + sudo cp -a /etc/init.d/$app_id $app_backup_dir/conf/$app_id.init + +fi + + +# Copy Nginx and YunoHost parameters to make the script "standalone" +sudo cp -a /etc/yunohost/apps/$app_id/. $app_backup_dir/yunohost +sudo cp -a /etc/nginx/conf.d/$app_domain.d/$app_id.conf $app_backup_dir/nginx.conf \ No newline at end of file diff --git a/scripts/install b/scripts/install new file mode 100644 index 0000000..6a5245a --- /dev/null +++ b/scripts/install @@ -0,0 +1,130 @@ +#!/bin/bash + +#debug commands +#exec > >(tee /tmp/debug-install.log) +#exec 2>&1 + +# Retrieve arguments +app_domain=$1 +app_path=$2 +app_host=$3 +app_port=$4 +app_fork=$5 +#app_opts=$6 + +# Set variables +app_id=couchpotato +app_user=couchpotato +app_install_dir=/opt/yunohost/$app_id +app_data_dir=/home/yunohost.app/$app_id +app_pid_file=/var/run/$app_id/$app_id.pid +app_config_file=$app_data_dir/config.ini +app_init_file=$app_install_dir/init/ubuntu +app_python_bin=/usr/bin/python + + +# Check domain/path availability +sudo yunohost app checkurl $app_domain$app_path -a $app_id +if [[ ! $? -eq 0 ]]; then + exit 1 +fi + +# Check port availability +sudo yunohost app checkport $app_port +if [[ ! $? -eq 0 ]]; then + exit 1 +fi + + +# Make install if localhost installation +if [[ $app_host == "127.0.0.1" ]]; then + + # Make directories + sudo mkdir -p $app_data_dir + sudo mkdir -p $app_install_dir + + # Install the latest version of App using the fork + sudo apt-get install -y git-core + sudo git clone $app_fork $app_install_dir + + # Install dependencies (using virtualenv) + if [[ $(python --version 2>&1) != Python\ 2* ]]; then + app_python_bin=$app_install_dir/bin/python + sudo apt-get install -y python-pip python-virtualenv python-dev uwsgi uwsgi-plugin-python + sudo virtualenv $app_install_dir + sudo bash -c "source $app_install_dir/bin/activate && pip install cheetah" + fi + + # Create App user + id -u $app_user &>/dev/null || sudo useradd --home-dir $app_install_dir --shell /bin/false $app_user + + # Configure daemon + sudo sed -i "s@USERTOCHANGE@$app_user@g" ../conf/$app_id + sudo sed -i "s@APPDIRTOCHANGE@$app_install_dir@g" ../conf/$app_id + sudo sed -i "s@DATADIRTOCHANGE@$app_data_dir@g" ../conf/$app_id + sudo sed -i "s@PIDFILETOCHANGE@$app_pid_file@g" ../conf/$app_id + sudo sed -i "s@PYTBINTOCHANGE@$app_python_bin@g" ../conf/$app_id + sudo sed -i "s@OPTSTOCHANGE@$app_config_file@g" ../conf/$app_id + sudo cp -a ../conf/$app_id /etc/default/$app_id + sudo cp -a $app_init_file /etc/init.d/$app_id + + # Configure App + sudo sed -i "s@PATHTOCHANGE@$app_path@g" ../conf/config.ini + sudo sed -i "s@PORTTOCHANGE@$app_port@g" ../conf/config.ini + sudo sed -i "s@DATADIRTOCHANGE@$app_data_dir@g" ../conf/config.ini + sudo cp -a ../conf/config.ini $app_config_file + + ## Configure specifics options + #case "$app_opts" in + #*"Transmission"*) + # ref_file=$(sudo sed -n -e '/^CONFIG_DIR/ s/.*\= *//p' $(find /etc/default -name '*transmission*') | sed 's/["* ]//g')/settings.json + # ref_field=(download-dir rpc-bind-address rpc-port rpc-url rpc-username rpc-password) + # for i in ${ref_field[*]}; do ref_value+=$(sudo sed -n -e "/$i/ s/.*\: *//p" $ref_file | sed 's/["*,]//g'); done + # ref_value=($ref_value) + # sudo sed -i "s@torrent_download_dir =.*@torrent_download_dir = ${ref_value[0]}@g" ../conf/config.ini + # sudo sed -i "s@torrent_path =.*@torrent_path = ${ref_value[0]}@g" ../conf/config.ini + # sudo sed -i "s@torrent_host =.*@torrent_host = http://${ref_value[1]}:${ref_value[2]}${ref_value[3]}@g" ../conf/config.ini + # sudo sed -i "s@torrent_username =.*@torrent_username = ${ref_value[4]}@g" ../conf/config.ini + # sudo sed -i "s@torrent_password =.*@torrent_password = ${ref_value[5]}@g" ../conf/config.ini + # sudo sed -i "s@torrent_method =.*@torrent_method = transmission@g" ../conf/config.ini + # sudo sed -i "s@torrent_custom_url =.*@torrent_custom_url = 1@g" ../conf/config.ini + # sudo sed -i "s@use_torrents =.*@use_torrents = 1@g" ../conf/config.ini + # sudo cp -a ../conf/config.ini $app_config_file + # ;; + #esac + + # Set rights + sudo chown -R $app_user $app_install_dir + sudo chown -R $app_user $app_data_dir + sudo chmod +x /etc/init.d/$app_id + sudo chmod +x -R $app_install_dir + sudo chmod +x -R $app_data_dir + + # Add service to YunoHost's monitoring + sudo yunohost service add $app_id --log $app_data_dir/logs/ --status "ps aux | grep $app_id | grep -v grep" + + # Start daemon at boot + sudo update-rc.d $app_id defaults + + # Reload daemon + sudo service $app_id restart + +fi + + +# Remove trailing "/" for next commands +app_path=${app_path%/} + +# Configure Nginx +sudo sed -i "s@IPTOCHANGE@$app_host@g" ../conf/nginx.conf +sudo sed -i "s@PORTTOCHANGE@$app_port@g" ../conf/nginx.conf +sudo sed -i "s@PATHTOCHANGE@$app_path@g" ../conf/nginx.conf +sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$app_domain.d/$app_id.conf + +# Store used IP for upgrades +sudo yunohost app setting $app_id host -v $app_host + +# Reload Nginx and regenerate SSOwat conf +sudo service nginx reload +echo $? +sudo yunohost app ssowatconf diff --git a/scripts/remove b/scripts/remove new file mode 100644 index 0000000..0eb5abb --- /dev/null +++ b/scripts/remove @@ -0,0 +1,42 @@ +#!/bin/bash + +# Set variables +app_id=couchpotato +app_user=couchpotato +app_install_dir=/opt/yunohost/$app_id +app_data_dir=/home/yunohost.app/$app_id +app_host=$(sudo yunohost app setting $app_id host) +app_domain=$(sudo yunohost app setting $app_id domain) + + +# Remove files if localhost installation +if [[ $app_host == "127.0.0.1" ]]; then + + # Kill App and remove from boot + sudo service $app_id stop + sudo killall $app_id + sudo update-rc.d $app_id remove + + # Delete App user + sudo deluser $app_user + + # Remove sources + sudo rm -rf $app_install_dir + + # Remove data + sudo rm -rf $app_data_dir + + # Remove daemon config + sudo rm -f /etc/init.d/$app_id + sudo rm -f /etc/default/$app_id + sudo rm -rf /var/run/$app_id + +fi + + +# Remove Nginx parameters +sudo rm -f /etc/nginx/conf.d/$app_domain.d/$app_id.conf + +# Reload Nginx and update Yunohost +sudo service nginx reload +sudo yunohost service remove $app_id \ No newline at end of file diff --git a/scripts/restore b/scripts/restore new file mode 100644 index 0000000..4db4383 --- /dev/null +++ b/scripts/restore @@ -0,0 +1,55 @@ +#!/bin/bash + +# Set variables +app_id=couchpotato +app_user=couchpotato +app_install_dir=/opt/yunohost/$app_id +app_data_dir=/home/yunohost.app/$app_id +app_host=$(sudo yunohost app setting $app_id host) +app_domain=$(sudo yunohost app setting $app_id domain) + +# The parameter $1 is the uncompressed restore directory location +app_backup_dir=$1/apps/$app_id + + +# Restore files if localhost installation +if [[ $app_host == "127.0.0.1" ]]; then + + # Kill App + sudo service $app_id stop + sudo killall $app_id + + # Restore sources + sudo cp -a $app_backup_dir/sources/. $app_install_dir + + # Restore data + sudo cp -a $app_backup_dir/data/. $app_data_dir + + # Restore daemon config + sudo cp -a $app_backup_dir/conf/$app_id.default /etc/default/$app_id + sudo cp -a $app_backup_dir/conf/$app_id.init /etc/init.d/$app_id + + # Set rights + sudo chown -R $app_user $app_install_dir + sudo chown -R $app_user $app_data_dir + sudo chmod +x /etc/init.d/$app_id + sudo chmod +x -R $app_install_dir + sudo chmod +x -R $app_data_dir + + # Start daemon at boot + sudo update-rc.d $app_id defaults + + # Reload daemon + sudo service $app_id restart + +fi + + +# Restore Nginx and YunoHost parameters +sudo cp -a $app_backup_dir/yunohost/. /etc/yunohost/apps/$app_id +sudo cp -a $app_backup_dir/nginx.conf /etc/nginx/conf.d/$app_domain.d/$app_id.conf + +# Reload Nginx and regenerate SSOwat conf +sudo service nginx reload +echo $? +sudo yunohost app ssowatconf \ No newline at end of file diff --git a/scripts/upgrade b/scripts/upgrade new file mode 100644 index 0000000..345c43e --- /dev/null +++ b/scripts/upgrade @@ -0,0 +1,39 @@ +#!/bin/bash + +# Set variables +app_id=couchpotato +app_user=couchpotato +app_install_dir=/opt/yunohost/$app_id +app_init_file=$app_install_dir/init/ubuntu +app_host=$(sudo yunohost app setting $app_id host) + +# Make upgrade if localhost installation +if [[ $app_host == "127.0.0.1" ]]; then + + # Kill App + sudo service $app_id stop + sudo killall $app_id + + # Upgrade to the latest version of App using the fork + cd $app_install_dir && sudo git pull + cd - + + # Upgrade dependencies + + # Update init file + sudo cp -a $app_init_file /etc/init.d/$app_id + + # Set rights + sudo chown -R $app_user $app_install_dir + sudo chmod +x /etc/init.d/$app_id + sudo chmod +x -R $app_install_dir + + # Reload daemon + sudo service $app_id restart + +fi + + +# Reload Nginx +sudo service nginx reload +