├── .gitignore ├── .mailmap ├── COPYING ├── Cargo.toml ├── Makefile ├── README.md └── src ├── controller.rs ├── http_client.rs ├── main.rs ├── state.rs └── view.rs /.gitignore: -------------------------------------------------------------------------------- 1 | /Cargo.lock 2 | /target 3 | -------------------------------------------------------------------------------- /.mailmap: -------------------------------------------------------------------------------- 1 | Arnav Singh 2 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "matrix-client" 3 | version = "0.1.0" 4 | license = "AGPL-3.0-only" 5 | authors = ["Arnav Singh "] 6 | edition = "2021" 7 | publish = false 8 | 9 | 10 | [dependencies] 11 | anyhow = { version = "1.0.14", default-features = false, features = [ 12 | "std", 13 | ] } 14 | chrono = { version = "0.4.20", default-features = false, features = [ 15 | "clock", # for chrono::Utc::now() 16 | "serde", # for chrono::serde 17 | ] } 18 | clap = { version = "4", default-features = false, features = [ 19 | "derive", # for #[derive(clap::Parser)] 20 | "std", # "`std` feature is currently required to build `clap`" 21 | ] } 22 | dirs = { version = "6", default-features = false } 23 | http = { version = "1", default-features = false } 24 | http-body-util = { version = "0.1", default-features = false } 25 | hyper = { version = "1", default-features = false } 26 | hyper-rustls = { version = "0.27", default-features = false, features = [ 27 | "http1", 28 | "ring", 29 | "tls12", 30 | "webpki-roots", 31 | ] } 32 | hyper-util = { version = "0.1", default-features = false, features = [ 33 | "client", 34 | "client-legacy", 35 | "http1", 36 | "tokio", 37 | ] } 38 | nix = { version = "0.29", default-features = false, features = [ 39 | "hostname", # for nix::unistd::gethostname 40 | "process", # for nix::unistd::Pid 41 | ] } 42 | rpassword = { version = "7", default-features = false } 43 | serde = { version = "1.0.103", default-features = false, features = [ 44 | "derive", 45 | ] } 46 | serde_json = { version = "1", default-features = false, features = ["std"] } 47 | sha2 = { version = "0.10", default-features = false } 48 | terminal = { git = "https://github.com/Arnavion/terminal", branch = "main" } 49 | thiserror = { version = "2", default-features = false } 50 | tokio = { version = "1", default-features = false, features = [ 51 | "rt", 52 | "time", 53 | ] } 54 | 55 | 56 | [lints.rust] 57 | rust_2018_idioms = "deny" 58 | warnings = "deny" 59 | 60 | 61 | [lints.clippy] 62 | all = { level = "deny", priority = -1 } 63 | pedantic = { level = "deny", priority = -1 } 64 | default_trait_access = "allow" 65 | similar_names = "allow" 66 | let_unit_value = "allow" 67 | too_many_lines = "allow" 68 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: clean default outdated print test 2 | 3 | default: 4 | cargo build --release 5 | 6 | clean: 7 | rm -rf Cargo.lock target/ 8 | 9 | outdated: 10 | cargo-outdated 11 | 12 | print: 13 | git status --porcelain 14 | 15 | test: 16 | cargo test --workspace 17 | cargo clippy --workspace --tests --examples 18 | cargo machete 19 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | TUI [Matrix](https://matrix.org/) client in Rust. 2 | 3 | 4 | # Features 5 | 6 | - `tmux` windows for rooms. 7 | - Read-only. 8 | - No E2EE support. Use something like [pantalaimon.](https://github.com/matrix-org/pantalaimon) 9 | 10 | 11 | # Dependencies 12 | 13 | - `tmux` - The TUI framework. 14 | - `/etc/machine-id` - Used to derive the device ID when logging in. 15 | 16 | 17 | # Usage 18 | 19 | 1. Build: 20 | 21 | ```sh 22 | cargo build --release 23 | ``` 24 | 25 | 1. Run: 26 | 27 | ```sh 28 | ./target/release/matrix-client 29 | ``` 30 | 31 | Example: 32 | 33 | ```sh 34 | ./target/release/matrix-client '@arnavion:arnavion.dev' 35 | ``` 36 | 37 | If you want to use a proxy like [pantalaimon](https://github.com/matrix-org/pantalaimon) instead of connecting directly to the homeserver, set the `MATRIX_HOMESERVER_BASE_URL` env var. 38 | 39 | Example: 40 | 41 | ```sh 42 | MATRIX_HOMESERVER_BASE_URL='http://[::1]:8009' ./target/release/matrix-client '@arnavion:arnavion.dev' 43 | ``` 44 | 45 | 46 | # TODO 47 | 48 | - Send events. 49 | - Mark events as read on homeserver. 50 | - Update events for redactions and replace. 51 | - Custom mouse events to support scrolling into prev batch. 52 | 53 | 54 | # License 55 | 56 | AGPL-3.0-only 57 | 58 | ``` 59 | matrix-client-rs 60 | 61 | https://github.com/Arnavion/matrix-client-rs 62 | 63 | Copyright 2021 Arnav Singh 64 | 65 | This program is free software: you can redistribute it and/or modify 66 | it under the terms of the GNU Affero General Public License as 67 | published by the Free Software Foundation, version 3 of the 68 | License. 69 | 70 | This program is distributed in the hope that it will be useful, 71 | but WITHOUT ANY WARRANTY; without even the implied warranty of 72 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 73 | GNU Affero General Public License for more details. 74 | 75 | You should have received a copy of the GNU Affero General Public License 76 | along with this program. If not, see . 77 | ``` 78 | -------------------------------------------------------------------------------- /src/controller.rs: -------------------------------------------------------------------------------- 1 | use anyhow::Context; 2 | 3 | pub(crate) fn run(user_id: String) -> anyhow::Result<()> { 4 | let runtime = 5 | tokio::runtime::Builder::new_current_thread() 6 | .enable_io() 7 | .enable_time() 8 | .build()?; 9 | let local_set = tokio::task::LocalSet::new(); 10 | 11 | () = local_set.block_on(&runtime, run_inner(user_id))?; 12 | Ok(()) 13 | } 14 | 15 | async fn run_inner(user_id: String) -> anyhow::Result<()> { 16 | use std::io::Write; 17 | 18 | let mut stdout = std::io::stdout().lock(); 19 | 20 | let mut stderr = std::io::stderr().lock(); 21 | 22 | let mut terminfo = terminal::terminfo::Terminfo::from_env().context("could not get terminfo")?; 23 | let (to_status_line, from_status_line) = terminfo.write_status_line(); 24 | 25 | _ = stdout.write_all(to_status_line); 26 | _ = stdout.write_all(user_id.as_bytes()); 27 | _ = stdout.write_all(from_status_line); 28 | _ = stdout.flush(); 29 | 30 | let mut state_manager = crate::state::Manager::new(&user_id).context("could not create state manager")?; 31 | 32 | let client = crate::http_client::Client::new(http::HeaderValue::from_static("github.com/Arnavion/matrix-client")); 33 | 34 | let homeserver_base_url = 35 | get_homeserver_base_url(&client, &user_id) 36 | .await.context("could not get homeserver base URL")?; 37 | 38 | let mut auth_header = 39 | login(&client, &mut state_manager, &homeserver_base_url, &user_id, &mut stderr) 40 | .await.context("could not log in")?; 41 | 42 | let sync_filter_id = 43 | create_sync_filter(&client, &homeserver_base_url, auth_header.clone(), &user_id) 44 | .await.context("could not create sync filter")?; 45 | 46 | let mut sync_next_batch = None; 47 | 48 | let mut view_fds: std::collections::BTreeMap = Default::default(); 49 | 50 | loop { 51 | #[derive(serde::Deserialize)] 52 | struct SyncResponse { 53 | next_batch: String, 54 | rooms: Option, 55 | } 56 | 57 | #[allow(non_camel_case_types)] 58 | #[derive(serde::Deserialize)] 59 | struct SyncResponse_Rooms { 60 | #[serde(default)] 61 | join: std::collections::BTreeMap, 62 | #[serde(default)] 63 | leave: std::collections::BTreeMap, 64 | } 65 | 66 | #[allow(non_camel_case_types)] 67 | #[derive(serde::Deserialize)] 68 | struct SyncResponse_JoinedRoom { 69 | state: SyncResponse_RoomState, 70 | summary: crate::SyncResponse_RoomSummary, 71 | timeline: SyncResponse_RoomTimeline, 72 | } 73 | 74 | #[allow(non_camel_case_types)] 75 | #[derive(serde::Deserialize)] 76 | struct SyncResponse_LeftRoom { 77 | state: SyncResponse_RoomState, 78 | timeline: SyncResponse_RoomTimeline, 79 | } 80 | 81 | #[allow(non_camel_case_types)] 82 | #[derive(serde::Deserialize)] 83 | struct SyncResponse_RoomState { 84 | events: Vec, 85 | } 86 | 87 | #[allow(non_camel_case_types)] 88 | #[derive(serde::Deserialize)] 89 | struct SyncResponse_RoomTimeline { 90 | events: Vec, 91 | } 92 | 93 | const SYNC_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(10); 94 | 95 | let path = 96 | if let Some(sync_next_batch) = sync_next_batch.as_deref() { 97 | format!( 98 | "/_matrix/client/v3/sync?filter={}&since={}&timeout={}", 99 | PercentEncode(&sync_filter_id), 100 | PercentEncode(sync_next_batch), 101 | SYNC_TIMEOUT.as_millis(), 102 | ) 103 | } 104 | else { 105 | format!("/_matrix/client/v3/sync?filter={}", PercentEncode(&sync_filter_id)) 106 | }; 107 | 108 | let sync: SyncResponse = loop { 109 | _ = write!(stdout, "\rSyncing at {} ... ", chrono::Local::now().to_rfc3339_opts(chrono::SecondsFormat::Secs, false)); 110 | stdout.flush()?; 111 | 112 | let response = 113 | client.request( 114 | &homeserver_base_url, 115 | &path, 116 | Some(auth_header.clone()), 117 | crate::http_client::RequestMethod::Get::<()>, 118 | ); 119 | let response = tokio::time::timeout(SYNC_TIMEOUT + std::time::Duration::from_secs(10), response); 120 | match response.await { 121 | Ok(Ok(crate::http_client::HomeserverResponse::Ok(response))) => { 122 | _ = write!(stdout, "\rSynced at {} ", chrono::Local::now().to_rfc3339_opts(chrono::SecondsFormat::Secs, false)); 123 | stdout.flush()?; 124 | break response; 125 | }, 126 | 127 | Ok(Ok(crate::http_client::HomeserverResponse::Err(err))) => { 128 | _ = writeln!(stderr, "\nSync error: {err:?} "); 129 | 130 | let mut state = state_manager.load().context("could not load state")?; 131 | state.access_token = None; 132 | () = state_manager.save(&state).context("could not save state")?; 133 | 134 | _ = writeln!(stdout); 135 | _ = writeln!(stderr, "Reconnecting to homeserver..."); 136 | auth_header = 137 | login(&client, &mut state_manager, &homeserver_base_url, &user_id, &mut stderr) 138 | .await.context("could not log in")?; 139 | }, 140 | 141 | Ok(Err(err)) => { 142 | _ = writeln!(stderr, "\nSync error: {err:?} "); 143 | tokio::time::sleep(std::time::Duration::from_secs(1)).await; 144 | }, 145 | 146 | Err(tokio::time::error::Elapsed { .. }) => { 147 | _ = writeln!(stderr, "timed out"); 148 | }, 149 | } 150 | }; 151 | 152 | sync_next_batch = Some(sync.next_batch); 153 | 154 | let mut to_write: std::collections::BTreeMap> = Default::default(); 155 | 156 | if let Some(rooms) = sync.rooms { 157 | for (room_id, room) in rooms.join { 158 | let lines = to_write.entry(room_id).or_default(); 159 | 160 | lines.push(crate::RoomViewLine::Summary { summary: room.summary }); 161 | 162 | for event in room.state.events { 163 | lines.push(crate::RoomViewLine::State { event }); 164 | } 165 | 166 | for event in room.timeline.events { 167 | lines.push(crate::RoomViewLine::Timeline { event }); 168 | } 169 | } 170 | 171 | for (room_id, room) in rooms.leave { 172 | let lines = to_write.entry(room_id).or_default(); 173 | 174 | for event in room.state.events { 175 | lines.push(crate::RoomViewLine::State { event }); 176 | } 177 | 178 | for event in room.timeline.events { 179 | lines.push(crate::RoomViewLine::Timeline { event }); 180 | } 181 | } 182 | } 183 | 184 | for (room_id, lines) in to_write { 185 | let f = match view_fds.entry(room_id) { 186 | std::collections::btree_map::Entry::Vacant(entry) => { 187 | let (reader, writer) = std::io::pipe().with_context(|| format!("could not create pipe for {}", entry.key()))?; 188 | 189 | let view_fd = std::os::fd::IntoRawFd::into_raw_fd(reader); 190 | 191 | let mut args = std::env::args_os(); 192 | let arg0 = args.next().context("argv[0] is not set")?; 193 | 194 | let mut view = crate::tmux(&user_id)?; 195 | view.args(["new-window", "-d"]); 196 | if let Ok(value) = std::env::var("DEBUG") { 197 | view.args(["-e", &format!("DEBUG={value}")]); 198 | } 199 | view.arg(arg0); 200 | view.args([&user_id, "_view", entry.key()]); 201 | view.arg(format!("/proc/{}/fd/{view_fd}", nix::unistd::Pid::this().as_raw())); 202 | let _ = 203 | view.output() 204 | .with_context(|| format!("could not create view for {}", entry.key()))?; 205 | 206 | entry.insert(writer) 207 | }, 208 | 209 | std::collections::btree_map::Entry::Occupied(entry) => entry.into_mut(), 210 | }; 211 | 212 | for line in lines { 213 | () = serde_json::to_writer(&mut *f, &line).context("could not write view line")?; 214 | f.flush().context("could not write view line")?; 215 | } 216 | } 217 | } 218 | } 219 | 220 | async fn get_homeserver_base_url(client: &crate::http_client::Client, user_id: &str) -> anyhow::Result { 221 | #[derive(serde::Deserialize)] 222 | struct ClientDiscoveryInfoResponse { 223 | #[serde(rename = "m.homeserver")] 224 | m_homeserver: ClientDiscoveryInfoResponse_MHomeserver, 225 | } 226 | 227 | #[allow(non_camel_case_types)] 228 | #[derive(serde::Deserialize)] 229 | struct ClientDiscoveryInfoResponse_MHomeserver { 230 | base_url: String, 231 | } 232 | 233 | #[derive(serde::Deserialize)] 234 | struct ClientVersions { 235 | versions: Vec, 236 | } 237 | 238 | let homeserver_base_url = 239 | if let Ok(homeserver_base_url) = std::env::var("MATRIX_HOMESERVER_BASE_URL") { 240 | homeserver_base_url 241 | } 242 | else { 243 | let (_, homeserver_name) = user_id.split_once(':').context("could not extract homeserver name from user ID")?; 244 | 245 | let ClientDiscoveryInfoResponse { m_homeserver: ClientDiscoveryInfoResponse_MHomeserver { base_url: homeserver_base_url } } = 246 | client.request(&format!("https://{homeserver_name}"), "/.well-known/matrix/client", None, crate::http_client::RequestMethod::Get::<()>) 247 | .await.context("could not get client discovery info")? 248 | .into_result() 249 | .context("could not get client discovery info")?; 250 | homeserver_base_url 251 | }; 252 | 253 | // TODO: pantalaimon doesn't support this until after the first login, because it doesn't have a default implementation. 254 | // Should this be made optional? 255 | let ClientVersions { versions } = 256 | client.request(&homeserver_base_url, "/_matrix/client/versions", None, crate::http_client::RequestMethod::Get::<()>) 257 | .await.context("could not get client versions supported by homeserver")? 258 | .into_result() 259 | .context("could not get client versions supported by homeserver")?; 260 | if !versions.into_iter().any(|version| version == "v1.9") { 261 | return Err(anyhow::anyhow!("homeserver does not support client version v1.9")); 262 | } 263 | 264 | Ok(homeserver_base_url) 265 | } 266 | 267 | async fn login( 268 | client: &crate::http_client::Client, 269 | state_manager: &mut crate::state::Manager, 270 | homeserver_base_url: &str, 271 | user_id: &str, 272 | stderr: &mut impl std::io::Write, 273 | ) -> anyhow::Result { 274 | let mut state = state_manager.load().context("could not load state")?; 275 | 276 | let access_token = 277 | if let Some(access_token) = state.access_token { 278 | access_token 279 | } 280 | else { 281 | #[derive(serde::Deserialize)] 282 | struct SupportedLoginTypesResponse { 283 | flows: Vec, 284 | } 285 | 286 | #[allow(non_camel_case_types)] 287 | #[derive(serde::Deserialize)] 288 | struct SupportedLoginTypesResponse_Flow { 289 | r#type: String, 290 | } 291 | 292 | #[derive(serde::Serialize)] 293 | struct LoginRequest<'a> { 294 | r#type: &'static str, 295 | identifier: LoginRequest_Identifier<'a>, 296 | password: &'a str, 297 | device_id: &'a str, 298 | initial_device_display_name: &'a str, 299 | } 300 | 301 | #[allow(non_camel_case_types)] 302 | #[derive(serde::Serialize)] 303 | struct LoginRequest_Identifier<'a> { 304 | r#type: &'static str, 305 | user: &'a str, 306 | } 307 | 308 | #[derive(serde::Deserialize)] 309 | struct LoginResponse { 310 | access_token: String, 311 | } 312 | 313 | // TODO: pantalaimon doesn't support this until after the first login, because it doesn't have a default implementation. 314 | // Should this be made optional? 315 | let SupportedLoginTypesResponse { flows } = 316 | client.request(homeserver_base_url, "/_matrix/client/v3/login", None, crate::http_client::RequestMethod::Get::<()>) 317 | .await.context("could not get supported login types")? 318 | .into_result() 319 | .context("could not get supported login types")?; 320 | if !flows.into_iter().any(|SupportedLoginTypesResponse_Flow { r#type }| r#type == "m.login.password") { 321 | return Err(anyhow::anyhow!("homeserver does not supported password login")); 322 | } 323 | 324 | let device_id = { 325 | use sha2::Digest; 326 | 327 | struct HexDisplay<'a>(&'a [u8]); 328 | 329 | impl std::fmt::Display for HexDisplay<'_> { 330 | fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { 331 | for b in self.0 { 332 | write!(f, "{b:02x}")?; 333 | } 334 | Ok(()) 335 | } 336 | } 337 | 338 | let mut machine_id = std::fs::read("/etc/machine-id").context("could not read /etc/machine-id")?; 339 | if machine_id.last().copied() == Some(b'\n') { 340 | machine_id.pop(); 341 | } 342 | 343 | let unique_id = sha2::Sha256::new().chain_update(&machine_id).finalize(); 344 | 345 | format!("matrix-client:{}", HexDisplay(&unique_id)) 346 | }; 347 | 348 | let initial_device_display_name = { 349 | let hostname = nix::unistd::gethostname().context("could not get hostname")?; 350 | format!("matrix-client ({})", hostname.to_string_lossy()) 351 | }; 352 | 353 | let access_token = loop { 354 | let password = rpassword::prompt_password("Enter password: ").context("could not read password")?; 355 | 356 | let login_response = 357 | client.request(homeserver_base_url, "/_matrix/client/v3/login", None, crate::http_client::RequestMethod::Post(LoginRequest { 358 | r#type: "m.login.password", 359 | identifier: LoginRequest_Identifier { 360 | r#type: "m.id.user", 361 | user: user_id, 362 | }, 363 | password: &password, 364 | device_id: &device_id, 365 | initial_device_display_name: &initial_device_display_name, 366 | })).await.context("could not send login request")?; 367 | match login_response { 368 | crate::http_client::HomeserverResponse::Ok(LoginResponse { access_token }) => break access_token, 369 | 370 | crate::http_client::HomeserverResponse::Err(err) => { 371 | _ = writeln!(stderr, "{err}"); 372 | }, 373 | } 374 | }; 375 | 376 | state.access_token = Some(access_token.clone()); 377 | 378 | () = state_manager.save(&state).context("could not save state")?; 379 | 380 | access_token 381 | }; 382 | 383 | let auth_header = format!("Bearer {access_token}").parse().context("could not construct auth header from access token")?; 384 | Ok(auth_header) 385 | } 386 | 387 | async fn create_sync_filter( 388 | client: &crate::http_client::Client, 389 | homeserver_base_url: &str, 390 | auth_header: http::HeaderValue, 391 | user_id: &str, 392 | ) -> anyhow::Result { 393 | #[derive(serde::Serialize)] 394 | struct CreateFilterRequest<'a> { 395 | presence: CreateFilterRequest_EventFilter<'a>, 396 | room: CreateFilterRequest_RoomFilter<'a>, 397 | } 398 | 399 | #[allow(non_camel_case_types)] 400 | #[derive(serde::Serialize)] 401 | struct CreateFilterRequest_EventFilter<'a> { 402 | not_types: &'a [&'a str], 403 | } 404 | 405 | #[allow(non_camel_case_types)] 406 | #[derive(serde::Serialize)] 407 | struct CreateFilterRequest_RoomFilter<'a> { 408 | ephemeral: CreateFilterRequest_RoomEventFilter<'a>, 409 | include_leave: bool, 410 | state: CreateFilterRequest_StateFilter<'a>, 411 | timeline: CreateFilterRequest_RoomEventFilter<'a>, 412 | } 413 | 414 | #[allow(non_camel_case_types)] 415 | #[derive(serde::Serialize)] 416 | struct CreateFilterRequest_RoomEventFilter<'a> { 417 | lazy_load_members: bool, 418 | not_types: &'a [&'a str], 419 | } 420 | 421 | #[allow(non_camel_case_types)] 422 | #[derive(serde::Serialize)] 423 | struct CreateFilterRequest_StateFilter<'a> { 424 | lazy_load_members: bool, 425 | not_types: &'a [&'a str], 426 | } 427 | 428 | #[derive(serde::Deserialize)] 429 | struct CreateFilterResponse { 430 | filter_id: String, 431 | } 432 | 433 | let CreateFilterResponse { filter_id } = 434 | client.request( 435 | homeserver_base_url, 436 | &format!("/_matrix/client/v3/user/{}/filter", PercentEncode(user_id)), 437 | Some(auth_header), 438 | crate::http_client::RequestMethod::Post(CreateFilterRequest { 439 | presence: CreateFilterRequest_EventFilter { 440 | not_types: &["*"], 441 | }, 442 | room: CreateFilterRequest_RoomFilter { 443 | ephemeral: CreateFilterRequest_RoomEventFilter { 444 | lazy_load_members: true, 445 | not_types: &["*"], 446 | }, 447 | include_leave: true, 448 | state: CreateFilterRequest_StateFilter { 449 | lazy_load_members: true, 450 | not_types: &[ 451 | "m.reaction", 452 | "m.room.avatar", 453 | "m.room.member", 454 | ], 455 | }, 456 | timeline: CreateFilterRequest_RoomEventFilter { 457 | lazy_load_members: true, 458 | not_types: &[ 459 | "m.reaction", 460 | "m.room.avatar", 461 | "m.room.member", 462 | ], 463 | }, 464 | }, 465 | }, 466 | )) 467 | .await.context("could not create sync filter")? 468 | .into_result() 469 | .context("could not create sync filter")?; 470 | Ok(filter_id) 471 | } 472 | 473 | struct PercentEncode<'a>(&'a str); 474 | 475 | impl std::fmt::Display for PercentEncode<'_> { 476 | fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { 477 | for b in self.0.as_bytes() { 478 | write!(f, "%{b:02x}")?; 479 | } 480 | Ok(()) 481 | } 482 | } 483 | -------------------------------------------------------------------------------- /src/http_client.rs: -------------------------------------------------------------------------------- 1 | use anyhow::Context; 2 | 3 | pub(crate) struct Client { 4 | inner: hyper_util::client::legacy::Client< 5 | hyper_rustls::HttpsConnector, 6 | http_body_util::Full>, 7 | >, 8 | user_agent: http::HeaderValue, 9 | } 10 | 11 | impl Client { 12 | pub(crate) fn new(user_agent: http::HeaderValue) -> Self { 13 | let connector = 14 | hyper_rustls::HttpsConnectorBuilder::new() 15 | .with_webpki_roots() 16 | .https_or_http() 17 | .enable_http1() 18 | .build(); 19 | 20 | let inner = hyper_util::client::legacy::Client::builder(hyper_util::rt::TokioExecutor::new()).build(connector); 21 | 22 | Client { 23 | inner, 24 | user_agent, 25 | } 26 | } 27 | 28 | pub(crate) async fn request( 29 | &self, 30 | base: &str, 31 | path: &str, 32 | mut auth_header: Option, 33 | mut method: RequestMethod, 34 | ) -> anyhow::Result> 35 | where 36 | TBody: serde::Serialize, 37 | TResponse: serde::de::DeserializeOwned, 38 | { 39 | enum Response { 40 | Json(serde_json::Value), 41 | Redirect(http::Uri), 42 | } 43 | 44 | // This fn encapsulates the non-generic parts of `request` to reduce code size from monomorphization. 45 | async fn request_inner( 46 | client: &Client, 47 | req: hyper::Request>, 48 | uri: http::Uri, 49 | auth_header: Option, 50 | ) -> anyhow::Result { 51 | let mut req = req.map(|body| http_body_util::Full::new(body.into())); 52 | 53 | *req.uri_mut() = uri; 54 | 55 | if let Some(auth_header) = auth_header { 56 | req.headers_mut().append(http::header::AUTHORIZATION, auth_header); 57 | } 58 | 59 | req.headers_mut().insert(http::header::ACCEPT, APPLICATION_JSON); 60 | req.headers_mut().insert(http::header::USER_AGENT, client.user_agent.clone()); 61 | 62 | let res = client.inner.request(req).await.context("could not execute request")?; 63 | 64 | let (http::response::Parts { status, mut headers, .. }, body) = res.into_parts(); 65 | 66 | Ok(if status.is_redirection() { 67 | let location = 68 | headers.remove(http::header::LOCATION) 69 | .with_context(|| format!("could not execute request: received {status} but no location header"))?; 70 | let location = location.as_bytes(); 71 | let location = 72 | location.try_into() 73 | .context("could not execute request: received redirect resposne with malformed location header")?; 74 | Response::Redirect(location) 75 | } 76 | else { 77 | let content_type = headers.remove(http::header::CONTENT_TYPE); 78 | let content_type = content_type.as_ref(); 79 | #[allow(clippy::borrow_interior_mutable_const)] 80 | if content_type != Some(&APPLICATION_JSON) && content_type != Some(&APPLICATION_JSON_CHARSET_UTF8) { 81 | return Err(anyhow::anyhow!("could not execute request: unexpected content-type {content_type:?}")); 82 | } 83 | let body = http_body_util::BodyExt::collect(body).await.context("could not execute request: could not read response body")?.aggregate(); 84 | let body = hyper::body::Buf::reader(body); 85 | let body: serde_json::Value = serde_json::from_reader(body).context("could not execute request")?; 86 | Response::Json(body) 87 | }) 88 | } 89 | 90 | let mut uri = format!("{base}{path}").try_into().context("could not request")?; 91 | 92 | loop { 93 | let follow_redirect = matches!(method, RequestMethod::Get) && auth_header.is_none(); 94 | 95 | let req = match method { 96 | RequestMethod::Get => { 97 | let mut req = http::Request::new(Default::default()); 98 | *req.method_mut() = http::Method::GET; 99 | req 100 | }, 101 | RequestMethod::Post(body) => { 102 | let body = serde_json::to_vec(&body).context("could not request")?; 103 | let mut req = http::Request::new(body); 104 | *req.method_mut() = http::Method::POST; 105 | req.headers_mut().append(http::header::CONTENT_TYPE, APPLICATION_JSON); 106 | req 107 | }, 108 | }; 109 | 110 | let body = request_inner(self, req, uri, auth_header).await?; 111 | 112 | match body { 113 | Response::Json(body) => 114 | break Ok(if let Ok(err) = serde::Deserialize::deserialize(&body) { 115 | HomeserverResponse::Err(err) 116 | } 117 | else { 118 | let body = serde::Deserialize::deserialize(body).context("could not execute request")?; 119 | HomeserverResponse::Ok(body) 120 | }), 121 | 122 | Response::Redirect(redirect_uri) if follow_redirect => { 123 | uri = redirect_uri; 124 | auth_header = None; 125 | method = RequestMethod::Get; 126 | }, 127 | 128 | Response::Redirect(_) => 129 | return Err(anyhow::anyhow!("could not execute request: unredirectable request got redirect response")), 130 | } 131 | } 132 | } 133 | } 134 | 135 | pub(crate) enum RequestMethod { 136 | Get, 137 | Post(TBody), 138 | } 139 | 140 | #[derive(Debug, serde::Deserialize, thiserror::Error)] 141 | #[error("{errcode}: {error}")] 142 | pub(crate) struct HomeserverError { 143 | pub(crate) errcode: String, 144 | pub(crate) error: String, 145 | } 146 | 147 | pub(crate) enum HomeserverResponse { 148 | Ok(TResponse), 149 | Err(HomeserverError), 150 | } 151 | 152 | impl HomeserverResponse { 153 | pub(crate) fn into_result(self) -> Result { 154 | match self { 155 | HomeserverResponse::Ok(response) => Ok(response), 156 | HomeserverResponse::Err(err) => Err(err), 157 | } 158 | } 159 | } 160 | 161 | #[allow(clippy::declare_interior_mutable_const)] 162 | const APPLICATION_JSON: http::HeaderValue = http::HeaderValue::from_static("application/json"); 163 | 164 | #[allow(clippy::declare_interior_mutable_const)] 165 | const APPLICATION_JSON_CHARSET_UTF8: http::HeaderValue = http::HeaderValue::from_static("application/json; charset=utf-8"); 166 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | mod controller; 2 | mod http_client; 3 | mod state; 4 | mod view; 5 | 6 | use anyhow::Context; 7 | 8 | #[derive(clap::Parser)] 9 | struct Options { 10 | user_id: String, 11 | 12 | #[command(subcommand)] 13 | command: Option, 14 | } 15 | 16 | #[derive(clap::Parser)] 17 | enum Command { 18 | Config { 19 | #[command(subcommand)] 20 | options: ConfigOptions, 21 | }, 22 | 23 | #[command(name = "_controller", hide(true))] 24 | Controller, 25 | 26 | #[command(name = "_view", hide(true))] 27 | View { 28 | room_id: String, 29 | 30 | lines: std::path::PathBuf, 31 | }, 32 | } 33 | 34 | #[derive(clap::Parser)] 35 | enum ConfigOptions { 36 | Logout, 37 | } 38 | 39 | fn main() -> anyhow::Result<()> { 40 | let Options { user_id, command } = clap::Parser::parse(); 41 | match command { 42 | None => { 43 | let mut args = std::env::args_os(); 44 | let arg0 = args.next().context("argv[0] is not set")?; 45 | 46 | let mut controller = tmux(&user_id)?; 47 | controller.args(["new-session", "-s", "matrix-client", "-n", &user_id]); 48 | if let Ok(value) = std::env::var("DEBUG") { 49 | controller.args(["-e", &format!("DEBUG={value}")]); 50 | } 51 | if let Ok(value) = std::env::var("MATRIX_HOMESERVER_BASE_URL") { 52 | controller.args(["-e", &format!("MATRIX_HOMESERVER_BASE_URL={value}")]); 53 | } 54 | controller.arg(arg0); 55 | controller.args([&user_id, "_controller"]); 56 | let err = std::os::unix::process::CommandExt::exec(&mut controller); 57 | return Err(err).context("execvp failed"); 58 | }, 59 | 60 | Some(Command::Config { options: ConfigOptions::Logout }) => { 61 | use std::io::Write; 62 | 63 | let mut stderr = std::io::stderr().lock(); 64 | 65 | let mut state_manager = state::Manager::new(&user_id).context("could not create state manager")?; 66 | let mut state = state_manager.load().context("could not load state")?; 67 | 68 | if let Some(_access_token) = state.access_token.take() { 69 | // TODO: Log out from the homeserver too 70 | // https://matrix.org/docs/spec/client_server/r0.6.1#id206 71 | } 72 | 73 | () = state_manager.save(&state).context("could not save state")?; 74 | 75 | _ = writeln!(stderr, "Done."); 76 | }, 77 | 78 | Some(Command::Controller) => controller::run(user_id)?, 79 | 80 | Some(Command::View { room_id, lines }) => view::run(&user_id, &room_id, &lines)?, 81 | } 82 | 83 | Ok(()) 84 | } 85 | 86 | fn tmux(user_id: &str) -> anyhow::Result { 87 | let mut command = std::process::Command::new("tmux"); 88 | 89 | let mut state_manager = state::Manager::new(user_id).context("could not create state manager")?; 90 | let state = state_manager.load().context("could not load state")?; 91 | if let Some(tmux_conf) = state.tmux_conf.as_ref() { 92 | command.arg("-f"); 93 | command.arg(tmux_conf); 94 | } 95 | 96 | Ok(command) 97 | } 98 | 99 | #[derive(Debug, serde::Deserialize, serde::Serialize)] 100 | enum RoomViewLine { 101 | Summary { 102 | summary: SyncResponse_RoomSummary, 103 | }, 104 | 105 | State { 106 | event: SyncResponse_RoomStateEvent, 107 | }, 108 | 109 | Timeline { 110 | event: SyncResponse_RoomEvent, 111 | }, 112 | } 113 | 114 | #[allow(non_camel_case_types)] 115 | #[derive(Debug, serde::Deserialize, serde::Serialize)] 116 | struct SyncResponse_RoomSummary { 117 | #[serde(default, rename = "m.heroes")] 118 | heroes: Vec, 119 | 120 | #[serde(rename = "m.invited_member_count")] 121 | invited_member_count: Option, 122 | 123 | #[serde(rename = "m.joined_member_count")] 124 | joined_member_count: Option, 125 | } 126 | 127 | #[allow(non_camel_case_types)] 128 | #[derive(Debug, serde::Deserialize, serde::Serialize)] 129 | struct SyncResponse_RoomStateEvent { 130 | content: serde_json::Map, 131 | #[serde(with = "chrono::serde::ts_milliseconds")] 132 | origin_server_ts: chrono::DateTime, 133 | sender: String, 134 | r#type: String, 135 | unsigned: Option>, 136 | } 137 | 138 | #[allow(non_camel_case_types)] 139 | #[derive(Debug, serde::Deserialize, serde::Serialize)] 140 | struct SyncResponse_RoomEvent { 141 | content: serde_json::Map, 142 | #[serde(with = "chrono::serde::ts_milliseconds")] 143 | origin_server_ts: chrono::DateTime, 144 | sender: String, 145 | r#type: String, 146 | unsigned: Option>, 147 | } 148 | 149 | macro_rules! define_events { 150 | ( 151 | $( 152 | $s:literal => $ident:ident { $($field_name:ident : $field_ty:ty),* }, 153 | )* 154 | ) => { 155 | #[allow(non_camel_case_types)] 156 | enum Event { 157 | $($ident { $($field_name : $field_ty ,)* },)* 158 | 159 | M_Room_Message(Event_M_Room_Message_Content), 160 | 161 | Unknown { 162 | r#type: String, 163 | content: serde_json::Map, 164 | }, 165 | } 166 | 167 | impl Event { 168 | fn parse( 169 | r#type: String, 170 | mut content: serde_json::Map, 171 | unsigned: Option>, 172 | ) -> Result { 173 | Ok(match &*r#type { 174 | $( 175 | $s => { 176 | #[derive(serde::Deserialize)] 177 | struct Content { 178 | $($field_name : $field_ty ,)* 179 | } 180 | 181 | let Content { $($field_name),* } = serde::Deserialize::deserialize(serde_json::Value::Object(content))?; 182 | Event::$ident { $($field_name),* } 183 | }, 184 | )* 185 | 186 | "m.room.message" => { 187 | let msgtype = content.remove("msgtype"); 188 | let msgtype = match msgtype { 189 | Some(serde_json::Value::String(s)) => Some(s), 190 | Some(msgtype) => return Err(serde::de::Error::custom(format!(r#"non-string "msgtype" in event {type} {content:?}: {msgtype:?}"#))), 191 | None => None, 192 | }; 193 | let content = match (msgtype.as_deref(), unsigned) { 194 | (Some("m.emote"), _) => Event_M_Room_Message_Content::Emote(serde::Deserialize::deserialize(serde_json::Value::Object(content))?), 195 | 196 | (Some("m.file"), _) => Event_M_Room_Message_Content::File(serde::Deserialize::deserialize(serde_json::Value::Object(content))?), 197 | 198 | (Some("m.image"), _) => Event_M_Room_Message_Content::Image(serde::Deserialize::deserialize(serde_json::Value::Object(content))?), 199 | 200 | (Some("m.notice"), _) => Event_M_Room_Message_Content::Notice(serde::Deserialize::deserialize(serde_json::Value::Object(content))?), 201 | 202 | (Some("m.text"), _) => Event_M_Room_Message_Content::Text(serde::Deserialize::deserialize(serde_json::Value::Object(content))?), 203 | 204 | (None, Some(unsigned)) => Event_M_Room_Message_Content::Redacted(serde::Deserialize::deserialize(serde_json::Value::Object(unsigned))?), 205 | 206 | (_, unsigned) => Event_M_Room_Message_Content::Other(Event_M_Room_Message_Content_Other { 207 | msgtype, 208 | content, 209 | unsigned, 210 | }), 211 | }; 212 | Event::M_Room_Message(content) 213 | }, 214 | 215 | _ => Event::Unknown { r#type, content }, 216 | }) 217 | } 218 | } 219 | }; 220 | } 221 | 222 | define_events! { 223 | "m.room.canonical_alias" => M_Room_CanonicalAlias { alias: Option }, 224 | "m.room.create" => M_Room_Create { room_version: Option }, 225 | "m.room.encrypted" => M_Room_Encrypted { algorithm: Option, ciphertext: Option, device_id: Option, sender_key: Option, session_id: Option }, 226 | "m.room.encryption" => M_Room_Encryption { algorithm: String }, 227 | "m.room.guest_access" => M_Room_GuestAccess { guest_access: String }, 228 | "m.room.history_visibility" => M_Room_HistoryVisibility { history_visibility: String }, 229 | "m.room.join_rules" => M_Room_JoinRules { join_rule: String }, 230 | "m.room.name" => M_Room_Name { name: String }, 231 | "m.room.power_levels" => M_Room_PowerLevels { users: std::collections::BTreeMap, users_default: Option }, 232 | "m.room.related_groups" => M_Room_RelatedGroups { groups: Vec }, 233 | "m.room.tombstone" => M_Room_Tombstone { body: String, replacement_room: String }, 234 | "m.room.topic" => M_Room_Topic { topic: String }, 235 | } 236 | 237 | #[allow(non_camel_case_types)] 238 | enum Event_M_Room_Message_Content { 239 | Emote(Event_M_Room_Message_Content_Emote), 240 | File(Event_M_Room_Message_Content_File), 241 | Image(Event_M_Room_Message_Content_Image), 242 | Notice(Event_M_Room_Message_Content_Notice), 243 | Redacted(Event_M_Room_Message_Content_Redacted), 244 | Text(Event_M_Room_Message_Content_Text), 245 | Other(Event_M_Room_Message_Content_Other), 246 | } 247 | 248 | #[allow(non_camel_case_types)] 249 | #[derive(serde::Deserialize)] 250 | struct Event_M_Room_Message_Content_Emote { 251 | body: String, 252 | } 253 | 254 | #[allow(non_camel_case_types)] 255 | #[derive(serde::Deserialize)] 256 | struct Event_M_Room_Message_Content_File { 257 | body: String, 258 | url: String, 259 | } 260 | 261 | #[allow(non_camel_case_types)] 262 | #[derive(serde::Deserialize)] 263 | struct Event_M_Room_Message_Content_Image { 264 | body: String, 265 | url: String, 266 | } 267 | 268 | #[allow(non_camel_case_types)] 269 | #[derive(serde::Deserialize)] 270 | struct Event_M_Room_Message_Content_Notice { 271 | body: String, 272 | } 273 | 274 | #[allow(non_camel_case_types)] 275 | #[derive(serde::Deserialize)] 276 | struct Event_M_Room_Message_Content_Redacted { 277 | redacted_because: Option, 278 | redacted_by: Option, 279 | } 280 | 281 | #[allow(non_camel_case_types)] 282 | #[derive(serde::Deserialize)] 283 | struct Event_M_Room_Message_Content_Text { 284 | body: String, 285 | } 286 | 287 | #[allow(non_camel_case_types)] 288 | struct Event_M_Room_Message_Content_Other { 289 | msgtype: Option, 290 | content: serde_json::Map, 291 | unsigned: Option>, 292 | } 293 | -------------------------------------------------------------------------------- /src/state.rs: -------------------------------------------------------------------------------- 1 | #[derive(Debug, thiserror::Error)] 2 | pub(crate) enum Error { 3 | #[error("could not get user config directory")] 4 | GetConfigDirectory, 5 | 6 | #[error("could not load config")] 7 | LoadIo(#[source] std::io::Error), 8 | 9 | #[error("could not load config")] 10 | LoadJson(#[source] serde_json::Error), 11 | 12 | #[error("could not save config")] 13 | SaveIo(#[source] std::io::Error), 14 | 15 | #[error("could not save config")] 16 | SaveJson(#[source] serde_json::Error), 17 | } 18 | 19 | pub(crate) struct Manager { 20 | path: std::path::PathBuf, 21 | } 22 | 23 | impl Manager { 24 | pub(crate) fn new(user_id: &str) -> Result { 25 | let mut path = dirs::config_dir().ok_or(Error::GetConfigDirectory)?; 26 | path.push("matrix-client"); 27 | path.push(format!("{user_id}.json")); 28 | Ok(Manager { 29 | path, 30 | }) 31 | } 32 | 33 | pub(crate) fn load(&mut self) -> Result { 34 | if let Some(parent) = &self.path.parent() { 35 | () = std::fs::create_dir_all(parent).map_err(Error::LoadIo)?; 36 | } 37 | 38 | match std::fs::File::open(&self.path) { 39 | Ok(file) => serde_json::from_reader(file).map_err(Error::LoadJson), 40 | Err(err) if err.kind() == std::io::ErrorKind::NotFound => { 41 | let state = Default::default(); 42 | self.save(&state)?; 43 | Ok(state) 44 | }, 45 | Err(err) => Err(Error::LoadIo(err)), 46 | } 47 | } 48 | 49 | pub(crate) fn save(&mut self, state: &State) -> Result<(), Error> { 50 | if let Some(parent) = &self.path.parent() { 51 | () = std::fs::create_dir_all(parent).map_err(Error::SaveIo)?; 52 | } 53 | 54 | match std::fs::File::create(&self.path) { 55 | Ok(mut file) => { 56 | () = serde_json::to_writer(&mut file, state).map_err(Error::SaveJson)?; 57 | () = std::io::Write::write_all(&mut file, b"\n").map_err(Error::SaveIo)?; 58 | Ok(()) 59 | }, 60 | Err(err) => Err(Error::SaveIo(err)), 61 | } 62 | } 63 | } 64 | 65 | #[derive(Default, serde::Deserialize, serde::Serialize)] 66 | pub(crate) struct State { 67 | pub(crate) access_token: Option, 68 | 69 | pub(crate) tmux_conf: Option, 70 | } 71 | -------------------------------------------------------------------------------- /src/view.rs: -------------------------------------------------------------------------------- 1 | use anyhow::Context; 2 | 3 | pub(crate) fn run(user_id: &str, room_id: &str, lines: &std::path::Path) -> anyhow::Result<()> { 4 | use std::io::Write; 5 | 6 | let mut stdout = std::io::stdout().lock(); 7 | 8 | let mut stderr = std::io::stderr().lock(); 9 | 10 | let mut terminfo = terminal::terminfo::Terminfo::from_env().context("could not get terminfo")?; 11 | let (to_status_line, from_status_line) = terminfo.write_status_line(); 12 | 13 | let tmux_pane = std::env::var_os("TMUX_PANE").context("could not read TMUX_PANE env var")?; 14 | 15 | let lines = std::fs::File::open(lines).context("could not open lines file")?; 16 | let lines = std::io::BufReader::new(lines); 17 | let lines = serde_json::Deserializer::from_reader(lines); 18 | let mut lines = lines.into_iter(); 19 | 20 | let mut last_event_origin_server_date = None; 21 | 22 | let mut room_joined_member_count = 0; 23 | let mut room_invited_member_count = 0; 24 | let mut room_heroes = vec![]; 25 | 26 | let mut room_name = None; 27 | let mut room_canonical_alias: Option = None; 28 | let mut room_is_tombstoned = false; 29 | let mut room_display_name_changed = true; 30 | 31 | let mut user_power_levels: std::collections::BTreeMap = Default::default(); 32 | let mut user_power_level_default = 0; 33 | 34 | loop { 35 | if room_display_name_changed { 36 | let room_display_name: std::borrow::Cow<'_, str> = 37 | if let Some(room_canonical_alias) = room_canonical_alias.as_deref() { 38 | room_canonical_alias.into() 39 | } 40 | else if let Some(room_name) = room_name.as_deref() { 41 | format!("{room_name} ({room_id})").into() 42 | } 43 | else if room_heroes.len() + 1 >= room_joined_member_count + room_invited_member_count { 44 | format!("{} ({room_id})", room_heroes.join(", ")).into() 45 | } 46 | else { 47 | room_id.into() 48 | }; 49 | let room_display_name: std::borrow::Cow<'_, str> = 50 | if room_is_tombstoned { 51 | format!("\u{1faa6} {room_display_name} \u{1faa6}").into() 52 | } 53 | else { 54 | room_display_name 55 | }; 56 | 57 | _ = stdout.write_all(to_status_line); 58 | _ = stdout.write_all(room_display_name.as_bytes()); 59 | _ = stdout.write_all(from_status_line); 60 | _ = stdout.flush(); 61 | 62 | let mut rename_command = crate::tmux(user_id)?; 63 | rename_command.args(["rename-window", "-t"]); 64 | rename_command.arg(&tmux_pane); 65 | // Replace `#` with `##` because tmux has special handling for some sequences like `#T` 66 | rename_command.arg(room_display_name.replace('#', "##")); 67 | _ = rename_command.output().context("could not rename tmux window to new room display name")?; 68 | 69 | room_display_name_changed = false; 70 | } 71 | 72 | let line = 73 | lines.next() 74 | .context("could not read line from lines file")? 75 | .context("could not read line from lines file")?; 76 | 77 | if std::env::var("DEBUG").as_deref() == Ok("1") { 78 | _ = writeln!(stderr, "{line:?}"); 79 | } 80 | 81 | let (origin_server_ts, sender, event) = match line { 82 | crate::RoomViewLine::Summary { summary } => { 83 | if let Some(invited_member_count) = summary.invited_member_count { 84 | room_invited_member_count = invited_member_count; 85 | } 86 | 87 | if let Some(joined_member_count) = summary.joined_member_count { 88 | room_joined_member_count = joined_member_count; 89 | } 90 | 91 | if !summary.heroes.is_empty() { 92 | room_heroes = summary.heroes; 93 | } 94 | 95 | room_display_name_changed = true; 96 | continue; 97 | }, 98 | 99 | crate::RoomViewLine::State { event: crate::SyncResponse_RoomStateEvent { content, origin_server_ts, sender, r#type, unsigned } } | 100 | crate::RoomViewLine::Timeline { event: crate::SyncResponse_RoomEvent { content, origin_server_ts, sender, r#type, unsigned } } => { 101 | let event = crate::Event::parse(r#type, content, unsigned).context("could not parse event")?; 102 | (origin_server_ts, sender, event) 103 | }, 104 | }; 105 | 106 | let origin_server_ts = origin_server_ts.with_timezone(&chrono::Local); 107 | let origin_server_date = origin_server_ts.date_naive(); 108 | if last_event_origin_server_date != Some(origin_server_date) { 109 | if last_event_origin_server_date.is_some() { 110 | _ = writeln!(stdout); 111 | } 112 | _ = writeln!(stdout, "--- {origin_server_date} ---"); 113 | 114 | last_event_origin_server_date = Some(origin_server_date); 115 | } 116 | 117 | _ = write!(stdout, "[{}] ", origin_server_ts.format_with_items([ 118 | chrono::format::Item::Numeric(chrono::format::Numeric::Hour, chrono::format::Pad::Zero), 119 | chrono::format::Item::Literal(":"), 120 | chrono::format::Item::Numeric(chrono::format::Numeric::Minute, chrono::format::Pad::Zero), 121 | chrono::format::Item::Literal(":"), 122 | chrono::format::Item::Numeric(chrono::format::Numeric::Second, chrono::format::Pad::Zero), 123 | ].into_iter())); 124 | 125 | match event { 126 | crate::Event::M_Room_CanonicalAlias { alias } => { 127 | if let Some(alias) = &alias { 128 | write_with_sender( 129 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 130 | SenderDecoration::Event, 131 | format_args!("set room canonical alias to {alias}\n"), 132 | ); 133 | } 134 | else { 135 | write_with_sender( 136 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 137 | SenderDecoration::Event, 138 | format_args!("removed room canonical alias\n"), 139 | ); 140 | } 141 | room_canonical_alias = alias; 142 | room_display_name_changed = true; 143 | }, 144 | 145 | crate::Event::M_Room_Create { room_version } => 146 | write_with_sender( 147 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 148 | SenderDecoration::Event, 149 | format_args!("created room with version {room_version}\n", room_version = room_version.as_deref().unwrap_or("1")), 150 | ), 151 | 152 | crate::Event::M_Room_Encrypted { algorithm, ciphertext, device_id, sender_key, session_id } => 153 | write_with_sender( 154 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 155 | SenderDecoration::Message, 156 | format_args!("[encrypted message] {algorithm:?} {session_id:?} {sender_key:?} {device_id:?} {ciphertext:?}\n"), 157 | ), 158 | 159 | crate::Event::M_Room_Encryption { algorithm } => 160 | write_with_sender( 161 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 162 | SenderDecoration::Event, 163 | format_args!("enabled room encryption with algorithm {algorithm}\n"), 164 | ), 165 | 166 | crate::Event::M_Room_GuestAccess { guest_access } => 167 | write_with_sender( 168 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 169 | SenderDecoration::Event, 170 | format_args!("set room guest access to {guest_access}\n"), 171 | ), 172 | 173 | crate::Event::M_Room_HistoryVisibility { history_visibility } => 174 | write_with_sender( 175 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 176 | SenderDecoration::Event, 177 | format_args!("set room history visibility to {history_visibility}\n"), 178 | ), 179 | 180 | crate::Event::M_Room_JoinRules { join_rule } => 181 | write_with_sender( 182 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 183 | SenderDecoration::Event, 184 | format_args!("set room join rules to {join_rule}\n"), 185 | ), 186 | 187 | crate::Event::M_Room_Message(content) => match content { 188 | crate::Event_M_Room_Message_Content::Emote(crate::Event_M_Room_Message_Content_Emote { body }) => { 189 | write_with_sender( 190 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 191 | SenderDecoration::Emote, 192 | format_args!(""), 193 | ); 194 | print_multiline(&mut stdout, &body); 195 | }, 196 | 197 | crate::Event_M_Room_Message_Content::File(crate::Event_M_Room_Message_Content_File { body, url }) => 198 | write_with_sender( 199 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 200 | SenderDecoration::Event, 201 | format_args!("posted file {body} at {url}\n"), 202 | ), 203 | 204 | crate::Event_M_Room_Message_Content::Image(crate::Event_M_Room_Message_Content_Image { body, url }) => 205 | write_with_sender( 206 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 207 | SenderDecoration::Event, 208 | format_args!("posted image {body} at {url}\n"), 209 | ), 210 | 211 | crate::Event_M_Room_Message_Content::Notice(crate::Event_M_Room_Message_Content_Notice { body }) | 212 | crate::Event_M_Room_Message_Content::Text(crate::Event_M_Room_Message_Content_Text { body }) => { 213 | write_with_sender( 214 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 215 | SenderDecoration::Message, 216 | format_args!(""), 217 | ); 218 | print_multiline(&mut stdout, &body); 219 | }, 220 | 221 | crate::Event_M_Room_Message_Content::Redacted(crate::Event_M_Room_Message_Content_Redacted { redacted_because, redacted_by }) => 222 | write_with_sender( 223 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 224 | SenderDecoration::Message, 225 | format_args!( 226 | " {redacted_because:?}\n", 227 | redacted_by = redacted_by.as_deref().unwrap_or("(unknown)"), 228 | ), 229 | ), 230 | 231 | crate::Event_M_Room_Message_Content::Other(crate::Event_M_Room_Message_Content_Other { msgtype, content, unsigned }) => 232 | write_with_sender( 233 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 234 | SenderDecoration::Event, 235 | format_args!("{msgtype:?} {content:?} {unsigned:?}\n"), 236 | ), 237 | }, 238 | 239 | crate::Event::M_Room_Name { name } => { 240 | write_with_sender( 241 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 242 | SenderDecoration::Event, 243 | format_args!("set room name to {name}\n"), 244 | ); 245 | room_name = Some(name); 246 | room_display_name_changed = true; 247 | }, 248 | 249 | crate::Event::M_Room_PowerLevels { users, users_default } => { 250 | user_power_level_default = users_default.unwrap_or(0); 251 | 252 | let mut users_by_power_level: std::collections::BTreeMap, Vec> = Default::default(); 253 | for (user_id, power_level) in users { 254 | users_by_power_level.entry(std::cmp::Reverse(power_level)).or_default().push(user_id.clone()); 255 | user_power_levels.insert(user_id, power_level); 256 | } 257 | 258 | let mut result = String::new(); 259 | for (std::cmp::Reverse(power_level), mut users) in users_by_power_level { 260 | use std::fmt::Write; 261 | 262 | if !result.is_empty() { 263 | result.push_str("; "); 264 | } 265 | users.sort(); 266 | write!(result, "{power_level}: {}", users.join(", ")).unwrap(); 267 | } 268 | 269 | write_with_sender( 270 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 271 | SenderDecoration::Event, 272 | format_args!("set room power levels: {result}\n"), 273 | ); 274 | }, 275 | 276 | crate::Event::M_Room_RelatedGroups { groups } => 277 | write_with_sender( 278 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 279 | SenderDecoration::Event, 280 | format_args!("set room related groups to {groups}\n", groups = groups.join(", ")), 281 | ), 282 | 283 | crate::Event::M_Room_Tombstone { body, replacement_room } => { 284 | write_with_sender( 285 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 286 | SenderDecoration::Event, 287 | format_args!("tombstoned room with replacement {replacement_room}: "), 288 | ); 289 | print_multiline(&mut stdout, &body); 290 | room_is_tombstoned = true; 291 | room_display_name_changed = true; 292 | }, 293 | 294 | crate::Event::M_Room_Topic { topic } => { 295 | write_with_sender( 296 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 297 | SenderDecoration::Event, 298 | format_args!("set room topic to "), 299 | ); 300 | print_multiline(&mut stdout, &topic); 301 | }, 302 | 303 | crate::Event::Unknown { r#type, content } => 304 | write_with_sender( 305 | &mut stdout, &sender, &user_power_levels, user_power_level_default, 306 | SenderDecoration::Event, 307 | format_args!("{type} {content:?}\n"), 308 | ), 309 | } 310 | } 311 | } 312 | 313 | fn print_multiline(stdout: &mut impl std::io::Write, s: &str) { 314 | if let Some((mut line, rest)) = s.split_once('\n') { 315 | let mut rest = Some(rest); 316 | 317 | _ = writeln!(stdout, ">"); 318 | 319 | loop { 320 | _ = writeln!(stdout, " | {line}"); 321 | 322 | let Some(rest_) = rest else { break; }; 323 | let (next_line, next_rest) = rest_.split_once('\n').map_or((rest_, None), |(line, rest)| (line, Some(rest))); 324 | line = next_line; 325 | rest = next_rest; 326 | } 327 | } 328 | else { 329 | _ = writeln!(stdout, "{s}"); 330 | } 331 | } 332 | 333 | #[derive(Clone, Copy)] 334 | enum SenderDecoration { 335 | Emote, 336 | Event, 337 | Message, 338 | } 339 | 340 | fn write_with_sender( 341 | stdout: &mut impl std::io::Write, 342 | sender: &str, 343 | user_power_levels: &std::collections::BTreeMap, 344 | user_power_level_default: usize, 345 | decoration: SenderDecoration, 346 | rest: std::fmt::Arguments<'_>, 347 | ) { 348 | let (decoration_start, decoration_end) = match decoration { 349 | SenderDecoration::Emote => ("<", "> /me"), 350 | SenderDecoration::Event => ("", ""), 351 | SenderDecoration::Message => ("<", ">"), 352 | }; 353 | 354 | let user_power_level = user_power_levels.get(sender).copied().unwrap_or(user_power_level_default); 355 | if user_power_level == user_power_level_default { 356 | _ = write!(stdout, "{decoration_start}{sender}{decoration_end}"); 357 | } 358 | else { 359 | _ = write!(stdout, "{decoration_start}[{user_power_level}] {sender}{decoration_end}"); 360 | } 361 | 362 | _ = write!(stdout, " {rest}"); 363 | } 364 | --------------------------------------------------------------------------------