diff --git a/.gitignore b/.gitignore index 345f72b..aeb8157 100644 --- a/.gitignore +++ b/.gitignore @@ -3,5 +3,9 @@ .env Secrets*.toml Cargo.lock -enrollments*.json -config.toml \ No newline at end of file +enrollments.json +config.toml +.vscode +.idea +*.config.toml +roles.toml \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml index a9c1fc2..f46ba62 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,16 +1,21 @@ [package] -name = "mlc_crab_bot" -version = "1.0.0" +name = "crab_bot" +version = "2.1.0" edition = "2021" +license = "GPL-3" +authors = ["Caden64", "Topazstix"] [dependencies] -serenity = { version = "0.11.5", default-features = false, features = ["client", "gateway", "rustls_backend", "model"] } -tokio = { version = "1.26.0", features = ["macros", "rt-multi-thread"] } -regex = "1.7.0" -dotenv = "0.15.0" -tracing = "0.1.37" -serde = "1.0.188" -serde_json = "1.0.105" -google-sheets4 = "5.0.3+20230119" -toml = "0.8.9" -serde_derive = "1.0.196" +poise = "0.6.1" +serde = { version = "1.0.216", features = ["derive"] } +tokio = { version = "1.40.0", features = ["rt-multi-thread"] } +toml = "0.8.19" +serde_json = "1.0.134" +regex = "1.11.1" +rand = "0.8.5" +meta_fetcher = "0.1.1" + +[build-dependencies] +edres = "0.6.0" +serde = { version = "1.0.216", features = ["derive"] } +toml = "0.8.19" diff --git a/Example.config.toml b/Example.config.toml new file mode 100644 index 0000000..ca23855 --- /dev/null +++ b/Example.config.toml @@ -0,0 +1,134 @@ +[TOKEN] +discord_token ="DISCORD TOKEN HERE" + +[GUILD.MAIN] +GUILD_ID = 1 # the home server of the bot +PRESIDENT = 1 # who ever is in change of the bot + +[GUILD.PARTNERS.a name or something] +id = 1 +name = "Name of partner" +SEND_NEWS = true # whether the "partner" want's to receive the news posted or not +NEWS_CHANNEL = 1 + +[ROLES.PUBLIC] +# The supported roles id's that can be given to users +ROLE1 = 1 +ROLE2 = 1 +other = 1 + +[ROLES.PRIVATE] +# the default role given when a user accepts the rules +REMOVE_ROLE_ID = 1 +# the role who should be notified if something goes wrong in registration (caused by user having higher permission than the bot or already existing in enrollments.json) +ADMIN_ROLE_ID = 1 + +[CHANNELS] +# Channel where user will enroll +ENROLL_CHANNEL_ID = 1 +# A voice channel where the meetings happen +MEETING_CHANNEL_ID = 1 +# where the news urls are posted to be shared +READING_CHANNEL_ID = 1 + +# currently not used and can be removed +[FEATURES] +SEND_NEWS = true + +# to get news +[RSS.FEED.mandiant] +url = "https://www.mandiant.com/resources/blog/rss.xml" +[RSS.FEED.troyhunt] +url = "https://feeds.feedburner.com/TroyHunt" +[RSS.FEED.thehackernews] +url = "https://feeds.feedburner.com/TheHackersNews" +[RSS.FEED.techspot] +url = "https://www.techspot.com/backend.xml" +[RSS.FEED.tomsguide] +url = "https://www.tomsguide.com/feeds/all" +[RSS.FEED.malwarebytes] +url = "https://www.malwarebytes.com/blog/Feed/index.xml" +[RSS.FEED.acronis] +url = "https://advisories.feedly.com/acronis/feed.json" +[RSS.FEED.BleepingComputer] +url = "http://www.bleepingcomputer.com/feed" +[RSS.FEED.CISECURITY] +url = "https://www.cisecurity.org/feed/advisories" +[RSS.FEED.CERT] +url = "http://www.kb.cert.org/vulfeed" +[RSS.FEED.CISAKNOWNVULNS] +url = "https://advisories.feedly.com/cisa/exploitedCve/feed.json" +[RSS.FEED.CISAALERTS] +url = "https://www.us-cert.gov/ncas/alerts.xml" +[RSS.FEED.CISACURRENTACTIVITY] +url = "http://www.us-cert.gov/current/index.rdf" +[RSS.FEED.CYBERADVISORY] +url = "https://www.cisa.gov/uscert/ncas/alerts.xml" +[RSS.FEED.CISCOTALOSDISCLOSEDVULNS] +url = "https://advisories.feedly.com/talos/disclosed/feed.json" +[RSS.FEED.PACKETSTORM] +url = "http://rss.packetstormsecurity.com/files/tags/code_execution" +[RSS.FEED.CXSECURITY] +url = "http://securityreason.com/rss/SecurityAlert" +[RSS.FEED.DARKREADING] +url = "http://www.darkreading.com/rss/all.xml" +[RSS.FEED.DELLADVISORY] +url = "https://advisories.feedly.com/dell/feed.json" +[RSS.FEED.ELASTICSTACK] +url = "https://discuss.elastic.co/c/announcements/security-announcements/31.rss" +[RSS.FEED.FULLDISCLOUSRE] +url = "http://seclists.org/rss/fulldisclosure.rss" +[RSS.FEED.GitHubADVISORYDATABASE] +url = "https://advisories.feedly.com/github/advisories/feed.json" +[RSS.FEED.GOOGLEZERODAY] +url = "https://advisories.feedly.com/google/0day/feed.json" +[RSS.FEED.GOOGLEANDROIDSECURITY] +url = "https://advisories.feedly.com/google/android/feed.json" +[RSS.FEED.CHROMESECURITY] +url = "https://advisories.feedly.com/google/chrome/feed.json" +[RSS.FEED.ICSADVISORY] +url = "https://www.cisa.gov/uscert/ics/advisories/advisories.xml" +[RSS.FEED.INTHEWILD] +url = "https://advisories.feedly.com/inthewild/exploitations/feed.json" +[RSS.FEED.INTHEWILDEXPLOITS] +url = "https://advisories.feedly.com/inthewild/exploits/feed.json" +[RSS.FEED.JVNRSS] +url = "https://jvn.jp/en/rss/jvn.rdf" +[RSS.FEED.KREBS] +url = "http://krebsonsecurity.com/feed/" +[RSS.FEED.MICROSOFTSECURITYADVISORY] +url = "https://advisories.feedly.com/microsoft/feed.json" +[RSS.FEED.MICROSOFTSECURITYBLOG] +url = "http://blogs.technet.com/mmpc/rss.xml" +[RSS.FEED.MOZILLASECURITYADVISORY] +url = "https://advisories.feedly.com/mozilla/feed.json" +[RSS.FEED.NVD] +url = "https://advisories.feedly.com/nvd-cve/feed.json" +[RSS.FEED.NETAPPSECURITYADVISORY] +url = "https://advisories.feedly.com/netapp/feed.json" +[RSS.FEED.NVIDIAPRODUCTSECURITY] +url = "https://advisories.feedly.com/nvidia/feed.json" +[RSS.FEED.PHORONIX] +url = "http://feeds.feedburner.com/Phoronix" +[RSS.FEED.REDHATSECURITYUPDATES] +url = "https://advisories.feedly.com/redhat/feed.json" +[RSS.FEED.SCHNEIERONSECURITY] +url = "http://www.schneier.com/blog/index.rdf" +[RSS.FEED.SECURELIST] +url = "https://securelist.com/feed" +[RSS.FEED.ARSTECHNICA] +url = "http://arstechnica.com/security/feed" +[RSS.FEED.QUALYS] +url = "https://community.qualys.com/blogs/securitylabs/feeds/posts" +[RSS.FEED.SOPHOS] +url = "https://blogs.sophos.com/feed" +[RSS.FEED.CXSECURITYEXPLOIT] +url = "http://securityreason.com/rss/ExploitAlert" +[RSS.FEED.STATEOfSECURITY] +url = "http://feeds.feedburner.com/tripwire-state-of-security" +[RSS.FEED.TRENDLABSTHREATINTEL] +url = "http://feeds.trendmicro.com/Anti-MalwareBlog" +[RSS.FEED.ZDIADVISORY] +url = "https://advisories.feedly.com/zdi/feed.json" +[RSS.FEED.ZOOMSECURITY] +url = "https://advisories.feedly.com/zoom/feed.json" \ No newline at end of file diff --git a/LICENSE b/LICENSE index 871ce8e..e72bfdd 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +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 + 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 . \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index cf73eb9..0000000 --- a/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Crab Bot - -> Documentation coming soon \ No newline at end of file diff --git a/build.rs b/build.rs new file mode 100644 index 0000000..7cc8bd4 --- /dev/null +++ b/build.rs @@ -0,0 +1,43 @@ +use edres::{generate_enum_from_source, EnumOptions, Format, Options}; +use std::env; +use std::fs; +use std::path::PathBuf; +include!("./src/utils/config.rs"); + +fn main() { + println!("cargo:rerun-if-changed=build.rs"); + println!("cargo:rerun-if-changed=config.rs"); + // Read the TOML file + let roles_toml = fs::read_to_string("config.toml").expect("Unable to read roles.toml"); + let convert_to_toml: ConfigData = toml::from_str(&roles_toml).unwrap(); + let necessary = toml::to_string(&convert_to_toml.roles.public).unwrap(); + + // Generate the enum from the TOML file content + let generated_code = generate_enum_from_source( + &necessary, + "RoleEnum", + Format::Toml, + &Options { + enums: EnumOptions { + impl_display: true, + impl_from_str: true, + derived_traits: vec![ + "poise::ChoiceParameter".into(), + "serde::Serialize".into(), + "Eq".into(), + "Hash".into(), + "PartialEq".into(), + ] + .into(), + ..EnumOptions::minimal() + }, + ..Options::default() + }, + ) + .unwrap(); + + // Write the generated code to a file in the OUT_DIR + let out_dir = PathBuf::from(env::var("OUT_DIR").unwrap()); + fs::write(out_dir.join("generated_roles.rs"), generated_code) + .expect("Unable to write generated roles to file"); +} diff --git a/src/backend/mod.rs b/src/backend/mod.rs deleted file mode 100644 index df6289f..0000000 --- a/src/backend/mod.rs +++ /dev/null @@ -1 +0,0 @@ -pub mod database_storage; \ No newline at end of file diff --git a/src/checks.rs b/src/checks.rs new file mode 100644 index 0000000..39613a4 --- /dev/null +++ b/src/checks.rs @@ -0,0 +1,2 @@ +pub mod enroll_channel; +pub mod remove_role; diff --git a/src/checks/enroll_channel.rs b/src/checks/enroll_channel.rs new file mode 100644 index 0000000..e1e70d6 --- /dev/null +++ b/src/checks/enroll_channel.rs @@ -0,0 +1,29 @@ +use crate::utils::config::ENROLL_CHANNEL; +use crate::{Context, Error}; + +// makes sure the command was sent in the enroll channel +pub async fn enroll_channel(ctx: Context<'_>) -> Result { + let guild_channel = match ctx.guild_channel().await { + Some(channel) => channel, + None => { + println!("Unable to get the guild_channel"); + return Ok(false); + } + }; + + let channel_id = guild_channel.id.get(); + + let enroll_channel_id = match ctx.data().config_data.channels.get(ENROLL_CHANNEL) { + Some(id) => id, + None => { + println!("Unable to get the enroll channel ID"); + return Ok(false); + } + }; + + if channel_id == *enroll_channel_id { + Ok(true) + } else { + Ok(false) + } +} diff --git a/src/checks/remove_role.rs b/src/checks/remove_role.rs new file mode 100644 index 0000000..c182e8d --- /dev/null +++ b/src/checks/remove_role.rs @@ -0,0 +1,22 @@ +use crate::{Context, Error, REMOVE_ROLE_ID}; + +// makes sure the user has the remove role +pub async fn remove_role(ctx: Context<'_>) -> Result { + if let Some(role_id) = ctx.data().config_data.roles.private.get(REMOVE_ROLE_ID) { + if ctx + .author() + .has_role( + &ctx.http(), + ctx.data().config_data.guild.main.guild_id, + *role_id, + ) + .await + .unwrap_or(false) + { + return Ok(true); + } + } + ctx.say("You don't have the proper permissions to use the enroll command") + .await?; + Ok(false) +} diff --git a/src/commands.rs b/src/commands.rs new file mode 100644 index 0000000..a8fbc33 --- /dev/null +++ b/src/commands.rs @@ -0,0 +1,7 @@ +pub mod acknowledgement; +pub mod enroll; +pub mod help; +pub mod ping; +pub mod register_commands; +pub mod news; +pub mod dump_channel; diff --git a/src/commands/acknowledgement.rs b/src/commands/acknowledgement.rs new file mode 100644 index 0000000..d3c92a8 --- /dev/null +++ b/src/commands/acknowledgement.rs @@ -0,0 +1,101 @@ +use crate::utils::config::REMOVE_ROLE_ID; +use crate::{Context, Error}; +use poise::serenity_prelude::{CreateMessage, EditMember, Mentionable}; +use poise::{serenity_prelude as serenity, CreateReply}; + +#[poise::command(slash_command, ephemeral)] +pub async fn acknowledge(ctx: Context<'_>) -> Result<(), Error> { + if let Some(guild_id) = ctx.guild_id() { + if let Ok(member) = guild_id.member(&ctx.http(), ctx.author().id.get()).await { + if member.roles.is_empty() { + let ctx_uuid = ctx.id(); + + // Prepare and send a reply with an "Acknowledge" button + let reply = { + let components = vec![serenity::CreateActionRow::Buttons(vec![ + serenity::CreateButton::new(format!("{ctx_uuid}")) + .style(serenity::ButtonStyle::Primary) + .label("Acknowledge"), + ])]; + + CreateReply::default() + .content("Please acknowledge to enroll") + .components(components) + }; + + ctx.send(reply).await?; + + // Start component interaction collection, looking for a button press of the specific button by comparing custom id's + while let Some(mci) = serenity::ComponentInteractionCollector::new(ctx) + .timeout(std::time::Duration::from_secs(120)) + .filter(move |mci| mci.data.custom_id == ctx_uuid.to_string()) + .await + { + // Create a message to send to the user + let guild_name = ctx + .guild() + .map(|g| g.name.clone()) + .unwrap_or_else(|| "the guild".to_string()); + let enroll_message = CreateMessage::new().content(format!( + "{}, You may now enroll in {}", + mci.user.mention(), + guild_name + )); + + // Define user role changes + let edit_user = if let Some(role_id) = + ctx.data().config_data.roles.private.get(REMOVE_ROLE_ID) + { + EditMember::new().roles(vec![*role_id]) + } else { + continue; + }; + + // Check if user doesn't have any other roles + // Change user roles in the guild + match guild_id + .edit_member(&ctx.http(), mci.user.id, edit_user) + .await + { + Ok(_) => { + println!("Member edited successfully"); + // Member edit successful + } + Err(e) => { + // Handle the error, e.g., log it or send an error message + println!("Failed to edit member: {:?}", e); + } + } + // Send DM to the user + match mci.user.create_dm_channel(&ctx.http()).await { + Ok(dm_channel) => { + match dm_channel.send_message(&ctx.http(), enroll_message).await { + Ok(_) => { + // Message sent successfully + println!("Enrollment message sent to user"); + } + Err(e) => { + // Handle error in sending message + println!("Failed to send enrollment message: {:?}", e); + } + } + } + Err(e) => { + // Handle error in creating DM channel + println!("Failed to create DM channel: {:?}", e); + } + } + // Send acknowledgment reply + mci.create_response(ctx, serenity::CreateInteractionResponse::Acknowledge) + .await? + } + } else { + ctx.say("Sorry you can already use the /enroll command or have a university role already") + .await?; + } + } + } else { + println!("Cannot determine guild ID"); + } + Ok(()) +} diff --git a/src/commands/dump_channel.rs b/src/commands/dump_channel.rs new file mode 100644 index 0000000..cfd7d54 --- /dev/null +++ b/src/commands/dump_channel.rs @@ -0,0 +1,30 @@ +use std::fs::File; +use std::io::Write; +use poise::futures_util::StreamExt; +use poise::serenity_prelude::Channel; +use regex::Regex; +use crate::{Context, Error}; + +#[poise::command(slash_command, ephemeral)] +pub async fn dump(ctx: Context<'_>, channel: Channel) -> Result<(), Error>{ + ctx.say("Dumping channel").await?; + let mut messages = channel.id().messages_iter(&ctx).boxed(); + let mut urls = vec![]; + while let Some(message) = messages.next().await.transpose()? { + let website_regex = Regex::new("^https?://([\\w.-]+).[a-z]{3,4}(/.*)?$").unwrap(); + let content = message.content.clone(); + if website_regex.is_match(&content) { + urls.push(content); + + } + } + println!("Dumped {} messages", urls.len()); + println!("{:?}", urls); + let mut file = File::create("dump.out")?; + + for item in urls { + writeln!(file, "{}", item)?; + } + + Ok(()) +} \ No newline at end of file diff --git a/src/commands/enroll.rs b/src/commands/enroll.rs new file mode 100644 index 0000000..3c18fb8 --- /dev/null +++ b/src/commands/enroll.rs @@ -0,0 +1,172 @@ +include!(concat!(env!("OUT_DIR"), "/generated_roles.rs")); +use crate::checks::enroll_channel::enroll_channel; +use crate::checks::remove_role::remove_role; +use crate::storage::save_user::save_to_json; +use crate::storage::user::User; +use crate::utils::config::{ADMIN_ROLE_ID, REMOVE_ROLE_ID}; +use crate::{Context, Error}; +use poise::serenity_prelude::{EditMember, Mentionable, RoleId}; +use regex::Regex; +use serde_json::json; + +#[poise::command( + slash_command, + guild_only, + check = "remove_role", + check = "enroll_channel" +)] +pub async fn enroll( + ctx: Context<'_>, + #[description = "First and at least last initial"] name: String, + #[description = "Your student email"] email: String, + #[description = "Why are you interested in cyber club"] interests: String, + #[description = "What role best describes you"] role: RoleEnum, + #[description = "Would you like to occasionally receive emails"] email_distro: Option, +) -> Result<(), Error> { + // Ensure the name input contains more than one word + if name.split_whitespace().count() == 0 { + ctx.reply("Need a last initial included").await?; + return Ok(()); + } + let email_regex = Regex::new("^[\\w\\-.]+@([\\w-]+\\.)+[\\w-]{2,}$").unwrap(); + if !email_regex.is_match(&email) { + ctx.reply("Invalid email format").await?; + return Ok(()); + } + + // Split name into first name and last initial + let first = match name.split_ascii_whitespace().next() { + Some(first_name) => first_name, + None => { + ctx.reply("invalid name must include last initial").await?; + return Ok(()); + } + }; + let last_initial = match name.split_ascii_whitespace().nth(1) { + Some(second_word) => match second_word.chars().next() { + Some(initial) => initial, + None => { + ctx.reply("invalid name must include last initial").await?; + return Ok(()); + } + }, + None => { + ctx.reply("invalid name must include last initial").await?; + return Ok(()); + } + }; + let email_distro = email_distro.unwrap_or_default(); + + // Check if the university name exists in the public roles + if !ctx + .data() + .config_data + .roles + .public + .contains_key(&role.to_string()) + { + ctx.reply("Unknown university selected please try again") + .await?; + return Ok(()); + } + let uni_role = ctx.data().config_data.roles.public.get(&role.to_string()); + if uni_role.is_none() { + ctx.reply("Invalid Role").await?; + return Ok(()); + } + let uni_role = *uni_role.unwrap(); + + // Retrieve some info about the guild member + let guild_id = ctx.guild_id(); + let http = ctx.http(); + let member_id = ctx.author().id; + let remove_role_id = ctx.data().config_data.roles.private.get(REMOVE_ROLE_ID); + + // Formulate an error output in case anything happens + let error_format = match ctx.author_member().await { + Some(member) => match guild_id { + Some(guild) => match guild.roles(&ctx.http()).await { + Ok(roles) => match ctx.data().config_data.roles.private.get(ADMIN_ROLE_ID) { + Some(admin_role_id) => match roles.get(&RoleId::new(*admin_role_id)) { + Some(role) => format!( + "Hi {}, Something has gone wrong. The people with {} will help you! Just message them!", + member.user.mention(), + role.mention() + ), + None => "An error occurred: Admin role not found.".to_string(), + }, + None => "An error occurred: Admin role ID not found.".to_string(), + }, + Err(_) => "An error occurred: Failed to fetch roles.".to_string(), + }, + None => "An error occurred: Guild ID not found.".to_string(), + }, + None => "An error occurred: Failed to fetch member.".to_string(), + }; + + // Try to assign new roles and nickname to the member + match guild_id { + Some(id) => { + // Prepare the modification of the member + let builder = EditMember::new() + .roles(vec![uni_role]) + .nickname(format!("{} {}", first, last_initial)); + // Try to apply the changes + match id.edit_member(&http, member_id, builder).await { + Ok(member) => { + // Remove the remove_role if it exists + if let Some(role_id) = remove_role_id { + match member.remove_role(&http, *role_id).await { + Ok(_) => (), + Err(e) => { + // Handle errors by sending a message + println!("error removing role error: {}", e.to_string()); + ctx.defer_ephemeral().await?; + ctx.reply(error_format).await?; + return Ok(()); + } + } + } + } + Err(e) => { + // Handle errors by sending a message + println!("error editing member error: {}", e.to_string()); + ctx.defer_ephemeral().await?; + ctx.reply(error_format).await?; + return Ok(()); + } + } + } + None => { + ctx.reply(error_format).await?; + return Ok(()); + } + }; + + // Everything went fine, let's notify the user + ctx.reply(format!("You have registered as:\nName: {} {}\nEmail: {}\nInterests: {}\nUniversity: {}\nAdd to Email Distro: {}", first, last_initial, email, interests, role, email_distro)).await?; + + // Prepare the user data as JSON + let user_data_json = json!({ + "user_id": ctx.author().id.get(), + "user_name": ctx.author().name, + "name": format!("{} {}", first, last_initial), + "role": role, + "email": email, + "interests": interests, + "email_distro": email_distro, + "points": 0, + "thm_username": "" + }); + + // Convert the JSON to the User struct + let user_data: User = serde_json::from_value(user_data_json).unwrap(); + + // Try to save the user data on a JSON file + if save_to_json(&user_data).is_err() { + // Log any errors that happened during saving + println!("Had an error while saving user data"); + ctx.reply(error_format).await?; + } + Ok(()) +} diff --git a/src/commands/enrollment.rs b/src/commands/enrollment.rs deleted file mode 100644 index 88e2d70..0000000 --- a/src/commands/enrollment.rs +++ /dev/null @@ -1,147 +0,0 @@ -use serenity::builder::CreateApplicationCommand; -use serenity::model::prelude::command::CommandOptionType; -use serenity::model::prelude::interaction::application_command::{ - CommandDataOption, - CommandDataOptionValue, -}; -use crate::{get_config, get_roles}; - -// private function to unwrap the data option -fn unwrap_data_option(option_value: &CommandDataOptionValue) -> Option { - - // if option string => string, - // if option boolean => Yes/No - // else None - match option_value { - CommandDataOptionValue::String(value) => Some(value.clone()), - CommandDataOptionValue::Boolean(value) => Some( - if *value { - "Yes".to_string() - } else { - "No".to_string() - } - ), - // CommandDataOptionValue::Integer(value) => Some(value.to_string()), - _ => None, - } - -}//end unwrap_data_option - - -// public function to run the command -pub fn run(options: &[CommandDataOption]) -> String { - - // unwrap the data options from users responses - let name_option = unwrap_data_option(options - .get(0) - .expect("Expected name option") - .resolved - .as_ref() - .expect("Expected name object")).unwrap(); - - let email_option = unwrap_data_option(options - .get(1) - .expect("Expected email option") - .resolved - .as_ref() - .expect("Expected email object")).unwrap(); - - let interests_option = unwrap_data_option(options - .get(2) - .expect("Expected interests option") - .resolved - .as_ref() - .expect("Expected interests object")).unwrap(); - - let uni_option = unwrap_data_option(options - .get(3) - .expect("Expected university option") - .resolved - .as_ref() - .expect("Expected university object")).unwrap(); - - let add_to_email_option = unwrap_data_option(options - .get(4) - .expect("Expected add_to_email_distro option") - .resolved - .as_ref() - .expect("Expected add_to_email_distro object")).unwrap(); - - // return the formatted string - format!( - "Enrolling new student:\nName: {:?}\nEmail: {:?}\nInterests: {:?}\nUniversity: {:?}\nAdd to email distro: {:?}\n@Officers", - name_option, - email_option, - interests_option, - uni_option, - add_to_email_option - ) - -}//end run - - -// public function to register the command -pub fn register(command: &mut CreateApplicationCommand) -> &mut CreateApplicationCommand { - - // create the enrollment command - command - .name("enrollment") - .description("Enrollment commands") - - // create name sub option - .create_option(|student_name| { - student_name - .name("name") - .description("First name and last initial") - .kind(CommandOptionType::String) - .required(true) - }) - - // create email sub option - .create_option(|student_email| { - student_email - .name("email") - .description("School email address") - .kind(CommandOptionType::String) - .required(true) - }) - - // create interests sub option - .create_option(|student_interests| { - student_interests - .name("interests") - .description("Areas of interest.") - .kind(CommandOptionType::String) - .required(true) - }) - - // create university student distinction option - // create university option - .create_option(|student_uni| { - student_uni - .name("student_uni") - .description("Which college are you with?") - .kind(CommandOptionType::String) - .required(true); - // get the other roles in the configuration - let config = get_config().expect("using config.toml gave an error"); - let roles = get_roles(&config); - // add the choices for those roles - for role in roles { - student_uni.add_string_choice(role.clone(), role); - } - // add other choice - student_uni.add_string_choice("Other or N/A", "Other / N/A"); - student_uni - }) - - // create email distro sub option - .create_option(|student_distro| { - student_distro - .name("add_to_email_distro") - .description("Add to email distro?") - .kind(CommandOptionType::Boolean) - .required(true) - }) - -}//end enrollment \ No newline at end of file diff --git a/src/commands/help.rs b/src/commands/help.rs new file mode 100644 index 0000000..c17c06e --- /dev/null +++ b/src/commands/help.rs @@ -0,0 +1,12 @@ +use crate::{Context, Error}; + +// use poise to generate a decent help menu +#[poise::command(slash_command)] +pub async fn help(ctx: Context<'_>, command: Option) -> Result<(), Error> { + let configuration = poise::builtins::HelpConfiguration { + // [configure aspects about the help message here] + ..Default::default() + }; + poise::builtins::help(ctx, command.as_deref(), configuration).await?; + Ok(()) +} diff --git a/src/commands/mod.rs b/src/commands/mod.rs deleted file mode 100644 index 6e434ef..0000000 --- a/src/commands/mod.rs +++ /dev/null @@ -1 +0,0 @@ -pub mod enrollment; diff --git a/src/commands/news.rs b/src/commands/news.rs new file mode 100644 index 0000000..fbc4d66 --- /dev/null +++ b/src/commands/news.rs @@ -0,0 +1,70 @@ +use poise::CreateReply; +use poise::serenity_prelude::{ChannelId, Colour, CreateEmbed, CreateMessage}; +use meta_fetcher::Metadata; +use rand::Rng; +use regex::Regex; +use crate::{Context, Error}; + + +#[poise::command(slash_command)] +pub async fn news( + ctx: Context<'_>, + url: String, +) -> Result<(), Error> { + let website_regex = Regex::new("^https?://([\\w.-]+).[a-z]{3,4}(/.*)?$").unwrap(); + if !website_regex.is_match(&url) { + ctx.defer_ephemeral().await?; + ctx.reply("Invalid URL").await?; + return Ok(()) + } + let channels_to_send_news_to = &ctx.data().config_data.guild.partners; + // for some fun colors on the side + let color = { + let mut rng = rand::thread_rng(); + Colour::from_rgb( + rng.gen_range(0..=255), + rng.gen_range(0..=255), + rng.gen_range(0..=255), + ) + }; + + + let user = &ctx.author().name; + + let mut embed = CreateEmbed::default(); + embed = embed.url(url.clone()); + embed = embed.color(color); + + // get the metadata from the page to make it pretty 💅 + let meta = Metadata::from_url(&url)?; + + if let Some(title) = meta.title { + embed = embed.title(title); + } else { + embed = embed.title("News Message"); + } + // get the image + if let Some(image) = meta.image { + embed = embed.image(image); + } + let mut msg = CreateMessage::new(); + let mut own = CreateReply::default(); + if let Some(description) = meta.description { + embed = embed.description(description); + msg = msg.content(format!("Article provided by {}", user)); + own = own.content(format!("Article provided by {}", user)); + } else { + embed = embed.description(format!("Article provided by {}", user)); + } + own = own.embed(embed.clone()); + msg = msg.embed(embed); + + // send discord the reply so it doesn't freak out + ctx.send(own).await?; + for i in channels_to_send_news_to { + let channel_id = ChannelId::from(i.1.news_channel); + channel_id.send_message(ctx.http(), msg.clone()).await?; + + } + Ok(()) +} diff --git a/src/commands/ping.rs b/src/commands/ping.rs new file mode 100644 index 0000000..48637ff --- /dev/null +++ b/src/commands/ping.rs @@ -0,0 +1,8 @@ +use crate::{Context, Error}; + +// quick simple way to confirm it's working +#[poise::command(slash_command, ephemeral, hide_in_help)] +pub async fn ping(ctx: Context<'_>) -> Result<(), Error> { + ctx.reply("Pong!").await?; + Ok(()) +} diff --git a/src/commands/register_commands.rs b/src/commands/register_commands.rs new file mode 100644 index 0000000..3618c1f --- /dev/null +++ b/src/commands/register_commands.rs @@ -0,0 +1,8 @@ +use crate::{Context, Error}; + +// admin command to register commands typically for debug use +#[poise::command(hide_in_help, guild_only, ephemeral, slash_command, owners_only)] +pub async fn register_commands(ctx: Context<'_>) -> Result<(), Error> { + poise::builtins::register_application_commands_buttons(ctx).await?; + Ok(()) +} diff --git a/src/main.rs b/src/main.rs index 8e0d6f7..8eacc96 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,235 +1,98 @@ +mod checks; mod commands; -mod backend; - - -use std::collections::HashMap; -use regex::Regex; -use tracing::error; -use serde_json::json; -use serenity::prelude::*; -use serenity::async_trait; -use serenity::model::gateway::Ready; -use serenity::model::channel::Message; -use backend::database_storage::Enrollment; -use serenity::model::id::{ChannelId, GuildId}; -use serenity::model::application::interaction::{Interaction, InteractionResponseType}; -use serde_derive::Deserialize; -use toml::de::Error; - -struct Bot; - +mod storage; +mod utils; +use crate::commands::acknowledgement::acknowledge; +use crate::commands::enroll::enroll; +use crate::commands::help::help; +use crate::commands::ping::ping; +use crate::commands::dump_channel::dump; +use crate::commands::register_commands::register_commands; +use crate::utils::config::{get_config, ConfigData, DISCORD_TOKEN, REMOVE_ROLE_ID}; +use crate::utils::event_handler::event_handler; +use poise::serenity_prelude as serenity; +use serde::Deserialize; +use std::default::Default; +use std::sync::atomic::AtomicBool; +use crate::commands::news::news; + +// define types for bot use #[derive(Debug, Deserialize)] struct Data { - token: HashMap, - guild: HashMap, - roles: HashMap, - channels: HashMap, -} - -// takes in a mutable iterator of string literals ' -// returns the user response -fn parse_response<'a>(responses: &mut dyn Iterator) -> &'a str { - // gets next value - responses.next().expect("No Next value in registration response") - // get the user input of the field - .split(": ").nth(1).expect("No value associated with registration response") - // trims quotations - .trim_matches('"') -} - -fn get_config() -> Result { - let data = std::fs::read_to_string("config.toml").unwrap(); - toml::from_str(&data) -} - -fn get_roles(config: &Data) -> Vec { - config.roles.keys() - .filter(|key| key.as_str() != REMOVE_ROLE_ID) - .map(|value| value.to_owned() ) - .collect::>() -} - -// const env vars -const DESTIN_CHANNEL_ID: &str = "DESTIN_CHANNEL_ID"; -const READING_CHANNEL_ID: &str = "READING_CHANNEL_ID"; -const ENROLL_CHANNEL_ID: &str = "ENROLL_CHANNEL_ID"; -const GUILD_ID: &str = "GUILD_ID"; -const DISCORD_TOKEN: &str = "discord_token"; -const REMOVE_ROLE_ID: &str = "REMOVE_ROLE_ID"; - -#[async_trait] -impl EventHandler for Bot { - // handle reading and sending messages - async fn message(&self, ctx: Context, msg: Message) { - - // secret command :) - if msg.content == "!hello" { - if let Err(e) = msg.channel_id.say(&ctx.http, "world!").await { - error!("Error sending message: {:?}", e); - }; - return - } - - let config = get_config().expect("using config.toml gave an error"); - - // pull Channel Id environment vars from .env file - let destin_channel = ChannelId(*config.channels.get(DESTIN_CHANNEL_ID).expect("destin channel id not found")); - let reading_channel = ChannelId(*config.channels.get(READING_CHANNEL_ID).expect("reading channel id not found")); - let enroll_channel = ChannelId(*config.channels.get(ENROLL_CHANNEL_ID).expect("enroll channel id not found")); - - - // set regular expression patterns for matching messages - let http_match = Regex::new(r"^(https|http|\^\^).*").unwrap(); - let enroll_match = Regex::new(r"^Enrolling new student:").unwrap(); - - // if the message is in the reading channel and matches the http regex, - // send it to the destin channel - if msg.channel_id == reading_channel && http_match.is_match(&msg.content) && !msg.author.bot { - - // Make a prettier message with the original authors name to send - let message = format!(".\n*This was originally posted by `{}`:*\n{}", msg.author.name, msg.content); - - if let Err(e) = destin_channel.say(&ctx.http, message).await { - error!("Error sending message: {:?}", e); - } - }//end http match and send - - - // if the message is in the enrollment channel and matches the enrollment regex, - // add the student role, remove the entry point role, and change the user's nickname - if msg.channel_id == enroll_channel && enroll_match.is_match(&msg.content) && msg.author.bot { - - // pull user and guild IDs from the message - let user_id = msg.interaction.as_ref().unwrap().user.id; - let user_name = msg.interaction.unwrap().user.name; - let guild_id = msg.guild_id.unwrap(); - - // pull env vars - let roles = get_roles(&config); - let remove_id = *config.roles.get(REMOVE_ROLE_ID).expect("Unable to find remove_id in config.toml"); - - // Pull student responses from enrollment message - // skips the first element in response iterator - let mut response = msg.content.lines().skip(1); - let nickname = parse_response(&mut response); - let email_response = parse_response(&mut response); - let interests_response = parse_response(&mut response); - let uni_response = parse_response(&mut response); - let distro_response = parse_response(&mut response); - - // remove entry point role if uni_response matches "uni_one" or "uni_two" - for role in roles { - if role == uni_response { - if let Err(e) = guild_id.member(&ctx.http, user_id).await.unwrap().remove_role(&ctx.http, remove_id).await { - error!("Error removing role: {:?}", e); - } - if let Err(e) = guild_id.member(&ctx.http, user_id).await.unwrap().add_role(&ctx.http, *config.roles.get(&role).expect("Unable to find role")).await { - error!("Error adding role: {:?}", e); - } - break - } - } - - // change the user's nickname for the guild to their response to the enrollment form - if let Ok(member) = guild_id.member(&ctx.http, user_id).await { - if let Err(e) = member.edit(&ctx.http, |guild_user| guild_user.nickname(nickname)).await { - error!("Error changing nickname: {:?}", e); - } else { - error!("Error: Member not found"); - } - } - - // store the users data in the database - let user_data_json = json!({ - "user_id": user_id.as_u64(), - "user_name": user_name, - "name": nickname, - "university": uni_response, - "email": email_response, - "interests": interests_response, - "email_distro": distro_response, - }); - - let user_data: Enrollment = serde_json::from_value(user_data_json).unwrap(); - - if let Err(e) = backend::database_storage::save_to_json(&user_data) { - error!("Error saving to json: {:?}", e); - } - - }//end enrollment match and send - - }//end interaction_create - - - // handle bot ready event - async fn ready(&self, ctx: Context, ready: Ready) { - - println!("{} is connected!", ready.user.name); - - // pull guild ID (discord server ID) - let config = get_config().expect("using config.toml gave an error"); - let guild_id = GuildId(*config.guild.get(GUILD_ID).expect("Unable to find GUILD_ID in config.toml")); - - // create commands for given guild - let commands = GuildId::set_application_commands(&guild_id, &ctx.http, |commands| { - commands - .create_application_command(|command| commands::enrollment::register(command)) - }).await; - - println!("The following commands are available: {:#?}", commands); - - }//end ready - - - // handle event interactions from server (slash commands) - async fn interaction_create(&self, ctx: Context, interaction: Interaction) { - - if let Interaction::ApplicationCommand(command) = interaction { - println!("Received command interaction: {:#?}", command); - - // determine what command to run from the users input - let content = match command.data.name.as_str() { - "enrollment" => commands::enrollment::run(&command.data.options), - _ => "not implemented :(".to_string(), // handle invalid commands - }; - - // respond to the command with the content from the command - if let Err(why) = command - .create_interaction_response(&ctx.http, |response| { - response - .kind(InteractionResponseType::ChannelMessageWithSource) - .interaction_response_data(|message| message.content(content)) - }).await { - error!("Cannot respond to slash command: {}", why); - } - - } - - }//end message - -}//end EventHandler for bot - - + config_data: ConfigData, + meeting_time: AtomicBool, +} // User data, which is stored and accessible in all command invocations +type Error = Box; +type Context<'a> = poise::Context<'a, Data, Error>; #[tokio::main] async fn main() { - // Configure the client with your Discord bot token in the environment. - let config = get_config().expect("using config.toml gave an error"); - let token: &String = config.token.get(DISCORD_TOKEN).expect("Unable to find DISCORD_TOKEN in config.toml"); - - // Set gateway intents, which decides what events the bot will be notified about - let intents = GatewayIntents::GUILD_MESSAGES | GatewayIntents::MESSAGE_CONTENT | - GatewayIntents::GUILD_MEMBERS | GatewayIntents::GUILDS; - - // Build our client. - let mut client = Client::builder(token, intents) - .event_handler(Bot) - .await - .expect("Error creating client"); - - // Finally, start a single shard, and start listening to events. - if let Err(why) = client.start().await { - println!("Client error: {:?}", why); - } - -}//end main \ No newline at end of file + // Load configuration + let config = get_config().expect("Unable to properly decode config.toml file"); + // Retrieve Discord token from configuration + let token = config + .token + .get(DISCORD_TOKEN) + .expect("Unable to find discord_token in config.toml file") + .to_string(); + + // intents + let intents = serenity::GatewayIntents::non_privileged() + | serenity::GatewayIntents::MESSAGE_CONTENT + | serenity::GatewayIntents::GUILD_MEMBERS; + + // Build the bot framework + let framework = poise::Framework::builder() + .options(poise::FrameworkOptions { + pre_command: |ctx| { + Box::pin(async move { + // Log the invoked command and the author + println!( + "{} called: {}", + ctx.author().name, + ctx.invoked_command_name(), + ); + }) + }, + prefix_options: poise::PrefixFrameworkOptions { + prefix: Some("!".into()), + ..Default::default() + }, + // Register bot commands + // for now only have the basic commands for enrollment + commands: vec![ + ping(), + enroll(), + help(), + acknowledge(), + news(), + #[cfg(debug_assertions)] + dump(), + #[cfg(debug_assertions)] + register_commands(), + ], + // Handler for other events + event_handler: |ctx, event, framework, data| { + Box::pin(event_handler(ctx, event, framework, data)) + }, + ..Default::default() + }) + .setup(|ctx, _ready, framework| { + Box::pin(async move { + // Globally register commands + poise::builtins::register_globally(ctx, &framework.options().commands).await?; + Ok(Data { + config_data: config.clone(), + meeting_time: AtomicBool::new(false), + }) + }) + }) + .build(); + + // Create a bot client with the token, intents and framework + let client = serenity::ClientBuilder::new(token, intents) + .framework(framework) + .await; + // Start the bot client + client.unwrap().start().await.unwrap(); +} diff --git a/src/storage.rs b/src/storage.rs new file mode 100644 index 0000000..10f9fa2 --- /dev/null +++ b/src/storage.rs @@ -0,0 +1,2 @@ +pub mod save_user; +pub mod user; \ No newline at end of file diff --git a/src/backend/database_storage.rs b/src/storage/save_user.rs similarity index 53% rename from src/backend/database_storage.rs rename to src/storage/save_user.rs index e69990b..b471880 100644 --- a/src/backend/database_storage.rs +++ b/src/storage/save_user.rs @@ -2,24 +2,14 @@ * Modular Database Storage/API Storage */ +use crate::storage::user::User; use std::collections::HashMap; -use serde::{Serialize, Deserialize}; -use std::io::Result; use std::fs; +use std::io::Result; -#[derive(Deserialize, Serialize, Debug, Clone)] -pub struct Enrollment { - user_id: u64, - user_name: String, - name: String, - university: String, - email: String, - interests: String, - email_distro: String, -} - -pub fn save_to_json(enrollment: &Enrollment) -> Result<()> { - let mut enrollments: HashMap = HashMap::new(); +// save the user to enrollments.json +pub fn save_to_json(enrollment: &User) -> Result<()> { + let mut enrollments: HashMap = HashMap::new(); // Load existing data if let Ok(data) = fs::read_to_string("enrollments.json") { @@ -34,4 +24,4 @@ pub fn save_to_json(enrollment: &Enrollment) -> Result<()> { fs::write("enrollments.json", data)?; Ok(()) -}// end save_to_json \ No newline at end of file +} // end save_to_json diff --git a/src/storage/user.rs b/src/storage/user.rs new file mode 100644 index 0000000..c29e8f0 --- /dev/null +++ b/src/storage/user.rs @@ -0,0 +1,15 @@ +use serde::{Deserialize, Serialize}; + +// User type +#[derive(Deserialize, Serialize, Debug, Clone)] +pub struct User { + pub user_id: u64, + pub user_name: String, + pub name: String, + pub role: String, + pub email: String, + pub interests: String, + pub email_distro: bool, + pub points: i64, + pub thm_username: String, +} diff --git a/src/utils.rs b/src/utils.rs new file mode 100644 index 0000000..18a25c2 --- /dev/null +++ b/src/utils.rs @@ -0,0 +1,2 @@ +pub mod config; +pub mod event_handler; diff --git a/src/utils/config.rs b/src/utils/config.rs new file mode 100644 index 0000000..c7168d6 --- /dev/null +++ b/src/utils/config.rs @@ -0,0 +1,84 @@ +use serde::{Deserialize, Serialize}; +use std::collections::HashMap; +// constants + +// token +pub const DISCORD_TOKEN: &str = "discord_token"; +// roles.private +pub const REMOVE_ROLE_ID: &str = "REMOVE_ROLE_ID"; +pub const ADMIN_ROLE_ID: &str = "ADMIN_ROLE_ID"; +// roles.public +// channels +pub const ENROLL_CHANNEL: &str = "ENROLL_CHANNEL_ID"; +pub const READING_CHANNEL: &str = "READING_CHANNEL_ID"; +// pub const LOGGING_CHANNEL: &str = "LOGGING_CHANNEL_ID"; +pub const MEETING_CHANNEL: &str = "MEETING_CHANNEL_ID"; + +// config file types +#[derive(Debug, Deserialize, Clone, Serialize)] +pub struct ConfigData { + #[serde(alias = "TOKEN")] + pub token: HashMap, + #[serde(alias = "GUILD")] + pub guild: Guild, + #[serde(alias = "ROLES")] + pub roles: Roles, + #[serde(alias = "CHANNELS")] + pub channels: HashMap, + #[serde(alias = "RSS")] + pub rss: Rss, +} + +#[derive(Debug, Deserialize, Clone, Serialize)] +pub struct Roles { + #[serde(alias = "PUBLIC")] + pub public: HashMap, + #[serde(alias = "PRIVATE")] + pub private: HashMap, +} + +#[derive(Debug, Deserialize, Clone, Serialize)] +pub struct Guild { + #[serde(alias = "MAIN")] + pub main: GuildMain, + #[serde(alias = "PARTNERS")] + pub partners: HashMap, +} + +#[derive(Debug, Deserialize, Clone, Serialize)] +pub struct Rss { + #[serde(alias = "FEED")] + pub feed: HashMap, +} + +#[derive(Debug, Deserialize, Clone, Serialize)] +pub struct Feed { + pub url: String, +} + +#[derive(Debug, Deserialize, Clone, Serialize)] +pub struct GuildMain { + #[serde(alias = "GUILD_ID")] + pub guild_id: u64, + #[serde(alias = "PRESIDENT")] + pub president: u64, +} + +#[allow(dead_code)] +#[derive(Debug, Deserialize, Clone, Serialize)] +pub struct GuildPartners { + #[serde(alias = "ID")] + pub id: u64, + #[serde(alias = "NAME")] + pub name: String, + #[serde(alias = "SEND_NEWS")] + pub send_news: bool, + #[serde(alias = "NEWS_CHANNEL")] + pub news_channel: u64, +} + +// read and return result of the config file +pub fn get_config() -> Result { + let data = std::fs::read_to_string("config.toml").expect("Unable to find config.toml file"); + toml::from_str(&data) +} diff --git a/src/utils/event_handler.rs b/src/utils/event_handler.rs new file mode 100644 index 0000000..81f9419 --- /dev/null +++ b/src/utils/event_handler.rs @@ -0,0 +1,44 @@ +use poise::serenity_prelude as serenity; +use poise::serenity_prelude::FullEvent::{GuildMemberAddition, Message, Ready, VoiceStateUpdate}; +use poise::serenity_prelude::{CacheHttp, CreateMessage, Mentionable}; + +use crate::{Data, Error}; + +pub async fn event_handler( + ctx: &serenity::Context, + event: &serenity::FullEvent, + framework: poise::FrameworkContext<'_, Data, Error>, + data: &Data, +) -> Result<(), Error> { + match event { + // Bot successfully logged in + Ready { data_about_bot, .. } => { + println!("Logged in as {}", data_about_bot.user.name); + } + + // New member joined the server + GuildMemberAddition { new_member, .. } => { + let member_guild = new_member.guild_id.get(); + if data.config_data.guild.main.guild_id == member_guild { + let join_message = CreateMessage::new().content(format!( + "Welcome to {}, {}! Thanks for joining us! 🎉", + ctx.http().get_guild(new_member.guild_id).await?.name, + new_member.user.mention(), + )); + new_member + .user + .create_dm_channel(ctx.http.http()) + .await? + .send_message(ctx.http.http(), join_message) + .await?; + } + println!( + "{} Joined Server {} ", + new_member.user.name, + ctx.http().get_guild(new_member.guild_id).await?.name + ); + } + _ => {} + } + Ok(()) +}