git ssb

0+

cel / pingbot-appservice-rs



Commit 4528900f89f26538dfd532ace24bd7d46076e998

Init

Charles E. Lehner committed on 2/22/2023, 3:03:29 AM

Files changed

Cargo.tomladded
LICENSE.mdadded
README.mdadded
appservice.example.yamladded
src/main.rsadded
systemd/pingbot.example.serviceadded
systemd/pingbot.example.socketadded
Cargo.tomlView
@@ -1,0 +1,16 @@
1 +[package]
2 +name = "pingbot"
3 +version = "0.1.0"
4 +edition = "2021"
5 +license = "AGPL-3.0-or-later"
6 +
7 +[dependencies]
8 +listenfd = "0.3.1"
9 +hyper = { version = "0.14", features = ["http1", "runtime", "server", "client", "stream"] }
10 +tokio = { version = "1", features = ["full"] }
11 +anyhow = "1.0"
12 +serde = { version = "1.0" }
13 +serde_json = "1.0"
14 +url = "2.2"
15 +chrono = "0.4"
16 +html-escape = "0.2"
LICENSE.mdView
@@ -1,0 +1,660 @@
1 +### GNU AFFERO GENERAL PUBLIC LICENSE
2 +
3 +Version 3, 19 November 2007
4 +
5 +Copyright (C) 2007 Free Software Foundation, Inc.
6 +<https://fsf.org/>
7 +
8 +Everyone is permitted to copy and distribute verbatim copies of this
9 +license document, but changing it is not allowed.
10 +
11 +### Preamble
12 +
13 +The GNU Affero General Public License is a free, copyleft license for
14 +software and other kinds of works, specifically designed to ensure
15 +cooperation with the community in the case of network server software.
16 +
17 +The licenses for most software and other practical works are designed
18 +to take away your freedom to share and change the works. By contrast,
19 +our General Public Licenses are intended to guarantee your freedom to
20 +share and change all versions of a program--to make sure it remains
21 +free software for all its users.
22 +
23 +When we speak of free software, we are referring to freedom, not
24 +price. Our General Public Licenses are designed to make sure that you
25 +have the freedom to distribute copies of free software (and charge for
26 +them if you wish), that you receive source code or can get it if you
27 +want it, that you can change the software or use pieces of it in new
28 +free programs, and that you know you can do these things.
29 +
30 +Developers that use our General Public Licenses protect your rights
31 +with two steps: (1) assert copyright on the software, and (2) offer
32 +you this License which gives you legal permission to copy, distribute
33 +and/or modify the software.
34 +
35 +A secondary benefit of defending all users' freedom is that
36 +improvements made in alternate versions of the program, if they
37 +receive widespread use, become available for other developers to
38 +incorporate. Many developers of free software are heartened and
39 +encouraged by the resulting cooperation. However, in the case of
40 +software used on network servers, this result may fail to come about.
41 +The GNU General Public License permits making a modified version and
42 +letting the public access it on a server without ever releasing its
43 +source code to the public.
44 +
45 +The GNU Affero General Public License is designed specifically to
46 +ensure that, in such cases, the modified source code becomes available
47 +to the community. It requires the operator of a network server to
48 +provide the source code of the modified version running there to the
49 +users of that server. Therefore, public use of a modified version, on
50 +a publicly accessible server, gives the public access to the source
51 +code of the modified version.
52 +
53 +An older license, called the Affero General Public License and
54 +published by Affero, was designed to accomplish similar goals. This is
55 +a different license, not a version of the Affero GPL, but Affero has
56 +released a new version of the Affero GPL which permits relicensing
57 +under this license.
58 +
59 +The precise terms and conditions for copying, distribution and
60 +modification follow.
61 +
62 +### TERMS AND CONDITIONS
63 +
64 +#### 0. Definitions.
65 +
66 +"This License" refers to version 3 of the GNU Affero General Public
67 +License.
68 +
69 +"Copyright" also means copyright-like laws that apply to other kinds
70 +of works, such as semiconductor masks.
71 +
72 +"The Program" refers to any copyrightable work licensed under this
73 +License. Each licensee is addressed as "you". "Licensees" and
74 +"recipients" may be individuals or organizations.
75 +
76 +To "modify" a work means to copy from or adapt all or part of the work
77 +in a fashion requiring copyright permission, other than the making of
78 +an exact copy. The resulting work is called a "modified version" of
79 +the earlier work or a work "based on" the earlier work.
80 +
81 +A "covered work" means either the unmodified Program or a work based
82 +on the Program.
83 +
84 +To "propagate" a work means to do anything with it that, without
85 +permission, would make you directly or secondarily liable for
86 +infringement under applicable copyright law, except executing it on a
87 +computer or modifying a private copy. Propagation includes copying,
88 +distribution (with or without modification), making available to the
89 +public, and in some countries other activities as well.
90 +
91 +To "convey" a work means any kind of propagation that enables other
92 +parties to make or receive copies. Mere interaction with a user
93 +through a computer network, with no transfer of a copy, is not
94 +conveying.
95 +
96 +An interactive user interface displays "Appropriate Legal Notices" to
97 +the extent that it includes a convenient and prominently visible
98 +feature that (1) displays an appropriate copyright notice, and (2)
99 +tells the user that there is no warranty for the work (except to the
100 +extent that warranties are provided), that licensees may convey the
101 +work under this License, and how to view a copy of this License. If
102 +the interface presents a list of user commands or options, such as a
103 +menu, a prominent item in the list meets this criterion.
104 +
105 +#### 1. Source Code.
106 +
107 +The "source code" for a work means the preferred form of the work for
108 +making modifications to it. "Object code" means any non-source form of
109 +a work.
110 +
111 +A "Standard Interface" means an interface that either is an official
112 +standard defined by a recognized standards body, or, in the case of
113 +interfaces specified for a particular programming language, one that
114 +is widely used among developers working in that language.
115 +
116 +The "System Libraries" of an executable work include anything, other
117 +than the work as a whole, that (a) is included in the normal form of
118 +packaging a Major Component, but which is not part of that Major
119 +Component, and (b) serves only to enable use of the work with that
120 +Major Component, or to implement a Standard Interface for which an
121 +implementation is available to the public in source code form. A
122 +"Major Component", in this context, means a major essential component
123 +(kernel, window system, and so on) of the specific operating system
124 +(if any) on which the executable work runs, or a compiler used to
125 +produce the work, or an object code interpreter used to run it.
126 +
127 +The "Corresponding Source" for a work in object code form means all
128 +the source code needed to generate, install, and (for an executable
129 +work) run the object code and to modify the work, including scripts to
130 +control those activities. However, it does not include the work's
131 +System Libraries, or general-purpose tools or generally available free
132 +programs which are used unmodified in performing those activities but
133 +which are not part of the work. For example, Corresponding Source
134 +includes interface definition files associated with source files for
135 +the work, and the source code for shared libraries and dynamically
136 +linked subprograms that the work is specifically designed to require,
137 +such as by intimate data communication or control flow between those
138 +subprograms and other parts of the work.
139 +
140 +The Corresponding Source need not include anything that users can
141 +regenerate automatically from other parts of the Corresponding Source.
142 +
143 +The Corresponding Source for a work in source code form is that same
144 +work.
145 +
146 +#### 2. Basic Permissions.
147 +
148 +All rights granted under this License are granted for the term of
149 +copyright on the Program, and are irrevocable provided the stated
150 +conditions are met. This License explicitly affirms your unlimited
151 +permission to run the unmodified Program. The output from running a
152 +covered work is covered by this License only if the output, given its
153 +content, constitutes a covered work. This License acknowledges your
154 +rights of fair use or other equivalent, as provided by copyright law.
155 +
156 +You may make, run and propagate covered works that you do not convey,
157 +without conditions so long as your license otherwise remains in force.
158 +You may convey covered works to others for the sole purpose of having
159 +them make modifications exclusively for you, or provide you with
160 +facilities for running those works, provided that you comply with the
161 +terms of this License in conveying all material for which you do not
162 +control copyright. Those thus making or running the covered works for
163 +you must do so exclusively on your behalf, under your direction and
164 +control, on terms that prohibit them from making any copies of your
165 +copyrighted material outside their relationship with you.
166 +
167 +Conveying under any other circumstances is permitted solely under the
168 +conditions stated below. Sublicensing is not allowed; section 10 makes
169 +it unnecessary.
170 +
171 +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
172 +
173 +No covered work shall be deemed part of an effective technological
174 +measure under any applicable law fulfilling obligations under article
175 +11 of the WIPO copyright treaty adopted on 20 December 1996, or
176 +similar laws prohibiting or restricting circumvention of such
177 +measures.
178 +
179 +When you convey a covered work, you waive any legal power to forbid
180 +circumvention of technological measures to the extent such
181 +circumvention is effected by exercising rights under this License with
182 +respect to the covered work, and you disclaim any intention to limit
183 +operation or modification of the work as a means of enforcing, against
184 +the work's users, your or third parties' legal rights to forbid
185 +circumvention of technological measures.
186 +
187 +#### 4. Conveying Verbatim Copies.
188 +
189 +You may convey verbatim copies of the Program's source code as you
190 +receive it, in any medium, provided that you conspicuously and
191 +appropriately publish on each copy an appropriate copyright notice;
192 +keep intact all notices stating that this License and any
193 +non-permissive terms added in accord with section 7 apply to the code;
194 +keep intact all notices of the absence of any warranty; and give all
195 +recipients a copy of this License along with the Program.
196 +
197 +You may charge any price or no price for each copy that you convey,
198 +and you may offer support or warranty protection for a fee.
199 +
200 +#### 5. Conveying Modified Source Versions.
201 +
202 +You may convey a work based on the Program, or the modifications to
203 +produce it from the Program, in the form of source code under the
204 +terms of section 4, provided that you also meet all of these
205 +conditions:
206 +
207 +- a) The work must carry prominent notices stating that you modified
208 + it, and giving a relevant date.
209 +- b) The work must carry prominent notices stating that it is
210 + released under this License and any conditions added under
211 + section 7. This requirement modifies the requirement in section 4
212 + to "keep intact all notices".
213 +- c) You must license the entire work, as a whole, under this
214 + License to anyone who comes into possession of a copy. This
215 + License will therefore apply, along with any applicable section 7
216 + additional terms, to the whole of the work, and all its parts,
217 + regardless of how they are packaged. This License gives no
218 + permission to license the work in any other way, but it does not
219 + invalidate such permission if you have separately received it.
220 +- d) If the work has interactive user interfaces, each must display
221 + Appropriate Legal Notices; however, if the Program has interactive
222 + interfaces that do not display Appropriate Legal Notices, your
223 + work need not make them do so.
224 +
225 +A compilation of a covered work with other separate and independent
226 +works, which are not by their nature extensions of the covered work,
227 +and which are not combined with it such as to form a larger program,
228 +in or on a volume of a storage or distribution medium, is called an
229 +"aggregate" if the compilation and its resulting copyright are not
230 +used to limit the access or legal rights of the compilation's users
231 +beyond what the individual works permit. Inclusion of a covered work
232 +in an aggregate does not cause this License to apply to the other
233 +parts of the aggregate.
234 +
235 +#### 6. Conveying Non-Source Forms.
236 +
237 +You may convey a covered work in object code form under the terms of
238 +sections 4 and 5, provided that you also convey the machine-readable
239 +Corresponding Source under the terms of this License, in one of these
240 +ways:
241 +
242 +- a) Convey the object code in, or embodied in, a physical product
243 + (including a physical distribution medium), accompanied by the
244 + Corresponding Source fixed on a durable physical medium
245 + customarily used for software interchange.
246 +- b) Convey the object code in, or embodied in, a physical product
247 + (including a physical distribution medium), accompanied by a
248 + written offer, valid for at least three years and valid for as
249 + long as you offer spare parts or customer support for that product
250 + model, to give anyone who possesses the object code either (1) a
251 + copy of the Corresponding Source for all the software in the
252 + product that is covered by this License, on a durable physical
253 + medium customarily used for software interchange, for a price no
254 + more than your reasonable cost of physically performing this
255 + conveying of source, or (2) access to copy the Corresponding
256 + Source from a network server at no charge.
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 +- d) Convey the object code by offering access from a designated
263 + place (gratis or for a charge), and offer equivalent access to the
264 + Corresponding Source in the same way through the same place at no
265 + further charge. You need not require recipients to copy the
266 + Corresponding Source along with the object code. If the place to
267 + copy the object code is a network server, the Corresponding Source
268 + may be on a different server (operated by you or a third party)
269 + that supports equivalent copying facilities, provided you maintain
270 + clear directions next to the object code saying where to find the
271 + Corresponding Source. Regardless of what server hosts the
272 + Corresponding Source, you remain obligated to ensure that it is
273 + available for as long as needed to satisfy these requirements.
274 +- e) Convey the object code using peer-to-peer transmission,
275 + provided you inform other peers where the object code and
276 + Corresponding Source of the work are being offered to the general
277 + public at no charge under subsection 6d.
278 +
279 +A separable portion of the object code, whose source code is excluded
280 +from the Corresponding Source as a System Library, need not be
281 +included in conveying the object code work.
282 +
283 +A "User Product" is either (1) a "consumer product", which means any
284 +tangible personal property which is normally used for personal,
285 +family, or household purposes, or (2) anything designed or sold for
286 +incorporation into a dwelling. In determining whether a product is a
287 +consumer product, doubtful cases shall be resolved in favor of
288 +coverage. For a particular product received by a particular user,
289 +"normally used" refers to a typical or common use of that class of
290 +product, regardless of the status of the particular user or of the way
291 +in which the particular user actually uses, or expects or is expected
292 +to use, the product. A product is a consumer product regardless of
293 +whether the product has substantial commercial, industrial or
294 +non-consumer uses, unless such uses represent the only significant
295 +mode of use of the product.
296 +
297 +"Installation Information" for a User Product means any methods,
298 +procedures, authorization keys, or other information required to
299 +install and execute modified versions of a covered work in that User
300 +Product from a modified version of its Corresponding Source. The
301 +information must suffice to ensure that the continued functioning of
302 +the modified object code is in no case prevented or interfered with
303 +solely because modification has been made.
304 +
305 +If you convey an object code work under this section in, or with, or
306 +specifically for use in, a User Product, and the conveying occurs as
307 +part of a transaction in which the right of possession and use of the
308 +User Product is transferred to the recipient in perpetuity or for a
309 +fixed term (regardless of how the transaction is characterized), the
310 +Corresponding Source conveyed under this section must be accompanied
311 +by the Installation Information. But this requirement does not apply
312 +if neither you nor any third party retains the ability to install
313 +modified object code on the User Product (for example, the work has
314 +been installed in ROM).
315 +
316 +The requirement to provide Installation Information does not include a
317 +requirement to continue to provide support service, warranty, or
318 +updates for a work that has been modified or installed by the
319 +recipient, or for the User Product in which it has been modified or
320 +installed. Access to a network may be denied when the modification
321 +itself materially and adversely affects the operation of the network
322 +or violates the rules and protocols for communication across the
323 +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
351 +of 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 +- b) Requiring preservation of specified reasonable legal notices or
356 + author attributions in that material or in the Appropriate Legal
357 + Notices displayed by works containing it; or
358 +- c) Prohibiting misrepresentation of the origin of that material,
359 + or requiring that modified versions of such material be marked in
360 + reasonable ways as different from the original version; or
361 +- d) Limiting the use for publicity purposes of names of licensors
362 + or authors of the material; or
363 +- e) Declining to grant rights under trademark law for use of some
364 + trade names, trademarks, or service marks; or
365 +- f) Requiring indemnification of licensors and authors of that
366 + material by anyone who conveys the material (or modified versions
367 + of it) with contractual assumptions of liability to the recipient,
368 + for any liability that these contractual assumptions directly
369 + impose on those licensors and authors.
370 +
371 +All other non-permissive additional terms are considered "further
372 +restrictions" within the meaning of section 10. If the Program as you
373 +received it, or any part of it, contains a notice stating that it is
374 +governed by this License along with a term that is a further
375 +restriction, you may remove that term. If a license document contains
376 +a further restriction but permits relicensing or conveying under this
377 +License, you may add to a covered work material governed by the terms
378 +of that license document, provided that the further restriction does
379 +not survive such relicensing or conveying.
380 +
381 +If you add terms to a covered work in accord with this section, you
382 +must place, in the relevant source files, a statement of the
383 +additional terms that apply to those files, or a notice indicating
384 +where to find the applicable terms.
385 +
386 +Additional terms, permissive or non-permissive, may be stated in the
387 +form of a separately written license, or stated as exceptions; the
388 +above requirements apply either way.
389 +
390 +#### 8. Termination.
391 +
392 +You may not propagate or modify a covered work except as expressly
393 +provided under this License. Any attempt otherwise to propagate or
394 +modify it is void, and will automatically terminate your rights under
395 +this License (including any patent licenses granted under the third
396 +paragraph of section 11).
397 +
398 +However, if you cease all violation of this License, then your license
399 +from a particular copyright holder is reinstated (a) provisionally,
400 +unless and until the copyright holder explicitly and finally
401 +terminates your license, and (b) permanently, if the copyright holder
402 +fails to notify you of the violation by some reasonable means prior to
403 +60 days after the cessation.
404 +
405 +Moreover, your license from a particular copyright holder is
406 +reinstated permanently if the copyright holder notifies you of the
407 +violation by some reasonable means, this is the first time you have
408 +received notice of violation of this License (for any work) from that
409 +copyright holder, and you cure the violation prior to 30 days after
410 +your receipt of the notice.
411 +
412 +Termination of your rights under this section does not terminate the
413 +licenses of parties who have received copies or rights from you under
414 +this License. If your rights have been terminated and not permanently
415 +reinstated, you do not qualify to receive new licenses for the same
416 +material under section 10.
417 +
418 +#### 9. Acceptance Not Required for Having Copies.
419 +
420 +You are not required to accept this License in order to receive or run
421 +a copy of the Program. Ancillary propagation of a covered work
422 +occurring solely as a consequence of using peer-to-peer transmission
423 +to receive a copy likewise does not require acceptance. However,
424 +nothing other than this License grants you permission to propagate or
425 +modify any covered work. These actions infringe copyright if you do
426 +not accept this License. Therefore, by modifying or propagating a
427 +covered work, you indicate your acceptance of this License to do so.
428 +
429 +#### 10. Automatic Licensing of Downstream Recipients.
430 +
431 +Each time you convey a covered work, the recipient automatically
432 +receives a license from the original licensors, to run, modify and
433 +propagate that work, subject to this License. You are not responsible
434 +for enforcing compliance by third parties with this License.
435 +
436 +An "entity transaction" is a transaction transferring control of an
437 +organization, or substantially all assets of one, or subdividing an
438 +organization, or merging organizations. If propagation of a covered
439 +work results from an entity transaction, each party to that
440 +transaction who receives a copy of the work also receives whatever
441 +licenses to the work the party's predecessor in interest had or could
442 +give under the previous paragraph, plus a right to possession of the
443 +Corresponding Source of the work from the predecessor in interest, if
444 +the predecessor has it or can get it with reasonable efforts.
445 +
446 +You may not impose any further restrictions on the exercise of the
447 +rights granted or affirmed under this License. For example, you may
448 +not impose a license fee, royalty, or other charge for exercise of
449 +rights granted under this License, and you may not initiate litigation
450 +(including a cross-claim or counterclaim in a lawsuit) alleging that
451 +any patent claim is infringed by making, using, selling, offering for
452 +sale, or importing the Program or any portion of it.
453 +
454 +#### 11. Patents.
455 +
456 +A "contributor" is a copyright holder who authorizes use under this
457 +License of the Program or a work on which the Program is based. The
458 +work thus licensed is called the contributor's "contributor version".
459 +
460 +A contributor's "essential patent claims" are all patent claims owned
461 +or controlled by the contributor, whether already acquired or
462 +hereafter acquired, that would be infringed by some manner, permitted
463 +by this License, of making, using, or selling its contributor version,
464 +but do not include claims that would be infringed only as a
465 +consequence of further modification of the contributor version. For
466 +purposes of this definition, "control" includes the right to grant
467 +patent sublicenses in a manner consistent with the requirements of
468 +this License.
469 +
470 +Each contributor grants you a non-exclusive, worldwide, royalty-free
471 +patent license under the contributor's essential patent claims, to
472 +make, use, sell, offer for sale, import and otherwise run, modify and
473 +propagate the contents of its contributor version.
474 +
475 +In the following three paragraphs, a "patent license" is any express
476 +agreement or commitment, however denominated, not to enforce a patent
477 +(such as an express permission to practice a patent or covenant not to
478 +sue for patent infringement). To "grant" such a patent license to a
479 +party means to make such an agreement or commitment not to enforce a
480 +patent against the party.
481 +
482 +If you convey a covered work, knowingly relying on a patent license,
483 +and the Corresponding Source of the work is not available for anyone
484 +to copy, free of charge and under the terms of this License, through a
485 +publicly available network server or other readily accessible means,
486 +then you must either (1) cause the Corresponding Source to be so
487 +available, or (2) arrange to deprive yourself of the benefit of the
488 +patent license for this particular work, or (3) arrange, in a manner
489 +consistent with the requirements of this License, to extend the patent
490 +license to downstream recipients. "Knowingly relying" means you have
491 +actual knowledge that, but for the patent license, your conveying the
492 +covered work in a country, or your recipient's use of the covered work
493 +in a country, would infringe one or more identifiable patents in that
494 +country that you have reason to believe are valid.
495 +
496 +If, pursuant to or in connection with a single transaction or
497 +arrangement, you convey, or propagate by procuring conveyance of, a
498 +covered work, and grant a patent license to some of the parties
499 +receiving the covered work authorizing them to use, propagate, modify
500 +or convey a specific copy of the covered work, then the patent license
501 +you grant is automatically extended to all recipients of the covered
502 +work and works based on it.
503 +
504 +A patent license is "discriminatory" if it does not include within the
505 +scope of its coverage, prohibits the exercise of, or is conditioned on
506 +the non-exercise of one or more of the rights that are specifically
507 +granted under this License. You may not convey a covered work if you
508 +are a party to an arrangement with a third party that is in the
509 +business of distributing software, under which you make payment to the
510 +third party based on the extent of your activity of conveying the
511 +work, and under which the third party grants, to any of the parties
512 +who would receive the covered work from you, a discriminatory patent
513 +license (a) in connection with copies of the covered work conveyed by
514 +you (or copies made from those copies), or (b) primarily for and in
515 +connection with specific products or compilations that contain the
516 +covered work, unless you entered into that arrangement, or that patent
517 +license was granted, prior to 28 March 2007.
518 +
519 +Nothing in this License shall be construed as excluding or limiting
520 +any implied license or other defenses to infringement that may
521 +otherwise be available to you under applicable patent law.
522 +
523 +#### 12. No Surrender of Others' Freedom.
524 +
525 +If conditions are imposed on you (whether by court order, agreement or
526 +otherwise) that contradict the conditions of this License, they do not
527 +excuse you from the conditions of this License. If you cannot convey a
528 +covered work so as to satisfy simultaneously your obligations under
529 +this License and any other pertinent obligations, then as a
530 +consequence you may not convey it at all. For example, if you agree to
531 +terms that obligate you to collect a royalty for further conveying
532 +from those to whom you convey the Program, the only way you could
533 +satisfy both those terms and this License would be to refrain entirely
534 +from conveying the Program.
535 +
536 +#### 13. Remote Network Interaction; Use with the GNU General Public License.
537 +
538 +Notwithstanding any other provision of this License, if you modify the
539 +Program, your modified version must prominently offer all users
540 +interacting with it remotely through a computer network (if your
541 +version supports such interaction) an opportunity to receive the
542 +Corresponding Source of your version by providing access to the
543 +Corresponding Source from a network server at no charge, through some
544 +standard or customary means of facilitating copying of software. This
545 +Corresponding Source shall include the Corresponding Source for any
546 +work covered by version 3 of the GNU General Public License that is
547 +incorporated pursuant to the following paragraph.
548 +
549 +Notwithstanding any other provision of this License, you have
550 +permission to link or combine any covered work with a work licensed
551 +under version 3 of the GNU General Public License into a single
552 +combined work, and to convey the resulting work. The terms of this
553 +License will continue to apply to the part which is the covered work,
554 +but the work with which it is combined will remain governed by version
555 +3 of the GNU General Public License.
556 +
557 +#### 14. Revised Versions of this License.
558 +
559 +The Free Software Foundation may publish revised and/or new versions
560 +of the GNU Affero General Public License from time to time. Such new
561 +versions will be similar in spirit to the present version, but may
562 +differ in detail to address new problems or concerns.
563 +
564 +Each version is given a distinguishing version number. If the Program
565 +specifies that a certain numbered version of the GNU Affero General
566 +Public License "or any later version" applies to it, you have the
567 +option of following the terms and conditions either of that numbered
568 +version or of any later version published by the Free Software
569 +Foundation. If the Program does not specify a version number of the
570 +GNU Affero General Public License, you may choose any version ever
571 +published by the Free Software Foundation.
572 +
573 +If the Program specifies that a proxy can decide which future versions
574 +of the GNU Affero General Public License can be used, that proxy's
575 +public statement of acceptance of a version permanently authorizes you
576 +to choose that version for the Program.
577 +
578 +Later license versions may give you additional or different
579 +permissions. However, no additional obligations are imposed on any
580 +author or copyright holder as a result of your choosing to follow a
581 +later version.
582 +
583 +#### 15. Disclaimer of Warranty.
584 +
585 +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
586 +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
587 +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
588 +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
589 +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
590 +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
591 +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
592 +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
593 +CORRECTION.
594 +
595 +#### 16. Limitation of Liability.
596 +
597 +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
598 +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
599 +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
600 +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
601 +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
602 +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
603 +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
604 +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
605 +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
606 +
607 +#### 17. Interpretation of Sections 15 and 16.
608 +
609 +If the disclaimer of warranty and limitation of liability provided
610 +above cannot be given local legal effect according to their terms,
611 +reviewing courts shall apply local law that most closely approximates
612 +an absolute waiver of all civil liability in connection with the
613 +Program, unless a warranty or assumption of liability accompanies a
614 +copy of the Program in return for a fee.
615 +
616 +END OF TERMS AND CONDITIONS
617 +
618 +### How to Apply These Terms to Your New Programs
619 +
620 +If you develop a new program, and you want it to be of the greatest
621 +possible use to the public, the best way to achieve this is to make it
622 +free software which everyone can redistribute and change under these
623 +terms.
624 +
625 +To do so, attach the following notices to the program. It is safest to
626 +attach them to the start of each source file to most effectively state
627 +the exclusion of warranty; and each file should have at least the
628 +"copyright" line and a pointer to where the full notice is found.
629 +
630 + <one line to give the program's name and a brief idea of what it does.>
631 + Copyright (C) <year> <name of author>
632 +
633 + This program is free software: you can redistribute it and/or modify
634 + it under the terms of the GNU Affero General Public License as
635 + published by the Free Software Foundation, either version 3 of the
636 + License, or (at your option) any later version.
637 +
638 + This program is distributed in the hope that it will be useful,
639 + but WITHOUT ANY WARRANTY; without even the implied warranty of
640 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
641 + GNU Affero General Public License for more details.
642 +
643 + You should have received a copy of the GNU Affero General Public License
644 + along with this program. If not, see <https://www.gnu.org/licenses/>.
645 +
646 +Also add information on how to contact you by electronic and paper
647 +mail.
648 +
649 +If your software can interact with users remotely through a computer
650 +network, you should also make sure that it provides a way for users to
651 +get its source. For example, if your program is a web application, its
652 +interface could display a "Source" link that leads users to an archive
653 +of the code. There are many ways you could offer source, and different
654 +solutions will be better for different programs; see section 13 for
655 +the specific requirements.
656 +
657 +You should also get your employer (if you work as a programmer) or
658 +school, if any, to sign a "copyright disclaimer" for the program, if
659 +necessary. For more information on this, and how to apply and follow
660 +the GNU AGPL, see <https://www.gnu.org/licenses/>.
README.mdView
@@ -1,0 +1,44 @@
1 +# pingbot-appservice-rs
2 +
3 +Matrix pingbot appservice in Rust
4 +
5 +## Install
6 +
7 +- Compile: `cargo build`.
8 +- Generate two access tokens (`HS_TOKEN` and `AS_TOKEN`). e.g. using `pwgen`.
9 +- Set up as a system service. Using systemd: modify `systemd/pingbot.example.service` and `systemd/pingbot.example.socket` and install them e.g. in `/etc/systemd/system/`.
10 +- Modify the appservice file `appservice.example.yaml`, adding the access tokens, and register it with your homeserver.
11 +- Optionally register with the homeserver, using `AS_TOKEN`. This returns another access token which you can use optionally instead of `$AS_TOKEN`:
12 +```
13 +curl -d '{"username":"pingbot", "type": "m.login.application_service"}' "https://mobilizon.us/_matrix/client/v3/register?access_token=$AS_TOKEN"
14 +```
15 +## Adding to rooms
16 +
17 +Joining rooms must be done manually. Here is a command to do it via [Client-Server API)](https://spec.matrix.org/v1.6/client-server-api/#post_matrixclientv3joinroomidoralias):
18 +```
19 +curl -d '{}' "https://mobilizon.us/_matrix/client/v3/rooms/%21ROOM_ID:example.org/join?access_token=$AS_TOKEN"
20 +```
21 +
22 +The appservice responds in rooms to the `!ping` command.
23 +
24 +## Development
25 +
26 +The appservice runs a HTTP server, using systemd socket activation to receive the server socket. When not run via systemd, you can emulate this by using [systemfd](https://github.com/mitsuhiko/systemfd); further, you can use [cargo-watch](https://github.com/watchexec/cargo-watch) for auto-reloading during development, as follows:
27 +```
28 +cargo install systemfd cargo-watch
29 +systemfd --no-pid -s http::7001 -- cargo watch -qx run
30 +```
31 +If run without systemd/systemfd, the appservice listens on a random port.
32 +A benefit of using the socket activation is that requests received during recompilation do not fail but are served when the compilation succeeds and the program starts.
33 +
34 +## References
35 +
36 +- https://spec.matrix.org/v1.2/application-service-api/
37 +- https://github.com/maubot/echo/blob/master/echo.py
38 +- https://github.com/maubot/pingstat
39 +- https://gitlab.com/famedly/conduit/-/blob/next/APPSERVICES.md
40 +- https://pad.mau.fi/code/#/2/code/view/bEQSTiIid1O-GkVqpMED9g70E8dZKH+M4wsxp1ntvbY/embed/present/ (Echo/Ping Bot Spec)
41 +
42 +## License
43 +
44 +AGPL3+
appservice.example.yamlView
@@ -1,0 +1,9 @@
1 +id: "pingbot"
2 +url: "http://127.0.0.3:7001"
3 +as_token: "EXAMPLE_AS_TOKEN"
4 +hs_token: "EXAMPLE_HS_TOKEN"
5 +sender_localpart: "pingbot"
6 +namespaces:
7 + users: []
8 + aliases: []
9 + rooms: []
src/main.rsView
@@ -1,0 +1,320 @@
1 +/*
2 + * pingbot-appservice-rs
3 + * Copyright (C) 2023 Charles E. lehner
4 + *
5 + * This program is free software: you can redistribute it and/or modify
6 + * it under the terms of the GNU Affero General Public License as
7 + * published by the Free Software Foundation, either version 3 of the
8 + * License, or (at your option) any later version.
9 + *
10 + * This program is distributed in the hope that it will be useful,
11 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 + * GNU Affero General Public License for more details.
14 + *
15 + * You should have received a copy of the GNU Affero General Public License
16 + * along with this program. If not, see <https://www.gnu.org/licenses/>.
17 +*/
18 +
19 +use anyhow::{anyhow, Context, Error};
20 +use chrono::{Duration, Utc};
21 +use hyper::header::CONTENT_TYPE;
22 +use hyper::http::{Request, Response};
23 +use hyper::{server::conn::Http, service::service_fn, Body, Method, StatusCode};
24 +use serde_json::{json, Map, Value};
25 +use std::collections::HashMap;
26 +use std::env::var;
27 +use std::net::SocketAddr;
28 +use tokio::net::TcpListener;
29 +use tokio::net::TcpStream;
30 +
31 +#[tokio::main]
32 +async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
33 + let mut listenfd = listenfd::ListenFd::from_env();
34 + let listener = match listenfd.take_tcp_listener(0)? {
35 + Some(listener) => TcpListener::from_std(listener)?,
36 + None => {
37 + let bind_addr = SocketAddr::from(([127, 0, 0, 1], 0));
38 + TcpListener::bind(bind_addr).await?
39 + }
40 + };
41 + let base_url = format!("http://{}", listener.local_addr()?);
42 + println!("Listening on {}", base_url);
43 +
44 + loop {
45 + let (tcp_stream, _client_addr) = listener.accept().await?;
46 + tokio::task::spawn(async move {
47 + if let Err(http_err) = Http::new()
48 + .http1_only(true)
49 + .http1_keep_alive(true)
50 + .serve_connection(tcp_stream, service_fn(server_main))
51 + .await
52 + {
53 + eprintln!("Error while serving HTTP connection: {}", http_err);
54 + }
55 + });
56 + }
57 +}
58 +
59 +async fn server_main(req: Request<Body>) -> Result<Response<Body>, Error> {
60 + // omit query from log because it may contain access token
61 + let path = req.uri().path().to_string();
62 + let hs_token = var("HS_TOKEN").context("unable to get HS_TOKEN")?;
63 + let query = req.uri().query().unwrap_or_default();
64 + let params = url::form_urlencoded::parse(query.as_bytes())
65 + .into_owned()
66 + .collect::<HashMap<String, String>>();
67 + eprintln!("{} {}", req.method(), path);
68 + if params.get("access_token").map(String::as_str) != Some(&hs_token) {
69 + eprint!("unauthorized");
70 + return Response::builder()
71 + .status(StatusCode::UNAUTHORIZED)
72 + .body(Body::from("Unauthorized (unmatched access token)\n"))
73 + .context("serving unauthorized");
74 + }
75 + if let Some(txid) = path.strip_prefix("/_matrix/app/v1/transactions/") {
76 + serve_tx(req, txid).await
77 + } else {
78 + serve_not_found()
79 + }
80 +}
81 +
82 +async fn serve_tx(req: Request<Body>, _txid: &str) -> Result<Response<Body>, Error> {
83 + if req.method() != Method::PUT {
84 + return Response::builder()
85 + .status(StatusCode::METHOD_NOT_ALLOWED)
86 + .header(CONTENT_TYPE, "application/json")
87 + .body(Body::from(r#"{"error": "Expected PUT"}"#))
88 + .context("serving not found");
89 + }
90 + let data = hyper::body::to_bytes(req).await.context("read PUT data")?;
91 + let mut obj: Map<String, Value> = serde_json::from_slice(&data).context("parsing PUT data")?;
92 + if let Some(Value::Array(events)) = obj.remove("events") {
93 + for event in events {
94 + if let Some(e) = handle_event(event).await.err() {
95 + eprintln!("error handling event: {}", e);
96 + }
97 + }
98 + }
99 + Response::builder()
100 + .body(Body::from("OK"))
101 + .context("handling PUT")
102 +}
103 +
104 +async fn handle_event(event: Value) -> Result<(), Error> {
105 + let event_type = event
106 + .get("type")
107 + .and_then(|value| value.as_str())
108 + .ok_or(anyhow!("missing event type"))?;
109 + if event_type == "m.room.message" {
110 + let content = event
111 + .get("content")
112 + .and_then(|value| value.as_object())
113 + .ok_or(anyhow!("missing content"))?;
114 + let body = content
115 + .get("body")
116 + .and_then(|value| value.as_str())
117 + .ok_or(anyhow!("missing body"))?;
118 + let msgtype = content
119 + .get("msgtype")
120 + .and_then(|value| value.as_str())
121 + .ok_or(anyhow!("missing msgtype"))?;
122 + if msgtype != "m.text" {
123 + return Ok(());
124 + }
125 + if let Some(arg) = body.strip_prefix("!ping") {
126 + let arg = arg.trim().to_string();
127 + if let Err(e) = handle_ping(event, &arg).await {
128 + eprintln!("error responding to ping: {}", e);
129 + }
130 + } else if let Some(arg) = body.strip_prefix("!echo") {
131 + let arg = arg.trim().to_string();
132 + if let Err(e) = handle_echo(event, &arg).await {
133 + eprintln!("error responding to echo: {}", e);
134 + }
135 + }
136 + } else {
137 + eprintln!(
138 + "unknown event: {}",
139 + serde_json::to_string_pretty(&event).context("serialize")?
140 + );
141 + }
142 + Ok(())
143 +}
144 +
145 +fn format_duration(mut duration: Duration) -> String {
146 + let ms = duration.num_milliseconds();
147 + if ms < 10000 {
148 + return format!("{} ms", ms);
149 + }
150 + if ms < 60000 {
151 + return format!("{:.2} seconds", (ms as f64) / 1000.0);
152 + }
153 + let mut parts = Vec::new();
154 + let days = duration.num_days();
155 + if days == 1 {
156 + parts.push(String::from("1 day"));
157 + } else if days > 1 {
158 + parts.push(format!("{} days", days));
159 + }
160 + duration = duration - Duration::days(days);
161 +
162 + let hours = duration.num_hours();
163 + if hours == 1 {
164 + parts.push(String::from("1 hour"));
165 + } else if hours > 1 {
166 + parts.push(format!("{} hours", hours));
167 + }
168 + duration = duration - Duration::hours(hours);
169 +
170 + let minutes = duration.num_minutes();
171 + if minutes == 1 {
172 + parts.push(String::from("1 minute"));
173 + } else if minutes > 1 {
174 + parts.push(format!("{} minutes", minutes));
175 + }
176 + duration = duration - Duration::minutes(minutes);
177 +
178 + let seconds = duration.num_seconds();
179 + if seconds == 1 {
180 + parts.push(String::from("1 second"));
181 + } else if seconds > 1 {
182 + parts.push(format!("{} seconds", seconds));
183 + }
184 +
185 + if let Some(last) = parts.pop() {
186 + if parts.is_empty() {
187 + return last.to_string();
188 + }
189 + return parts.join(", ") + " and " + &last;
190 + } else {
191 + format!("{}", duration)
192 + }
193 +}
194 +
195 +async fn handle_ping(event: Value, arg: &str) -> Result<(), Error> {
196 + let event_id = event
197 + .get("event_id")
198 + .and_then(|value| value.as_str())
199 + .ok_or(anyhow!("missing event id"))?;
200 + let room_id = event
201 + .get("room_id")
202 + .and_then(|value| value.as_str())
203 + .ok_or(anyhow!("missing room id"))?;
204 + let origin_server_ts = event
205 + .get("origin_server_ts")
206 + .and_then(|value| value.as_i64())
207 + .ok_or(anyhow!("missing origin_server_ts"))?;
208 + let origin_server_time = chrono::NaiveDateTime::from_timestamp_millis(origin_server_ts)
209 + .ok_or(anyhow!("unable to convert origin_server_ts"))?
210 + .and_local_timezone(Utc)
211 + .single()
212 + .ok_or(anyhow!("unable to convert server time to single"))?;
213 +
214 + // respond with pong
215 + let sender = event
216 + .get("sender")
217 + .and_then(|value| value.as_str())
218 + .ok_or(anyhow!("missing sender"))?;
219 + let from = sender.rsplit(':').next().unwrap();
220 + let now = Utc::now();
221 + let duration = now - origin_server_time;
222 + let duration_string = format_duration(duration);
223 + let duration_ms = duration.num_milliseconds();
224 + let (quoted_arg, html_quoted_arg) = if arg.is_empty() {
225 + (String::new(), String::new())
226 + } else {
227 + (
228 + format!(" \"{}\"", arg),
229 + format!(" \"{}\"", html_escape::encode_text(arg)),
230 + )
231 + };
232 + let body = format!(
233 + "{}: Pong! (ping{} took {} to arrive",
234 + sender, quoted_arg, duration
235 + );
236 + let formatted_body = format!(
237 + r#"<a href="https://matrix.to/#/{}">{}</a>: Pong! (<a href="https://matrix.to/#/{}/{}">ping</a>{} took {} to arrive)"#,
238 + sender,
239 + html_escape::encode_text(sender),
240 + room_id,
241 + event_id,
242 + html_quoted_arg,
243 + duration_string
244 + );
245 + let out = json!({
246 + "msgtype": "m.notice",
247 + "body": body,
248 + "format": "org.matrix.custom.html",
249 + "formatted_body": formatted_body,
250 + "m.relates_to": {
251 + "rel_type": "xyz.maubot.pong",
252 + "event_id": event_id,
253 + "from": from,
254 + "ms": duration_ms,
255 + },
256 + "pong": {
257 + "ping": event_id,
258 + "from": from,
259 + "ms": duration_ms,
260 + }
261 + });
262 + send(room_id, out).await
263 +}
264 +
265 +fn generate_txid() -> String {
266 + format!("m{}", Utc::now().timestamp_millis())
267 +}
268 +
269 +async fn handle_echo(event: Value, arg: &str) -> Result<(), Error> {
270 + let room_id = event
271 + .get("room_id")
272 + .and_then(|value| value.as_str())
273 + .ok_or(anyhow!("missing room id"))?;
274 + let out = json!({
275 + "msgtype": "m.notice",
276 + "body": arg,
277 + });
278 + send(room_id, out).await
279 +}
280 +
281 +async fn send(room_id: &str, out: Value) -> Result<(), Error> {
282 + let as_token = var("AS_TOKEN").context("unable to get AS_TOKEN")?;
283 + let uri = format!(
284 + "/_matrix/client/r0/rooms/{}/send/m.room.message/{}?access_token={}",
285 + room_id, generate_txid(), as_token
286 + );
287 + let json = serde_json::to_string_pretty(&out).context("serialize event")?;
288 + let stream = TcpStream::connect("127.0.0.3:6167").await?;
289 + let (mut sender, conn) = hyper::client::conn::handshake(stream)
290 + .await
291 + .context("http handshake")?;
292 + tokio::task::spawn(async move {
293 + if let Err(err) = conn.await {
294 + println!("Connection failed: {:?}", err);
295 + }
296 + });
297 + let req = Request::builder()
298 + .uri(uri)
299 + .method(Method::PUT)
300 + .header(CONTENT_TYPE, "application/json")
301 + .body(Body::from(json))?;
302 + let res = sender.send_request(req).await?;
303 + if res.status() != StatusCode::OK {
304 + println!("Response status: {}", res.status());
305 + }
306 + let data = hyper::body::to_bytes(res)
307 + .await
308 + .context("read POST response")?;
309 + let obj: Map<String, Value> = serde_json::from_slice(&data).context("parsing response")?;
310 + let json = serde_json::to_string_pretty(&obj).context("serialize response")?;
311 + eprintln!("response: {}", json);
312 + Ok(())
313 +}
314 +
315 +fn serve_not_found() -> Result<Response<Body>, Error> {
316 + Response::builder()
317 + .status(StatusCode::NOT_FOUND)
318 + .body(Body::from("Not found\n"))
319 + .context("serving not found")
320 +}
systemd/pingbot.example.serviceView
@@ -1,0 +1,15 @@
1 +[Unit]
2 +Description=pingbot matrix appservice
3 +After=network.target
4 +Requires=pingbot.socket
5 +
6 +[Service]
7 +Environment=HS_TOKEN=EXAMPLE_HS_TOKEN
8 +Environment=AS_TOKEN=EXAMPLE_AS_TOKEN
9 +Restart=always
10 +RestartSec=5
11 +ExecStart=/usr/local/bin/pingbot-appservice
12 +DynamicUser=yes
13 +
14 +[Install]
15 +WantedBy=multi-user.target
systemd/pingbot.example.socketView
@@ -1,0 +1,5 @@
1 +[Unit]
2 +Description=pingbot matrix appservice socket
3 +
4 +[Socket]
5 +ListenStream=127.0.0.3:7001

Built with git-ssb-web