Unbewohnte
3 years ago
commit
61e21e8309
29 changed files with 2178 additions and 0 deletions
@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE |
||||
Version 3, 29 June 2007 |
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> |
||||
Everyone is permitted to copy and distribute verbatim copies |
||||
of this license document, but changing it is not allowed. |
||||
|
||||
Preamble |
||||
|
||||
The GNU General Public License is a free, copyleft license for |
||||
software and other kinds of works. |
||||
|
||||
The licenses for most software and other practical works are designed |
||||
to take away your freedom to share and change the works. By contrast, |
||||
the GNU General Public License is intended to guarantee your freedom to |
||||
share and change all versions of a program--to make sure it remains free |
||||
software for all its users. We, the Free Software Foundation, use the |
||||
GNU General Public License for most of our software; it applies also to |
||||
any other work released this way by its authors. You can apply it to |
||||
your programs, too. |
||||
|
||||
When we speak of free software, we are referring to freedom, not |
||||
price. Our General Public Licenses are designed to make sure that you |
||||
have the freedom to distribute copies of free software (and charge for |
||||
them if you wish), that you receive source code or can get it if you |
||||
want it, that you can change the software or use pieces of it in new |
||||
free programs, and that you know you can do these things. |
||||
|
||||
To protect your rights, we need to prevent others from denying you |
||||
these rights or asking you to surrender the rights. Therefore, you have |
||||
certain responsibilities if you distribute copies of the software, or if |
||||
you modify it: responsibilities to respect the freedom of others. |
||||
|
||||
For example, if you distribute copies of such a program, whether |
||||
gratis or for a fee, you must pass on to the recipients the same |
||||
freedoms that you received. You must make sure that they, too, receive |
||||
or can get the source code. And you must show them these terms so they |
||||
know their rights. |
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps: |
||||
(1) assert copyright on the software, and (2) offer you this License |
||||
giving you legal permission to copy, distribute and/or modify it. |
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains |
||||
that there is no warranty for this free software. For both users' and |
||||
authors' sake, the GPL requires that modified versions be marked as |
||||
changed, so that their problems will not be attributed erroneously to |
||||
authors of previous versions. |
||||
|
||||
Some devices are designed to deny users access to install or run |
||||
modified versions of the software inside them, although the manufacturer |
||||
can do so. This is fundamentally incompatible with the aim of |
||||
protecting users' freedom to change the software. The systematic |
||||
pattern of such abuse occurs in the area of products for individuals to |
||||
use, which is precisely where it is most unacceptable. Therefore, we |
||||
have designed this version of the GPL to prohibit the practice for those |
||||
products. If such problems arise substantially in other domains, we |
||||
stand ready to extend this provision to those domains in future versions |
||||
of the GPL, as needed to protect the freedom of users. |
||||
|
||||
Finally, every program is threatened constantly by software patents. |
||||
States should not allow patents to restrict development and use of |
||||
software on general-purpose computers, but in those that do, we wish to |
||||
avoid the special danger that patents applied to a free program could |
||||
make it effectively proprietary. To prevent this, the GPL assures that |
||||
patents cannot be used to render the program non-free. |
||||
|
||||
The precise terms and conditions for copying, distribution and |
||||
modification follow. |
||||
|
||||
TERMS AND CONDITIONS |
||||
|
||||
0. Definitions. |
||||
|
||||
"This License" refers to version 3 of the GNU General Public License. |
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of |
||||
works, such as semiconductor masks. |
||||
|
||||
"The Program" refers to any copyrightable work licensed under this |
||||
License. Each licensee is addressed as "you". "Licensees" and |
||||
"recipients" may be individuals or organizations. |
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work |
||||
in a fashion requiring copyright permission, other than the making of an |
||||
exact copy. The resulting work is called a "modified version" of the |
||||
earlier work or a work "based on" the earlier work. |
||||
|
||||
A "covered work" means either the unmodified Program or a work based |
||||
on the Program. |
||||
|
||||
To "propagate" a work means to do anything with it that, without |
||||
permission, would make you directly or secondarily liable for |
||||
infringement under applicable copyright law, except executing it on a |
||||
computer or modifying a private copy. Propagation includes copying, |
||||
distribution (with or without modification), making available to the |
||||
public, and in some countries other activities as well. |
||||
|
||||
To "convey" a work means any kind of propagation that enables other |
||||
parties to make or receive copies. Mere interaction with a user through |
||||
a computer network, with no transfer of a copy, is not conveying. |
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices" |
||||
to the extent that it includes a convenient and prominently visible |
||||
feature that (1) displays an appropriate copyright notice, and (2) |
||||
tells the user that there is no warranty for the work (except to the |
||||
extent that warranties are provided), that licensees may convey the |
||||
work under this License, and how to view a copy of this License. If |
||||
the interface presents a list of user commands or options, such as a |
||||
menu, a prominent item in the list meets this criterion. |
||||
|
||||
1. Source Code. |
||||
|
||||
The "source code" for a work means the preferred form of the work |
||||
for making modifications to it. "Object code" means any non-source |
||||
form of a work. |
||||
|
||||
A "Standard Interface" means an interface that either is an official |
||||
standard defined by a recognized standards body, or, in the case of |
||||
interfaces specified for a particular programming language, one that |
||||
is widely used among developers working in that language. |
||||
|
||||
The "System Libraries" of an executable work include anything, other |
||||
than the work as a whole, that (a) is included in the normal form of |
||||
packaging a Major Component, but which is not part of that Major |
||||
Component, and (b) serves only to enable use of the work with that |
||||
Major Component, or to implement a Standard Interface for which an |
||||
implementation is available to the public in source code form. A |
||||
"Major Component", in this context, means a major essential component |
||||
(kernel, window system, and so on) of the specific operating system |
||||
(if any) on which the executable work runs, or a compiler used to |
||||
produce the work, or an object code interpreter used to run it. |
||||
|
||||
The "Corresponding Source" for a work in object code form means all |
||||
the source code needed to generate, install, and (for an executable |
||||
work) run the object code and to modify the work, including scripts to |
||||
control those activities. However, it does not include the work's |
||||
System Libraries, or general-purpose tools or generally available free |
||||
programs which are used unmodified in performing those activities but |
||||
which are not part of the work. For example, Corresponding Source |
||||
includes interface definition files associated with source files for |
||||
the work, and the source code for shared libraries and dynamically |
||||
linked subprograms that the work is specifically designed to require, |
||||
such as by intimate data communication or control flow between those |
||||
subprograms and other parts of the work. |
||||
|
||||
The Corresponding Source need not include anything that users |
||||
can regenerate automatically from other parts of the Corresponding |
||||
Source. |
||||
|
||||
The Corresponding Source for a work in source code form is that |
||||
same work. |
||||
|
||||
2. Basic Permissions. |
||||
|
||||
All rights granted under this License are granted for the term of |
||||
copyright on the Program, and are irrevocable provided the stated |
||||
conditions are met. This License explicitly affirms your unlimited |
||||
permission to run the unmodified Program. The output from running a |
||||
covered work is covered by this License only if the output, given its |
||||
content, constitutes a covered work. This License acknowledges your |
||||
rights of fair use or other equivalent, as provided by copyright law. |
||||
|
||||
You may make, run and propagate covered works that you do not |
||||
convey, without conditions so long as your license otherwise remains |
||||
in force. You may convey covered works to others for the sole purpose |
||||
of having them make modifications exclusively for you, or provide you |
||||
with facilities for running those works, provided that you comply with |
||||
the terms of this License in conveying all material for which you do |
||||
not control copyright. Those thus making or running the covered works |
||||
for you must do so exclusively on your behalf, under your direction |
||||
and control, on terms that prohibit them from making any copies of |
||||
your copyrighted material outside their relationship with you. |
||||
|
||||
Conveying under any other circumstances is permitted solely under |
||||
the conditions stated below. Sublicensing is not allowed; section 10 |
||||
makes it unnecessary. |
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
||||
|
||||
No covered work shall be deemed part of an effective technological |
||||
measure under any applicable law fulfilling obligations under article |
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or |
||||
similar laws prohibiting or restricting circumvention of such |
||||
measures. |
||||
|
||||
When you convey a covered work, you waive any legal power to forbid |
||||
circumvention of technological measures to the extent such circumvention |
||||
is effected by exercising rights under this License with respect to |
||||
the covered work, and you disclaim any intention to limit operation or |
||||
modification of the work as a means of enforcing, against the work's |
||||
users, your or third parties' legal rights to forbid circumvention of |
||||
technological measures. |
||||
|
||||
4. Conveying Verbatim Copies. |
||||
|
||||
You may convey verbatim copies of the Program's source code as you |
||||
receive it, in any medium, provided that you conspicuously and |
||||
appropriately publish on each copy an appropriate copyright notice; |
||||
keep intact all notices stating that this License and any |
||||
non-permissive terms added in accord with section 7 apply to the code; |
||||
keep intact all notices of the absence of any warranty; and give all |
||||
recipients a copy of this License along with the Program. |
||||
|
||||
You may charge any price or no price for each copy that you convey, |
||||
and you may offer support or warranty protection for a fee. |
||||
|
||||
5. Conveying Modified Source Versions. |
||||
|
||||
You may convey a work based on the Program, or the modifications to |
||||
produce it from the Program, in the form of source code under the |
||||
terms of section 4, provided that you also meet all of these conditions: |
||||
|
||||
a) The work must carry prominent notices stating that you modified |
||||
it, and giving a relevant date. |
||||
|
||||
b) The work must carry prominent notices stating that it is |
||||
released under this License and any conditions added under section |
||||
7. This requirement modifies the requirement in section 4 to |
||||
"keep intact all notices". |
||||
|
||||
c) You must license the entire work, as a whole, under this |
||||
License to anyone who comes into possession of a copy. This |
||||
License will therefore apply, along with any applicable section 7 |
||||
additional terms, to the whole of the work, and all its parts, |
||||
regardless of how they are packaged. This License gives no |
||||
permission to license the work in any other way, but it does not |
||||
invalidate such permission if you have separately received it. |
||||
|
||||
d) If the work has interactive user interfaces, each must display |
||||
Appropriate Legal Notices; however, if the Program has interactive |
||||
interfaces that do not display Appropriate Legal Notices, your |
||||
work need not make them do so. |
||||
|
||||
A compilation of a covered work with other separate and independent |
||||
works, which are not by their nature extensions of the covered work, |
||||
and which are not combined with it such as to form a larger program, |
||||
in or on a volume of a storage or distribution medium, is called an |
||||
"aggregate" if the compilation and its resulting copyright are not |
||||
used to limit the access or legal rights of the compilation's users |
||||
beyond what the individual works permit. Inclusion of a covered work |
||||
in an aggregate does not cause this License to apply to the other |
||||
parts of the aggregate. |
||||
|
||||
6. Conveying Non-Source Forms. |
||||
|
||||
You may convey a covered work in object code form under the terms |
||||
of sections 4 and 5, provided that you also convey the |
||||
machine-readable Corresponding Source under the terms of this License, |
||||
in one of these ways: |
||||
|
||||
a) Convey the object code in, or embodied in, a physical product |
||||
(including a physical distribution medium), accompanied by the |
||||
Corresponding Source fixed on a durable physical medium |
||||
customarily used for software interchange. |
||||
|
||||
b) Convey the object code in, or embodied in, a physical product |
||||
(including a physical distribution medium), accompanied by a |
||||
written offer, valid for at least three years and valid for as |
||||
long as you offer spare parts or customer support for that product |
||||
model, to give anyone who possesses the object code either (1) a |
||||
copy of the Corresponding Source for all the software in the |
||||
product that is covered by this License, on a durable physical |
||||
medium customarily used for software interchange, for a price no |
||||
more than your reasonable cost of physically performing this |
||||
conveying of source, or (2) access to copy the |
||||
Corresponding Source from a network server at no charge. |
||||
|
||||
c) Convey individual copies of the object code with a copy of the |
||||
written offer to provide the Corresponding Source. This |
||||
alternative is allowed only occasionally and noncommercially, and |
||||
only if you received the object code with such an offer, in accord |
||||
with subsection 6b. |
||||
|
||||
d) Convey the object code by offering access from a designated |
||||
place (gratis or for a charge), and offer equivalent access to the |
||||
Corresponding Source in the same way through the same place at no |
||||
further charge. You need not require recipients to copy the |
||||
Corresponding Source along with the object code. If the place to |
||||
copy the object code is a network server, the Corresponding Source |
||||
may be on a different server (operated by you or a third party) |
||||
that supports equivalent copying facilities, provided you maintain |
||||
clear directions next to the object code saying where to find the |
||||
Corresponding Source. Regardless of what server hosts the |
||||
Corresponding Source, you remain obligated to ensure that it is |
||||
available for as long as needed to satisfy these requirements. |
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided |
||||
you inform other peers where the object code and Corresponding |
||||
Source of the work are being offered to the general public at no |
||||
charge under subsection 6d. |
||||
|
||||
A separable portion of the object code, whose source code is excluded |
||||
from the Corresponding Source as a System Library, need not be |
||||
included in conveying the object code work. |
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any |
||||
tangible personal property which is normally used for personal, family, |
||||
or household purposes, or (2) anything designed or sold for incorporation |
||||
into a dwelling. In determining whether a product is a consumer product, |
||||
doubtful cases shall be resolved in favor of coverage. For a particular |
||||
product received by a particular user, "normally used" refers to a |
||||
typical or common use of that class of product, regardless of the status |
||||
of the particular user or of the way in which the particular user |
||||
actually uses, or expects or is expected to use, the product. A product |
||||
is a consumer product regardless of whether the product has substantial |
||||
commercial, industrial or non-consumer uses, unless such uses represent |
||||
the only significant mode of use of the product. |
||||
|
||||
"Installation Information" for a User Product means any methods, |
||||
procedures, authorization keys, or other information required to install |
||||
and execute modified versions of a covered work in that User Product from |
||||
a modified version of its Corresponding Source. The information must |
||||
suffice to ensure that the continued functioning of the modified object |
||||
code is in no case prevented or interfered with solely because |
||||
modification has been made. |
||||
|
||||
If you convey an object code work under this section in, or with, or |
||||
specifically for use in, a User Product, and the conveying occurs as |
||||
part of a transaction in which the right of possession and use of the |
||||
User Product is transferred to the recipient in perpetuity or for a |
||||
fixed term (regardless of how the transaction is characterized), the |
||||
Corresponding Source conveyed under this section must be accompanied |
||||
by the Installation Information. But this requirement does not apply |
||||
if neither you nor any third party retains the ability to install |
||||
modified object code on the User Product (for example, the work has |
||||
been installed in ROM). |
||||
|
||||
The requirement to provide Installation Information does not include a |
||||
requirement to continue to provide support service, warranty, or updates |
||||
for a work that has been modified or installed by the recipient, or for |
||||
the User Product in which it has been modified or installed. Access to a |
||||
network may be denied when the modification itself materially and |
||||
adversely affects the operation of the network or violates the rules and |
||||
protocols for communication across the network. |
||||
|
||||
Corresponding Source conveyed, and Installation Information provided, |
||||
in accord with this section must be in a format that is publicly |
||||
documented (and with an implementation available to the public in |
||||
source code form), and must require no special password or key for |
||||
unpacking, reading or copying. |
||||
|
||||
7. Additional Terms. |
||||
|
||||
"Additional permissions" are terms that supplement the terms of this |
||||
License by making exceptions from one or more of its conditions. |
||||
Additional permissions that are applicable to the entire Program shall |
||||
be treated as though they were included in this License, to the extent |
||||
that they are valid under applicable law. If additional permissions |
||||
apply only to part of the Program, that part may be used separately |
||||
under those permissions, but the entire Program remains governed by |
||||
this License without regard to the additional permissions. |
||||
|
||||
When you convey a copy of a covered work, you may at your option |
||||
remove any additional permissions from that copy, or from any part of |
||||
it. (Additional permissions may be written to require their own |
||||
removal in certain cases when you modify the work.) You may place |
||||
additional permissions on material, added by you to a covered work, |
||||
for which you have or can give appropriate copyright permission. |
||||
|
||||
Notwithstanding any other provision of this License, for material you |
||||
add to a covered work, you may (if authorized by the copyright holders of |
||||
that material) supplement the terms of this License with terms: |
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the |
||||
terms of sections 15 and 16 of this License; or |
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or |
||||
author attributions in that material or in the Appropriate Legal |
||||
Notices displayed by works containing it; or |
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or |
||||
requiring that modified versions of such material be marked in |
||||
reasonable ways as different from the original version; or |
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or |
||||
authors of the material; or |
||||
|
||||
e) Declining to grant rights under trademark law for use of some |
||||
trade names, trademarks, or service marks; or |
||||
|
||||
f) Requiring indemnification of licensors and authors of that |
||||
material by anyone who conveys the material (or modified versions of |
||||
it) with contractual assumptions of liability to the recipient, for |
||||
any liability that these contractual assumptions directly impose on |
||||
those licensors and authors. |
||||
|
||||
All other non-permissive additional terms are considered "further |
||||
restrictions" within the meaning of section 10. If the Program as you |
||||
received it, or any part of it, contains a notice stating that it is |
||||
governed by this License along with a term that is a further |
||||
restriction, you may remove that term. If a license document contains |
||||
a further restriction but permits relicensing or conveying under this |
||||
License, you may add to a covered work material governed by the terms |
||||
of that license document, provided that the further restriction does |
||||
not survive such relicensing or conveying. |
||||
|
||||
If you add terms to a covered work in accord with this section, you |
||||
must place, in the relevant source files, a statement of the |
||||
additional terms that apply to those files, or a notice indicating |
||||
where to find the applicable terms. |
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the |
||||
form of a separately written license, or stated as exceptions; |
||||
the above requirements apply either way. |
||||
|
||||
8. Termination. |
||||
|
||||
You may not propagate or modify a covered work except as expressly |
||||
provided under this License. Any attempt otherwise to propagate or |
||||
modify it is void, and will automatically terminate your rights under |
||||
this License (including any patent licenses granted under the third |
||||
paragraph of section 11). |
||||
|
||||
However, if you cease all violation of this License, then your |
||||
license from a particular copyright holder is reinstated (a) |
||||
provisionally, unless and until the copyright holder explicitly and |
||||
finally terminates your license, and (b) permanently, if the copyright |
||||
holder fails to notify you of the violation by some reasonable means |
||||
prior to 60 days after the cessation. |
||||
|
||||
Moreover, your license from a particular copyright holder is |
||||
reinstated permanently if the copyright holder notifies you of the |
||||
violation by some reasonable means, this is the first time you have |
||||
received notice of violation of this License (for any work) from that |
||||
copyright holder, and you cure the violation prior to 30 days after |
||||
your receipt of the notice. |
||||
|
||||
Termination of your rights under this section does not terminate the |
||||
licenses of parties who have received copies or rights from you under |
||||
this License. If your rights have been terminated and not permanently |
||||
reinstated, you do not qualify to receive new licenses for the same |
||||
material under section 10. |
||||
|
||||
9. Acceptance Not Required for Having Copies. |
||||
|
||||
You are not required to accept this License in order to receive or |
||||
run a copy of the Program. Ancillary propagation of a covered work |
||||
occurring solely as a consequence of using peer-to-peer transmission |
||||
to receive a copy likewise does not require acceptance. However, |
||||
nothing other than this License grants you permission to propagate or |
||||
modify any covered work. These actions infringe copyright if you do |
||||
not accept this License. Therefore, by modifying or propagating a |
||||
covered work, you indicate your acceptance of this License to do so. |
||||
|
||||
10. Automatic Licensing of Downstream Recipients. |
||||
|
||||
Each time you convey a covered work, the recipient automatically |
||||
receives a license from the original licensors, to run, modify and |
||||
propagate that work, subject to this License. You are not responsible |
||||
for enforcing compliance by third parties with this License. |
||||
|
||||
An "entity transaction" is a transaction transferring control of an |
||||
organization, or substantially all assets of one, or subdividing an |
||||
organization, or merging organizations. If propagation of a covered |
||||
work results from an entity transaction, each party to that |
||||
transaction who receives a copy of the work also receives whatever |
||||
licenses to the work the party's predecessor in interest had or could |
||||
give under the previous paragraph, plus a right to possession of the |
||||
Corresponding Source of the work from the predecessor in interest, if |
||||
the predecessor has it or can get it with reasonable efforts. |
||||
|
||||
You may not impose any further restrictions on the exercise of the |
||||
rights granted or affirmed under this License. For example, you may |
||||
not impose a license fee, royalty, or other charge for exercise of |
||||
rights granted under this License, and you may not initiate litigation |
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that |
||||
any patent claim is infringed by making, using, selling, offering for |
||||
sale, or importing the Program or any portion of it. |
||||
|
||||
11. Patents. |
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this |
||||
License of the Program or a work on which the Program is based. The |
||||
work thus licensed is called the contributor's "contributor version". |
||||
|
||||
A contributor's "essential patent claims" are all patent claims |
||||
owned or controlled by the contributor, whether already acquired or |
||||
hereafter acquired, that would be infringed by some manner, permitted |
||||
by this License, of making, using, or selling its contributor version, |
||||
but do not include claims that would be infringed only as a |
||||
consequence of further modification of the contributor version. For |
||||
purposes of this definition, "control" includes the right to grant |
||||
patent sublicenses in a manner consistent with the requirements of |
||||
this License. |
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free |
||||
patent license under the contributor's essential patent claims, to |
||||
make, use, sell, offer for sale, import and otherwise run, modify and |
||||
propagate the contents of its contributor version. |
||||
|
||||
In the following three paragraphs, a "patent license" is any express |
||||
agreement or commitment, however denominated, not to enforce a patent |
||||
(such as an express permission to practice a patent or covenant not to |
||||
sue for patent infringement). To "grant" such a patent license to a |
||||
party means to make such an agreement or commitment not to enforce a |
||||
patent against the party. |
||||
|
||||
If you convey a covered work, knowingly relying on a patent license, |
||||
and the Corresponding Source of the work is not available for anyone |
||||
to copy, free of charge and under the terms of this License, through a |
||||
publicly available network server or other readily accessible means, |
||||
then you must either (1) cause the Corresponding Source to be so |
||||
available, or (2) arrange to deprive yourself of the benefit of the |
||||
patent license for this particular work, or (3) arrange, in a manner |
||||
consistent with the requirements of this License, to extend the patent |
||||
license to downstream recipients. "Knowingly relying" means you have |
||||
actual knowledge that, but for the patent license, your conveying the |
||||
covered work in a country, or your recipient's use of the covered work |
||||
in a country, would infringe one or more identifiable patents in that |
||||
country that you have reason to believe are valid. |
||||
|
||||
If, pursuant to or in connection with a single transaction or |
||||
arrangement, you convey, or propagate by procuring conveyance of, a |
||||
covered work, and grant a patent license to some of the parties |
||||
receiving the covered work authorizing them to use, propagate, modify |
||||
or convey a specific copy of the covered work, then the patent license |
||||
you grant is automatically extended to all recipients of the covered |
||||
work and works based on it. |
||||
|
||||
A patent license is "discriminatory" if it does not include within |
||||
the scope of its coverage, prohibits the exercise of, or is |
||||
conditioned on the non-exercise of one or more of the rights that are |
||||
specifically granted under this License. You may not convey a covered |
||||
work if you are a party to an arrangement with a third party that is |
||||
in the business of distributing software, under which you make payment |
||||
to the third party based on the extent of your activity of conveying |
||||
the work, and under which the third party grants, to any of the |
||||
parties who would receive the covered work from you, a discriminatory |
||||
patent license (a) in connection with copies of the covered work |
||||
conveyed by you (or copies made from those copies), or (b) primarily |
||||
for and in connection with specific products or compilations that |
||||
contain the covered work, unless you entered into that arrangement, |
||||
or that patent license was granted, prior to 28 March 2007. |
||||
|
||||
Nothing in this License shall be construed as excluding or limiting |
||||
any implied license or other defenses to infringement that may |
||||
otherwise be available to you under applicable patent law. |
||||
|
||||
12. No Surrender of Others' Freedom. |
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or |
||||
otherwise) that contradict the conditions of this License, they do not |
||||
excuse you from the conditions of this License. If you cannot convey a |
||||
covered work so as to satisfy simultaneously your obligations under this |
||||
License and any other pertinent obligations, then as a consequence you may |
||||
not convey it at all. For example, if you agree to terms that obligate you |
||||
to collect a royalty for further conveying from those to whom you convey |
||||
the Program, the only way you could satisfy both those terms and this |
||||
License would be to refrain entirely from conveying the Program. |
||||
|
||||
13. Use with the GNU Affero General Public License. |
||||
|
||||
Notwithstanding any other provision of this License, you have |
||||
permission to link or combine any covered work with a work licensed |
||||
under version 3 of the GNU Affero General Public License into a single |
||||
combined work, and to convey the resulting work. The terms of this |
||||
License will continue to apply to the part which is the covered work, |
||||
but the special requirements of the GNU Affero General Public License, |
||||
section 13, concerning interaction through a network will apply to the |
||||
combination as such. |
||||
|
||||
14. Revised Versions of this License. |
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of |
||||
the GNU General Public License from time to time. Such new versions will |
||||
be similar in spirit to the present version, but may differ in detail to |
||||
address new problems or concerns. |
||||
|
||||
Each version is given a distinguishing version number. If the |
||||
Program specifies that a certain numbered version of the GNU General |
||||
Public License "or any later version" applies to it, you have the |
||||
option of following the terms and conditions either of that numbered |
||||
version or of any later version published by the Free Software |
||||
Foundation. If the Program does not specify a version number of the |
||||
GNU General Public License, you may choose any version ever published |
||||
by the Free Software Foundation. |
||||
|
||||
If the Program specifies that a proxy can decide which future |
||||
versions of the GNU General Public License can be used, that proxy's |
||||
public statement of acceptance of a version permanently authorizes you |
||||
to choose that version for the Program. |
||||
|
||||
Later license versions may give you additional or different |
||||
permissions. However, no additional obligations are imposed on any |
||||
author or copyright holder as a result of your choosing to follow a |
||||
later version. |
||||
|
||||
15. Disclaimer of Warranty. |
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY |
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT |
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY |
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, |
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM |
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF |
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION. |
||||
|
||||
16. Limitation of Liability. |
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS |
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY |
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE |
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF |
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD |
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), |
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF |
||||
SUCH DAMAGES. |
||||
|
||||
17. Interpretation of Sections 15 and 16. |
||||
|
||||
If the disclaimer of warranty and limitation of liability provided |
||||
above cannot be given local legal effect according to their terms, |
||||
reviewing courts shall apply local law that most closely approximates |
||||
an absolute waiver of all civil liability in connection with the |
||||
Program, unless a warranty or assumption of liability accompanies a |
||||
copy of the Program in return for a fee. |
||||
|
||||
END OF TERMS AND CONDITIONS |
||||
|
||||
How to Apply These Terms to Your New Programs |
||||
|
||||
If you develop a new program, and you want it to be of the greatest |
||||
possible use to the public, the best way to achieve this is to make it |
||||
free software which everyone can redistribute and change under these terms. |
||||
|
||||
To do so, attach the following notices to the program. It is safest |
||||
to attach them to the start of each source file to most effectively |
||||
state the exclusion of warranty; and each file should have at least |
||||
the "copyright" line and a pointer to where the full notice is found. |
||||
|
||||
<one line to give the program's name and a brief idea of what it does.> |
||||
Copyright (C) <year> <name of author> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>. |
||||
|
||||
Also add information on how to contact you by electronic and paper mail. |
||||
|
||||
If the program does terminal interaction, make it output a short |
||||
notice like this when it starts in an interactive mode: |
||||
|
||||
<program> Copyright (C) <year> <name of author> |
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. |
||||
This is free software, and you are welcome to redistribute it |
||||
under certain conditions; type `show c' for details. |
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate |
||||
parts of the General Public License. Of course, your program's commands |
||||
might be different; for a GUI interface, you would use an "about box". |
||||
|
||||
You should also get your employer (if you work as a programmer) or school, |
||||
if any, to sign a "copyright disclaimer" for the program, if necessary. |
||||
For more information on this, and how to apply and follow the GNU GPL, see |
||||
<https://www.gnu.org/licenses/>. |
||||
|
||||
The GNU General Public License does not permit incorporating your program |
||||
into proprietary programs. If your program is a subroutine library, you |
||||
may consider it more useful to permit linking proprietary applications with |
||||
the library. If this is what you want to do, use the GNU Lesser General |
||||
Public License instead of this License. But first, please read |
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>. |
@ -0,0 +1,17 @@
|
||||
BIN_DIR:=bin
|
||||
SRC_DIR:=src
|
||||
EXE_NAME:=gochat
|
||||
PAGES_DIR:=pages
|
||||
STATIC_DIR:=static
|
||||
SCRIPTS_DIR:=scripts
|
||||
|
||||
|
||||
all: clean |
||||
mkdir $(BIN_DIR)
|
||||
cd $(SRC_DIR) && go build && mv $(EXE_NAME) ../$(BIN_DIR)
|
||||
cp -r $(PAGES_DIR) $(BIN_DIR)
|
||||
cp -r $(STATIC_DIR) $(BIN_DIR)
|
||||
cp -r $(SCRIPTS_DIR) $(BIN_DIR)
|
||||
|
||||
clean: |
||||
rm -rf $(BIN_DIR)
|
@ -0,0 +1,21 @@
|
||||
## gochat |
||||
### A dead simple real time webchat with authorization using websockets |
||||
|
||||
### Building |
||||
`make` or `cd src/ && go build && mv gochat ..` |
||||
|
||||
### Project structure |
||||
As you are probably here for reconnaissance reasons for your own project here's a |
||||
quick overview of the structure: |
||||
|
||||
- `pages` -> html pages |
||||
- `scripts` -> js files where chat.js is the "heavy-lifter" which actually implements the websocket chat logic |
||||
- `static` -> icon, stylesheet for pages |
||||
- `src/api` -> the fundament of backend logic, authorization, database and websocket handling,all necessary structs, constants |
||||
- `src/log` -> a custom logger |
||||
- `src/page` -> a shorcut function for handling html templates |
||||
- `src/server` -> the main server struct that glues everything together. For a high-level inspection - refer there |
||||
- `src/main.go` -> parse command line flags, set up logging and leave the rest for the server |
||||
|
||||
### License |
||||
GPLv3 |
@ -0,0 +1,50 @@
|
||||
{{ define "base" }} |
||||
|
||||
<!-- gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>. --> |
||||
|
||||
<!DOCTYPE html> |
||||
<html lang="en" dir="ltr"> |
||||
<head> |
||||
<meta charset="utf-8"> |
||||
<title>gochat</title> |
||||
<link rel="shortcut icon" href="/static/images/favicon.png"> |
||||
<link rel="stylesheet" href="/static/style.css"> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0"> |
||||
<script src="/scripts/constants.js"></script> |
||||
</head> |
||||
|
||||
<body> |
||||
|
||||
<div id="wrapper"> |
||||
<nav> |
||||
<a href="/">main</a> |
||||
| |
||||
<a href="/register">register</a> |
||||
| |
||||
<a href="/login">log in</a> |
||||
</nav> |
||||
|
||||
<div id="content"> |
||||
{{ template "content" .}} |
||||
</div> |
||||
|
||||
<footer id="error_output"></footer> |
||||
</div> |
||||
|
||||
</body> |
||||
|
||||
</html> |
||||
|
||||
{{ end }} |
@ -0,0 +1,21 @@
|
||||
{{ template "base" . }} |
||||
|
||||
{{ define "content" }} |
||||
|
||||
<p> |
||||
logged in as <b id="logged_username" onload=""></b> |
||||
</p> |
||||
|
||||
<pre id="chatbox"></pre> |
||||
|
||||
<div> |
||||
<input type="text" id="text_input"> |
||||
<input type="button" value="Send" id="send_button"> |
||||
<input type="button" value="Disconnect" id="disconnect_button"> |
||||
</div> |
||||
|
||||
|
||||
<script src="/scripts/user.js"></script> |
||||
<script src="/scripts/chat.js"></script> |
||||
|
||||
{{ end }} |
@ -0,0 +1,26 @@
|
||||
{{ template "base" . }} |
||||
|
||||
{{ define "content" }} |
||||
|
||||
<h3>Log in</h3> |
||||
|
||||
<form name="auth_form" onsubmit="return false;"> |
||||
<p> |
||||
<label for="username">Username</label> <br> |
||||
<input type="text" name="username"> |
||||
</p> |
||||
|
||||
<p> |
||||
<label for="password">Password</label> <br> |
||||
<input type="password" name="password"> |
||||
</p> |
||||
|
||||
<p> |
||||
<input type="submit" value="Log in" onmouseup="login()"> |
||||
</p> |
||||
</form> |
||||
|
||||
<script src="/scripts/sha256.js"></script> |
||||
<script src="/scripts/user.js"></script> |
||||
|
||||
{{ end }} |
@ -0,0 +1,26 @@
|
||||
{{ template "base" . }} |
||||
|
||||
{{ define "content" }} |
||||
|
||||
<h3>Register</h3> |
||||
|
||||
<form name="auth_form" onsubmit="return false;"> |
||||
<p> |
||||
<label for="username">Username</label> <br> |
||||
<input type="text" name="username" required minlength="3"> |
||||
</p> |
||||
|
||||
<p> |
||||
<label for="password">Password</label> <br> |
||||
<input type="password" name="password" required minlength="3"> |
||||
</p> |
||||
|
||||
<p> |
||||
<input type="submit" value="Register" onmouseup="register()"> |
||||
</p> |
||||
</form> |
||||
|
||||
<script src="/scripts/sha256.js"></script> |
||||
<script src="/scripts/user.js"></script> |
||||
|
||||
{{ end }} |
@ -0,0 +1,96 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
let username = localStorage.getItem(LOCALSTORAGE_NAME_KEY); |
||||
let secret_hash = localStorage.getItem(LOCALSTORAGE_PASSWORD_HASH_KEY); |
||||
|
||||
// check whether credentials are right or not
|
||||
areCredentialsValid({username:username, secret_hash:secret_hash}) |
||||
.then(valid => { |
||||
if (valid === true) { |
||||
// they are valid, connect as a websocket
|
||||
document.getElementById("logged_username").innerHTML = username; |
||||
let socket = new WebSocket(`ws://${BACKEND_URL}/${API_WEBSOCKET_ENDPOINT}`); |
||||
|
||||
// send auth data right away, as API tells us to do
|
||||
socket.onopen = event => { |
||||
console.log("Connected to the server"); |
||||
let auth_data = JSON.stringify({ |
||||
username: username, |
||||
secret_hash: secret_hash, |
||||
}); |
||||
socket.send(auth_data); |
||||
} |
||||
|
||||
socket.onclose = event => { |
||||
console.log("Closed connection: ", event); |
||||
socket.close(); |
||||
|
||||
let chatbox = document.getElementById("chatbox"); |
||||
chatbox.innerHTML += "Connection closed"; |
||||
chatbox.scrollTop = chatbox.scrollHeight; |
||||
}; |
||||
|
||||
// display it
|
||||
socket.onmessage = event => { |
||||
let message = JSON.parse(event.data);
|
||||
let from_user = message.from.username; |
||||
|
||||
let constructed_message_to_display = `${from_user}: ${message.contents}` + "\n"; |
||||
|
||||
let chatbox = document.getElementById("chatbox"); |
||||
chatbox.innerHTML += constructed_message_to_display; |
||||
chatbox.scrollTop = chatbox.scrollHeight; |
||||
} |
||||
|
||||
// make buttons do intended
|
||||
let send_button = document.getElementById("send_button"); |
||||
send_button.addEventListener("click", (event) => { |
||||
let text_input = document.getElementById("text_input"); |
||||
|
||||
socket.send( |
||||
JSON.stringify({ |
||||
contents: String(text_input.value), |
||||
})); |
||||
|
||||
text_input.value = ""; |
||||
text_input.focus(); |
||||
}); |
||||
|
||||
let disconnect_button = document.getElementById("disconnect_button"); |
||||
disconnect_button.addEventListener("click", (event) => { |
||||
socket.close(); |
||||
disconnect_button.value = "Reconnect"; |
||||
disconnect_button.addEventListener("click", (event) => { |
||||
location.reload(); |
||||
}) |
||||
}) |
||||
|
||||
// make message to be sent via pressing 'Enter' key
|
||||
document.addEventListener("keypress", (event) => { |
||||
if (event.key == "Enter") { |
||||
send_button.click();
|
||||
} |
||||
}) |
||||
|
||||
// and focus the text input so the user does not have to click it manually
|
||||
document.getElementById("text_input").focus(); |
||||
|
||||
} else { |
||||
// credentials are not valid ! To the registration page you go
|
||||
window.location.replace("/register"); |
||||
} |
||||
}) |
@ -0,0 +1,27 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
const API_BASE_ENDPOINT = "api"; |
||||
const API_USER_ENDPOINT = "api/user" |
||||
const API_WEBSOCKET_ENDPOINT = "api/ws"; |
||||
|
||||
const AUTH_HEADER_KEY = "AUTH_INFO"; |
||||
const AUTH_SEPARATOR = ":" |
||||
|
||||
const LOCALSTORAGE_NAME_KEY = "username"; |
||||
const LOCALSTORAGE_PASSWORD_HASH_KEY = "secret_hash"; |
||||
|
||||
const BACKEND_URL = window.location.host; |
@ -0,0 +1,26 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
function sha256(string) { |
||||
const encoded_string = new TextEncoder().encode(string); |
||||
return crypto.subtle.digest('SHA-256', encoded_string).then((hash_sum) => { |
||||
const hashArray = Array.from(new Uint8Array(hash_sum)); |
||||
const hashHex = hashArray |
||||
.map((bytes) => bytes.toString(16).padStart(2, '0')) |
||||
.join(''); |
||||
return hashHex; |
||||
}); |
||||
} |
@ -0,0 +1,22 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
|
||||
function to_hex_string(byteArr) { |
||||
return Array.from(byteArr, function(byte) { |
||||
return ('0' + (byte & 0xFF).toString(16).slice(-2)); |
||||
}).join('') |
||||
} |
@ -0,0 +1,112 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
|
||||
async function register() { |
||||
let auth_form = document.forms["auth_form"]; |
||||
|
||||
let username = String(auth_form.elements["username"].value).trim(); |
||||
if (username.length < 3) { |
||||
document.getElementById("error_output").innerHTML = "Username must be >= 3 characters long"; |
||||
return; |
||||
} |
||||
|
||||
let password = String(auth_form.elements["password"].value).trim(); |
||||
if (password.length < 3) { |
||||
document.getElementById("error_output").innerHTML = "Password must be >= 3 characters long"; |
||||
return; |
||||
} |
||||
|
||||
sha256(password).then((password_sha256) => { |
||||
let post_data = { |
||||
username: username, |
||||
secret_hash: password_sha256, |
||||
}; |
||||
|
||||
fetch(API_USER_ENDPOINT, { |
||||
method: "POST", |
||||
headers: {"Content-Type": "application/json"}, |
||||
body: JSON.stringify(post_data), |
||||
}) |
||||
.then(response => { |
||||
if (response.status == 200) { |
||||
localStorage.setItem(LOCALSTORAGE_NAME_KEY, username); |
||||
localStorage.setItem(LOCALSTORAGE_PASSWORD_HASH_KEY, password_sha256);
|
||||
window.location.replace("/") |
||||
} |
||||
}) |
||||
.catch((error) => { |
||||
document.getElementById("error_output").innerHTML = error; |
||||
}); |
||||
}); |
||||
}; |
||||
|
||||
async function areCredentialsValid(user_credentials) {
|
||||
let valid = false; |
||||
|
||||
await fetch(API_USER_ENDPOINT, { |
||||
method: "GET", |
||||
headers: {"AUTH_INFO": user_credentials.username+":"+user_credentials.secret_hash}, |
||||
}) |
||||
.then(response => { |
||||
return response.text(); |
||||
}) |
||||
.then(response_data => { |
||||
let response = JSON.parse(response_data) |
||||
console.log(response); |
||||
if (response.valid === true) { |
||||
valid = true; |
||||
} else { |
||||
valid = false; |
||||
} |
||||
}); |
||||
|
||||
return valid; |
||||
} |
||||
|
||||
async function login() { |
||||
let auth_form = document.forms["auth_form"]; |
||||
|
||||
let username = String(auth_form.elements["username"].value).trim(); |
||||
if (username.length < 3) { |
||||
document.getElementById("error_output").innerHTML = "Username must be >= 3 characters long"; |
||||
return; |
||||
} |
||||
|
||||
let password = String(auth_form.elements["password"].value).trim(); |
||||
if (password.length < 3) { |
||||
document.getElementById("error_output").innerHTML = "Password must be >= 3 characters long"; |
||||
return; |
||||
} |
||||
|
||||
await sha256(password).then((password_sha256) => { |
||||
let user_credentials = { |
||||
"username": username, |
||||
"secret_hash": password_sha256, |
||||
}; |
||||
|
||||
areCredentialsValid(user_credentials) |
||||
.then(valid => { |
||||
if (valid === true) { |
||||
localStorage.setItem(LOCALSTORAGE_NAME_KEY, username); |
||||
localStorage.setItem(LOCALSTORAGE_PASSWORD_HASH_KEY, password_sha256);
|
||||
window.location.replace("/"); |
||||
} else { |
||||
document.getElementById("error_output").innerHTML = "Invalid credentials"; |
||||
} |
||||
}) |
||||
}); |
||||
} |
@ -0,0 +1,81 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
package api |
||||
|
||||
import ( |
||||
"fmt" |
||||
"net/http" |
||||
"strings" |
||||
) |
||||
|
||||
const ( |
||||
AuthHeaderKey string = "AUTH_INFO" |
||||
AuthSeparator string = ":" |
||||
) |
||||
|
||||
var ErrNotAuthorized error = fmt.Errorf("not authorized") |
||||
|
||||
// Extract information about the sender from request headers.
|
||||
// If no data is given or just wrong - returns a default user struct
|
||||
func GetUserAuthHeaderData(req *http.Request) User { |
||||
authData := req.Header.Get(AuthHeaderKey) |
||||
dividedAuthData := strings.Split(authData, AuthSeparator) |
||||
if len(dividedAuthData) != 2 { |
||||
return User{} |
||||
} |
||||
username, passHash := dividedAuthData[0], dividedAuthData[1] |
||||
|
||||
return User{ |
||||
Name: username, |
||||
SecretHash: passHash, |
||||
} |
||||
} |
||||
|
||||
// Checks whether provided request indeed contains SOME authentication information.
|
||||
// Does not check it for being legitimate or not
|
||||
func WithAuth(req *http.Request) bool { |
||||
authenticationData := req.Header.Get(AuthHeaderKey) |
||||
if authenticationData == "" || len(authenticationData) < 3 { |
||||
return false |
||||
} |
||||
|
||||
return true |
||||
} |
||||
|
||||
// Checks whether request contains valid and real user authorization data that is in the database
|
||||
func (db *DB) IsValidAuth(req *http.Request) bool { |
||||
if !WithAuth(req) { |
||||
return false |
||||
} |
||||
|
||||
headerUser := GetUserAuthHeaderData(req) |
||||
|
||||
if !db.DoesUserExist(headerUser.Name) { |
||||
return false |
||||
} |
||||
|
||||
userDB, err := db.GetUser(headerUser.Name) |
||||
if err != nil { |
||||
return false |
||||
} |
||||
|
||||
if userDB.SecretHash != headerUser.SecretHash { |
||||
return false |
||||
} |
||||
|
||||
return true |
||||
} |
@ -0,0 +1,114 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
package api |
||||
|
||||
import ( |
||||
"database/sql" |
||||
"fmt" |
||||
"os" |
||||
|
||||
_ "github.com/mattn/go-sqlite3" |
||||
) |
||||
|
||||
const ( |
||||
UsersTablename string = "users" |
||||
// MessagesTablename string = "messages"
|
||||
) |
||||
|
||||
// SQL database wrapper
|
||||
type DB struct { |
||||
*sql.DB |
||||
} |
||||
|
||||
// Closes database connection
|
||||
func (db *DB) ShutDown() { |
||||
db.Close() |
||||
} |
||||
|
||||
func (db *DB) createUsersTable() error { |
||||
command := fmt.Sprintf( |
||||
`CREATE TABLE IF NOT EXISTS %s
|
||||
(username TEXT NOT NULL PRIMARY KEY, secret_hash TEXT NOT NULL)`, UsersTablename) |
||||
_, err := db.Exec(command) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
// func (db *DB) createMessagesTable() error {
|
||||
// command := fmt.Sprintf(
|
||||
// `CREATE TABLE IF NOT EXISTS %s
|
||||
// (id INTEGER NOT NULL PRIMARY KEY, content TEXT NOT NULL,
|
||||
// from_name TEXT NOT NULL, FOREIGN KEY(from_name) REFERENCES %s(username))`,
|
||||
// MessagesTablename, UsersTablename,
|
||||
// )
|
||||
|
||||
// _, err := db.Exec(command)
|
||||
// if err != nil {
|
||||
// return err
|
||||
// }
|
||||
|
||||
// return nil
|
||||
// }
|
||||
|
||||
func (db *DB) setUpTables() error { |
||||
err := db.createUsersTable() |
||||
if err != nil { |
||||
return fmt.Errorf("error creating users table: %s", err) |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
// Creates a database if does not exist
|
||||
func CreateDB(path string) error { |
||||
dbFile, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, os.ModePerm) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
dbFile.Close() |
||||
|
||||
sqlDB, err := sql.Open("sqlite3", path) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
db := DB{ |
||||
sqlDB, |
||||
} |
||||
|
||||
err = db.setUpTables() |
||||
if err != nil { |
||||
return fmt.Errorf("could not set up tables: %s", err) |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
// Opens a DB
|
||||
func OpenDB(path string) (*DB, error) { |
||||
sqlDB, err := sql.Open("sqlite3", path) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
db := DB{ |
||||
sqlDB, |
||||
} |
||||
|
||||
return &db, nil |
||||
} |
@ -0,0 +1,58 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
package api |
||||
|
||||
// A message struct that is converted back and forth to JSON in order to communicate with frontend
|
||||
type Message struct { |
||||
TimeStamp uint64 `json:"timestamp"` |
||||
From User `json:"from"` |
||||
Contents string `json:"contents"` |
||||
} |
||||
|
||||
/* PROBABLY come back later and implement a message-remembering feature */ |
||||
|
||||
// func (db *DB) AddMessage(message Message) error {
|
||||
// command := fmt.Sprintf("INSERT INTO %s(from, contents) VALUES(%s, %s)", MessagesTablename, message.From.Name, message.Contents)
|
||||
// _, err := db.Exec(command)
|
||||
// if err != nil {
|
||||
// return err
|
||||
// }
|
||||
|
||||
// return nil
|
||||
// }
|
||||
|
||||
// func (db *DB) GetAllMessages() (*[]Message, error) {
|
||||
// command := fmt.Sprintf("SELECT * FROM %s", MessagesTablename)
|
||||
// rows, err := db.Query(command)
|
||||
// if err != nil {
|
||||
// return nil, err
|
||||
// }
|
||||
|
||||
// var messages []Message
|
||||
|
||||
// /*
|
||||
// (id INTEGER NOT NULL PRIMARY KEY, content TEXT NOT NULL,
|
||||
// to_name TEXT NOT NULL, from_name TEXT NOT NULL, FOREIGN KEY(from_name, to_name) REFERENCES %s(username, username))`,
|
||||
// */
|
||||
// for rows.Next() {
|
||||
// var message Message
|
||||
// rows.Scan(&message.ID, &message.Contents, message.From.Name)
|
||||
// messages = append(messages, message)
|
||||
// }
|
||||
|
||||
// return &messages, nil
|
||||
// }
|
@ -0,0 +1,24 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
package api |
||||
|
||||
const ( |
||||
RouteBase string = "/api" |
||||
RouteUsers string = RouteBase + "/user" |
||||
RouteWebsockets string = RouteBase + "/ws" |
||||
RouteRooms string = RouteBase + "/room" |
||||
) |
@ -0,0 +1,102 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
package api |
||||
|
||||
import ( |
||||
"fmt" |
||||
|
||||
"unbewohnte.xyz/gochat/log" |
||||
) |
||||
|
||||
const HashLength uint = 64 |
||||
|
||||
type User struct { |
||||
Name string `json:"username"` |
||||
SecretHash string `json:"secret_hash"` |
||||
Created uint64 |
||||
} |
||||
|
||||
// Used to declare connection/disconnection messages in chat
|
||||
var UserSystem User = User{ |
||||
Name: "System", |
||||
SecretHash: "_", |
||||
Created: 0, |
||||
} |
||||
|
||||
// Get existing user from database by unique name
|
||||
func (db *DB) GetUser(name string) (User, error) { |
||||
command := fmt.Sprintf("SELECT * FROM %s WHERE username=\"%s\"", UsersTablename, name) |
||||
result := db.QueryRow(command) |
||||
err := result.Err() |
||||
if err != nil { |
||||
return User{}, err |
||||
} |
||||
|
||||
user := User{} |
||||
err = result.Scan(&user.Name, &user.SecretHash) |
||||
if err != nil { |
||||
return User{}, err |
||||
} |
||||
|
||||
return user, nil |
||||
} |
||||
|
||||
// Create a new user with a unique name
|
||||
func (db *DB) CreateUser(user *User) error { |
||||
command := fmt.Sprintf("INSERT INTO %s (username, secret_hash) VALUES (?, ?)", UsersTablename) |
||||
_, err := db.Exec(command, user.Name, user.SecretHash) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
log.Info("created user \"%s\"", user.Name) |
||||
|
||||
return nil |
||||
} |
||||
|
||||
// Tells if the user already exists in the db
|
||||
func (db *DB) DoesUserExist(name string) bool { |
||||
_, err := db.GetUser(name) |
||||
if err != nil { |
||||
return false |
||||
} |
||||
|
||||
return true |
||||
} |
||||
|
||||
// func (db *DB) GetAllUsers() (*[]User, error) {
|
||||
// command := fmt.Sprintf("SELECT * FROM %s", UsersTablename)
|
||||
// rows, err := db.Query(command)
|
||||
// if err != nil {
|
||||
// return nil, err
|
||||
// }
|
||||
|
||||
// var users []User
|
||||
|
||||
// for rows.Next() {
|
||||
// var user User
|
||||
// rows.Scan(&user.Name, &user.SecretHash)
|
||||
// users = append(users, user)
|
||||
// }
|
||||
|
||||
// return &users, nil
|
||||
// }
|
||||
|
||||
// Used to send validation check results for user credentials to frontend
|
||||
type UserCredentialsValidation struct { |
||||
Valid bool `json:"valid"` |
||||
} |
@ -0,0 +1,107 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
package api |
||||
|
||||
import ( |
||||
"encoding/json" |
||||
"fmt" |
||||
"time" |
||||
|
||||
"github.com/gorilla/websocket" |
||||
"unbewohnte.xyz/gochat/log" |
||||
) |
||||
|
||||
// Websocket connection paired with the owner
|
||||
type WS struct { |
||||
Socket *websocket.Conn |
||||
User User |
||||
} |
||||
|
||||
// All existing websockets wrapper
|
||||
type WSHolder struct { |
||||
Sockets []*WS |
||||
} |
||||
|
||||
// Untrack user's websocket from broadcast
|
||||
func (holder *WSHolder) Remove(username string) { |
||||
var indexToRemove int |
||||
for index, socket := range holder.Sockets { |
||||
if socket.User.Name == username { |
||||
indexToRemove = index |
||||
break |
||||
} |
||||
} |
||||
|
||||
if len(holder.Sockets) >= 2 { |
||||
holder.Sockets = append(holder.Sockets[:indexToRemove], holder.Sockets[indexToRemove+1:]...) |
||||
} else { |
||||
holder.Sockets = append(holder.Sockets[:indexToRemove]) |
||||
} |
||||
} |
||||
|
||||
// Tell the websocket that it is no longer connected
|
||||
func Disconnect(ws *websocket.Conn) { |
||||
ws.WriteControl(websocket.CloseMessage, nil, time.Now().Add(time.Second*1)) |
||||
ws.Close() |
||||
} |
||||
|
||||
// Handle all incoming messages from this websocket, redirecting messages to specified output
|
||||
func (holder *WSHolder) HandleNewWebSocketMessages(ws *WS, output chan Message) { |
||||
for { |
||||
msgType, contents, err := ws.Socket.ReadMessage() |
||||
if err != nil { |
||||
log.Error("could not read message from websocket: %s", err) |
||||
Disconnect(ws.Socket) |
||||
holder.Remove(ws.User.Name) |
||||
|
||||
disconnectionMessage := Message{ |
||||
From: UserSystem, |
||||
Contents: fmt.Sprintf("%s has disconnected", ws.User.Name), |
||||
} |
||||
output <- disconnectionMessage |
||||
break |
||||
} |
||||
|
||||
switch msgType { |
||||
case websocket.CloseMessage: |
||||
ws.Socket.Close() |
||||
holder.Remove(ws.User.Name) |
||||
|
||||
disconnectionMessage := Message{ |
||||
From: UserSystem, |
||||
Contents: fmt.Sprintf("%s has disconnected", ws.User.Name), |
||||
} |
||||
output <- disconnectionMessage |
||||
|
||||
case websocket.TextMessage: |
||||
var newMessage Message |
||||
err = json.Unmarshal(contents, &newMessage) |
||||
if err != nil { |
||||
log.Error("error unmarshaling text message from \"%s\"'s websocket: %s", ws.User.Name, err) |
||||
break |
||||
} |
||||
|
||||
if len(newMessage.Contents) < 1 { |
||||
break |
||||
} |
||||
|
||||
newMessage.From = ws.User |
||||
output <- newMessage |
||||
} |
||||
|
||||
} |
||||
} |
@ -0,0 +1,8 @@
|
||||
module unbewohnte.xyz/gochat |
||||
|
||||
go 1.17 |
||||
|
||||
require ( |
||||
github.com/gorilla/websocket v1.5.0 // indirect |
||||
github.com/mattn/go-sqlite3 v1.14.12 // indirect |
||||
) |
@ -0,0 +1,4 @@
|
||||
github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc= |
||||
github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= |
||||
github.com/mattn/go-sqlite3 v1.14.12 h1:TJ1bhYJPV44phC+IMu1u2K/i5RriLTPe+yc68XDJ1Z0= |
||||
github.com/mattn/go-sqlite3 v1.14.12/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU= |
@ -0,0 +1,55 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
package log |
||||
|
||||
import ( |
||||
"io" |
||||
"log" |
||||
"os" |
||||
) |
||||
|
||||
// 3 basic loggers in global space
|
||||
var ( |
||||
infoLog *log.Logger |
||||
warningLog *log.Logger |
||||
errorLog *log.Logger |
||||
) |
||||
|
||||
func init() { |
||||
infoLog = log.New(os.Stdout, "[INFO] ", log.Ldate|log.Ltime) |
||||
warningLog = log.New(os.Stdout, "[WARNING] ", log.Ldate|log.Ltime) |
||||
errorLog = log.New(os.Stdout, "[ERROR] ", log.Ldate|log.Ltime|log.Lshortfile) |
||||
} |
||||
|
||||
// Set up loggers to write to the given writer
|
||||
func SetOutput(writer io.Writer) { |
||||
infoLog.SetOutput(writer) |
||||
warningLog.SetOutput(writer) |
||||
errorLog.SetOutput(writer) |
||||
} |
||||
|
||||
func Info(format string, a ...interface{}) { |
||||
infoLog.Printf(format, a...) |
||||
} |
||||
|
||||
func Warning(format string, a ...interface{}) { |
||||
warningLog.Printf(format, a...) |
||||
} |
||||
|
||||
func Error(format string, a ...interface{}) { |
||||
errorLog.Printf(format, a...) |
||||
} |
@ -0,0 +1,74 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
package main |
||||
|
||||
import ( |
||||
"flag" |
||||
"fmt" |
||||
"io" |
||||
"os" |
||||
"path/filepath" |
||||
|
||||
"unbewohnte.xyz/gochat/log" |
||||
"unbewohnte.xyz/gochat/server" |
||||
) |
||||
|
||||
const version string = "0.1.0" |
||||
|
||||
func main() { |
||||
// set up logging
|
||||
exePath, err := os.Executable() |
||||
if err != nil { |
||||
log.Error("could not lookup executable's path: %s", err) |
||||
} |
||||
|
||||
exeDirPath := filepath.Dir(exePath) |
||||
logsDirPath := filepath.Join(exeDirPath, "logs") |
||||
|
||||
err = os.MkdirAll(logsDirPath, os.ModePerm) |
||||
if err != nil { |
||||
log.Error("could not create logs directory: %s", err) |
||||
} |
||||
|
||||
logsFile, err := os.Create(filepath.Join(logsDirPath, "latest.log")) |
||||
if err != nil { |
||||
log.Error("could not create logs file: %s", err) |
||||
} |
||||
|
||||
if err == nil { |
||||
log.SetOutput(io.MultiWriter(os.Stdout, logsFile)) |
||||
} else { |
||||
log.SetOutput(os.Stdout) |
||||
} |
||||
|
||||
// work out launch flags
|
||||
var port uint |
||||
flag.UintVar(&port, "port", 8080, "Set working port") |
||||
flag.Usage = func() { |
||||
fmt.Printf("gochat v%s\n\nFlags\nport [uint] -> specify a port number (default: 8080)\n\n(c) Unbewohnte (Kasyanov Nikolay Alexeyevich)\n", version) |
||||
} |
||||
flag.Parse() |
||||
|
||||
const dbFilename string = "gochat.db" |
||||
dbPath := filepath.Join(exeDirPath, dbFilename) |
||||
|
||||
server, err := server.New(exeDirPath, dbPath, port) |
||||
if err != nil { |
||||
log.Error("could not create a new server instance: %s", err) |
||||
} |
||||
server.Start() |
||||
} |
@ -0,0 +1,32 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
package page |
||||
|
||||
import ( |
||||
"html/template" |
||||
"path/filepath" |
||||
) |
||||
|
||||
// Parse files in pagesDir and return a ready-to-render template
|
||||
func Get(pagesDir string, base string, pagename string) (*template.Template, error) { |
||||
page, err := template.ParseFiles(filepath.Join(pagesDir, base), filepath.Join(pagesDir, pagename)) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
return page, nil |
||||
} |
@ -0,0 +1,126 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
package server |
||||
|
||||
import ( |
||||
"fmt" |
||||
"net/http" |
||||
"os" |
||||
"path/filepath" |
||||
"strings" |
||||
"time" |
||||
|
||||
"unbewohnte.xyz/gochat/api" |
||||
"unbewohnte.xyz/gochat/log" |
||||
"unbewohnte.xyz/gochat/page" |
||||
) |
||||
|
||||
// Server structure that glues api logic and http/websocket server together
|
||||
type Server struct { |
||||
workingDir string |
||||
http *http.Server |
||||
db *api.DB |
||||
websockets *api.WSHolder |
||||
incomingMessages chan api.Message |
||||
} |
||||
|
||||
// Create a new configured and ready-to-launch server
|
||||
func New(workingDir string, dbPath string, port uint) (*Server, error) { |
||||
var server = Server{ |
||||
workingDir: workingDir, |
||||
websockets: &api.WSHolder{}, |
||||
incomingMessages: make(chan api.Message), |
||||
} |
||||
|
||||
err := api.CreateDB(dbPath) |
||||
if err != nil { |
||||
log.Error("could not create database: %s", err) |
||||
os.Exit(1) |
||||
} |
||||
|
||||
db, err := api.OpenDB(dbPath) |
||||
if err != nil { |
||||
log.Error("could not open database: %s", err) |
||||
os.Exit(1) |
||||
} |
||||
server.db = db |
||||
|
||||
// set up routes and handlers
|
||||
const ( |
||||
pagesDirName string = "pages" |
||||
staticDirName string = "static" |
||||
scriptsDirName string = "scripts" |
||||
) |
||||
|
||||
pagesDirPath := filepath.Join(workingDir, pagesDirName) |
||||
|
||||
serveMux := http.NewServeMux() |
||||
|
||||
serveMux.Handle("/static/", http.StripPrefix("/static/", http.FileServer(http.Dir(filepath.Join(workingDir, staticDirName))))) |
||||
serveMux.Handle("/scripts/", http.StripPrefix("/scripts/", http.FileServer(http.Dir(filepath.Join(workingDir, scriptsDirName))))) |
||||
|
||||
serveMux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) { |
||||
switch req.URL.Path { |
||||
case "/": |
||||
requestedPage, err := page.Get(pagesDirPath, "base.html", "index.html") |
||||
if err != nil { |
||||
log.Error("error getting page on route %s: %s", req.URL.Path, err) |
||||
http.Error(w, "internal server error", http.StatusInternalServerError) |
||||
} |
||||
requestedPage.ExecuteTemplate(w, "index.html", nil) |
||||
|
||||
default: |
||||
if strings.HasPrefix(req.URL.Path, api.RouteBase) { |
||||
return |
||||
} |
||||
|
||||
requestedPage, err := page.Get(pagesDirPath, "base.html", req.URL.Path[1:]+".html") |
||||
if err != nil { |
||||
log.Error("error getting page on route %s: %s", req.URL.Path, err) |
||||
http.Error(w, "internal server error", http.StatusInternalServerError) |
||||
} |
||||
requestedPage.ExecuteTemplate(w, req.URL.Path[1:]+".html", nil) |
||||
} |
||||
}) |
||||
|
||||
// user api endpoint
|
||||
serveMux.HandleFunc(api.RouteUsers, server.HandlerUsers) |
||||
// ws api endpoint
|
||||
serveMux.HandleFunc(api.RouteWebsockets, server.HandlerWebsockets) |
||||
|
||||
httpServer := http.Server{ |
||||
Addr: fmt.Sprintf(":%d", port), |
||||
Handler: serveMux, |
||||
ReadTimeout: time.Second * 5, |
||||
WriteTimeout: time.Second * 5, |
||||
} |
||||
server.http = &httpServer |
||||
|
||||
return &server, nil |
||||
} |
||||
|
||||
// Fire up the server
|
||||
func (s *Server) Start() { |
||||
defer s.db.ShutDown() |
||||
go s.BroadcastMessages() |
||||
|
||||
// fire up a server
|
||||
err := s.http.ListenAndServe() |
||||
if err != nil { |
||||
log.Error("FATAL server error: %s", err) |
||||
} |
||||
} |
@ -0,0 +1,128 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
package server |
||||
|
||||
import ( |
||||
"encoding/json" |
||||
"io" |
||||
"net/http" |
||||
|
||||
"unbewohnte.xyz/gochat/api" |
||||
"unbewohnte.xyz/gochat/log" |
||||
) |
||||
|
||||
// User creation/credentials validation http handler
|
||||
func (s *Server) HandlerUsers(w http.ResponseWriter, req *http.Request) { |
||||
switch req.Method { |
||||
case http.MethodPost: |
||||
// unmarshal incoming json
|
||||
requestBody, err := io.ReadAll(req.Body) |
||||
if err != nil { |
||||
http.Error(w, "", http.StatusInternalServerError) |
||||
return |
||||
} |
||||
|
||||
var newUser api.User |
||||
err = json.Unmarshal(requestBody, &newUser) |
||||
if err != nil { |
||||
log.Error("could not unmarshal new user json: %s", err) |
||||
http.Error(w, "invalid user json", http.StatusBadRequest) |
||||
return |
||||
} |
||||
|
||||
// check if this all is genuine
|
||||
if len(newUser.Name) <= 1 || uint(len(newUser.SecretHash)) != api.HashLength { |
||||
log.Error("could not create a new user: incoming name or secret hash is invalid") |
||||
http.Error(w, "invalid user json", http.StatusBadRequest) |
||||
return |
||||
} |
||||
|
||||
if s.db.DoesUserExist(newUser.Name) { |
||||
// already have !
|
||||
http.Error(w, "already exists", http.StatusBadRequest) |
||||
return |
||||
} |
||||
|
||||
// add user to db
|
||||
err = s.db.CreateUser(&newUser) |
||||
if err != nil { |
||||
http.Error(w, "", http.StatusInternalServerError) |
||||
log.Error("could not create a new user \"%s\": %s", newUser.Name, err) |
||||
return |
||||
} |
||||
|
||||
log.Info("successfully created a new user: \"%s\"", newUser.Name) |
||||
|
||||
w.WriteHeader(http.StatusOK) |
||||
|
||||
case http.MethodGet: |
||||
// TODO(redo to make it return true or false whether user credentials are okay or not)
|
||||
headerUserData := api.GetUserAuthHeaderData(req) |
||||
|
||||
if s.db.DoesUserExist(headerUserData.Name) { |
||||
response := api.UserCredentialsValidation{} |
||||
|
||||
userDB, _ := s.db.GetUser(headerUserData.Name) |
||||
|
||||
if userDB.SecretHash != headerUserData.SecretHash { |
||||
// passwords do not match
|
||||
response.Valid = false |
||||
} else { |
||||
response.Valid = true |
||||
} |
||||
|
||||
responseBytes, err := json.Marshal(&response) |
||||
if err != nil { |
||||
log.Error("could not marshal user credentials validation response: %s", err) |
||||
http.Error(w, "", http.StatusInternalServerError) |
||||
return |
||||
} |
||||
|
||||
w.Write(responseBytes) |
||||
|
||||
} else { |
||||
// does not even exist
|
||||
responseBytes, err := json.Marshal(&api.UserCredentialsValidation{ |
||||
Valid: false, |
||||
}) |
||||
if err != nil { |
||||
log.Error("could not marshal user credentials validation response: %s", err) |
||||
http.Error(w, "", http.StatusInternalServerError) |
||||
return |
||||
} |
||||
|
||||
w.Write(responseBytes) |
||||
} |
||||
|
||||
// users, err := db.getAllUsers()
|
||||
// if err != nil {
|
||||
// http.Error(w, "", http.StatusInternalServerError)
|
||||
// return
|
||||
// }
|
||||
|
||||
// w.Header().Add("Content-type", "application/json")
|
||||
// userBytes, err := json.Marshal(*users)
|
||||
// if err != nil {
|
||||
// break
|
||||
// }
|
||||
|
||||
// w.Write(userBytes)
|
||||
|
||||
default: |
||||
http.Error(w, "wrong method", http.StatusMethodNotAllowed) |
||||
} |
||||
} |
@ -0,0 +1,89 @@
|
||||
/* |
||||
gochat - A dead simple real time webchat. |
||||
Copyright (C) 2022 Kasyanov Nikolay Alexeyevich (Unbewohnte) |
||||
This file is a part of gochat |
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
package server |
||||
|
||||
import ( |
||||
"fmt" |
||||
"net/http" |
||||
|
||||
"github.com/gorilla/websocket" |
||||
"unbewohnte.xyz/gochat/api" |
||||
"unbewohnte.xyz/gochat/log" |
||||
) |
||||
|
||||
// Websocket creation handler
|
||||
func (s *Server) HandlerWebsockets(w http.ResponseWriter, req *http.Request) { |
||||
upgrader := websocket.Upgrader{} |
||||
socket, err := upgrader.Upgrade(w, req, nil) |
||||
if err != nil { |
||||
http.Error(w, "could not upgrade to a websocket", http.StatusInternalServerError) |
||||
return |
||||
} |
||||
|
||||
var authInfo api.User |
||||
err = socket.ReadJSON(&authInfo) |
||||
if err != nil { |
||||
log.Error("%s did not send auth info on websocket connection at all: %s", socket.RemoteAddr(), err) |
||||
api.Disconnect(socket) |
||||
return |
||||
} |
||||
|
||||
if !s.db.DoesUserExist(authInfo.Name) { |
||||
log.Error("%s sent an invalid authentication data on websocket: user does not exist", socket.RemoteAddr()) |
||||
api.Disconnect(socket) |
||||
return |
||||
} |
||||
|
||||
userDB, _ := s.db.GetUser(authInfo.Name) |
||||
|
||||
if authInfo.SecretHash != userDB.SecretHash { |
||||
log.Error("%s did not send valid password hash on websocket", socket.RemoteAddr()) |
||||
api.Disconnect(socket) |
||||
return |
||||
} |
||||
|
||||
newWS := api.WS{ |
||||
Socket: socket, |
||||
User: authInfo, |
||||
} |
||||
|
||||
// add this new authorized socket to the broadcast
|
||||
s.websockets.Sockets = append(s.websockets.Sockets, &newWS) |
||||
|
||||
log.Info("A new websocket connection has been established with %s as \"%s\"", newWS.Socket.RemoteAddr(), newWS.User.Name) |
||||
go s.websockets.HandleNewWebSocketMessages(&newWS, s.incomingMessages) |
||||
|
||||
newConnectionMessage := api.Message{ |
||||
From: api.UserSystem, |
||||
Contents: fmt.Sprintf("%s has connected", newWS.User.Name), |
||||
} |
||||
s.incomingMessages <- newConnectionMessage |
||||
} |
||||
|
||||
// Send incoming messages from each websocket to all connected ones
|
||||
func (s *Server) BroadcastMessages() { |
||||
for { |
||||
message, ok := <-s.incomingMessages |
||||
if !ok { |
||||
break |
||||
} |
||||
|
||||
for _, ws := range s.websockets.Sockets { |
||||
ws.Socket.WriteJSON(&message) |
||||
} |
||||
} |
||||
} |
After Width: | Height: | Size: 353 KiB |
@ -0,0 +1,57 @@
|
||||
@viewport { |
||||
width: device-width; |
||||
zoom: 1.0; |
||||
} |
||||
|
||||
body { |
||||
margin: auto; |
||||
margin-top: 5ch; |
||||
margin-bottom: 10ch; |
||||
background-color: #232729; |
||||
max-width: 120ch; |
||||
padding-left: 2ch; |
||||
padding-right: 2ch; |
||||
|
||||
|
||||
font-size: 1.1em; |
||||
|
||||
word-wrap: break-word; |
||||
color: #bbbbbb; |
||||
} |
||||
|
||||
a { |
||||
text-decoration: none; |
||||
color: #bbbbbb; |
||||
} |
||||
|
||||
a:hover { |
||||
color: azure; |
||||
} |
||||
|
||||
nav { |
||||
white-space: nowrap; |
||||
display: inline-block; |
||||
} |
||||
|
||||
#wrapper { |
||||
display: flex; |
||||
flex-flow: column wrap; |
||||
justify-content: center; |
||||
row-gap: 3ch; |
||||
} |
||||
|
||||
#chatbox { |
||||
flex: 1 0 90%; |
||||
width: auto; |
||||
height: 60ch; |
||||
|
||||
max-width: 80ch; |
||||
max-height: 150ch; |
||||
|
||||
overflow-y: scroll; |
||||
border: 1px solid #bbbbbb; |
||||
} |
||||
|
||||
#error_output { |
||||
color: firebrick; |
||||
} |
Loading…
Reference in new issue