A => LICENSE +674 -0
@@ 1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ 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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ 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 <https://www.gnu.org/licenses/>.
+
+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:
+
+ <program> Copyright (C) <year> <name of author>
+ 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
+<https://www.gnu.org/licenses/>.
+
+ 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
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
A => README.md +13 -0
@@ 1,13 @@
+# sup
+
+sup is a [Matrix](https://matrix.org) client for your terminal.
+
+This initial version doesn't store anything between sessions and so will take horribly long to start if you're in rooms with thousands of members.
+
+See the [manpage](./doc/sup.1.scd) for a tutorial.
+
+# From Source
+
+You need *go* (>=1.19) and then run `go build`.
+
+If you want to compile the manpage, you need *scdoc* and then run `scdoc < doc/sup.1.scd > sup.1`.
A => commands.go +648 -0
@@ 1,648 @@
+package main
+
+import (
+ "fmt"
+ "github.com/pzl/tui/ansi"
+ "maunium.net/go/mautrix"
+ "maunium.net/go/mautrix/event"
+ "maunium.net/go/mautrix/id"
+ "os"
+ "os/exec"
+ "strconv"
+ "strings"
+)
+
+func (app *App) pickRoom(room string, roomIDs []id.RoomID) id.RoomID {
+ if room == "" {
+ return app.RoomID
+ }
+ n, err := strconv.Atoi(room)
+ if err == nil && n > 0 && n <= len(roomIDs) {
+ return roomIDs[n-1]
+ }
+ for _, rid := range roomIDs {
+ if string(rid) == room {
+ return rid
+ }
+ }
+ for _, rid := range roomIDs {
+ if string(roomAlias(app.Client, rid)) == room {
+ return rid
+ }
+ for _, a := range roomAltAliases(app.Client, rid) {
+ if string(a) == room {
+ return rid
+ }
+ }
+ }
+ for _, rid := range roomIDs {
+ if strings.HasPrefix(app.roomTitle(rid), room) {
+ return rid
+ }
+ }
+ return ""
+}
+
+func (app *App) pickUpload(upload string) *Media {
+ uid, err := strconv.Atoi(upload)
+ if err != nil {
+ return nil
+ }
+ for _, u := range app.Uploads[app.RoomID] {
+ if u.ID == uid {
+ return u
+ }
+ }
+ return nil
+}
+
+func pickUser(user string, from []id.UserID) id.UserID {
+ for _, uid := range from {
+ if uid == id.UserID(user) {
+ return uid
+ }
+ }
+ return ""
+}
+
+func (app *App) Ban(user string) {
+ uid := id.UserID(user)
+ _, _, err := uid.ParseAndValidate()
+ if err == nil {
+ app.UI.Accept()
+ req := &mautrix.ReqBanUser{UserID: uid}
+ _, err := app.Client.BanUser(app.RoomID, req)
+ if err != nil {
+ app.UI.Notify(ansi.Red, "Failed to ban user: " + err.Error())
+ }
+ } else {
+ app.UI.Reject()
+ }
+}
+
+func (app *App) browse(rid id.RoomID) {
+ app.UI.Accept()
+ app.Screen = rid
+ app.RoomID = rid
+ app.Unseen[rid] = false
+ app.UI.StatusBar.Title = app.roomTitle(rid)
+ app.UI.StatusBar.Members = len(roomMembers(app.Client, rid))
+ app.UI.Feed.Entries = nil
+ for _, msg := range app.Messages[rid] {
+ app.UI.Feed.Entries = append(app.UI.Feed.Entries, msg)
+ }
+ app.UI.Feed.Index = app.UI.Feed.scrollLimit()
+ app.UI.Render()
+}
+
+func (app *App) browseSpace(rid id.RoomID) {
+ app.Screen = rid
+ app.RoomID = rid
+ app.Unseen[rid] = false
+ app.UI.StatusBar.Title = app.roomTitle(rid)
+ app.UI.StatusBar.Members = len(roomMembers(app.Client, rid))
+ app.UI.Feed.Entries = []Entry{entry("Sorry, spaces are not yet supported.")}
+ app.UI.Feed.Index = app.UI.Feed.scrollLimit()
+ app.UI.Accept()
+ app.UI.Render()
+}
+
+func (app *App) Browse(roomShorthand string) {
+ rid := app.pickRoom(roomShorthand, app.RoomList())
+ if rid == "" || roomMembership(app.Client, rid) != event.MembershipJoin {
+ app.UI.Reject()
+ } else {
+ if roomIsSpace(app.Client, rid) {
+ app.browseSpace(rid)
+ } else {
+ app.browse(rid)
+ }
+ }
+}
+
+func (app *App) createDirectChat(uid id.UserID) {
+ app.UI.Accept()
+ req := &mautrix.ReqCreateRoom{
+ Preset: "trusted_private_chat",
+ Invite: []id.UserID{uid},
+ IsDirect: true,
+ }
+ resp, err := app.Client.CreateRoom(req)
+ if err == nil {
+ err := setAsDirectChat(app.Client, resp.RoomID, uid)
+ if err == nil {
+ app.UI.Notify(0, "Created a direct chat and invited " + string(uid))
+ } else {
+ app.UI.Notify(ansi.Yellow, "Failed to set created room as direct chat: " + err.Error())
+ }
+ app.refreshRoomDetials(resp.RoomID)
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to create direct chat: " + err.Error())
+ }
+}
+
+func (app *App) Create(roomName string) {
+ app.UI.Accept()
+ req := mautrix.ReqCreateRoom{Name: roomName}
+ resp, err := app.Client.CreateRoom(&req)
+ if err == nil {
+ app.UI.Notify(0, "Created " + roomName)
+ app.refreshRoomDetials(resp.RoomID)
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to create room: " + err.Error())
+ }
+}
+
+func (app *App) Download(media string) {
+ u := app.pickUpload(media)
+ if u == nil {
+ app.UI.Reject()
+ } else {
+ app.UI.Accept()
+ data, err := u.Download(app.Client)
+ if err == nil {
+ err := writeFile(u.Name, data, 0600)
+ if err == nil {
+ app.UI.Notify(0, "Downloaded " + u.Name)
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to write file: " + err.Error())
+ }
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to download: " + err.Error())
+ }
+ }
+}
+
+func (app *App) Forget(room string) {
+ rid := app.pickRoom(room, app.RoomList())
+ if rid == "" {
+ app.UI.Reject()
+ } else {
+ app.UI.Accept()
+ _, err := app.Client.ForgetRoom(rid)
+ if err == nil {
+ delete(app.Messages, rid)
+ if app.RoomID == rid || app.Screen == RoomsScreen {
+ app.roomsScreen()
+ }
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to forget room: " + err.Error())
+ }
+ }
+}
+
+func (app *App) Invite(user string) {
+ uid := id.UserID(user)
+ _, _, err := uid.ParseAndValidate()
+ if err != nil {
+ app.UI.Reject()
+ return
+ }
+ if app.Screen == RoomsScreen {
+ app.createDirectChat(uid)
+ } else {
+ app.UI.Accept()
+ req := &mautrix.ReqInviteUser{UserID: uid}
+ _, err := app.Client.InviteUser(app.RoomID, req)
+ if err == nil {
+ app.UI.Notify(0, "Invited " + string(uid))
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to invite user: " + err.Error())
+ }
+ }
+}
+
+func (app *App) Join(room string) {
+ rid := app.pickRoom(room, app.RoomList())
+ var err error
+ if rid == "" {
+ _, err = app.Client.JoinRoom(room, "", nil)
+ } else {
+ _, err = app.Client.JoinRoomByID(rid)
+ }
+ if err == nil {
+ app.UI.Accept()
+ app.UI.Notify(0, "Joined room: " + room)
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to join room: " + err.Error())
+ }
+}
+
+func (app *App) Kick(user string) {
+ uid := pickUser(user, roomOtherMembers(app.Client, app.RoomID))
+ if uid == "" {
+ app.UI.Reject()
+ return
+ }
+ req := &mautrix.ReqKickUser{UserID: uid}
+ _, err := app.Client.KickUser(app.RoomID, req)
+ if err == nil {
+ app.UI.Accept()
+ if uid == app.Client.UserID {
+ app.roomsScreen()
+ }
+ app.UI.Notify(0, "Kicked " + string(uid))
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to kick user: " + err.Error())
+ }
+}
+
+func (app *App) leave(rid id.RoomID) {
+ app.UI.Accept()
+ title := app.roomTitle(rid)
+ m := roomMembership(app.Client, rid)
+ _, err := app.Client.LeaveRoom(rid)
+ if err == nil {
+ if m == event.MembershipInvite {
+ app.UI.Notify(0, "Rejected invitation")
+ } else {
+ app.UI.Notify(0, "Left " + title)
+ }
+ } else {
+ if m == event.MembershipInvite {
+ app.UI.Notify(ansi.Red, "Failed to reject invitation: " + err.Error())
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to leave room: " + err.Error())
+ }
+ }
+}
+
+func (app *App) Leave(roomShorthand string) {
+ rid := app.pickRoom(roomShorthand, app.RoomList())
+ if rid == "" {
+ app.UI.Reject()
+ } else {
+ app.leave(rid)
+ if app.Screen == rid {
+ app.roomsScreen()
+ }
+ }
+}
+
+func setAsDirectChat(client *mautrix.Client, rid id.RoomID, uid id.UserID) error {
+ dc := event.DirectChatsEventContent{}
+ if err := client.GetAccountData("m.direct", &dc); err != nil {
+ return err
+ }
+ for user, rooms := range dc {
+ for i, r := range rooms {
+ if r == rid {
+ dc[user] = append(dc[user][:i], dc[user][i+1:]...)
+ }
+ }
+ }
+ dc[uid] = append(dc[uid], rid)
+ if err := client.SetAccountData("m.direct", dc); err != nil {
+ return err
+ }
+ return nil
+}
+
+func unsetAsDirectChat(client *mautrix.Client, rid id.RoomID) error {
+ dc := event.DirectChatsEventContent{}
+ if err := client.GetAccountData("m.direct", &dc); err != nil {
+ return err
+ }
+ for user, rooms := range dc {
+ for i, r := range rooms {
+ if r == rid {
+ dc[user] = append(dc[user][:i], dc[user][i+1:]...)
+ }
+ }
+ }
+ if err := client.SetAccountData("m.direct", dc); err != nil {
+ return err
+ }
+ return nil
+}
+
+func (app *App) MakeDirectChat(user string) {
+ others := roomOtherUsers(app.Client, app.RoomID)
+ var uid id.UserID
+ if user == "" {
+ if len(others) > 1 {
+ app.UI.Accept()
+ app.UI.Notify(ansi.Red, "Need to specify which user for direct chat")
+ return
+ }
+ uid = others[0]
+ } else {
+ uid = pickUser(user, others)
+ if uid == "" {
+ app.UI.Reject()
+ return
+ }
+ }
+ app.UI.Accept()
+ err := setAsDirectChat(app.Client, app.RoomID, uid)
+ if err == nil {
+ app.refreshRoomDetials(app.RoomID)
+ app.UI.Notify(0, "Set room as direct chat with " + string(uid))
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to set as direct chat: " + err.Error())
+ }
+}
+
+func (app *App) MakeGroupChat() {
+ app.UI.Accept()
+ err := unsetAsDirectChat(app.Client, app.RoomID)
+ if err == nil {
+ app.refreshRoomDetials(app.RoomID)
+ app.UI.Notify(0, "Set room as group chat")
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to set as group chat: " + err.Error())
+ }
+}
+
+func (app *App) MakeHistoryVisibility(hv event.HistoryVisibility) {
+ app.UI.Accept()
+ c := event.HistoryVisibilityEventContent{HistoryVisibility: hv}
+ _, err := app.Client.SendStateEvent(app.RoomID, event.StateHistoryVisibility, "", c)
+ if err == nil {
+ app.refreshRoomDetials(app.RoomID)
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to set history visibility: " + err.Error())
+ }
+}
+
+func (app *App) MakeJoinRule(jr event.JoinRule) {
+ app.UI.Accept()
+ c := event.JoinRulesEventContent{JoinRule: jr}
+ _, err := app.Client.SendStateEvent(app.RoomID, event.StateJoinRules, "", c)
+ if err == nil {
+ app.refreshRoomDetials(app.RoomID)
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to set access: " + err.Error())
+ }
+}
+
+func (app *App) MakeName(name string) {
+ app.UI.Accept()
+ c := event.RoomNameEventContent{Name: name}
+ _, err := app.Client.SendStateEvent(app.RoomID, event.StateRoomName, "", c)
+ if err == nil {
+ app.refreshRoomName(app.RoomID)
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to name room: " + err.Error())
+ }
+}
+
+func (app *App) MakeTopic(topic string) {
+ app.UI.Accept()
+ c := event.TopicEventContent{Topic: topic}
+ _, err := app.Client.SendStateEvent(app.RoomID, event.StateTopic, "", c)
+ if err == nil {
+ app.refreshRoomDetials(app.RoomID)
+ } else {
+ app.UI.Notify(ansi.Red, "Failed to set topic: " + err.Error())
+ }
+}
+
+func (app *App) membersScreen(rid id.RoomID) {
+ app.Screen = MembersScreen
+ app.RoomID = rid
+ app.UI.StatusBar.Title = app.roomTitle(rid)
+ app.UI.StatusBar.Members = len(roomMembers(app.Client, rid))
+ room := app.Client.Store.LoadRoom(rid)
+ events := room.State[event.StateMember]
+ app.UI.Feed.Entries = make([]Entry, 0, len(events))
+ for _, ev := range events {
+ membership := "<error>"
+ switch ev.Content.AsMember().Membership {
+ case event.MembershipJoin:
+ membership = ""
+ case event.MembershipLeave:
+ membership = "<left> "
+ case event.MembershipInvite:
+ membership = "<invited> "
+ case event.MembershipBan:
+ membership = "<banned> "
+ case event.MembershipKnock:
+ membership = "<requesting invite> "
+ }
+ line := membership + prettyUser(id.UserID(*ev.StateKey))
+ app.UI.Feed.Entries = append(app.UI.Feed.Entries, entry(line))
+ }
+ app.UI.Render()
+}
+
+func (app *App) MembersScreen(room string) {
+ rid := app.pickRoom(room, app.RoomList())
+ if rid == "" {
+ app.UI.Reject()
+ } else {
+ app.UI.Accept()
+ app.UI.Feed.Index = 0
+ app.membersScreen(rid)
+ }
+}
+
+func (app *App) open(upload, cmd, msg string) {
+ u := app.pickUpload(upload)
+ if u == nil {
+ app.UI.Reject()
+ } else {
+ app.UI.Accept()
+ f, clean, err := u.TempFile(app.Client)
+ if err == nil {
+ go func() {
+ defer clean()
+ err := exec.Command(cmd, f.Name()).Run()
+ if err != nil {
+ app.UI.Notify(ansi.Red, msg + err.Error())
+ }
+ }()
+ } else {
+ app.UI.Notify(ansi.Red, err.Error())
+ }
+ }
+}
+
+func (app *App) openEnv(upload, env, msg string) {
+ cmd := os.Getenv(env)
+ if cmd == "" {
+ app.UI.Accept()
+ app.UI.Notify(ansi.Red, "$" + env + " is not set")
+ } else {
+ app.open(upload, cmd, msg)
+ }
+}
+
+func (app *App) Open(upload string) {
+ app.open(upload, "xdg-open", "Opening: ")
+}
+
+func (app *App) OpenAudio(upload string) {
+ app.openEnv(upload, "AUDIO_PLAYER", "Audio Player: ")
+}
+
+func (app *App) OpenImage(upload string) {
+ app.openEnv(upload, "IMAGE_VIEWER", "Image Viewer: ")
+}
+
+func (app *App) OpenVideo(upload string) {
+ app.openEnv(upload, "VIDEO_PLAYER", "Video Player: ")
+}
+
+func (app *App) roomDescriptionScreen(rid id.RoomID) {
+ app.Screen = RoomDescriptionScreen
+ app.RoomID = rid
+ app.UI.StatusBar.Title = app.roomTitle(rid)
+ app.UI.StatusBar.Members = len(roomMembers(app.Client, rid))
+ app.UI.Feed.Index = 0
+
+ creator := prettyUser(roomCreator(app.Client, rid))
+ direct := "false"
+ if u := app.RoomDirectChatUser(rid); u != "" {
+ direct = "with " + prettyUser(u)
+ }
+ histvis := roomHistoryVisibilityString(app.Client, rid)
+
+ var aliases strings.Builder
+ if a := roomAlias(app.Client, rid); a != "" {
+ aliases.WriteString(fmt.Sprintf("%s%s%s\n", ansi.Bold, a, ansi.Reset))
+ }
+ for _, a := range roomAltAliases(app.Client, rid) {
+ aliases.WriteString(fmt.Sprintf(" %s\n", string(a)))
+ }
+
+ app.UI.Feed.Entries = []Entry{
+ entry(fmt.Sprintf("Creator: %s", creator)),
+ entry(fmt.Sprintf("Topic: %s\n", roomTopic(app.Client, rid))),
+ entry(fmt.Sprintf("Access: %s", roomJoinRule(app.Client, rid))),
+ entry(fmt.Sprintf("History Visibility: %s", histvis)),
+ entry(fmt.Sprintf("Encrypted: %t\n", roomIsEncrypted(app.Client, rid))),
+ entry(fmt.Sprintf("Is Space: %t", roomIsSpace(app.Client, rid))),
+ entry(fmt.Sprintf("Is Direct Chat (set per user): %s\n", direct)),
+ entry(fmt.Sprintf("ID: %s", rid)),
+ entry(fmt.Sprintf("Aliases: %s", aliases.String())),
+ }
+
+ app.UI.Render()
+}
+
+func (app *App) RoomDescriptionScreen(room string) {
+ rid := app.pickRoom(room, app.RoomList())
+ if rid == "" {
+ app.UI.Reject()
+ } else {
+ app.UI.Accept()
+ app.roomDescriptionScreen(rid)
+ }
+}
+
+func (app *App) roomsScreen() {
+ app.Screen = RoomsScreen
+ app.UI.StatusBar.Title = "Rooms"
+ app.UI.StatusBar.Members = 0
+
+ headings := []string{
+ "People:",
+ "Private:",
+ "Public:",
+ }
+ tags := []string{
+ "<invited to> ",
+ "",
+ "<requesting> ",
+ "<banned from> ",
+ "<left> ",
+ }
+ app.UI.Feed.Entries = nil
+ i := 1
+ for ci, c := range CategoryOrder {
+ app.UI.Feed.Entries = append(app.UI.Feed.Entries, entry(headings[ci]))
+ for mi, m := range MembershipOrder {
+ for _, rid := range app.Rooms(c, m) {
+ name := roomName(app.Client, rid)
+ user := roomCreator(app.Client, rid)
+ if c.direct {
+ user = app.RoomDirectChatUser(rid)
+ }
+ if roomIsSpace(app.Client, rid) {
+ name = fmt.Sprintf("%s%s%s%s", ansi.It, ansi.Underline, name, ansi.Reset)
+ }
+ if name != "" {
+ name += " "
+ }
+ line := fmt.Sprintf("[%d] %s%s%s", i, tags[mi], name, prettyUser(user))
+ if unread := app.Unread[rid]; unread > 0 {
+ line += fmt.Sprintf(" {%d UNREAD}", unread)
+ } else if app.Unseen[rid] {
+ line += " !"
+ }
+ app.UI.Feed.Entries = append(app.UI.Feed.Entries, entry(line))
+ i++
+ }
+ }
+ app.UI.Feed.Entries = append(app.UI.Feed.Entries, entry(""))
+ }
+
+ app.UI.Render()
+}
+
+func (app *App) RoomsScreen() {
+ app.UI.Accept()
+ app.UI.Feed.Index = 0
+ app.roomsScreen()
+}
+
+func (app *App) Say(msg string) {
+ app.UI.Accept()
+ go func() {
+ if _, err := app.Client.SendText(app.RoomID, msg); err != nil {
+ app.UI.Notify(ansi.Red, "Failed to send text: " + err.Error())
+ }
+ }()
+}
+
+func (app *App) Unban(user string) {
+ uid := pickUser(user, roomOtherUsersBanned(app.Client, app.RoomID))
+ if uid == "" {
+ app.UI.Reject()
+ } else {
+ app.UI.Accept()
+ req := &mautrix.ReqUnbanUser{UserID: uid}
+ _, err := app.Client.UnbanUser(app.RoomID, req)
+ if err != nil {
+ app.UI.Notify(ansi.Red, "Failed to unban user: " + err.Error())
+ }
+ }
+}
+
+func (app *App) upload(file *os.File) {
+ stat, err := file.Stat()
+ if err != nil {
+ app.UI.Reject()
+ return
+ }
+ app.UI.Accept()
+ resp, err := app.Client.UploadMedia(mautrix.ReqUploadMedia{
+ Content: file,
+ ContentLength: stat.Size(),
+ ContentType: string(event.MsgFile),
+ })
+ if err != nil {
+ app.UI.Notify(ansi.Red, "Failed to upload file: " + err.Error())
+ return
+ }
+ c := event.MessageEventContent{
+ MsgType: event.MsgFile,
+ Body: stat.Name(),
+ URL: resp.ContentURI.CUString(),
+ }
+ _, err = app.Client.SendMessageEvent(app.RoomID, event.EventMessage, c)
+ if err != nil {
+ app.UI.Notify(ansi.Red, "Failed send file: " + err.Error())
+ }
+}
+
+func (app *App) Upload(path string) {
+ f, err := os.Open(expandPath(path))
+ if err == nil {
+ defer f.Close()
+ app.upload(f)
+ } else {
+ app.UI.Reject()
+ }
+}
A => debug.go +10 -0
@@ 1,10 @@
+package main
+
+import (
+ "fmt"
+ "os/exec"
+)
+
+func N(a ...any) {
+ _ = exec.Command("notify-send", fmt.Sprint(a...)).Run()
+}
A => doc/sup.1.scd +196 -0
@@ 1,196 @@
+sup(1)
+
+# NAME
+
+*sup* - Terminal Matrix client
+
+# SYNOPSIS
+
+*sup*
+*sup* *--help*
+
+# DESCRIPTION
+
+*sup* is a Matrix client for real-time chat with a command driven user interface.
+
+# OPTIONS
+
+*-h*, *--help*
+ Print help and exit.
+
+# LOGGING IN
+
+You need an existing Matrix account on a server of your choice.
+*sup* uses the environment variables *SUP_HOMESEVER*, *SUP_USERNAME* and *SUP_PASSWORD* to log in, or prompts you to type them if they are unset.
+
+For example, this would just prompt for a password:
+ *SUP_HOMESEVER=matrix.org SUP_USERNAME=example sup*
+
+# TUTORIAL
+
+The initial screen lists the rooms you are a member of or invited to.
+Let's create a new room by typing *create My Room* and pressing Enter.
+We can browse it by entering *b* and its number or the start of its name if its unique, like *b 4* or *b My Ro*.
+You could now say something with the *s* command like *s sup lads*, but you'll be talking to the void.
+We could invite a friend to our room using *invite @example:matrix.org*, or return to the rooms screen with *r*.
+
+If we want to accept an invitation, we can use *join* and pass the room's number or name.
+Commands can also take a room's official ID or alias, so we could join a public room using *join #matrix:matrix.org* or *join !OGEhHVWSdvArJzumhm:matrix.org*.
+There's also *leave* to leave a room or reject an invitation.
+
+Rooms we *create* start off as private chats requiring an invitation, but they can then be changed.
+If we browse a room or inspect one with the *room* command, we can then use one of the commands beginning with *make-* to tweak it.
+We could make it public with *make-public* and privite again with *make-private*, or set the topic with *make-topic crop rotation*.
+
+You can use *make-direct-chat* to mark a room as a one-to-one chat rather than a group chat, but you can also just *invite* someone from the rooms screen to create direct chat with them.
+
+Aside from commands, there are a few keybindings.
+You can scroll up with Ctrl+u and down with Ctrl+d, and clear what you've typed with Escape or Ctrl+c.
+The up and down arrow keys navigate your command history, and the Tab key auto-completes commands, rooms, users and filepaths.
+
+There are no pop-up notifications when you get a message, but the three numbers at the top of the screen show how many direct/public/privite chats have unseen messages, and you can check the rooms screen.
+
+Command names end at the first non-letter so you can often omit the space and just do *b2* or *room9*, and even just *b* or *room* for the current room.
+
+# COMMANDS
+
+*ban* _user_
+ Bans a user from the current room, kicking them if they are a member.
+
+*browse*, *b* _room_
+ Browses a room, making it the current room.
+
+*create* _name_
+ Creates a new private group chat.
+
+*download*, *d* _upload_
+ Downloads an upload to the current working directory.
+
+*forget* _room_
+ Forgets a room you were a member of, taking it off the room screen.
+
+*invite* _user_
+ Invites a user to the current room, or creates a new direct with them if you are at the rooms screen.
+
+*join* _room_
+ Joins a room or accepts an invitation.
+
+*kick* _user_
+ Removes a user from the current room, but does not ban them.
+
+*leave* _room_
+ Leaves a room or accepts an invitation.
+
+*make-direct-chat*
+ Marks the current room as a direct chat.
+
+*make-group-chat*
+ Marks the current room as a group chat.
+
+*make-history-secret*
+ Has messages of the current room from before each member joined be invisible to them.
+
+*make-history-shared*
+ Has messages of the current room from before each member joined be visible to them.
+
+*make-name* _name_
+ Sets the current room's name.
+
+*make-private*
+ Makes the current room require an invite to join.
+
+*make-public*
+ Makes the current room not require an invite to join.
+
+*make-topic* _topic_
+ Sets the current room's topic.
+
+*members*, *m*
+ Browses the members of a room, making it the current room.
+
+*open*, *o* _upload_
+ Opens an upload using the *xdg-open* command.
+
+*open-audio*, *oa* _upload_
+ Opens an upload using the environment variable *AUDIO_PLAYER*.
+
+*open-image*, *oi* _upload_
+ Opens an upload using the environment variable *IMAGE_VIEWER*.
+
+*open-video*, *ov* _upload_
+ Opens an upload using the environment variable *VIDEO_PLAYER*.
+
+*quit*, *q*
+ Terminates *sup*.
+
+*room* _room_
+ Browses the room's state, making it the current room.
+
+*rooms*, *r*
+ Browses the rooms screen, making there be no current room.
+
+*say*, *s* _message_
+ Sends a message to the current room.
+
+*unban* _user_
+ Unbans a user from the current room.
+
+*upload*, *u* _filepath_
+ Uploads a file to the current room.
+
+A room is specified by its arbitrary number in the rooms screen, its ID, one of its aliases, or a unique prefix of its name.
+If no room is specified, the current room is used.
+Examples: *join 2*, *join #matrix:matrix.org*, *join !OGEhHVWSdvArJzumhm:matrix.org*, *join My Ro*.
+
+A user is specified by their Matrix ID following form *@*_username_*:*_homeserver_.
+
+An upload is specified by its arbitrary number.
+
+# KEYBINDINGS
+
+Escape or Ctrl+c
+ Clear the command line.
+
+Home or Ctrl+b
+ Move the cursor to the start of the command line.
+
+End or Ctrl+e
+ Move the cursor to the end of the command line.
+
+Ctrl+Backspace
+ Delete to start of word.
+
+Tab
+ Auto-complete command, room, user or filepath.
+
+Up
+ Go up command history.
+
+Down
+ Go down command history.
+
+
+Ctrl+l
+ Refresh the screen.
+
+Ctrl+j
+ Scroll down a single entry.
+
+Ctrl+k
+ Scroll up a single entry.
+
+Ctrl+d
+ Scroll down half a screen.
+
+Ctrl+u
+ Scroll up half a screen.
+
+PgDn
+ Scroll down a screen.
+
+PgUp
+ Scroll up a screen.
+
+# AUTHOR
+
+John Gebbie
A => go.mod +23 -0
@@ 1,23 @@
+module git.sr.ht/~geb/sup
+
+go 1.19
+
+require (
+ github.com/mattn/go-runewidth v0.0.12
+ github.com/muesli/reflow v0.3.0
+ github.com/pzl/tui v0.0.0-20201130221034-7267c4304bb3
+ golang.org/x/term v0.0.0-20210927222741-03fcf44c2211
+ maunium.net/go/mautrix v0.12.0
+)
+
+require (
+ github.com/mattn/go-isatty v0.0.14 // indirect
+ github.com/rivo/uniseg v0.2.0 // indirect
+ github.com/tidwall/gjson v1.14.1 // indirect
+ github.com/tidwall/match v1.1.1 // indirect
+ github.com/tidwall/pretty v1.2.0 // indirect
+ github.com/tidwall/sjson v1.2.4 // indirect
+ golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d // indirect
+ golang.org/x/net v0.0.0-20220624214902-1bab6f366d9e // indirect
+ golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a // indirect
+)
A => go.sum +48 -0
@@ 1,48 @@
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/mattn/go-isatty v0.0.7/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
+github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
+github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
+github.com/mattn/go-runewidth v0.0.4/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
+github.com/mattn/go-runewidth v0.0.12 h1:Y41i/hVW3Pgwr8gV+J23B9YEY0zxjptBuCWEaxmAOow=
+github.com/mattn/go-runewidth v0.0.12/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk=
+github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s=
+github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/pzl/tui v0.0.0-20201130221034-7267c4304bb3 h1:grc/ip3Y4Psa0+oiUgq4YUtTJMIA4N1zTZDGpXSUCDY=
+github.com/pzl/tui v0.0.0-20201130221034-7267c4304bb3/go.mod h1:fcmqDndm2ZYmfFo3DBpqYLzSLoQrV23KvIfI0M/Ou2E=
+github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
+github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY=
+github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
+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.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk=
+github.com/tidwall/gjson v1.12.1/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
+github.com/tidwall/gjson v1.14.1 h1:iymTbGkQBhveq21bEvAQ81I0LEBork8BFe1CUZXdyuo=
+github.com/tidwall/gjson v1.14.1/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
+github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
+github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
+github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs=
+github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
+github.com/tidwall/sjson v1.2.4 h1:cuiLzLnaMeBhRmEv00Lpk3tkYrcxpmbU81tAY4Dw0tc=
+github.com/tidwall/sjson v1.2.4/go.mod h1:098SZ494YoMWPmMO6ct4dcFnqxwj9r/gF0Etp19pSNM=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20190426145343-a29dc8fdc734/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d h1:sK3txAijHtOK88l68nt020reeT1ZdKLIYetKl95FzVY=
+golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/net v0.0.0-20220624214902-1bab6f366d9e h1:TsQ7F31D3bUCLeqPT0u+yjp1guoArKaNKmCr22PYgTQ=
+golang.org/x/net v0.0.0-20220624214902-1bab6f366d9e/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a h1:dGzPydgVsqGcTRVwiLJ1jVbufYwmzD3LfVPLKsKg+0k=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+maunium.net/go/mautrix v0.12.0 h1:jyT1TkJBIRJ7+OW7NhmMHmnEEBLsQe9ml+FYwSLhlaU=
+maunium.net/go/mautrix v0.12.0/go.mod h1:hHvNi5iKVAiI2MAdAeXHtP4g9BvNEX2rsQpSF/x6Kx4=
A => helper.go +55 -0
@@ 1,55 @@
+package main
+
+import (
+ "fmt"
+ "os"
+ "path/filepath"
+ "strings"
+ "unicode"
+)
+
+func fatal(a ...any) {
+ fmt.Fprintln(os.Stderr, a...)
+ os.Exit(1)
+}
+
+func max(a, b int) int {
+ if a > b {
+ return a
+ } else {
+ return b
+ }
+}
+func min(a, b int) int {
+ if a < b {
+ return a
+ } else {
+ return b
+ }
+}
+
+func strings_TrimLeftSpace(s string) string {
+ return strings.TrimLeftFunc(s, unicode.IsSpace)
+}
+
+func expandPath(path string) string {
+ if path == "~" || (len(path) > 1 && path[0] == '~' && os.IsPathSeparator(path[1])) {
+ home, err := os.UserHomeDir()
+ if err == nil {
+ return filepath.Join(home, path[1:])
+ }
+ }
+ return path
+}
+
+func writeFile(name string, data []byte, perm os.FileMode) error {
+ f, err := os.OpenFile(name, os.O_WRONLY|os.O_CREATE|os.O_EXCL, perm)
+ if err != nil {
+ return err
+ }
+ _, err = f.Write(data)
+ if err1 := f.Close(); err1 != nil && err == nil {
+ err = err1
+ }
+ return err
+}
A => main.go +704 -0
@@ 1,704 @@
+package main
+
+import (
+ "bufio"
+ "context"
+ "fmt"
+ "github.com/pzl/tui"
+ "github.com/pzl/tui/ansi"
+ "golang.org/x/term"
+ "maunium.net/go/mautrix"
+ "maunium.net/go/mautrix/event"
+ "maunium.net/go/mautrix/id"
+ "os"
+ "strings"
+ "time"
+ "unicode"
+)
+
+type Media struct {
+ ID int
+ Kind event.MessageType
+ URL id.ContentURI
+ Name string
+ data []byte
+}
+
+func (m *Media) Entry() string {
+ return fmt.Sprintf("[%d] %s: %s", m.ID, string(m.Kind)[2:], m.Name)
+}
+
+func (m *Media) Download(client *mautrix.Client) ([]byte, error) {
+ if len(m.data) > 0 {
+ return m.data, nil
+ }
+ var err error
+ m.data, err = client.DownloadBytes(m.URL)
+ return m.data, err
+}
+
+func (m *Media) TempFile(client *mautrix.Client) (*os.File, func(), error) {
+ data, err := m.Download(client)
+ if err != nil {
+ return nil, func() {}, err
+ }
+ f, err := os.CreateTemp("", "sup*_" + m.Name)
+ clean := func() { f.Close(); os.Remove(f.Name()) }
+ if err != nil {
+ clean()
+ return nil, func() {}, err
+ }
+ _, err = f.Write(data)
+ if err != nil {
+ clean()
+ return nil, func() {}, err
+ }
+ return f, clean, nil
+}
+
+
+type Message struct {
+ EventID id.EventID
+ RoomID id.RoomID
+ Sender id.UserID
+ Time time.Time
+ Body string
+ IsEvent bool
+ IsSpecial bool
+ Media *Media
+}
+
+func daySuffix(n int) string {
+ switch n {
+ case 1, 21, 31:
+ return "st"
+ case 2, 22:
+ return "nd"
+ case 3, 23:
+ return "rd"
+ }
+ return "th"
+}
+
+func (msg *Message) timeString() string {
+ year, month, day := time.Now().Date()
+ y, m, d := msg.Time.Date()
+ var sb strings.Builder
+ if y != year {
+ sb.WriteString(fmt.Sprintf("%d %s %d%s ", y, m.String()[:3], d, daySuffix(d)))
+ } else if m != month {
+ sb.WriteString(fmt.Sprintf("%s %d%s ", m.String()[:3], d, daySuffix(d)))
+ } else if d != day {
+ sb.WriteString(fmt.Sprintf("%d%s ", d, daySuffix(d)))
+ }
+ sb.WriteString(fmt.Sprintf("%d:%02d", msg.Time.Hour(), msg.Time.Minute()))
+ return sb.String()
+}
+
+func (msg *Message) Entry() string {
+ pre := msg.timeString() + " " + prettyUser(msg.Sender)
+ body := msg.Body
+ if msg.IsEvent {
+ body = fmt.Sprintf("%s%s%s%s", ansi.Dim, ansi.It, body, ansi.Reset)
+ } else if msg.IsSpecial {
+ body = fmt.Sprint(ansi.Bold, body, ansi.Reset)
+ } else if msg.Media != nil {
+ body = fmt.Sprint(ansi.Bold, msg.Media.Entry(), ansi.Reset)
+ }
+ return pre + " " + body
+}
+
+func normalMessage(ev *event.Event) *Message {
+ c := ev.Content.AsMessage()
+ ts := time.UnixMilli(ev.Timestamp)
+ msg := Message{ev.ID, ev.RoomID, ev.Sender, ts, c.Body, false, false, nil}
+ switch c.MsgType {
+ case event.MsgFile, event.MsgImage, event.MsgVideo, event.MsgAudio:
+ name := c.FileName
+ if name == "" {
+ name = msg.Body
+ }
+ msg.Media = &Media{0, c.MsgType, c.URL.ParseOrIgnore(), name, nil}
+ case event.MsgEmote:
+ msg.IsSpecial = true
+ msg.Body = "*" + msg.Body + "*"
+ case event.MsgNotice:
+ msg.IsSpecial = true
+ msg.Body = "notice: " + msg.Body
+ case event.MsgLocation:
+ msg.IsSpecial = true
+ msg.Body = "location: " + c.GeoURI
+ }
+ return &msg
+}
+
+func eventMessage(ev *event.Event) *Message {
+ c := ev.Content.AsMember()
+ before := event.MembershipLeave
+ if ev.Unsigned.PrevContent != nil {
+ before = event.Membership(ev.Unsigned.PrevContent.Raw["membership"].(string))
+ }
+ ts := time.UnixMilli(ev.Timestamp)
+
+ var body string
+ switch c.Membership {
+ case event.MembershipJoin:
+ if before == event.MembershipJoin {
+ body = "changed their name or avatar"
+ } else {
+ body = "joined"
+ }
+ case event.MembershipLeave:
+ if before == event.MembershipInvite {
+ if ev.Sender == id.UserID(*ev.StateKey) {
+ body = "rejected their invite"
+ } else {
+ body = "revoked the invite of " + prettyUser(id.UserID(*ev.StateKey))
+ }
+ } else if before == event.MembershipKnock {
+ if ev.Sender == id.UserID(*ev.StateKey) {
+ body = "retracted their invite request"
+ } else {
+ body = "denied " + prettyUser(id.UserID(*ev.StateKey))
+ }
+ } else if before == event.MembershipBan {
+ body = "unbanned " + prettyUser(id.UserID(*ev.StateKey))
+ } else if ev.Sender == id.UserID(*ev.StateKey) {
+ body = "left"
+ } else {
+ body = "kicked " + prettyUser(id.UserID(*ev.StateKey))
+ }
+ case event.MembershipInvite:
+ body = "invited " + prettyUser(id.UserID(*ev.StateKey))
+ case event.MembershipBan:
+ body = "banned " + prettyUser(id.UserID(*ev.StateKey))
+ case event.MembershipKnock:
+ body = "requested an invite"
+ }
+
+ return &Message{ev.ID, ev.RoomID, ev.Sender, ts, body, true, false, nil}
+}
+
+func encryptedMessage(ev *event.Event) *Message {
+ ts := time.UnixMilli(ev.Timestamp)
+ body := "encrypted message (not yet supported)"
+ return &Message{ev.ID, ev.RoomID, ev.Sender, ts, body, false, true, nil}
+}
+
+
+type App struct {
+ Client *mautrix.Client
+ UI *UI
+ Screen id.RoomID
+ RoomID id.RoomID
+ Unseen map[id.RoomID] bool
+ Messages map[id.RoomID][]*Message
+ Uploads map[id.RoomID][]*Media
+ ReadReceipts map[id.RoomID]id.EventID
+ Unread map[id.RoomID]int
+ DirectChats map[id.RoomID]id.UserID
+}
+
+func (app *App) unseenStatus() (direct int, private int, public int) {
+ j := event.MembershipJoin
+ for _, rid := range app.Rooms(CategoryOrder[0], j) {
+ if app.Unseen[rid] {
+ direct++
+ }
+ }
+ for _, rid := range app.Rooms(CategoryOrder[1], j) {
+ if app.Unseen[rid] {
+ private++
+ }
+ }
+ for _, rid := range app.Rooms(CategoryOrder[2], j) {
+ if app.Unseen[rid] {
+ public++
+ }
+ }
+ return
+}
+
+func NewApp(client *mautrix.Client) *App {
+ app := &App{
+ client, nil, "", "",
+ make(map[id.RoomID]bool),
+ make(map[id.RoomID][]*Message),
+ make(map[id.RoomID][]*Media),
+ make(map[id.RoomID]id.EventID),
+ make(map[id.RoomID]int),
+ nil,
+ }
+ app.UI = NewUI(app.unseenStatus, app.tabComplete)
+ return app
+}
+
+func (app *App) AddMessage(msg *Message) {
+ app.Messages[msg.RoomID] = append(app.Messages[msg.RoomID], msg)
+ if msg.Media != nil {
+ msg.Media.ID = len(app.Uploads[msg.RoomID]) + 1
+ app.Uploads[msg.RoomID] = append(app.Uploads[msg.RoomID], msg.Media)
+ }
+
+ if app.Screen == msg.RoomID {
+ app.UI.Feed.Entries = append(app.UI.Feed.Entries, msg)
+ limit := app.UI.Feed.scrollLimit()
+ if limit > 0 {
+ if app.UI.Feed.Index >= limit - GapBelowFeed - 1 {
+ app.UI.Feed.Index++
+ } else if msg.Sender != app.Client.UserID {
+ app.UI.StatusBar.Blink = true
+ }
+ }
+ app.UI.Render()
+ } else if msg.Sender != app.Client.UserID && !msg.IsEvent {
+ if !app.Unseen[msg.RoomID] {
+ app.Unseen[msg.RoomID] = true
+ app.UI.RenderStatusBar()
+ }
+
+ app.Unread[msg.RoomID]++
+ if app.Screen == RoomsScreen {
+ app.roomsScreen()
+ }
+ }
+}
+
+func (app *App) refreshRoomDetials(rid id.RoomID) {
+ if app.Screen == RoomDescriptionScreen && app.RoomID == rid {
+ app.roomDescriptionScreen(rid)
+ }
+}
+
+func (app *App) refreshRoomName(rid id.RoomID) {
+ if app.Screen == RoomsScreen {
+ app.roomsScreen()
+ } else if app.Screen == rid {
+ app.UI.StatusBar.Title = app.roomTitle(rid)
+ app.UI.Render()
+ }
+}
+
+func (app *App) refreshRoomSoul(rid id.RoomID) {
+ if app.Screen == RoomsScreen {
+ app.roomsScreen()
+ } else if app.Screen == RoomDescriptionScreen && app.RoomID == rid {
+ app.roomDescriptionScreen(rid)
+ }
+}
+
+func (app *App) storeDirectChats(c *event.DirectChatsEventContent) {
+ app.DirectChats = make(map[id.RoomID]id.UserID)
+ for uid, roomIDs := range *c {
+ for _, rid := range roomIDs {
+ app.DirectChats[rid] = uid
+ }
+ }
+}
+
+func (app *App) readReceiptIndex(rid id.RoomID) int {
+ if _, ok := app.ReadReceipts[rid]; !ok {
+ return 0
+ }
+ for i := len(app.Messages[rid])-1; i >= 0; i-- {
+ if app.Messages[rid][i].EventID == app.ReadReceipts[rid] {
+ return i
+ }
+ }
+ return -1
+}
+
+func (app *App) unseen(rid id.RoomID) int {
+ i := app.readReceiptIndex(rid)
+ if i == -1 {
+ return 0
+ }
+ for ; i < len(app.Messages[rid]); i++ {
+ m := app.Messages[rid][i]
+ if m.Sender != app.Client.UserID && !m.IsEvent {
+ break
+ }
+ }
+ return len(app.Messages[rid]) - i - 1
+}
+
+func (app *App) unread(rid id.RoomID) int {
+ i := app.readReceiptIndex(rid)
+ if i == -1 {
+ return 0
+ }
+ for ; i < len(app.Messages[rid]); i++ {
+ m := app.Messages[rid][i]
+ if m.Sender != app.Client.UserID && !m.IsEvent {
+ break
+ }
+ }
+ // don't count joined, left, etc.
+ for j := i + 1; j < len(app.Messages[rid]); j++ {
+ if app.Messages[rid][j].IsEvent {
+ i++
+ }
+ }
+ return len(app.Messages[rid]) - i - 1
+}
+
+func (app *App) updateUnread(rid id.RoomID) {
+ unread := app.Unread[rid]
+ unseen := app.Unseen[rid]
+ app.Unread[rid] = app.unread(rid)
+ app.Unseen[rid] = app.unseen(rid) > 0
+ if app.Unread[rid] != unread || app.Unseen[rid] != unseen {
+ if app.Screen == RoomsScreen {
+ app.roomsScreen()
+ }
+ }
+}
+
+func (app *App) sync() chan func() {
+ syncer := app.Client.Syncer.(*mautrix.DefaultSyncer)
+ updates := make(chan func())
+
+ onEvent := func(t event.Type, h mautrix.EventHandler) {
+ syncer.OnEventType(t, func(src mautrix.EventSource, ev *event.Event) {
+ updates <- func() {
+ h(src, ev)
+ }
+ })
+ }
+ store := func(src mautrix.EventSource, ev *event.Event) {
+ app.Client.Store.(*mautrix.InMemoryStore).UpdateState(src, ev)
+ }
+
+ onEvent(event.StateEncryption, func(src mautrix.EventSource, ev *event.Event) {
+ store(src, ev)
+ app.refreshRoomDetials(ev.RoomID)
+ })
+ onEvent(event.StateCanonicalAlias, func(src mautrix.EventSource, ev *event.Event) {
+ store(src, ev)
+ app.refreshRoomDetials(ev.RoomID)
+ })
+ onEvent(event.StateCreate, func(src mautrix.EventSource, ev *event.Event) {
+ store(src, ev)
+ app.refreshRoomSoul(ev.RoomID)
+ })
+ onEvent(event.StateHistoryVisibility, func(src mautrix.EventSource, ev *event.Event) {
+ store(src, ev)
+ app.refreshRoomDetials(ev.RoomID)
+ })
+ onEvent(event.StateJoinRules, func(src mautrix.EventSource, ev *event.Event) {
+ store(src, ev)
+ })
+ onEvent(event.StateMember, func(src mautrix.EventSource, ev *event.Event) {
+ store(src, ev)
+ if ev.Sender == app.Client.UserID {
+ app.refreshRoomSoul(ev.RoomID)
+ }
+ app.AddMessage(eventMessage(ev))
+ })
+ onEvent(event.StateRoomName, func(src mautrix.EventSource, ev *event.Event) {
+ store(src, ev)
+ app.refreshRoomName(ev.RoomID)
+ })
+ onEvent(event.StateTopic, func(src mautrix.EventSource, ev *event.Event) {
+ store(src, ev)
+ app.refreshRoomDetials(ev.RoomID)
+ })
+
+ onEvent(event.EventEncrypted, func(src mautrix.EventSource, ev *event.Event) {
+ app.AddMessage(encryptedMessage(ev))
+ })
+ onEvent(event.EventMessage, func(src mautrix.EventSource, ev *event.Event) {
+ app.AddMessage(normalMessage(ev))
+ })
+
+ onEvent(event.AccountDataDirectChats, func(src mautrix.EventSource, ev *event.Event) {
+ app.storeDirectChats(ev.Content.AsDirectChats())
+ app.refreshRoomSoul(ev.RoomID)
+ })
+
+ onEvent(event.EphemeralEventReceipt, func(src mautrix.EventSource, ev *event.Event) {
+ c := ev.Content.AsReceipt()
+ for eid, receipts := range *c {
+ if userReceipts, ok := receipts[event.ReceiptTypeRead]; ok {
+ if _, ok := userReceipts[app.Client.UserID]; ok {
+ app.ReadReceipts[ev.RoomID] = eid
+ app.updateUnread(ev.RoomID)
+ }
+ }
+ }
+ })
+
+ go func() {
+ for {
+ if err := app.Client.Sync(); err != nil {
+ app.UI.Notify(ansi.Red, "Failed to sync: " + err.Error())
+ }
+ time.Sleep(time.Second)
+ }
+ }()
+
+ return updates
+}
+
+var inRoomCommands = []string{
+ "ban",
+ "download", "d",
+ "kick",
+ "make-direct-chat",
+ "make-group-chat",
+ "make-history-secret",
+ "make-history-shared",
+ "make-name",
+ "make-private",
+ "make-public",
+ "make-topic",
+ "open", "o",
+ "open-audio", "oa",
+ "open-image", "oi",
+ "open-video", "ov",
+ "say", "s",
+ "unban",
+ "upload", "u",
+}
+
+var roomsScreenOrInRoomCommands = []string{
+ "browse", "b",
+ "create",
+ "forget",
+ "invite",
+ "join",
+ "leave",
+ "members", "m",
+ "quit", "q",
+ "room",
+ "rooms", "r",
+}
+
+func cutCmd(s string, cmd... string) (string, bool) {
+ for _, c := range cmd {
+ if s == c {
+ return "", true
+ }
+ if strings.HasPrefix(s, c + " ") {
+ return s[len(c) + 1:], true
+ }
+ if strings.HasPrefix(s, c) && !unicode.IsLetter(rune(s[len(c)])) {
+ return s[len(c):], true
+ }
+ }
+ return "", false
+}
+
+func (app *App) Do(cmd string) int {
+ cmd = strings_TrimLeftSpace(cmd)
+ fellthrough := false
+ // In-room-only Commands
+ if app.Screen != RoomsScreen {
+ if user, ok := cutCmd(cmd, "ban"); ok {
+ app.Ban(user)
+ } else if media, ok := cutCmd(cmd, "download", "d"); ok {
+ app.Download(media)
+ } else if user, ok := cutCmd(cmd, "kick"); ok {
+ app.Kick(user)
+ } else if user, ok := cutCmd(cmd, "make-direct-chat"); ok {
+ app.MakeDirectChat(user)
+ } else if s, ok := cutCmd(cmd, "make-group-chat"); ok && len(s) == 0 {
+ app.MakeGroupChat()
+ } else if s, ok := cutCmd(cmd, "make-history-secret"); ok && len(s) == 0 {
+ app.MakeHistoryVisibility(event.HistoryVisibilityJoined)
+ } else if s, ok := cutCmd(cmd, "make-history-shared"); ok && len(s) == 0 {
+ app.MakeHistoryVisibility(event.HistoryVisibilityShared)
+ } else if name, ok := cutCmd(cmd, "make-name"); ok {
+ app.MakeName(name)
+ } else if s, ok := cutCmd(cmd, "make-private"); ok && len(s) == 0 {
+ app.MakeJoinRule(event.JoinRuleInvite)
+ } else if s, ok := cutCmd(cmd, "make-public"); ok && len(s) == 0 {
+ app.MakeJoinRule(event.JoinRulePublic)
+ } else if topic, ok := cutCmd(cmd, "make-topic"); ok {
+ app.MakeTopic(topic)
+ } else if media, ok := cutCmd(cmd, "open", "o"); ok {
+ app.Open(media)
+ } else if audio, ok := cutCmd(cmd, "open-audio", "oa"); ok {
+ app.OpenAudio(audio)
+ } else if image, ok := cutCmd(cmd, "open-image", "oi"); ok {
+ app.OpenImage(image)
+ } else if video, ok := cutCmd(cmd, "open-video", "ov"); ok {
+ app.OpenVideo(video)
+ } else if msg, ok := cutCmd(cmd, "say", "s"); ok {
+ app.Say(msg)
+ } else if user, ok := cutCmd(cmd, "unban"); ok {
+ app.Unban(user)
+ } else if path, ok := cutCmd(cmd, "upload", "u"); ok {
+ app.Upload(path)
+ } else {
+ fellthrough = true
+ }
+ }
+ // Rooms Screen and/or In-room Commands
+ if app.Screen == RoomsScreen || fellthrough {
+ if room, ok := cutCmd(cmd, "browse", "b"); ok {
+ app.Browse(room)
+ } else if room, ok := cutCmd(cmd, "create"); ok {
+ app.Create(room)
+ } else if room, ok := cutCmd(cmd, "forget"); ok {
+ app.Forget(room)
+ } else if user, ok := cutCmd(cmd, "invite"); ok {
+ app.Invite(user)
+ } else if room, ok := cutCmd(cmd, "join"); ok {
+ app.Join(room)
+ } else if room, ok := cutCmd(cmd, "leave"); ok {
+ app.Leave(room)
+ } else if room, ok := cutCmd(cmd, "members", "m"); ok {
+ app.MembersScreen(room)
+ } else if s, ok := cutCmd(cmd, "quit", "q"); ok && len(s) == 0 {
+ return 0
+ } else if room, ok := cutCmd(cmd, "room"); ok {
+ app.RoomDescriptionScreen(room)
+ } else if s, ok := cutCmd(cmd, "rooms", "r"); ok && len(s) == 0 {
+ app.RoomsScreen()
+ } else {
+ app.UI.Reject()
+ }
+ }
+ return -1
+}
+
+// alive marks messages read based off the scroll position.
+func (app *App) alive() {
+ if app.Screen == app.RoomID {
+ // As a rule of thumb, mark all read if the bottom message is visible.
+ if app.UI.Feed.Index >= app.UI.Feed.scrollLimit() - GapBelowFeed - 1 {
+ r := app.readReceiptIndex(app.RoomID)
+ i := len(app.Messages[app.RoomID]) - 1
+ if r != -1 && i > r {
+ eid := app.Messages[app.RoomID][i].EventID
+ app.ReadReceipts[app.RoomID] = eid
+ _ = app.Client.MarkRead(app.RoomID, eid)
+ app.UI.StatusBar.Blink = false
+ }
+ }
+ }
+}
+
+func (app *App) Run() int {
+ app.UI.Ansi.Screen(ansi.Alt)
+ defer app.UI.Ansi.Screen(ansi.Normal)
+ ctx, cancel := context.WithCancel(context.Background())
+ defer cancel()
+ inputEvents, restoreInput, err := tui.GetInput(ctx, 0)
+ defer restoreInput()
+ if err != nil {
+ fatal("Failed to capture terminal input: " + err.Error())
+ }
+
+ updates := app.sync()
+
+ // Resize with terminal
+ go func() {
+ var width, height int
+ for range time.Tick(200 * time.Millisecond) {
+ w, h := tui.TermSize(0)
+ if w != width || h != height {
+ updates <- func() {
+ app.UI.Resize(w, h)
+ app.UI.Render()
+ }
+ width, height = w, h
+ }
+ }
+ }()
+
+ // Refresh every minute
+ go func() {
+ for range time.Tick(time.Minute) {
+ updates <- func() { app.UI.Render() }
+ }
+ }()
+
+ // Mainloop
+ app.roomsScreen()
+ app.UI.Resize(tui.TermSize(0))
+ app.UI.Render()
+ for {
+ select {
+ case ev := <- inputEvents:
+ if cmd, ok := app.UI.Handle(ev); ok {
+ code := app.Do(cmd)
+ if code >= 0 {
+ return code
+ }
+ }
+ app.alive()
+ case update := <- updates:
+ update()
+ }
+ }
+}
+
+func login(homeserver, username, password string) (*mautrix.Client, error) {
+ client, err := mautrix.NewClient(homeserver, "", "")
+ if err != nil {
+ return nil, err
+ }
+ _, err = client.Login(&mautrix.ReqLogin{
+ Type: "m.login.password",
+ Identifier: mautrix.UserIdentifier{
+ Type: mautrix.IdentifierTypeUser,
+ User: username,
+ },
+ Password: password,
+ StoreCredentials: true,
+ })
+ if err != nil {
+ return nil, err
+ }
+ return client, nil
+}
+
+func Login() *mautrix.Client {
+ homeserver := os.Getenv("SUP_HOMESEVER")
+ username := os.Getenv("SUP_USERNAME")
+ password := os.Getenv("SUP_PASSWORD")
+
+ scanner := bufio.NewScanner(os.Stdin)
+ if len(homeserver) == 0 {
+ fmt.Print("Homeserver: ")
+ if !scanner.Scan() {
+ fatal("\nProblem reading homeserver.")
+ }
+ homeserver = scanner.Text()
+ }
+ if len(username) == 0 {
+ fmt.Print("Username: ")
+ if !scanner.Scan() {
+ fatal("\nProblem reading username.")
+ }
+ username = scanner.Text()
+ }
+ if len(password) == 0 {
+ fmt.Print("Password: ")
+ passwordBytes, err := term.ReadPassword(0)
+ password = string(passwordBytes)
+ if err != nil {
+ fatal("\nProblem reading password.")
+ }
+ }
+
+ client, err := login(homeserver, username, password)
+ if err != nil {
+ fatal("\n" + err.Error())
+ }
+ return client
+}
+
+func main() {
+ if len(os.Args) > 1 {
+ fmt.Println("Usage: sup\nSee the manpage for a tutorial.")
+ os.Exit(0)
+ }
+
+ client := Login()
+ defer client.Logout()
+ app := NewApp(client)
+ os.Exit(app.Run())
+}
A => room.go +252 -0
@@ 1,252 @@
+package main
+
+import (
+ "maunium.net/go/mautrix"
+ "maunium.net/go/mautrix/event"
+ "maunium.net/go/mautrix/id"
+ "sort"
+)
+
+func roomAlias(client *mautrix.Client, rid id.RoomID) id.RoomAlias {
+ r := client.Store.LoadRoom(rid)
+ ev := r.GetStateEvent(event.StateCanonicalAlias, "")
+ if ev == nil {
+ return ""
+ }
+ return ev.Content.AsCanonicalAlias().Alias
+}
+
+func roomAltAliases(client *mautrix.Client, rid id.RoomID) []id.RoomAlias {
+ r := client.Store.LoadRoom(rid)
+ ev := r.GetStateEvent(event.StateCanonicalAlias, "")
+ if ev == nil {
+ return nil
+ }
+ return ev.Content.AsCanonicalAlias().AltAliases
+}
+
+func roomCreator(client *mautrix.Client, rid id.RoomID) id.UserID {
+ r := client.Store.LoadRoom(rid)
+ ev := r.GetStateEvent(event.StateCreate, "")
+ if ev == nil {
+ return ""
+ }
+ return ev.Content.AsCreate().Creator
+}
+
+func (app *App) RoomDirectChatUser(rid id.RoomID) id.UserID {
+ for r, uid := range app.DirectChats {
+ if r == rid {
+ return uid
+ }
+ }
+ return ""
+}
+
+func roomHistoryVisibility(client *mautrix.Client, rid id.RoomID) event.HistoryVisibility {
+ r := client.Store.LoadRoom(rid)
+ ev := r.GetStateEvent(event.StateHistoryVisibility, "")
+ if ev == nil {
+ return event.HistoryVisibilityShared
+ }
+ return ev.Content.AsHistoryVisibility().HistoryVisibility
+}
+
+func roomHistoryVisibilityString(client *mautrix.Client, rid id.RoomID) string {
+ hv := roomHistoryVisibility(client, rid)
+ switch hv {
+ case event.HistoryVisibilityInvited:
+ return "secret (up to invite)"
+ case event.HistoryVisibilityJoined:
+ return "secret (up to join)"
+ case event.HistoryVisibilityShared:
+ return "shared"
+ case event.HistoryVisibilityWorldReadable:
+ return "world readable"
+ }
+ return string(hv)
+}
+
+func roomIsEncrypted(client *mautrix.Client, rid id.RoomID) bool {
+ r := client.Store.LoadRoom(rid)
+ return r.GetStateEvent(event.StateEncryption, "") != nil
+}
+
+func roomIsSpace(client *mautrix.Client, rid id.RoomID) bool {
+ r := client.Store.LoadRoom(rid)
+ ev := r.GetStateEvent(event.StateCreate, "")
+ if ev == nil {
+ return false
+ }
+ return ev.Content.AsCreate().Type == event.RoomTypeSpace
+}
+
+func roomJoinRule(client *mautrix.Client, rid id.RoomID) event.JoinRule {
+ r := client.Store.LoadRoom(rid)
+ ev := r.GetStateEvent(event.StateJoinRules, "")
+ if ev == nil {
+ return ""
+ }
+ return ev.Content.AsJoinRules().JoinRule
+}
+
+func roomMembers(client *mautrix.Client, rid id.RoomID) []id.UserID {
+ r := client.Store.LoadRoom(rid)
+ var uids []id.UserID
+ for _, ev := range r.State[event.StateMember] {
+ c := ev.Content.AsMember()
+ if c.Membership == event.MembershipJoin {
+ uids = append(uids, id.UserID(*ev.StateKey))
+ }
+ }
+ return uids
+}
+
+func roomMembership(client *mautrix.Client, rid id.RoomID) event.Membership {
+ r := client.Store.LoadRoom(rid)
+ return r.GetMembershipState(client.UserID)
+}
+
+func roomName(client *mautrix.Client, rid id.RoomID) string {
+ r := client.Store.LoadRoom(rid)
+ ev := r.GetStateEvent(event.StateRoomName, "")
+ if ev == nil {
+ return ""
+ }
+ return ev.Content.AsRoomName().Name
+}
+
+func roomOtherMembers(client *mautrix.Client, rid id.RoomID) []id.UserID {
+ r := client.Store.LoadRoom(rid)
+ var uids []id.UserID
+ for _, ev := range r.State[event.StateMember] {
+ if id.UserID(*ev.StateKey) != client.UserID {
+ c := ev.Content.AsMember()
+ if c.Membership == event.MembershipJoin {
+ uids = append(uids, id.UserID(*ev.StateKey))
+ }
+ }
+ }
+ return uids
+}
+
+func roomOtherUsers(client *mautrix.Client, rid id.RoomID) []id.UserID {
+ r := client.Store.LoadRoom(rid)
+ var uids []id.UserID
+ for _, ev := range r.State[event.StateMember] {
+ if id.UserID(*ev.StateKey) != client.UserID {
+ uids = append(uids, id.UserID(*ev.StateKey))
+ }
+ }
+ return uids
+}
+
+func roomOtherUsersBanned(client *mautrix.Client, rid id.RoomID) []id.UserID {
+ r := client.Store.LoadRoom(rid)
+ var uids []id.UserID
+ for _, ev := range r.State[event.StateMember] {
+ if id.UserID(*ev.StateKey) != client.UserID {
+ c := ev.Content.AsMember()
+ if c.Membership == event.MembershipBan {
+ uids = append(uids, id.UserID(*ev.StateKey))
+ }
+ }
+ }
+ return uids
+}
+
+func (app *App) roomTitle(rid id.RoomID) string {
+ t := string(app.RoomDirectChatUser(rid))
+ if t == "" {
+ t = roomName(app.Client, rid)
+ }
+ return t
+}
+
+func roomTopic(client *mautrix.Client, rid id.RoomID) string {
+ r := client.Store.LoadRoom(rid)
+ ev := r.GetStateEvent(event.StateTopic, "")
+ if ev == nil {
+ return ""
+ }
+ return ev.Content.AsTopic().Topic
+}
+
+// friends returns all the other members of the user's direct and private chats.
+func (app *App) friends() []id.UserID {
+ m := make(map[id.UserID]struct{})
+ mask := RoomMask{true, true, true, false}
+ for _, rid := range app.Rooms(mask, event.MembershipJoin) {
+ for _, uid := range roomOtherUsers(app.Client, rid) {
+ m[uid] = struct{}{}
+ }
+ }
+ s := make([]id.UserID, 0, len(m))
+ for uid := range m {
+ s = append(s, uid)
+ }
+ return s
+}
+
+
+const (
+ MembersScreen = id.RoomID("Members")
+ RoomDescriptionScreen = id.RoomID("RoomDescription")
+ RoomsScreen = id.RoomID("Rooms")
+)
+
+type RoomMask struct {
+ group bool
+ direct bool
+ private bool
+ public bool
+}
+
+func (app *App) roomMeets(rid id.RoomID, mask RoomMask) bool {
+ d := app.RoomDirectChatUser(rid) != ""
+ p := roomJoinRule(app.Client, rid) == event.JoinRulePublic
+ return (d == mask.direct || d != mask.group) && (p == mask.public || p != mask.private)
+}
+
+func (app *App) Rooms(mask RoomMask, ships ...event.Membership) []id.RoomID {
+ var roomIDs []id.RoomID
+ for rid, room := range app.Client.Store.(*mautrix.InMemoryStore).Rooms {
+ membership := room.GetMembershipState(app.Client.UserID)
+ if app.roomMeets(rid, mask) {
+ for _, s := range ships {
+ if s == membership {
+ roomIDs = append(roomIDs, rid)
+ break
+ }
+ }
+ }
+ }
+ sort.Slice(roomIDs, func(i, j int) bool {
+ return app.roomTitle(roomIDs[i]) < app.roomTitle(roomIDs[j])
+ })
+ return roomIDs
+}
+
+var CategoryOrder = []RoomMask{
+ RoomMask{false, true, true, true},
+ RoomMask{true, false, true, false},
+ RoomMask{true, false, false, true},
+}
+
+var MembershipOrder = []event.Membership{
+ event.MembershipInvite,
+ event.MembershipJoin,
+ event.MembershipKnock,
+ event.MembershipBan,
+ event.MembershipLeave,
+}
+
+func (app *App) RoomList() []id.RoomID {
+ var s []id.RoomID
+ for _, c := range CategoryOrder {
+ for _, m := range MembershipOrder {
+ s = append(s, app.Rooms(c, m)...)
+ }
+ }
+ return s
+}
A => ui.go +624 -0
@@ 1,624 @@
+package main
+
+import (
+ "fmt"
+ "github.com/mattn/go-runewidth"
+ "github.com/muesli/reflow/truncate"
+ "github.com/muesli/reflow/wrap"
+ "github.com/pzl/tui"
+ "github.com/pzl/tui/ansi"
+ "maunium.net/go/mautrix/id"
+ "os"
+ "path/filepath"
+ "strings"
+ "time"
+ "unicode"
+)
+
+var colors = []ansi.BasicColor{
+ ansi.Red,
+ ansi.Green,
+ ansi.Yellow,
+ /* Blue can be hard to read */
+ ansi.Magenta,
+ ansi.Cyan,
+ // Light Colors
+ 60 + ansi.Red,
+ 60 + ansi.Green,
+ 60 + ansi.Yellow,
+ 60 + ansi.Blue,
+ 60 + ansi.Magenta,
+ 60 + ansi.Cyan,
+}
+
+func color(uid id.UserID) ansi.BasicColor {
+ n := 0
+ for i, r := range uid {
+ n += i * int(r)
+ }
+ return colors[n % len(colors)]
+}
+
+func prettyUser(uid id.UserID) string {
+ return fmt.Sprintf("%s%s%s%s", ansi.Bold, color(uid), uid, ansi.Reset)
+}
+
+
+type StatusBar struct {
+ Width func() int
+ Title string
+ Blink bool
+ Members int
+ Unseen func() (int, int, int)
+}
+
+func (sb *StatusBar) Render(a *ansi.Writer) {
+ dir, pub, priv := sb.Unseen()
+ unseen := fmt.Sprintf("[%d] [%d] [%d] ", dir, pub, priv)
+ pad := strings.Repeat(" ", max(0, sb.Width() - runewidth.StringWidth(unseen)))
+ fmt.Printf("%s%s%s", ansi.Reverse, pad + unseen, ansi.Reset)
+ a.Column(0)
+ title := truncate.StringWithTail(sb.Title, 30, "...")
+ if sb.Blink {
+ fmt.Print(ansi.Blink, " " + title + " ", ansi.Reset)
+ } else {
+ fmt.Print(" " + title + " ")
+ }
+ if sb.Members == 0 {
+ fmt.Print("\n")
+ } else if sb.Members == 1 {
+ fmt.Println(ansi.Reverse, "1 Member", ansi.Reset)
+ } else if sb.Members > 1 {
+ fmt.Printf("%s %d Members%s\n", ansi.Reverse, sb.Members, ansi.Reset)
+ }
+}
+
+
+type Notice struct {
+ Width func() int
+ Color ansi.BasicColor
+ Text string
+}
+
+func (n *Notice) Render(a *ansi.Writer) {
+ if n.Text == "" {
+ fmt.Print("\n")
+ } else {
+ t := truncate.StringWithTail(" " + n.Text, uint(n.Width()), "...")
+ pad := strings.Repeat(" ", n.Width() - len(t))
+ fmt.Printf("%s%s%s%s\n", n.Color, ansi.Reverse, t + pad, ansi.Reset)
+ }
+}
+
+
+type Entry interface {
+ Entry() string
+}
+
+type entry string
+
+func (e entry) Entry() string {
+ return string(e)
+}
+
+func (e entry) String() string {
+ return string(e)
+}
+
+type Feed struct {
+ Width func() int
+ Height func() int
+ Entries []Entry
+ Index int // the entry at the top
+}
+
+const GapBelowFeed = 3
+
+func (f *Feed) scrollLimit() int {
+ i := len(f.Entries) - 1
+ n := 0
+ for i >= 0 && n < f.Height() - GapBelowFeed {
+ n += 1 + strings.Count(wrap.String(f.Entries[i].Entry(), f.Width()), "\n")
+ i--
+ }
+ return i + 1
+}
+
+func (f *Feed) ScrollDown(n int) {
+ for i := f.Index; i < len(f.Entries); i++ {
+ if n <= 0 {
+ break
+ }
+ n -= strings.Count(wrap.String(f.Entries[i].Entry(), f.Width()), "\n") + 1
+ f.Index++
+ }
+ f.Index = min(f.scrollLimit(), f.Index)
+}
+
+func (f *Feed) ScrollUp(n int) {
+ for i := f.Index; i > 0; i-- {
+ if n <= 0 {
+ return
+ }
+ n -= strings.Count(wrap.String(f.Entries[i].Entry(), f.Width()), "\n") + 1
+ f.Index--
+ }
+}
+
+func (f *Feed) Render(a *ansi.Writer) {
+ var i, j int
+ func() {
+ for ; f.Index + i < len(f.Entries); i++ {
+ entry := f.Entries[f.Index + i]
+ for _, line := range strings.Split(wrap.String(entry.Entry(), f.Width()), "\n") {
+ if j >= f.Height() {
+ return
+ }
+ a.Column(0)
+ a.ClearLineRight()
+ fmt.Println(line)
+ j++
+ }
+ }
+ }()
+ for ; j < f.Height(); j++ {
+ a.Column(0)
+ a.ClearLineRight()
+ fmt.Print("\n")
+ }
+}
+
+
+func tabComplete(s string, possibilities []string) (string, bool) {
+ if len(s) == 0 {
+ return "", false
+ }
+ var c string
+ for _, p := range possibilities {
+ if strings.HasPrefix(p, s) {
+ if len(c) == 0 {
+ c = p
+ } else {
+ var sb strings.Builder
+ for i := 0; i < min(len(c), len(p)); i++ {
+ if []rune(c)[i] != []rune(p)[i] {
+ break
+ }
+ sb.WriteRune([]rune(c)[i])
+ }
+ c = sb.String()
+ }
+ }
+ }
+ if len(c) == 0 || c == s {
+ return s, false
+ }
+ return c, true
+}
+
+func entries(dirpath string) []string {
+ dir, _ := os.ReadDir(dirpath)
+ names := make([]string, len(dir))
+ for i := range dir {
+ names[i] = dir[i].Name()
+ if dir[i].IsDir() {
+ names[i] += string(os.PathSeparator)
+ }
+ }
+ return names
+}
+
+func (app *App) tabComplete(s string) string {
+ s = strings_TrimLeftSpace(s)
+ f := func(r rune) bool { return !unicode.IsLetter(r) }
+ if i := strings.IndexFunc(s, f); i == -1 {
+ fellthrough := false
+ if app.Screen != RoomsScreen {
+ s, fellthrough = tabComplete(s, inRoomCommands)
+ fellthrough = !fellthrough
+ }
+ if app.Screen == RoomsScreen || fellthrough {
+ s, _ = tabComplete(s, roomsScreenOrInRoomCommands)
+ }
+ } else {
+ if j := strings.LastIndexAny(s, " @!#"); j != -1 && s[j] != ' ' {
+ var from []string
+ if s[j] == '@' {
+ // User
+ var uids []id.UserID
+ if s[:i] == "invite" {
+ uids = app.friends()
+ } else if app.Screen != RoomsScreen {
+ if s[:i] == "kick" {
+ uids = roomOtherMembers(app.Client, app.RoomID)
+ } else if s[:i] == "unban" {
+ uids = roomOtherUsersBanned(app.Client, app.RoomID)
+ } else {
+ uids = roomOtherUsers(app.Client, app.RoomID)
+ }
+ }
+ from = make([]string, len(uids))
+ for i := range uids {
+ from[i] = string(uids[i])
+ }
+ } else if s[j] == '!' {
+ // Room ID
+ rids := app.RoomList()
+ from = make([]string, len(rids))
+ for i := range rids {
+ from[i] = string(rids[i])
+ }
+ } else {
+ // Room Alias
+ for _, rid := range app.RoomList() {
+ from = append(from, string(roomAlias(app.Client, rid)))
+ for _, a := range roomAltAliases(app.Client, rid) {
+ from = append(from, string(a))
+ }
+ }
+ }
+ c, _ := tabComplete(s[j:], from)
+ s = s[:j] + c
+ }
+ if left, right, _ := strings.Cut(s, " "); len(right) > 0 {
+ // Filepath
+ dir, base := filepath.Split(right)
+ var names []string
+ if dir == "" {
+ names = entries(".")
+ } else {
+ names = entries(expandPath(dir))
+ }
+ if len(names) == 1 {
+ if strings.HasPrefix(names[0], base) {
+ s = left + " " + dir + names[0]
+ }
+ } else {
+ base, _ := tabComplete(base, names)
+ s = left + " " + dir + base
+ }
+ }
+ }
+ return s
+}
+
+type CommandLine struct {
+ Width func() int
+ Text string
+ Index int // the cursor position
+ Offset int // the visual shift for long lines
+ History []string
+ HistoryIndex int
+ Search string
+ TabComplete func(string) string
+}
+
+func (cl *CommandLine) offsetRight() bool {
+ if cl.Index - cl.Offset > cl.Width() - 2 {
+ cl.Offset = min(cl.Offset + 1, len(cl.Text) - cl.Width() + 2)
+ return true
+ }
+ return false
+}
+
+func (cl *CommandLine) PositionCursor(a *ansi.Writer) {
+ a.Column(cl.Index + 2 - cl.Offset)
+}
+
+func (cl *CommandLine) CursorLeft(a *ansi.Writer, n int) {
+ if cl.Index == cl.Offset {
+ cl.Offset = max(0, cl.Offset - n)
+ cl.Render(a)
+ }
+ cl.Index = max(0, cl.Index - n)
+ cl.PositionCursor(a)
+}
+
+func (cl *CommandLine) CursorRight(a *ansi.Writer, n int) {
+ cl.Index = min(len(cl.Text), cl.Index + n)
+ if cl.offsetRight() {
+ cl.Render(a)
+ }
+ cl.PositionCursor(a)
+}
+
+func (cl *CommandLine) tillFuncLeft(f func(rune,rune) bool) int {
+ if cl.Index == 0 {
+ return 0
+ }
+ n := 1
+ t := []rune(cl.Text)
+ for {
+ i := cl.Index - n
+ if i == 0 || f(t[i - 1], t[i]) {
+ return n
+ }
+ n++
+ }
+}
+
+func (cl *CommandLine) tillFuncRight(f func(rune,rune) bool) int {
+ if cl.Index == len(cl.Text) {
+ return 0
+ }
+ n := 1
+ t := []rune(cl.Text)
+ for {
+ i := cl.Index + n
+ if i == len(cl.Text) || f(t[i - 1], t[i]) {
+ return n
+ }
+ n++
+ }
+}
+
+func isAlnum(r rune) bool {
+ return unicode.In(r, unicode.Letter, unicode.Digit)
+}
+
+func isWordStart(a, b rune) bool {
+ return !isAlnum(a) && isAlnum(b)
+}
+
+func (cl *CommandLine) CursorLeftWord(a *ansi.Writer) {
+ cl.CursorLeft(a, cl.tillFuncLeft(isWordStart))
+}
+
+func (cl *CommandLine) CursorRightWord(a *ansi.Writer) {
+ cl.CursorRight(a, cl.tillFuncRight(isWordStart))
+}
+
+func (cl *CommandLine) DeleteLeft(a *ansi.Writer, n int) {
+ if cl.Index == cl.Offset {
+ cl.Offset = max(0, cl.Offset - n)
+ }
+ n = min(cl.Index, n)
+ if n != 0 {
+ cl.Text = cl.Text[:cl.Index - n] + cl.Text[cl.Index:]
+ cl.Index = max(0, cl.Index - n)
+ cl.Render(a)
+ }
+}
+
+func (cl *CommandLine) DeleteRight(a *ansi.Writer, n int) {
+ if cl.Index != len(cl.Text) {
+ cl.Text = cl.Text[:cl.Index] + cl.Text[cl.Index + 1:]
+ cl.Render(a)
+ }
+}
+
+func (cl *CommandLine) DeleteWord(a *ansi.Writer) {
+ cl.DeleteLeft(a, cl.tillFuncLeft(isWordStart))
+}
+
+func (cl *CommandLine) UpHistory() {
+ for cl.HistoryIndex < len(cl.History) {
+ h := cl.History[len(cl.History) - cl.HistoryIndex - 1]
+ cl.HistoryIndex++
+ if len(cl.Search) == 0 || (strings.HasPrefix(h, cl.Search) && h != cl.Search) {
+ cl.Text = h
+ cl.Index = len(h)
+ cl.offsetRight()
+ return
+ }
+ }
+}
+
+func (cl *CommandLine) DownHistory() {
+ if cl.HistoryIndex == 1 {
+ cl.HistoryIndex = 0
+ cl.Text = cl.Search
+ cl.Index = len(cl.Search)
+ cl.offsetRight()
+ return
+ }
+ for cl.HistoryIndex > 0 {
+ cl.HistoryIndex--
+ h := cl.History[len(cl.History) - cl.HistoryIndex]
+ if len(cl.Text) == 0 || (strings.HasPrefix(h, cl.Search) && h != cl.Search) {
+ cl.Text = h
+ cl.Index = len(h)
+ cl.offsetRight()
+ return
+ }
+ }
+}
+
+func (cl *CommandLine) Clear(a *ansi.Writer) {
+ cl.Text = ""
+ cl.Index = 0
+ cl.Offset = 0
+ a.Column(2)
+ a.ClearLineRight()
+}
+
+func (cl *CommandLine) Accept(a *ansi.Writer) {
+ if len(cl.History) == 0 || cl.Text != cl.History[len(cl.History)-1] {
+ if len(cl.Text) > 0 {
+ cl.History = append(cl.History, cl.Text)
+ }
+ }
+ cl.HistoryIndex = 0
+ cl.Search = ""
+ cl.Clear(a)
+}
+
+func (cl *CommandLine) Reject(a *ansi.Writer) {
+ fmt.Print(ansi.Red)
+ cl.Render(a)
+ fmt.Print(ansi.Reset)
+ time.Sleep(100 * time.Millisecond)
+ cl.Render(a)
+}
+
+func (cl *CommandLine) Render(a *ansi.Writer) {
+ if cl.Width() == 0 {
+ return
+ }
+ a.Column(0)
+ a.ClearLineRight()
+ fmt.Print(":")
+ fmt.Print(cl.Text[cl.Offset:min(cl.Offset + cl.Width()-1, len(cl.Text))])
+ cl.PositionCursor(a)
+}
+
+func (cl *CommandLine) Handle(ev tui.Event, a *ansi.Writer) bool {
+ switch ev.Type {
+ case tui.KeyPrint:
+ cl.Text = cl.Text[:cl.Index] + string(ev.Key) + cl.Text[cl.Index:]
+ cl.Index++
+ cl.offsetRight()
+ cl.Render(a)
+ case tui.KeySpecial:
+ switch ev.Key {
+ case tui.CtrlM: // Enter
+ return true
+ case tui.ESC, tui.CtrlC:
+ cl.Clear(a)
+ case tui.BSpace:
+ cl.DeleteLeft(a, 1)
+ case tui.CtrlH, tui.CtrlW: // CtrlH = Ctrl+Backspace
+ cl.DeleteWord(a)
+ case tui.Del:
+ cl.DeleteRight(a, 1)
+ case tui.Tab:
+ // completion, _ := tabComplete(cl.Text[:cl.Index], commands)
+ completion := cl.TabComplete(cl.Text[:cl.Index])
+ cl.Text = completion + cl.Text[cl.Index:]
+ cl.Index = len(completion)
+ cl.offsetRight()
+ cl.Render(a)
+ case tui.Up:
+ cl.UpHistory()
+ cl.Render(a)
+ case tui.Down:
+ cl.DownHistory()
+ cl.Render(a)
+ case tui.Left:
+ cl.CursorLeft(a, 1)
+ case tui.Right:
+ cl.CursorRight(a, 1)
+ case tui.CtrlLeft:
+ cl.CursorLeftWord(a)
+ case tui.CtrlRight:
+ cl.CursorRightWord(a)
+ case tui.Home, tui.CtrlB:
+ cl.Index = 0
+ cl.Offset = 0
+ cl.Render(a)
+ case tui.End, tui.CtrlE:
+ cl.Index = len(cl.Text)
+ cl.offsetRight()
+ cl.Render(a)
+ }
+ }
+ if ev.Type == tui.KeyPrint || (ev.Key != tui.Up && ev.Key != tui.Down) {
+ cl.Search = cl.Text[:cl.Index]
+ }
+ return false
+}
+
+
+type UI struct {
+ Ansi *ansi.Writer
+ Width int
+ Height int
+ StatusBar StatusBar
+ Feed Feed
+ CommandLine CommandLine
+ Notice Notice
+}
+
+func NewUI(unseen func() (int,int,int), tabComplete func(string) string) *UI {
+ ui := &UI{Ansi: ansi.NewWriter(os.Stdout)}
+ ui.StatusBar.Unseen = unseen
+ ui.StatusBar.Width = func() int { return ui.Width }
+ ui.Feed.Width = func() int { return ui.Width }
+ ui.Feed.Height = func() int { return ui.Height - 2 }
+ ui.CommandLine.Width = func() int { return ui.Width }
+ ui.CommandLine.TabComplete = tabComplete
+ ui.Notice.Width = func() int { return ui.Width }
+ return ui
+}
+
+func (ui *UI) Scroll(n int) {
+ if n >= 0 {
+ ui.Feed.ScrollDown(n)
+ } else {
+ ui.Feed.ScrollUp(-n)
+ }
+ ui.Render()
+}
+
+func (ui *UI) Notify(col ansi.BasicColor, text string) {
+ ui.Notice.Color = col
+ ui.Notice.Text = text
+ ui.Ansi.MoveTo(0, ui.Height - 1)
+ ui.Notice.Render(ui.Ansi)
+ ui.CommandLine.PositionCursor(ui.Ansi)
+}
+
+func (ui *UI) Accept() {
+ ui.CommandLine.Accept(ui.Ansi)
+ ui.Notice.Text = ""
+ ui.Render()
+}
+
+func (ui *UI) Reject() {
+ ui.CommandLine.Reject(ui.Ansi)
+ ui.Notice.Text = ""
+ ui.Render()
+}
+
+func (ui *UI) Resize(width, height int) {
+ ui.Width, ui.Height = width, height
+}
+
+func (ui *UI) Render() {
+ ui.Ansi.CursorHide()
+ defer ui.Ansi.CursorShow()
+ ui.Ansi.Origin()
+ ui.StatusBar.Render(ui.Ansi)
+ ui.Feed.Render(ui.Ansi)
+ ui.Ansi.Up(1)
+ ui.Notice.Render(ui.Ansi)
+ ui.CommandLine.Render(ui.Ansi)
+ ui.CommandLine.PositionCursor(ui.Ansi)
+}
+
+func (ui *UI) RenderStatusBar() {
+ ui.Ansi.Origin()
+ ui.StatusBar.Render(ui.Ansi)
+ ui.Ansi.Down(ui.Feed.Height())
+ ui.CommandLine.PositionCursor(ui.Ansi)
+}
+
+func (ui *UI) Handle(ev tui.Event) (string, bool) {
+ switch ev.Type {
+ case tui.KeyPrint:
+ ui.CommandLine.Handle(ev, ui.Ansi)
+ case tui.KeySpecial:
+ switch ev.Key {
+ case tui.CtrlL:
+ ui.Notice.Text = ""
+ ui.Render()
+ case tui.CtrlJ:
+ ui.Scroll(1)
+ case tui.CtrlK:
+ ui.Scroll(-1)
+ case tui.CtrlD:
+ ui.Scroll(ui.Feed.Height() / 2)
+ case tui.CtrlU:
+ ui.Scroll(-ui.Feed.Height() / 2)
+ case tui.PgDn:
+ ui.Scroll(ui.Feed.Height())
+ case tui.PgUp:
+ ui.Scroll(-ui.Feed.Height())
+ default:
+ if ui.CommandLine.Handle(ev, ui.Ansi) {
+ return ui.CommandLine.Text, true
+ }
+ }
+ }
+ return "", false
+}