diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..5b0885a --- /dev/null +++ b/.editorconfig @@ -0,0 +1,19 @@ +# EditorConfig is awesome: https://editorconfig.org + +# top-most EditorConfig file +root = true + +# Unix-style newlines with a newline ending every file +[*] +charset = utf-8 +end_of_line = lf +indent_style = space +indent_size = 2 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.php] +indent_size = 4 + +[*.md] +trim_trailing_whitespace = false diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml new file mode 100644 index 0000000..19d9a59 --- /dev/null +++ b/.github/workflows/changelog.yml @@ -0,0 +1,17 @@ +name: 'Generate Auto Changelog' +on: + push: + branches: + - main +jobs: + master: + name: 'build' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + with: + fetch-depth: 0 + - name: Generate Auto Changelog + uses: Evarisk/action-auto-changelog@master + with: + github_token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..01b4d1f --- /dev/null +++ b/.gitignore @@ -0,0 +1,22 @@ +# Generated binaries +/build/*.zip +/bin/*.zip +# Doxygen generated documentation +/build/doxygen/doxygen_warnings.log +/doc/code/doxygen +# Composer managed dependencies +/vendor +/dev/bin +# PHPdocumentor generated files +/build/phpdoc +/doc/code/phpdoc +# Sphinx generated files +/doc/user/build +/.settings/ +/.buildpath +/.project +# Other +*.back +/.gitattributes +node_modules +package-lock.json diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a0453 --- /dev/null +++ b/COPYING @@ -0,0 +1,621 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS diff --git a/README.md b/README.md index cb10567..8d8ec9d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,53 @@ -# digiboard -Tableau de bord pour les applications DigiRisk, DigiQuali et bien plus ... +# DigiBoard sur [DOLIBARR ERP CRM](https://dolibarr.org) + +## Informations + +- Numéro du module : 436320 +- Dernière mise à jour : 11/10/2024 +- Éditeur : [Evarisk](https://evarisk.com) +- Thème : Eldy Menu +- Licence : GPLv3 +- Disponible sur : Windows - MacOS - Linux + +### Version + +- Version : 1.0.0 +- PHP : 7.4.33 +- Compatibilité : Dolibarr 19.0.3 - 20.0.0 +- Saturne Framework : 1.7.0 + +## Liens + +- Support & Assistance : [Forum dolibarr.fr](https://dolibarr.fr) / Par mail à technique@evarisk.com +- Demo : [Demo DigiBoard](https://demodoli.digirisk.com) - ID: demo - Password: demo +- Documentation : [Wiki DigiBoard](https://wiki.dolibarr.org/index.php/Module_DigiBoard) +- Projet Github : [Projet DigiBoard](https://github.com/Evarisk/digiboard/projects?query=is%3Aopen) +- Saturne Framework : [Télécharger Saturne](https://dolistore.com/fr/modules/1906-Saturne.html) +- D'autres modules développés par Evarisk disponibles sur [Dolistore.com](https://dolistore.com) + +## Fonctionnalités + +- Tableau de bord pour les applications DigiRisk, DigiQuali et bien plus ... + +## Traductions + +- Français +- Anglais + +## Installation + +### Méthode 1 : + +- Depuis le menu "Déployer/Installer un module externe" de Dolibarr : +- Glisser l'archive ZIP 'module_digiboard-X.Y.Z' et cliquer sur "ENVOYER FICHIER" +- Glisser l'archive ZIP 'module_saturne-X.Y.Z' et cliquer sur "ENVOYER FICHIER" +- Activer le module dans la liste des Modules/Applications installés + +### Méthode 2 : + +- Dans le dossier "dolibarr/htdocs/custom" copier la ligne suivante : +``` +git clone https://github.com/Evarisk/digiboard.git +git clone https://github.com/Evarisk/saturne.git +``` +- Activer le module dans la liste des Modules/Applications installés diff --git a/admin/index.php b/admin/index.php new file mode 100644 index 0000000..cd6990e --- /dev/null +++ b/admin/index.php @@ -0,0 +1,2 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * \file admin/setup.php + * \ingroup digiboard + * \brief DigiBoard setup page + */ + +// Load DigiBoard environment +if (file_exists('../digiboard.main.inc.php')) { + require_once __DIR__ . '/../digiboard.main.inc.php'; +} elseif (file_exists('../../digiboard.main.inc.php')) { + require_once __DIR__ . '/../../digiboard.main.inc.php'; +} else { + die('Include of digiboard main fails'); +} + +// Load DigiBoard libraries +require_once __DIR__ . '/../lib/digiboard.lib.php'; + +// Global variables definitions +global $conf, $db, $langs, $user; + +// Load translation files required by the page +saturne_load_langs(); + +// Get parameters +$action = GETPOST('action', 'alpha'); + +// Security check - Protection if external user +$permissionToRead = $user->hasRight('digiboard', 'adminpage', 'read'); +saturne_check_access($permissionToRead); + +/* + * View + */ + +$title = $langs->trans('ModuleSetup', 'DigiBoard'); +$help_url = 'FR:Module_DigiBoard'; + +saturne_header(0,'', $title, $help_url); + +// Subheader +$linkBack = '' . $langs->trans('BackToModuleList') . ''; +print load_fiche_titre($title, $linkBack, 'title_setup'); + +// Configuration header +$head = digiboard_admin_prepare_head(); +print dol_get_fiche_head($head, 'settings', $title, -1, 'digiboard_color@digiboard'); + +$constArray['digiboard'] = [ + 'DIGIBOARD_DIGIRISIK_STATS_LOAD_ACCIDENT' => [ + 'name' => 'DigiRiskStatsLoadAccident', + 'description' => 'DigiRiskStatsLoadAccidentDescription', + 'code' => 'DIGIBOARD_DIGIRISIK_STATS_LOAD_ACCIDENT', + ] +]; +require __DIR__ . '/../../saturne/core/tpl/admin/object/object_const_view.tpl.php'; + +// Page end +print dol_get_fiche_end(); +$db->close(); +llxFooter(); diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..099f731 --- /dev/null +++ b/changelog.md @@ -0,0 +1 @@ +### Changelog diff --git a/class/actions_digiboard.class.php b/class/actions_digiboard.class.php new file mode 100644 index 0000000..bd557ae --- /dev/null +++ b/class/actions_digiboard.class.php @@ -0,0 +1,101 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * \file class/actions_digiboard.class.php + * \ingroup digiboard + * \brief DigiBoard hook overload + */ + +/** + * Class ActionsDigiboard + */ +class ActionsDigiboard +{ + /** + * @var DoliDB Database handler + */ + public DoliDB $db; + + /** + * @var string Error code (or message) + */ + public string $error = ''; + + /** + * @var array Errors. + */ + public array $errors = []; + + /** + * @var array Hook results. Propagated to $hookmanager->resArray for later reuse + */ + public array $results = []; + + /** + * @var string|null String displayed by executeHook() immediately after return + */ + public ?string $resprints; + + /** + * Constructor + * + * @param DoliDB $db Database handler + */ + public function __construct(DoliDB $db) + { + $this->db = $db; + } + + /** + * Overloading the addHtmlHeader function : replacing the parent's function with the one below + * + * @param array $parameters Hook metadata (context, etc...) + * @return int 0 < on error, 0 on success, 1 to replace standard code + */ + public function addHtmlHeader(array $parameters): int + { + if (strpos($parameters['context'], 'digiboardindex') !== false) { + $resourcesRequired = [ + 'css' => '/custom/digiriskdolibarr/css/digiriskdolibarr.min.css', + ]; + + $out = ''; + $out .= ''; + + $this->resprints = $out; + } + + return 0; // or return 1 to replace standard code + } + + /** + * Overloading the printUserListWhere function : replacing the parent's function with the one below + * + * @param array $parameters Hook metadata (context, etc...) + * @return int 0 < on error, 0 on success, 1 to replace standard code + */ + public function printUserListWhere(array $parameters): int + { + if (strpos($parameters['context'], 'digiboardindex') !== false) { + $this->resprints = ' WHERE 1 = 1'; + return 1; + } + + return 0; // or return 1 to replace standard code + } +} diff --git a/class/digiboarddashboard.class.php b/class/digiboarddashboard.class.php new file mode 100644 index 0000000..f511a7f --- /dev/null +++ b/class/digiboarddashboard.class.php @@ -0,0 +1,168 @@ + + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * \file class/digiboarddashboard.class.php + * \ingroup digiboard + * \brief Class file for manage DigiBoardDashboard + */ + +/** + * Class for DigiBoardDashboard + */ +class DigiboardDashboard +{ + /** + * @var DoliDB Database handler + */ + public DoliDB $db; + + /** + * Constructor + * + * @param DoliDB $db Database handler + */ + public function __construct(DoliDB $db) + { + $this->db = $db; + } + + /** + * Load dashboard info + * + * @return array + * @throws Exception + */ + public function load_dashboard(): array + { + $array['lists'] = []; + + if (isModEnabled('digiriskdolibarr') && isModEnabled('multicompany')) { + $getDigiRiskStatsList = $this->getDigiRiskStatsList(); + $array['digiriskdolibarr']['lists'] = [$getDigiRiskStatsList]; + } + + return $array; + } + + /** + * Get digirisk stats list with API + * + * @return array Graph datas (label/color/type/title/data etc..) + * @throws Exception + */ + public function getDigiRiskStatsList(): array + { + global $db, $mc, $langs; + + // Graph Title parameters + $array['title'] = $langs->transnoentities('DigiRiskStatsList'); + $array['picto'] = 'digiriskdolibarr_color@digiriskdolibarr'; + + // Graph parameters + $array['type'] = 'list'; + $array['labels'] = ['Site', 'Siret', 'RiskAssessmentDocument', 'DelayGenerateDate', 'NbEmployees', 'NbEmployeesInvolved', 'GreyRisk', 'OrangeRisk', 'RedRisk', 'BlackRisk']; + if (getDolGlobalInt('DIGIBOARD_DIGIRISIK_STATS_LOAD_ACCIDENT') > 0) { + $array['labels'][] = ['NbPresquAccidents', 'NbAccidents', 'NbAccidentsByEmployees', 'NbAccidentInvestigations', 'WorkStopDays', 'FrequencyIndex', 'FrequencyRate', 'GravityRate']; + } + + require_once __DIR__ . '/../../digiriskdolibarr/class/digiriskdolibarrdocuments/riskassessmentdocument.class.php'; + require_once __DIR__ . '/../../digiriskdolibarr/class/evaluator.class.php'; + require_once __DIR__ . '/../../digiriskdolibarr/class/digiriskelement.class.php'; + require_once __DIR__ . '/../../digiriskdolibarr/class/riskanalysis/risk.class.php'; + require_once __DIR__ . '/../../digiriskdolibarr/class/accident.class.php'; + + $riskAssessmentDocument = new RiskAssessmentDocument($this->db); + $evaluator = new Evaluator($this->db); + $digiriskElement = new DigiriskElement($this->db); + $risk = new Risk($this->db); + $accident = new Accident($this->db); + + $riskAssessmentDocument->ismultientitymanaged = 0; + $accident->ismultientitymanaged = 0; + $evaluator->ismultientitymanaged = 0; + + $arrayDigiRiskStatsList = []; + $filter = ''; + $riskAssessmentCotation = [1 => 'GreyRisk', 2 => 'OrangeRisk', 3 => 'RedRisk', 4 => 'BlackRisk']; + $sharingEntities = $mc->sharings['digiriskstats']; + $entities = $mc->getEntitiesList(false, false, true); + if (!empty($sharingEntities)) { + $currentEntity[] = 1; + $sharingEntitiesAndCurrent = array_unique(array_merge($currentEntity, $sharingEntities)); + $filter = $digiriskElement->getTrashExclusionSqlFilter(); + } + if (!empty($entities)) { + foreach ($entities as $entityID => $entityName) { + if (!empty($sharingEntitiesAndCurrent) && !in_array($entityID, $sharingEntitiesAndCurrent)) { + continue; + } + + $arrayDigiRiskStatsList[$entityID]['Site']['value'] = $entityName; + $arrayDigiRiskStatsList[$entityID]['Site']['morecss'] = 'left bold'; + $arrayDigiRiskStatsList[$entityID]['Siret']['value'] = dolibarr_get_const($db, 'MAIN_INFO_SIRET', $entityID); + + $moreParam['entity'] = $entityID; + $filterEntity = ' AND t.entity = ' . $entityID; + $moreParam['filter'] = $filterEntity; + $arrayGetGenerationDateInfos = $riskAssessmentDocument->getGenerationDateInfos($moreParam); + $arrayDigiRiskStatsList[$entityID]['RiskAssessmentDocument']['value'] = $arrayGetGenerationDateInfos['lastgeneratedate'] . $arrayGetGenerationDateInfos['moreContent']; + $arrayDigiRiskStatsList[$entityID]['DelayGenerateDate']['value'] = $arrayGetGenerationDateInfos['delaygeneratedate']; + + $moreParam['filter'] = ' AND u.entity IN (0,' . $entityID . ')'; + $employees = $evaluator->getNbEmployees($moreParam); + $moreParam['filter'] = 't.entity = ' . $entityID; + $arrayDigiRiskStatsList[$entityID]['NbEmployees']['value'] = $employees['nbemployees']; + $arrayDigiRiskStatsList[$entityID]['NbEmployeesInvolved']['value'] = $evaluator->getNbEmployeesInvolved($moreParam)['nbemployeesinvolved']; + + $moreParam['filter'] = $filter . $filterEntity; + $moreParam['multiEntityManagement'] = false; + $getRisksByCotation = $risk->getRisksByCotation($moreParam)['data']; + for ($i = 1; $i <= 4; $i++) { + $arrayDigiRiskStatsList[$entityID][$riskAssessmentCotation[$i]]['value'] = $getRisksByCotation[$i]; + $arrayDigiRiskStatsList[$entityID][$riskAssessmentCotation[$i]]['morecss'] = 'risk-evaluation-cotation'; + $arrayDigiRiskStatsList[$entityID][$riskAssessmentCotation[$i]]['moreAttr'] = 'data-scale=' . $i . ' style="line-height: 0; border-radius: 0;"'; + } + + if (getDolGlobalInt('DIGIBOARD_DIGIRISIK_STATS_LOAD_ACCIDENT') > 0) { + $moreParam['filter'] = $filterEntity; + $join = ' LEFT JOIN ' . MAIN_DB_PREFIX . $accident->table_element . ' as a ON a.rowid = t.fk_accident'; + $accidentsWithWorkStops = saturne_fetch_all_object_type('AccidentWorkStop', 'DESC', 't.rowid', 0, 0, ['customsql' => 't.entity = ' . $entityID], 'AND', false, false, false, $join); + $accidents = $accident->fetchAll('', '', 0, 0, ['customsql' => ' t.status > ' . Accident::STATUS_DRAFT . $moreParam['filter']]); + if (empty($accidents) && !is_array($accidents)) { + $accidents = []; + } + if (empty($accidentsWithWorkStops) && !is_array($accidentsWithWorkStops)) { + $accidentsWithWorkStops = []; + } + + $arrayDigiRiskStatsList[$entityID]['NbPresquAccidents']['value'] = $accident->getNbPresquAccidents()['nbpresquaccidents']; + $arrayDigiRiskStatsList[$entityID]['NbAccidents']['value'] = $accident->getNbAccidents($accidents, $accidentsWithWorkStops)['data']['accidents']; + $arrayDigiRiskStatsList[$entityID]['NbAccidentsByEmployees']['value'] = $accident->getNbAccidentsByEmployees($accidents, $accidentsWithWorkStops, $employees)['nbaccidentsbyemployees']; + $arrayDigiRiskStatsList[$entityID]['NbAccidentInvestigations']['value'] = $accident->getNbAccidentInvestigations($moreParam)['nbaccidentinvestigations']; + $arrayDigiRiskStatsList[$entityID]['WorkStopDays']['value'] = $accident->getNbWorkstopDays($accidentsWithWorkStops)['nbworkstopdays']; + $arrayDigiRiskStatsList[$entityID]['FrequencyIndex']['value'] = $accident->getFrequencyIndex($accidentsWithWorkStops, $employees)['frequencyindex']; + $arrayDigiRiskStatsList[$entityID]['FrequencyRate']['value'] = $accident->getFrequencyRate($employees)['frequencyrate']; + $arrayDigiRiskStatsList[$entityID]['GravityRate']['value'] = $accident->getGravityRate($employees)['gravityrate']; + } + } + } + $array['data'] = $arrayDigiRiskStatsList; + + return $array; + } +} diff --git a/class/index.php b/class/index.php new file mode 100644 index 0000000..cd6990e --- /dev/null +++ b/class/index.php @@ -0,0 +1,2 @@ + + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * \defgroup digiboard Module DigiBoard + * \brief DigiBoard module descriptor + * + * \file core/modules/modDigiBoard.class.php + * \ingroup digiboard + * \brief Description and activation file for module DigiBoard + */ + +// Load Dolibarr libraries +require_once DOL_DOCUMENT_ROOT . '/core/modules/DolibarrModules.class.php'; + +/** + * Description and activation class for module DigiBoard + */ +class modDigiBoard extends DolibarrModules +{ + /** + * Constructor. Define names, constants, directories, boxes, permissions + * + * @param DoliDB $db Database handler + */ + public function __construct($db) + { + global $langs, $conf; + $this->db = $db; + + if (file_exists(__DIR__ . '/../../../saturne/lib/saturne_functions.lib.php')) { + require_once __DIR__ . '/../../../saturne/lib/saturne_functions.lib.php'; + saturne_load_langs(['digiboard@digiboard']); + } else { + $this->error++; + $this->errors[] = $langs->trans('activateModuleDependNotSatisfied', 'DigiBoard', 'Saturne'); + } + + // ID for module (must be unique) + $this->numero = 436320; + + // Key text used to identify module (for permissions, menus, etc...) + $this->rights_class = 'digiboard'; + + // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...' + // It is used to group modules by family in module setup page + $this->family = ''; + + // Module position in the family on 2 digits ('01', '10', '20', ...) + $this->module_position = ''; + + // Gives the possibility for the module, to provide his own family info and position of this family (Overwrite $this->family and $this->module_position. Avoid this) + $this->familyinfo = ['Evarisk' => ['position' => '01', 'label' => 'Evarisk']]; + // Module label (no space allowed), used if translation string 'ModuleDigiBoardName' not found (DigiBoard is name of module) + $this->name = preg_replace('/^mod/i', '', get_class($this)); + + // Module description, used if translation string 'ModuleDigiBoardDesc' not found (DigiBoard is name of module) + $this->description = $langs->transnoentities('DigiBoardDescription'); + // Used only if file README.md and README-LL.md not found + $this->descriptionlong = $langs->transnoentities('DigiBoardDescriptionLong'); + + // Author + $this->editor_name = 'Evarisk'; + $this->editor_url = 'https://evarisk.com'; + + // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z' + $this->version = '1.0.0'; + + // Url to the file with your last numberversion of this module + //$this->url_last_version = 'http://www.example.com/versionmodule.txt'; + + // Key used in llx_const table to save module status enabled/disabled (where DigiBoard is value of property name of module in uppercase) + $this->const_name = 'MAIN_MODULE_' . strtoupper($this->name); + + // Name of image file used for this module + // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue' + // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module' + // To use a supported fa-xxx css style of font awesome, use this->picto='xxx' + $this->picto = 'digiboard_color@digiboard'; + + // Define some features supported by module (triggers, login, substitutions, menus, css, etc...) + $this->module_parts = [ + // Set this to 1 if module has its own trigger directory (core/triggers) + 'triggers' => 0, + // Set this to 1 if module has its own login method file (core/login) + 'login' => 0, + // Set this to 1 if module has its own substitution function file (core/substitutions) + 'substitutions' => 0, + // Set this to 1 if module has its own menus handler directory (core/menus) + 'menus' => 0, + // Set this to 1 if module overwrite template dir (core/tpl) + 'tpl' => 0, + // Set this to 1 if module has its own barcode directory (core/modules/barcode) + 'barcode' => 0, + // Set this to 1 if module has its own models' directory (core/modules/xxx) + 'models' => 0, + // Set this to 1 if module has its own printing directory (core/modules/printing) + 'printing' => 0, + // Set this to 1 if module has its own theme directory (theme) + 'theme' => 0, + // Set this to relative path of css file if module has its own css file + 'css' => [], + // Set this to relative path of js file if module must load a js on all pages + 'js' => [], + // Set here all hooks context managed by module. To find available hook context, make a "grep -r '>initHooks(' *" on source code. You can also set hook context to 'all' + 'hooks' => [ + 'digiboardindex' + ], + // Set this to 1 if features of module are opened to external users + 'moduleforexternal' => 0 + ]; + + // Data directories to create when module is enabled + // Example: this->dirs = array("/digiboard/temp","/digiboard/subdir"); + $this->dirs = [ + '/digiboard/temp', + ]; + + // Config pages. Put here list of php page, stored into digiboard/admin directory, to use to set up module + $this->config_page_url = ['setup.php@digiboard']; + + // Dependencies + // A condition to hide module + $this->hidden = false; + + // List of module class names as string that must be enabled if this module is enabled. Example: array('always1'=>'modModuleToEnable1','always2'=>'modModuleToEnable2', 'FR1'=>'modModuleToEnableFR'...) + $this->depends = ['modSaturne', 'modDigiriskDolibarr', 'modMultiCompany']; + $this->requiredby = ['']; // List of module class names as string to disable if this one is disabled. Example: array('modModuleToDisable1', ...) + $this->conflictwith = []; // List of module class names as string this module is in conflict with. Example: array('modModuleToDisable1', ...) + + // The language file dedicated to your module + $this->langfiles = ['digiboard@digiboard']; + + // Prerequisites + $this->phpmin = [7, 4]; // Minimum version of PHP required by module + $this->need_dolibarr_version = [19, 0]; // Minimum version of Dolibarr required by module + + // Messages at activation + $this->warnings_activation = []; // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','MX'='textmx'...) + $this->warnings_activation_ext = []; // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','MX'='textmx'...) + //$this->automatic_activation = array('FR'=>'DigiBoardWasAutomaticallyActivatedBecauseOfYourCountryChoice'); + //$this->always_enabled = true; // If true, can't be disabled + + // Constants + // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive) + // Example: $this->const=array(1 => array('DIGIBOARD_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1), + // 2 => array('DIGIBOARD_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1) + // ); + $i = 0; + $this->const = [ + // CONST CONFIGURATION + $i++ => ['DIGIBOARD_DIGIRISIK_STATS_LOAD_ACCIDENT', 'integer', 0, '', 0, 'current'], + + // CONST MODULE + $i++ => ['DIGIBOARD_VERSION', 'chaine', $this->version, '', 0, 'current'], + $i++ => ['DIGIBOARD_DB_VERSION', 'chaine', $this->version, '', 0, 'current'], + $i => ['DIGIBOARD_SHOW_PATCH_NOTE', 'integer', 1, '', 0, 'current'], + ]; + + // Some keys to add into the overwriting translation tables + /*$this->overwrite_translation = array( + 'en_US:ParentCompany'=>'Parent company or reseller', + 'fr_FR:ParentCompany'=>'Maison mère ou revendeur' + )*/ + + if (!isset($conf->digiboard) || !isset($conf->digiboard->enabled)) { + $conf->digiboard = new stdClass(); + $conf->digiboard->enabled = 0; + } + + // Array to add new pages in new tabs + $this->tabs = []; + + // Dictionaries + $this->dictionaries = []; + + // Boxes/Widgets + // Add here list of php file(s) stored in digiboard/core/boxes that contains a class to show a widget + $this->boxes = []; + + // Cronjobs (List of cron jobs entries to add when module is enabled) + // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week + $this->cronjobs = []; + + // Permissions provided by this module + $this->rights = []; + $r = 0; + + /* DIGIBOARD PERMISSIONS */ + $this->rights[$r][0] = $this->numero . sprintf('%02d', $r + 1); // Permission id (must not be already used) + $this->rights[$r][1] = $langs->trans('LireModule', 'DigiBoard'); // Permission label + $this->rights[$r][4] = 'lire'; // In php code, permission will be checked by test if ($user->rights->digiboard->session->read) + $this->rights[$r][5] = 1; + $r++; + $this->rights[$r][0] = $this->numero . sprintf('%02d', $r + 1); + $this->rights[$r][1] = $langs->trans('ReadModule', 'DigiBoard'); + $this->rights[$r][4] = 'read'; + $this->rights[$r][5] = 1; + $r++; + + /* ADMINPAGE PANEL ACCESS PERMISSIONS */ + $this->rights[$r][0] = $this->numero . sprintf('%02d', $r + 1); + $this->rights[$r][1] = $langs->transnoentities('ReadAdminPage', 'DigiBoard'); + $this->rights[$r][4] = 'adminpage'; + $this->rights[$r][5] = 'read'; + + // Main menu entries to add + $this->menu = []; + $r = 0; + + // Add here entries to declare new menus + $this->menu[$r++] = [ + 'fk_menu' => 'fk_mainmenu=digiriskdolibarr', + 'type' => 'left', + 'titre' => $langs->transnoentities('DigiBoard'), + 'prefix' => '', + 'mainmenu' => 'digiriskdolibarr', + 'leftmenu' => 'digiboardconfig', + 'url' => '/digiboard/digiboardindex.php', + 'langs' => 'digiboard@digiboard', + 'position' => 10 + $r, + 'enabled' => '$conf->digiboard->enabled && $conf->digiriskdolibarr->enabled', + 'perms' => '$user->rights->digiboard->read && $user->rights->digiriskdolibarr->read ', + 'target' => '', + 'user' => 0, + ]; + } + + /** + * Function called when module is enabled + * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database + * It also creates data directories + * + * @param string $options Options when enabling module ('', 'noboxes') + * @return int 1 if OK, 0 if KO + * @throws Exception + */ + public function init($options = ''): int + { + global $conf; + + // Permissions + $this->remove($options); + + $sql = []; + + dolibarr_set_const($this->db, 'DIGIBOARD_VERSION', $this->version, 'chaine', 0, '', $conf->entity); + dolibarr_set_const($this->db, 'DIGIBOARD_DB_VERSION', $this->version, 'chaine', 0, '', $conf->entity); + + $params = [ + 'digiboard' => [ // nom informatif du module externe qui apporte ses paramètres + 'sharingelements' => [ // section des paramètres 'element' et 'object' + 'digiriskstats' => [ // Valeur utilisée dans getEntity() + 'type' => 'element', // element: partage d'éléments principaux (thirdparty, product, member, etc...) + 'icon' => 'chart-bar', // Font Awesome icon + 'lang' => 'digiboard@digiboard', // Fichier de langue contenant les traductions + 'tooltip' => 'DigiriskStatsSharedTooltip', // Message Tooltip (ne pas mettre cette clé si pas de tooltip) + 'enable' => '!empty($conf->digiboard->enabled) && !empty($conf->digiriskdolibarr->enabled)', // Conditions d'activation du partage + 'input' => [ // input : Paramétrage de la réaction du bouton on/off + 'global' => [ // global : réaction lorsqu'on désactive l'option de partage global + 'showhide' => true, // showhide : afficher/cacher le bloc de partage lors de l'activation/désactivation du partage global + 'hide' => true, // hide : cache le bloc de partage lors de la désactivation du partage global + 'del' => true // del : suppression de la constante du partage lors de la désactivation du partage global + ] + ] + ] + ], + 'sharingmodulename' => [ // correspondance des noms de modules pour le lien parent ou compatibilité (ex: 'productsupplierprice' => 'product') + 'digiriskstats' => 'digiboard', + ] + ] + ]; + + $externalModule = json_decode(getDolGlobalString('MULTICOMPANY_EXTERNAL_MODULES_SHARING'), true); + $externalModule = !empty(getDolGlobalString('MULTICOMPANY_EXTERNAL_MODULES_SHARING')) ? array_merge($externalModule, $params) : $params; + dolibarr_set_const($this->db, 'MULTICOMPANY_EXTERNAL_MODULES_SHARING', json_encode($externalModule), 'json', 0, '', 0); + + return $this->_init($sql, $options); + } + + /** + * Function called when module is disabled + * Remove from database constants, boxes and permissions from Dolibarr database + * Data directories are not deleted + * + * @param string $options Options when enabling module ('', 'noboxes') + * @return int 1 if OK, 0 if KO + */ + public function remove($options = ''): int + { + $sql = []; + return $this->_remove($sql, $options); + } +} diff --git a/digiboard.main.inc.php b/digiboard.main.inc.php new file mode 100644 index 0000000..d2ae2dd --- /dev/null +++ b/digiboard.main.inc.php @@ -0,0 +1,35 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * \file digiboard.main.inc.php + * \ingroup digiboard + * \brief File that defines environment for Saturne common functions + */ + +$moduleName = 'DigiBoard'; +$moduleNameLowerCase = strtolower($moduleName); +$moduleNameUpperCase = strtoupper($moduleName); + +// Load Saturne environment +if (file_exists(__DIR__ . '/../saturne/saturne.main.inc.php')) { + require_once __DIR__ . '/../saturne/saturne.main.inc.php'; +} elseif (file_exists(__DIR__ . '/../../saturne/saturne.main.inc.php')) { + require_once __DIR__ . '/../../saturne/saturne.main.inc.php'; +} else { + die('Include of saturne main fails'); +} diff --git a/digiboardindex.php b/digiboardindex.php new file mode 100644 index 0000000..813757d --- /dev/null +++ b/digiboardindex.php @@ -0,0 +1,33 @@ + + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * \file digiboardindex.php + * \ingroup digiboard + * \brief Home page of digiboard top menu + */ + +// Load DigiBoard environment +if (file_exists('digiboard.main.inc.php')) { + require_once __DIR__ . '/digiboard.main.inc.php'; +} elseif (file_exists('../digiboard.main.inc.php')) { + require_once __DIR__ . '/../digiboard.main.inc.php'; +} else { + die('Include of digiboard main fails'); +} + +require_once __DIR__ . '/../saturne/core/tpl/index/index_view.tpl.php'; diff --git a/img/digiboard.png b/img/digiboard.png new file mode 100644 index 0000000..a79fd15 Binary files /dev/null and b/img/digiboard.png differ diff --git a/img/digiboard_color.png b/img/digiboard_color.png new file mode 100644 index 0000000..7581c37 Binary files /dev/null and b/img/digiboard_color.png differ diff --git a/img/index.php b/img/index.php new file mode 100644 index 0000000..cd6990e --- /dev/null +++ b/img/index.php @@ -0,0 +1,2 @@ + +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# +# Générique +# + +# Data - Donnée +ModuleDigiBoardName = DigiBoard +ModuleDigiBoardDesc = Tableau de bord pour les applications DigiRisk, DigiQuali et bien plus ... +DigiBoardDescription = Tableau de bord pour les applications DigiRisk, DigiQuali et bien plus ... +DigiBoardDescriptionLong = Tableau de bord pour les applications DigiRisk, DigiQuali et bien plus ... +EnableDigiBoard = Veuillez activer le module DigiBoard pour accéder à cette page + +# MultiCompany - MultiCompany +ShareDigiriskstats = Activer le partage des statistiques de DigiRisk +DigiriskStatsSharedTooltip = Partagez vos statistiques avec les autres entités de DigiRisk +DIGIRISKSTATSSharing = Partage des statistiques DigiRisk +DIGIRISKSTATSSharingDescription = Sélection des entités qui partageront leurs statistiques DigiRisk avec cette entité. +DigiRiskStatsList = Statistiques DigiRisk + + + +# +# Config page - Page d'administration +# + +# Setup - Réglages +DigiRiskStatsLoadAccident = Chargement des statistiques d'accidents de DigiRisk +DigiRiskStatsLoadAccidentDescription = Chargement des statistiques d'accidents de DigiRisk pour les entités partagées diff --git a/langs/fr_FR/index.php b/langs/fr_FR/index.php new file mode 100644 index 0000000..cd6990e --- /dev/null +++ b/langs/fr_FR/index.php @@ -0,0 +1,2 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * \file lib/digiboard.lib.php + * \ingroup digiboard + * \brief Library files with common functions for Admin conf + */ + +/** + * Prepare admin pages header + * + * @return array $head Array of tabs + */ +function digiboard_admin_prepare_head(): array +{ + // Global variables definitions + global $conf, $langs; + + // Load translation files required by the page + saturne_load_langs(); + + // Initialize values + $h = 0; + $head = []; + + $head[$h][0] = dol_buildpath('digiboard/admin/setup.php', 1); + $head[$h][1] = $conf->browser->layout == 'classic' ? '' . $langs->trans('ModuleSettings') : ''; + $head[$h][2] = 'settings'; + $h++; + + $head[$h][0] = dol_buildpath('saturne/admin/about.php', 1) . '?module_name=DigiBoard'; + $head[$h][1] = $conf->browser->layout == 'classic' ? '' . $langs->trans('About') : ''; + $head[$h][2] = 'about'; + $h++; + + complete_head_from_modules($conf, $langs, null, $head, $h, 'digiboard@digiboard'); + + complete_head_from_modules($conf, $langs, null, $head, $h, 'digiboard@digiboard', 'remove'); + + return $head; +} diff --git a/lib/index.php b/lib/index.php new file mode 100644 index 0000000..cd6990e --- /dev/null +++ b/lib/index.php @@ -0,0 +1,2 @@ +