diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6bb5339 --- /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.md b/README.md index 8deb0e7..8ff65e4 100644 --- a/README.md +++ b/README.md @@ -22,42 +22,22 @@ https://example.com/odoo/ will NOT work What does not work ------------------ -- Automatic database creation (experimental) - Backup and restore via Odoo (works with a trick shared on the Github) -- Backup and restore via YunoHost -- Automatic LDAP configuration Still to do ----------- -- Automatic LDAP setup + emails -- Backup/restore via Odoo fix -- Backup/restore via YunoHost -- SMTP settings +See the project here : https://github.com/YunoHost-Apps/odoo_ynh/projects/1 Configuration ------------- -**Create the database manually** -- The database must be named "*subdomain-domain-tld*" (for example *erp-test-com* if you access the database via *erp.test.com* - -**Setup LDAP** -- Create a user named "template" with email "template". This user will give its permissions by default to YunoHost users so you can also give it appropriate permissions. -- In "Edit Company Data" (on the logo), go to "Configuration" and add a LDAP setting -- LDAP Address: localhost -- LDAP Port: 389 -- LDAP Base: ou=users, dc=yunohost,dc=org -- LDAP filter: uid=%s -- Template user: template -- Save **Backup via Odoo** -- In YunoHost, open the port 8069 -- Access Odoo via your server's IP or URL via *:8069* at the end +- Access Odoo - Go to manage databases and backup **Restore via Odoo** -- In YunoHost, open the port 8069 (if you haven't opened it already) -- Access Odoo via your server's IP or URL via *:8069* at the end +- Access Odoo - Go to manage databases and delete the old database - Restore - **Important!** The database must be named "*subdomain-domain-tld*" (for example *erp-test-com* if you access the database via *erp.test.com* diff --git a/check_process b/check_process new file mode 100644 index 0000000..594f369 --- /dev/null +++ b/check_process @@ -0,0 +1,37 @@ +;; Test complet sans multisite + auto_remove=1 + ; Manifest + domain="domain.tld" (DOMAIN) + version="10.0" + oca=0 + admin_password="testpassw0rD" + lang="en_US" + tz="Europe/Paris" + ; Checks + pkg_linter=1 + setup_sub_dir=0 + setup_root=1 + setup_nourl=0 + setup_private=0 + setup_public=1 + upgrade=1 + backup_restore=1 + multi_instance=1 + wrong_user=0 + wrong_path=0 + incorrect_path=0 + corrupt_source=1 + fail_download_source=1 + port_already_use=1 + final_path_already_use=0 +;;; Levels + Level 1=auto + Level 2=auto + Level 3=auto + Level 4=0 + Level 5=auto + Level 6=auto + Level 7=auto + Level 8=0 + Level 9=0 + Level 10=0 diff --git a/conf/app.src b/conf/app.src new file mode 100644 index 0000000..62eab80 --- /dev/null +++ b/conf/app.src @@ -0,0 +1,5 @@ +SOURCE_URL=https://downloads.wkhtmltopdf.org/0.12/0.12.4/wkhtmltox-0.12.4_linux-generic-amd64.tar.xz +SOURCE_SUM=049b2cdec9a8254f0ef8ac273afaf54f7e25459a273e27189591edc7d7cf29db +SOURCE_FILE=wkhtmltox-0.12.4_linux-generic-amd64.tar.xz +SOURCE_FORMAT=tar.xz +SOURCE_SUM_PRG=sha256sum diff --git a/conf/install_database.py b/conf/install_database.py deleted file mode 100644 index 80dd07d..0000000 --- a/conf/install_database.py +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/python -import oerplib -oerp = oerplib.OERP(server='localhost', protocol='xmlrpc', port=8069) -oerp.db.create_database('ADMIN_PASSWORD', 'DOMAIN_DATABASE', False, 'DATABASE_LANG', 'DATABASE_PASSWORD') \ No newline at end of file diff --git a/conf/nginx.conf b/conf/nginx.conf deleted file mode 100644 index 64aa12f..0000000 --- a/conf/nginx.conf +++ /dev/null @@ -1,13 +0,0 @@ -location / { - proxy_pass http://127.0.0.1:8069/; - proxy_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504; - proxy_buffers 16 64k; - proxy_buffer_size 128k; - proxy_redirect off; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Host $server_name; - proxy_read_timeout 999999999; -} \ No newline at end of file diff --git a/conf/nginx.conf.j2 b/conf/nginx.conf.j2 new file mode 100644 index 0000000..623dce2 --- /dev/null +++ b/conf/nginx.conf.j2 @@ -0,0 +1,19 @@ +location / { + if ($scheme = http) { + rewrite ^ https://$server_name$request_uri? permanent; + } + try_files $uri @{{ app }}; +} +location @{{ app }} { + proxy_pass http://127.0.0.1:{{ port }}; + proxy_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504; + proxy_buffers 16 64k; + proxy_buffer_size 128k; + proxy_redirect off; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Host $server_name; + proxy_read_timeout 999999999; +} diff --git a/conf/openerp-server.conf b/conf/openerp-server.conf.j2 similarity index 56% rename from conf/openerp-server.conf rename to conf/openerp-server.conf.j2 index f6b8a4a..742a9e5 100644 --- a/conf/openerp-server.conf +++ b/conf/openerp-server.conf.j2 @@ -1,11 +1,11 @@ [options] ; This is the password that allows database operations: without_demo = all -admin_passwd = ADMIN_PASSWORD +admin_passwd = {{ admin_password }} db_host = false db_port = false db_user = odoo -db_password = DATABASE_PASSWORD -addons_path = /usr/lib/python2.7/dist-packages/openerp/addons +db_password = {{ dbpass }} +addons_path = {{ source_path }}addons proxy_mode = true dbfilter = %h diff --git a/manifest.json b/manifest.json index 2804d0b..e1e4fb1 100644 --- a/manifest.json +++ b/manifest.json @@ -1,64 +1,74 @@ { - "name": "Odoo", - "id": "odoo", - "packaging_format": 1, - "description": { - "en": "Odoo is a suite of business apps (ERP: CRM, Accounting, Point of Sale, HR, Purchases...).", - "fr": "Odoo est une collection d'apps de gestion d'entreprise (ERP : CRM, Comptabilité, Point de Vente, RH, Achats, ...)." - }, - "developer": { - "name": "scith" - }, - "requirements": { - "yunohost": ">= 2.4.0" - }, - "multi_instance": "true", - "services": [ - "nginx" - ], - "arguments": { - "install" : [ - { - "name": "domain", - "type": "domain", - "ask": { - "en": "Choose a domain for Odoo (Odoo will be installed on its root!)", - "fr": "Choisissez un domaine pour Odoo (Odoo sera installé dans sa racine !)" - }, - "example": "odoo.domain.org" - }, - { - "name": "odoo_version", - "ask": { - "en": "Which version of Odoo do you want to install?", - "fr": "Quelle version d'Odoo souhaitez-vous installer ?" - }, - "choices": ["8.0", "9.0"], - "default": "8.0" - }, - { - "name": "admin_password", - "ask": { - "en": "Choose a strong master admin password", - "fr": "Choisissez un mot de passe maître fort pour l'administration" - } - }, - { - "name": "database_password", - "ask": { - "en": "Choose a password for the 'admin' account on Odoo", - "fr": "Choisissez un mot de passe pour le compte 'admin' d'Odoo" - } - }, - { - "name": "lang", - "ask": { - "en": "Choose a language for Odoo", - "fr": "Choisissez une langue pour Odoo" - }, - "choices": ["en_US", "fr_FR", "de_DE"], - "default": "en_US" - } - ] - } + "name": "Odoo", + "id": "odoo", + "packaging_format": 1, + "description": { + "en": "Odoo is a suite of business apps (ERP: CRM, Accounting, Point of Sale, HR, Purchases...).", + "fr": "Odoo est une collection d'apps de gestion d'entreprise (ERP : CRM, Comptabilité, Point de Vente, RH, Achats, ...)." + }, + "maintainer": { + "name": "scith, ljf", + "email": "ljf+yunohost@grimaud.me" + }, + "version": "10.0-1", + "url": "https://www.odoo.com", + "license": "LGPL-3.0", + "requirements": { + "yunohost": ">= 2.6.0" + }, + "multi_instance": true, + "services": [ + "nginx" + ], + "arguments": { + "install": [{ + "name": "domain", + "type": "domain", + "ask": { + "en": "Choose a domain for Odoo (Odoo will be installed on its root!)", + "fr": "Choisissez un domaine pour Odoo (Odoo sera installé dans sa racine !)" + }, + "example": "odoo.domain.org" + }, { + "name": "version", + "ask": { + "en": "Which version of Odoo do you want to install?", + "fr": "Quelle version d'Odoo souhaitez-vous installer ?" + }, + "choices": ["8.0", "9.0", "10.0"], + "default": "9.0" + }, { + "name": "oca", + "type": "boolean", + "ask": { + "en": "Use OCA repository to get community bugfixes ?", + "fr": "Utiliser les dépots OCA pour bénéficier des bugfix communautaires ?" + }, + "default": false + }, { + "name": "admin_password", + "type": "password", + "ask": { + "en": "Choose a strong master admin password", + "fr": "Choisissez un mot de passe maître fort pour l'administration" + } + }, { + "name": "lang", + "ask": { + "en": "Choose a language for Odoo", + "fr": "Choisissez une langue pour Odoo" + }, + "choices": ["sq_AL", "am_ET", "ar_SY", "eu_ES", "bs_BA", "bg_BG", "my_MM", "ca_ES", "zh_CN", "zh_HK", "zh_TW", "hr_HR", "cs_CZ", "da_DK", "nl_BE", "nl_NL", "en_AU", "en_GB", "en_US", "et_EE", "fi_FI", "fr_BE", "fr_CA", "fr_CH", "fr_FR", "gl_ES", "ka_GE", "de_CH", "de_DE", "el_GR", "gu_IN", "he_IL", "hi_IN", "hu_HU", "id_ID", "it_IT", "ja_JP", "kab_DZ", "ko_KP", "ko_KR", "lo_LA", "lv_LV", "lt_LT", "mk_MK", "mn_MN", "nb_NO", "fa_IR", "pl_PL", "pt_BR", "pt_PT", "ro_RO", "ru_RU", "sr_RS", "sr@latin", "sk_SK", "sl_SI", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_GT", "es_MX", "es_PA", "es_PE", "es_PY", "es_UY", "es_VE", "es_ES", "sv_SE", "te_IN", "th_TH", "tr_TR", "uk_UA", "vi_VN"], + "default": "en_US" + }, { + "name": "tz", + "ask": { + "en": "Choose a time zone for Odoo", + "fr": "Choisissez un fuseau horaire pour Odoo" + }, + "choices": ["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/East-Saskatchewan","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Europe/Amsterdam","Europe/Andorra","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Pacific-New","US/Samoa","UTC","Universal","W-SU","WET","Zulu","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu", "Etc/Zulu"], + "default": "UTC", + "example": "Europe/Paris" + }] + } } diff --git a/scripts/_common.sh b/scripts/_common.sh new file mode 100644 index 0000000..2228359 --- /dev/null +++ b/scripts/_common.sh @@ -0,0 +1,124 @@ +# +# Common variables +# + +APPNAME="odoo" + +function define_paths() { + # In odoo 10 some file change + if [ $(echo "$odoo_version >= 10" | bc) -ne 0 ]; then + export source_path=/usr/lib/python2.7/dist-packages/odoo/ + conf_file=/etc/odoo/odoo.conf + bin_file=/usr/bin/odoo + else + export source_path=/usr/lib/python2.7/dist-packages/openerp/ + conf_file=/etc/odoo/openerp-server.conf + bin_file=/usr/bin/openerp-server + fi +} + +function check_odoo_version () { + if [ $(echo "$odoo_version >= 10" | bc) -ne 0 ]; then + if [ -f /usr/bin/openerp-server ]; then + ynh_die "Another version of odoo is installed" + fi + else + if [ -f /usr/bin/odoo ]; then + ynh_die "Another version of odoo is installed" + fi + fi +} + +function define_is_master() { + if [ -f $bin_file ]; then + export is_master=false + else + export is_master=true + fi +} + +function define_port () { + if [ "$is_master" = true ]; then + export port=$(ynh_find_port 8069) + yunohost app checkport $port + if [[ ! $? -eq 0 ]]; then + ynh_die "Port 8069 unavailable" 1 + fi + else + # FIXME find master port + export port="8069" + fi +} + +function define_dbpass () { + # TODO set -x + if [ "$is_master" = true ]; then + # Generate random password + if [ "${1:-}" = "restore" ]; then + export dbpass=$(ynh_app_setting_get $app psqlpwd) + else + export dbpass=$(ynh_string_random) + fi + else + export dbpass=$(grep db_password /etc/odoo/odoo.conf | cut -d \= -f 2 | sed -e 's/^[ \t]*//') + fi + ynh_app_setting_set "$app" psqlpwd "$dbpass" +} + +# Install dependencies +function install_dependencies() { + if [ ! -f /etc/apt/sources.list.d/odoo.list ]; then + # Install Odoo + # Prepare installation + ynh_package_install curl + + # Install Odoo + curl -sS https://nightly.odoo.com/odoo.key | sudo apt-key add - + sh -c "echo 'deb http://nightly.odoo.com/${odoo_version}/nightly/deb/ ./' > /etc/apt/sources.list.d/odoo.list" + # TODO if 8.0 install https://www.odoo.com/apps/modules/8.0/shell/ + fi + + apt-get update + + ynh_install_app_dependencies curl postgresql odoo xfonts-75dpi xfonts-base wkhtmltopdf node-less python-xlrd + + if ! wkhtmltopdf --version | grep "wkhtmltopdf 0.12.4 (with patched qt)"; then + # The debian package has a bug so we deploy a more recent version + ynh_setup_source /usr/ + fi +} + + +# Create db +function create_general_db() { + service postgresql reload + if ! su -c "psql -lqt | cut -d \| -f 1 " - postgres | grep $APPNAME; then + # Generate random password + ynh_psql_execute_as_root "ALTER USER $APPNAME WITH CREATEDB;" + ynh_psql_execute_as_root "ALTER USER $APPNAME WITH PASSWORD '$dbpass';" + su -c "createdb -O $APPNAME $APPNAME" - postgres + fi +} + +# Add services +function add_services() { + if ! grep "^postgresql:$" /etc/yunohost/services.yml; then + yunohost service add postgresql + fi + if ! grep "^odoo:$" /etc/yunohost/services.yml; then + yunohost service add odoo --log /var/log/odoo/odoo-server.log + yunohost service stop odoo + yunohost service start odoo + fi +} + +function ssowat_and_restart() { + # Restart odoo service + service odoo restart + + # Configure SSOWat + ynh_sso_access "/web/database/manager" + + # Reload services + service nginx reload +} diff --git a/scripts/_future.sh b/scripts/_future.sh new file mode 100644 index 0000000..d68da67 --- /dev/null +++ b/scripts/_future.sh @@ -0,0 +1,205 @@ + +log() { + echo "${1}" +} + +info() { + log "[INFO] ${1}" +} + +warn() { + log "[WARN] ${1}" +} + +err() { + log "[ERR] ${1}" +} +ynh_check_var () { + test -n "$1" || ynh_die "$2" +} + +ynh_exit_properly () { + exit_code=$? + if [ "$exit_code" -eq 0 ]; then + exit 0 + fi + trap '' EXIT + set +eu + echo -e "\e[91m \e[1m" + err "$app script has encountered an error." + + if type -t CLEAN_SETUP > /dev/null; then + CLEAN_SETUP + fi + + ynh_die +} + +# Activate signal capture +# Exit if a command fail, and if a variable is used unset. +# Capturing exit signals on shell script +# +# example: CLEAN_SETUP () { +# # Clean residual file un remove by remove script +# } +# ynh_trap_on +ynh_trap_on () { + set -eu + trap ynh_exit_properly EXIT # Capturing exit signals on shell script +} + +ynh_export () { + local ynh_arg="" + for var in $@; + do + ynh_arg=$(echo $var | awk '{print toupper($0)}') + ynh_arg="YNH_APP_ARG_$ynh_arg" + export $var=${!ynh_arg} + done +} + +# Save listed var in YunoHost app settings +# usage: ynh_save_args VARNAME1 [VARNAME2 [...]] +ynh_save_args () { + for var in $@; + do + ynh_app_setting_set $app $var ${!var} + done +} + +ynh_sso_access () { + ynh_app_setting_set $app unprotected_uris "/" + + if [[ $is_public -eq 0 ]]; then + ynh_app_setting_set $app protected_uris "$1" + fi + sudo yunohost app ssowatconf +} +ynh_configure () { + local TEMPLATE=$1 + local DEST=$2 + type j2 2>/dev/null || sudo pip install j2cli + j2 "${YNH_CWD}/../conf/$TEMPLATE.j2" > "${YNH_CWD}/../conf/$TEMPLATE" + sudo cp "${YNH_CWD}/../conf/$TEMPLATE" "$DEST" +} + +ynh_configure_nginx () { + ynh_configure nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf + sudo service nginx reload +} +# Find a free port and return it +# +# example: port=$(ynh_find_port 8080) +# +# usage: ynh_find_port begin_port +# | arg: begin_port - port to start to search +ynh_find_port () { + port=$1 + test -n "$port" || ynh_die "The argument of ynh_find_port must be a valid port." + while netcat -z 127.0.0.1 $port # Check if the port is free + do + port=$((port+1)) # Else, pass to next port + done + echo $port +} + +ynh_rm_nginx_conf () { + if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then + sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf" + sudo service nginx reload + fi +} + + +ynh_secure_rm () { + [[ "/var/www /opt /home/yunohost.app" =~ $1 ]] \ + || (test -n "$1" && sudo rm -Rf $1 ) +} + +# Upgrade +ynh_read_json () { + python3 -c "import sys, json;print(json.load(open('$1'))['$2'])" +} + +ynh_read_manifest () { + if [ -f '../manifest.json' ] ; then + ynh_read_json '../manifest.json' "$1" + else + ynh_read_json '../settings/manifest.json' "$1" + fi +} +ynh_exit_if_up_to_date () { + if [ "${version}" = "${last_version}" ]; then + info "Up-to-date, nothing to do" + exit 0 + fi +} + + +# # Execute a command as root user +# +# usage: ynh_psql_execute_as_root sql [db] +# | arg: sql - the SQL command to execute +# | arg: db - the database to connect to +ynh_psql_execute_as_root () { + sudo su -c "psql" - postgres <<< ${1} +} + +# Create a user +# +# usage: ynh_psql_create_user user pwd [host] +# | arg: user - the user name to create +# | arg: pwd - the password to identify user by +ynh_psql_create_user() { + ynh_psql_execute_as_root \ + "CREATE USER ${1} WITH PASSWORD '${2}';" +} + +# Create a database and grant optionnaly privilegies to a user +# +# usage: ynh_psql_create_db db [user [pwd]] +# | arg: db - the database name to create +# | arg: user - the user to grant privilegies +# | arg: pwd - the password to identify user by +ynh_psql_create_db() { + db=$1 + # grant all privilegies to user + if [[ $# -gt 1 ]]; then + ynh_psql_create_user ${2} "${3}" + sudo su -c "createdb -O ${2} $db" - postgres + else + sudo su -c "createdb $db" - postgres + fi + +} + +# Drop a database +# +# usage: ynh_psql_drop_db db +# | arg: db - the database name to drop +ynh_psql_drop_db() { + sudo su -c "dropdb ${1}" - postgres +} + +# Drop a user +# +# usage: ynh_psql_drop_user user +# | arg: user - the user name to drop +ynh_psql_drop_user() { + sudo su -c "dropuser ${1}" - postgres +} + + +# Execute a command as another user +# usage: exec_as USER COMMAND [ARG ...] +exec_as() { + local USER=$1 + shift 1 + + if [[ $USER = $(whoami) ]]; then + eval "$@" + else + # use sudo twice to be root and be allowed to use another user + sudo sudo -u "$USER" "$@" + fi +} diff --git a/scripts/backup b/scripts/backup index 1373adf..c727458 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,24 +1,32 @@ -#! /bin/bash +#!/bin/bash # Exit on command errors and treat unset variables as an error set -eu -# See comments in install script -app=$YNH_APP_INSTANCE_NAME +source /usr/share/yunohost/helpers +#source _future.sh +source ../settings/scripts/_common.sh -# Source YunoHost helpers -. /usr/share/yunohost/helpers +app=$YNH_APP_INSTANCE_NAME +domain=$(ynh_app_setting_get "$app" domain) +odoo_version=$(ynh_app_setting_get "$app" odoo_version) + +define_paths # Backup sources & data -ynh_backup "/usr/lib/python2.7/dist-packages/openerp/" "sources" +ynh_backup "${source_path}addons" "$1${source_path}addons" +mkdir -p /opt/odoo-oca-addons +ynh_backup "/opt/odoo-oca-addons" "$1/opt/odoo-oca-addons" + +# Backup configuration +ynh_backup "$conf_file" "$1$conf_file" # Copy NGINX configuration -domain=$(ynh_app_setting_get "$app" domain) -ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" "nginx.conf" -ynh_backup "/etc/odoo/openerp-server.conf" "openerp-server.conf" +ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" "etc/nginx/conf.d/${domain}.d/${app}.conf" + +# Save postgresql conf +ynh_backup "/etc/postgresql/9.4/main/pg_hba.conf" "etc/postgresql/9.4/main/pg_hba.conf" # Copy database database=${domain//./-} sudo su -c "pg_dump $database" postgres > ./dump.sql -pwd=`pwd` -ynh_backup "$pwd/dump.sql" "dump.sql" diff --git a/scripts/install b/scripts/install index 9d920d5..7e68529 100644 --- a/scripts/install +++ b/scripts/install @@ -2,130 +2,99 @@ set -eu -app=$YNH_APP_INSTANCE_NAME +source /usr/share/yunohost/helpers +source _future.sh +source _common.sh -# Retrieve arguments -domain=$YNH_APP_ARG_DOMAIN -odoo_version=$YNH_APP_ARG_ODOO_VERSION -admin_password=$YNH_APP_ARG_ADMIN_PASSWORD -database_password=$YNH_APP_ARG_DATABASE_PASSWORD -lang=$YNH_APP_ARG_LANG +ynh_trap_on -# Source YunoHost helpers -. /usr/share/yunohost/helpers +# Arguments from manifest +export app=$YNH_APP_INSTANCE_NAME +export domain=$YNH_APP_ARG_DOMAIN +export odoo_version=$YNH_APP_ARG_VERSION +export oca=$YNH_APP_ARG_OCA +export admin_password=$YNH_APP_ARG_ADMIN_PASSWORD +export lang=$YNH_APP_ARG_LANG +export tz=$YNH_APP_ARG_TZ +export is_public=0 -# Check domain/path availability -domain=${domain}"/" -sudo yunohost app checkurl $domain -a $app \ - || (echo "Path not available: $domain" && exit 1) +#================================================= +# CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS +#================================================= +ynh_check_var "$app" "app name not set" +ynh_webpath_available "$domain" "/" +check_odoo_version +define_paths +define_is_master +define_port +define_dbpass -# Remove trailing "/" for next commands -domain=${domain%/} -ynh_app_setting_set "$app" domain "$domain" -ynh_app_setting_set "$app" domain "$domain" -if [ -f /usr/bin/openerp-server ]; then - echo "Odoo is already installed, switching to multi-instances" - ynh_app_setting_set "$app" instance "slave" +#================================================= +# SETUP THE APP BY MODIFYING THE SYSTEM +#================================================= +function setup_files() { + # Set admin password + ynh_configure openerp-server.conf $conf_file + chown odoo:odoo $conf_file -else - sudo yunohost app checkport 8069 - if [[ ! $? -eq 0 ]]; then - exit 1 - fi - - echo "Installing odoo" - ynh_app_setting_set "$app" version "$odoo_version" - ynh_app_setting_set "$app" instance "master" - # Install Odoo - # Prepare installation - ynh_package_install curl - - # Install Odoo - sudo curl -sS https://nightly.odoo.com/odoo.key | sudo apt-key add - - if [ "$odoo_version" = "8.0" ]; then - sudo sh -c 'echo "deb http://nightly.odoo.com/8.0/nightly/deb/ ./" > /etc/apt/sources.list.d/odoo.list' - else - sudo sh -c 'echo "deb http://nightly.odoo.com/9.0/nightly/deb/ ./" > /etc/apt/sources.list.d/odoo.list' - fi - sudo apt-get update - - # Initialize installation - ynh_package_install postgresql - sudo su -c "psql" postgres <<< \ - "CREATE USER $app WITH PASSWORD '$database_password' CREATEDB;" - ynh_package_install odoo - - # Install wkhtmltopdf to print PDF reports - ynh_package_install wkhtmltopdf - - # Set admin password - sudo sed -i "s@ADMIN_PASSWORD@$admin_password@g" ../conf/openerp-server.conf - sudo sed -i "s@DATABASE_PASSWORD@$database_password@g" ../conf/openerp-server.conf - sudo cp ../conf/openerp-server.conf /etc/odoo/openerp-server.conf - sudo chown odoo:odoo /etc/odoo/openerp-server.conf - - # Autoinstall the LDAP auth module - sudo sed -i "s@'auto_install': False@'auto_install': True@g" /usr/lib/python2.7/dist-packages/openerp/addons/auth_ldap/__openerp__.py - - # Install oerplib to manage databases - #sudo pip install oerplib - - # Add services - sudo yunohost service add postgresql - sudo yunohost service add odoo --log /var/log/odoo/odoo-server.log - sudo yunohost service stop odoo - sudo yunohost service start odoo -fi - -function exit_properly -{ - set +e - # TODO: uninstall db - sudo rm -f /etc/nginx/conf.d/$domain.d/$app.conf - sudo service nginx reload - exit 1 -} -trap exit_properly ERR - -ynh_psql_create_user() { - sudo su -c "psql" postgres <<< \ - "CREATE USER ${1} WITH PASSWORD '${2}';" -} -ynh_psql_create_db() { - db=$1 - # grant all privilegies to user - if [[ $# -gt 1 ]]; then - ynh_psql_create_user ${2} '${3}' - sudo su -c "createdb -O ${2} $db" postgres + # Autoinstall the LDAP auth module + if [ $(echo "$odoo_version >= 10" | bc) -ne 0 ]; then + ynh_replace_string "^{$" "{'auto_install': True," ${source_path}addons/auth_ldap/__manifest__.py else - sudo su -c "createdb $db" postgres + ynh_replace_string "'auto_install': False" "'auto_install': True" ${source_path}addons/auth_ldap/__openerp__.py fi + # Fix peer authentification issue + sed -i '/local\s*all\s*all\s*peer/i \ + local all odoo password' /etc/postgresql/9.4/main/pg_hba.conf + + ynh_configure_nginx } -# Configure Nginx and reload -sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf +function setup_database() { -# Make Odoo public -sudo yunohost app setting $app skipped_uris -v "/" + # Setup database: not working + database=${domain//./-} -sudo service nginx reload + # Load translation + $bin_file -c $conf_file --stop-after-init -i auth_ldap -d $database + $bin_file -c $conf_file --stop-after-init -d $database --load-language $lang + # Configure language, timezone and ldap + $bin_file shell -c $conf_file -d $database <<< \ +" +self.change_password('admin','$admin_password') +self.env.cr.commit() +self.write({'tz':'$tz','lang':'$lang'}) +self.env.cr.commit() +template=env['res.users'].create({ + 'login':'template', + 'password':'', + 'name':'template', + 'email':'template', + 'sel_groups_9_10':9, + 'tz':'$tz', + 'lang':'$lang' +}) +self.env.cr.commit() +self.company_id.ldaps.create({ + 'ldap_server':'localhost', + 'ldap_server_port':389, + 'ldap_base':'ou=users, dc=yunohost,dc=org', + 'ldap_filter':'uid=%s', + 'user':template.id, + 'company':self.company_id.id +}) +self.env.cr.commit() +" +} -# Fix peer authentification issue -sudo sed -i '/local\s*all\s*all\s*peer/i \ -local all odoo password' /etc/postgresql/9.4/main/pg_hba.conf -sudo service postgresql reload +ynh_webpath_register "$app" "$domain" "/" +ynh_save_args domain odoo_version oca lang tz is_master port +install_dependencies +setup_files +create_general_db +add_services +setup_database +ssowat_and_restart -# Setup database: not working -database=${domain//./-} -sudo /usr/bin/openerp-server -c /etc/odoo/openerp-server.conf --stop-after-init -d $database -#ynh_psql_create_db $database -#sudo sed -i "s@ADMIN_PASSWORD@$admin_password@g" ../conf/install_database.py -#sudo sed -i "s@DOMAIN_DATABASE@${domain//./-}@g" ../conf/install_database.py -#sudo sed -i "s@DATABASE_LANG@$lang@g" ../conf/install_database.py -#sudo sed -i "s@DATABASE_PASSWORD@$database_password@g" ../conf/install_database.py -#sudo python ../conf/install_database.py - -# Setup LDAP: TO BE DONE -echo $? diff --git a/scripts/remove b/scripts/remove index eaa90a0..59c84cf 100644 --- a/scripts/remove +++ b/scripts/remove @@ -1,31 +1,54 @@ #!/bin/bash -set -eu +set -u + +source /usr/share/yunohost/helpers +source _future.sh +source _common.sh app=$YNH_APP_INSTANCE_NAME -# Source YunoHost helpers -. /usr/share/yunohost/helpers + # Retrieve app settings domain=$(ynh_app_setting_get "$app" domain) - +odoo_version=$(ynh_app_setting_get "$app" odoo_version) +if [ "$odoo_version" = "" ]; then + exit 0 +fi database=${domain//./-} -instance=$(ynh_app_setting_get "$app" instance) +is_master=$(ynh_app_setting_get "$app" is_master) + +define_paths + +yunohost service stop odoo +list=$(yunohost app list --installed | grep odoo) +# If removing master instance, remove Odoo. +if [ $(echo $list | wc -l) = 1 ]; then + rm -f /etc/apt/sources.list.d/odoo.list + apt-get update + yunohost service remove odoo + ynh_psql_drop_db $APPNAME + #ynh_psql_drop_user $APPNAME +else + # Set another app as master + if [ "$is_master" = "true" ]; then + for instance in $list; do + if [ "$instance" != "$app" ]; then + ynh_app_setting_set "$instance" is_master "true" + break + fi + done + is_master="false" + fi +fi + +ynh_remove_app_dependencies # Remove database -sudo su -c "dropdb $database" postgres +ynh_psql_drop_db $database -# If removing master instance, remove Odoo. -if [ "$instance" = "master" ]; then - # Remove Odoo - sudo yunohost service stop odoo - sudo apt-get remove odoo -y - sudo apt-get remove wkhtmltopdf -y - sudo yunohost service remove odoo +if [ "$is_master" = "false" ]; then + yunohost service start odoo fi # Remove NGINX conf -sudo rm /etc/nginx/conf.d/$domain.d/$app.conf - -# Reload -sudo service nginx reload -sudo yunohost app ssowatconf +ynh_rm_nginx_conf diff --git a/scripts/restore b/scripts/restore index a47a836..0d3b76f 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,3 +1,67 @@ #!/bin/bash -app=odoo -# TO BE DONE \ No newline at end of file +set -eu + +# Import helpers +source /usr/share/yunohost/helpers +source ../settings/scripts/_future.sh +source ../settings/scripts/_common.sh + +ynh_trap_on + +export app=$YNH_APP_INSTANCE_NAME +export domain=$(ynh_app_setting_get $app domain) +export odoo_version=$(ynh_app_setting_get $app odoo_version) +export oca=$(ynh_app_setting_get $app oca) +export port=$(ynh_app_setting_get $app port) +export is_public=0 + +#================================================= +# CHECK IF THE APP CAN BE RESTORED +#================================================= +ynh_check_var "$app" "app name not set" +ynh_webpath_available "$domain" "/" +check_odoo_version +define_paths +define_is_master +define_port +define_dbpass restore + +#================================================= +# RESTORE THE APP BY MODIFYING THE SYSTEM +#================================================= +# Restore files +function restore_files () { + if [ "$is_master" = true ]; then + ynh_restore + chown -R odoo:odoo /var/lib/odoo/ + chown postgres:postgres /etc/postgresql/9.4/main/pg_hba.conf + else + # If odoo is already setup we just restore nginx and add some missing + # modules. Other files are already on system, and we don't want to + # erase it + + # Configure Nginx and reload + ynh_restore_file "/etc/nginx/conf.d/${domain}.d/${app}.conf" + + # TODO Restore plugin/addons + fi +} + +# Restore database +function restore_database () { + # Restore database + database=${domain//./-} + su -c "createdb -O $APPNAME $database" - postgres + su -c "psql $database" postgres < ./dump.sql +} + +ynh_save_args is_master port +install_dependencies +restore_files +create_general_db +add_services +restore_database +ssowat_and_restart + + + diff --git a/scripts/upgrade b/scripts/upgrade index a3df0a1..51aed46 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,14 +1,54 @@ #!/bin/bash + set -eu -app=$YNH_APP_INSTANCE_NAME # Source YunoHost helpers -. /usr/share/yunohost/helpers +source /usr/share/yunohost/helpers +source _future.sh +source _common.sh + +ynh_trap_on # Retrieve arguments -domain=$(ynh_app_setting_get "$app" domain) +export app=$YNH_APP_INSTANCE_NAME +export domain=$(ynh_app_setting_get "$app" domain) +export odoo_version=$(ynh_app_setting_get "$app" odoo_version) +export is_master=$(ynh_app_setting_get "$app" is_master) +export oca=$(ynh_app_setting_get "$app" oca) +export port=$(ynh_app_setting_get $app port) +export is_public=0 + +version=$(ynh_read_json "/etc/yunohost/apps/$app/manifest.json" 'version' 2> /dev/null || echo '9.0-0') +last_version=$(ynh_read_manifest 'version') + +#ynh_exit_if_up_to_date +ynh_check_var "$app" "app name not set" # Upgrade official package - sudo apt-get install odoo -y -qq +apt-get install odoo -y -qq + +# Zamentur version https://github.com/zamentur/odoo_ynh/commit/cdeb9afbf218431781f752dedfbf4247afbd5b44 +if [ "${version}" = "9.0-0" ]; then + # set new args + odoo_version=${odoo_version:-$(ynh_app_setting_get "$app" version)} + if [ "$is_master" = "" ]; then + if [ "$(ynh_app_setting_get "$app" instance)" = "master" ];then + is_master="true" + else + is_master="false" + fi + fi + port=${port:-8069} + oca=${oca:-false} + ynh_save_args odoo_version oca is_master port + + # Install official debian package + install_dependencies +fi + +if [ "${version}" = "10.0-1" ]; then + # Put here your migrations + echo "" +fi + -# TBD