commit 0a1dd87fe70ec6a8e2ada46effa898c779273ea0 Author: Trevor Slocum Date: Thu Nov 30 13:27:42 2023 -0800 Initial commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f3adc3b --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# bgammon-tabula-bot - tabula bot for [bgammon.org](https://bgammon.org) + +## Support + +Please share issues and suggestions [here](https://code.rocket9labs.com/tslocum/bgammon-tabula-bot/issues). diff --git a/bot/client.go b/bot/client.go new file mode 100644 index 0000000..2735a87 --- /dev/null +++ b/bot/client.go @@ -0,0 +1,485 @@ +package bot + +import ( + "bufio" + "bytes" + "context" + "fmt" + "log" + "math" + "net" + "os" + "strings" + "text/tabwriter" + "time" + + "code.rocket9labs.com/tslocum/bgammon" + "code.rocket9labs.com/tslocum/tabula" + "nhooyr.io/websocket" +) + +var Debug int + +var Game = &bgammon.GameState{ + Game: bgammon.NewGame(false), +} + +type Client struct { + Address string + Username string + Password string + Events chan interface{} + Out chan []byte + points int + connecting bool + sentGreeting bool + rolled bool + lastActivity time.Time +} + +func NewClient(address string, username string, password string, points int) *Client { + const bufferSize = 10 + c := &Client{ + Address: address, + Username: username, + Password: password, + Events: make(chan interface{}, bufferSize), + Out: make(chan []byte, bufferSize), + points: points, + } + go c.handleTimeout() + return c +} + +func NewLocalClient(conn net.Conn, address string, username string, password string, points int) { + c := NewClient(address, username, password, points) + c.connecting = true + go c.connectTCP(conn) + c.HandleEvents() +} + +func (c *Client) Connect() { + if c.connecting { + return + } + c.connecting = true + + if strings.HasPrefix(c.Address, "ws://") || strings.HasPrefix(c.Address, "wss://") { + c.connectWebSocket() + return + } + c.connectTCP(nil) +} + +func (c *Client) logIn() []byte { + loginInfo := strings.ReplaceAll(c.Username, " ", "_") + if c.Username != "" && c.Password != "" { + loginInfo = fmt.Sprintf("%s %s", strings.ReplaceAll(c.Username, " ", "_"), strings.ReplaceAll(c.Password, " ", "_")) + } + return []byte(fmt.Sprintf("lj bgammon-tabula-bot %s\nlist\n", loginInfo)) +} + +func (c *Client) LoggedIn() bool { + return c.connecting +} + +func (c *Client) connectWebSocket() { + reconnect := func() { + log.Println("*** Reconnecting...") + time.Sleep(2 * time.Second) + go c.connectWebSocket() + } + + ctx, _ := context.WithTimeout(context.Background(), 10*time.Second) + + conn, _, err := websocket.Dial(ctx, c.Address, nil) + if err != nil { + reconnect() + return + } + + for _, msg := range bytes.Split(c.logIn(), []byte("\n")) { + if len(msg) == 0 { + continue + } + + ctx, _ = context.WithTimeout(context.Background(), 10*time.Second) + + err = conn.Write(ctx, websocket.MessageText, msg) + if err != nil { + reconnect() + return + } + } + + go c.handleWebSocketWrite(conn) + c.handleWebSocketRead(conn) + + reconnect() +} + +func (c *Client) handleWebSocketWrite(conn *websocket.Conn) { + var ctx context.Context + for buf := range c.Out { + split := bytes.Split(buf, []byte("\n")) + for i := range split { + if len(split[i]) == 0 { + continue + } + + ctx, _ = context.WithTimeout(context.Background(), 10*time.Second) + + err := conn.Write(ctx, websocket.MessageText, split[i]) + if err != nil { + conn.Close(websocket.StatusNormalClosure, "Write error") + return + } + + if Debug > 0 { + log.Printf("-> %s", split[i]) + } + } + } +} + +func (c *Client) handleWebSocketRead(conn *websocket.Conn) { + for { + msgType, msg, err := conn.Read(context.Background()) + if err != nil || msgType != websocket.MessageText { + conn.Close(websocket.StatusNormalClosure, "Read error") + return + } + + ev, err := bgammon.DecodeEvent(msg) + if err != nil { + log.Printf("error: failed to parse message: %s", msg) + conn.Close(websocket.StatusNormalClosure, "Read error") + return + } + c.Events <- ev + + if Debug > 0 { + log.Printf("<- %s", msg) + } + } +} + +func (c *Client) connectTCP(conn net.Conn) { + address := c.Address + if strings.HasPrefix(c.Address, "tcp://") { + address = c.Address[6:] + } + + reconnect := func() { + log.Println("*** Disconnected") + os.Exit(0) // TODO Reconnecting is currently disabled. + + log.Println("*** Reconnecting...") + time.Sleep(2 * time.Second) + go c.connectTCP(nil) + } + + if conn == nil { + var err error + conn, err = net.DialTimeout("tcp", address, 10*time.Second) + if err != nil { + reconnect() + return + } + } + + // Read a single line of text and parse remaining output as JSON. + buf := make([]byte, 1) + var readBytes int + for { + _, err := conn.Read(buf) + if err != nil { + reconnect() + return + } + + if buf[0] == '\n' { + break + } + + readBytes++ + if readBytes == 512 { + reconnect() + return + } + } + + conn.SetWriteDeadline(time.Now().Add(10 * time.Second)) + + _, err := conn.Write(c.logIn()) + if err != nil { + reconnect() + return + } + + go c.handleTCPWrite(conn) + c.handleTCPRead(conn) + + reconnect() +} + +func (c *Client) handleTCPWrite(conn net.Conn) { + for buf := range c.Out { + conn.SetWriteDeadline(time.Now().Add(10 * time.Second)) + + _, err := conn.Write(buf) + if err != nil { + conn.Close() + return + } + + conn.SetWriteDeadline(time.Now().Add(10 * time.Second)) + + _, err = conn.Write([]byte("\n")) + if err != nil { + conn.Close() + return + } + + if Debug > 0 { + log.Printf("-> %s", buf) + } + } +} + +func (c *Client) handleTCPRead(conn net.Conn) { + conn.SetReadDeadline(time.Now().Add(40 * time.Second)) + + scanner := bufio.NewScanner(conn) + for scanner.Scan() { + if scanner.Err() != nil { + conn.Close() + return + } + + ev, err := bgammon.DecodeEvent(scanner.Bytes()) + if err != nil { + log.Printf("error: failed to parse message: %s", scanner.Bytes()) + conn.Close() + return + } + c.Events <- ev + + if Debug > 0 { + log.Printf("<- %s", scanner.Bytes()) + } + + conn.SetReadDeadline(time.Now().Add(40 * time.Second)) + } +} + +func (c *Client) createMatch() { + c.Out <- []byte(fmt.Sprintf("c public %d", c.points)) + c.sentGreeting = false + c.rolled = false +} + +func (c *Client) handleTimeout() { + t := time.NewTicker(time.Minute) + for range t.C { + if !c.rolled { + continue + } + + if len(Game.Player2.Name) == 0 && time.Since(c.lastActivity) >= 2*time.Minute { + c.Out <- []byte("leave") + continue + } + + t := time.Now() + delta := t.Sub(c.lastActivity) + if delta >= 5*time.Minute { + c.Out <- []byte("say Sorry, this match has timed out.") + c.Out <- []byte("leave") + } else if t.Sub(c.lastActivity) >= 2*time.Minute { + plural := "s" + if 6-math.Ceil(delta.Minutes()) == 1 { + plural = "" + } + c.Out <- []byte(fmt.Sprintf("say Warning: This match will time out in %d minute%s. Please roll or make a move.", int(6-math.Ceil(delta.Minutes())), plural)) + } + } +} + +func (c *Client) HandleEvents() { + for e := range c.Events { + switch ev := e.(type) { + case *bgammon.EventWelcome: + c.Username = ev.PlayerName + + areIs := "are" + if ev.Clients == 1 { + areIs = "is" + } + clientsPlural := "s" + if ev.Clients == 1 { + clientsPlural = "" + } + matchesPlural := "es" + if ev.Games == 1 { + matchesPlural = "" + } + log.Printf("*** Welcome, %s. There %s %d client%s playing %d match%s.", ev.PlayerName, areIs, ev.Clients, clientsPlural, ev.Games, matchesPlural) + + c.createMatch() + case *bgammon.EventNotice: + log.Printf("*** %s", ev.Message) + case *bgammon.EventSay: + log.Printf("<%s> %s", ev.Player, ev.Message) + case *bgammon.EventList: + case *bgammon.EventJoined: + if ev.PlayerNumber == 1 { + Game.Player1.Name = ev.Player + } else if ev.PlayerNumber == 2 { + c.lastActivity = time.Now() + Game.Player2.Name = ev.Player + } + if ev.Player != c.Username { + log.Printf("%s joined the match.", ev.Player) + if !c.sentGreeting { + c.Out <- []byte(fmt.Sprintf("say Hello, %s. I am a bot powered by the tabula backgammon engine. Good luck, have fun.", ev.Player)) + c.sentGreeting = true + } + } + case *bgammon.EventFailedJoin: + log.Printf("*** Failed to join match: %s", ev.Reason) + case *bgammon.EventFailedLeave: + log.Printf("*** Failed to leave match: %s", ev.Reason) + + c.createMatch() + case *bgammon.EventLeft: + if Game.Player1.Name == ev.Player { + Game.Player1.Name = "" + } else if Game.Player2.Name == ev.Player { + Game.Player2.Name = "" + } + if ev.Player == c.Username { + c.createMatch() + } else { + log.Printf("%s left the match.", ev.Player) + } + case *bgammon.EventBoard: + c.lastActivity = time.Now() + + *Game = ev.GameState + *Game.Game = *ev.GameState.Game + + if Game.DoubleOffered && Game.DoublePlayer != Game.PlayerNumber { + acceptCube := true // TODO + if acceptCube { + c.Out <- []byte("ok") + } else { + c.Out <- []byte("resign") + } + c.rolled = true + continue + } + + if Game.Roll1 == 0 && len(Game.Player2.Name) != 0 && (Game.Turn == 0 || Game.Turn == Game.PlayerNumber) && Game.MayRoll() { + if Game.MayDouble() { + // TODO + } + c.Out <- []byte("r") + c.rolled = true + continue + } else if Game.Turn == 0 || Game.Turn != Game.PlayerNumber { + continue + } + + if len(Game.Moves) != 0 { + continue + } else if len(Game.Available) == 0 { + c.Out <- []byte("ok") + c.lastActivity = time.Now() + continue + } + + log.Println("==========") + log.Println("Legal moves:", Game.Available) + + b := Game.Board + var roll1, roll2, roll3, roll4 int8 + roll1, roll2 = int8(Game.Roll1), int8(Game.Roll2) + if roll1 == roll2 { + roll3, roll4 = int8(Game.Roll1), int8(Game.Roll2) + } + boardState := tabula.Board{int8(b[0]), int8(b[1]), int8(b[2]), int8(b[3]), int8(b[4]), int8(b[5]), int8(b[6]), int8(b[7]), int8(b[8]), int8(b[9]), int8(b[10]), int8(b[11]), int8(b[12]), int8(b[13]), int8(b[14]), int8(b[15]), int8(b[16]), int8(b[17]), int8(b[18]), int8(b[19]), int8(b[20]), int8(b[21]), int8(b[22]), int8(b[23]), int8(b[24]), int8(b[25]), int8(b[26]), int8(b[27]), roll1, roll2, roll3, roll4} + + result := boardState.Analyze(1, Game.Available) + if len(result) == 0 { + log.Printf("Legal moves: %+v", Game.Available) + log.Fatalf("NO PLAYABLE MOVES RETURNED: %+v", result) + } + + const padding = 3 + w := tabwriter.NewWriter(os.Stderr, 0, 0, padding, ' ', 0) + fmt.Fprintln(w, "Moves\tScore\tPlayer Score\tPips\tBlots\tHits\tOpponent Score\tPips\tBlots\tHits\t") + for _, r := range result { + fmt.Fprintf(w, "%s\t%.2f\t%.2f\t%d\t%d\t%d\t%.2f\t%.2f\t%.2f\t%.2f\t\n", fmt.Sprint(r.Moves), r.Score, r.PlayerScore, r.Pips, r.Blots, r.Hits, r.OppScore, r.OppPips, r.OppBlots, r.OppHits) + } + w.Flush() + log.Println("==========") + + for _, move := range result[0].Moves { + if move[0] == 0 || move[0] == 25 { + c.Out <- []byte(fmt.Sprintf("mv bar/%d", move[1])) + } else { + c.Out <- []byte(fmt.Sprintf("mv %d/%d", move[0], move[1])) + } + } + c.Out <- []byte("ok") + c.lastActivity = time.Now() + case *bgammon.EventRolled: + Game.Roll1 = ev.Roll1 + Game.Roll2 = ev.Roll2 + var diceFormatted string + if Game.Turn == 0 { + if ev.Player == Game.Player1.Name { + diceFormatted = fmt.Sprintf("%d", Game.Roll1) + } else { + diceFormatted = fmt.Sprintf("%d", Game.Roll2) + } + } else { + diceFormatted = fmt.Sprintf("%d-%d", Game.Roll1, Game.Roll2) + } + if ev.Player == Game.Player2.Name { + c.lastActivity = time.Now() + } + c.rolled = true + log.Printf("%s rolled %s.", ev.Player, diceFormatted) + if Game.Turn == 0 && Game.Roll1 == Game.Roll2 { + c.Out <- []byte("r") + } + case *bgammon.EventFailedRoll: + log.Printf("*** Failed to roll: %s", ev.Reason) + case *bgammon.EventMoved: + if ev.Player == Game.Player2.Name { + c.lastActivity = time.Now() + } + log.Printf("%s moved %s.", ev.Player, bgammon.FormatMoves(ev.Moves)) + case *bgammon.EventFailedMove: + var extra string + if ev.From != 0 || ev.To != 0 { + extra = fmt.Sprintf(" from %s to %s", bgammon.FormatSpace(ev.From), bgammon.FormatSpace(ev.To)) + } + log.Printf("*** Failed to move checker%s: %s", extra, ev.Reason) + log.Printf("*** Legal moves: %s", bgammon.FormatMoves(Game.Available)) + case *bgammon.EventFailedOk: + c.Out <- []byte("board") // Refresh game state. + log.Printf("*** Failed to submit moves: %s", ev.Reason) + case *bgammon.EventWin: + log.Printf("%s wins!", ev.Player) + c.Out <- []byte("rematch") + case *bgammon.EventPing: + c.Out <- []byte(fmt.Sprintf("pong %s", ev.Message)) + default: + log.Printf("*** Warning: Received unknown event: %+v", ev) + log.Println("*** You may need to upgrade your client.") + } + } +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..03ec7c6 --- /dev/null +++ b/go.mod @@ -0,0 +1,10 @@ +module code.rocket9labs.com/tslocum/bgammon-tabula-bot + +go 1.21.4 + +require ( + code.rocket9labs.com/tslocum/bgammon v0.0.0-20231130213126-817f86dcf920 + nhooyr.io/websocket v1.8.10 +) + +require code.rocket9labs.com/tslocum/tabula v0.0.0-20231130202354-01189fe9433e diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..c8ba334 --- /dev/null +++ b/go.sum @@ -0,0 +1,6 @@ +code.rocket9labs.com/tslocum/bgammon v0.0.0-20231130213126-817f86dcf920 h1:0WYRdT4yxJgbDPg+LASmNbGUuk9V/k/HfVNukGANFtc= +code.rocket9labs.com/tslocum/bgammon v0.0.0-20231130213126-817f86dcf920/go.mod h1:+dgD9v8BlzZjzpIB+/g0lgog90YUoPzEZsp1iAchl30= +code.rocket9labs.com/tslocum/tabula v0.0.0-20231130202354-01189fe9433e h1:+u8tivrgQ8+UhQn/pAW6VHMziwoimD/w0RrEXtThnIQ= +code.rocket9labs.com/tslocum/tabula v0.0.0-20231130202354-01189fe9433e/go.mod h1:DZdQq8KZDVw6rdeo7Zerk74rrX/KQHuKoQgiF+jVmYA= +nhooyr.io/websocket v1.8.10 h1:mv4p+MnGrLDcPlBoWsvPP7XCzTYMXP9F9eIGoKbgx7Q= +nhooyr.io/websocket v1.8.10/go.mod h1:rN9OFWIUwuxg4fR5tELlYC04bXYowCP9GX47ivo2l+c= diff --git a/main.go b/main.go new file mode 100644 index 0000000..b430259 --- /dev/null +++ b/main.go @@ -0,0 +1,26 @@ +package main + +import ( + "flag" + + "code.rocket9labs.com/tslocum/bgammon-tabula-bot/bot" +) + +func main() { + var ( + serverAddress string + username string + password string + points int + ) + flag.StringVar(&serverAddress, "address", "bgammon.org:1337", "Server address") + flag.StringVar(&username, "username", "", "Username") + flag.StringVar(&password, "password", "", "Password") + flag.IntVar(&points, "points", 1, "Match points") + flag.Parse() + + c := bot.NewClient(serverAddress, username, password, points) + + go c.Connect() + c.HandleEvents() +}