diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /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/PROJECT_STRUCTURE.md b/PROJECT_STRUCTURE.md index 988ff24..5e1e535 100644 --- a/PROJECT_STRUCTURE.md +++ b/PROJECT_STRUCTURE.md @@ -101,8 +101,8 @@ Elle gère les membres, les cotisations, et s'intègre avec des services tiers ( | `members:cleanup-expired` | Desactive les membres expires (Dolibarr + ISPConfig + Nextcloud). `--dry-run` | | `sync:ispconfig-mail-members` | Lie les membres a leurs comptes mail ISPConfig (@retzien.fr) | | `sync:ispconfig-web-members` | Lie les membres a leurs comptes d'hebergement web | -| `sync:nextcloud-members` | Lie les membres a leurs comptes Nextcloud | -| `sync:services-members` | Synchronise les services associes aux membres | +| `nextcloud:sync-members` | Lie les membres a leurs comptes Nextcloud | +| `memberships:sync-services` | Synchronise les services associes aux membres | --- @@ -173,7 +173,7 @@ resources/js/components/ ## Localisation -Langues : **fr**, **en** — fichiers dans `lang/{locale}/` : contacts, members, memberships, packages, services, users, member_groups. +Langues : **fr**, **en** — fichiers dans `lang/{locale}/` : contacts, members, memberships, packages, services, users, member_groups, synchronisations. --- diff --git a/README.md b/README.md index 2e104a6..ef148ec 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,211 @@ -# ROXANE - Centralized Portal with Laravel, React & Keycloak SSO +# Roxane -This project is a **centralized portal application & web hosting association ERP** built with **Laravel 12 & React19**, designed to provide a seamless and secure entry point for both **end users** and **administrators**. +Roxane is an open source membership management application designed for associations. It centralizes member management, subscriptions, and integration with self-hosted third-party services (Dolibarr, ISPConfig, Nextcloud, Sympa). -- **Front Office (Users)** - - Build on React19 - - (V2) Authentication via **Keycloak SSO (OIDC)** - - Unified dashboard to access external applications (cloud storage, mailing tools, file sharing, etc.) - - Role-based access control synced from Keycloak - - Connected with : ISP Config for web hosting and mailbox management, NextCloud, Sympa for mailing list and more... -- **Back Office (Admins)** - - Authentication handled **locally in Laravel** (separate from Keycloak) - - Built with **FilamentPHP** - - Advanced admin features: app configuration, user activity logs, monitoring -- **Security & API** - - JWT validation for user-facing APIs (via Keycloak) - - Laravel Sanctum / API tokens for admin endpoints - - Support for MFA, Single Logout, and audit logging -- **Tech Stack Highlights** - - Laravel 12 (PHP 8.3) - - Blade + Livewire (back office UI) - - React19 (front office UI) - - TailwindCSS (UI framework) - - Keycloak SSO (OIDC) (V2) - - FilamentPHP (admin panel) - - Redis (cache, sessions, queues) - - Maria DB - - Docker-ready + CI/CD support and automated deploy +The project is developed in the context of **Le Retzien Libre**, a non-profit association promoting digital freedom and self-hosting. It is intended to be generic enough to be adapted by other associations with similar needs. -This architecture allows associations to **centralize authentication and app access** while keeping the **admin back office independent and highly secure**. +> Work in progress. The application is functional for core features but is actively being developed. See the [known TODOs](#known-todos) section. + +--- + +## Features + +**Back office (administrators)** +- Member management (status, nature, groups) +- Subscription and package management +- Manual and automated synchronization with third-party services +- Role and permission management (Spatie Permissions + Filament Shield) +- Two-factor authentication for admin accounts + +**Front office (members)** +- Registration and membership form +- Personal dashboard with access to associated services +- Profile and password management +- Two-factor authentication + +**Integrations** +- Dolibarr ERP (member and subscription import via REST API) +- ISPConfig (mail and web hosting account management via SOAP) +- Nextcloud (account provisioning via OCS API) +- Sympa (mailing list management) + +**Planned in V2** +- SSO authentication via Keycloak (OIDC) for the front office +- Admin back office remains on local Laravel authentication + +--- + +## Tech stack + +| Layer | Technologies | +|-----------|-------------------------------------------------------| +| Backend | Laravel 12, PHP 8.3, MySQL | +| Admin | Filament v4, Livewire 3 | +| Frontend | React 19, Inertia v2, Tailwind CSS v4 | +| Auth | Laravel Fortify, 2FA, Spatie Permissions + Shield | +| Queue | Redis (cache, sessions, queues) | +| Tests | PHPUnit 11 | +| Dev tools | Pint, ESLint, Prettier, Laravel Sail, Wayfinder | + +--- + +## Requirements + +- PHP 8.3+ +- Composer +- Node.js 20+ and npm +- MySQL 8+ or MariaDB 10.6+ +- Redis +- Docker (optional, via Laravel Sail) + +--- + +## Installation + +### 1. Clone the repository + +```bash +git clone https://github.com/your-org/roxane.git +cd roxane +``` + +### 2. Install dependencies + +```bash +composer install +npm install +``` + +### 3. Environment configuration + +```bash +cp .env.example .env +php artisan key:generate +``` + +Edit `.env` and configure: +- Database connection (`DB_*`) +- Redis connection (`REDIS_*`) +- Mail configuration (`MAIL_*`) +- Third-party service credentials (Dolibarr, ISPConfig, Nextcloud) + +### 4. Database setup + +```bash +php artisan migrate +php artisan db:seed +``` + +The seeder creates: +- Member groups (`admin-interface`, `website`) +- Default packages (`custom`, `one-year`, `two-years`) +- Default services (mail, file2link, nextcloud, sympa, webhosting) +- Admin account (`contact@nebulae-design.com` / `password`) +- Notification templates + +In non-production environments, a demo member (Jane Doe) is also created. + +**Change all default credentials immediately after installation.** + +### 5. Build frontend assets + +```bash +npm run build +``` + +For local development with hot reload: + +```bash +npm run dev +``` + +Or use the all-in-one development command: + +```bash +composer run dev +``` + +### 6. Queues and scheduler + +The application uses queued jobs for synchronization tasks and notifications. In production, configure a queue worker and the Laravel scheduler. + +```bash +# Queue worker +php artisan queue:work + +# Scheduler (add to crontab) +* * * * * cd /path/to/roxane && php artisan schedule:run >> /dev/null 2>&1 +``` + +--- + +## Running with Laravel Sail (Docker) + +```bash +./vendor/bin/sail up -d +./vendor/bin/sail artisan migrate +./vendor/bin/sail artisan db:seed +./vendor/bin/sail npm run build +``` + +--- + +## Default accounts + +| Account | Email | Password | Role | +|-------------|----------------------------|----------|-------------| +| Admin | contact@nebulae-design.com | password | super_admin | +| Demo member | jane@doe.com | password | — | + +These accounts are created by the seeder. Remove or change them before any production deployment. + +--- + +## Artisan commands + +Synchronization commands can be triggered manually from the admin panel (Synchronisations page) or via CLI: + +| Command | Description | +|-------------------------------|--------------------------------------------------------------| +| `sync:dolibarr-members` | Import members and subscriptions from Dolibarr | +| `members:cleanup-expired` | Deactivate expired members across all services (`--dry-run`) | +| `sync:ispconfig-mail-members` | Link members to their ISPConfig mail accounts | +| `sync:ispconfig-web-members` | Link members to their ISPConfig web hosting accounts | +| `nextcloud:sync-members` | Link members to their Nextcloud accounts | +| `memberships:sync-services` | Synchronize services associated with active memberships | + +--- + +## Running tests + +```bash +php artisan test --compact +``` + +--- + +## Known TODOs + +| Area | Description | +|---------------------------|---------------------------------------------------------------------| +| ContactService | Send email notification to administrator on new contact request | +| MemberService | Send emails to member and admin on deactivation | +| SubscriptionExpiredPhase1 | Generic template + backend UI for notification content management | +| User.php | Restrict admin access in production to @retzien.fr emails | +| SyncDolibarrMembers | Extract `toDate()` method into a shared service or helper | +| SyncISPConfigMailMembers | Handle multiple email addresses per member | +| SyncISPConfigMailMembers | Track `ispconfig_client_id` | +| Global | Make Roxane fully generic for any association ERP use case | +| Translations | Audit project for missing translation keys | +| Global | Raise PHPStan to level 8 | +| V2 | Keycloak SSO integration (OIDC) for front office authentication | + +--- + +## License + +This project is licensed under the [GNU Affero General Public License v3.0](LICENSE) (AGPL-3.0). + +Any modification to the source code, including versions run as a network service, must be made available under the same license. This ensures the project remains free and open for all. + +Contributions are welcome. If you are adapting Roxane for your own association, feel free to open an issue or submit a pull request. diff --git a/app/Filament/Pages/Synchronisations.php b/app/Filament/Pages/Synchronisations.php index 069e9fd..775679a 100644 --- a/app/Filament/Pages/Synchronisations.php +++ b/app/Filament/Pages/Synchronisations.php @@ -3,26 +3,18 @@ namespace App\Filament\Pages; use App\Jobs\RunSyncCommand; -use BackedEnum; use Filament\Actions\Action; use Filament\Forms\Components\Toggle; use Filament\Pages\Page; use Illuminate\Support\Facades\Cache; -use UnitEnum; class Synchronisations extends Page { protected string $view = 'filament.pages.synchronisations'; - protected static string|BackedEnum|null $navigationIcon = 'heroicon-o-arrow-path'; + protected static string|null|\BackedEnum $navigationIcon = 'heroicon-o-arrow-path'; - protected static string|UnitEnum|null $navigationGroup = 'Paramètres'; - - protected static ?string $navigationLabel = 'Synchronisations'; - - protected static ?string $title = 'Synchronisations'; - - protected static ?string $slug = 'synchronisations'; + protected static string|null|\UnitEnum $navigationGroup = 'Paramètres'; protected static ?int $navigationSort = 10; @@ -35,6 +27,16 @@ class Synchronisations extends Page 'services', ]; + public static function getNavigationLabel(): string + { + return __('synchronisations.navigation_label'); + } + + public function getTitle(): string + { + return __('synchronisations.title'); + } + public static function canAccess(): bool { return auth()->user()?->hasRole('super_admin') ?? false; @@ -76,11 +78,10 @@ class Synchronisations extends Page public function syncDolibarrAction(): Action { return Action::make('syncDolibarr') - ->label('Lancer') ->requiresConfirmation() - ->modalHeading('Synchronisation Dolibarr') - ->modalDescription('Importer les membres et cotisations depuis Dolibarr.') - ->modalSubmitActionLabel('Lancer') + ->modalHeading(__('synchronisations.sections.dolibarr.modal_heading')) + ->modalDescription(__('synchronisations.sections.dolibarr.modal_description')) + ->modalSubmitActionLabel(__('synchronisations.action.submit')) ->disabled(fn () => in_array($this->getCommandStatus('dolibarr')['status'], ['pending', 'running'])) ->action(fn () => $this->enqueueCommand('dolibarr', 'sync:dolibarr-members')); } @@ -88,18 +89,17 @@ class Synchronisations extends Page public function cleanupExpiredAction(): Action { return Action::make('cleanupExpired') - ->label('Lancer') - ->modalHeading('Désactiver les membres expirés') - ->modalDescription('Désactive les membres expirés dans Dolibarr, ISPConfig et Nextcloud.') - ->modalSubmitActionLabel('Lancer') + ->modalHeading(__('synchronisations.sections.expired.modal_heading')) + ->modalDescription(__('synchronisations.sections.expired.modal_description')) + ->modalSubmitActionLabel(__('synchronisations.action.submit')) ->schema([ Toggle::make('dry_run') - ->label('Mode simulation (dry-run)') - ->helperText('Simule l\'opération sans effectuer de modifications.') + ->label(__('synchronisations.sections.expired.dry_run_label')) + ->helperText(__('synchronisations.sections.expired.dry_run_helper')) ->default(true), ]) ->disabled(fn () => in_array($this->getCommandStatus('cleanup_expired')['status'], ['pending', 'running'])) - ->action(function (array $data) { + ->action(function (array $data): void { $parameters = $data['dry_run'] ? ['--dry-run' => true] : []; $this->enqueueCommand('cleanup_expired', 'members:cleanup-expired', $parameters); }); @@ -108,11 +108,10 @@ class Synchronisations extends Page public function syncISPConfigMailAction(): Action { return Action::make('syncISPConfigMail') - ->label('Lancer') ->requiresConfirmation() - ->modalHeading('Synchronisation ISPConfig Mail') - ->modalDescription('Lie les membres à leurs comptes mail ISPConfig (@retzien.fr).') - ->modalSubmitActionLabel('Lancer') + ->modalHeading(__('synchronisations.sections.ispconfig_mail.modal_heading')) + ->modalDescription(__('synchronisations.sections.ispconfig_mail.modal_description')) + ->modalSubmitActionLabel(__('synchronisations.action.submit')) ->disabled(fn () => in_array($this->getCommandStatus('ispconfig_mail')['status'], ['pending', 'running'])) ->action(fn () => $this->enqueueCommand('ispconfig_mail', 'sync:ispconfig-mail-members')); } @@ -120,18 +119,17 @@ class Synchronisations extends Page public function syncISPConfigWebAction(): Action { return Action::make('syncISPConfigWeb') - ->label('Lancer') - ->modalHeading('Synchronisation ISPConfig Web') - ->modalDescription('Lie les membres à leurs comptes d\'hébergement web.') - ->modalSubmitActionLabel('Lancer') + ->modalHeading(__('synchronisations.sections.ispconfig_web.modal_heading')) + ->modalDescription(__('synchronisations.sections.ispconfig_web.modal_description')) + ->modalSubmitActionLabel(__('synchronisations.action.submit')) ->schema([ Toggle::make('refresh_cache') - ->label('Vider le cache ISPConfig') - ->helperText('Vide le cache avant la synchronisation.') + ->label(__('synchronisations.sections.ispconfig_web.refresh_cache_label')) + ->helperText(__('synchronisations.sections.ispconfig_web.refresh_cache_helper')) ->default(false), ]) ->disabled(fn () => in_array($this->getCommandStatus('ispconfig_web')['status'], ['pending', 'running'])) - ->action(function (array $data) { + ->action(function (array $data): void { $parameters = $data['refresh_cache'] ? ['--refresh-cache' => true] : []; $this->enqueueCommand('ispconfig_web', 'sync:ispconfig-web-members', $parameters); }); @@ -140,18 +138,17 @@ class Synchronisations extends Page public function syncNextcloudAction(): Action { return Action::make('syncNextcloud') - ->label('Lancer') - ->modalHeading('Synchronisation Nextcloud') - ->modalDescription('Lie les membres à leurs comptes Nextcloud.') - ->modalSubmitActionLabel('Lancer') + ->modalHeading(__('synchronisations.sections.nextcloud.modal_heading')) + ->modalDescription(__('synchronisations.sections.nextcloud.modal_description')) + ->modalSubmitActionLabel(__('synchronisations.action.submit')) ->schema([ Toggle::make('dry_run') - ->label('Mode simulation (dry-run)') - ->helperText('Simule l\'opération sans effectuer de modifications.') + ->label(__('synchronisations.sections.nextcloud.dry_run_label')) + ->helperText(__('synchronisations.sections.nextcloud.dry_run_helper')) ->default(false), ]) ->disabled(fn () => in_array($this->getCommandStatus('nextcloud')['status'], ['pending', 'running'])) - ->action(function (array $data) { + ->action(function (array $data): void { $parameters = $data['dry_run'] ? ['--dry-run' => true] : []; $this->enqueueCommand('nextcloud', 'nextcloud:sync-members', $parameters); }); @@ -160,11 +157,10 @@ class Synchronisations extends Page public function syncServicesAction(): Action { return Action::make('syncServices') - ->label('Lancer') ->requiresConfirmation() - ->modalHeading('Synchronisation des services') - ->modalDescription('Synchronise les services associés aux membres actifs.') - ->modalSubmitActionLabel('Lancer') + ->modalHeading(__('synchronisations.sections.services.modal_heading')) + ->modalDescription(__('synchronisations.sections.services.modal_description')) + ->modalSubmitActionLabel(__('synchronisations.action.submit')) ->disabled(fn () => in_array($this->getCommandStatus('services')['status'], ['pending', 'running'])) ->action(fn () => $this->enqueueCommand('services', 'memberships:sync-services')); } diff --git a/app/Providers/Filament/AdminPanelProvider.php b/app/Providers/Filament/AdminPanelProvider.php index 94c738b..b891847 100644 --- a/app/Providers/Filament/AdminPanelProvider.php +++ b/app/Providers/Filament/AdminPanelProvider.php @@ -29,6 +29,7 @@ class AdminPanelProvider extends PanelProvider { return $panel ->plugin(FilamentNordThemePlugin::make()) + ->viteTheme('resources/css/filament-admin.css') ->default() ->id('admin') ->path('admin') diff --git a/database/seeders/DatabaseSeeder.php b/database/seeders/DatabaseSeeder.php index c936107..af12fc8 100644 --- a/database/seeders/DatabaseSeeder.php +++ b/database/seeders/DatabaseSeeder.php @@ -2,173 +2,22 @@ namespace Database\Seeders; -use App\Models\MemberGroup; -use App\Models\Package; -use App\Models\Service; -use App\Models\User; -// use Illuminate\Database\Console\Seeds\WithoutModelEvents; use Illuminate\Database\Seeder; class DatabaseSeeder extends Seeder { - /** - * Seed the application's database. - */ public function run(): void { - // Admin account - User::updateOrCreate([ - 'name' => 'SuperAdmin', - ], - [ - 'email' => 'contact@nebulae-design.com', - 'email_verified_at' => now(), - 'password' => bcrypt('password'), - ]); - - // Member groups - $adminGroup = MemberGroup::updateOrCreate([ - 'name' => 'Admin Interface', - ], [ - 'identifier' => 'admin-interface', - 'description' => 'Groupe d\'utilisateurs créés par les administrateurs du site.', + $this->call([ + MemberGroupSeeder::class, + PackageSeeder::class, + ServiceSeeder::class, + UserSeeder::class, + NotificationTemplateSeeder::class, ]); - $websiteGroup = MemberGroup::updateOrCreate([ - 'name' => 'Site Web', - ], - [ - 'identifier' => 'website', - 'description' => 'Groupe d\'utilisateurs provenant du site web.', - ]); - - // Subscription packages - $packages = [ - [ - 'identifier' => 'custom', - 'name' => 'Sur-mesure', - 'description' => 'Calcul du nombre de mois restant dans l\'année', - 'price' => '1.00', - ], - [ - 'identifier' => 'one-year', - 'name' => 'Un an', - 'description' => '12 mois à compter de la date de validation de l\'adhésion du membre', - 'price' => '12.00', - ], - [ - 'identifier' => 'two-years', - 'name' => 'Deux ans', - 'description' => '24 mois à compter de la date de validation de l\'adhésion du membre', - 'price' => '24.00', - ], - ]; - - foreach ($packages as $package) { - Package::updateOrCreate([ - 'identifier' => $package['identifier'], - ], [ - 'name' => $package['name'], - 'description' => $package['description'], - 'price' => $package['price'], - 'is_active' => true, - ]); + if (! app()->isProduction()) { + $this->call(DemoSeeder::class); } - - // Services - $services = [ - [ - 'identifier' => 'mail', - 'name' => 'Mail RoundCube', - 'description' => 'Service de messagerie', - 'url' => '#', - 'icon' => 'mail', - ], - [ - 'identifier' => 'file2link', - 'name' => 'File2Link', - 'description' => 'Service de partage de fichiers', - 'url' => '#', - 'icon' => 'document-add', - ], - [ - 'identifier' => 'nextcloud', - 'name' => 'Nextcloud', - 'description' => 'Service de stockage de fichiers', - 'url' => '#', - 'icon' => 'cloud-upload', - ], - [ - 'identifier' => 'sympa', - 'name' => 'Sympa', - 'description' => 'Service de gestion de listes de diffusion', - 'url' => '#', - 'icon' => 'clipboard-list', - ], - [ - 'identifier' => 'webhosting', - 'name' => 'Hébergement web', - 'description' => 'Service d\'hébergement web', - 'url' => '#', - 'icon' => 'database', - ], - ]; - - foreach ($services as $service) { - Service::updateOrCreate([ - 'identifier' => $service['identifier'], - ], [ - 'name' => $service['name'], - 'description' => $service['description'], - 'url' => $service['url'], - 'icon' => $service['icon'], - ]); - } - - // Notification templates - $this->call(NotificationTemplateSeeder::class); - - // JaneDoe - $userTest = User::updateOrCreate([ - 'name' => 'JaneDoe', - ], - [ - 'email' => 'jane@doe.com', - 'email_verified_at' => null, - 'password' => bcrypt('password'), - ]); - - $memberTest = $userTest->members()->updateOrCreate([ - 'user_id' => $userTest->id, - ], [ - 'status' => 'valid', - 'nature' => 'physical', - 'group_id' => $websiteGroup->id, - 'lastname' => 'Doe', - 'firstname' => 'Jane', - 'email' => 'jane@doe.com', - 'company' => 'Nebulae Design', - 'date_of_birth' => '1990-01-06', - 'address' => '123 Rue du Test', - 'zipcode' => '49000', - 'city' => 'Saumur', - 'country' => 'FR', - 'phone1' => '0123456789', - 'phone2' => '0123456789', - 'public_membership' => false, - ]); - - $membershipTest = $memberTest->memberships()->updateOrCreate([ - 'member_id' => $memberTest->id, - ], [ - 'admin_id' => '1', - 'package_id' => Package::where('identifier', 'one-year')->first()->id, - 'start_date' => '2025-01-01', - 'end_date' => '2025-12-31', - 'status' => 'active', - 'amount' => 12.00, - 'payment_status' => 'paid', - ]); - } } diff --git a/database/seeders/DemoSeeder.php b/database/seeders/DemoSeeder.php new file mode 100644 index 0000000..589316f --- /dev/null +++ b/database/seeders/DemoSeeder.php @@ -0,0 +1,60 @@ +first(); + $package = Package::where('identifier', 'one-year')->first(); + + $user = User::updateOrCreate( + ['email' => 'jane@doe.com'], + [ + 'name' => 'JaneDoe', + 'email_verified_at' => null, + 'password' => bcrypt('password'), + ] + ); + + $member = $user->members()->updateOrCreate( + ['user_id' => $user->id], + [ + 'status' => 'valid', + 'nature' => 'physical', + 'group_id' => $websiteGroup->id, + 'lastname' => 'Doe', + 'firstname' => 'Jane', + 'email' => 'jane@doe.com', + 'company' => 'Nebulae Design', + 'date_of_birth' => '1990-01-06', + 'address' => '123 Rue du Test', + 'zipcode' => '49000', + 'city' => 'Saumur', + 'country' => 'FR', + 'phone1' => '0123456789', + 'phone2' => '0123456789', + 'public_membership' => false, + ] + ); + + $member->memberships()->updateOrCreate( + ['member_id' => $member->id], + [ + 'admin_id' => User::where('email', 'contact@nebulae-design.com')->value('id'), + 'package_id' => $package->id, + 'start_date' => '2025-01-01', + 'end_date' => '2025-12-31', + 'status' => 'active', + 'amount' => 12.00, + 'payment_status' => 'paid', + ] + ); + } +} diff --git a/database/seeders/MemberGroupSeeder.php b/database/seeders/MemberGroupSeeder.php new file mode 100644 index 0000000..fb89d61 --- /dev/null +++ b/database/seeders/MemberGroupSeeder.php @@ -0,0 +1,28 @@ + 'admin-interface'], + [ + 'name' => 'Admin Interface', + 'description' => 'Groupe d\'utilisateurs créés par les administrateurs du site.', + ] + ); + + MemberGroup::updateOrCreate( + ['identifier' => 'website'], + [ + 'name' => 'Site Web', + 'description' => 'Groupe d\'utilisateurs provenant du site web.', + ] + ); + } +} diff --git a/database/seeders/PackageSeeder.php b/database/seeders/PackageSeeder.php new file mode 100644 index 0000000..fa15c23 --- /dev/null +++ b/database/seeders/PackageSeeder.php @@ -0,0 +1,45 @@ + 'custom', + 'name' => 'Sur-mesure', + 'description' => 'Calcul du nombre de mois restant dans l\'année', + 'price' => '1.00', + ], + [ + 'identifier' => 'one-year', + 'name' => 'Un an', + 'description' => '12 mois à compter de la date de validation de l\'adhésion du membre', + 'price' => '12.00', + ], + [ + 'identifier' => 'two-years', + 'name' => 'Deux ans', + 'description' => '24 mois à compter de la date de validation de l\'adhésion du membre', + 'price' => '24.00', + ], + ]; + + foreach ($packages as $package) { + Package::updateOrCreate( + ['identifier' => $package['identifier']], + [ + 'name' => $package['name'], + 'description' => $package['description'], + 'price' => $package['price'], + 'is_active' => true, + ] + ); + } + } +} diff --git a/database/seeders/ServiceSeeder.php b/database/seeders/ServiceSeeder.php new file mode 100644 index 0000000..01997bb --- /dev/null +++ b/database/seeders/ServiceSeeder.php @@ -0,0 +1,69 @@ + 'mail', + 'name' => 'Mail RoundCube', + 'description' => 'Service de messagerie', + 'url' => '#', + 'icon' => 'envelope', + ], + [ + 'identifier' => 'file2link', + 'name' => 'File2Link', + 'description' => 'Service de partage de fichiers', + 'url' => '#', + 'icon' => 'share', + ], + [ + 'identifier' => 'nextcloud', + 'name' => 'Nextcloud', + 'description' => 'Service de stockage de fichiers', + 'url' => '#', + 'icon' => 'cloud', + ], + [ + 'identifier' => 'sympa', + 'name' => 'Sympa', + 'description' => 'Service de gestion de listes de diffusion', + 'url' => '#', + 'icon' => 'megaphone', + ], + [ + 'identifier' => 'listmonk', + 'name' => 'ListMonk', + 'description' => 'Service de newsletter et listes de diffusion', + 'url' => '#', + 'icon' => 'newspaper', + ], + [ + 'identifier' => 'webhosting', + 'name' => 'Hébergement web', + 'description' => 'Service d\'hébergement web', + 'url' => '#', + 'icon' => 'globe-alt', + ], + ]; + + foreach ($services as $service) { + Service::updateOrCreate( + ['identifier' => $service['identifier']], + [ + 'name' => $service['name'], + 'description' => $service['description'], + 'url' => $service['url'], + 'icon' => $service['icon'], + ] + ); + } + } +} diff --git a/database/seeders/UserSeeder.php b/database/seeders/UserSeeder.php new file mode 100644 index 0000000..71d2be8 --- /dev/null +++ b/database/seeders/UserSeeder.php @@ -0,0 +1,21 @@ + 'contact@nebulae-design.com'], + [ + 'name' => 'SuperAdmin', + 'email_verified_at' => now(), + 'password' => bcrypt('password'), + ] + ); + } +} diff --git a/lang/en/synchronisations.php b/lang/en/synchronisations.php new file mode 100644 index 0000000..7eef900 --- /dev/null +++ b/lang/en/synchronisations.php @@ -0,0 +1,67 @@ + 'Synchronisations', + 'navigation_label' => 'Synchronisations', + + 'sections' => [ + 'dolibarr' => [ + 'heading' => 'Dolibarr', + 'description' => 'Import members and memberships from Dolibarr.', + 'action_label' => 'Sync Dolibarr', + 'modal_heading' => 'Dolibarr Synchronisation', + 'modal_description' => 'Import members and memberships from Dolibarr.', + ], + 'expired' => [ + 'heading' => 'Expired Members', + 'description' => 'Deactivate expired members in Dolibarr, ISPConfig and Nextcloud.', + 'action_label' => 'Expired Members', + 'modal_heading' => 'Deactivate Expired Members', + 'modal_description' => 'Deactivate expired members in Dolibarr, ISPConfig and Nextcloud.', + 'dry_run_label' => 'Simulation mode (dry-run)', + 'dry_run_helper' => 'Simulates the operation without making any changes.', + ], + 'ispconfig_mail' => [ + 'heading' => 'ISPConfig Mail', + 'description' => 'Link members to their ISPConfig mail accounts (@retzien.fr).', + 'action_label' => 'ISPConfig Mail', + 'modal_heading' => 'ISPConfig Mail Synchronisation', + 'modal_description' => 'Link members to their ISPConfig mail accounts (@retzien.fr).', + ], + 'ispconfig_web' => [ + 'heading' => 'ISPConfig Web', + 'description' => 'Link members to their web hosting accounts.', + 'action_label' => 'ISPConfig Web', + 'modal_heading' => 'ISPConfig Web Synchronisation', + 'modal_description' => 'Link members to their web hosting accounts.', + 'refresh_cache_label' => 'Clear ISPConfig cache', + 'refresh_cache_helper' => 'Clears the cache before synchronisation.', + ], + 'nextcloud' => [ + 'heading' => 'Nextcloud', + 'description' => 'Link members to their Nextcloud accounts.', + 'action_label' => 'Nextcloud', + 'modal_heading' => 'Nextcloud Synchronisation', + 'modal_description' => 'Link members to their Nextcloud accounts.', + 'dry_run_label' => 'Simulation mode (dry-run)', + 'dry_run_helper' => 'Simulates the operation without making any changes.', + ], + 'services' => [ + 'heading' => 'Member Services', + 'description' => 'Synchronise services associated with active members.', + 'action_label' => 'Member Services', + 'modal_heading' => 'Member Services Synchronisation', + 'modal_description' => 'Synchronise services associated with active members.', + ], + ], + + 'status' => [ + 'pending' => 'Waiting in execution queue...', + 'running' => 'Running...', + 'finished_at' => 'Finished at :time', + ], + + 'action' => [ + 'submit' => 'Run', + ], +]; diff --git a/lang/fr/synchronisations.php b/lang/fr/synchronisations.php new file mode 100644 index 0000000..b4fec80 --- /dev/null +++ b/lang/fr/synchronisations.php @@ -0,0 +1,67 @@ + 'Synchronisations', + 'navigation_label' => 'Synchronisations', + + 'sections' => [ + 'dolibarr' => [ + 'heading' => 'Dolibarr', + 'description' => 'Importe les membres et cotisations depuis Dolibarr.', + 'action_label' => 'Synchroniser Dolibarr', + 'modal_heading' => 'Synchronisation Dolibarr', + 'modal_description' => 'Importer les membres et cotisations depuis Dolibarr.', + ], + 'expired' => [ + 'heading' => 'Membres expirés', + 'description' => 'Désactive les membres expirés dans Dolibarr, ISPConfig et Nextcloud.', + 'action_label' => 'Membres expirés', + 'modal_heading' => 'Désactiver les membres expirés', + 'modal_description' => 'Désactive les membres expirés dans Dolibarr, ISPConfig et Nextcloud.', + 'dry_run_label' => 'Mode simulation (dry-run)', + 'dry_run_helper' => 'Simule l\'opération sans effectuer de modifications.', + ], + 'ispconfig_mail' => [ + 'heading' => 'ISPConfig Mail', + 'description' => 'Lie les membres à leurs comptes mail ISPConfig (@retzien.fr).', + 'action_label' => 'ISPConfig Mail', + 'modal_heading' => 'Synchronisation ISPConfig Mail', + 'modal_description' => 'Lie les membres à leurs comptes mail ISPConfig (@retzien.fr).', + ], + 'ispconfig_web' => [ + 'heading' => 'ISPConfig Web', + 'description' => 'Lie les membres à leurs comptes d\'hébergement web.', + 'action_label' => 'ISPConfig Web', + 'modal_heading' => 'Synchronisation ISPConfig Web', + 'modal_description' => 'Lie les membres à leurs comptes d\'hébergement web.', + 'refresh_cache_label' => 'Vider le cache ISPConfig', + 'refresh_cache_helper' => 'Vide le cache avant la synchronisation.', + ], + 'nextcloud' => [ + 'heading' => 'Nextcloud', + 'description' => 'Lie les membres à leurs comptes Nextcloud.', + 'action_label' => 'Nextcloud', + 'modal_heading' => 'Synchronisation Nextcloud', + 'modal_description' => 'Lie les membres à leurs comptes Nextcloud.', + 'dry_run_label' => 'Mode simulation (dry-run)', + 'dry_run_helper' => 'Simule l\'opération sans effectuer de modifications.', + ], + 'services' => [ + 'heading' => 'Services membres', + 'description' => 'Synchronise les services associés aux membres actifs.', + 'action_label' => 'Services membres', + 'modal_heading' => 'Synchronisation des services', + 'modal_description' => 'Synchronise les services associés aux membres actifs.', + ], + ], + + 'status' => [ + 'pending' => 'En attente dans la file d\'exécution...', + 'running' => 'Exécution en cours...', + 'finished_at' => 'Terminé à :time', + ], + + 'action' => [ + 'submit' => 'Lancer', + ], +]; diff --git a/public/favicon.ico b/public/favicon.ico new file mode 100644 index 0000000..105bfb2 Binary files /dev/null and b/public/favicon.ico differ diff --git a/resources/css/app.css b/resources/css/app.css index a5a0876..dc102d8 100644 --- a/resources/css/app.css +++ b/resources/css/app.css @@ -5,6 +5,7 @@ @source '../views'; @source '../../vendor/laravel/framework/src/Illuminate/Pagination/resources/views/*.blade.php'; + @custom-variant dark (&:is(.dark *)); @theme { diff --git a/resources/css/filament-admin.css b/resources/css/filament-admin.css new file mode 100644 index 0000000..1817bfe --- /dev/null +++ b/resources/css/filament-admin.css @@ -0,0 +1,3 @@ +@import '../../vendor/andreia/filament-nord-theme/resources/css/theme.css'; + +@source '../../resources/views/filament/**/*.blade.php'; diff --git a/resources/views/filament/pages/partials/sync-status.blade.php b/resources/views/filament/pages/partials/sync-status.blade.php index b30dc48..512b565 100644 --- a/resources/views/filament/pages/partials/sync-status.blade.php +++ b/resources/views/filament/pages/partials/sync-status.blade.php @@ -1,12 +1,12 @@ @if($status['status'] === 'pending') -

En attente dans la file d'exécution...

+

{{ __('synchronisations.status.pending') }}

@elseif($status['status'] === 'running') -

Exécution en cours...

+

{{ __('synchronisations.status.running') }}

@elseif(in_array($status['status'], ['completed', 'failed']) && $status['output'])
{{ $status['output'] }}
@if($status['finished_at']) -

Terminé à {{ $status['finished_at'] }}

+

{{ __('synchronisations.status.finished_at', ['time' => $status['finished_at']]) }}

@endif @endif diff --git a/resources/views/filament/pages/synchronisations.blade.php b/resources/views/filament/pages/synchronisations.blade.php index 9ae876b..785d3a0 100644 --- a/resources/views/filament/pages/synchronisations.blade.php +++ b/resources/views/filament/pages/synchronisations.blade.php @@ -1,109 +1,142 @@ -@vite('resources/css/backend.css') -
hasRunningCommands()) wire:poll.5s @endif > @php - $dolibarr = $this->getCommandStatus('dolibarr'); - $expired = $this->getCommandStatus('cleanup_expired'); - $ispMail = $this->getCommandStatus('ispconfig_mail'); - $ispWeb = $this->getCommandStatus('ispconfig_web'); - $nextcloud = $this->getCommandStatus('nextcloud'); - $services = $this->getCommandStatus('services'); + $dolibarr = $this->getCommandStatus('dolibarr'); + $expired = $this->getCommandStatus('cleanup_expired'); + $ispMail = $this->getCommandStatus('ispconfig_mail'); + $ispWeb = $this->getCommandStatus('ispconfig_web'); + $nextcloud = $this->getCommandStatus('nextcloud'); + $services = $this->getCommandStatus('services'); @endphp - {{-- Dolibarr --}} - @include('filament.pages.partials.sync-heading', ['label' => 'Dolibarr', 'status' => $dolibarr]) + @include('filament.pages.partials.sync-heading', [ + 'label' => __('synchronisations.sections.dolibarr.heading'), + 'status' => $dolibarr, + ])

- Importe les membres et cotisations depuis Dolibarr. + {{ __('synchronisations.sections.dolibarr.description') }}

@include('filament.pages.partials.sync-status', ['status' => $dolibarr]) - - {{ $this->getAction('syncDolibarr') }} + + {{ __('synchronisations.action.submit') }} +
- {{-- Membres expirés --}} - @include('filament.pages.partials.sync-heading', ['label' => 'Membres expirés', 'status' => $expired]) + @include('filament.pages.partials.sync-heading', [ + 'label' => __('synchronisations.sections.expired.heading'), + 'status' => $expired, + ])

- Désactive les membres expirés dans Dolibarr, ISPConfig et Nextcloud. + {{ __('synchronisations.sections.expired.description') }}

@include('filament.pages.partials.sync-status', ['status' => $expired]) - - {{ $this->getAction('cleanupExpired') }} + + {{ __('synchronisations.action.submit') }} +
- {{-- ISPConfig Mail --}} - @include('filament.pages.partials.sync-heading', ['label' => 'ISPConfig Mail', 'status' => $ispMail]) + @include('filament.pages.partials.sync-heading', [ + 'label' => __('synchronisations.sections.ispconfig_mail.heading'), + 'status' => $ispMail, + ])

- Lie les membres à leurs comptes mail ISPConfig (@retzien.fr). + {{ __('synchronisations.sections.ispconfig_mail.description') }}

@include('filament.pages.partials.sync-status', ['status' => $ispMail]) - - {{ $this->getAction('syncISPConfigMail') }} + + {{ __('synchronisations.action.submit') }} +
- {{-- ISPConfig Web --}} - @include('filament.pages.partials.sync-heading', ['label' => 'ISPConfig Web', 'status' => $ispWeb]) + @include('filament.pages.partials.sync-heading', [ + 'label' => __('synchronisations.sections.ispconfig_web.heading'), + 'status' => $ispWeb, + ])

- Lie les membres à leurs comptes d'hébergement web. + {{ __('synchronisations.sections.ispconfig_web.description') }}

@include('filament.pages.partials.sync-status', ['status' => $ispWeb]) - - {{ $this->getAction('syncISPConfigWeb') }} + + {{ __('synchronisations.action.submit') }} +
- {{-- Nextcloud --}} - @include('filament.pages.partials.sync-heading', ['label' => 'Nextcloud', 'status' => $nextcloud]) + @include('filament.pages.partials.sync-heading', [ + 'label' => __('synchronisations.sections.nextcloud.heading'), + 'status' => $nextcloud, + ])

- Lie les membres à leurs comptes Nextcloud. + {{ __('synchronisations.sections.nextcloud.description') }}

@include('filament.pages.partials.sync-status', ['status' => $nextcloud]) - - {{ $this->getAction('syncNextcloud') }} + + {{ __('synchronisations.action.submit') }} +
- {{-- Services membres --}} - @include('filament.pages.partials.sync-heading', ['label' => 'Services membres', 'status' => $services]) + @include('filament.pages.partials.sync-heading', [ + 'label' => __('synchronisations.sections.services.heading'), + 'status' => $services, + ])

- Synchronise les services associés aux membres actifs. + {{ __('synchronisations.sections.services.description') }}

@include('filament.pages.partials.sync-status', ['status' => $services]) - - {{ $this->getAction('syncServices') }} + + {{ __('synchronisations.action.submit') }} +
- -
diff --git a/vite.config.js b/vite.config.js index 857b61a..acd7b90 100644 --- a/vite.config.js +++ b/vite.config.js @@ -11,8 +11,8 @@ export default defineConfig({ 'resources/css/app.css', 'resources/css/backend.css', 'resources/css/fonts.css', + 'resources/css/filament-admin.css', 'resources/js/app.tsx', - 'vendor/andreia/filament-nord-theme/resources/css/theme.css' ], ssr: 'resources/js/ssr.tsx', refresh: true,