From 15c378ba281f1009cede9d04acd6d00ad8b4d80d Mon Sep 17 00:00:00 2001 From: "matthias@arch" Date: Wed, 23 Nov 2022 02:00:43 +0100 Subject: [PATCH] initial commit --- .gitignore | 2 + LICENSE | 674 +++++++++++++++++++++++++++++++++++++ README.md | 22 ++ _regina.compdef.zsh | 30 ++ regina.1.man | 186 ++++++++++ regina.1.md | 103 ++++++ regina/collect.py | 112 ++++++ regina/database.py | 139 ++++++++ regina/main.py | 107 ++++++ regina/settings_manager.py | 25 ++ regina/sql_util.py | 41 +++ regina/visualize.py | 301 +++++++++++++++++ server_datenbank.uxf | 142 ++++++++ setup.py | 30 ++ 14 files changed, 1914 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 _regina.compdef.zsh create mode 100644 regina.1.man create mode 100644 regina.1.md create mode 100644 regina/collect.py create mode 100644 regina/database.py create mode 100644 regina/main.py create mode 100644 regina/settings_manager.py create mode 100644 regina/sql_util.py create mode 100644 regina/visualize.py create mode 100644 server_datenbank.uxf create mode 100755 setup.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9998860 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +testing/ +__pycache__ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c6c9682 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Regina +Regina is an analytics tool for nginx. +**R**uling **E**mpress **G**enerating **I**n-depth **N**ginx **A**nalytics (obviously) + +## About +It collects information from the nginx access.log and stores it in a sqlite3 database. +Regina supports several data visualization configurations and can generate an admin-analytics page from an html template file. + +## Visualization options: +- Line plot: Einmal seit Beginn der Aufzeichnung(pro Monat), einmal letzte 30 Tage (pro Tag) + x: date + y: #unique users, #unique requests +- Bar charts: + - unique user information: + - used browsers (in percent) + - used operating systems (in percent) + - countries (in percent) + - unique request information: + - requested files (in counts) + - HTTP referrers (in counts) +A unique user is a IP-address - user agent pair. +A unique request is a unique-user - requested file - date (day) - combination. diff --git a/_regina.compdef.zsh b/_regina.compdef.zsh new file mode 100644 index 0000000..807bb0d --- /dev/null +++ b/_regina.compdef.zsh @@ -0,0 +1,30 @@ +#compdef nicole +# https://zsh.sourceforge.io/Doc/Release/Completion-System.html#Completion-Functions +_lyrics-site() +{ + _values "lyrics site" \ + 'genius[use only genius.com]' \ + 'azlyrics[use only azlyrics.com]' \ + 'all[use all supported sites (default)]' +} + +_nicole() +{ + # each argument is + # n:message:action + # option[description]:message:action + # # -s allow stacking, eg -inr + _arguments -s \ + '-d[process directory]':directory:_directories \ + '-f[process file]':file:_files \ + '-r[go through directories recursively]' \ + '-s[silent]' \ + '-i[ignore history]' \ + '-n[do not write to history]' \ + '-o[overwrite if the file already has lyrics]' \ + '-t[test, only print lyrics, dont write to tags]' \ + '-h[show this]' \ + '--rm_explicit[remove the "Explicit" lyrics warning from the title tag]' \ + '--site[specify lyrics site]':lyrics-site:_lyrics-site +} +_nicole "$@" diff --git a/regina.1.man b/regina.1.man new file mode 100644 index 0000000..c31e739 --- /dev/null +++ b/regina.1.man @@ -0,0 +1,186 @@ +.\" Automatically generated by Pandoc 2.17.0.1 +.\" +.TH "NICOLE" "1" "April 2022" "nicole 2.0" "" +.hy +.SH NAME +.PP +\f[B]N\f[R]ew-\f[B]I\f[R]ntrepid-\f[B]C\f[R]hief-\f[B]O\f[R]f-\f[B]L\f[R]yrics-\f[B]E\f[R]mbedders +(obviously) +.PP +Nicole is a program that searches for lyrics and writes them into the +mp3-tag of a file. +.SH SYNOPSIS +.PP +Directory: +.PD 0 +.P +.PD +\ \ \ \f[B]nicole\f[R] [OPTION\&...] +-d DIRECTORY +.PD 0 +.P +.PD +File: +.PD 0 +.P +.PD +\ \ \ \f[B]nicole\f[R] [OPTION\&...] +-f FILE +.SS Files +.PP +Nicole supports FLAC and mp3 files. +Other files can not be edited (as of now). +Files that do not have a .flac or .mp3 extension are skipped +automatically. +.PP +\f[B]mp3\f[R]: lyrics are stored in \[lq]USLT\[rq] tag as +\[lq]lyrics-\[rq] +.PP +\f[B]flac\f[R]: lyrics are stored as vorbis-comment with key +\[lq]LYRICS\[rq] +.SS History +.PP +Nicole creates a history of all files that were processed in +\f[C]\[ti]/.configs/nicole\f[R]. +If a file is in the history, it will be skipped (unless \f[C]-i\f[R] is +passed). +If the lyrics for a file can not be obtained, it is added to +\f[C]\[ti]/.configs/nicole/failed_files\f[R]. +Those files are not skipped, the file only exists so that you can see +which lyrics were not downloaded. +.PP +If you don\[cq]t want your files in the history, add the \f[C]-n\f[R] +option. +.SS genius +.PP +Nicole searches for lyrics using the genius api with the \[lq]title\[rq] +and \[lq]artist\[rq] tags of the file. +If the title and artist names from genius and the tags are similar, the +lyrics are scraped from the url obtained through the api. +.SS azlyrics +.PP +Nicole creates an azlyrics.com url from the \[lq]title\[rq] and +\[lq]artist\[rq] tags of the file. +The lyrics are extracted from the html document using regex. +.PP +Unfortunately, there needs to be a 5 second delay between each request +to azlyrics.com because the site will block your ip for a while if you +send many requests. +.SS Important Note +.PP +Since the lyrics are extracted from html pages and not from an api, the +lyrics sites might temporarily block your ip address if you send too +many requests. +If that is the case, wait a few hours and try again. +.SH USAGE +.SS Command line options +.TP +\f[B]-d\f[R] directory +process directory [directory] +.TP +\f[B]-f\f[R] file +process file [file] +.TP +\f[B]-r\f[R] +go through directories recursively +.TP +\f[B]-s\f[R] +silent, no command-line output +.TP +\f[B]-i\f[R] +ignore history +.TP +\f[B]-n\f[R] +do not write to history +.TP +\f[B]-o\f[R] +overwrite if the file already has lyrics +.TP +\f[B]-t\f[R] +test, do not write lyrics to file, but print to stdout +.TP +\f[B]-h\f[R] +show this +.TP +\f[B]\[em]-rm_explicit\f[R] +remove the \[lq][Explicit]\[rq] lyrics warning from the song\[cq]s title +tag +.TP +\f[B]\[em]-site\f[R] site +onlysearch [site] for lyrics (genius or azlyrics) +.PP +If you do not specify a directory or file, the program will ask you if +you want to use the current working directory. +Example: \f[C]nicole -ior -d \[ti]/music/artist ----rm_explicit\f[R] +.SH INSTALLATION AND UPDATING +.PP +To update nicole, simply follow the installation instructions. +.SS pacman (Arch Linux) +.PP +Installing nicole using the Arch Build System also installs the man-page +and a zsh completion script, if you have zsh installed. +.IP +.nf +\f[C] +git clone https://github.com/MatthiasQuintern/nicole.git +cd nicole +makepkg -si +\f[R] +.fi +.SS pip +.PP +You can also install nicole with python-pip: +.IP +.nf +\f[C] +git clone https://github.com/MatthiasQuintern/nicole.git +cd nicole +python3 -m pip install . +\f[R] +.fi +.PP +You can also install it system-wide using +\f[C]sudo python3 -m pip install.\f[R] +.PP +If you also want to install the man-page and the zsh completion script: +.IP +.nf +\f[C] +sudo cp nicole.1.man /usr/share/man/man1/nicole.1 +sudo gzip /usr/share/man/man1/nicole.1 +sudo cp _nicole.compdef.zsh /usr/share/zsh/site-functions/_nicole +sudo chmod +x /usr/share/zsh/site-functions/_nicole +\f[R] +.fi +.SS Dependencies +.IP \[bu] 2 +https://github.com/quodlibet/mutagen read and write mp3-tags +.IP \[bu] 2 +https://www.crummy.com/software/BeautifulSoup deal with the html from +genius +.PP +The dependencies will be automatically installed when using the either +of the two installation options. +.SH CHANGELOG +.SS 2.0 +.IP \[bu] 2 +Nicole now supports lyrics from genius! +.SS 1.1 +.IP \[bu] 2 +Lyrics are now properly encoded. +.IP \[bu] 2 +If a title contains parenthesis or umlaute, multiple possible urls will +be checked. +.IP \[bu] 2 +Files are now processed in order +.SH COPYRIGHT +.PP +Copyright \[co] 2022 Matthias Quintern. +License GPLv3+: GNU GPL version 3 . +.PD 0 +.P +.PD +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. +.SH AUTHORS +Matthias Quintern. diff --git a/regina.1.md b/regina.1.md new file mode 100644 index 0000000..726d8fc --- /dev/null +++ b/regina.1.md @@ -0,0 +1,103 @@ +% NICOLE(1) nicole 2.0 +% Matthias Quintern +% April 2022 + +# Name +**R**uling **E**mpress **G**enerating **I**n-depth **N**ginx **A**nalytics (obviously) +Regina is an analytics tool for nginx. + +## About +It collects information from the nginx access.log and stores it in a sqlite3 database. +Regina supports several data visualization configurations and can generate an admin-analytics page from an html template file. + +# SYNOPSIS +| With config file: +| **regina** [OPTION...] + +## Visualization options: +- Line plot: Einmal seit Beginn der Aufzeichnung(pro Monat), einmal letzte 30 Tage (pro Tag) + x: date + y: #unique users, #unique requests +- Bar charts: + - unique user information: + - used browsers (in percent) + - used operating systems (in percent) + - countries (in percent) + - unique request information: + - requested files (in counts) + - HTTP referrers (in counts) +A unique user is a IP-address - user agent pair. +A unique request is a unique-user - requested file - date (day) - combination. + +## Command line options +**-d** directory +: process directory [directory] + +**-f** file +: process file [file] + +**-r** +: go through directories recursively + +**-s** +: silent, no command-line output + +**-i** +: ignore history + +**-n** +: do not write to history + +**-o** +: overwrite if the file already has lyrics + +**-t** +: test, do not write lyrics to file, but print to stdout + +**-h** +: show this + +**--rm_explicit** +: remove the "[Explicit]" lyrics warning from the song's title tag + +**--site** site +: onlysearch [site] for lyrics (genius or azlyrics) + +If you do not specify a directory or file, the program will ask you if you want to use the current working directory. +Example: `nicole -ior -d ~/music/artist --rm_explicit` + +# INSTALLATION AND UPDATING +To update nicole, simply follow the installation instructions. + +## pacman (Arch Linux) +Installing nicole using the Arch Build System also installs the man-page and a zsh completion script, if you have zsh installed. +```shell +git clone https://github.com/MatthiasQuintern/nicole.git +cd nicole +makepkg -si +``` + +## pip +You can also install nicole with python-pip: +```shell +git clone https://github.com/MatthiasQuintern/nicole.git +cd nicole +python3 -m pip install . +``` +You can also install it system-wide using `sudo python3 -m pip install.` + +If you also want to install the man-page and the zsh completion script: +```shell +sudo cp nicole.1.man /usr/share/man/man1/nicole.1 +sudo gzip /usr/share/man/man1/nicole.1 +sudo cp _nicole.compdef.zsh /usr/share/zsh/site-functions/_nicole +sudo chmod +x /usr/share/zsh/site-functions/_nicole +``` + +# CHANGELOG +## 1.0 +- Initial release + +# COPYRIGHT +Copyright © 2022 Matthias Quintern. License GPLv3+: GNU GPL version 3 .\ +This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. diff --git a/regina/collect.py b/regina/collect.py new file mode 100644 index 0000000..6b35441 --- /dev/null +++ b/regina/collect.py @@ -0,0 +1,112 @@ +import sqlite3 as sql +from re import match +from time import mktime +from datetime import datetime as dt +from database import t_request, t_user, t_file, t_filegroup, database_tables, get_filegroup +from sql_util import sanitize, sql_select, sql_exists, sql_insert, sql_tablesize + +DEBUG = True +def pdebug(*args): + if DEBUG: print(*args) + +def warning(w): + print(w) + + +months = ["Jan", "Feb", "Mar", "Apr", "Jun", "Jul", "Aut", "Sep", "Oct", "Nov", "Dez"] + +class Request: + def __init__(self, ip_address="", time_local="", request_type="", request_file="", request_protocol="", status="", bytes_sent="", referer="", user_agent=""): + self.ip_address = sanitize(ip_address) + self.time_local = 0 + #[20/Nov/2022:00:47:36 +0100] + m = match(r"\[(\d+)/(\w+)/(\d+):(\d+):(\d+):(\d+).*\]", time_local) + if m: + g = m.groups() + try: + datetime_ = dt(int(g[2]), months.index(g[1])+1, int(g[0]), int(g[3]), int(g[4]), int(g[5])) + self.time_local = int(mktime(datetime_.timetuple())) + except Exception as e: + warning(f"Request:__init__: {e}") + else: + warning(f"Request:__init__: Could not match time: '{time_local}'") + + self.request_type = sanitize(request_type) + self.request_file = sanitize(request_file) + self.request_protocol = sanitize(request_protocol) + self.status = sanitize(status) + self.bytes_sent = sanitize(bytes_sent) + self.referer = sanitize(referer) + self.user_agent = sanitize(user_agent) + + def insert_user_sql_str(self, user_id, user_table="user"): + return f"INSERT INTO {user_table} (user_id, ip_address, user_agent) VALUES ({user_id}, '{self.ip_address}', '{self.user_agent}');" + + def __repr__(self): + return f"{self.ip_address} - {self.time_local} - {self.request_file} - {self.user_agent} - {self.status}" + +re_remote_addr = r"[0-9a-fA-F.:]+" +re_remote_user = ".*" +re_time_local = r"\[.+\]" +re_request = r'"[^"]+"' +re_status = r'\d+' +re_body_bytes_sent = r'\d+' +re_http_referer = r'"([^"]*)"' +re_http_user_agent = r'"([^"]*)"' +re_log_format: str = f'({re_remote_addr}) - ({re_remote_user}) ({re_time_local}) ({re_request}) ({re_status}) ({re_body_bytes_sent}) {re_http_referer} {re_http_user_agent}' +def parse_log(logfile:str) -> list[Request]: + """ + create Request objects from each line in the logfile + """ + requests = [] + with open(logfile, "r") as file: + lines = file.readlines() + for line in lines: + m = match(re_log_format, line) + if m is None: + warning(f"parse_log: Unmatched line: '{line}'") + continue + # print(m.groups()) + g = m.groups() + request_ = m.groups()[3].split(" ") + if len(request_) != 3: + warning(f"parse_log: len('{m.groups()[3]}'.split(' ')) is {len(request_)} and not 3") + continue + requests.append(Request(ip_address=g[0], time_local=g[2], + request_type=request_[0], request_file=request_[1], request_protocol=request_[2], + status=g[4], bytes_sent=g[5], referer=g[6], user_agent=g[7])) + return requests + +def get_user_id(request: Request, cursor: sql.Cursor) -> int: + """ + get the user_id. Adds the user if not already existing + """ + # if user exists + if sql_exists(cursor, t_user, [("ip_address", request.ip_address), ("user_agent", request.user_agent)]): + user_id = sql_select(cursor, t_user, [("ip_address", request.ip_address), ("user_agent", request.user_agent)])[0][0] + else: # new user + # new user_id is number of elements + user_id: int = sql_tablesize(cursor, t_user) + pdebug("new user:", user_id, request.ip_address) + cursor.execute(request.insert_user_sql_str(user_id)) + return user_id + + +def add_requests_to_db(requests: list[Request], db_name: str): + conn = sql.connect(db_name) + cursor = conn.cursor() + for i in range(len(requests)): + request = requests[i] + pdebug("add_requests_to_db:", i, "request:", request) + user_id = get_user_id(request, cursor) + conn.commit() + group_id: int = get_filegroup(request.request_file, cursor) + # check if request is unique + group_id_name = database_tables[t_filegroup].key.name + user_id_name = database_tables[t_user].key.name + if sql_exists(cursor, t_request, [(group_id_name, group_id), (user_id_name, user_id), ("date", request.time_local)]): + pdebug("request exists:", request) + else: + pdebug("new request:", request) + request_id = sql_tablesize(cursor, t_request) + sql_insert(cursor, t_request, [[request_id, user_id, group_id, request.time_local, request.referer, request.status]]) diff --git a/regina/database.py b/regina/database.py new file mode 100644 index 0000000..08509e0 --- /dev/null +++ b/regina/database.py @@ -0,0 +1,139 @@ +import sqlite3 as sql +from sql_util import sanitize, sql_select, sql_exists, sql_insert, sql_tablesize +from os import path, listdir + +DEBUG = True +def pdebug(*args): + if DEBUG: print(*args) + +class Entry: + """ + represents an sql entry + type_ is INTEGER, TEXT, REAL... + """ + def __init__(self, name, type_) -> None: + self.name = name + self.type_ = type_ + def __repr__(self): + return f"[{self.name}] {self.type_}" + +class Table: + def __init__(self, name, key: Entry, entries: list[Entry]=[], constaints: list[str]=[]): + self.name = name + self.key = key + self.entries = entries + self.constaints = constaints + def create_sql_str(self): + return f"CREATE TABLE IF NOT EXISTS {self.name}\n({self})\n" + def __repr__(self): + s = f"{self.key} PRIMARY KEY" + for entry in self.entries: + s += f", {entry}" + for c in self.constaints: + s += f", {c}" + return s +t_request = "request" +t_file = "file" +t_filegroup = "filegroup" +t_user = "user" + +user_id = Entry("user_id", "INTEGER") +request_id = Entry("request_id", "INTEGER") +filegroup_id = Entry("group_id", "INTEGER") +ip_address_entry = Entry("ip_address", "TEXT") +filename_entry = Entry("filename", "TEXT") +database_tables = { + t_user: Table(t_user, user_id, [Entry("ip_address", "TEXT"), Entry("user_agent", "TEXT")], [f"UNIQUE({user_id.name})"]), + t_file: Table(t_file, filename_entry, [filegroup_id], [f"UNIQUE({filename_entry.name})"]), + t_filegroup: Table(t_filegroup, filegroup_id, [Entry("groupname", "TEXT")], [f"UNIQUE({filegroup_id.name})"]), + t_request: Table(t_request, request_id, [ + user_id, filegroup_id, Entry("date", "INTEGER"), Entry("referer", "TEXT"), Entry("status", "INTEGER") + ], ["UNIQUE(request_id)"]), +} + + + +def get_filegroup(filename: str, cursor: sql.Cursor) -> int: + """ + get the user_id. Adds the user if not already existing + """ + if sql_exists(cursor, t_file, [("filename", filename)]): + return sql_select(cursor, t_file, [("filename", filename)])[0][1] + else: + group_id = sql_tablesize(cursor, t_filegroup) + # pdebug("new file(group):", group_id, filename) + # add group + sql_insert(cursor, t_filegroup, [[group_id, filename]]) + # add file + sql_insert(cursor, t_file, [[filename, group_id]]) + return group_id + +def create_filegroups(cursor: sql.Cursor, filegroup_str: str): + # filegroup_str: 'name1: file1, file2, file3; name2: file33' + groups = filegroup_str.strip(";").split(";") + pdebug("create_filegroups", groups) + for group in groups: + name, vals = group.split(":") + # create/get group + if sql_exists(cursor, t_filegroup, [("groupname", name)]): + group_id = sql_select(cursor, t_filegroup, [("groupname", name)])[0][0] + else: + group_id = sql_tablesize(cursor, t_filegroup) + sql_insert(cursor, t_filegroup, [(group_id, name)]) + # pdebug("create_filegroups: group_id", group_id) + # create/edit file + for filename in vals.split(","): + if sql_exists(cursor, t_file, [("filename", filename)]): # if exist, update + cursor.execute(f"UPDATE {t_file} SET group_id = {group_id} WHERE filename = '{filename}'") + else: + sql_insert(cursor, t_file, [[filename, group_id]]) + +def get_files_from_dir_rec(p: str, files: list[str]): + """recursivly append all files to files""" + pdebug("get_files_from_dir_rec:",p) + if path.isfile(p): + files.append(p) + elif path.isdir(p): + for p_ in listdir(p): + get_files_from_dir_rec(p + "/" + p_, files) + +def get_auto_filegroup_str(location_and_dirs:list[tuple[str, str]], auto_group_filetypes:list[str]) -> str: + """ + :param list of nginx locations and the corresponding directories + :param auto_filetype_groups list of filetypes for auto grouping + """ + files: list[str] = [] + start_i = 0 + for location, dir_ in location_and_dirs: + get_files_from_dir_rec(dir_, files) + # replace dir_ with location, eg /www/website with / + for i in range(start_i, len(files)): + files[i] = files[i].replace(dir_, location).replace("//", "/") + filegroups = "" + # create groups for each filetype + for ft in auto_group_filetypes: + filegroups += f"{ft}:" + for file in files: + if file.endswith(f".{ft}"): + filegroups += f"{file}," + filegroups = filegroups.strip(",") + ";" + pdebug("get_auto_filegroup_str: found files:", files, "filegroups_str:", filegroups) + return filegroups + +def create_db(name, filegroup_str="", location_and_dirs:list[tuple[str, str]]=[], auto_group_filetypes=[]): + """ + create the name with database_tables + """ + conn = sql.connect(f"{name}") + cursor = conn.cursor() + for table in database_tables.values(): + cursor.execute(table.create_sql_str()) + filegroup_str = filegroup_str.strip("; ") + ";" + get_auto_filegroup_str(location_and_dirs, auto_group_filetypes) + print(filegroup_str) + create_filegroups(cursor, filegroup_str) + conn.commit() + conn.close() + + +if __name__ == '__main__': + create_db("test.db") diff --git a/regina/main.py b/regina/main.py new file mode 100644 index 0000000..1631741 --- /dev/null +++ b/regina/main.py @@ -0,0 +1,107 @@ +from enum import auto +from collect import parse_log, add_requests_to_db +from sys import argv, exit +from database import create_db +from os.path import isfile + +def parse_config_file(path): + server_name ="" + access_log_path = "" + db_path = "" + filegroups = "" + locs_and_dirs = [] + auto_group_filetypes = [] + with open(path, "r") as file: + lines = file.readlines() + for line in lines: + line = line.strip("\n ") + if line.startswith("#"): continue + arg, val = line.split("=") + arg = arg.strip(" ") + val = val.strip(" ") + if arg == "server-name": server_name = val + elif arg == "log": access_log_path = val + elif arg == "db": db_path = val + elif arg == "filegroups": filegroups = val + elif arg == "locs-and-dirs": locs_and_dirs = val + elif arg == "auto-group-filetypes": auto_group_filetypes = val + return server_name, access_log_path, db_path, filegroups, locs_and_dirs, auto_group_filetypes + + +def help(): + helpstring = """Command line options: + --server-name string + --log path to the access.log + --db name of the database + --filegroups string describing filegroups, eg 'name1: file1, file2; name2: file3, file4, file5;' + --auto-group-filetypes comma separated list of filetypes, eg 'css,png,gif' + --locs-and_dirs comma separated list of nginx_location:directory pairs, eg '/:/www/website' + --config-file path to a config file that specifies all the other parameters: param = value, where value has the same formatting as on the command line + """ + print(helpstring) +def missing_arg_val(arg): + print("Missing argument for", arg) + exit(1) + +def missing_arg(arg): + print("Missing ", arg) + exit(1) +if __name__ == '__main__': + server_name ="" + access_log_path = "" + db_path = "" + config_file = "" + filegroups = "" + auto_group_filetypes =[] + locs_and_dirs = [] + # parse args + i = 1 + while i in range(1, len(argv)): + if argv[i] == "--server-name": + if len(argv) > i + 1: server_name = argv[i+1] + else: missing_arg_val(argv[i]) + i += 1 + elif argv[i] == "--db": + if len(argv) > i + 1: db_path = argv[i+1] + else: missing_arg_val(argv[i]) + i += 1 + elif argv[i] == "--log": + if len(argv) > i + 1: access_log_path = argv[i+1] + else: missing_arg_val(argv[i]) + i += 1 + elif argv[i] == "--config": + if len(argv) > i + 1: config_file = argv[i+1] + else: missing_arg_val(argv[i]) + i += 1 + elif argv[i] == "--filegroups": + if len(argv) > i + 1: filegroups = argv[i+1] + else: missing_arg_val(argv[i]) + i += 1 + elif argv[i] == "--auto-group-filetypes": + if len(argv) > i + 1: auto_group_filetypes = argv[i+1] + else: missing_arg_val(argv[i]) + i += 1 + elif argv[i] == "--locs-and-dirs": + if len(argv) > i + 1: locs_and_dirs = argv[i+1] + else: missing_arg_val(argv[i]) + i += 1 + elif argv[i] == "--help": + help() + exit(0) + else: + i += 1 + + if config_file: + server_name, access_log_path, db_path, filegroups, locs_and_dirs, auto_group_filetypes = parse_config_file(config_file) + + if not server_name: missing_arg("--server-name") + if not access_log_path: missing_arg("--log") + if not db_path: missing_arg("--db") + if type(auto_group_filetypes) == str: + auto_group_filetypes = auto_group_filetypes.split(",") + if type(locs_and_dirs) == str: + locs_and_dirs = [ loc_and_dir.split(":") for loc_and_dir in locs_and_dirs.split(",") ] + if not isfile(db_path): + create_db(db_path, filegroups, locs_and_dirs, auto_group_filetypes) + requests = parse_log(access_log_path) + add_requests_to_db(requests, db_path) diff --git a/regina/settings_manager.py b/regina/settings_manager.py new file mode 100644 index 0000000..2e9b656 --- /dev/null +++ b/regina/settings_manager.py @@ -0,0 +1,25 @@ + +def read_settings_file(filepath: str, settings:dict, ignore_invalid_lines=True, allow_new_keys=False, convert_to_type=True): + lines = [] + with open(filepath, "r") as file: + lines = file.readlines() + + for i in range(len(lines)): + line = lines[i].strip("\n ") + if line.startswith("#"): continue + vals = line.split("=") + if not len(vals) == 2: + if ignore_invalid_lines: continue + else: raise KeyError(f"Invalid line: '{line}'") + vals[0] = vals[0].strip(" ") + if not allow_new_keys and vals[0] not in settings.keys(): + if ignore_invalid_lines: continue + else: raise KeyError(f"Invalid key: '{vals[0]}'") + if convert_to_type and type(settings[vals[0]]) not in [str, None]: + try: + settings[vals[0]] = type(settings[vals[0]])(vals[1].strip(" ")) + except Exception as e: + if not ignore_invalid_lines: raise e + else: continue + else: + settings[vals[0]] = vals[1].strip(" ") diff --git a/regina/sql_util.py b/regina/sql_util.py new file mode 100644 index 0000000..34b0dc5 --- /dev/null +++ b/regina/sql_util.py @@ -0,0 +1,41 @@ +import sqlite3 as sql +"""Various sql utilities""" + +def sanitize(s): + if type(s) != str: return s + return s\ + .replace("''", "'").replace("'", r"''").strip(" ") + # .replace('"', r'\"')\ + +def sql_get_constaint_str(constraints: list[tuple[str, str|int]], logic="AND") -> str: + c_str = "" + for name, val in constraints: + c_str += f"{name} = '{sanitize(val)}' {logic} " + return c_str.strip(logic + " ") + +def sql_get_value_str(values: list[list]) -> str: + c_str = "" + for params in values: + c_str += "(" + for p in params: c_str += f"'{sanitize(p)}', " + c_str = c_str.strip(", ") + "), " + return c_str.strip(", ") + +def sql_exists(cur: sql.Cursor, table: str, constraints: list[tuple[str, str|int]], logic="AND") -> bool: + cur.execute(f"SELECT EXISTS (SELECT 1 FROM {table} WHERE {sql_get_constaint_str(constraints, logic)})") + return cur.fetchone()[0] == 1 + +def sql_select(cur: sql.Cursor, table: str, constraints: list[tuple[str, str|int]], logic="AND"): + cur.execute(f"SELECT * FROM {table} WHERE {sql_get_constaint_str(constraints, logic)}") + return cur.fetchall() + +def sql_insert(cur: sql.Cursor, table: str, values: list[list]): + cur.execute(f"INSERT INTO {table} VALUES {sql_get_value_str(values)}") + +def sql_tablesize(cur: sql.Cursor, table: str) -> int: + cur.execute(f"SELECT Count(*) FROM {table}") + return cur.fetchone()[0] + +def sql_get_count_where(cur: sql.Cursor, table, constraints) -> int: + cur.execute(f"SELECT COUNT(*) FROM {table} WHERE {sql_get_constaint_str(constraints)}") + return cur.fetchone()[0] diff --git a/regina/visualize.py b/regina/visualize.py new file mode 100644 index 0000000..a34cd14 --- /dev/null +++ b/regina/visualize.py @@ -0,0 +1,301 @@ +import sqlite3 as sql +from sys import argv, exit +from database import t_request, t_user, t_file, t_filegroup, database_tables +from sql_util import sanitize, sql_select, sql_exists, sql_insert, sql_tablesize, sql_get_count_where +from re import fullmatch, findall +import matplotlib.pyplot as plt +import matplotlib as mpl + +settings = { + # "file_ranking_regex_whitelist": r".*\.((txt)|(html)|(css)|(php)|(png)|(jpeg)|(jpg)|(svg)|(gif))", + "file_ranking_regex_whitelist": r".*\.(html)", + "referer_ranking_regex_whitelist": r"", + "user_agent_ranking_regex_whitelist": r"", + "file_ranking_plot_max_files": 15, + # "plot_figsize": (60, 40), + "plot_dpi": 300, + "plot_tight_layout": False, + "plot_constrained_layout": False, +} +color_settings_filetypes = { + "red": ["html"], + "green": ["jpg", "png", "jpeg", "gif", "svg", "webp"], + "yellow": ["css"], + "grey": ["txt"] +} + +img_ft = "svg" +# these oses and browser can be detected: +# lower element takes precedence +user_agent_operating_systems = ["Windows", "Android", "Linux", "iPhone", "iPad", "Mac", "BSD"] +user_agent_browsers = ["Firefox", "DuckDuckGo", "SeaMonkey", "Vivaldi", "Yandex", "Brave", "SamsungBrowser", "Lynx", "Epiphany", "Chromium", "Chrome", "Safari", "Opera", "Edge"] +color_settings_browsers = { + "red": ["Safari"], + "orange": ["Firefox"], + "yellow": ["Chrome"], + "grey": ["Edge"], + "green": ["Chromium"], + "teal": ["Brave"] +} +color_settings_operating_systems = { + "red": ["Macintosh"], + "green": ["Android"], + "grey": ["iPhone", "iPad"], + "yellow": ["Linux"], + "teal": ["BSD"], + "#6464ff": ["Windows"], +} + + + + +# get all dates +def get_dates(cur: sql.Cursor) -> list[str]: + cur.execute(f"SELECT DISTINCT DATE(date, 'unixepoch') FROM {t_request}") + return [ date[0] for date in cur.fetchall() ] # fetchall returns tuples (date, ) + +def get_unique_user_ids_for_date(cur: sql.Cursor, date:str) -> list[int]: + cur.execute(f"SELECT DISTINCT user_id FROM {t_request} WHERE DATE(date, 'unixepoch') = '{sanitize(date)}'") + return [ user_id[0] for user_id in cur.fetchall() ] + +# get number of requests per day +def get_request_count_for_date(cur: sql.Cursor, date:str) -> int: + return sql_get_count_where(cur, t_request, [("DATE(date, 'unixepoch')", date)]) + +def get_unique_user_count(cur: sql.Cursor) -> int: + return sql_tablesize(cur, t_user) + +def get_user_agent(cur: sql.Cursor, user_id: int): + return sql_select(cur, t_user, [("user_id", user_id)])[0] + +# +# FILTERS +# +# re_user_agent = r"(?: ?([\w\- ]+)(?:\/([\w.]+))?(?: \(([^()]*)\))?)" +# 1: platform, 2: version, 3: details +def get_os_browser_pairs_from_agent(user_agent): + # for groups in findall(re_user_agent, user_agent): + operating_system = "" + browser = "" + mobile = "Mobi" in user_agent + for os in user_agent_operating_systems: + if os in user_agent: + operating_system = os + break + for br in user_agent_browsers: + if br in user_agent: + browser = br + break + if not operating_system or not browser: print(f"Warning: get_os_browser_pairs_from_agent: Could not find all information for agent '{user_agent}', found os: '{operating_system}' and browser: '{browser}'") + return operating_system, browser, mobile + +def get_os_browser_mobile_rankings(user_agent_ranking): + """ + returns [(count, operating_system)], [(count, browser)], mobile_user_percentage + """ + os_ranking = {} + os_count = 0.0 + browser_ranking = {} + browser_count = 0.0 + mobile_ranking = { True: 0.0, False: 0.0 } + for count, agent in user_agent_ranking: + os, browser, mobile = get_os_browser_pairs_from_agent(agent) + if os: + if os in os_ranking: os_ranking[os] += 1 + else: os_ranking[os] = 1 + os_count += 1 + if browser: + if browser in browser_ranking: browser_ranking[browser] += 1 + else: browser_ranking[browser] = 1 + browser_count += 1 + if (os or browser): + mobile_ranking[mobile] += 1 + try: + mobile_user_percentage = mobile_ranking[True] / (mobile_ranking[True] + mobile_ranking[False]) + except ZeroDivisionError: + mobile_user_percentage = 0.0 + + os_ranking = [(c/os_count, n) for n, c in os_ranking.items()] + os_ranking.sort() + browser_ranking = [(c/browser_count, n) for n, c in browser_ranking.items()] + browser_ranking.sort() + return os_ranking, browser_ranking, mobile_user_percentage + +# +# RANKINGS +# +def get_file_ranking(cur: sql.Cursor, min_date_unix_time = 0) -> list[tuple[int, str]]: + """ + :returns [(request_count, filename)] + """ + ranking = [] + cur.execute(f"SELECT DISTINCT group_id FROM {t_filegroup}") + for group in cur.fetchall(): + group = group[0] + filename = sql_select(cur, t_file, [("group_id", group)]) + if len(filename) == 0: continue + filename = filename[0][0] + if settings["file_ranking_regex_whitelist"]: + if not fullmatch(settings["file_ranking_regex_whitelist"], filename): + continue + # ranking.append((sql_get_count_where(cur, t_request, [("group_id", group)]), filename)) + cur.execute(f"SELECT COUNT(*) FROM {t_request} WHERE group_id = {group} AND date >= {min_date_unix_time}") + ranking.append((cur.fetchone()[0], filename)) + ranking.sort() + # print(ranking) + return ranking + +def get_user_agent_ranking(cur: sql.Cursor, min_date_unix_time = 0) -> list[tuple[int, str]]: + """ + :returns [(request_count, user_agent)] + """ + ranking = [] + cur.execute(f"SELECT DISTINCT user_id FROM {t_request} WHERE date >= {min_date_unix_time}") + for user_id in cur.fetchall(): + user_id = user_id[0] + user_agent = sql_select(cur, t_user, [("user_id", user_id)]) + if len(user_agent) == 0: continue + user_agent = user_agent[0][2] + if settings["user_agent_ranking_regex_whitelist"]: + if not fullmatch(settings["user_agent_ranking_regex_whitelist"], user_agent): + continue + # ranking.append((sql_get_count_where(cur, t_request, [("group_id", group)]), filename)) + cur.execute(f"SELECT COUNT(*) FROM {t_request} WHERE user_id = {user_id} AND date >= {min_date_unix_time}") + ranking.append((cur.fetchone()[0], user_agent)) + ranking.sort() + # print(ranking) + return ranking + +def get_ranking(field_name: str, table: str, whitelist_regex: str, cur: sql.Cursor, min_date_unix_time = 0) -> list[tuple[int, str]]: + """ + 1) get all the distinct entries for field_name after min_date_unix_time + 2) call get_name_function with the distinct entry + 3) for every entry, get the count in table after min_date_unix_time + 3) sort by count in ascending order + :returns [(request_count, name)] + """ + ranking = [] + cur.execute(f"SELECT DISTINCT {field_name} FROM {table} WHERE date >= {min_date_unix_time}") + for name in cur.fetchall(): + name = name[0] + if whitelist_regex: + if not fullmatch(whitelist_regex, name): + continue + # ranking.append((sql_get_count_where(cur, t_request, [("group_id", group)]), filename)) + cur.execute(f"SELECT COUNT(*) FROM {table} WHERE {field_name} = '{name}' AND date >= {min_date_unix_time}") + ranking.append((cur.fetchone()[0], name)) + ranking.sort() + # print(ranking) + return ranking + + +# +# PLOTTING +# +def add_vertikal_labels_in_bar_plot(labels, max_y_val, ax, bar_plot): + for idx,rect in enumerate(bar_plot): + height = rect.get_height() + if height > 0.8 * max_y_val: + height = 0.05 * max_y_val + ax.text(rect.get_x() + rect.get_width()/2., 1.05*height, + labels[idx], + ha='center', va='bottom', rotation=90) + +def plot_ranking(ranking: list[tuple[int, str]], fig=None, xlabel="", ylabel="", color_settings:dict|list=[]): + """ + make a bar plot of the most requested files + """ + if not fig: + fig = plt.figure(figsize=None, dpi=settings["plot_dpi"], linewidth=1.0, frameon=True, subplotpars=None, tight_layout=settings["plot_tight_layout"], constrained_layout=settings["plot_constrained_layout"]) + # create new axis if none is given + ax = fig.add_subplot(xlabel=xlabel, ylabel=ylabel) + # fill x y data + if len(ranking) > settings["file_ranking_plot_max_files"]: + start_index = len(ranking) - settings["file_ranking_plot_max_files"] + else: start_index = 0 + x_names = [] + y_counts = [] + colors = [] + for i in range(start_index, len(ranking)): + x_names.append(ranking[i][1]) + y_counts.append(ranking[i][0]) + ft = ranking[i][1].split(".")[-1] + color = "blue" + if not color_settings: color = "blue" + elif type(color_settings) == dict: + for key, val in color_settings.items(): + if ft in val: color = key + if not color: color = "blue" + elif type(color_settings) == list: + color = color_settings[(i - start_index) % len(color_settings)] + colors.append(color) + bar = ax.bar(x_names, y_counts, tick_label="", color=colors) + add_vertikal_labels_in_bar_plot(x_names, y_counts[-1], ax, bar) + # ax.ylabel(y_counts) + return fig + + +def plot_users_per_day(days, user_counts, fig=None): + pass + + +# +# MAIN +# +def missing_arg_val(arg): + print("Missing argument for", arg) + exit(1) + +def missing_arg(arg): + print("Missing ", arg) + exit(1) +if __name__ == '__main__': + server_name ="" + db_path = "" + # parse args + i = 1 + while i in range(1, len(argv)): + if argv[i] == "--server-name": + if len(argv) > i + 1: server_name = argv[i+1] + else: missing_arg_val(argv[i]) + i += 1 + elif argv[i] == "--db": + if len(argv) > i + 1: db_path = argv[i+1] + else: missing_arg_val(argv[i]) + i += 1 + else: + i += 1 + + if not server_name: missing_arg("--server-name") + if not db_path: missing_arg("--db") + + + + conn = sql.connect(db_path) + cur = conn.cursor() + file_ranking = get_file_ranking(cur) + referer_ranking = get_ranking("referer", t_request, settings["referer_ranking_regex_whitelist"], cur) + user_agent_ranking = get_user_agent_ranking(cur) + for count, agent in user_agent_ranking: + get_os_browser_pairs_from_agent(agent) + fig_file_ranking = plot_ranking(file_ranking, xlabel="Filename/Filegroup", ylabel="Number of requests", color_settings=color_settings_filetypes) + fig_file_ranking.savefig(f"ranking_files.{img_ft}") + + dates = get_dates(cur) + unique_users_for_dates = [] + print(dates, unique_users_for_dates) + for date in dates: + unique_users_for_dates.append(get_unique_user_ids_for_date(cur, date)) + print(dates, unique_users_for_dates) + os_ranking, browser_ranking, mobile_user_percentage = get_os_browser_mobile_rankings(user_agent_ranking) + fig_os_rating = plot_ranking(os_ranking, xlabel="Operating Systems", ylabel="Percentage", color_settings=color_settings_operating_systems) + fig_os_rating.savefig(f"ranking_operating_systems.{img_ft}") + fig_browser_rating = plot_ranking(browser_ranking, xlabel="Browsers", ylabel="Percentage", color_settings=color_settings_browsers) + fig_browser_rating.savefig(f"ranking_browsers.{img_ft}") + # print("File Ranking", file_ranking) + # print("referer Ranking", referer_ranking) + # print("user agent ranking", user_agent_ranking) + # print("Unique Users:", get_unique_user_count(cur)) + print("OS ranking", os_ranking) + print("Browser ranking", browser_ranking) + print("Mobile percentage", mobile_user_percentage) diff --git a/server_datenbank.uxf b/server_datenbank.uxf new file mode 100644 index 0000000..6895493 --- /dev/null +++ b/server_datenbank.uxf @@ -0,0 +1,142 @@ + + + 19 + + UMLClass + + 38 + 323 + 342 + 190 + + User +-- +<<PK>>- user_id +-- +- ip address +- user agent string +style=autoresize + + + + UMLClass + + 1064 + 323 + 247 + 152 + + FileGroup +-- +<<PK>>- group_id +-- +- group_name +style=autoresize + + + + Relation + + 874 + 323 + 228 + 95 + + lt=- +m1=n +m2=1 + + 10.0;20.0;100.0;20.0 + + + UMLClass + + 608 + 304 + 285 + 285 + + Request +-- +<<PK>>- request_id +-- +- user_id +- file name +-- +- date +- referer +- status +style=autoresize + + + + Relation + + 361 + 323 + 285 + 95 + + lt=- +m1=1 +m2=n + + 10.0;20.0;130.0;20.0 + + + UMLClass + + 1064 + 722 + 190 + 152 + + File +-- +<<PK>>- name +-- +- group_id +-- +style=autoresize + + + + Relation + + 1121 + 456 + 76 + 304 + + lt=- +m1=n +m2=1 + + 10.0;140.0;10.0;10.0 + + + UMLNote + + 779 + 95 + 570 + 133 + + One group contains multiple files. +Lets you group the images from a +html with the html itself +style=autoresize + + + + Relation + + 1083 + 209 + 57 + 152 + + lt=<- + 10.0;60.0;10.0;10.0 + + diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..642debb --- /dev/null +++ b/setup.py @@ -0,0 +1,30 @@ +from setuptools import setup + +setup( + name="regina", + version="1.0", + description="Get analytics from nginx logs and visualize them", + + author="Matthias Quintern", + author_email="matthias@quintern.xyz", + + url="https://git.quintern.xyz/MatthiasQuintern/regina.git", + + license="GPLv3", + + packages=["regina"], + install_requires=["sqlite3"], + + classifiers=[ + "Operating System :: POSIX :: Linux", + "Environment :: Console", + "Programming Language :: Python :: 3", + "Topic :: Server", + "Topic :: Utilities", + ], + + # scripts=["bin/nicole"], + entry_points={ + "console_scripts": [ "regina=regina.main:main" ], + }, +)