commit 275ae709aef8c5882dc7de6482b5db48984ae31a Author: diamondburned (Forefront) Date: Mon May 25 23:51:06 2020 -0700 Initial commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..53d1f3d --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + 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/go.mod b/go.mod new file mode 100644 index 0000000..fd01342 --- /dev/null +++ b/go.mod @@ -0,0 +1,12 @@ +module github.com/diamondburned/cchat-gtk + +go 1.14 + +require ( + github.com/Xuanwo/go-locale v0.2.0 + github.com/diamondburned/cchat v0.0.9 + github.com/diamondburned/cchat-mock v0.0.0-20200525222906-807afeffb7d4 + github.com/goodsign/monday v1.0.0 + github.com/gotk3/gotk3 v0.4.1-0.20200524052254-cb2aa31c6194 + github.com/pkg/errors v0.9.1 +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..99bb189 --- /dev/null +++ b/go.sum @@ -0,0 +1,38 @@ +github.com/Pallinder/go-randomdata v1.2.0 h1:DZ41wBchNRb/0GfsePLiSwb0PHZmT67XY00lCDlaYPg= +github.com/Pallinder/go-randomdata v1.2.0/go.mod h1:yHmJgulpD2Nfrm0cR9tI/+oAgRqCQQixsA8HyRZfV9Y= +github.com/Xuanwo/go-locale v0.2.0 h1:1N8SGG2VNpLl6VVa8ueZm3Nm+dxvk8ffY9aviKHl4IE= +github.com/Xuanwo/go-locale v0.2.0/go.mod h1:6qbT9M726OJgyiGZro2YwPmx63wQzlH+VvtjJWQoftw= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/diamondburned/cchat v0.0.8 h1:/PmI23SFHJcjYBWNBwQbp36n7fDvDu+NMnQuhM5FM2E= +github.com/diamondburned/cchat v0.0.8/go.mod h1:+zXktogE45A0om4fT6B/z6Ii7FXNafjxsNspI0rlhbU= +github.com/diamondburned/cchat v0.0.9 h1:+F96eDDuaOg4v4dz3GBDWbEW4dZ/k5uGrDp33/yeXR8= +github.com/diamondburned/cchat v0.0.9/go.mod h1:+zXktogE45A0om4fT6B/z6Ii7FXNafjxsNspI0rlhbU= +github.com/diamondburned/cchat-mock v0.0.0-20200525222906-807afeffb7d4 h1:k6vfDs6NR8yIi2V7YEpNp9Vujtl6mpDL5cWh7Pg09kk= +github.com/diamondburned/cchat-mock v0.0.0-20200525222906-807afeffb7d4/go.mod h1:mOf8RsTQUOf9qJ1Z/OKbsMKnCMtA2gRexH12fc9LxiQ= +github.com/go-ole/go-ole v1.2.4 h1:nNBDSCOigTSiarFpYE9J/KtEA1IOW4CNeqT9TQDqCxI= +github.com/go-ole/go-ole v1.2.4/go.mod h1:XCwSNxSkXRo4vlyPy93sltvi/qJq0jqQhjqQNIwKuxM= +github.com/goodsign/monday v1.0.0 h1:Yyk/s/WgudMbAJN6UWSU5xAs8jtNewfqtVblAlw0yoc= +github.com/goodsign/monday v1.0.0/go.mod h1:r4T4breXpoFwspQNM+u2sLxJb2zyTaxVGqUfTBjWOu8= +github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= +github.com/gotk3/gotk3 v0.4.0 h1:TIuhyQitGeRTxOQIV3AJlYtEWWJpC74JHwAIsxlH8MU= +github.com/gotk3/gotk3 v0.4.0/go.mod h1:Eew3QBwAOBTrfFFDmsDE5wZWbcagBL1NUslj1GhRveo= +github.com/gotk3/gotk3 v0.4.1-0.20200524052254-cb2aa31c6194 h1:bB6XWpxMt2isCWqzjXN8tfVazjxvD8nRJrNoKcL0xAc= +github.com/gotk3/gotk3 v0.4.1-0.20200524052254-cb2aa31c6194/go.mod h1:/hqFpkNa9T3JgNAE2fLvCdov7c5bw//FHNZrZ3Uv9/Q= +github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc= +github.com/smartystreets/goconvey v1.6.4/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs= +golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +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= diff --git a/internal/gts/gts.go b/internal/gts/gts.go new file mode 100644 index 0000000..14ac2a3 --- /dev/null +++ b/internal/gts/gts.go @@ -0,0 +1,101 @@ +package gts + +import ( + "os" + "sync" + + "github.com/diamondburned/cchat-gtk/internal/log" + "github.com/gotk3/gotk3/glib" + "github.com/gotk3/gotk3/gtk" +) + +var Args = append([]string{}, os.Args...) +var recvPool *sync.Pool + +var App struct { + *gtk.Application + Window *gtk.ApplicationWindow + Header *gtk.HeaderBar +} + +func init() { + gtk.Init(&Args) + + recvPool = &sync.Pool{ + New: func() interface{} { + return make(chan struct{}) + }, + } + + App.Application, _ = gtk.ApplicationNew("com.github.diamondburned.gtkcord3", 0) +} + +type Windower interface { + Window() gtk.IWidget +} + +type Headerer interface { + Header() gtk.IWidget +} + +// Above interfaces should be kept for modularity, but since this is an internal +// abstraction, we already know our application will implement both. +type WindowHeaderer interface { + Windower + Headerer +} + +func Main(wfn func() WindowHeaderer) { + App.Application.Connect("activate", func() { + App.Header, _ = gtk.HeaderBarNew() + App.Header.Show() + App.Header.SetShowCloseButton(true) + + App.Window, _ = gtk.ApplicationWindowNew(App.Application) + App.Window.Show() + App.Window.SetTitlebar(App.Header) + + // Execute the function later, because we need it to run after + // initialization. + w := wfn() + App.Window.Add(w.Window()) + App.Header.Add(w.Header()) + }) + + // Use a special function to run the application. Exit with the appropriate + // exit code. + os.Exit(App.Run(Args)) +} + +// Async runs fn asynchronously, then runs the function it returns in the Gtk +// main thread. +func Async(fn func() (func(), error)) { + go func() { + f, err := fn() + if err != nil { + log.Error(err) + return + } + + glib.IdleAdd(f) + }() +} + +// ExecAsync executes function asynchronously in the Gtk main thread. +func ExecAsync(fn func()) { + glib.IdleAdd(fn) +} + +// ExecSync executes the function asynchronously, but returns a channel that +// indicates when the job is done. +func ExecSync(fn func()) <-chan struct{} { + ch := recvPool.Get().(chan struct{}) + defer recvPool.Put(ch) + + glib.IdleAdd(func() { + fn() + close(ch) + }) + + return ch +} diff --git a/internal/humanize/humanize.go b/internal/humanize/humanize.go new file mode 100644 index 0000000..c658b07 --- /dev/null +++ b/internal/humanize/humanize.go @@ -0,0 +1,41 @@ +package humanize + +import ( + "time" + + "github.com/goodsign/monday" +) + +const ( + Day = 24 * time.Hour + Week = 7 * Day + Year = 365 * Day +) + +var truncators = []struct { + d time.Duration + s string +}{ + {d: Day, s: "15:04"}, + {d: Week, s: "Mon 15:04"}, + {d: Year, s: "15:04 02/01"}, + {d: -1, s: "15:04 02/01/2006"}, +} + +func TimeAgo(t time.Time) string { + ensureLocale() + + trunc := t + now := time.Now() + + for _, truncator := range truncators { + trunc = trunc.Truncate(truncator.d) + now = now.Truncate(truncator.d) + + if trunc.Equal(now) || truncator.d == -1 { + return monday.Format(t, truncator.s, Locale) + } + } + + return "" +} diff --git a/internal/humanize/locale.go b/internal/humanize/locale.go new file mode 100644 index 0000000..65bf746 --- /dev/null +++ b/internal/humanize/locale.go @@ -0,0 +1,42 @@ +package humanize + +import ( + "log" + "strings" + "sync" + "unicode" + + "github.com/Xuanwo/go-locale" + "github.com/goodsign/monday" +) + +var Locale monday.Locale = monday.LocaleEnUS // changed on init + +var localeOnce sync.Once + +func lettersOnly(str string) string { + return strings.Map(func(r rune) rune { + if unicode.IsLetter(r) { + return r + } + return -1 + }, str) +} + +func ensureLocale() { + localeOnce.Do(func() { + if tag, err := locale.Detect(); err == nil { + Locale = monday.Locale(lettersOnly(tag.String())) + } + + // Check if locale is supported + for _, locale := range monday.ListLocales() { + if lettersOnly(string(locale)) == string(Locale) { + return + } + } + + log.Println("Locale", Locale, "not found, defaulting to en_US") + Locale = monday.LocaleEnUS + }) +} diff --git a/internal/log/log.go b/internal/log/log.go new file mode 100644 index 0000000..d45a915 --- /dev/null +++ b/internal/log/log.go @@ -0,0 +1,57 @@ +package log + +import ( + "fmt" + "os" + "sync" + "time" +) + +var globalBuffer struct { + sync.Mutex + entries []Entry + handlers []func(Entry) +} + +func init() { + AddEntryHandler(func(entry Entry) { + fmt.Fprintln(os.Stderr, entry) + }) +} + +type Entry struct { + Time time.Time + Msg string +} + +func (entry Entry) String() string { + return entry.Time.Format(time.Stamp) + ": " + entry.Msg +} + +// AddEntryHandler adds a handler, which will run asynchronously. +func AddEntryHandler(fn func(Entry)) { + globalBuffer.handlers = append(globalBuffer.handlers, fn) +} + +func Error(err error) { + Write("Error: " + err.Error()) +} + +func Write(msg string) { + WriteEntry(Entry{ + Time: time.Now(), + Msg: msg, + }) +} + +func WriteEntry(entry Entry) { + go func() { + globalBuffer.Lock() + globalBuffer.entries = append(globalBuffer.entries, entry) + globalBuffer.Unlock() + + for _, fn := range globalBuffer.handlers { + fn(entry) + } + }() +} diff --git a/internal/ui/dialog/dialog.go b/internal/ui/dialog/dialog.go new file mode 100644 index 0000000..8d21ec9 --- /dev/null +++ b/internal/ui/dialog/dialog.go @@ -0,0 +1,64 @@ +package dialog + +import ( + "github.com/diamondburned/cchat-gtk/internal/gts" + "github.com/gotk3/gotk3/glib" + "github.com/gotk3/gotk3/gtk" +) + +func NewModal(body gtk.IWidget, title, label string, callback func()) *gtk.Dialog { + cancel, _ := gtk.ButtonNew() + cancel.Show() + cancel.SetHAlign(gtk.ALIGN_START) + cancel.SetRelief(gtk.RELIEF_NONE) + cancel.SetLabel("Cancel") + + action, _ := gtk.ButtonNew() + action.Show() + action.SetHAlign(gtk.ALIGN_END) + action.SetRelief(gtk.RELIEF_NONE) + action.SetLabel(label) + + header, _ := gtk.HeaderBarNew() + header.Show() + header.SetTitle(title) + header.PackStart(cancel) + header.PackEnd(action) + + dialog := newCSD(body, header) + + cancel.Connect("clicked", dialog.Destroy) + action.Connect("clicked", callback) + + return dialog +} + +func NewCSD(body, header gtk.IWidget) *gtk.Dialog { + dialog := newCSD(body, header) + dialog.Connect("response", func(_ *glib.Object, resp gtk.ResponseType) { + if resp == gtk.RESPONSE_DELETE_EVENT { + dialog.Destroy() + } + }) + return dialog +} + +func newCSD(body, header gtk.IWidget) *gtk.Dialog { + dialog, _ := gtk.DialogNew() + dialog.SetModal(true) + dialog.SetTransientFor(gts.App.Window) + + if area, _ := dialog.GetContentArea(); area != nil { + dialog.Remove(area) + } + + if oldh, _ := dialog.GetHeaderBar(); oldh != nil { + dialog.Remove(oldh) + } + + dialog.Add(body) + + dialog.SetTitlebar(header) + + return dialog +} diff --git a/internal/ui/header.go b/internal/ui/header.go new file mode 100644 index 0000000..5ec342d --- /dev/null +++ b/internal/ui/header.go @@ -0,0 +1,14 @@ +package ui + +import "github.com/gotk3/gotk3/gtk" + +type header struct { + *gtk.Box +} + +func newHeader() *header { + box, _ := gtk.BoxNew(gtk.ORIENTATION_VERTICAL, 0) + box.Show() + // TODO + return &header{box} +} diff --git a/internal/ui/message/container.go b/internal/ui/message/container.go new file mode 100644 index 0000000..e0f6306 --- /dev/null +++ b/internal/ui/message/container.go @@ -0,0 +1,64 @@ +package message + +import ( + "github.com/diamondburned/cchat" + "github.com/diamondburned/cchat-gtk/internal/gts" + "github.com/gotk3/gotk3/gtk" +) + +type Container struct { + *gtk.ScrolledWindow + main *gtk.Box + messages map[string]Message +} + +func NewContainer() *Container { + box, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 3) + box.Show() + + sw, _ := gtk.ScrolledWindowNew(nil, nil) + sw.Show() + + return &Container{sw, box, map[string]Message{}} +} + +func (c *Container) Reset() { + for _, msg := range c.messages { + c.main.Remove(msg) + } + + c.messages = nil +} + +func (c *Container) CreateMessage(msg cchat.MessageCreate) { + gts.ExecAsync(func() { + var msgc = NewMessage(msg) + c.messages[msgc.ID] = msgc + c.main.Add(msgc) + }) +} + +func (c *Container) UpdateMessage(msg cchat.MessageUpdate) { + gts.ExecAsync(func() { + mc, ok := c.messages[msg.ID()] + if !ok { + return + } + + if author := msg.Author(); !author.Empty() { + mc.UpdateAuthor(author) + } + if content := msg.Content(); !content.Empty() { + mc.UpdateContent(content) + } + }) +} + +func (c *Container) DeleteMessage(msg cchat.MessageDelete) { + gts.ExecAsync(func() { + if m, ok := c.messages[msg.ID()]; ok { + delete(c.messages, msg.ID()) + c.main.Remove(m) + } + }) +} diff --git a/internal/ui/message/input/input.go b/internal/ui/message/input/input.go new file mode 100644 index 0000000..2ae2bd2 --- /dev/null +++ b/internal/ui/message/input/input.go @@ -0,0 +1,83 @@ +package input + +import ( + "github.com/diamondburned/cchat" + "github.com/diamondburned/cchat-gtk/internal/log" + "github.com/gotk3/gotk3/gtk" + "github.com/pkg/errors" +) + +type Field struct { + *gtk.ScrolledWindow + text *gtk.TextView + buffer *gtk.TextBuffer + + sender cchat.ServerMessageSender +} + +func NewField() *Field { + text, _ := gtk.TextViewNew() + text.Show() + + buf, _ := text.GetBuffer() + + sw, _ := gtk.ScrolledWindowNew(nil, nil) + sw.Show() + sw.SetPolicy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC) + sw.SetProperty("max-content-height", 150) + sw.Add(text) + + return &Field{ + sw, + text, + buf, + nil, + } +} + +// SetSender changes the sender of the input field. If nil, the input will be +// disabled. +func (f *Field) SetSender(sender cchat.ServerMessageSender) { + f.sender = sender + f.text.SetSensitive(sender != nil) // grey if sender is nil + + // reset the input + f.buffer.Delete(f.buffer.GetBounds()) +} + +// SendMessage yanks the text from the input field and sends it to the backend. +// This function is not thread-safe. +func (f *Field) SendMessage() { + if f.sender == nil { + return + } + + var text = f.yankText() + if text == "" { + return + } + + var sender = f.sender + + go func() { + if err := sender.SendMessage(SendMessageData(text)); err != nil { + log.Error(errors.Wrap(err, "Failed to send message")) + } + }() +} + +type SendMessageData string + +func (s SendMessageData) Content() string { return string(s) } + +// yankText cuts the text from the input field and returns it. +func (f *Field) yankText() string { + start, end := f.buffer.GetBounds() + + text, _ := f.buffer.GetText(start, end, false) + if text != "" { + f.buffer.Delete(start, end) + } + + return text +} diff --git a/internal/ui/message/message.go b/internal/ui/message/message.go new file mode 100644 index 0000000..8ac2651 --- /dev/null +++ b/internal/ui/message/message.go @@ -0,0 +1,71 @@ +package message + +import ( + "time" + + "github.com/diamondburned/cchat" + "github.com/diamondburned/cchat-gtk/internal/humanize" + "github.com/diamondburned/cchat/text" + "github.com/gotk3/gotk3/gtk" + "github.com/gotk3/gotk3/pango" +) + +type Message struct { + ID string + Nonce string + + *gtk.Box + Timestamp *gtk.Label + Username *gtk.Label + Content *gtk.Label +} + +func NewMessage(msg cchat.MessageCreate) Message { + box, _ := gtk.BoxNew(gtk.ORIENTATION_VERTICAL, 3) + box.Show() + + ts, _ := gtk.LabelNew("") + ts.Show() + ts.SetWidthChars(12) + ts.SetLineWrapMode(pango.WRAP_WORD) + + user, _ := gtk.LabelNew("") + user.Show() + user.SetLineWrapMode(pango.WRAP_WORD_CHAR) + + content, _ := gtk.LabelNew("") + content.Show() + + box.PackStart(ts, false, false, 0) + box.PackStart(user, false, false, 0) + box.PackStart(content, true, true, 0) + + m := Message{ + ID: msg.ID(), + Box: box, + Timestamp: ts, + Username: user, + Content: content, + } + m.UpdateTimestamp(msg.Time()) + m.UpdateAuthor(msg.Author()) + m.UpdateContent(msg.Content()) + + if noncer, ok := msg.(cchat.MessageNonce); ok { + m.Nonce = noncer.Nonce() + } + + return m +} + +func (m *Message) UpdateTimestamp(t time.Time) { + m.Timestamp.SetLabel(humanize.TimeAgo(t)) +} + +func (m *Message) UpdateAuthor(author text.Rich) { + m.Username.SetLabel(author.Content) +} + +func (m *Message) UpdateContent(content text.Rich) { + m.Content.SetLabel(content.Content) +} diff --git a/internal/ui/message/view.go b/internal/ui/message/view.go new file mode 100644 index 0000000..d68ecfc --- /dev/null +++ b/internal/ui/message/view.go @@ -0,0 +1,52 @@ +package message + +import ( + "github.com/diamondburned/cchat" + "github.com/diamondburned/cchat-gtk/internal/log" + "github.com/diamondburned/cchat-gtk/internal/ui/message/input" + "github.com/gotk3/gotk3/gtk" + "github.com/pkg/errors" +) + +type View struct { + *gtk.Box + Container *Container + SendInput *input.Field + + current cchat.ServerMessage +} + +func NewView() *View { + container := NewContainer() + sendinput := input.NewField() + + box, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0) + box.Show() + box.PackStart(container, true, true, 0) + box.PackStart(sendinput, false, false, 0) + + return &View{ + Box: box, + Container: container, + SendInput: sendinput, + } +} + +func (v *View) JoinServer(server cchat.ServerMessage) { + if v.current != nil { + if err := v.current.LeaveServer(); err != nil { + log.Error(errors.Wrap(err, "Error leaving server")) + } + } + + v.current = server + + // Skipping ok check because sender can be nil. Without the empty check, Go + // will panic. + sender, _ := server.(cchat.ServerMessageSender) + v.SendInput.SetSender(sender) + + if err := v.current.JoinServer(v.Container); err != nil { + log.Error(errors.Wrap(err, "Failed to join server")) + } +} diff --git a/internal/ui/service/auth/auth.go b/internal/ui/service/auth/auth.go new file mode 100644 index 0000000..52ea33b --- /dev/null +++ b/internal/ui/service/auth/auth.go @@ -0,0 +1,175 @@ +package auth + +import ( + "html" + + "github.com/diamondburned/cchat" + "github.com/diamondburned/cchat-gtk/internal/gts" + "github.com/diamondburned/cchat-gtk/internal/ui/dialog" + "github.com/gotk3/gotk3/gtk" + "github.com/gotk3/gotk3/pango" +) + +type Dialog struct { + *gtk.Dialog + Auther cchat.Authenticator + onAuth func(cchat.Session) + + stack *gtk.Stack // dialog stack + scroll *gtk.ScrolledWindow + body *gtk.Box + label *gtk.Label + + // filled on spin() + request *Request +} + +// NewDialog makes a new authentication dialog. Auth() is called when the user +// is authenticated successfully inside the Gtk main thread. +func NewDialog(name string, auther cchat.Authenticator, auth func(cchat.Session)) *Dialog { + label, _ := gtk.LabelNew("") + label.Show() + + box, _ := gtk.BoxNew(gtk.ORIENTATION_VERTICAL, 0) + box.Show() + box.Add(label) + + sw, _ := gtk.ScrolledWindowNew(nil, nil) + sw.Show() + sw.Add(box) + + spinner, _ := gtk.SpinnerNew() + spinner.Show() + spinner.Start() + spinner.SetSizeRequest(50, 50) + + stack, _ := gtk.StackNew() + stack.Show() + stack.SetVExpand(true) + stack.SetHExpand(true) + stack.AddNamed(sw, "main") + stack.AddNamed(spinner, "spinner") + + d := &Dialog{ + Auther: auther, + onAuth: auth, + stack: stack, + scroll: sw, + body: box, + label: label, + } + d.Dialog = dialog.NewModal(stack, "Log in to "+name, "Log in", d.ok) + d.Dialog.SetDefaultSize(400, 300) + d.spin(nil) + d.Show() + + return d +} + +func (d *Dialog) runOnAuth(ses cchat.Session) { + // finalize + d.Destroy() + d.onAuth(ses) +} + +func (d *Dialog) spin(err error) { + // Remove old request. + if d.request != nil { + d.body.Remove(d.request) + } + + // Print the error. + if err != nil { + d.label.SetMarkup(`` + html.EscapeString(err.Error()) + ``) + } else { + d.label.SetText("") + } + + // Restore the old widget states. + d.stack.SetVisibleChildName("main") + d.Dialog.SetSensitive(true) + + d.request = NewRequest(d.Auther.AuthenticateForm()) + d.body.Add(d.request) +} + +func (d *Dialog) ok() { + // Disable the buttons. + d.Dialog.SetSensitive(false) + + // Switch to the spinner screen. + d.stack.SetVisibleChildName("spinner") + + // Get the values of all fields. + var values = d.request.values() + + gts.Async(func() (func(), error) { + s, err := d.Auther.Authenticate(values) + if err != nil { + return func() { d.spin(err) }, nil + } + + return func() { d.runOnAuth(s) }, nil + }) +} + +type Request struct { + *gtk.Grid + labels []*gtk.Label + entries []*gtk.Entry +} + +func NewRequest(authEntries []cchat.AuthenticateEntry) *Request { + grid, _ := gtk.GridNew() + grid.Show() + grid.SetRowHomogeneous(true) + grid.SetRowSpacing(2) + + req := &Request{ + Grid: grid, + labels: make([]*gtk.Label, len(authEntries)), + entries: make([]*gtk.Entry, len(authEntries)), + } + + for i, authEntry := range authEntries { + label, entry := newEntry(authEntry) + + req.labels[i] = label + req.entries[i] = entry + + grid.Attach(label, 0, i, 1, 1) + grid.Attach(entry, 1, i, 3, 1) // triple the width + } + + return req +} + +func (r *Request) values() []string { + var values = make([]string, len(r.entries)) + for i, entry := range r.entries { + values[i], _ = entry.GetText() + } + + return values +} + +func newEntry(authEntry cchat.AuthenticateEntry) (*gtk.Label, *gtk.Entry) { + label, _ := gtk.LabelNew(authEntry.Name) + label.Show() + label.SetXAlign(1) // right align + label.SetEllipsize(pango.ELLIPSIZE_END) + + input, _ := gtk.EntryNew() + input.Show() + + if authEntry.Secret { + input.SetInputPurpose(gtk.INPUT_PURPOSE_PASSWORD) + input.SetVisibility(false) + input.SetInvisibleChar('●') + } else { + // usually; this is just an assumption + input.SetInputPurpose(gtk.INPUT_PURPOSE_EMAIL) + } + + return label, input +} diff --git a/internal/ui/service/service.go b/internal/ui/service/service.go new file mode 100644 index 0000000..412e4a9 --- /dev/null +++ b/internal/ui/service/service.go @@ -0,0 +1,110 @@ +package service + +import ( + "github.com/diamondburned/cchat" + "github.com/diamondburned/cchat-gtk/internal/ui/service/auth" + "github.com/diamondburned/cchat-gtk/internal/ui/service/session" + "github.com/gotk3/gotk3/gtk" +) + +type View struct { + *gtk.ScrolledWindow + Box *gtk.Box + Services []*Container +} + +func NewView() *View { + box, _ := gtk.BoxNew(gtk.ORIENTATION_VERTICAL, 0) + box.Show() + + sw, _ := gtk.ScrolledWindowNew(nil, nil) + sw.Show() + sw.Add(box) + + return &View{ + sw, + box, + nil, + } +} + +func (v *View) AddService(svc cchat.Service) { + s := NewContainer(svc) + v.Services = append(v.Services, s) + v.Box.Add(s) +} + +type Container struct { + *gtk.Box + header *header + revealer *gtk.Revealer + children *children +} + +func NewContainer(svc cchat.Service) *Container { + header := newHeader(svc) + + children := newChildren() + chrev, _ := gtk.RevealerNew() + chrev.Show() + chrev.SetRevealChild(false) + chrev.Add(children) + + box, _ := gtk.BoxNew(gtk.ORIENTATION_VERTICAL, 0) + box.Show() + box.PackStart(header, false, false, 0) + box.PackStart(chrev, false, false, 0) + + var container = &Container{box, header, chrev, children} + + header.add.Connect("clicked", func() { + auth.NewDialog(svc.Name(), svc.Authenticate(), container.addSession) + }) + + return container +} + +func (c *Container) addSession(ses cchat.Session) { + srow := session.New(ses) + c.children.addSessionRow(srow) +} + +type header struct { + *gtk.Box + label *gtk.Label + add *gtk.Button +} + +func newHeader(svc cchat.Service) *header { + label, _ := gtk.LabelNew(svc.Name()) + label.Show() + label.SetXAlign(0) + + add, _ := gtk.ButtonNewFromIconName("list-add-symbolic", gtk.ICON_SIZE_BUTTON) + add.SetRelief(gtk.RELIEF_NONE) + add.Show() + + box, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0) + box.Show() + box.PackStart(label, true, true, 5) + box.PackStart(add, false, false, 0) + + return &header{box, label, add} +} + +type children struct { + *gtk.Box + Sessions []*session.Row +} + +func newChildren() *children { + box, _ := gtk.BoxNew(gtk.ORIENTATION_VERTICAL, 0) + box.Show() + + return &children{box, nil} +} + +func (c *children) addSessionRow(row *session.Row) { + c.Sessions = append(c.Sessions, row) + c.Box.Add(row) +} diff --git a/internal/ui/service/session/server/server.go b/internal/ui/service/session/server/server.go new file mode 100644 index 0000000..0e0db73 --- /dev/null +++ b/internal/ui/service/session/server/server.go @@ -0,0 +1,117 @@ +package server + +import ( + "github.com/diamondburned/cchat" + "github.com/diamondburned/cchat-gtk/internal/gts" + "github.com/diamondburned/cchat-gtk/internal/log" + "github.com/gotk3/gotk3/gtk" + "github.com/pkg/errors" +) + +type Row struct { + *gtk.Box + Button *gtk.Button + Server cchat.Server + + // enum 1 + clicked func(*Row) + message cchat.ServerMessage + + // enum 2 + children *Children +} + +func New(server cchat.Server) *Row { + name, err := server.Name() + if err != nil { + log.Error(errors.Wrap(err, "Failed to get the server name")) + name = "no name" + } + + box, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0) + box.Show() + + button, _ := gtk.ButtonNew() + button.Show() + button.SetRelief(gtk.RELIEF_NONE) + button.SetLabel(name) + + // TODO: images + + var row = &Row{ + Box: box, + Button: button, + Server: server, + } + button.Connect("clicked", row.onClick) + + switch server := server.(type) { + case cchat.ServerList: + row.children = NewChildren(server) + case cchat.ServerMessage: + row.message = server + } + + return row +} + +// SetOnClick sets the callback when the server is clicked. This only works if +// the passed in server implements ServerMessage. +func (row *Row) SetOnClick(clicked func(*Row)) { + if row.message != nil { + row.clicked = clicked + } +} + +func (row *Row) onClick() { + switch { + case row.message != nil: + row.clicked(row) + case row.children != nil: + row.children.SetRevealChild(!row.children.GetRevealChild()) + } +} + +type Children struct { + *gtk.Revealer + Main *gtk.Box + Rows []*Row + List cchat.ServerList +} + +func NewChildren(list cchat.ServerList) *Children { + rev, _ := gtk.RevealerNew() + rev.Show() + rev.SetRevealChild(false) + + main, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0) + main.Show() + + children := &Children{ + Revealer: rev, + Main: main, + List: list, + } + + if err := list.Servers(children); err != nil { + log.Error(errors.Wrap(err, "Failed to get servers")) + } + + return children +} + +func (c *Children) SetServers(servers []cchat.Server) { + gts.ExecAsync(func() { + for _, row := range c.Rows { + c.Main.Remove(row) + } + + c.Rows = make([]*Row, len(servers)) + + for i, server := range servers { + row := New(server) + c.Rows[i] = row + c.Main.Add(row) + } + }) +} diff --git a/internal/ui/service/session/session.go b/internal/ui/service/session/session.go new file mode 100644 index 0000000..6740110 --- /dev/null +++ b/internal/ui/service/session/session.go @@ -0,0 +1,44 @@ +package session + +import ( + "github.com/diamondburned/cchat" + "github.com/diamondburned/cchat-gtk/internal/log" + "github.com/diamondburned/cchat-gtk/internal/ui/service/session/server" + "github.com/gotk3/gotk3/gtk" + "github.com/pkg/errors" +) + +type Row struct { + *gtk.Box + Button *gtk.Button + Session cchat.Session + + Servers *server.Children +} + +func New(ses cchat.Session) *Row { + n, err := ses.Name() + if err != nil { + log.Error(errors.Wrap(err, "Failed to get the username")) + n = "no name" + } + + box, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0) + box.Show() + + button, _ := gtk.ButtonNew() + button.Show() + button.SetRelief(gtk.RELIEF_NONE) + button.SetLabel(n) + + rev, _ := gtk.RevealerNew() + rev.Show() + rev.SetRevealChild(false) + + return &Row{ + Box: box, + Button: button, + Session: ses, + Servers: server.NewChildren(ses), + } +} diff --git a/internal/ui/ui.go b/internal/ui/ui.go new file mode 100644 index 0000000..c94d8da --- /dev/null +++ b/internal/ui/ui.go @@ -0,0 +1,40 @@ +package ui + +import ( + "github.com/diamondburned/cchat" + "github.com/diamondburned/cchat-gtk/internal/gts" + "github.com/gotk3/gotk3/gtk" +) + +const LeftWidth = 220 + +type Application struct { + window *window + header *header +} + +var ( + _ gts.Windower = (*Application)(nil) + _ gts.Headerer = (*Application)(nil) +) + +func NewApplication() *Application { + app := &Application{ + window: newWindow(), + header: newHeader(), + } + + return app +} + +func (app *Application) AddService(svc cchat.Service) { + app.window.Services.AddService(svc) +} + +func (app *Application) Header() gtk.IWidget { + return app.header +} + +func (app *Application) Window() gtk.IWidget { + return app.window +} diff --git a/internal/ui/window.go b/internal/ui/window.go new file mode 100644 index 0000000..30a1397 --- /dev/null +++ b/internal/ui/window.go @@ -0,0 +1,26 @@ +package ui + +import ( + "github.com/diamondburned/cchat-gtk/internal/ui/message" + "github.com/diamondburned/cchat-gtk/internal/ui/service" + "github.com/gotk3/gotk3/gtk" +) + +type window struct { + *gtk.Box + Services *service.View + MessageView *message.View +} + +func newWindow() *window { + services := service.NewView() + services.SetSizeRequest(LeftWidth, -1) + mesgview := message.NewView() + + box, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0) + box.Show() + box.PackStart(services, false, false, 0) + box.PackStart(mesgview, true, true, 0) + + return &window{box, services, mesgview} +} diff --git a/main.go b/main.go new file mode 100644 index 0000000..029b764 --- /dev/null +++ b/main.go @@ -0,0 +1,32 @@ +package main + +import ( + "github.com/diamondburned/cchat-gtk/internal/gts" + "github.com/diamondburned/cchat-gtk/internal/log" + "github.com/diamondburned/cchat-gtk/internal/ui" + "github.com/diamondburned/cchat/services" + + _ "github.com/diamondburned/cchat-mock" + _ "github.com/diamondburned/cchat/services/plugins" +) + +func main() { + gts.Main(func() gts.WindowHeaderer { + var app = ui.NewApplication() + + // Load all cchat services. + srvcs, errs := services.Get() + if len(errs) > 0 { + for _, err := range errs { + log.Error(err) + } + } + + // Add the services. + for _, srvc := range srvcs { + app.AddService(srvc) + } + + return app + }) +} diff --git a/shell.nix b/shell.nix new file mode 100644 index 0000000..3a4352d --- /dev/null +++ b/shell.nix @@ -0,0 +1,14 @@ +{ pkgs ? import {} }: + +pkgs.stdenv.mkDerivation rec { + name = "cchat-gtk"; + version = "0.0.2"; + + buildInputs = with pkgs; [ + gnome3.glib gnome3.gtk # libhandy + ]; + + nativeBuildInputs = with pkgs; [ + pkgconfig go + ]; +}