diff --git a/Dockerfile b/Dockerfile index 62f7da7..16e8060 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,7 +2,7 @@ FROM yobasystems/alpine-mariadb:latest ENV token "" ENV password "toor" -ENV encrypt "" +ENV encrypt "password" ENV MYSQL_DATABASE "Untis" ENV MYSQL_ROOT_PASSWORD $password @@ -21,8 +21,8 @@ RUN wget -O /untisbot-discord/lib/logback-core.jar https://repo1.maven.org/maven wget -O /untisbot-discord/lib/untis4j.jar "$(curl -s https://api.github.com/repos/ByteDream/untis4j/releases/latest | grep "browser_download_url" | grep "withDependencies.jar" | cut -d '"' -f 4)" && \ wget -O /untisbot-discord/lib/JDA.jar "$(curl -s https://api.github.com/repos/DV8FromTheWorld/JDA/releases/latest | grep "browser_download_url" | grep "withDependencies-min.jar" | cut -d '"' -f 4)" -COPY dockerfiles/run.sh /untisbot-discord/ -COPY dockerfiles/database.sql /untisbot-discord/ +COPY files/run.sh /untisbot-discord/ +COPY files/database.sql /untisbot-discord/ COPY src/ /untisbot-discord/src EXPOSE 3306 diff --git a/LICENCE b/LICENCE index a612ad9..2c03e26 100644 --- a/LICENCE +++ b/LICENCE @@ -1,373 +1,61 @@ -Mozilla Public License Version 2.0 -================================== +Copyright © 2007 Free Software Foundation, Inc. -1. Definitions --------------- +Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. -1.1. "Contributor" - means each individual or legal entity that creates, contributes to - the creation of, or owns Covered Software. +This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. +0. Additional Definitions. -1.2. "Contributor Version" - means the combination of the Contributions of others (if any) used - by a Contributor and that particular Contributor's Contribution. +As used herein, “this License” refers to version 3 of the GNU Lesser General Public License, and the “GNU GPL” refers to version 3 of the GNU General Public License. -1.3. "Contribution" - means Covered Software of a particular Contributor. +“The Library” refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. -1.4. "Covered Software" - means Source Code Form to which the initial Contributor has attached - the notice in Exhibit A, the Executable Form of such Source Code - Form, and Modifications of such Source Code Form, in each case - including portions thereof. +An “Application” is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. -1.5. "Incompatible With Secondary Licenses" - means +A “Combined Work” is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the “Linked Version”. - (a) that the initial Contributor has attached the notice described - in Exhibit B to the Covered Software; or +The “Minimal Corresponding Source” for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. - (b) that the Covered Software was made available under the terms of - version 1.1 or earlier of the License, but not also under the - terms of a Secondary License. +The “Corresponding Application Code” for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. +1. Exception to Section 3 of the GNU GPL. -1.6. "Executable Form" - means any form of the work other than Source Code Form. +You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. +2. Conveying Modified Versions. -1.7. "Larger Work" - means a work that combines Covered Software with other material, in - a separate file or files, that is not Covered Software. +If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: -1.8. "License" - means this document. + a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or + b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. -1.9. "Licensable" - means having the right to grant, to the maximum extent possible, - whether at the time of the initial grant or subsequently, any and - all of the rights conveyed by this License. +3. Object Code Incorporating Material from Library Header Files. -1.10. "Modifications" - means any of the following: +The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: - (a) any file in Source Code Form that results from an addition to, - deletion from, or modification of the contents of Covered - Software; or + a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. + b) Accompany the object code with a copy of the GNU GPL and this license document. - (b) any new file in Source Code Form that contains any Covered - Software. +4. Combined Works. -1.11. "Patent Claims" of a Contributor - means any patent claim(s), including without limitation, method, - process, and apparatus claims, in any patent Licensable by such - Contributor that would be infringed, but for the grant of the - License, by the making, using, selling, offering for sale, having - made, import, or transfer of either its Contributions or its - Contributor Version. +You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: -1.12. "Secondary License" - means either the GNU General Public License, Version 2.0, the GNU - Lesser General Public License, Version 2.1, the GNU Affero General - Public License, Version 3.0, or any later versions of those - licenses. + a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. + b) Accompany the Combined Work with a copy of the GNU GPL and this license document. + c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. + d) Do one of the following: + 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. + 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. + e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) -1.13. "Source Code Form" - means the form of the work preferred for making modifications. +5. Combined Libraries. -1.14. "You" (or "Your") - means an individual or a legal entity exercising rights under this - License. For legal entities, "You" includes any entity that - controls, is controlled by, or is under common control with You. For - purposes of this definition, "control" means (a) the power, direct - or indirect, to cause the direction or management of such entity, - whether by contract or otherwise, or (b) ownership of more than - fifty percent (50%) of the outstanding shares or beneficial - ownership of such entity. +You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: -2. License Grants and Conditions --------------------------------- + a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. + b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. -2.1. Grants +6. Revised Versions of the GNU Lesser General Public License. -Each Contributor hereby grants You a world-wide, royalty-free, -non-exclusive license: +The Free Software Foundation may publish revised and/or new versions of the GNU Lesser 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. -(a) under intellectual property rights (other than patent or trademark) - Licensable by such Contributor to use, reproduce, make available, - modify, display, perform, distribute, and otherwise exploit its - Contributions, either on an unmodified basis, with Modifications, or - as part of a Larger Work; and +Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. -(b) under Patent Claims of such Contributor to make, use, sell, offer - for sale, have made, import, and otherwise transfer either its - Contributions or its Contributor Version. - -2.2. Effective Date - -The licenses granted in Section 2.1 with respect to any Contribution -become effective for each Contribution on the date the Contributor first -distributes such Contribution. - -2.3. Limitations on Grant Scope - -The licenses granted in this Section 2 are the only rights granted under -this License. No additional rights or licenses will be implied from the -distribution or licensing of Covered Software under this License. -Notwithstanding Section 2.1(b) above, no patent license is granted by a -Contributor: - -(a) for any code that a Contributor has removed from Covered Software; - or - -(b) for infringements caused by: (i) Your and any other third party's - modifications of Covered Software, or (ii) the combination of its - Contributions with other software (except as part of its Contributor - Version); or - -(c) under Patent Claims infringed by Covered Software in the absence of - its Contributions. - -This License does not grant any rights in the trademarks, service marks, -or logos of any Contributor (except as may be necessary to comply with -the notice requirements in Section 3.4). - -2.4. Subsequent Licenses - -No Contributor makes additional grants as a result of Your choice to -distribute the Covered Software under a subsequent version of this -License (see Section 10.2) or under the terms of a Secondary License (if -permitted under the terms of Section 3.3). - -2.5. Representation - -Each Contributor represents that the Contributor believes its -Contributions are its original creation(s) or it has sufficient rights -to grant the rights to its Contributions conveyed by this License. - -2.6. Fair Use - -This License is not intended to limit any rights You have under -applicable copyright doctrines of fair use, fair dealing, or other -equivalents. - -2.7. Conditions - -Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted -in Section 2.1. - -3. Responsibilities -------------------- - -3.1. Distribution of Source Form - -All distribution of Covered Software in Source Code Form, including any -Modifications that You create or to which You contribute, must be under -the terms of this License. You must inform recipients that the Source -Code Form of the Covered Software is governed by the terms of this -License, and how they can obtain a copy of this License. You may not -attempt to alter or restrict the recipients' rights in the Source Code -Form. - -3.2. Distribution of Executable Form - -If You distribute Covered Software in Executable Form then: - -(a) such Covered Software must also be made available in Source Code - Form, as described in Section 3.1, and You must inform recipients of - the Executable Form how they can obtain a copy of such Source Code - Form by reasonable means in a timely manner, at a charge no more - than the cost of distribution to the recipient; and - -(b) You may distribute such Executable Form under the terms of this - License, or sublicense it under different terms, provided that the - license for the Executable Form does not attempt to limit or alter - the recipients' rights in the Source Code Form under this License. - -3.3. Distribution of a Larger Work - -You may create and distribute a Larger Work under terms of Your choice, -provided that You also comply with the requirements of this License for -the Covered Software. If the Larger Work is a combination of Covered -Software with a work governed by one or more Secondary Licenses, and the -Covered Software is not Incompatible With Secondary Licenses, this -License permits You to additionally distribute such Covered Software -under the terms of such Secondary License(s), so that the recipient of -the Larger Work may, at their option, further distribute the Covered -Software under the terms of either this License or such Secondary -License(s). - -3.4. Notices - -You may not remove or alter the substance of any license notices -(including copyright notices, patent notices, disclaimers of warranty, -or limitations of liability) contained within the Source Code Form of -the Covered Software, except that You may alter any license notices to -the extent required to remedy known factual inaccuracies. - -3.5. Application of Additional Terms - -You may choose to offer, and to charge a fee for, warranty, support, -indemnity or liability obligations to one or more recipients of Covered -Software. However, You may do so only on Your own behalf, and not on -behalf of any Contributor. You must make it absolutely clear that any -such warranty, support, indemnity, or liability obligation is offered by -You alone, and You hereby agree to indemnify every Contributor for any -liability incurred by such Contributor as a result of warranty, support, -indemnity or liability terms You offer. You may include additional -disclaimers of warranty and limitations of liability specific to any -jurisdiction. - -4. Inability to Comply Due to Statute or Regulation ---------------------------------------------------- - -If it is impossible for You to comply with any of the terms of this -License with respect to some or all of the Covered Software due to -statute, judicial order, or regulation then You must: (a) comply with -the terms of this License to the maximum extent possible; and (b) -describe the limitations and the code they affect. Such description must -be placed in a text file included with all distributions of the Covered -Software under this License. Except to the extent prohibited by statute -or regulation, such description must be sufficiently detailed for a -recipient of ordinary skill to be able to understand it. - -5. Termination --------------- - -5.1. The rights granted under this License will terminate automatically -if You fail to comply with any of its terms. However, if You become -compliant, then the rights granted under this License from a particular -Contributor are reinstated (a) provisionally, unless and until such -Contributor explicitly and finally terminates Your grants, and (b) on an -ongoing basis, if such Contributor fails to notify You of the -non-compliance by some reasonable means prior to 60 days after You have -come back into compliance. Moreover, Your grants from a particular -Contributor are reinstated on an ongoing basis if such Contributor -notifies You of the non-compliance by some reasonable means, this is the -first time You have received notice of non-compliance with this License -from such Contributor, and You become compliant prior to 30 days after -Your receipt of the notice. - -5.2. If You initiate litigation against any entity by asserting a patent -infringement claim (excluding declaratory judgment actions, -counter-claims, and cross-claims) alleging that a Contributor Version -directly or indirectly infringes any patent, then the rights granted to -You by any and all Contributors for the Covered Software under Section -2.1 of this License shall terminate. - -5.3. In the event of termination under Sections 5.1 or 5.2 above, all -end user license agreements (excluding distributors and resellers) which -have been validly granted by You or Your distributors under this License -prior to termination shall survive termination. - -************************************************************************ -* * -* 6. Disclaimer of Warranty * -* ------------------------- * -* * -* Covered Software is provided under this License on an "as is" * -* basis, without warranty of any kind, either expressed, implied, or * -* statutory, including, without limitation, warranties that the * -* Covered Software is free of defects, merchantable, fit for a * -* particular purpose or non-infringing. The entire risk as to the * -* quality and performance of the Covered Software is with You. * -* Should any Covered Software prove defective in any respect, You * -* (not any Contributor) assume the cost of any necessary servicing, * -* repair, or correction. This disclaimer of warranty constitutes an * -* essential part of this License. No use of any Covered Software is * -* authorized under this License except under this disclaimer. * -* * -************************************************************************ - -************************************************************************ -* * -* 7. Limitation of Liability * -* -------------------------- * -* * -* Under no circumstances and under no legal theory, whether tort * -* (including negligence), contract, or otherwise, shall any * -* Contributor, or anyone who distributes Covered Software as * -* permitted above, be liable to You for any direct, indirect, * -* special, incidental, or consequential damages of any character * -* including, without limitation, damages for lost profits, loss of * -* goodwill, work stoppage, computer failure or malfunction, or any * -* and all other commercial damages or losses, even if such party * -* shall have been informed of the possibility of such damages. This * -* limitation of liability shall not apply to liability for death or * -* personal injury resulting from such party's negligence to the * -* extent applicable law prohibits such limitation. Some * -* jurisdictions do not allow the exclusion or limitation of * -* incidental or consequential damages, so this exclusion and * -* limitation may not apply to You. * -* * -************************************************************************ - -8. Litigation -------------- - -Any litigation relating to this License may be brought only in the -courts of a jurisdiction where the defendant maintains its principal -place of business and such litigation shall be governed by laws of that -jurisdiction, without reference to its conflict-of-law provisions. -Nothing in this Section shall prevent a party's ability to bring -cross-claims or counter-claims. - -9. Miscellaneous ----------------- - -This License represents the complete agreement concerning the subject -matter hereof. If any provision of this License is held to be -unenforceable, such provision shall be reformed only to the extent -necessary to make it enforceable. Any law or regulation which provides -that the language of a contract shall be construed against the drafter -shall not be used to construe this License against a Contributor. - -10. Versions of the License ---------------------------- - -10.1. New Versions - -Mozilla Foundation is the license steward. Except as provided in Section -10.3, no one other than the license steward has the right to modify or -publish new versions of this License. Each version will be given a -distinguishing version number. - -10.2. Effect of New Versions - -You may distribute the Covered Software under the terms of the version -of the License under which You originally received the Covered Software, -or under the terms of any subsequent version published by the license -steward. - -10.3. Modified Versions - -If you create software not governed by this License, and you want to -create a new license for such software, you may create and use a -modified version of this License if you rename the license and remove -any references to the name of the license steward (except to note that -such modified license differs from this License). - -10.4. Distributing Source Code Form that is Incompatible With Secondary -Licenses - -If You choose to distribute Source Code Form that is Incompatible With -Secondary Licenses under the terms of this version of the License, the -notice described in Exhibit B of this License must be attached. - -Exhibit A - Source Code Form License Notice -------------------------------------------- - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - -If it is not possible or desirable to put the notice in a particular -file, then You may include the notice in a location (such as a LICENSE -file in a relevant directory) where a recipient would be likely to look -for such a notice. - -You may add additional accurate notices of copyright ownership. - -Exhibit B - "Incompatible With Secondary Licenses" Notice ---------------------------------------------------------- - - This Source Code Form is "Incompatible With Secondary Licenses", as - defined by the Mozilla Public License, v. 2.0. +If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. \ No newline at end of file diff --git a/README.md b/README.md index 48b5a89..c5b04e8 100644 --- a/README.md +++ b/README.md @@ -3,51 +3,60 @@ **UntisBot** is a java programmed discord bot, which uses the [WebUntis](https://webuntis.com/) timetable software / api to automatically sends messages when the timetable from a given account or class changes. You can invite the bot right [here](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.0/UntisBot-1.0.jar) or [host it yourself](#Self-hosting). +

+ Commands + • + Self-hosting + • + Language + • + Licence +

+ ## Commands The default prefix for the bot is `!untis `, so you have to call every command with `!untis `. -To see all available commands and get infos about it, simply type `help` +To see all available commands and get infos about it, simply type `help`. -`channel` - In the channel where this command is entered, the bot shows the timetable changes | eg. `channel`. +`<>` are required arguments, `[]` is optional. -`clear` - Clears the given untis data, given from the `data` command | eg. `clear`. - -`data [class name]` - Sets the data with which the bot logs in to untis and checks for timetable changes. The data is stored encrypted on the server. -`username` and `password` are the normal untis login data with which one also logs in to the untis website / app. To gain the login page url you have to go to webuntis.com, type in your school and choose it. -Then you will be redirected to the untis login page, The url of this page is the login page url, for example `https://example.webuntis.com/WebUntis/?school=myschool#/basic/main`. -`class name` is just the name of the class you want to check (eg. `12AB`). If `class name` is not specified, the bot tries to get the default class which is assigned to the given account. - -eg. `data myname secure https://example.webuntis.com/WebUntis/?school=example#/basic/main 12AB`. - -`help ` - Displays help to a given command | eg. `help data`. - -`language ` - Changes the language in which the timetable information are displayed. Currently only 'de' (german) and 'en' (english) are supported | eg. `language de` | default: `en`. - -`prefix ` - Changes the prefix with which commands are called | eg. `prefix $` | default: `!untis `. - -`stats` - Displays a message with some stats (total cancelled lessons, etc.) | eg. `stats`. - -`<>` = required; `[]` = optional +| command | usage | example | default | +| --- | --- | --- | --- | +| `channel` | In the channel where this command is entered, the bot shows the timetable changes | `channel` | - +| `clear` | Clears the given untis data, given from the `data` command | `clear` | - +| `data [class name]` | Sets the data with which the bot logs in to untis and checks for timetable changes. The data is stored encrypted on the server. `username` and `password` are the normal untis login data with which one also logs in to the untis website / app. To gain the login page url you have to go to webuntis.com, type in your school and choose it. Then you will be redirected to the untis login page, The url of this page is the login page url, for example `https://example.webuntis.com/WebUntis/?school=myschool#/basic/main`. `class name` is just the name of the class you want to check (eg. `12AB`). If `class name` is not specified, the bot tries to get the default class which is assigned to the given account. | `data myname secure https://example.webuntis.com/WebUntis/?school=example#/basic/main 12AB` | - | +| `help` | Displays help to a given command | `help data` | - | +| `language ` | Changes the language in which the timetable information are displayed. Currently only `de` (german) and `en` (english) are supported | `language de` | `en` | +| `prefix ` | Changes the prefix with which commands are called | `prefix $` | `!untis ` | +| `stats` | Displays a message with some stats (total cancelled lessons, etc.) | `stats` | - | Note: All commands except for `help ` and `` can only be executed by a member with admin rights. ## Self-hosting +The first step before setting up the bot is to generate a bot token on the [discord developer website](https://discord.com/developers/applications). +A more detailed instruction can be found [here](https://www.writebots.com/discord-bot-token/). + If you want to host **UntisBot** on your own server / pc you have the choice between two types of hosting: - Run the bot in a [docker container](#Docker) - - Run it [natively](#Natively) on your machine + - Run it [manually](#Manually) on your machine ## Docker -Download this repository with `git clone https://github.com/ByteDream/untisbot-discord.git` and go into the cloned directory. -Then run `docker build -t untisbot-discord .` to build the docker image and if this is done, type `docker run -d --name untisbot-discord -e token= untisbot-discord` to run it. +To run the bot in a docker container, follow the commands below +```bash +git clone https://github.com/ByteDream/untisbot-discord.git +cd untisbot-discord +docker build -t untisbot-discord . +docker run -d --name untisbot-discord -e token= untisbot-discord +``` Note: You can declare more [environment variables](#Run-options-for-docker-container) besides `token`. -## Natively +## Manually -When you run the bot natively you can choose from 2 types of data storage: +When you run the bot manually you can choose from 2 types of data storage: - [In-memory](#In-memory-storage) (simpler) - [Database storage](#MariaDB) (MariaDB) @@ -65,28 +74,10 @@ With MariaDB you can store the data safely in a sql database, and they won't be If you haven't installed MariaDB, you can follow the instructions from [here](https://linuxize.com/post/how-to-install-mariadb-on-ubuntu-18-04/) (this tutorial is for ubuntu, but it should work with every debian distro). -To set up the database, you have two options to choose from. - -##### The short one: +To set up the database, you have to execute the following command and replace `` with the sql user which should manage the database. ```bash -mysql --user= --password= -e "CREATE DATABASE Untis;" && wget -qO- https://raw.githubusercontent.com/ByteDream/untisbot-discord/master/src/org/bytedream/untisbot/dockerfiles/database.sql | mysql --user= --password= Untis +mysql -u -p -e "CREATE DATABASE Untis; USE Untis; $(wget -qO- https://raw.githubusercontent.com/ByteDream/untisbot-discord/master/files/database.sql)" ``` -Just copy this and replace `` with the sql user which should manage the database and `` with the user's password. - ---- - -##### And the long one: - -First you have to connect you with MariaDB. When you are connected, enter the following commands (without the '>'): -```sql -> CREATE DATABASE Untis; -> USE Untis; -> CREATE TABLE Guilds (GUILDID BIGINT NOT NULL, LANGUAGE TINYTEXT, USERNAME TINYTEXT, PASSWORD TEXT, SERVER TINYTEXT, SCHOOL TINYTEXT, KLASSEID SMALLINT, CHANNELID BIGINT, PREFIX VARCHAR(7) DEFAULT '!untis ' NOT NULL, SLEEPTIME BIGINT DEFAULT 3600000 NOT NULL, ISCHECKACTIVE BOOLEAN DEFAULT FALSE NOT NULL, LASTCHECKED DATE); -> CREATE TABLE Stats (GUILDID BIGINT NOT NULL, TOTALREQUESTS INT DEFAULT 0 NOT NULL, TOTALDAYS SMALLINT DEFAULT 0 NOT NULL, TOTALLESSONS INT DEFAULT 0 NOT NULL, TOTALCANCELLEDLESSONS SMALLINT DEFAULT 0 NOT NULL, TOTALMOVEDLESSONS SMALLINT DEFAULT 0 NOT NULL, AVERAGECANCELLEDLESSONS FLOAT DEFAULT 0 NOT NULL, AVERAGEMOVEDLESSONS FLOAT DEFAULT 0 NOT NULL); -> CREATE TABLE AbsentTeachers (GUILDID BIGINT NOT NULL, TEACHERNAME TINYTEXT NOT NULL, ABSENTLESSONS SMALLINT NOT NULL); -``` - ---- Now you have set up the database and are ready to go. Download the [jar]() and run it with `java -jar UntisBot-1.0.jar mariadb`. @@ -96,30 +87,39 @@ The syntax of the following arguments / run option is very simple: `key=value`. ### Run options for docker container -When you start the container you can declare several environment variables: - - `token` (required!) - The discord bot token - - `password` (optional) - Password for the given user | default: `toor` - - `encrypt` (optional) - A password to encrypt the user's untis username and password | default: `password` +When you start the container you can declare several environment variables + +| variable | description | default | required | +| --- | --- | --- | --- | +| `token` | The discord bot token | - | yes | +| `password` | Password for the given user | `toor` | no | +| `encrypt` | A password to encrypt the user's untis username and password | `password` | no | (always remember when declaring a new environment variable `-e` must be prefixed) ---- - Example: - - `docker run -d -e token=BLySFrzvz3tAHtquQevY1FF5W8CT0UMyMNmCSUCbJAPdNAmnnqYVBzaPTkz -e password=very_secure untisbot-discord` +```bash +docker run -d -e token=BLySFrzvz3tAHtquQevY1FF5W8CT0UMyMNmCSUCbJAPdNAmnnqYVBzaPTkz -e password=very_secure untisbot-discord +``` -### Run options for native hosting +### Run options for manual hosting -There are several arguments to start the bot with: - - `token` (required!) - The discord bot token - - `encrypt` (optional) - A password to encrypt the user's untis username and password | default: `password` - - `lng` (optional) - Path to a language file | default: `` (uses the [internal](src/org/bytedream/untisbot/language.json) language file) +There are several arguments to start the bot with + +| variable | description | default | required | +| --- | --- | --- | --- | +| `token` | The discord bot token | - | yes | +| `encrypt` | A password to encrypt the user's untis username and password | `password` | no | +| `lng` | Path to a language file | uses the [internal](src/org/bytedream/untisbot/language.json) language file | no | The following arguments are only for MariaDB user: - - `user` (optional) - The user who should connect to the mariadb database | default: `root` - - `password` (optional) - Password for the given mariadb user | default: `` - - `port` (optional) - Port of mariadb | default: `3306` - - `ip` (optional) - IP address of mariadb | default: `127.0.0.1` + +| variable | description | default | required | +| --- | --- | --- | --- | +| `user` | The user who should connect to the mariadb database | `root` | no | +| `password` | Password for the given mariadb user | | no | +| `port` | Database port | `3306` | no | +| `user` | IP address of the database | `127.0.0.1` | no | If you want to use MariaDB as store type you have to add the argument `mariadb` (without any value). @@ -147,13 +147,23 @@ In-memory examples: MariaDB examples: - `UntisBot-1.0.jar mariadb token=BLySFrzvz3tAHtquQevY1FF5W8CT0UMyMNmCSUCbJAPdNAmnnqYVBzaPTkz encrypt=super_ultra_secure_password` - `UntisBot-1.0.jar mariadb token=BLySFrzvz3tAHtquQevY1FF5W8CT0UMyMNmCSUCbJAPdNAmnnqYVBzaPTkz encrypt=super_ultra_secure_password user=untis password=toor` - + +## Language + +The layout for the language file is available [here](src/org/bytedream/untisbot/language.json). + +If you want to add a language which isn't supported you can +- Host the bot [yourself](#Self-hosting) and use the `lng` variable (only compatible if you choose [manually hosting](#Manually)) +- Create a new [issue](https://github.com/ByteDream/untisbot-discord/issues/new) or [pull request](https://github.com/ByteDream/untisbot-discord/compare) + and paste in your json language. The layout has to be like [this](src/org/bytedream/untisbot/language.json). + Then, after a short check (thx [DeepL](https://www.deepl.com/translator)), I will add it to the repository. + ## Dependencies - Java 8 or higher - [Discord library](https://github.com/DV8FromTheWorld/JDA) (JDA) - [Untis library](https://github.com/ByteDream/untis4j) (untis4j) -- [MariaDB client](https://github.com/mariadb-corporation/mariadb-connector-j) (mariadb java client) +- [Database client](https://github.com/mariadb-corporation/mariadb-connector-j) (mariadb java client) - [Logger](https://github.com/qos-ch/logback) (logback-core and logback-classic) **_Note_: The [UntisBot jar file](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.0/UntisBot-1.0.jar) and the [Dockerfile](Dockerfile) are containing all dependencies.** @@ -161,4 +171,4 @@ MariaDB examples: ## License -This project is licensed under the Mozilla Public Licence 2.0 - see the [LICENSE](LICENCE) file for more details \ No newline at end of file +This project is licensed under the GNU Lesser General Public License v3.0 (LGPL-3.0) - see the [LICENSE](LICENCE) file for more details. \ No newline at end of file diff --git a/dockerfiles/database.sql b/files/database.sql similarity index 100% rename from dockerfiles/database.sql rename to files/database.sql diff --git a/dockerfiles/run.sh b/files/run.sh similarity index 94% rename from dockerfiles/run.sh rename to files/run.sh index 83b45fd..dbf4ca0 100755 --- a/dockerfiles/run.sh +++ b/files/run.sh @@ -2,7 +2,7 @@ /scripts/run.sh & -sleep 10 +sleep 10 # boot time of mariadb mariadb --user=root --password="$MYSQL_ROOT_PASSWORD" -h 127.0.0.1 Untis < "/untisbot-discord/database.sql" diff --git a/src/org/bytedream/untisbot/discord/DiscordCommandListener.java b/src/org/bytedream/untisbot/discord/DiscordCommandListener.java index 518964f..81667a9 100644 --- a/src/org/bytedream/untisbot/discord/DiscordCommandListener.java +++ b/src/org/bytedream/untisbot/discord/DiscordCommandListener.java @@ -94,8 +94,8 @@ public class DiscordCommandListener extends ListenerAdapter { textChannel = guild.getDefaultChannel(); if (textChannel != null) { guildDataConnector.update(guildId, null, null, null, null, null, null, textChannel.getIdLong(), null, null, null, null); - textChannel.sendMessage("It seems like, that the channel where I should send the timetable messages in doesn't exists anymore." + - "I'll send the changes now in this channel." + + textChannel.sendMessage("It seems like, that the channel where I should send the timetable messages in doesn't exists anymore. " + + "I'll send the changes now in this channel. " + "If you want that I send these messages into another channel, type `" + data.getPrefix() + "channel` in the channel where I should send the messages in").queue(); } } @@ -109,7 +109,7 @@ public class DiscordCommandListener extends ListenerAdapter { } catch (IOException e) { e.printStackTrace(); logger.warn(guildName + " ran into an exception while trying to setup the timetable checker", e); - textChannel.sendMessage("An error occurred while trying to setup the timetable checking process." + + textChannel.sendMessage("An error occurred while trying to setup the timetable checking process. " + "You should try to re-set your data or trying to contact my author <@650417934073593886> (:3) if the problem won't go away").queue(); return; } @@ -126,7 +126,7 @@ public class DiscordCommandListener extends ListenerAdapter { } else { guildDataConnector.update(guildId, null, null, null, null, null, null, textChannel.getIdLong(), null, null, null, null); textChannel.sendMessage("It seems like, that the channel where I should send the timetable messages in doesn't exists anymore. " + - "I'll send the changes now in this channel." + + "I'll send the changes now in this channel. " + "If you want that I send these messages into another channel, type `" + data.getPrefix() + "set-channel` in the channel where I should send the messages in").queue(); } } @@ -288,7 +288,7 @@ public class DiscordCommandListener extends ListenerAdapter { } catch (Exception e) { logger.warn(guildName + " ran into an exception while trying to check the timetable for the " + localDate.format(DateTimeFormatter.ofPattern("dd.MM.yyyy")), e); if (!error) { - textChannel.sendMessage("An error occurred while trying to check the timetable." + + textChannel.sendMessage("An error occurred while trying to check the timetable. " + "You can try to re-set your data or trying to contact my author <@650417934073593886> (:3) if the problem won't go away").queue(); error = true; }