diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..dbbe355 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.markdown b/README.md similarity index 99% rename from README.markdown rename to README.md index a97b6c1..0347cf1 100644 --- a/README.markdown +++ b/README.md @@ -33,7 +33,7 @@ From command line: Infos ----- -Kanboard v1.0.41 +Kanboard v1.0.48 Yunohost forum thread: diff --git a/check_process b/check_process index 1b389c5..88a7a7e 100644 --- a/check_process +++ b/check_process @@ -4,7 +4,7 @@ domain="domain.tld" (DOMAIN) path="/path" (PATH) admin="john" (USER) - is_public="Yes" (PUBLIC|public=Yes|private=No) + is_public=1 (PUBLIC|public=1|private=0) ; Checks pkg_linter=1 setup_sub_dir=1 @@ -14,7 +14,7 @@ setup_public=1 upgrade=1 backup_restore=1 - multi_instance=0 + multi_instance=1 wrong_user=1 wrong_path=1 incorrect_path=1 diff --git a/conf/app.src b/conf/app.src new file mode 100644 index 0000000..8ee6638 --- /dev/null +++ b/conf/app.src @@ -0,0 +1,4 @@ +SOURCE_URL=https://github.com/kanboard/kanboard/releases/download/v1.0.48/kanboard-1.0.48.zip +SOURCE_SUM=a15f63f7582869fd9c777313bbb3cefbe3e4db34bae550b76e1e37d9c4b35a67 +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=zip diff --git a/conf/config.php b/conf/config.php index 211db4c..5269a5a 100644 --- a/conf/config.php +++ b/conf/config.php @@ -232,4 +232,4 @@ define('HTTP_PROXY_PASSWORD', ''); define('HTTP_VERIFY_SSL_CERTIFICATE', false); // TOTP (2FA) issuer name -define('TOTP_ISSUER', 'Kanboard'); \ No newline at end of file +define('TOTP_ISSUER', 'Kanboard'); diff --git a/conf/nginx.conf b/conf/nginx.conf index 79e17d0..45d88b9 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,25 +1,25 @@ -location PATHTOCHANGE { - alias ALIASTOCHANGE; - if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; - } - index index.php; - client_max_body_size 50M; - try_files $uri $uri/ /index.php?$args; +location __PATH__ { + alias __FINALPATH__/; + if ($scheme = http) { + rewrite ^ https://$server_name$request_uri? permanent; + } + index index.php; + client_max_body_size 50M; + try_files $uri $uri/ /index.php?$args; - # Override CSP header to make SSOWAT user panel compatible with kanboard - more_set_headers Content-Security-Policy "default-src 'self' 'unsafe-eval' data:;"; - - location ~ [^/]\.php(/|$) { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php5-fpm-NAMETOCHANGE.sock; - fastcgi_index index.php; - include fastcgi_params; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; - fastcgi_param SCRIPT_FILENAME $request_filename; - } + # Override CSP header to make SSOWAT user panel compatible with kanboard + more_set_headers Content-Security-Policy "default-src 'self' 'unsafe-eval' data:;"; - # Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; -} \ No newline at end of file + location ~ [^/]\.php(/|$) { + fastcgi_split_path_info ^(.+?\.php)(/.*)$; + fastcgi_pass unix:/var/run/php5-fpm-__NAME__.sock; + fastcgi_index index.php; + include fastcgi_params; + fastcgi_param REMOTE_USER $remote_user; + fastcgi_param PATH_INFO $fastcgi_path_info; + fastcgi_param SCRIPT_FILENAME $request_filename; + } + + # Include SSOWAT user panel. + include conf.d/yunohost_panel.conf.inc; +} diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf index 8b69b95..2a80b9b 100644 --- a/conf/php-fpm.conf +++ b/conf/php-fpm.conf @@ -1,6 +1,6 @@ -[#POOLNAME#] +[__NAMETOCHANGE__] ; The address on which to accept FastCGI requests. -listen = /var/run/php5-fpm-#POOLNAME#.sock +listen = /var/run/php5-fpm-__NAMETOCHANGE__.sock ; Set permissions for unix socket, if one is used. listen.owner = www-data @@ -8,8 +8,8 @@ listen.group = www-data listen.mode = 0600 ; Unix user/group of processes. -user = www-data -group = www-data +user = __USER__ +group = __USER__ ; Choose how the process manager will control the number of child processes. pm = dynamic @@ -47,7 +47,7 @@ request_terminate_timeout = 1d request_slowlog_timeout = 5s ; The log file for slow requests. -slowlog = /var/log/nginx/#POOLNAME#.slow.log +slowlog = /var/log/nginx/__NAMETOCHANGE__.slow.log ; Set open file descriptor rlimit. rlimit_files = 4096 @@ -56,7 +56,7 @@ rlimit_files = 4096 rlimit_core = 0 ; Chdir to this directory at the start. -chdir = #DESTDIR# +chdir = __FINALPATH__ ; Redirect worker stdout and stderr into main error log. catch_workers_output = yes @@ -69,3 +69,4 @@ php_value[upload_max_filesize] = 10G php_value[post_max_size] = 10G php_value[default_charset] = UTF-8 php_value[always_populate_raw_post_data] = -1 +php_value[session.save_path] = /var/www/__NAMETOCHANGE__/sessions diff --git a/manifest.json b/manifest.json index d38414a..6177e36 100644 --- a/manifest.json +++ b/manifest.json @@ -1,62 +1,61 @@ { - "name": "Kanboard", - "id": "kanboard", - "packaging_format": 1, - "description": { - "en": "Kanboard is a simple visual task board web application", - "fr": "Kanboard est une application web de management de tâches simples" - }, - "version": "1.0.41", - "url": "http://kanboard.net/", - "maintainer": { - "name": "mbugeia", - "email": "maxime@max.privy.place" - }, - "multi_instance": "false", - "services": [ - "nginx", - "php5-fpm", - "mysql" - ], - "arguments": { - "install" : [ - { - "name": "domain", - "ask": { - "en": "Choose a domain for Kanboard", - "fr": "Choisissez un domaine pour Kanboard" - }, - "example": "domain.org", - "type": "domain" - }, - { - "name": "path", - "ask": { - "en": "Choose a path for Kanboard", - "fr": "Choisissez un chemin pour Kanboard" - }, - "type": "path", - "example": "/kanboard", - "default": "/kanboard" - }, - { - "name": "admin", - "ask": { - "en": "Choose the admin user for Kanboard", - "fr": "Choisissez l'administrateur de Kanboard" - }, - "type": "user", - "example": "johndoe" - }, - { - "name": "is_public", - "ask": { - "en": "Is it a public site ?", - "fr": "Est-ce un site public ?" - }, - "choices": ["Yes", "No"], - "default": "No" - } - ] - } + "name": "Kanboard", + "id": "kanboard", + "packaging_format": 1, + "description": { + "en": "Kanboard is a simple visual task board web application" + }, + "version": "1.0.48", + "url": "https://kanboard.net/", + "license": "AGPL-3.0", + "requirements": { + "yunohost": ">= 2.7.0" + }, + "maintainer": { + "name": "mbugeia", + "email": "maxime@max.privy.place" + }, + "multi_instance": true, + "services": [ + "nginx", + "php5-fpm", + "mysql" + ], + "arguments": { + "install": [ + { + "name": "domain", + "ask": { + "en": "Choose a domain for Kanboard" + }, + "example": "domain.org", + "type": "domain" + }, + { + "name": "path", + "ask": { + "en": "Choose a path for Kanboard" + }, + "type": "path", + "example": "/kanboard", + "default": "/kanboard" + }, + { + "name": "admin", + "ask": { + "en": "Choose the admin user for Kanboard" + }, + "type": "user", + "example": "johndoe" + }, + { + "name": "is_public", + "ask": { + "en": "Is it a public site ?" + }, + "type": "boolean", + "default": "0" + } + ] + } } diff --git a/scripts/_common.sh b/scripts/_common.sh index 8d9086b..e1c9af8 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,28 +1,5 @@ +#!/bin/bash # # Common variables # -# Application version -VERSION="1.0.41" - -# Remote URL to fetch application source archive -APPLICATION_SOURCE_URL="https://kanboard.net/kanboard-${VERSION}.zip" - -# -# Common helpers -# - -# Download and extract application sources to the given directory -# usage: extract_application_to DESTDIR -extract_application() { - local DESTDIR=$1 - TMPDIR=$(mktemp -d) - chmod 755 $TMPDIR - archive="${TMPDIR}/application.zip" - wget -q -O "$archive" "$APPLICATION_SOURCE_URL" \ - || ynh_die "Unable to download application archive" - unzip -qq "$archive" -d "$TMPDIR" \ - || ynh_die "Unable to extract application archive" - rm "$archive" - sudo rsync -a "$TMPDIR"/*/* "$DESTDIR" -} diff --git a/scripts/backup b/scripts/backup index bdbe28f..4ff3af0 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,28 +1,62 @@ #!/bin/bash -set -eu +#================================================= +# GENERIC START +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -app="kanboard" +if [ ! -e _common.sh ]; then + # Get the _common.sh file if it's not in the current directory + cp ../settings/scripts/_common.sh ./_common.sh + chmod a+rx _common.sh +fi +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= + +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME # Set app specific variables dbname=$app -dbuser=$app - -# Source app helpers -source /usr/share/yunohost/helpers # Retrieve app settings domain=$(ynh_app_setting_get "$app" domain) -dbpass=$(ynh_app_setting_get "$app" mysqlpwd) +final_path=$(ynh_app_setting_get "$app" final_path) + +#================================================= +# STANDARD BACKUP STEPS +#================================================= +# BACKUP THE APP MAIN DIR +#================================================= # Copy the app source files -DESTDIR="/var/www/$app" -ynh_backup "$DESTDIR" "www" +ynh_backup "$final_path" -# Copy the conf files -mkdir ./conf -ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" "conf/nginx.conf" -ynh_backup "/etc/php5/fpm/pool.d/${app}.conf" "conf/php-fpm.conf" +#================================================= +# BACKUP THE NGINX CONFIGURATION +#================================================= -# Dump the database -mysqldump -u "$dbuser" -p"$dbpass" --no-create-db "$dbname" > ./db.sql +ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" + +#================================================= +# BACKUP THE PHP-FPM CONFIGURATION +#================================================= + +ynh_backup "/etc/php5/fpm/pool.d/${app}.conf" + +#================================================= +# BACKUP THE MYSQL DATABASE +#================================================= + +ynh_mysql_dump_db "$dbname" > ./db.sql diff --git a/scripts/install b/scripts/install index c1cc5d0..057a26d 100644 --- a/scripts/install +++ b/scripts/install @@ -1,38 +1,72 @@ #!/bin/bash -set -eu +#================================================= +# GENERIC START +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -app="kanboard" - -# Source local helpers -source ./_common.sh - -# Source app helpers +source _common.sh source /usr/share/yunohost/helpers +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= + +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + +#================================================= +# RETRIEVE ARGUMENTS FROM THE MANIFEST +#================================================= + # Retrieve arguments -domain=$1 -path=$2 -admin=$3 -is_public=$4 +domain=$YNH_APP_ARG_DOMAIN +path_url=$YNH_APP_ARG_PATH +admin=$YNH_APP_ARG_ADMIN +is_public=$YNH_APP_ARG_IS_PUBLIC -# TODO: Check domain/path availability with app helper -sudo yunohost app checkurl "${domain}${path}" -a "$app" \ - || ynh_die "The path ${domain}${path} is not available for app installation." +app=$YNH_APP_INSTANCE_NAME -# Check user parameter -ynh_user_exists "$admin" \ - || ynh_die "The chosen admin user does not exist." -ynh_app_setting_set $app admin_user $admin - -# Retrieve admin email -email=$(sudo yunohost user info $admin | grep mail: | sed "s/mail: //g") +#================================================= +# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS +#================================================= # Check destination directory -DESTDIR="/var/www/$app" -[[ -d $DESTDIR ]] && ynh_die \ -"The destination directory '$DESTDIR' already exists.\ - You should safely delete it before installing this app." +final_path="/var/www/$app" +test ! -e "$final_path" || ynh_die "This path already contains a folder" + +# Normalize the url path syntax +path_url=$(ynh_normalize_url_path "$path_url") + +# Check web path availability +ynh_webpath_available "$domain" "$path_url" +# Register (book) web path +ynh_webpath_register "$app" "$domain" "$path_url" + +#================================================= +# STORE SETTINGS FROM MANIFEST +#================================================= + +ynh_app_setting_set "$app" domain "$domain" +ynh_app_setting_set "$app" final_path "$final_path" +ynh_app_setting_set "$app" adminusername "$admin" +ynh_app_setting_set "$app" is_public "$is_public" + + +#================================================= +# STANDARD MODIFICATIONS +#================================================= + +#================================================= +# INSTALL DEPENDENCIES +#================================================= + +ynh_install_app_dependencies php5-gd + +#================================================= +# CREATE A MYSQL DATABASE +#================================================ # Generate random password dbpass=$(ynh_string_random) @@ -41,52 +75,98 @@ dbuser=$app # Initialize database and store mysql password for upgrade ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass" -ynh_app_setting_set $app mysqlpwd $dbpass -ynh_app_setting_set $app adminusername $admin -ynh_app_setting_set $app is_public $is_public +ynh_app_setting_set "$app" mysqlpwd "$dbpass" -extract_application "$DESTDIR" +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= + +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source "$final_path" +mkdir -p "$final_path"/sessions/ + +#================================================= +# NGINX CONFIGURATION +#================================================= + +ynh_add_nginx_config + +#================================================= +# CREATE DEDICATED USER +#================================================= + +# Create a system user +ynh_system_user_create "$app" + +#================================================= +# PHP-FPM CONFIGURATION +#================================================= + +ynh_add_fpm_config + +#================================================= +# SPECIFIC SETUP +#================================================= +# Create config.php +#================================================= + +# Retrieve admin email +email=$(ynh_user_get_info "$admin" mail) # Copy and edit config.php -sudo cp ../conf/config.php ${DESTDIR} -sudo sed -i "s/yuno_dbpdw/${dbpass}/g" ${DESTDIR}/config.php -sudo sed -i "s/yuno_dbuser/${dbuser}/g" ${DESTDIR}/config.php -sudo sed -i "s/yuno_admin/${admin}/g" ${DESTDIR}/config.php -sudo sed -i "s/yuno_email/${email}/g" ${DESTDIR}/config.php -sudo sed -i "s/yuno_domain/${domain}/g" ${DESTDIR}/config.php +config_php="${final_path}/config.php" -# Set permissions to kanboard and data directory -sudo chown -R root:root ${DESTDIR} -sudo chown -R www-data ${DESTDIR}/{data,plugins} +cp ../conf/config.php "$config_php" +ynh_replace_string "yuno_dbpdw" "$dbpass" "$config_php" +ynh_replace_string "yuno_dbuser" "$dbuser" "$config_php" +ynh_replace_string "yuno_admin" "$admin" "$config_php" +ynh_replace_string "yuno_email" "$email" "$config_php" +ynh_replace_string "yuno_domain" "$domain" "$config_php" -# Copy and set php-fpm configuration -phpfpm_conf="/etc/php5/fpm/pool.d/${app}.conf" -sed -i "s@#POOLNAME#@${app}@g" ../conf/php-fpm.conf -sed -i "s@#DESTDIR#@${DESTDIR}/@g" ../conf/php-fpm.conf -sudo cp ../conf/php-fpm.conf "$phpfpm_conf" -sudo chown root: $phpfpm_conf -sudo chmod 644 $phpfpm_conf - -# Modify Nginx configuration file and copy it to Nginx conf directory -sed -i "s@NAMETOCHANGE@${app}@g" ../conf/nginx.conf* -sed -i "s@PATHTOCHANGE@${path}@g" ../conf/nginx.conf* -sed -i "s@ALIASTOCHANGE@${DESTDIR}/@g" ../conf/nginx.conf* -sudo cp ../conf/nginx.conf /etc/nginx/conf.d/${domain}.d/${app}.conf - -# Make app public or private -if [ "$is_public" = "Yes" ]; -then - sudo yunohost app setting ${app} unprotected_uris -v "/" - sudo sed -i "s/define('LDAP_AUTH'.*$/define('LDAP_AUTH', true);/g" ${DESTDIR}/config.php - sudo sed -i "s/define('HIDE_LOGIN_FORM'.*$/define('HIDE_LOGIN_FORM', false);/g" ${DESTDIR}/config.php - sudo sed -i "s/define('REMEMBER_ME_AUTH'.*$/define('REMEMBER_ME_AUTH', true);/g" ${DESTDIR}/config.php - sudo sed -i "s/define('DISABLE_LOGOUT'.*$/define('DISABLE_LOGOUT', false);/g" ${DESTDIR}/config.php -fi +#================================================= +# Database initialization +#================================================= # Init database -#sudo chmod o+x ${DESTDIR} ${DESTDIR}/app/ ${DESTDIR}/app/Schema/ ${DESTDIR}/app/Schema/Sql -ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < ${DESTDIR}/app/Schema/Sql/mysql.sql +ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < "${final_path}/app/Schema/Sql/mysql.sql" + +#================================================= +# GENERIC FINALIZATION +#================================================= +# SECURE FILES AND DIRECTORIES +#================================================ + +# Set permissions to kanboard and data directory +chown -R root:root "$final_path" +chown -R "$app" "$final_path"/{data,plugins,sessions} +chmod -R 700 "$final_path"/sessions + +#================================================= +# SETUP SSOWAT +#================================================= + +if [[ "$path_url" == "/" ]] +then + # ynh panel is only comptable with non-root installation + ynh_replace_string " include conf.d/" " #include conf.d/" "$finalnginxconf" + + ynh_store_file_checksum "$finalnginxconf" +fi + +# Make app public or private +if [[ "$is_public" -eq 1 ]]; +then + ynh_app_setting_set "$app" unprotected_uris "/" + ynh_replace_string "define('LDAP_AUTH'.*$" "define('LDAP_AUTH', true);" "$config_php" + ynh_replace_string "define('HIDE_LOGIN_FORM'.*$" "define('HIDE_LOGIN_FORM', false);" "$config_php" + ynh_replace_string "define('REMEMBER_ME_AUTH'.*$" "define('REMEMBER_ME_AUTH', true);" "$config_php" + ynh_replace_string "define('DISABLE_LOGOUT'.*$" "define('DISABLE_LOGOUT', false);" "$config_php" +fi + +#================================================= +# RELOAD NGINX & PHP5-FPM +#================================================= # Reload services -sudo service php5-fpm restart || true -sudo service nginx reload || true +service php5-fpm restart +service nginx reload diff --git a/scripts/remove b/scripts/remove index bba4394..06959c0 100644 --- a/scripts/remove +++ b/scripts/remove @@ -1,25 +1,55 @@ #!/bin/bash -app="kanboard" +#================================================= +# GENERIC START +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME + +domain=$(ynh_app_setting_get "$app" domain) +final_path=$(ynh_app_setting_get "$app" final_path) dbname=$app dbuser=$app -# Source app helpers -source /usr/share/yunohost/helpers +#================================================= +# REMOVE DEPENDENCIES +#================================================= -# Drop MySQL database and user -ynh_mysql_drop_db "$dbname" 2>/dev/null || true -ynh_mysql_drop_user "$dbuser" 2>/dev/null || true +# Remove metapackage and its dependencies +ynh_remove_app_dependencies -# Retrieve domain from app settings -domain=$(ynh_app_setting_get "$app" domain) +#================================================= +# REMOVE THE MYSQL DATABASE +#================================================= -# Delete app directory and configurations -sudo rm -rf "/var/www/${app}" -sudo rm -f "/etc/php5/fpm/pool.d/${app}.conf" -[[ -n $domain ]] && sudo rm -f "/etc/nginx/conf.d/${domain}.d/${app}.conf" +# Remove a database if it exists, along with the associated user +ynh_mysql_remove_db "$dbuser" "$dbname" -# Reload services -sudo service php5-fpm restart || true -sudo service nginx reload || true +#================================================= +# REMOVE APP MAIN DIR +#================================================= + +ynh_secure_remove "$final_path" + +#================================================= +# REMOVE NGINX CONFIGURATION +#================================================= + +# Remove the dedicated nginx config +ynh_remove_nginx_config + +#================================================= +# REMOVE PHP-FPM CONFIGURATION +#================================================= + +ynh_remove_fpm_config diff --git a/scripts/restore b/scripts/restore index 18f89db..f7be894 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,56 +1,107 @@ #!/bin/bash -set -eu +#================================================= +# GENERIC START +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -app="kanboard" +if [ ! -e _common.sh ]; then + # Get the _common.sh file if it's not in the current directory + cp ../settings/scripts/_common.sh ./_common.sh + chmod a+rx _common.sh +fi +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= + +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + + +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME # Set app specific variables dbname=$app dbuser=$app -# Source app helpers -source /usr/share/yunohost/helpers - # Retrieve old app settings domain=$(ynh_app_setting_get "$app" domain) -path=$(ynh_app_setting_get "$app" path) +path_url=$(ynh_app_setting_get "$app" path) dbpass=$(ynh_app_setting_get "$app" mysqlpwd) +final_path=$(ynh_app_setting_get "$app" final_path) -# TODO: Check domain/path availability with app helper -sudo yunohost app checkurl "${domain}${path}" -a "$app" \ - || ynh_die "The path ${domain}${path} is not available for app installation." +#================================================= +# CHECK IF THE APP CAN BE RESTORED +#================================================= -# Check destination directory -DESTDIR="/var/www/$app" -[[ -d $DESTDIR ]] && ynh_die \ -"The destination directory '$DESTDIR' already exists.\ - You should safely delete it before restoring this app." +ynh_webpath_available $domain $path_url \ + || ynh_die "Path not available: ${domain}${path_url}" -# Check configuration files -nginx_conf="/etc/nginx/conf.d/${domain}.d/${app}.conf" -[[ -f $nginx_conf ]] && ynh_die \ -"The NGINX configuration already exists at '${nginx_conf}'. -You should safely delete it before restoring this app." -phpfpm_conf="/etc/php5/fpm/pool.d/${app}.conf" -[[ -f $phpfpm_conf ]] && ynh_die \ -"The PHP FPM configuration already exists at '${phpfpm_conf}'. -You should safely delete it before restoring this app." +test ! -d $final_path \ +|| ynh_die "There is already a directory: $final_path " + +#================================================= +# STANDARD RESTORATION STEPS +#================================================= +# REINSTALL DEPENDENCIES +#================================================= + +# Define and install dependencies +ynh_install_app_dependencies php5-gd + +#================================================= +# RESTORE THE NGINX CONFIGURATION +#================================================= + +ynh_restore_file "/etc/nginx/conf.d/${domain}.d/${app}.conf" + +#================================================= +# RESTORE THE APP MAIN DIR +#================================================= # Restore the app files -sudo cp -a ./www "$DESTDIR" +ynh_restore_file "$final_path" -# Create and restore the database -ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass" +#================================================= +# RESTORE THE MYSQL DATABASE +#================================================= + +ynh_mysql_setup_db "$dbuser" "$dbname" "$dbpass" ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < ./db.sql -# Restore permissions -sudo chown -R root:root "$DESTDIR" -sudo chown -R www-data ${DESTDIR}/{data,plugins} +#================================================= +# RECREATE THE DEDICATED USER +#================================================= -# Restore configuration files -sudo cp -a ./conf/nginx.conf "$nginx_conf" -sudo cp -a ./conf/php-fpm.conf "$phpfpm_conf" +# Create the dedicated user (if not existing) +ynh_system_user_create "$app" -# Reload services -sudo service php5-fpm restart || true -sudo service nginx reload || true +#================================================= +# RESTORE USER RIGHTS +#================================================= + +chown -R root:root "$final_path" +chown -R "$app" "$final_path"/{data,plugins} + +#================================================= +# RESTORE THE PHP-FPM CONFIGURATION +#================================================= + +ynh_restore_file "/etc/php5/fpm/pool.d/${app}.conf" + +#================================================= +# GENERIC FINALIZATION +#================================================= +# RELOAD NGINX AND PHP-FPM +#================================================= + +service php5-fpm restart +service nginx reload diff --git a/scripts/upgrade b/scripts/upgrade index f0f8bde..33ced7a 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,98 +1,185 @@ #!/bin/bash -set -eu +#================================================= +# GENERIC START +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -app="kanboard" +source _common.sh +source /usr/share/yunohost/helpers -# Source local helpers -source ./_common.sh +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= + +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + +#================================================= +# RETRIEVE ARGUMENTS FROM THE MANIFEST +#================================================= + +app=$YNH_APP_INSTANCE_NAME # Set app specific variables -dbname=$app dbuser=$app -# Source app helpers -source /usr/share/yunohost/helpers - # Retrieve settings domain=$(ynh_app_setting_get "$app" domain) -path=$(ynh_app_setting_get "$app" path) +path_url=$(ynh_app_setting_get "$app" path) admin=$(ynh_app_setting_get "$app" adminusername) -email=$(sudo yunohost user info $admin | grep mail: | sed "s/mail: //g") +email=$(ynh_user_get_info "$admin" mail) dbpass=$(ynh_app_setting_get "$app" mysqlpwd) is_public=$(ynh_app_setting_get "$app" is_public) -if [ -z $is_public ] +final_path=$(ynh_app_setting_get "$app" final_path) + +if [[ -z "$is_public" ]] then # Old version doesnt have is_public settings - is_public=No - ynh_app_setting_set $app is_public $is_public + is_public=0 + ynh_app_setting_set "$app" is_public "$is_public" fi -# Check destination directory -DESTDIR="/var/www/$app" -[[ ! -d $DESTDIR ]] && ynh_die \ -"The destination directory '$DESTDIR' does not exist.\ - The app is not correctly installed, you should remove it first." +# Fix is_public as a boolean value +if [ "$is_public" = "Yes" ]; then + ynh_app_setting_set "$app" is_public 1 + is_public=1 +elif [ "$is_public" = "No" ]; then + ynh_app_setting_set "$app" is_public 0 + is_public=0 +fi -# flush php sessions before upgrade -sudo rm -rf /var/lib/php5/session/* +# If final_path doesn't exist, create it +if [[ -z "$final_path" ]] +then + final_path="/var/www/$app" + ynh_app_setting_set "$app" final_path "$final_path" +fi + +#================================================= +# CHECK THE PATH +#================================================= + +# Normalize the URL path syntax +path_url=$(ynh_normalize_url_path $path_url) + +# Backup the current version of the app +ynh_backup_before_upgrade +ynh_clean_setup () { + # restore it if the upgrade fails + ynh_restore_upgradebackup +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + +#================================================= +# STANDARD UPGRADE STEPS +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= # Move old app dir -sudo mv ${DESTDIR} ${DESTDIR}.old +mv "$final_path" "$final_path.old" -extract_application "$DESTDIR" +ynh_setup_source "$final_path" +mkdir -p "$final_path"/sessions # restore data -sudo cp -a ${DESTDIR}.old/data ${DESTDIR} +cp -a "$final_path.old/data" "$final_path" # restore plugins -if [ -e ${DESTDIR}.old/plugins ] +if [ -e "$final_path.old/plugins" ] then - sudo cp -a ${DESTDIR}.old/plugins ${DESTDIR} + cp -a "$final_path.old/plugins" "$final_path" fi # delete temp directory -sudo rm -Rf ${DESTDIR}.old +ynh_secure_remove "$final_path.old" + +#================================================= +# NGINX CONFIGURATION +#================================================= + +# Create a dedicated nginx config +ynh_add_nginx_config + +#================================================= +# CREATE DEDICATED USER +#================================================= + +# Create a system user +ynh_system_user_create "$app" + +#================================================= +# PHP-FPM CONFIGURATION +#================================================= + +# Create a dedicated php-fpm config +ynh_add_fpm_config + +#================================================= +# SPECIFIC UPGRADE +#================================================= +# Create config.php +#================================================= # Copy and edit config.php -sudo cp ../conf/config.php ${DESTDIR} -sudo sed -i "s/yuno_dbpdw/${dbpass}/g" ${DESTDIR}/config.php -sudo sed -i "s/yuno_dbuser/${dbuser}/g" ${DESTDIR}/config.php -sudo sed -i "s/yuno_admin/${admin}/g" ${DESTDIR}/config.php -sudo sed -i "s/yuno_email/${email}/g" ${DESTDIR}/config.php -sudo sed -i "s/yuno_domain/${domain}/g" ${DESTDIR}/config.php +config_php="$final_path/config.php" +cp ../conf/config.php "$config_php" + +ynh_replace_string "yuno_dbpdw" "$dbpass" "$config_php" +ynh_replace_string "yuno_dbuser" "$dbuser" "$config_php" +ynh_replace_string "yuno_admin" "$admin" "$config_php" +ynh_replace_string "yuno_email" "$email" "$config_php" +ynh_replace_string "yuno_domain" "$domain" "$config_php" + +#================================================= +# Database initialization +#================================================= + +( + cd "$final_path" + # Launch database migratio + php cli db:migrate --no-interaction --verbose + # Launch plugins migration + php cli plugin:upgrade --no-interaction --verbose +) + +#================================================= +# GENERIC FINALIZATION +#================================================= +# SECURE FILES AND DIRECTORIES +#================================================= # Set permissions to kanboard and data directory -sudo chown -R root:root ${DESTDIR} -sudo chown -R www-data ${DESTDIR}/{data,plugins} +chown -R root:root "$final_path" +chown -R "$app" "$final_path"/{data,plugins,sessions} +chmod -R 700 "$final_path"/sessions -# Launch database migration -sudo ${DESTDIR}/cli db:migrate +#================================================= +# SETUP SSOWAT +#================================================= -# Copy and set php-fpm configuration -phpfpm_conf="/etc/php5/fpm/pool.d/${app}.conf" -sed -i "s@#USER#@${app}@g" ../conf/php-fpm.conf -sed -i "s@#GROUP#@${app}@g" ../conf/php-fpm.conf -sed -i "s@#POOLNAME#@${app}@g" ../conf/php-fpm.conf -sed -i "s@#DESTDIR#@${DESTDIR}/@g" ../conf/php-fpm.conf -sudo cp ../conf/php-fpm.conf "$phpfpm_conf" -sudo chown root: $phpfpm_conf -sudo chmod 644 $phpfpm_conf - -# Modify Nginx configuration file and copy it to Nginx conf directory -sed -i "s@NAMETOCHANGE@${app}@g" ../conf/nginx.conf* -sed -i "s@PATHTOCHANGE@${path}@g" ../conf/nginx.conf* -sed -i "s@ALIASTOCHANGE@${DESTDIR}/@g" ../conf/nginx.conf* -sudo cp ../conf/nginx.conf /etc/nginx/conf.d/${domain}.d/${app}.conf - -# Make app public or private -if [ "$is_public" = "Yes" ]; +if [[ "$path_url" == "/" ]] then - sudo yunohost app setting ${app} unprotected_uris -v "/" - sudo sed -i "s/define('LDAP_AUTH'.*$/define('LDAP_AUTH', true);/g" ${DESTDIR}/config.php - sudo sed -i "s/define('HIDE_LOGIN_FORM'.*$/define('HIDE_LOGIN_FORM', false);/g" ${DESTDIR}/config.php - sudo sed -i "s/define('REMEMBER_ME_AUTH'.*$/define('REMEMBER_ME_AUTH', true);/g" ${DESTDIR}/config.php - sudo sed -i "s/define('DISABLE_LOGOUT'.*$/define('DISABLE_LOGOUT', false);/g" ${DESTDIR}/config.php + # ynh panel is only comptable with non-root installation + ynh_replace_string " include conf.d/" " #include conf.d/" "$finalnginxconf" + + ynh_store_file_checksum "$finalnginxconf" fi -# Reload services -sudo service php5-fpm restart || true -sudo service nginx reload || true +# Make app public or private +if [[ "$is_public" -eq 1 ]]; +then + ynh_app_setting_set "$app" unprotected_uris "/" + ynh_replace_string "define('LDAP_AUTH'.*$" "define('LDAP_AUTH', true);" "$config_php" + ynh_replace_string "define('HIDE_LOGIN_FORM'.*$" "define('HIDE_LOGIN_FORM', false);" "$config_php" + ynh_replace_string "define('REMEMBER_ME_AUTH'.*$" "define('REMEMBER_ME_AUTH', true);" "$config_php" + ynh_replace_string "define('DISABLE_LOGOUT'.*$" "define('DISABLE_LOGOUT', false);" "$config_php" +fi + +#================================================= +# RELOAD NGINX +#================================================= + +service php5-fpm restart +systemctl reload nginx