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 index fbcd679..983fb34 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,16 @@ [FIBS](https://fibs.com) (online backgammon) client library -**Currently in pre-alpha state. Here be dragons.** +## Features + +- `Client` provides methods for connecting to FIBS and manages interactions +- `Board` provides methods for retrieving the current game state and playing the game +- Watch backgammon TV (spectate live matches continuously) + +## Applications + +- [Boxcars](https://code.rocketnine.space/tslocum/boxcars), a FIBS client with a graphical user interface +- [bgammon](https://code.rocketnine.space/tslocum/bgammon), a FIBS client with a terminal user interface ## Documentation diff --git a/board.go b/board.go index a82bfeb..654c928 100644 --- a/board.go +++ b/board.go @@ -10,8 +10,6 @@ import ( "sync" ) -// TODO Add PlayerName, etc - const ( BoxDrawingsLightVertical = '|' ) @@ -23,6 +21,11 @@ const ( StateBoardSpace0 ) +const ( + StatePlayerName = iota + StateOpponentName +) + const ( StateTurn = 29 + iota StatePlayerDice1 @@ -75,14 +78,11 @@ type Board struct { from map[int]int to map[int]int - playerDice [2]int - opponentDice [2]int - selected [2]int premove [][2]int - premovefrom map[int]int - premoveto map[int]int + Premovefrom map[int]int + Premoveto map[int]int dragFromX int dragFromY int @@ -115,6 +115,10 @@ func NewBoard(client *Client) *Board { } // TODO refactor +func (b *Board) GetStringState() []string { + return b.s +} + func (b *Board) GetIntState() []int { return b.v } @@ -126,7 +130,7 @@ func (b *Board) resetSelection() { func (b *Board) autoSendMoves() { movable := 2 - if b.playerDice[0] > 0 && b.playerDice[0] == b.playerDice[1] { + if b.v[StatePlayerDice1] > 0 && b.v[StatePlayerDice1] == b.v[StatePlayerDice2] { movable = 4 } if b.v[StateMovablePieces] > 0 { @@ -139,9 +143,9 @@ func (b *Board) autoSendMoves() { abs *= -1 direction = -1 } - if b.playerDice[0] == b.playerDice[1] { + if b.v[StatePlayerDice1] == b.v[StatePlayerDice2] { for expandDoubles := 4; expandDoubles >= 2; expandDoubles-- { - if abs != b.playerDice[0]*expandDoubles { + if abs != b.v[StatePlayerDice1]*expandDoubles { continue } @@ -149,7 +153,7 @@ func (b *Board) autoSendMoves() { b.premove = nil for i := 1; i <= expandDoubles; i++ { - b.premove = append(b.premove, [2]int{from + ((b.playerDice[0]*i - 1) * direction), from + ((b.playerDice[0] * i) * direction)}) + b.premove = append(b.premove, [2]int{from + ((b.v[StatePlayerDice1]*i - 1) * direction), from + ((b.v[StatePlayerDice1] * i) * direction)}) } break } @@ -201,10 +205,10 @@ func (b *Board) GetState() string { func (b *Board) SetState(state string) { b.Lock() - lastTurn := 0 + /*lastTurn := 0 if len(b.v) > 0 { lastTurn = b.v[StateTurn] - } + }*/ b.s = strings.Split(state, ":") @@ -217,20 +221,21 @@ func (b *Board) SetState(state string) { } } - if b.v[StateTurn] != lastTurn { + /*if b.v[StateTurn] != lastTurn { if lastTurn == b.v[StatePlayerColor] { b.playerDice = [2]int{0, 0} } else { b.opponentDice = [2]int{0, 0} } - } + }*/ // TODO disabled - if b.v[StatePlayerDice1] > 0 { + // TODO only overwrite dice when player names change + /*if b.v[StatePlayerDice1] > 0 { b.playerDice = [2]int{b.v[StatePlayerDice1], b.v[StatePlayerDice2]} } if b.v[StateOpponentDice1] > 0 { b.opponentDice = [2]int{b.v[StateOpponentDice1], b.v[StateOpponentDice2]} - } + }*/ b.Unlock() b.Draw() @@ -340,7 +345,7 @@ func (b *Board) renderSpace(index int, spaceValue int) []byte { // Highlight legal moves highlightSpace := b.validMove(b.selected[0], index) highlightSpace = false // TODO Make configurable, disable by default - //+(b.playerDice[0]*b.v[StatePlayerColor]) ||b.selected[0] == index+(b.playerDice[1]*b.v[StatePlayerColor])) && b.selected[1] > 0 + //+(b.v[StatePlayerDice1]*b.v[StatePlayerColor]) ||b.selected[0] == index+(b.v[StatePlayerDice2]*b.v[StatePlayerColor])) && b.selected[1] > 0 if b.selected[1] > 0 && highlightSpace && index != 25 && index != 0 { foregroundColor = "black" backgroundColor = "yellow" @@ -354,7 +359,7 @@ func (b *Board) renderSpace(index int, spaceValue int) []byte { rightArrowFrom := (b.v[StateDirection] == b.movesColor) == (index > 12) if b.selected[0] == index && b.selected[1] > 0 && spaceValue <= abs && spaceValue > abs-b.selected[1] { r = []byte("*") - } else if b.premovefrom[index] > 0 && spaceValue > (abs+b.premoveto[index])-b.premovefrom[index] && spaceValue <= abs+b.premoveto[index] { + } else if b.Premovefrom[index] > 0 && spaceValue > (abs+b.Premoveto[index])-b.Premovefrom[index] && spaceValue <= abs+b.Premoveto[index] { if index == 25-b.playerBarSpace() { r = []byte("▾") } else if index == b.playerBarSpace() { @@ -365,7 +370,7 @@ func (b *Board) renderSpace(index int, spaceValue int) []byte { r = []byte("◂") } foregroundColor = "yellow" - } else if b.premoveto[index] > 0 && spaceValue > abs && spaceValue <= abs+(b.premoveto[index]) { + } else if b.Premoveto[index] > 0 && spaceValue > abs && spaceValue <= abs+(b.Premoveto[index]) { r = []byte(playerColor) foregroundColor = "yellow" } else if b.from[index] > 0 && spaceValue > abs && spaceValue <= abs+b.from[index] { @@ -400,17 +405,22 @@ func (b *Board) ResetMoves() { func (b *Board) ResetPreMoves() { b.premove = nil - b.premovefrom = make(map[int]int) - b.premoveto = make(map[int]int) + b.Premovefrom = make(map[int]int) + b.Premoveto = make(map[int]int) } -func (b *Board) allPlayerPiecesInHomeBoard() bool { +func (b *Board) homeBoardSpaces() (int, int) { homeBoardStart := 1 homeBoardEnd := 6 - if b.v[StateDirection] == -1 { + if (b.v[StateDirection] == -1) == (b.v[StatePlayerColor] == -1) { homeBoardStart = 19 homeBoardEnd = 24 } + return homeBoardStart, homeBoardEnd +} + +func (b *Board) allPlayerPiecesInHomeBoard() bool { + homeBoardStart, homeBoardEnd := b.homeBoardSpaces() hasPlayerPiece := func(index int) bool { if index < 0 || index > 25 { return false @@ -450,21 +460,21 @@ func (b *Board) GetValidMoves(from int) []int { b.validMoves[from] = validMoves }() - if b.v[StateTurn] != b.v[StatePlayerColor] || b.playerDice[0] == 0 || b.playerDice[1] == 0 { + if b.v[StateTurn] != b.v[StatePlayerColor] || b.v[StatePlayerDice1] == 0 || b.v[StatePlayerDice2] == 0 { return validMoves } // TODO consider opponent blocking midway In full move trySpaces := [][]int{ - {b.playerDice[0]}, - {b.playerDice[1]}, - {b.playerDice[0], b.playerDice[1]}, - {b.playerDice[1], b.playerDice[0]}, + {b.v[StatePlayerDice1]}, + {b.v[StatePlayerDice2]}, + {b.v[StatePlayerDice1], b.v[StatePlayerDice2]}, + {b.v[StatePlayerDice2], b.v[StatePlayerDice1]}, } - if b.playerDice[0] == b.playerDice[1] { + if b.v[StatePlayerDice1] == b.v[StatePlayerDice2] { trySpaces = append(trySpaces, - []int{b.playerDice[0], b.playerDice[0], b.playerDice[0]}, - []int{b.playerDice[0], b.playerDice[0], b.playerDice[0], b.playerDice[0]}) + []int{b.v[StatePlayerDice1], b.v[StatePlayerDice1], b.v[StatePlayerDice1]}, + []int{b.v[StatePlayerDice1], b.v[StatePlayerDice1], b.v[StatePlayerDice1], b.v[StatePlayerDice1]}) } if b.allPlayerPiecesInHomeBoard() { @@ -473,7 +483,7 @@ func (b *Board) GetValidMoves(from int) []int { if spacesHome < 0 { spacesHome *= -1 } - if spacesHome <= b.playerDice[0] || spacesHome <= b.playerDice[1] { + if spacesHome <= b.v[StatePlayerDice1] || spacesHome <= b.v[StatePlayerDice2] { trySpaces = append(trySpaces, []int{spacesHome}) } } @@ -511,7 +521,7 @@ func (b *Board) playerHomeSpace() int { } func (b *Board) validMove(f int, t int) bool { - if b.v[StateTurn] != b.v[StatePlayerColor] || b.playerDice[0] == 0 || b.playerDice[1] == 0 { + if b.v[StateTurn] != b.v[StatePlayerColor] || b.v[StatePlayerDice1] == 0 || b.v[StatePlayerDice2] == 0 { return false } @@ -588,13 +598,19 @@ func (b *Board) SimplifyMoves() { } } -func (b *Board) addPreMove(from int, to int) bool { +func (b *Board) AddPreMove(from int, to int) bool { + // Allow bearing off when the player moves their own pieces on to the bar + if to == 0 || to == 25 { + to = b.playerHomeSpace() + } if !b.validMove(from, to) { return false } b.premove = append(b.premove, [2]int{from, to}) - b.premovefrom[from]++ - b.premoveto[to]++ + b.Premovefrom[from]++ + b.Premoveto[to]++ + + b.autoSendMoves() return true } @@ -720,14 +736,14 @@ func (b *Board) Render() []byte { } t.Write([]byte("[-::-]")) } else if i == 2 { - if b.opponentDice[0] > 0 { - t.Write([]byte(fmt.Sprintf(" [%s::%s]%d %d[-::-] ", opponentRollColor, opponentBold, b.opponentDice[0], b.opponentDice[1]))) + if b.v[StateOpponentDice1] > 0 { + t.Write([]byte(fmt.Sprintf(" [%s::%s]%d %d[-::-] ", opponentRollColor, opponentBold, b.v[StateOpponentDice1], b.v[StateOpponentDice2]))) } else { t.Write([]byte(fmt.Sprintf(" [%s]- -[-] ", opponentRollColor))) } } else if i == 8 { - if b.playerDice[0] > 0 { - t.Write([]byte(fmt.Sprintf(" [%s::%s]%d %d[-::-] ", playerRollColor, playerBold, b.playerDice[0], b.playerDice[1]))) + if b.v[StatePlayerDice1] > 0 { + t.Write([]byte(fmt.Sprintf(" [%s::%s]%d %d[-::-] ", playerRollColor, playerBold, b.v[StatePlayerDice1], b.v[StatePlayerDice2]))) } else { t.Write([]byte(fmt.Sprintf(" [%s]- -[-] ", playerRollColor))) } diff --git a/board_test.go b/board_test.go index d48a630..16446e8 100644 --- a/board_test.go +++ b/board_test.go @@ -38,7 +38,7 @@ func TestBoard_GetValidMoves(t *testing.T) { for _, c := range testCases { c := c t.Run(fmt.Sprintf("With-%d-%d-From-%s", c.roll[0], c.roll[1], fmt.Sprintf("%02d", c.from)), func(t *testing.T) { - b.playerDice = c.roll + b.v[StatePlayerDice1], b.v[StatePlayerDice2] = c.roll[0], c.roll[1] b.Draw() validMoves := b.GetValidMoves(c.from) diff --git a/client.go b/client.go index 1b7c47b..46acf28 100644 --- a/client.go +++ b/client.go @@ -2,7 +2,9 @@ package fibs import ( "bytes" + "context" "fmt" + "io" "log" "math/rand" "regexp" @@ -14,6 +16,7 @@ import ( "github.com/reiver/go-telnet" "golang.org/x/text/language" "golang.org/x/text/message" + "nhooyr.io/websocket" ) const debug = 1 // TODO @@ -35,6 +38,8 @@ const ( whoInfoDataEmail ) +var DefaultProxyAddress = "" + var ( TypeWelcome = []byte("1") TypeOwnInfo = []byte("2") @@ -101,9 +106,15 @@ type Client struct { notified map[string]bool - serverAddress string + serverAddress string + wsProxyAddress string // WebSocket->TCP proxy address + + tcpConn io.Writer + wsConn *websocket.Conn Board *Board + + tvMode bool } func NewClient(serverAddress string, username string, password string) *Client { @@ -112,7 +123,8 @@ func NewClient(serverAddress string, username string, password string) *Client { Out: make(chan []byte, 100), Event: make(chan interface{}, 100), - serverAddress: serverAddress, + serverAddress: serverAddress, + wsProxyAddress: DefaultProxyAddress, Username: username, Password: password, @@ -129,87 +141,7 @@ func NewClient(serverAddress string, username string, password string) *Client { return c } -// CallTELNET is called when a connection is made with the server. -func (c *Client) CallTELNET(ctx telnet.Context, w telnet.Writer, r telnet.Reader) { - go func() { - var b = &bytes.Buffer{} - var buffer [1]byte // Seems like the length of the buffer needs to be small, otherwise will have to wait for buffer to fill up. - p := buffer[:] - - var motd bool // Parse all messages as MOTD text until MsgEndMOTD - - for { - // Read 1 byte. - n, err := r.Read(p) - if n <= 0 && nil == err { - continue - } else if n <= 0 && nil != err { - if err.Error() != "EOF" { - lf("** Disconnected: %s", err) - } else { - l("** Disconnected") - } - return - } - - b.WriteByte(p[0]) - - if p[0] == '\n' { - buf := make([]byte, b.Len()) - copy(buf, b.Bytes()) - - if debug > 0 { - l("<- " + string(bytes.TrimSpace(buf))) - } - - if c.loggedin { - if !motd { - buf = bytes.TrimSpace(buf) - if len(buf) == 0 { - b.Reset() - continue - } - } - - if c.rawMode { - c.In <- append([]byte("** "), buf...) - b.Reset() - continue - } - - if bytes.HasPrefix(b.Bytes(), TypeMOTD) && !motd { - motd = true - c.motd = append(c.motd, buf[1:]...) - b.Reset() - continue - } else if bytes.HasPrefix(b.Bytes(), TypeEndMOTD) && motd { - motd = false - c.motd = bytes.TrimSpace(c.motd) - c.In <- append([]byte("3 "), c.motd...) - b.Reset() - continue - } else if motd { - c.motd = append(c.motd, buf...) - b.Reset() - continue - } - - c.In <- buf - } - b.Reset() - } - - if !c.loggedin { - bt := strings.TrimSpace(b.String()) - if bt == "login:" { - b.Reset() - c.Out <- []byte(fmt.Sprintf("login bgammon 1008 %s %s", c.Username, c.Password)) - c.loggedin = true - } - } - } - }() - +func (c *Client) handleWrite() { var buffer bytes.Buffer var p []byte @@ -221,6 +153,8 @@ func (c *Client) CallTELNET(ctx telnet.Context, w telnet.Writer, r telnet.Reader quit := []byte("quit") bye := []byte("bye") watch := []byte("watch") + tv := []byte("tv") + reset := []byte("reset") about := []byte("about") show := []byte("show") average := []byte("average") @@ -231,6 +165,20 @@ func (c *Client) CallTELNET(ctx telnet.Context, w telnet.Writer, r telnet.Reader if bytes.Equal(bytes.ToLower(b), watch) { c.WatchRandomGame() continue + } else if bytes.Equal(bytes.ToLower(b), tv) { + c.tvMode = !c.tvMode + if c.tvMode { + l("Now watching backgammon TV") + c.WatchRandomGame() + } else { + l("Stopped watching backgammon TV") + } + continue + } else if bytes.Equal(bytes.ToLower(b), reset) { + c.Board.ResetPreMoves() + c.Event <- &EventDraw{} + l("Reset pre-moves") + continue } else if bytes.Equal(bytes.ToLower(b), who) { for username := range c.who { lf("%s", c.who[username]) @@ -244,10 +192,15 @@ func (c *Client) CallTELNET(ctx telnet.Context, w telnet.Writer, r telnet.Reader c.rawMode = false }() } else if bytes.Equal(bytes.ToLower(b), boardstate) { + homeBoardStart, homeBoardEnd := c.Board.homeBoardSpaces() + lf("Board state: %s", c.Board.GetState()) lf("Player color: %d", c.Board.v[StatePlayerColor]) lf("Direction: %d", c.Board.v[StateDirection]) lf("Current turn: %d", c.Board.v[StateTurn]) + lf("Player home spaces: %d-%d", + homeBoardStart, homeBoardEnd) + lf("Player can bear off: %t", c.Board.allPlayerPiecesInHomeBoard()) lf("Moves: %+v", c.Board.moves) lf("Pre-moves: %+v", c.Board.premove) continue @@ -265,7 +218,16 @@ func (c *Client) CallTELNET(ctx telnet.Context, w telnet.Writer, r telnet.Reader p = buffer.Bytes() - n, err := oi.LongWrite(w, p) + if c.wsProxyAddress != "" { + err := c.wsConn.Write(context.Background(), websocket.MessageBinary, p) + if err != nil { + log.Fatalf("Transmission problem: %s", err) + } + buffer.Reset() + continue + } + + n, err := oi.LongWrite(c.tcpConn, p) if nil != err { break } @@ -277,6 +239,94 @@ func (c *Client) CallTELNET(ctx telnet.Context, w telnet.Writer, r telnet.Reader } } +func (c *Client) handleRead(r io.Reader) { + var b = &bytes.Buffer{} + var buffer [1]byte // Seems like the length of the buffer needs to be small, otherwise will have to wait for buffer to fill up. + p := buffer[:] + + var motd bool // Parse all messages as MOTD text until MsgEndMOTD + + for { + // Read 1 byte. + n, err := r.Read(p) + if n <= 0 && nil == err { + continue + } else if n <= 0 && nil != err { + if err.Error() != "EOF" { + lf("** Disconnected: %s", err) + } else { + l("** Disconnected") + } + return + } + + b.WriteByte(p[0]) + + if p[0] == '\n' { + buf := make([]byte, b.Len()) + copy(buf, b.Bytes()) + + if debug > 0 { + l("<- " + string(bytes.TrimSpace(buf))) + } + + if c.loggedin { + if !motd { + buf = bytes.TrimSpace(buf) + if len(buf) == 0 { + b.Reset() + continue + } + } + + if c.rawMode { + c.In <- append([]byte("** "), buf...) + b.Reset() + continue + } + + if bytes.HasPrefix(b.Bytes(), TypeMOTD) && !motd { + motd = true + c.motd = append(c.motd, buf[1:]...) + b.Reset() + continue + } else if bytes.HasPrefix(b.Bytes(), TypeEndMOTD) && motd { + motd = false + c.motd = bytes.TrimSpace(c.motd) + c.In <- append([]byte("3 "), c.motd...) + b.Reset() + continue + } else if motd { + c.motd = append(c.motd, buf...) + b.Reset() + continue + } + + c.In <- buf + } + b.Reset() + } + + if !c.loggedin { + bt := strings.TrimSpace(b.String()) + if bt == "login:" { + b.Reset() + c.Out <- []byte(fmt.Sprintf("login bgammon 1008 %s %s", c.Username, c.Password)) + c.loggedin = true + } + } + } +} + +// CallTELNET is called when a connection is made with the server. +func (c *Client) CallTELNET(ctx telnet.Context, w telnet.Writer, r telnet.Reader) { + c.tcpConn = w + + go c.handleRead(r) + + c.handleWrite() +} + func (c *Client) keepAlive() { t := time.NewTicker(5 * time.Minute) for range t.C { @@ -394,11 +444,63 @@ func (c *Client) WatchRandomGame() { c.Out <- []byte("watch " + option) } +func (c *Client) callWebSocket() { + ctx := context.Background() + + var err error + c.wsConn, _, err = websocket.Dial(ctx, c.wsProxyAddress, nil) + if err != nil { + log.Fatal("dial error", err) + } + defer c.wsConn.Close(websocket.StatusInternalError, "the sky is falling") + + //c.wsConn.Close(websocket.StatusNormalClosure, "") + + r, w := io.Pipe() + + go c.handleRead(r) + + go func() { + for { + _, data, err := c.wsConn.Read(context.Background()) + if err != nil { + if err.Error() != "EOF" { + lf("** Disconnected: %s", err) + } else { + l("** Disconnected") + } + } + w.Write(data) + } + }() + + c.handleWrite() + /* TODO + err := conn.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, "")) + if err != nil { + log.Println("write close:", err) + return nil + } + select { + case <-done: + case <-time.After(time.Second): + }*/ +} + func (c *Client) Connect() error { - l(fmt.Sprintf("Connecting to %s...", c.serverAddress)) + connectionType := "Telnet" + if c.wsProxyAddress != "" { + connectionType = fmt.Sprintf("WebSocket proxy (%s)", c.wsProxyAddress) + } + l(fmt.Sprintf("Connecting via %s to %s...", connectionType, c.serverAddress)) go c.keepAlive() + if c.wsProxyAddress != "" { + go c.callWebSocket() + return nil + } + err := telnet.DialToAndCall(c.serverAddress, c) if err != nil { lf("** Disconnected: %s", err) @@ -415,6 +517,7 @@ func (c *Client) eventLoop() { var dropsConnection = regexp.MustCompile(`^\w+ drops connection\.`) var startMatchRegexp = regexp.MustCompile(`^\w+ and \w+ start a .*`) var winsMatchRegexp = regexp.MustCompile(`^\w+ wins a [0-9]+ point match against .*`) + var winsThisMatchRegexp = regexp.MustCompile(`^\w+ wins the [0-9]+ point match .*`) var newGameRegexp = regexp.MustCompile(`^Starting a new game with .*`) var gameBufferRegexp = regexp.MustCompile(`^\w+ (makes|roll|rolls|rolled|move|moves) .*`) @@ -504,6 +607,7 @@ func (c *Client) eventLoop() { continue } else if bytes.HasPrefix(b, TypeBoardState) { c.Board.SetState(string(bytes.SplitN(b, []byte(" "), 2)[0][6:])) + c.Event <- &EventBoardState{S: c.Board.s, V: c.Board.v} continue } else if turnRegexp.Match(b) { turn := turnRegexp.FindSubmatch(b) @@ -531,12 +635,16 @@ func (c *Client) eventLoop() { if string(roll[1]) == c.Board.s[0] || string(roll[1]) == "You" { c.Board.v[StateTurn] = c.Board.v[StatePlayerColor] - c.Board.playerDice = dice + c.Board.v[StatePlayerDice1] = dice[0] + c.Board.v[StatePlayerDice2] = dice[1] } else { c.Board.v[StateTurn] = c.Board.v[StatePlayerColor] * -1 - c.Board.opponentDice = dice + c.Board.v[StateOpponentDice1] = dice[0] + c.Board.v[StateOpponentDice2] = dice[1] } + c.Event <- &EventBoardState{S: c.Board.s, V: c.Board.v} + c.Board.ResetMoves() c.Board.Draw() @@ -593,12 +701,12 @@ func (c *Client) eventLoop() { u := string(match[1]) if u == c.Username || u == c.Board.s[0] || u == "You" { - c.Board.opponentDice[0] = 0 - c.Board.opponentDice[1] = 0 + //c.Board.opponentDice[0] = 0 + //c.Board.opponentDice[1] = 0 c.Board.v[StateTurn] = c.Board.v[StatePlayerColor] * -1 } else if u == c.Board.s[1] { - c.Board.playerDice[0] = 0 - c.Board.playerDice[1] = 0 + //c.Board.playerDice[0] = 0 + //c.Board.playerDice[1] = 0 c.Board.v[StateTurn] = c.Board.v[StatePlayerColor] } } else if pleaseMoveRegexp.Match(b) { @@ -610,7 +718,6 @@ func (c *Client) eventLoop() { } } else if bytes.HasPrefix(bl, []byte("you're now watching")) { // Board state is not sent automatically when watching - log.Println("WRITE BOARDD") c.Out <- []byte("board") } else if logInOutRegexp.Match(b) { continue @@ -618,6 +725,17 @@ func (c *Client) eventLoop() { continue } else if startMatchRegexp.Match(b) { continue + } else if winsThisMatchRegexp.Match(b) { + if c.tvMode { + go func() { + time.Sleep(5 * time.Second) + if !c.tvMode { + return + } + c.WatchRandomGame() + }() + } + continue } else if winsMatchRegexp.Match(b) { continue } else if newGameRegexp.Match(b) { diff --git a/doc.go b/doc.go index 1628a73..23ab1bd 100644 --- a/doc.go +++ b/doc.go @@ -1,4 +1,10 @@ /* Package fibs provides a FIBS.com (online backgammon) client library. + +In addition to the standard FIBS commands, the following internal custom +commands are available: + +- `watch` - Watch a random game +- `tv` - Watch random games continuously */ package fibs diff --git a/event.go b/event.go index a34224e..61eddc4 100644 --- a/event.go +++ b/event.go @@ -1,6 +1,8 @@ package fibs -type EventGame struct { +type EventBoardState struct { + S []string + V []int } type EventMove struct { @@ -12,3 +14,5 @@ type EventMove struct { type EventMessage struct { Message string } + +type EventDraw struct{} diff --git a/go.mod b/go.mod index 05612ae..5972f7d 100644 --- a/go.mod +++ b/go.mod @@ -6,4 +6,7 @@ require ( github.com/reiver/go-oi v1.0.0 github.com/reiver/go-telnet v0.0.0-20180421082511-9ff0b2ab096e golang.org/x/text v0.3.7 + nhooyr.io/websocket v1.8.7 ) + +require github.com/klauspost/compress v1.13.5 // indirect diff --git a/go.sum b/go.sum index 7f41126..bb9e388 100644 --- a/go.sum +++ b/go.sum @@ -1,7 +1,67 @@ +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE= +github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI= +github.com/gin-gonic/gin v1.6.3 h1:ahKqKTFpO5KTPHxWZjEdPScmYaGtLo8Y4DMHoEsnp14= +github.com/gin-gonic/gin v1.6.3/go.mod h1:75u5sXoLsGZoRN5Sgbi1eraJ4GU3++wFwWzhwvtwp4M= +github.com/go-playground/assert/v2 v2.0.1/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= +github.com/go-playground/locales v0.13.0 h1:HyWk6mgj5qFqCT5fjGBuRArbVDfE4hi8+e8ceBS/t7Q= +github.com/go-playground/locales v0.13.0/go.mod h1:taPMhCMXrRLJO55olJkUXHZBHCxTMfnGwq/HNwmWNS8= +github.com/go-playground/universal-translator v0.17.0 h1:icxd5fm+REJzpZx7ZfpaD876Lmtgy7VtROAbHHXk8no= +github.com/go-playground/universal-translator v0.17.0/go.mod h1:UkSxE5sNxxRwHyU+Scu5vgOQjsIJAF8j9muTVoKLVtA= +github.com/go-playground/validator/v10 v10.2.0 h1:KgJ0snyC2R9VXYN2rneOtQcw5aHQB1Vv0sFl1UcHBOY= +github.com/go-playground/validator/v10 v10.2.0/go.mod h1:uOYAAleCW8F/7oMFd6aG0GOhaH6EGOAJShg8Id5JGkI= +github.com/gobwas/httphead v0.0.0-20180130184737-2c6c146eadee h1:s+21KNqlpePfkah2I+gwHF8xmJWRjooY+5248k6m4A0= +github.com/gobwas/httphead v0.0.0-20180130184737-2c6c146eadee/go.mod h1:L0fX3K22YWvt/FAX9NnzrNzcI4wNYi9Yku4O0LKYflo= +github.com/gobwas/pool v0.2.0 h1:QEmUOlnSjWtnpRGHF3SauEiOsy82Cup83Vf2LcMlnc8= +github.com/gobwas/pool v0.2.0/go.mod h1:q8bcK0KcYlCgd9e7WYLm9LpyS+YeLd8JVDW6WezmKEw= +github.com/gobwas/ws v1.0.2 h1:CoAavW/wd/kulfZmSIBt6p24n4j7tHgNVCjsfHVNUbo= +github.com/gobwas/ws v1.0.2/go.mod h1:szmBTxLgaFppYjEmNtny/v3w89xOydFnnZMcgRRu/EM= +github.com/golang/protobuf v1.3.3/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw= +github.com/golang/protobuf v1.3.5 h1:F768QJ1E9tib+q5Sc8MkdJi1RxLTbRcTf8LJV56aRls= +github.com/golang/protobuf v1.3.5/go.mod h1:6O5/vntMXwX2lRkT1hjjk0nAC1IDOTvTlVgjlRvqsdk= +github.com/google/go-cmp v0.4.0 h1:xsAVV57WRhGj6kEIi8ReJzQlHHqcBYCElAvkovg3B/4= +github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/gorilla/websocket v1.4.1 h1:q7AeDBpnBk8AogcD4DSag/Ukw/KV+YhzLj2bP5HvKCM= +github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= +github.com/json-iterator/go v1.1.9 h1:9yzud/Ht36ygwatGx56VwCZtlI/2AD15T1X2sjSuGns= +github.com/json-iterator/go v1.1.9/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= +github.com/klauspost/compress v1.10.3/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYsUV+/s2qKfXs= +github.com/klauspost/compress v1.13.5 h1:9O69jUPDcsT9fEm74W92rZL9FQY7rCdaXVneq+yyzl4= +github.com/klauspost/compress v1.13.5/go.mod h1:/3/Vjq9QcHkK5uEr5lBEmyoZ1iFhe47etQ6QUkpK6sk= +github.com/leodido/go-urn v1.2.0 h1:hpXL4XnriNwQ/ABnpepYM/1vCLWNDfUNts8dX3xTG6Y= +github.com/leodido/go-urn v1.2.0/go.mod h1:+8+nEpDfqqsY+g338gtMEUOtuK+4dEMhiQEgxpxOKII= +github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY= +github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 h1:ZqeYNhU3OHLH3mGKHDcjJRFFRrJa6eAM5H+CtDdOsPc= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 h1:Esafd1046DLDQ0W1YjYsBW+p8U2u7vzgW2SQVmlNazg= +github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/reiver/go-oi v1.0.0 h1:nvECWD7LF+vOs8leNGV/ww+F2iZKf3EYjYZ527turzM= github.com/reiver/go-oi v1.0.0/go.mod h1:RrDBct90BAhoDTxB1fenZwfykqeGvhI6LsNfStJoEkI= github.com/reiver/go-telnet v0.0.0-20180421082511-9ff0b2ab096e h1:quuzZLi72kkJjl+f5AQ93FMcadG19WkS7MO6TXFOSas= github.com/reiver/go-telnet v0.0.0-20180421082511-9ff0b2ab096e/go.mod h1:+5vNVvEWwEIx86DB9Ke/+a5wBI464eDRo3eF0LcfpWg= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/ugorji/go v1.1.7 h1:/68gy2h+1mWMrwZFeD1kQialdSzAb432dtpeJ42ovdo= +github.com/ugorji/go v1.1.7/go.mod h1:kZn38zHttfInRq0xu/PH0az30d+z6vm202qpg1oXVMw= +github.com/ugorji/go/codec v1.1.7 h1:2SvQaVZ1ouYrrKKwoSk2pzd4A9evlKJb9oTL+OaLUSs= +github.com/ugorji/go/codec v1.1.7/go.mod h1:Ax+UKWsSmolVDwsd+7N3ZtXu+yMGCf907BLYF3GoBXY= +golang.org/x/sys v0.0.0-20200116001909-b77594299b42 h1:vEOn+mP2zCOVzKckCZy6YsCtDblrpj/w7B9nxGNELpg= +golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10= +gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +nhooyr.io/websocket v1.8.7 h1:usjR2uOr/zjjkVMy0lW+PPohFok7PCow5sDjLgX4P4g= +nhooyr.io/websocket v1.8.7/go.mod h1:B70DZP8IakI65RVQ51MsWP/8jndNma26DVA/nFSCgW0=