diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e8892d --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Laniakea + +A lightweight, easy to use and performance Telegram API wrapper for bot development. \ No newline at end of file diff --git a/api.go b/api.go index e4c6645..aa9983e 100644 --- a/api.go +++ b/api.go @@ -63,3 +63,18 @@ func (r TelegramRequest[R, P]) Do(bot *Bot) (*R, error) { } return &response.Result, nil } + +func (b *Bot) GetFileByLink(link string) ([]byte, error) { + c := http.DefaultClient + u := fmt.Sprintf("https://api.telegram.org/file/bot%s/%s", b.token, link) + req, err := http.NewRequest("GET", u, nil) + if err != nil { + return nil, err + } + res, err := c.Do(req) + if err != nil { + return nil, err + } + defer res.Body.Close() + return io.ReadAll(res.Body) +} diff --git a/bot.go b/bot.go index 58c386b..9295a9c 100644 --- a/bot.go +++ b/bot.go @@ -8,6 +8,7 @@ import ( "strings" "time" + "git.nix13.pw/scuroneko/extypes" "git.nix13.pw/scuroneko/slog" "github.com/redis/go-redis/v9" "github.com/vinovest/sqlx" @@ -30,8 +31,8 @@ type Bot struct { logger *slog.Logger requestLogger *slog.Logger - plugins []*Plugin - middlewares []*Middleware + plugins []Plugin + middlewares []Middleware prefixes []string runners []Runner @@ -39,7 +40,7 @@ type Bot struct { updateOffset int updateTypes []string - updateQueue *Queue[*Update] + updateQueue *extypes.Queue[*Update] } type BotSettings struct { @@ -73,9 +74,9 @@ func LoadPrefixesFromEnv() []string { return strings.Split(prefixesS, ";") } func NewBot(settings *BotSettings) *Bot { - updateQueue := CreateQueue[*Update](256) + updateQueue := extypes.CreateQueue[*Update](256) bot := &Bot{ - updateOffset: 0, plugins: make([]*Plugin, 0), debug: settings.Debug, errorTemplate: "%s", + updateOffset: 0, plugins: make([]Plugin, 0), debug: settings.Debug, errorTemplate: "%s", prefixes: settings.Prefixes, updateTypes: make([]string, 0), runners: make([]Runner, 0), updateQueue: updateQueue, token: settings.Token, @@ -117,6 +118,12 @@ func NewBot(settings *BotSettings) *Bot { } } + u, err := bot.GetMe() + if err != nil { + bot.logger.Fatal(err) + } + bot.logger.Infof("Authorized as %s\n", u.FirstName) + return bot } @@ -171,20 +178,20 @@ func (b *Bot) Debug(debug bool) *Bot { b.debug = debug return b } -func (b *Bot) AddPlugins(plugin ...*Plugin) *Bot { +func (b *Bot) AddPlugins(plugin ...Plugin) *Bot { b.plugins = append(b.plugins, plugin...) for _, p := range plugin { b.logger.Debugln(fmt.Sprintf("plugins with name \"%s\" registered", p.Name)) } return b } -func (b *Bot) AddMiddleware(middleware ...*Middleware) *Bot { +func (b *Bot) AddMiddleware(middleware ...Middleware) *Bot { b.middlewares = append(b.middlewares, middleware...) for _, m := range middleware { b.logger.Debugln(fmt.Sprintf("middleware with name \"%s\" registered", m.Name)) } - sort.Slice(&b.middlewares, func(i, j int) bool { + sort.Slice(b.middlewares, func(i, j int) bool { first := b.middlewares[i] second := b.middlewares[j] if first.Order == second.Order { @@ -244,9 +251,7 @@ func (b *Bot) Run() { continue } - ctx := &MsgContext{ - Bot: b, Update: u, - } + ctx := &MsgContext{Bot: b, Update: u} for _, middleware := range b.middlewares { middleware.Execute(ctx, b.dbContext) } diff --git a/go.mod b/go.mod index 79c4658..bf2cc14 100644 --- a/go.mod +++ b/go.mod @@ -1,9 +1,10 @@ module git.nix13.pw/scuroneko/laniakea -go 1.25 +go 1.25.6 require ( - git.nix13.pw/scuroneko/slog v1.0.0 + git.nix13.pw/scuroneko/extypes v1.0.2 + git.nix13.pw/scuroneko/slog v1.0.2 github.com/redis/go-redis/v9 v9.17.3 github.com/vinovest/sqlx v1.7.1 go.mongodb.org/mongo-driver/v2 v2.5.0 diff --git a/go.sum b/go.sum index 21af68d..e737cc0 100644 --- a/go.sum +++ b/go.sum @@ -1,7 +1,9 @@ filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA= filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4= -git.nix13.pw/scuroneko/slog v1.0.0 h1:PI0YePrmCopjrljUfwCtBIEwNYB+PBgDzPcCXbetpcE= -git.nix13.pw/scuroneko/slog v1.0.0/go.mod h1:3Qm2wzkR5KjwOponMfG7TcGSDjmYaFqRAmLvSPTuWJI= +git.nix13.pw/scuroneko/extypes v1.0.2 h1:Qz1InLccaB9crXY33oGrSetPHePKfQAUqW/p/iYXmJk= +git.nix13.pw/scuroneko/extypes v1.0.2/go.mod h1:uZVs8Yo3RrYAG9dMad6qR6lsYY67t+459D9c65QAYAw= +git.nix13.pw/scuroneko/slog v1.0.2 h1:vZyUROygxC2d5FJHUQM/30xFEHY1JT/aweDZXA4rm2g= +git.nix13.pw/scuroneko/slog v1.0.2/go.mod h1:3Qm2wzkR5KjwOponMfG7TcGSDjmYaFqRAmLvSPTuWJI= github.com/bsm/ginkgo/v2 v2.12.0 h1:Ny8MWAHyOepLGlLKYmXG4IEkioBysk6GpaRTLC8zwWs= github.com/bsm/ginkgo/v2 v2.12.0/go.mod h1:SwYbGRRDovPVboqFv0tPTcG1sN61LM1Z4ARdbAV9g4c= github.com/bsm/gomega v1.27.10 h1:yeMWxP2pV2fG3FgAODIY8EiRE3dy0aeFYt4l7wh6yKA= diff --git a/handler.go b/handler.go index 3559d60..c2f8877 100644 --- a/handler.go +++ b/handler.go @@ -39,6 +39,9 @@ func (b *Bot) handleMessage(update *Update, ctx *MsgContext) { ctx.Text = strings.TrimSpace(text[len(cmd):]) ctx.Args = strings.Split(ctx.Text, " ") + if !plugin.executeMiddlewares(ctx, b.dbContext) { + return + } go plugin.Execute(cmd, ctx, b.dbContext) return } @@ -57,6 +60,7 @@ func (b *Bot) handleCallback(update *Update, ctx *MsgContext) { ctx.From = update.CallbackQuery.From ctx.Msg = update.CallbackQuery.Message ctx.CallbackMsgId = update.CallbackQuery.Message.MessageID + ctx.CallbackQueryId = update.CallbackQuery.ID ctx.Args = data.Args for _, plugin := range b.plugins { @@ -64,6 +68,10 @@ func (b *Bot) handleCallback(update *Update, ctx *MsgContext) { if !ok { continue } + + if !plugin.executeMiddlewares(ctx, b.dbContext) { + return + } go plugin.ExecutePayload(data.Command, ctx, b.dbContext) return } diff --git a/methods.go b/methods.go index d2f02fe..81ef1b6 100644 --- a/methods.go +++ b/methods.go @@ -73,21 +73,36 @@ func (b *Bot) SendMessage(params *SendMessageP) (*Message, error) { return req.Do(b) } +type SendPhotoBaseP struct { + BusinessConnectionID string `json:"business_connection_id,omitempty"` + ChatID int `json:"chat_id"` + MessageThreadID int `json:"message_thread_id,omitempty"` + ParseMode ParseMode `json:"parse_mode,omitempty"` + Caption string `json:"caption,omitempty"` + CaptionEntities []*MessageEntity `json:"caption_entities,omitempty"` + ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"` + HasSpoiler bool `json:"has_spoiler,omitempty"` + DisableNotifications bool `json:"disable_notifications,omitempty"` + ProtectContent bool `json:"protect_content,omitempty"` + AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"` + MessageEffectID string `json:"message_effect_id,omitempty"` + ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` +} type SendPhotoP struct { BusinessConnectionID string `json:"business_connection_id,omitempty"` ChatID int `json:"chat_id"` MessageThreadID int `json:"message_thread_id,omitempty"` ParseMode ParseMode `json:"parse_mode,omitempty"` - Photo string `json:"photo"` Caption string `json:"caption,omitempty"` CaptionEntities []*MessageEntity `json:"caption_entities,omitempty"` - ShowCaptionAboveMedia bool `json:"show_caption_above_media"` - HasSpoiler bool `json:"has_spoiler"` + ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"` + HasSpoiler bool `json:"has_spoiler,omitempty"` DisableNotifications bool `json:"disable_notifications,omitempty"` ProtectContent bool `json:"protect_content,omitempty"` AllowPaidBroadcast bool `json:"allow_paid_broadcast,omitempty"` MessageEffectID string `json:"message_effect_id,omitempty"` ReplyMarkup InlineKeyboardMarkup `json:"reply_markup,omitempty"` + Photo string `json:"photo"` } func (b *Bot) SendPhoto(params *SendPhotoP) (*Message, error) { @@ -130,7 +145,99 @@ type DeleteMessageP struct { MessageID int `json:"message_id"` } -func (b *Bot) DeleteMessage(params *DeleteMessageP) (*Message, error) { - req := NewRequest[Message]("deleteMessage", params) +func (b *Bot) DeleteMessage(params *DeleteMessageP) (bool, error) { + req := NewRequest[bool]("deleteMessage", params) + ok, err := req.Do(b) + if err != nil { + return false, err + } + return *ok, err +} + +type AnswerCallbackQueryP struct { + CallbackQueryID string `json:"callback_query_id"` + Text string `json:"text,omitempty"` + ShowAlert bool `json:"show_alert,omitempty"` + URL string `json:"url,omitempty"` + CacheTime int `json:"cache_time,omitempty"` +} + +func (b *Bot) AnswerCallbackQuery(params *AnswerCallbackQueryP) (bool, error) { + req := NewRequest[bool]("answerCallbackQuery", params) + ok, err := req.Do(b) + if err != nil { + return false, err + } + return *ok, err +} + +type GetFileP struct { + FileId string `json:"file_id"` +} + +func (b *Bot) GetFile(params *GetFileP) (*File, error) { + req := NewRequest[File]("getFile", params) return req.Do(b) } + +type SendChatActionP struct { + BusinessConnectionID string `json:"business_connection_id,omitempty"` + ChatID int `json:"chat_id"` + MessageThreadID int `json:"message_thread_id,omitempty"` + Action ChatActions `json:"action"` +} + +func (b *Bot) SendChatAction(params SendChatActionP) (bool, error) { + req := NewRequest[bool]("sendChatAction", params) + res, err := req.Do(b) + if err != nil { + return false, err + } + return *res, err +} + +type SetMessageReactionP struct { + ChatId int `json:"chat_id"` + MessageId int `json:"message_id"` + IsBig bool `json:"is_big,omitempty"` +} +type SetMessageReactionEmojiP struct { + SetMessageReactionP + Reaction []ReactionTypeEmoji `json:"reaction"` +} + +func (b *Bot) SetMessageReactionEmoji(params SetMessageReactionEmojiP) (bool, error) { + req := NewRequest[bool]("setMessageReaction", params) + res, err := req.Do(b) + if err != nil { + return false, err + } + return *res, err +} + +type SetMessageReactionCustomEmojiP struct { + SetMessageReactionP + Reaction []ReactionTypeCustomEmoji `json:"reaction"` +} + +func (b *Bot) SetMessageReactionCustom(params SetMessageReactionCustomEmojiP) (bool, error) { + req := NewRequest[bool]("setMessageReaction", params) + res, err := req.Do(b) + if err != nil { + return false, err + } + return *res, err +} + +type SetMessageReactionPaidP struct { + SetMessageReactionP +} + +func (b *Bot) SetMessageReactionPaid(params SetMessageReactionPaidP) (bool, error) { + req := NewRequest[bool]("setMessageReaction", params) + res, err := req.Do(b) + if err != nil { + return false, err + } + return *res, err +} diff --git a/msg_context.go b/msg_context.go index 441ee6a..e1d92bc 100644 --- a/msg_context.go +++ b/msg_context.go @@ -3,15 +3,16 @@ package laniakea import "fmt" type MsgContext struct { - Bot *Bot - Msg *Message - Update *Update - From *User - CallbackMsgId int - FromID int - Prefix string - Text string - Args []string + Bot *Bot + Msg *Message + Update *Update + From *User + CallbackMsgId int + CallbackQueryId string + FromID int + Prefix string + Text string + Args []string } type AnswerMessage struct { @@ -75,6 +76,10 @@ func (ctx *MsgContext) editPhotoText(messageId int, text string, kb *InlineKeybo } } func (m *AnswerMessage) EditCaption(text string) *AnswerMessage { + if m.MessageID == 0 { + m.ctx.Bot.logger.Errorln("Can't edit caption message, message id is zero") + return m + } return m.ctx.editPhotoText(m.MessageID, text, nil) } func (m *AnswerMessage) EditCaptionKeyboard(text string, kb *InlineKeyboard) *AnswerMessage { @@ -114,8 +119,8 @@ func (ctx *MsgContext) answerPhoto(photoId, text string, kb *InlineKeyboard) *An params := &SendPhotoP{ ChatID: ctx.Msg.Chat.ID, Caption: text, - Photo: photoId, ParseMode: ParseMD, + Photo: photoId, } if kb != nil { params.ReplyMarkup = kb.Get() @@ -123,6 +128,9 @@ func (ctx *MsgContext) answerPhoto(photoId, text string, kb *InlineKeyboard) *An msg, err := ctx.Bot.SendPhoto(params) if err != nil { ctx.Bot.logger.Errorln(err) + return &AnswerMessage{ + ctx: ctx, Text: text, IsMedia: true, + } } return &AnswerMessage{ MessageID: msg.MessageID, ctx: ctx, Text: text, IsMedia: true, @@ -151,14 +159,50 @@ func (ctx *MsgContext) CallbackDelete() { ctx.delete(ctx.CallbackMsgId) } -func (ctx *MsgContext) Error(err error) { - _, sendErr := ctx.Bot.SendMessage(&SendMessageP{ - ChatID: ctx.Msg.Chat.ID, - Text: fmt.Sprintf(ctx.Bot.errorTemplate, EscapeMarkdown(err.Error())), +func (ctx *MsgContext) answerCallbackQuery(url, text string, showAlert bool) { + if len(ctx.CallbackQueryId) == 0 { + return + } + _, err := ctx.Bot.AnswerCallbackQuery(&AnswerCallbackQueryP{ + CallbackQueryID: ctx.CallbackQueryId, + Text: text, ShowAlert: showAlert, URL: url, }) - ctx.Bot.logger.Errorln(err) - - if sendErr != nil { - ctx.Bot.logger.Errorln(sendErr) + if err != nil { + ctx.Bot.logger.Errorln(err) } } +func (ctx *MsgContext) AnswerCbQuery() { + ctx.answerCallbackQuery("", "", false) +} +func (ctx *MsgContext) AnswerCbQueryText(text string) { + ctx.answerCallbackQuery("", text, false) +} +func (ctx *MsgContext) AnswerCbQueryAlert(text string) { + ctx.answerCallbackQuery("", text, true) +} +func (ctx *MsgContext) AnswerCbQueryUrl(u string) { + ctx.answerCallbackQuery(u, "", false) +} + +func (ctx *MsgContext) SendAction(action ChatActions) { + _, err := ctx.Bot.SendChatAction(SendChatActionP{ + ChatID: ctx.Msg.Chat.ID, Action: action, + }) + if err != nil { + ctx.Bot.logger.Errorln(err) + } +} + +func (ctx *MsgContext) error(err error) { + text := fmt.Sprintf(ctx.Bot.errorTemplate, EscapeMarkdown(err.Error())) + + if ctx.CallbackQueryId != "" { + ctx.answerCallbackQuery("", text, false) + } else { + ctx.answer(text, nil) + } + ctx.Bot.logger.Errorln(err) +} +func (ctx *MsgContext) Error(err error) { + ctx.error(err) +} diff --git a/multipart.go b/multipart.go new file mode 100644 index 0000000..e928fc3 --- /dev/null +++ b/multipart.go @@ -0,0 +1,131 @@ +package laniakea + +import ( + "encoding/json" + "fmt" + "io" + "mime/multipart" + "reflect" + "slices" + "strconv" + "strings" +) + +func Encode[T any](w *multipart.Writer, req T) error { + v := reflect.ValueOf(req) + if v.Kind() == reflect.Ptr { + v = v.Elem() + } + + if v.Kind() != reflect.Struct { + return fmt.Errorf("req must be a struct") + } + + t := v.Type() + for i := 0; i < v.NumField(); i++ { + field := v.Field(i) + fieldType := t.Field(i) + + formTags := strings.Split(fieldType.Tag.Get("json"), ",") + fieldName := "" + if len(formTags) == 0 { + formTags = strings.Split(fieldType.Tag.Get("json"), ",") + } + + if len(formTags) > 0 { + fieldName = formTags[0] + if fieldName == "-" { + continue + } + if slices.Index(formTags, "omitempty") >= 0 { + if field.IsZero() { + continue + } + } + } else { + fieldName = strings.ToLower(fieldType.Name) + } + + var ( + fw io.Writer + err error + ) + switch field.Kind() { + case reflect.String: + if field.String() != "" { + fw, err = w.CreateFormField(fieldName) + if err == nil { + _, err = fw.Write([]byte(field.String())) + } + } + case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: + fw, err = w.CreateFormField(fieldName) + if err == nil { + _, err = fw.Write([]byte(strconv.FormatInt(field.Int(), 10))) + } + case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64: + fw, err = w.CreateFormField(fieldName) + if err == nil { + _, err = fw.Write([]byte(strconv.FormatUint(field.Uint(), 10))) + } + case reflect.Float32, reflect.Float64: + fw, err = w.CreateFormField(fieldName) + if err == nil { + _, err = fw.Write([]byte(strconv.FormatFloat(field.Float(), 'f', -1, 64))) + } + case reflect.Bool: + fw, err = w.CreateFormField(fieldName) + if err == nil { + _, err = fw.Write([]byte(strconv.FormatBool(field.Bool()))) + } + + case reflect.Slice: + if field.Type().Elem().Kind() == reflect.Uint8 && !field.IsNil() { + filename := fieldType.Tag.Get("filename") + if filename == "" { + filename = fieldName + } + + ext := "" + filename = filename + ext + + fw, err = w.CreateFormFile(fieldName, filename) + if err == nil { + _, err = fw.Write(field.Bytes()) + } + } else if !field.IsNil() { + // Handle slice of primitive values (as multiple form fields with the same name) + for j := 0; j < field.Len(); j++ { + elem := field.Index(j) + fw, err = w.CreateFormField(fieldName) + if err == nil { + switch elem.Kind() { + case reflect.String: + _, err = fw.Write([]byte(elem.String())) + case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: + _, err = fw.Write([]byte(strconv.FormatInt(elem.Int(), 10))) + case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64: + _, err = fw.Write([]byte(strconv.FormatUint(elem.Uint(), 10))) + } + } + } + } + + case reflect.Struct: + var jsonData []byte + jsonData, err = json.Marshal(field.Interface()) + if err == nil { + fw, err = w.CreateFormField(fieldName) + if err == nil { + _, err = fw.Write(jsonData) + } + } + } + + if err != nil { + return err + } + } + + return nil +} diff --git a/plugins.go b/plugins.go index eb56574..86b5e96 100644 --- a/plugins.go +++ b/plugins.go @@ -1,6 +1,10 @@ package laniakea -import "log" +import ( + "log" + + "git.nix13.pw/scuroneko/extypes" +) type CommandExecutor func(ctx *MsgContext, dbContext *DatabaseContext) @@ -9,6 +13,7 @@ type PluginBuilder struct { commands map[string]*CommandExecutor payloads map[string]*CommandExecutor updateListener *CommandExecutor + middlewares extypes.Slice[*PluginMiddleware] } type Plugin struct { @@ -16,6 +21,7 @@ type Plugin struct { Commands map[string]*CommandExecutor Payloads map[string]*CommandExecutor UpdateListener *CommandExecutor + Middlewares extypes.Slice[*PluginMiddleware] } func NewPlugin(name string) *PluginBuilder { @@ -45,17 +51,22 @@ func (p *PluginBuilder) UpdateListener(listener CommandExecutor) *PluginBuilder return p } -func (p *PluginBuilder) Build() *Plugin { +func (p *PluginBuilder) Middleware(middleware *PluginMiddleware) *PluginBuilder { + p.middlewares = p.middlewares.Push(middleware) + return p +} + +func (p *PluginBuilder) Build() Plugin { if len(p.commands) == 0 && len(p.payloads) == 0 { log.Println("no command or payloads") } - plugin := &Plugin{ + return Plugin{ Name: p.name, Commands: p.commands, Payloads: p.payloads, UpdateListener: p.updateListener, + Middlewares: p.middlewares, } - return plugin } func (p *Plugin) Execute(cmd string, ctx *MsgContext, dbContext *DatabaseContext) { @@ -66,28 +77,37 @@ func (p *Plugin) ExecutePayload(payload string, ctx *MsgContext, dbContext *Data (*p.Payloads[payload])(ctx, dbContext) } +func (p *Plugin) executeMiddlewares(ctx *MsgContext, db *DatabaseContext) bool { + for _, m := range p.Middlewares { + if !m.Execute(ctx, db) { + return false + } + } + return true +} + type Middleware struct { Name string - Executor *CommandExecutor + Executor CommandExecutor Order int Async bool } type MiddlewareBuilder struct { name string - executor *CommandExecutor + executor CommandExecutor order int async bool } -func NewMiddleware(name string) *MiddlewareBuilder { - return &MiddlewareBuilder{name: name, async: false} +func NewMiddleware(name string, executor CommandExecutor) *MiddlewareBuilder { + return &MiddlewareBuilder{name: name, executor: executor, order: 0, async: false} } func (m *MiddlewareBuilder) SetName(name string) *MiddlewareBuilder { m.name = name return m } func (m *MiddlewareBuilder) SetExecutor(executor CommandExecutor) *MiddlewareBuilder { - m.executor = &executor + m.executor = executor return m } func (m *MiddlewareBuilder) SetOrder(order int) *MiddlewareBuilder { @@ -98,19 +118,51 @@ func (m *MiddlewareBuilder) SetAsync(async bool) *MiddlewareBuilder { m.async = async return m } -func (m *MiddlewareBuilder) Build() *Middleware { - return &Middleware{ +func (m *MiddlewareBuilder) Build() Middleware { + return Middleware{ Name: m.name, Executor: m.executor, Order: m.order, Async: m.async, } } -func (m *Middleware) Execute(ctx *MsgContext, db *DatabaseContext) { - exec := *m.Executor +func (m Middleware) Execute(ctx *MsgContext, db *DatabaseContext) { if m.Async { - go exec(ctx, db) + go m.Executor(ctx, db) } else { - exec(ctx, db) + m.Execute(ctx, db) } } + +type PluginMiddlewareExecutor func(ctx *MsgContext, db *DatabaseContext) bool + +// PluginMiddleware +// When async, returned value ignored +type PluginMiddleware struct { + executor PluginMiddlewareExecutor + order int + async bool +} + +func NewPluginMiddleware(executor PluginMiddlewareExecutor) *PluginMiddleware { + return &PluginMiddleware{ + executor: executor, + order: 0, + async: false, + } +} +func (m *PluginMiddleware) SetOrder(order int) *PluginMiddleware { + m.order = order + return m +} +func (m *PluginMiddleware) SetAsync(async bool) *PluginMiddleware { + m.async = async + return m +} +func (m *PluginMiddleware) Execute(ctx *MsgContext, db *DatabaseContext) bool { + if m.async { + go m.executor(ctx, db) + return true + } + return m.executor(ctx, db) +} diff --git a/queue.go b/queue.go deleted file mode 100644 index d319ce7..0000000 --- a/queue.go +++ /dev/null @@ -1,71 +0,0 @@ -package laniakea - -import ( - "errors" - "sync" -) - -var QueueFullErr = errors.New("queue full") - -type Queue[T any] struct { - size uint64 - mu sync.RWMutex - queue []T -} - -func CreateQueue[T any](size uint64) *Queue[T] { - return &Queue[T]{ - queue: make([]T, 0), - size: size, - } -} - -func (q *Queue[T]) Enqueue(el T) error { - if q.IsFull() { - return QueueFullErr - } - q.queue = append(q.queue, el) - return nil -} - -func (q *Queue[T]) Peak() T { - q.mu.RLock() - defer q.mu.RUnlock() - return q.queue[0] -} - -func (q *Queue[T]) IsEmpty() bool { - return q.Length() == 0 -} - -func (q *Queue[T]) IsFull() bool { - return q.Length() == q.size -} - -func (q *Queue[T]) Length() uint64 { - q.mu.RLock() - defer q.mu.RUnlock() - return uint64(len(q.queue)) -} - -func (q *Queue[T]) Dequeue() T { - q.mu.RLock() - el := q.queue[0] - q.mu.RUnlock() - - if q.Length() == 1 { - q.mu.Lock() - q.queue = make([]T, 0) - q.mu.Unlock() - return el - } - - q.mu.Lock() - q.queue = q.queue[1:] - q.mu.Unlock() - return el -} - -func (q *Queue[T]) Raw() []T { - return q.queue -} diff --git a/types.go b/types.go index f2fa3b7..974f144 100644 --- a/types.go +++ b/types.go @@ -1,5 +1,7 @@ package laniakea +import "git.nix13.pw/scuroneko/extypes" + type Update struct { UpdateID int `json:"update_id"` Message *Message `json:"message"` @@ -54,9 +56,9 @@ type Message struct { Chat *Chat `json:"chat,omitempty"` Text string `json:"text"` - Photo []*PhotoSize `json:"photo,omitempty"` - Caption string `json:"caption,omitempty"` - ReplyToMessage *Message `json:"reply_to_message"` + Photo extypes.Slice[*PhotoSize] `json:"photo,omitempty"` + Caption string `json:"caption,omitempty"` + ReplyToMessage *Message `json:"reply_to_message"` ReplyMarkup *MessageReplyMarkup `json:"reply_markup,omitempty"` } @@ -172,3 +174,23 @@ type ReactionCount struct { Type *ReactionType `json:"type"` TotalCount int `json:"total_count"` } + +type File struct { + FileId string `json:"file_id"` + FileUniqueID string `json:"file_unique_id"` + FileSize int `json:"file_size,omitempty"` + FilePath string `json:"file_path,omitempty"` +} + +type ChatActions string + +const ( + ChatActionTyping ChatActions = "typing" + ChatActionUploadPhoto ChatActions = "upload_photo" + ChatActionUploadVideo ChatActions = "upload_video" + ChatActionUploadVoice ChatActions = "upload_voice" + ChatActionUploadDocument ChatActions = "upload_document" + ChatActionChooseSticker ChatActions = "choose_sticker" + ChatActionFindLocation ChatActions = "find_location" + ChatActionUploadVideoNone ChatActions = "upload_video_none" +) diff --git a/uploader.go b/uploader.go new file mode 100644 index 0000000..def36ce --- /dev/null +++ b/uploader.go @@ -0,0 +1,136 @@ +package laniakea + +import ( + "bytes" + "encoding/json" + "fmt" + "io" + "mime/multipart" + "net/http" + "path/filepath" +) + +type Uploader struct { + bot *Bot +} + +func NewUploader(bot *Bot) *Uploader { + return &Uploader{bot: bot} +} + +type UploaderFileType string + +const ( + UploaderPhotoType UploaderFileType = "photo" + UploaderVideoType UploaderFileType = "video" + UploaderAudioType UploaderFileType = "audio" + UploaderDocumentType UploaderFileType = "document" + UploaderVoiceType UploaderFileType = "voice" + UploaderVideoNoteType UploaderFileType = "video_note" +) + +type UploaderFile struct { + filename string + data []byte + t UploaderFileType +} + +func NewUploaderFile(name string, data []byte) UploaderFile { + t := uploaderTypeByExt(name) + return UploaderFile{filename: name, data: data, t: t} +} + +// SetType used when auto-detect failed. I.e. you sending a voice message, but it detects as audio +func (f UploaderFile) SetType(t UploaderFileType) UploaderFile { + f.t = t + return f +} + +type UploaderRequest[R, P any] struct { + method string + file UploaderFile + params P +} + +func NewUploaderRequest[R, P any](method string, file UploaderFile, params P) UploaderRequest[R, P] { + return UploaderRequest[R, P]{method, file, params} +} + +func (u UploaderRequest[R, P]) Do(bot *Bot) (*R, error) { + url := fmt.Sprintf("https://api.telegram.org/bot%s/%s", bot.token, u.method) + + buf := bytes.NewBuffer(nil) + w := multipart.NewWriter(buf) + + fw, err := w.CreateFormFile(string(u.file.t), u.file.filename) + if err != nil { + w.Close() + return nil, err + } + _, err = fw.Write(u.file.data) + if err != nil { + w.Close() + return nil, err + } + err = Encode(w, u.params) + if err != nil { + w.Close() + return nil, err + } + err = w.Close() + if err != nil { + return nil, err + } + + req, err := http.NewRequest("POST", url, buf) + if err != nil { + return nil, err + } + req.Header.Set("Content-Type", w.FormDataContentType()) + bot.logger.Debugln("UPLOADER REQ", u.method) + res, err := http.DefaultClient.Do(req) + if err != nil { + return nil, err + } + defer res.Body.Close() + + body, err := io.ReadAll(res.Body) + if err != nil { + return nil, err + } + bot.logger.Debugln("UPLOADER RES", u.method, string(body)) + if res.StatusCode != http.StatusOK { + return nil, fmt.Errorf("[%d] %s", res.StatusCode, string(body)) + } + + response := new(ApiResponse[*R]) + err = json.Unmarshal(body, response) + if err != nil { + return nil, err + } + if !response.Ok { + return nil, fmt.Errorf("[%d] %s", response.ErrorCode, response.Description) + } + return response.Result, nil +} + +func (u *Uploader) UploadPhoto(file UploaderFile, params SendPhotoBaseP) (*Message, error) { + req := NewUploaderRequest[Message]("sendPhoto", file, params) + return req.Do(u.bot) +} + +func uploaderTypeByExt(filename string) UploaderFileType { + ext := filepath.Ext(filename) + switch ext { + case ".jpg", ".jpeg", ".png", ".webp", ".bmp": + return UploaderPhotoType + case ".mp4": + return UploaderVideoType + case ".mp3", ".m4a": + return UploaderAudioType + case ".ogg": + return UploaderVoiceType + default: + return UploaderDocumentType + } +} diff --git a/utils.go b/utils.go index b071e13..5bfad8d 100644 --- a/utils.go +++ b/utils.go @@ -41,12 +41,12 @@ func MapToJson(m map[string]any) (string, error) { return string(data), err } -func StructToMap(s interface{}) (map[string]interface{}, error) { +func StructToMap(s any) (map[string]any, error) { data, err := json.Marshal(s) if err != nil { return nil, err } - m := make(map[string]interface{}) + m := make(map[string]any) err = json.Unmarshal(data, &m) return m, err } @@ -73,57 +73,3 @@ func EscapeMarkdownV2(s string) string { } return s } - -func GetUnclosedTag(markdown string) string { - // order is important! - var tags = []string{ - "```", - "`", - "*", - "_", - } - var currentTag = "" - - markdownRunes := []rune(markdown) - - var i = 0 -outer: - for i < len(markdownRunes) { - // skip escaped characters (only outside tags) - if markdownRunes[i] == '\\' && currentTag == "" { - i += 2 - continue - } - if currentTag != "" { - if strings.HasPrefix(string(markdownRunes[i:]), currentTag) { - // turn a tag off - i += len(currentTag) - currentTag = "" - continue - } - } else { - for _, tag := range tags { - if strings.HasPrefix(string(markdownRunes[i:]), tag) { - // turn a tag on - currentTag = tag - i += len(currentTag) - continue outer - } - } - } - i++ - } - - return currentTag -} -func IsValid(markdown string) bool { - return GetUnclosedTag(markdown) == "" -} - -func FixMarkdown(markdown string) string { - tag := GetUnclosedTag(markdown) - if tag == "" { - return markdown - } - return markdown + tag -} diff --git a/version.go b/version.go index eda06e3..2661f98 100644 --- a/version.go +++ b/version.go @@ -1,8 +1,8 @@ package laniakea const ( - VersionString = "0.3.2" + VersionString = "0.3.9" VersionMajor = 0 VersionMinor = 3 - VersionPatch = 2 + VersionPatch = 9 )