├── .github
└── FUNDING.yml
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── admin.go
├── chat.go
├── data
├── adjectives.go
└── animals.go
├── go.mod
├── go.sum
├── html
├── about.html
├── admin.html
├── index.css
├── index.html
├── privacy_policy.html
└── simple.css
├── main.go
├── message.go
├── neartalk.example.service
├── nicknames.go
└── version.go
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | github: makew0rld
2 | ko_fi: makeworld
3 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Binary
2 | neartalk
3 | # My personal SystemD service file, that contains the admin key
4 | neartalk.service
5 | # My personal notes
6 | NOTES.md
7 |
8 | # Created by https://www.toptal.com/developers/gitignore/api/go,visualstudiocode,linux
9 | # Edit at https://www.toptal.com/developers/gitignore?templates=go,visualstudiocode,linux
10 |
11 | ### Go ###
12 | # Binaries for programs and plugins
13 | *.exe
14 | *.exe~
15 | *.dll
16 | *.so
17 | *.dylib
18 |
19 | # Test binary, built with `go test -c`
20 | *.test
21 |
22 | # Output of the go coverage tool, specifically when used with LiteIDE
23 | *.out
24 |
25 | # Dependency directories (remove the comment below to include it)
26 | # vendor/
27 |
28 | ### Go Patch ###
29 | /vendor/
30 | /Godeps/
31 |
32 | ### Linux ###
33 | *~
34 |
35 | # temporary files which can be created if a process still has a handle open of a deleted file
36 | .fuse_hidden*
37 |
38 | # KDE directory preferences
39 | .directory
40 |
41 | # Linux trash folder which might appear on any partition or disk
42 | .Trash-*
43 |
44 | # .nfs files are created when an open file is removed but is still being accessed
45 | .nfs*
46 |
47 | ### VisualStudioCode ###
48 | .vscode/*
49 | !.vscode/settings.json
50 | !.vscode/tasks.json
51 | !.vscode/launch.json
52 | !.vscode/extensions.json
53 | *.code-workspace
54 |
55 | # Local History for Visual Studio Code
56 | .history/
57 |
58 | ### VisualStudioCode Patch ###
59 | # Ignore all local history of files
60 | .history
61 | .ionide
62 |
63 | # End of https://www.toptal.com/developers/gitignore/api/go,visualstudiocode,linux
64 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
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
637 | by 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 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | GITV != git describe --tags
2 | GITC != git rev-parse --verify HEAD
3 | SRC != find . -type f -name '*.go' ! -name '*_test.go'
4 | TEST != find . -type f -name '*_test.go'
5 |
6 | PREFIX ?= /usr/local
7 | VERSION ?= $(GITV)
8 | COMMIT ?= $(GITC)
9 | BUILDER ?= Makefile
10 |
11 | GO := go
12 | INSTALL := install
13 | RM := rm
14 |
15 | neartalk: go.mod go.sum $(SRC)
16 | GO111MODULE=on CGO_ENABLED=0 $(GO) build -o $@ -ldflags="-s -w -X main.version=$(VERSION) -X main.commit=$(COMMIT) -X main.builtBy=$(BUILDER)"
17 |
18 | .PHONY: clean
19 | clean:
20 | $(RM) -f neartalk
21 |
22 | .PHONY: install
23 | install: neartalk
24 | install -d $(PREFIX)/bin/
25 | install -m 755 neartalk $(PREFIX)/bin/neartalk
26 |
27 | .PHONY: uninstall
28 | uninstall:
29 | $(RM) -f $(PREFIX)/bin/neartalk
30 |
31 | # Development helpers
32 | .PHONY: fmt
33 | fmt:
34 | go fmt ./...
35 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # NearTalk
2 |
3 | Visit [neartalk.makeworld.space](https://neartalk.makeworld.space) to check it out! That server always runs the latest code on the `main` branch.
4 |
5 |
6 |
7 |
What is it?
8 |
9 | NearTalk is chat platform to talk to people nearby.
10 |
11 |
12 | Anyone with the same IP address is in the same chat room. For example, everyone
13 | in your house will get the same chat room if they visit NearTalk. If you go to
14 | your local coffee shop, everyone who visit NearTalk will be in the same chat room.
15 | This extends to larger organizations like college/university campuses.
16 |
17 |
18 | Depending on how the network is set up, all mobile devices using data with the same
19 | network provider as you may be chatting together. Or similarly, all the other homes
20 | using the same ISP. This is the minority of cases however.
21 |
22 |
Why is it?
23 |
24 | For fun, mostly. I wanted to make a chat application and I wanted to use
25 | htmx, and this seemed like a fun idea.
26 |
27 |
28 | There are many reasons why NearTalk isn't useful, and talking to your fellow humans
29 | face to face
30 | is much better. However there are some times when having a local chatroom is useful,
31 | like for discussing (or dragging) a presentation going on. At the end of the day,
32 | I'm happy to have made something.
33 |
34 |
35 |
36 |
37 | ## Building
38 |
39 | GNU Make is required to use the Makefile. Compiling with `make` automatically embeds version information into the binary from Git, and it's the only supported way to build the project.
40 |
41 | Only the latest Go (1.17) is tested, but Go 1.16+ should compile.
42 |
43 | ## Deploying
44 |
45 | You can look at the [neartalk.example.service](./neartalk.example.service) file in the repo as an example for running NearTalk under systemd.
46 |
47 | Currently the code does not handle TLS certificates, and so a reverse-proxy is required to use TLS and ensure user security. Make sure you set up your reverse-proxy so that websockets work as well. Just look up ` reverse proxy websocket` to find a configuration.
48 |
49 | Currently the code is also designed to work under a domain or subdomain, not a subpath.
50 |
51 | Please let me know why you deploy your own instance if you do!
52 |
53 | ## License
54 |
55 | NearTalk is licensed under the [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html). If host your own version, you must release your source code.
56 |
--------------------------------------------------------------------------------
/admin.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | // This file has functions that handle the admin interface over HTTP.
4 |
5 | import (
6 | "bufio"
7 | "fmt"
8 | "io"
9 | "log"
10 | "net/http"
11 | "net/url"
12 | "os"
13 | "strings"
14 | "time"
15 |
16 | "github.com/dustin/go-humanize"
17 | )
18 |
19 | // adminHandler serves the admin.html file, but checks if the provided key is correct first.
20 | func (cs *chatServer) adminHandler(w http.ResponseWriter, r *http.Request) {
21 | query, err := url.QueryUnescape(r.URL.RawQuery)
22 | if err != nil {
23 | // Shouldn't happnen unless there's a browser bug I guess
24 | query = r.URL.RawQuery
25 | }
26 | if query != adminKey {
27 | w.WriteHeader(http.StatusForbidden)
28 | return
29 | }
30 | adminHtml, err := os.Open("html/admin.html")
31 | if err != nil {
32 | log.Printf("chatServer.adminHandler: err opening admin.html: %v", err)
33 | w.WriteHeader(http.StatusInternalServerError)
34 | return
35 | }
36 | defer adminHtml.Close()
37 | io.Copy(w, adminHtml)
38 | }
39 |
40 | func (cs *chatServer) adminDataHandler(rw http.ResponseWriter, r *http.Request) {
41 | if !strings.HasSuffix(r.Header.Get("HX-Current-URL"), "?"+url.QueryEscape(adminKey)) {
42 | // Admin data wasn't requested from inside the admin page
43 | rw.WriteHeader(http.StatusForbidden)
44 | return
45 | }
46 |
47 | cs.roomsMu.Lock()
48 | defer cs.roomsMu.Unlock()
49 |
50 | // Write HTML data as it's processed, but with a buffer
51 | w := bufio.NewWriter(rw)
52 | fmt.Fprintf(w, `
%d chat rooms
`, len(cs.rooms))
53 | for ip, room := range cs.rooms {
54 | fmt.Fprintf(
55 | w, `
%s
%d chatters
Last message: %s
`,
56 | ip, room.numClients(), humanize.RelTime(room.whenLastMsg, time.Now(), "ago", "from now"),
57 | )
58 | }
59 | w.Flush()
60 | }
61 |
--------------------------------------------------------------------------------
/chat.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | // This file handles the majority of the application.
4 | // Chat messages, HTTP server, websocket handling, etc.
5 | //
6 | // It was adapted from some chat example code by nhooyr:
7 | // https://github.com/nhooyr/websocket/tree/b6adc4bc5c001d513d1604ec9efd97e73e1d082a/examples/chat
8 | // That code is under the MIT license, so there are no licensing issues with it
9 | // being adapted for here. Note it was adapted, and not directly copied. The
10 | // example was used as a starting point.
11 |
12 | import (
13 | "context"
14 | "errors"
15 | "fmt"
16 | "log"
17 | "net"
18 | "net/http"
19 | "sort"
20 | "strings"
21 | "sync"
22 | "time"
23 |
24 | "golang.org/x/time/rate"
25 | "nhooyr.io/websocket"
26 | "nhooyr.io/websocket/wsjson"
27 | )
28 |
29 | // clientMsgBuffer controls the max number
30 | // of messages that can be queued for a client
31 | // before it is kicked.
32 | const clientMsgBuffer = 16
33 |
34 | // The max number of unprocessed messages from clients the server can have
35 | // before clients are prevented from sending more messages.
36 | const serverMsgBuffer = 20
37 |
38 | // msg is used to pass messages from users around in the server code.
39 | type msg struct {
40 | // nick is the nickname of the user at the time the message was sent.
41 | // An empty nickname indicates this is a message from the server.
42 | nick string
43 | // text is the message text. It is stored unsanitized.
44 | text string
45 | // author points to the client that sent the message. A nil author
46 | // indicates this message is from the server
47 | author *client
48 | // when is when the message was sent.
49 | when time.Time
50 | // raw is a string that indicates that is message was pre-rendered to HTML,
51 | // and doesn't need any processing.
52 | // TODO: this is a hack to allow the server to queue messages custom
53 | // messages, like join/leave
54 | raw string
55 | }
56 |
57 | type chatRoom struct {
58 | // incoming is where messages sent by clients are temporarily stored.
59 | incoming chan msg
60 | // quit is used to stop the chatRoom goroutine
61 | quit chan struct{}
62 | // limiter rate limits the messages sent to the server for this room.
63 | // This prevents the server from being spammed by messages.
64 | limiter *rate.Limiter
65 | // whenLastMsg is when the most recent message was sent
66 | whenLastMsg time.Time
67 |
68 | clientsMu sync.Mutex
69 | clients map[*client]struct{} // map is used for easy removal
70 | }
71 |
72 | func newChatRoom() *chatRoom {
73 | cr := &chatRoom{
74 | incoming: make(chan msg, serverMsgBuffer),
75 | quit: make(chan struct{}),
76 | clients: make(map[*client]struct{}),
77 | // TODO: is this a good limiter?
78 | limiter: rate.NewLimiter(rate.Every(time.Millisecond*100), 8),
79 | }
80 | go cr.start()
81 | return cr
82 | }
83 |
84 | func (cr *chatRoom) start() {
85 | for {
86 | select {
87 | case <-cr.quit:
88 | return
89 | case m := <-cr.incoming:
90 | cr.limiter.Wait(context.Background())
91 |
92 | authorMsg, chatMsg := cr.handleMsg(m)
93 | if chatMsg == "" {
94 | // No message needs to be sent to all clients
95 | continue
96 | }
97 | cr.clientsMu.Lock()
98 | for c := range cr.clients {
99 | if m.author == c {
100 | // This client sent the message, so clear their input field
101 | c.sendText(authorMsg + clearInputFieldMsg)
102 | } else {
103 | c.sendText(chatMsg)
104 | }
105 | }
106 | cr.clientsMu.Unlock()
107 | }
108 | }
109 | }
110 |
111 | // addClient adds a client to the chat room.
112 | // It also generates a nickname for them.
113 | // The chatServer addClient method should be used by clients instead.
114 | func (cr *chatRoom) addClient(c *client) {
115 | cr.clientsMu.Lock()
116 | defer cr.clientsMu.Unlock()
117 |
118 | c.nick = cr.getNewNick()
119 | cr.clients[c] = struct{}{}
120 | cr.incoming <- createJoinMsg(c, cr.nicks())
121 | }
122 |
123 | // removeClient removes a client from the chat room.
124 | // The chatServer removeClient method should be used by clients instead.
125 | func (cr *chatRoom) removeClient(c *client) {
126 | cr.clientsMu.Lock()
127 | defer cr.clientsMu.Unlock()
128 |
129 | delete(cr.clients, c)
130 | if len(cr.clients) > 0 {
131 | // Send leave message to clients left in the room
132 | cr.incoming <- createLeaveMsg(c, cr.nicks())
133 | }
134 | }
135 |
136 | // numClients returns the number of clients in the room.
137 | // It holds the client mutex.
138 | func (cr *chatRoom) numClients() int {
139 | cr.clientsMu.Lock()
140 | defer cr.clientsMu.Unlock()
141 | return len(cr.clients)
142 | }
143 |
144 | // nickInUse returns a bool that indicates whether the provided nickname is
145 | // already used by another client. It does not lock the clientsMu, callers
146 | // should do that.
147 | func (cr *chatRoom) nickInUse(nick string) bool {
148 | for c := range cr.clients {
149 | if nick == c.nick {
150 | return true
151 | }
152 | }
153 | return false
154 | }
155 |
156 | // getNewNick returns a random nickname that no other client in the room has used.
157 | // It does not lock the clientsMu, callers should do that.
158 | func (cr *chatRoom) getNewNick() string {
159 | // If nick is already used, just increment number until it's not
160 |
161 | ogNick := genNick()
162 | nick := ogNick
163 | i := 2
164 | for cr.nickInUse(nick) {
165 | nick = fmt.Sprintf("%s%d", ogNick, i)
166 | i++
167 | }
168 | return nick
169 | }
170 |
171 | // nicks returns all the nicknames currently in use in this chat room.
172 | // The nicknames are sorted alphabetically.
173 | // It does not lock the clientsMu, callers should do that.
174 | func (cr *chatRoom) nicks() []string {
175 | nks := make([]string, len(cr.clients))
176 |
177 | i := 0
178 | for c := range cr.clients {
179 | nks[i] = c.nick
180 | i++
181 | }
182 | sort.Strings(nks)
183 | return nks
184 | }
185 |
186 | type client struct {
187 | // nick (nickname) is the name that appears beside every chat message they send.
188 | // It is stored sanitized.
189 | nick string
190 | // outgoing is where messages to be sent to the client are temporarily stored.
191 | // It recieves pre-rendered messages, no processing is needed.
192 | outgoing chan string
193 | // closeSlow is called if the client can't keep up with messages
194 | closeSlow func()
195 | }
196 |
197 | // sendText tries to send the provided string to the client. If the client's
198 | // outgoing channel is full, the client's closeSlow func is called in a goroutine.
199 | func (c *client) sendText(s string) {
200 | select {
201 | case c.outgoing <- s:
202 | default:
203 | go c.closeSlow()
204 |
205 | }
206 | }
207 |
208 | // chatServer manages all the chat rooms.
209 | // There should only be one instance of it for the site.
210 | type chatServer struct {
211 | // rooms maps IP address strings to chat rooms
212 | rooms map[string]*chatRoom
213 | roomsMu sync.Mutex
214 |
215 | serveMux http.ServeMux
216 | }
217 |
218 | func newChatServer() *chatServer {
219 | cs := &chatServer{
220 | rooms: make(map[string]*chatRoom),
221 | }
222 | cs.serveMux.Handle("/", noCacheHandler(http.StripPrefix("/", http.FileServer(http.Dir("html")))))
223 | cs.serveMux.HandleFunc("/connect", cs.connectHandler)
224 | cs.serveMux.HandleFunc("/admin", noCache(cs.adminHandler))
225 | cs.serveMux.HandleFunc("/admin.html", noCache(cs.adminHandler))
226 | cs.serveMux.HandleFunc("/admin-data", cs.adminDataHandler)
227 | cs.serveMux.HandleFunc("/version", func(w http.ResponseWriter, r *http.Request) {
228 | fmt.Fprint(w, versionInfo)
229 | })
230 | return cs
231 | }
232 |
233 | // noCache disables caching of responses.
234 | func noCache(next http.HandlerFunc) http.HandlerFunc {
235 | return func(rw http.ResponseWriter, r *http.Request) {
236 | rw.Header().Add("Cache-Control", "no-store, max-age=0")
237 | rw.Header().Add("Pragma", "no-cache")
238 | next(rw, r)
239 | }
240 | }
241 |
242 | // noCacheHandler disables caching of responses for http.Handler.
243 | func noCacheHandler(h http.Handler) http.HandlerFunc {
244 | return func(rw http.ResponseWriter, r *http.Request) {
245 | rw.Header().Add("Cache-Control", "no-store, max-age=0")
246 | rw.Header().Add("Pragma", "no-cache")
247 | h.ServeHTTP(rw, r)
248 | }
249 | }
250 |
251 | // addClient adds a client to the approriate chat room, creating it if needed.
252 | // The room the client is in is returned. It also generates and sets a nickname
253 | // for the client.
254 | func (cs *chatServer) addClient(ip string, c *client) *chatRoom {
255 | cs.roomsMu.Lock()
256 | defer cs.roomsMu.Unlock()
257 |
258 | room, ok := cs.rooms[ip]
259 | if !ok {
260 | // Room didn't previously exist, create it
261 | room = newChatRoom()
262 | cs.rooms[ip] = room
263 | }
264 |
265 | // Nickname generation happens inside the room func
266 | room.addClient(c)
267 |
268 | // Insert room name
269 | c.outgoing <- fmt.Sprintf(`
14 | NearTalk is chat platform to talk to people nearby.
15 |
16 |
17 | Anyone with the same IP address is in the same chat room. For example, everyone
18 | in your house will get the same chat room if they visit NearTalk. If you go to
19 | your local coffee shop, everyone who visits NearTalk will be in the same chat room.
20 | This extends to larger organizations like college/university campuses.
21 |
22 |
23 | Depending on how the network is set up, all mobile devices using data with the same
24 | network provider as you may be chatting together. Or similarly, all the other homes
25 | using the same ISP. This is the minority of cases however.
26 |
27 |
Why is it?
28 |
29 | For fun, mostly. I wanted to make a chat application and I wanted to use
30 | htmx, and this seemed like a fun idea.
31 |
32 |
33 | There are many reasons why NearTalk isn't useful, and talking to your fellow humans
34 | face to face
35 | is much better. However there are a few times when having a local chatroom is useful,
36 | like for discussing (or dragging) a presentation going on. At the end of the day,
37 | I'm happy to have made something.
38 |
39 |
How do I change my nickname?
40 |
41 | Send this special message: /nick my-new-nickname
42 | It will go away when you reload the page.
43 |
44 |
Source code? Self hosting?
45 |
46 | Of course! NearTalk is licensed under the AGPLv3,
47 | and source code is available on GitHub.
48 |
49 |
50 | You're welcome to host your own version, as long as you comply with the license by publishing your source
51 | code. Feel free to report bugs and submit PRs as well!
52 |
53 |
Contact
54 |
55 | You can email me about NearTalk at: makeworld (AT) protonmail (DOT) com
56 |
57 |
58 | I'd be happy to hear about any fun stories.
59 |
13 | NearTalk is intended to be a privacy-preserving service.
14 | Your data is yours, and I don't want it.
15 |
16 |
17 | No data is retained long term. If the service experiences abuse I may turn on HTTP logging,
18 | meaning IP addresses, user agents, and times when the site was visited would be available to me.
19 | Currently, even that is not turned on, so no data is retained.
20 |
21 |
22 | The content of messages is never stored anywhere. It is removed from the server RAM as soon as
23 | the message has be sent to all users in the chat room.
24 |
25 |
26 | As server admin, I can ONLY see:
27 |
28 |
IP addresses
29 |
Number of chat rooms
30 |
When the last message was sent in each room
31 |
32 | Nothing else is available to me, by design, and none of this is saved permanently.
33 |
34 |
35 | If you'd like to verify this yourself, you can read the
36 | source code.
37 |
38 |
39 |
--------------------------------------------------------------------------------
/html/simple.css:
--------------------------------------------------------------------------------
1 | /*
2 | Hi there! Please take this CSS and use it for your own projects.
3 | It's a great little thing.
4 | */
5 |
6 | body {
7 | margin: 40px auto;
8 | max-width: 720px;
9 | line-height: 1.6;
10 | font-size: 18px;
11 | color: rgb(0, 0, 0);
12 | padding: 0 20px;
13 | word-wrap: break-word;
14 | font-family: Sans-Serif;
15 | }
16 |
17 | h1, h2, h3 {
18 | line-height: 1.2
19 | }
20 |
--------------------------------------------------------------------------------
/main.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "context"
5 | "flag"
6 | "fmt"
7 | "log"
8 | "math/rand"
9 | "net"
10 | "net/http"
11 | "os"
12 | "os/signal"
13 | "strconv"
14 | "syscall"
15 | "time"
16 | )
17 |
18 | // Flag vars
19 | var (
20 | host string
21 | port uint
22 | adminKey string
23 | versionFlag bool
24 | )
25 |
26 | func main() {
27 | flag.StringVar(&host, "host", "127.0.0.1", "Host for HTTP server")
28 | flag.UintVar(&port, "port", 8000, "Port number for HTTP server")
29 | flag.StringVar(&adminKey, "key", "", "Key/password to access admin interface")
30 | flag.BoolVar(&versionFlag, "version", false, "See version info")
31 | flag.Parse()
32 |
33 | if versionFlag {
34 | fmt.Print(versionInfo)
35 | return
36 | }
37 | if adminKey == "" {
38 | fmt.Println("No admin key set! Use -help for details.")
39 | return
40 | }
41 |
42 | err := run()
43 | if err != nil {
44 | log.Fatal(err)
45 | }
46 | }
47 |
48 | func run() error {
49 | rand.Seed(time.Now().UnixNano())
50 |
51 | l, err := net.Listen("tcp", net.JoinHostPort(host, strconv.FormatUint(uint64(port), 10)))
52 | if err != nil {
53 | return err
54 | }
55 | log.Printf("listening on http://%v", l.Addr())
56 |
57 | // Create and run HTTP server
58 | cs := newChatServer()
59 | s := &http.Server{
60 | Handler: cs,
61 | ReadTimeout: time.Second * 10,
62 | WriteTimeout: time.Second * 10,
63 | }
64 | errc := make(chan error, 1)
65 | go func() {
66 | errc <- s.Serve(l)
67 | }()
68 |
69 | // Wait for server error or process signals (like Ctrl-C)
70 | sigs := make(chan os.Signal, 1)
71 | signal.Notify(sigs, os.Interrupt, syscall.SIGTERM)
72 | select {
73 | case err := <-errc:
74 | log.Printf("failed to serve: %v", err)
75 | case sig := <-sigs:
76 | log.Printf("terminating: %v", sig)
77 | }
78 |
79 | // Gracefully shut down HTTP server with 5 second timeout
80 | ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
81 | defer cancel()
82 | return s.Shutdown(ctx)
83 | }
84 |
--------------------------------------------------------------------------------
/message.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | // This file deals with messages coming from or going to the web UI.
4 | // The web UI uses htmx (htmx.org) and so HTML is passed over the websocket for
5 | // updates.
6 | // Like with any chat service, messages coming in have to sanitized.
7 | // This file also deals with rendering any kinds of special messages, like red
8 | // for errors.
9 |
10 | import (
11 | "fmt"
12 | "html"
13 | "regexp"
14 | "strings"
15 | "time"
16 |
17 | "github.com/rivo/uniseg"
18 | "golang.org/x/text/unicode/norm"
19 | )
20 |
21 | const maxNickLen = 30
22 | const maxMsgTextLen = 512
23 |
24 | // URL Regex
25 | // Source:
26 | // John Gruber has a blog post: https://daringfireball.net/2010/07/improved_regex_for_matching_urls
27 | // That links to this gist: https://gist.github.com/gruber/249502
28 | // I modified the regex slightly for Go (\x60 instead of `)
29 | // I also changed it so it wouldn't recognize non-URLs like "bit.com/test"
30 | // I also made the protocol required
31 | // I applied the change mention in this comment:
32 | // https://gist.github.com/gruber/249502#gistcomment-1381560
33 | // That way magnet links and similar are picked up
34 | var urlRe = regexp.MustCompile(`(?i)\b(?:[a-z][\w.+-]+:(?:/{1,3}|[?+]?[a-z0-9%]))(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()<>]+\)))*\)|[^\s\x60!()\[\]{};:'".,<>?«»“”‘’])`)
35 |
36 | // Sending this through the websocket to htmx clears whatever message was
37 | // written in the input field. This is used to clear the field after the user
38 | // sends a message.
39 | const clearInputFieldMsg = ``
40 |
41 | // createChatMsg takes the message from a user and returns HTML
42 | // that can be sent over websocket to the htmx web UI.
43 | // It returns two messages, one for the author, and one for everyone else.
44 | // It will return empty strings if the provided msg is considered invalid.
45 | func createChatMsg(m msg) (string, string) {
46 | sanitizedMsgText := renderMsgText(m.text)
47 | if !isMsgTextValid(sanitizedMsgText) {
48 | return "", ""
49 | }
50 | ts := m.when.UTC().Format(time.RFC3339)
51 | author := fmt.Sprintf(
52 | // Add message to log
53 | `
54 |
62 | `,
63 | ts, m.nick, sanitizedMsgText,
64 | )
65 | return author, nonAuthor
66 | }
67 |
68 | func isMsgTextValid(s string) bool {
69 | return s != ""
70 | }
71 |
72 | // createUserListMsg creates HTML that can replace the current user list.
73 | // It assume the nicknames provided are already HTML escaped.
74 | func createUserListMsg(nicks []string) string {
75 | var b strings.Builder
76 | b.WriteString(`
`)
77 | for i := range nicks {
78 | b.WriteString(fmt.Sprintf(`
%s
`, nicks[i]))
79 | }
80 | b.WriteString(`
`)
81 | b.WriteString(fmt.Sprintf(`
Users (%d)
`, len(nicks)))
82 | return b.String()
83 | }
84 |
85 | // createSpecialMsg creates a message not from any specific user, that has a
86 | // CSS class. This can be used for error messages, or notifications.
87 | func createSpecialMsg(text string, class string) string {
88 | var ts string
89 | if class == "notif" {
90 | // Notification messages are timestamped
91 | ts = time.Now().UTC().Format(time.RFC3339)
92 | }
93 | return fmt.Sprintf(
94 | // Add message to log
95 | `
96 |
%s
%s
97 | `,
98 | ts, class, html.EscapeString(text),
99 | )
100 | }
101 |
102 | // createJoinMsg creates a msg struct that can be sent to a chat room when a client joins.
103 | func createJoinMsg(c *client, nicks []string) msg {
104 | return msg{
105 | raw: createSpecialMsg(fmt.Sprintf("%s has joined", c.nick), "notif") +
106 | createUserListMsg(nicks),
107 | when: time.Now(),
108 | }
109 | }
110 |
111 | // createLeaveMsg creates a msg struct that can be sent to a chat room when a client leaves.
112 | func createLeaveMsg(c *client, nicks []string) msg {
113 | return msg{
114 | raw: createSpecialMsg(fmt.Sprintf("%s has left", c.nick), "notif") +
115 | createUserListMsg(nicks),
116 | when: time.Now(),
117 | }
118 | }
119 |
120 | func sanitizeNick(nick string) string {
121 | nick = strings.ToValidUTF8(nick, "\uFFFD")
122 | nick = strings.TrimSpace(nick)
123 | // Unicode normalization, to prevent look-alike nicknames
124 | nick = norm.NFC.String(nick)
125 |
126 | // Truncate by graphemes instead of runes, so multi-rune things like flags work
127 | g := uniseg.NewGraphemes(nick)
128 | i := 0
129 | nick = ""
130 | for g.Next() && i < maxNickLen {
131 | nick += g.Str()
132 | i++
133 | }
134 |
135 | nick = html.EscapeString(nick)
136 | return nick
137 | }
138 |
139 | func renderMsgText(text string) string {
140 | text = strings.ToValidUTF8(text, "\uFFFD")
141 | text = strings.TrimSpace(text)
142 |
143 | // TODO: is this too slow?
144 | g := uniseg.NewGraphemes(text)
145 | i := 0
146 | var b strings.Builder
147 | for g.Next() && i < maxMsgTextLen {
148 | b.Write(g.Bytes())
149 | i++
150 | }
151 | text = b.String()
152 | text = html.EscapeString(text)
153 |
154 | // Linkify URLs
155 | text = urlRe.ReplaceAllStringFunc(text, func(urlText string) string {
156 | return fmt.Sprintf(`%s`, urlText, urlText)
157 | })
158 |
159 | return text
160 | }
161 |
162 | // Message handlers
163 |
164 | // handleMsg takes a msg and performs the appropriate action.
165 | // This may involve sending a message back to the author. If a message should
166 | // sent to all chat room clients, handleMsg returns a two strings, one to send
167 | // to the author, and another to send to everyone else.
168 | // Otherwise empty strings are returned.
169 | func (cr *chatRoom) handleMsg(m msg) (string, string) {
170 | cr.clientsMu.Lock()
171 | defer cr.clientsMu.Unlock()
172 |
173 | if m.raw != "" {
174 | // Message is already rendered
175 | return m.raw, m.raw
176 | }
177 |
178 | if strings.HasPrefix(m.text, "/nick ") && len(m.text) > len("/nick ") {
179 | newNick := sanitizeNick(m.text[len("/nick "):])
180 | if newNick == "" {
181 | // Empty nickname, invalid
182 | m.author.sendText(createSpecialMsg("Nickname cannot be empty", "error"))
183 | return "", ""
184 | }
185 | if cr.nickInUse(newNick) {
186 | m.author.sendText(createSpecialMsg("That nickname is already in use", "error"))
187 | return "", ""
188 | }
189 | oldNick := m.author.nick
190 | m.author.nick = newNick
191 | // Tell everyone about name change, and update user list
192 | s := createSpecialMsg(
193 | fmt.Sprintf("%s is now known as %s", oldNick, newNick), "notif",
194 | ) +
195 | createUserListMsg(cr.nicks())
196 | return s, s
197 | }
198 |
199 | // Regular message
200 | cr.whenLastMsg = m.when
201 | return createChatMsg(m)
202 | }
203 |
--------------------------------------------------------------------------------
/neartalk.example.service:
--------------------------------------------------------------------------------
1 | # This is an example systemd service file for deploying NearTalk
2 | # "webserver" is the web server you are using for reverse proxying.
3 |
4 | [Unit]
5 | Description=NearTalk server
6 | After=webserver.service
7 |
8 | [Install]
9 | WantedBy=webserver.service
10 |
11 | [Service]
12 | WorkingDirectory=/path/to/neartalk-git
13 | ExecStart=/path/to/neartalk-git/neartalk -port 1234 -key PUT-ADMIN-KEY-HERE
14 | Restart=always
15 |
--------------------------------------------------------------------------------
/nicknames.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "fmt"
5 | "math/rand"
6 | "strings"
7 |
8 | "github.com/makeworld-the-better-one/neartalk/data"
9 | )
10 |
11 | // genNick returns a new random nickname.
12 | func genNick() string {
13 | adjective := data.Adjectives[rand.Intn(len(data.Adjectives))]
14 | animal := data.Animals[rand.Intn(len(data.Animals))]
15 |
16 | // Convert to CamelCase
17 | return strings.ReplaceAll(
18 | strings.Title(fmt.Sprintf("%s %s", adjective, animal)),
19 | " ", "",
20 | )
21 | }
22 |
--------------------------------------------------------------------------------
/version.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import "fmt"
4 |
5 | // Version info. This is set by the Makefile
6 | var (
7 | version string
8 | commit string
9 | builtBy string
10 | )
11 |
12 | var versionInfo = fmt.Sprintf("Version: %s\nCommit: %s\nBuilt by: %s\n", version, commit, builtBy)
13 |
--------------------------------------------------------------------------------