Compare commits
58 commits
Author | SHA1 | Date | |
---|---|---|---|
4811755f88 | |||
|
6b89e80315 | ||
|
a6ae020e02 | ||
|
8537586c86 | ||
|
321a3d2947 | ||
|
c128219aad | ||
|
8f5da5e228 | ||
|
ed57cbd884 | ||
|
61ccd7a5e7 | ||
|
f9c1430a48 | ||
|
7d61f29dbd | ||
fd45155809 | |||
b1daca94f9 | |||
5db043bd26 | |||
bc72f09198 | |||
|
5e433333f0 | ||
|
2b06989935 | ||
|
71df47260a | ||
8f83a8cae7 | |||
05a12c2c25 | |||
7815af7e34 | |||
0c4865e2e4 | |||
6f551cd1d9 | |||
37793acaa2 | |||
90ec4a7a91 | |||
|
4bbd8fe979 | ||
|
fae69c4d1a | ||
5f3505dcb0 | |||
|
ea645e07b3 | ||
|
56fd74c8f4 | ||
|
7a271ea070 | ||
|
adeb1d8614 | ||
9f252300aa | |||
|
9f5eeebc23 | ||
|
55d28230cc | ||
3985a69934 | |||
|
6d8ca4c4d4 | ||
|
5e2dde384d | ||
|
82ec819102 | ||
|
40ab08eb9e | ||
|
b515907d1a | ||
|
e45bf3586f | ||
|
afd0da0297 | ||
|
444b5ad34b | ||
|
15e7b57e12 | ||
|
75adb7e3c0 | ||
|
2b7ba22bfa | ||
|
ed440f582f | ||
|
47a646e78b | ||
|
2c81432664 | ||
|
63c9738b84 | ||
|
72a454df58 | ||
|
afff1981bc | ||
|
6d323a1d21 | ||
|
a3dbf56981 | ||
|
052f6144d7 | ||
|
21344a585e | ||
|
6d64c86577 |
26 changed files with 1444 additions and 120 deletions
661
LICENSE
Normal file
661
LICENSE
Normal file
|
@ -0,0 +1,661 @@
|
|||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are 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.
|
||||
|
||||
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.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
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 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 work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
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 AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
41
core/boottime.go
Normal file
41
core/boottime.go
Normal file
|
@ -0,0 +1,41 @@
|
|||
/// Get system boot time
|
||||
/// should fail on not-linux
|
||||
|
||||
package core
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"os"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
type Time = time.Time
|
||||
|
||||
func GetBootTime() (Time, error) {
|
||||
file, err := os.Open("/proc/stat")
|
||||
if err != nil {
|
||||
return Time{}, err
|
||||
}
|
||||
|
||||
scanner := bufio.NewScanner(file)
|
||||
for scanner.Scan() {
|
||||
line := scanner.Text()
|
||||
s_btime := "btime "
|
||||
if strings.HasPrefix(line, s_btime) {
|
||||
btime, err := strconv.ParseInt(line[len(s_btime):], 10, 64)
|
||||
if err != nil {
|
||||
return Time{}, err
|
||||
}
|
||||
return time.Unix(btime, 0), nil
|
||||
}
|
||||
}
|
||||
|
||||
if err := scanner.Err(); err != nil {
|
||||
return Time{}, err
|
||||
}
|
||||
|
||||
return Time{}, fmt.Errorf("btime (boot time) not found in /proc/stat")
|
||||
}
|
|
@ -10,15 +10,14 @@ import (
|
|||
)
|
||||
|
||||
type Config struct {
|
||||
Service []scanner.ServiceConfig
|
||||
Matrix MatrixConfig
|
||||
UnixSocket string
|
||||
}
|
||||
|
||||
type MatrixConfig struct {
|
||||
UserId string
|
||||
AccessToken string
|
||||
RoomId string
|
||||
SiteName string
|
||||
IconSrc string
|
||||
Database string
|
||||
UnixSocket string
|
||||
BasicAuthUsername string
|
||||
BasicAuthPassword string
|
||||
Service []scanner.ServiceConfig
|
||||
Matrix MatrixConfig
|
||||
}
|
||||
|
||||
func LoadConfigFromTOML(configPath string) (*Config, error) {
|
||||
|
|
|
@ -1,3 +0,0 @@
|
|||
package core
|
||||
|
||||
// todo
|
94
core/db_interface.go
Normal file
94
core/db_interface.go
Normal file
|
@ -0,0 +1,94 @@
|
|||
package core
|
||||
|
||||
import (
|
||||
"time"
|
||||
|
||||
. "git.exozy.me/exozyme/status/scanner"
|
||||
)
|
||||
|
||||
// change implementation here
|
||||
func OpenDatabase(dir string) (Database, error) {
|
||||
return OpenPrototypeDb(dir)
|
||||
}
|
||||
|
||||
type Database interface {
|
||||
// dump data to disk
|
||||
Persist() error
|
||||
|
||||
// get all records after some time (`cutoff`)
|
||||
//
|
||||
// Usage: (get past 7 days of history)
|
||||
// db.QueryAllAfter(time.Now().Add(-7 * 24 * time.Hour))
|
||||
//
|
||||
// Then, parse the result with `GetServiceStatusSpans(rows, service_url)`
|
||||
QueryAllAfter(cutoff time.Time) ([]Row, error)
|
||||
|
||||
// store service status records with timestamp
|
||||
// returns non-duplicate rows
|
||||
StoreServiceStatusBatch(entries ServiceStatusBatch, when time.Time) ([]ServiceStatus, error)
|
||||
|
||||
// store self up/down event with timestamp
|
||||
//
|
||||
// `status` is EventSelfUp or EventSelfDown
|
||||
StoreSelfStatus(status EventType, when time.Time) error
|
||||
}
|
||||
|
||||
type Row struct {
|
||||
time time.Time
|
||||
kind EventType
|
||||
data ServiceStatus
|
||||
}
|
||||
|
||||
type EventType int
|
||||
|
||||
const (
|
||||
// represents when a servire's status text changes
|
||||
// start and stop events are represented with EventSelfUp and EventSelfDown
|
||||
EventService EventType = iota
|
||||
// represents when this program starts
|
||||
EventSelfUp
|
||||
// represents when this program stops
|
||||
EventSelfDown
|
||||
)
|
||||
|
||||
type Span struct {
|
||||
start time.Time
|
||||
stop time.Time
|
||||
status ServiceStatus
|
||||
}
|
||||
|
||||
// Find when the service is up, and when the service is down
|
||||
// returns timespans. There might be gaps between two spans, meaning that we don't know the state of that service
|
||||
func CalculateServiceStatusSpans(rows []Row, service_url string) []Span {
|
||||
res := []Span{}
|
||||
start_i := -1
|
||||
var status ServiceStatus
|
||||
|
||||
for i, v := range rows {
|
||||
switch v.kind {
|
||||
case EventSelfDown:
|
||||
append_span(&res, rows, start_i, i, status)
|
||||
start_i = -1
|
||||
case EventService:
|
||||
if v.data.Url == service_url {
|
||||
append_span(&res, rows, start_i, i, status)
|
||||
start_i = i
|
||||
status = v.data
|
||||
}
|
||||
}
|
||||
}
|
||||
append_span(&res, rows, start_i, -1, status)
|
||||
|
||||
return res
|
||||
}
|
||||
|
||||
func append_span(res *[]Span, rows []Row, start_i, stop_i int, status ServiceStatus) {
|
||||
var stop_time time.Time
|
||||
if stop_i < 0 {
|
||||
stop_time = time.Now()
|
||||
} else {
|
||||
stop_time = rows[stop_i].time
|
||||
}
|
||||
start_time := rows[start_i].time
|
||||
*res = append(*res, Span{start_time, stop_time, status})
|
||||
}
|
199
core/db_prototype.go
Normal file
199
core/db_prototype.go
Normal file
|
@ -0,0 +1,199 @@
|
|||
package core
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"log"
|
||||
"os"
|
||||
"path"
|
||||
"sort"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/oklog/ulid/v2"
|
||||
|
||||
. "git.exozy.me/exozyme/status/scanner"
|
||||
)
|
||||
|
||||
type PrototypeDb struct {
|
||||
rootDir string
|
||||
rows []Row
|
||||
mutex sync.Mutex
|
||||
}
|
||||
|
||||
// Load the newest backup, or start anew
|
||||
func OpenPrototypeDb(dir string) (Database, error) {
|
||||
if dir == "" {
|
||||
return nil, fmt.Errorf("database path is empty. did you set it in config file?")
|
||||
}
|
||||
err := os.MkdirAll(dir, 0755)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
files, err := os.ReadDir(dir)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
// sort the file name desc. Since the file names are ULID, newer files are sorted first
|
||||
sort.Slice(files, func(i, j int) bool {
|
||||
return files[i].Name() > files[j].Name()
|
||||
})
|
||||
for _, file := range files {
|
||||
filename := file.Name()
|
||||
_, err := ulid.Parse(filename)
|
||||
if err != nil {
|
||||
continue // because database files have ULID as names
|
||||
}
|
||||
fullpath := path.Join(dir, filename)
|
||||
content, err := os.ReadFile(fullpath)
|
||||
if err != nil {
|
||||
log.Printf("[WARN] db file cannot be read: %v", err)
|
||||
continue
|
||||
}
|
||||
var rows []Row
|
||||
err = json.NewDecoder(bytes.NewReader(content)).Decode(&rows)
|
||||
if err != nil {
|
||||
log.Printf("[WARN] db file content cannot be parsed: %v", err)
|
||||
continue
|
||||
}
|
||||
log.Printf("Loaded %d rows from: %v", len(rows), fullpath)
|
||||
|
||||
return &PrototypeDb{rootDir: dir, rows: rows}, nil
|
||||
}
|
||||
|
||||
return &PrototypeDb{rootDir: dir, rows: []Row{}}, nil
|
||||
}
|
||||
|
||||
func (db *PrototypeDb) sortRows() {
|
||||
sort.Slice(db.rows, func(i, j int) bool {
|
||||
return db.rows[i].time.Compare(db.rows[j].time) == -1
|
||||
})
|
||||
}
|
||||
|
||||
// Dump data to file
|
||||
//
|
||||
// Steps:
|
||||
// create -> write -> fsync -> rename
|
||||
func (db *PrototypeDb) Persist() error {
|
||||
db.mutex.Lock()
|
||||
defer db.mutex.Unlock()
|
||||
|
||||
db.sortRows()
|
||||
|
||||
dir := db.rootDir
|
||||
// [section] clean up old checkpoints
|
||||
files, err := os.ReadDir(dir)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// sort the file name desc. Since the file names are ULID, newer files are sorted first
|
||||
sort.Slice(files, func(i, j int) bool {
|
||||
return files[i].Name() > files[j].Name()
|
||||
})
|
||||
// delete old files
|
||||
if len(files) > DbCheckpointsToKeep {
|
||||
for _, file := range files[DbCheckpointsToKeep:] {
|
||||
filename := file.Name()
|
||||
_, err := ulid.Parse(filename)
|
||||
if err != nil {
|
||||
continue // because database files have ULID as names
|
||||
}
|
||||
fullpath := path.Join(dir, filename)
|
||||
err = os.Remove(fullpath)
|
||||
if err != nil {
|
||||
log.Printf("Error when os.Delete: %v", err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
id := ulid.Make().String() // checkpoint filename is ULID
|
||||
filename_final := path.Join(db.rootDir, id)
|
||||
filename_tmp := path.Join(db.rootDir, id+".tmp")
|
||||
|
||||
file, err := os.Create(filename_tmp)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer file.Close()
|
||||
err = json.NewEncoder(file).Encode(db.rows) // file content is JSON
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
err = file.Sync()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
err = os.Rename(filename_tmp, filename_final)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
log.Printf("Saved %d rows to: %v", len(db.rows), filename_final)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (db *PrototypeDb) QueryAllAfter(cutoff time.Time) ([]Row, error) {
|
||||
db.mutex.Lock()
|
||||
defer db.mutex.Unlock()
|
||||
|
||||
db.sortRows()
|
||||
|
||||
var start int = -1
|
||||
for i, v := range db.rows {
|
||||
if v.time.Compare(cutoff) >= 0 {
|
||||
start = i
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if start == -1 {
|
||||
return []Row{}, nil
|
||||
}
|
||||
return db.rows[start:], nil
|
||||
}
|
||||
|
||||
func (db *PrototypeDb) StoreServiceStatusBatch(entries ServiceStatusBatch, when time.Time) ([]ServiceStatus, error) {
|
||||
non_duplicates := []ServiceStatus{}
|
||||
|
||||
db.mutex.Lock()
|
||||
defer db.mutex.Unlock()
|
||||
|
||||
for _, v := range entries {
|
||||
new_row := Row{when, EventService, v}
|
||||
|
||||
is_duplicate := false
|
||||
for i := len(db.rows) - 1; i >= 0; i-- {
|
||||
row := db.rows[i]
|
||||
// not duplicate if server restarted in-between
|
||||
if row.kind == EventSelfUp || row.kind == EventSelfDown {
|
||||
break
|
||||
}
|
||||
if row.kind == new_row.kind && row.data.Url == new_row.data.Url {
|
||||
is_duplicate = row.data == new_row.data
|
||||
break
|
||||
}
|
||||
}
|
||||
if !is_duplicate {
|
||||
db.rows = append(db.rows, new_row)
|
||||
non_duplicates = append(non_duplicates, v)
|
||||
}
|
||||
}
|
||||
return non_duplicates, nil
|
||||
}
|
||||
|
||||
func (db *PrototypeDb) StoreSelfStatus(status EventType, when time.Time) error {
|
||||
db.mutex.Lock()
|
||||
defer db.mutex.Unlock()
|
||||
|
||||
if status != EventSelfUp && status != EventSelfDown {
|
||||
log.Panicf("(StoreSelfStatus) invalid value: %v", status)
|
||||
}
|
||||
var placeholder ServiceStatus
|
||||
new_row := Row{when, EventType(status), placeholder}
|
||||
db.rows = append(db.rows, new_row)
|
||||
if len(db.rows) > DbEntriesToKeep {
|
||||
db.rows = db.rows[len(db.rows)-DbEntriesToKeep:]
|
||||
}
|
||||
return nil
|
||||
}
|
7
core/magicnumber.go
Normal file
7
core/magicnumber.go
Normal file
|
@ -0,0 +1,7 @@
|
|||
package core
|
||||
|
||||
import "time"
|
||||
|
||||
const DbEntriesToKeep = 1000
|
||||
const DbCheckpointsToKeep = 3
|
||||
const WaitDurationAfterBoot = 5 * time.Minute
|
86
core/matrix.go
Normal file
86
core/matrix.go
Normal file
|
@ -0,0 +1,86 @@
|
|||
package core
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"git.exozy.me/exozyme/status/scanner"
|
||||
m "maunium.net/go/mautrix"
|
||||
"maunium.net/go/mautrix/event"
|
||||
. "maunium.net/go/mautrix/id"
|
||||
)
|
||||
|
||||
type MatrixConfig struct {
|
||||
UserId string
|
||||
// The AccessToken can be got by logging in with any Matrix client.
|
||||
// In element.io, find it under Settings -> About & Help -> Advanced.
|
||||
AccessToken string
|
||||
RoomId string
|
||||
HomeServer string
|
||||
}
|
||||
|
||||
type MatrixClient struct {
|
||||
inner m.Client
|
||||
config MatrixConfig
|
||||
// Resolved/opaque Room Id
|
||||
room_id RoomID
|
||||
}
|
||||
|
||||
func NewMatrixClient(config MatrixConfig) (*MatrixClient, error) {
|
||||
if config.AccessToken == "" {
|
||||
return nil, fmt.Errorf("no access token")
|
||||
}
|
||||
|
||||
user_id := UserID(config.UserId)
|
||||
homeserver := config.HomeServer
|
||||
if homeserver == "" {
|
||||
homeserver = user_id.Homeserver()
|
||||
}
|
||||
client, err := m.NewClient(homeserver, user_id, config.AccessToken)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var opaque_room_id RoomID
|
||||
if strings.HasPrefix(config.RoomId, "!") {
|
||||
opaque_room_id = RoomID(config.RoomId)
|
||||
} else {
|
||||
resp, err := client.ResolveAlias(RoomAlias(config.RoomId))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
opaque_room_id = resp.RoomID
|
||||
}
|
||||
|
||||
return &MatrixClient{
|
||||
inner: *client,
|
||||
config: config,
|
||||
room_id: opaque_room_id,
|
||||
}, nil
|
||||
}
|
||||
|
||||
func (client *MatrixClient) SendNotice(message string) (*m.RespSendEvent, error) {
|
||||
return client.inner.SendNotice(client.room_id, message)
|
||||
}
|
||||
|
||||
func (client *MatrixClient) SendNoticeHTML(plain string, html string, status *[]scanner.ServiceStatus) (*m.RespSendEvent, error) {
|
||||
return client.inner.SendMessageEvent(client.room_id, event.EventMessage,
|
||||
&StatusMessageEventContent{
|
||||
event.MessageEventContent{
|
||||
MsgType: event.MsgNotice,
|
||||
Body: plain,
|
||||
Format: "org.matrix.custom.html",
|
||||
FormattedBody: html,
|
||||
},
|
||||
status,
|
||||
})
|
||||
}
|
||||
|
||||
func (client *MatrixClient) RedactEvent(eventId EventID, reason string) (*m.RespSendEvent, error) {
|
||||
return client.inner.RedactEvent(client.room_id, eventId, m.ReqRedact{Reason: reason})
|
||||
}
|
||||
|
||||
type StatusMessageEventContent struct {
|
||||
event.MessageEventContent
|
||||
StatusEvent *[]scanner.ServiceStatus `json:"me.exozy.status,omitempty"`
|
||||
}
|
|
@ -1,11 +0,0 @@
|
|||
# install with
|
||||
# ln -sr dinit-service ~/.config/dinit.d/status
|
||||
# Start with
|
||||
# proto/deploy
|
||||
|
||||
type = process
|
||||
# change the following line based on where the executable is
|
||||
command = /usr/bin/bwrap --bind / / --tmpfs /home --unshare-all --share-net /opt/status/status
|
||||
working-dir = /opt/status
|
||||
logfile = $HOME/.log/exozyme-status.log
|
||||
load-options = sub-vars
|
2
go.mod
2
go.mod
|
@ -4,6 +4,7 @@ go 1.21.1
|
|||
|
||||
require (
|
||||
github.com/cbroglie/mustache v1.4.0
|
||||
github.com/oklog/ulid/v2 v2.1.0
|
||||
github.com/pelletier/go-toml/v2 v2.1.0
|
||||
github.com/prometheus-community/pro-bing v0.3.0
|
||||
maunium.net/go/mautrix v0.16.1
|
||||
|
@ -18,6 +19,7 @@ require (
|
|||
github.com/tidwall/match v1.1.1 // indirect
|
||||
github.com/tidwall/pretty v1.2.0 // indirect
|
||||
github.com/tidwall/sjson v1.2.5 // indirect
|
||||
github.com/timewasted/go-accept-headers v0.0.0-20130320203746-c78f304b1b09
|
||||
go.mau.fi/util v0.1.0 // indirect
|
||||
golang.org/x/crypto v0.13.0 // indirect
|
||||
golang.org/x/exp v0.0.0-20230905200255-921286631fa9 // indirect
|
||||
|
|
5
go.sum
5
go.sum
|
@ -11,6 +11,9 @@ github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZb
|
|||
github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
|
||||
github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
|
||||
github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
|
||||
github.com/oklog/ulid/v2 v2.1.0 h1:+9lhoxAP56we25tyYETBBY1YLA2SaoLvUFgrP2miPJU=
|
||||
github.com/oklog/ulid/v2 v2.1.0/go.mod h1:rcEKHmBBKfef9DhnvX7y1HZBYxjXb0cP5ExxNsTT1QQ=
|
||||
github.com/pborman/getopt v0.0.0-20170112200414-7148bc3a4c30/go.mod h1:85jBQOZwpVEaDAr341tbn15RS4fCAsIst0qp7i8ex1o=
|
||||
github.com/pelletier/go-toml/v2 v2.1.0 h1:FnwAJ4oYMvbT/34k9zzHuZNrhlz48GB3/s6at6/MHO4=
|
||||
github.com/pelletier/go-toml/v2 v2.1.0/go.mod h1:tJU2Z3ZkXwnxa4DPO899bsyIoywizdUvyaeZurnPPDc=
|
||||
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||
|
@ -37,6 +40,8 @@ github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs=
|
|||
github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
|
||||
github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY=
|
||||
github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28=
|
||||
github.com/timewasted/go-accept-headers v0.0.0-20130320203746-c78f304b1b09 h1:QVxbx5l/0pzciWYOynixQMtUhPYC3YKD6EcUlOsgGqw=
|
||||
github.com/timewasted/go-accept-headers v0.0.0-20130320203746-c78f304b1b09/go.mod h1:Uy/Rnv5WKuOO+PuDhuYLEpUiiKIZtss3z519uk67aF0=
|
||||
go.mau.fi/util v0.1.0 h1:BwIFWIOEeO7lsiI2eWKFkWTfc5yQmoe+0FYyOFVyaoE=
|
||||
go.mau.fi/util v0.1.0/go.mod h1:AxuJUMCxpzgJ5eV9JbPWKRH8aAJJidxetNdUj7qcb84=
|
||||
golang.org/x/crypto v0.13.0 h1:mvySKfSWJ+UKUii46M40LOvyWfN0s2U+46/jDd0e6Ck=
|
||||
|
|
208
main.go
208
main.go
|
@ -3,16 +3,21 @@ package main
|
|||
import (
|
||||
"context"
|
||||
"embed"
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"log"
|
||||
"net"
|
||||
"net/http"
|
||||
"os"
|
||||
os_signal "os/signal"
|
||||
"strings"
|
||||
"syscall"
|
||||
"time"
|
||||
|
||||
"git.exozy.me/exozyme/status/core"
|
||||
"git.exozy.me/exozyme/status/scanner"
|
||||
"github.com/cbroglie/mustache"
|
||||
"github.com/timewasted/go-accept-headers"
|
||||
)
|
||||
|
||||
//go:embed all:public
|
||||
|
@ -21,7 +26,7 @@ var staticAssets embed.FS
|
|||
//go:embed all:templates
|
||||
var templateAssets embed.FS
|
||||
|
||||
func parseAndRenderTemplate(templateName string, data interface{}) (string, error) {
|
||||
func parseAndRenderTemplate(templateName, siteName, iconSrc string, data interface{}) (string, error) {
|
||||
rawTemplate, err := templateAssets.ReadFile(templateName)
|
||||
if err != nil {
|
||||
return "", err
|
||||
|
@ -33,16 +38,15 @@ func parseAndRenderTemplate(templateName string, data interface{}) (string, erro
|
|||
return "", err
|
||||
}
|
||||
|
||||
res, err := tmpl.Render(data)
|
||||
res, err := tmpl.Render(map[string]interface{}{"SiteName": siteName, "IconSrc": iconSrc, "Data": data})
|
||||
if err != nil {
|
||||
log.Println("Failed to render template:", err)
|
||||
return "", err
|
||||
}
|
||||
|
||||
return res, nil
|
||||
}
|
||||
|
||||
func rootPage(w http.ResponseWriter, r *http.Request) {
|
||||
func index(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method != "GET" {
|
||||
return
|
||||
}
|
||||
|
@ -55,44 +59,100 @@ func rootPage(w http.ResponseWriter, r *http.Request) {
|
|||
}
|
||||
|
||||
// get service status'
|
||||
timeout := time.Second
|
||||
timeout := 3 * time.Second
|
||||
ctx, cancel := context.WithTimeout(context.Background(), timeout)
|
||||
data := scanner.TestMultipleServices(ctx, config.Service)
|
||||
cancel()
|
||||
defer cancel()
|
||||
data := scanner.CheckServiceBatch(ctx, config.Service, config.BasicAuthUsername, config.BasicAuthPassword)
|
||||
non_duplicates, err := dbm.StoreServiceStatusBatch(data, time.Now())
|
||||
if err != nil {
|
||||
http.Error(w, err.Error(), 500)
|
||||
return
|
||||
}
|
||||
err_annouce := announce(non_duplicates)
|
||||
if err_annouce != nil {
|
||||
log.Println(err_annouce)
|
||||
}
|
||||
|
||||
// don't uncomment this in production. verbose
|
||||
// log.Printf("%v", data)
|
||||
|
||||
parsedTemplate, err := parseAndRenderTemplate("templates/index.html", data)
|
||||
ua := r.UserAgent()
|
||||
|
||||
prefer_text := strings.HasPrefix(ua, "curl/")
|
||||
|
||||
header_accept := accept.Parse(r.Header.Get("Accept"))
|
||||
accept_text := header_accept.Accepts("text/plain")
|
||||
accept_html := header_accept.Accepts("text/html")
|
||||
|
||||
if (!accept_html || prefer_text) && accept_text {
|
||||
indexForVT100(w, r, data)
|
||||
} else if accept_html {
|
||||
historical_data, err := dbm.QueryAllAfter(time.Now().Add(-7 * 24 * time.Hour))
|
||||
if err != nil {
|
||||
http.Error(w, err.Error(), 500)
|
||||
return
|
||||
}
|
||||
indexForBrowserWithHistoricalData(w, r, historical_data, config.SiteName, config.IconSrc)
|
||||
} else { // when no valid content type is requested
|
||||
// not to-spec. still sends plain text anyway
|
||||
indexForVT100(w, r, data)
|
||||
}
|
||||
}
|
||||
|
||||
func indexForVT100(w http.ResponseWriter, _ *http.Request, data scanner.ServiceStatusBatch) {
|
||||
w.Header().Add("Content-Type", "text/plain; charset=utf-8")
|
||||
parsedTemplate := formatStatusUpdateAsText(data)
|
||||
w.Write([]byte(parsedTemplate))
|
||||
}
|
||||
|
||||
func indexForBrowserWithHistoricalData(w http.ResponseWriter, _ *http.Request, historical_data []core.Row, siteName string, iconSrc string) {
|
||||
// the basic idea here:
|
||||
// - create new template and render it with historical_data
|
||||
//
|
||||
// reference: see `indexForBrowser` above
|
||||
|
||||
parsedTemplate, err := parseAndRenderTemplate("templates/index.html", siteName, iconSrc, data)
|
||||
if err != nil {
|
||||
http.Error(w, err.Error(), 500)
|
||||
return
|
||||
}
|
||||
|
||||
w.Write([]byte(parsedTemplate))
|
||||
}
|
||||
|
||||
func removeFile(path string) {
|
||||
err := os.Remove(path)
|
||||
if err != nil && !os.IsNotExist(err) {
|
||||
log.Fatal(err)
|
||||
}
|
||||
}
|
||||
|
||||
var config *core.Config
|
||||
var dbm core.Database
|
||||
var client *core.MatrixClient
|
||||
|
||||
func cleanup() {
|
||||
log.Println("Cleaning up")
|
||||
_ = dbm.StoreSelfStatus(core.EventSelfDown, time.Now())
|
||||
_ = dbm.Persist()
|
||||
}
|
||||
|
||||
func main() {
|
||||
var err error
|
||||
config, err = core.LoadConfig()
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
log.Panic(err)
|
||||
}
|
||||
|
||||
http.HandleFunc("/", rootPage)
|
||||
dbm, err = core.OpenDatabase(config.Database)
|
||||
if err != nil {
|
||||
log.Panic(err)
|
||||
}
|
||||
|
||||
client, err = core.NewMatrixClient(config.Matrix)
|
||||
if err != nil {
|
||||
log.Panic(err)
|
||||
}
|
||||
|
||||
http.HandleFunc("/", index)
|
||||
|
||||
// serve public folder from embedfs
|
||||
htmlContent, err := fs.Sub(fs.FS(staticAssets), "public")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
log.Panic(err)
|
||||
}
|
||||
fs := http.FileServer(http.FS(htmlContent))
|
||||
http.Handle("/public/", http.StripPrefix("/public/", fs))
|
||||
|
@ -123,16 +183,122 @@ func main() {
|
|||
srv := &http.Server{Addr: addr, Handler: nil}
|
||||
ln, err := net.Listen(protocol, addr)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
log.Panic(err)
|
||||
}
|
||||
if is_unix {
|
||||
err = os.Chmod(addr, 0660)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
log.Panic(err)
|
||||
}
|
||||
log.Printf("Listening on %v\n", addr)
|
||||
} else {
|
||||
log.Printf("Listening on http://%v/\n", addr)
|
||||
}
|
||||
log.Fatal(srv.Serve(ln))
|
||||
|
||||
// log startup and register cleanup (on SIGTERM or panic)
|
||||
ch_sigterm := make(chan os.Signal, 1)
|
||||
os_signal.Notify(ch_sigterm, syscall.SIGTERM, syscall.SIGINT)
|
||||
|
||||
log.Print("Starting up")
|
||||
err = dbm.StoreSelfStatus(core.EventSelfUp, time.Now())
|
||||
if err != nil {
|
||||
log.Panic(err)
|
||||
}
|
||||
defer cleanup()
|
||||
|
||||
go func() {
|
||||
<-ch_sigterm
|
||||
err := srv.Shutdown(context.Background())
|
||||
if err != nil {
|
||||
log.Printf("Error when shutting down: %v", err)
|
||||
}
|
||||
}()
|
||||
|
||||
btime, err := core.GetBootTime()
|
||||
if err != nil {
|
||||
log.Printf("Error in core.GetBootTime: %v", err)
|
||||
} else {
|
||||
time_passed := time.Now().Sub(btime)
|
||||
time.Sleep(core.WaitDurationAfterBoot - time_passed)
|
||||
}
|
||||
|
||||
go func() { // timed update
|
||||
for {
|
||||
err := routineCheck(5 * time.Minute)
|
||||
if err != nil {
|
||||
log.Printf("Error in routineCheck: %v", err)
|
||||
// idea: maybe we should delay here
|
||||
}
|
||||
}
|
||||
}()
|
||||
|
||||
err = srv.Serve(ln) // serve http
|
||||
if err != http.ErrServerClosed {
|
||||
log.Panic(err)
|
||||
}
|
||||
}
|
||||
|
||||
func routineCheck(timeout time.Duration) error {
|
||||
ctx, cancel := context.WithTimeout(context.Background(), timeout)
|
||||
defer cancel()
|
||||
|
||||
data := scanner.CheckServiceBatch(ctx, config.Service, config.BasicAuthUsername, config.BasicAuthPassword)
|
||||
non_duplicates, err := dbm.StoreServiceStatusBatch(data, time.Now())
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
err = announce(non_duplicates)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// log.Printf("Routine check: %v", data)
|
||||
<-ctx.Done()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func formatStatusUpdateAsText(updates []scanner.ServiceStatus) string {
|
||||
result := ""
|
||||
for _, v := range updates {
|
||||
var upOrDown string
|
||||
if v.Ok {
|
||||
upOrDown = "UP"
|
||||
} else {
|
||||
upOrDown = "DOWN"
|
||||
}
|
||||
serviceType := fmt.Sprintf("[%s]", v.Type)
|
||||
result += fmt.Sprintf("%-4s | %-24s %-7s %s\n", upOrDown, v.Name, serviceType, v.Status)
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
var first_time_to_annouce = true
|
||||
|
||||
func announce(updates []scanner.ServiceStatus) error {
|
||||
messageBody := ""
|
||||
if first_time_to_annouce { // only show downed services
|
||||
tmp := []scanner.ServiceStatus{}
|
||||
num_omitted := 0
|
||||
for _, v := range updates {
|
||||
if !v.Ok {
|
||||
tmp = append(tmp, v)
|
||||
} else {
|
||||
num_omitted += 1
|
||||
}
|
||||
}
|
||||
updates = tmp
|
||||
messageBody += fmt.Sprintf("UP | (%d services omitted)\n", num_omitted)
|
||||
}
|
||||
if len(updates) == 0 {
|
||||
return nil
|
||||
}
|
||||
if first_time_to_annouce {
|
||||
first_time_to_annouce = false
|
||||
}
|
||||
messageBody += formatStatusUpdateAsText(updates)
|
||||
_, err := client.SendNoticeHTML(
|
||||
"```\n"+messageBody+"```",
|
||||
"<pre><code>"+strings.TrimRight(messageBody, "\n")+"</code></pre>", &updates)
|
||||
log.Printf("notify: err=%v\n%v", err, updates)
|
||||
return err
|
||||
}
|
||||
|
|
|
@ -1,12 +1,20 @@
|
|||
# unixSocket = "/srv/http/pages/status"
|
||||
siteName = "Status Page"
|
||||
iconSrc = "https://exozy.me/img/logo.svg"
|
||||
database = "/tmp/exozyme-status-test-db"
|
||||
# unixSocket = "/srv/http/status"
|
||||
# basicAuthUsername = "user"
|
||||
# basicAuthPassword = "pass"
|
||||
|
||||
service = [
|
||||
{ description = "exozy.me", url = "https://exozy.me" },
|
||||
{ description = "drgns.space", url = "https://drgns.space" },
|
||||
{ description = "invalid.example.com", url = "https://invalid.example.com" },
|
||||
{ description = "port 1234", url = "tcp://localhost:1234" },
|
||||
{ description = "basic auth", url = "https://some-service.exozy.me/", user = "overrideUser", pass = "overridePass" },
|
||||
]
|
||||
|
||||
[matrix]
|
||||
userId = "@exozymebot76397:matrix.org"
|
||||
userId = "@bot:exozy.me"
|
||||
# accessToken = "nil"
|
||||
roomId = "!fXEYZcqHcbjztwNhhD:exozy.me"
|
||||
homeserver = "https://chat.exozy.me"
|
||||
|
|
11
proto/dinit-service
Normal file
11
proto/dinit-service
Normal file
|
@ -0,0 +1,11 @@
|
|||
# install with
|
||||
# ln -sr dinit-service ~/.config/dinit.d/status
|
||||
# Start with
|
||||
# proto/deploy
|
||||
|
||||
type = process
|
||||
# change the following line based on where the executable is
|
||||
command = /usr/bin/bwrap --bind / / --tmpfs /home --ro-bind $HOME/c/status/status $HOME/c/status/status --unshare-all $HOME/c/status/status
|
||||
working-dir = $HOME/c/status
|
||||
logfile = $HOME/.log/status.log
|
||||
load-options = sub-vars
|
10
proto/dinit-updater-service
Normal file
10
proto/dinit-updater-service
Normal file
|
@ -0,0 +1,10 @@
|
|||
# install with
|
||||
# ln -sr proto/updater-service ~/.config/dinit.d/status-updater
|
||||
# Start with
|
||||
# dinitctl enable status-updater
|
||||
|
||||
type = process
|
||||
command = ./proto/updater
|
||||
working-dir = $HOME/c/status
|
||||
logfile = $HOME/.log/status-updater.log
|
||||
# load-options = sub-vars
|
|
@ -5,7 +5,10 @@ cd (dirname (status -f))/..
|
|||
set -l old_hash (git rev-parse HEAD)
|
||||
while true
|
||||
git pull 2>&1 1>/tmp/status-updater-git-output
|
||||
or break
|
||||
or begin
|
||||
sleep 60
|
||||
continue
|
||||
end
|
||||
set new_hash (git rev-parse HEAD)
|
||||
if test $old_hash != $new_hash
|
||||
set old_hash $new_hash
|
|
@ -1,10 +0,0 @@
|
|||
# install with
|
||||
# ln -sr proto/updater-service ~/.config/dinit.d/status-updater
|
||||
# Start with
|
||||
# dinitctl enable status-updator
|
||||
|
||||
type = process
|
||||
command = /opt/status/proto/dumb-updater
|
||||
working-dir = /opt/status
|
||||
logfile = $HOME/.log/exozyme-status-updater.log
|
||||
# load-options = sub-vars
|
15
proto/uptime/main.go
Normal file
15
proto/uptime/main.go
Normal file
|
@ -0,0 +1,15 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"git.exozy.me/exozyme/status/core"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
btime, err := core.GetBootTime()
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
fmt.Println(btime)
|
||||
}
|
|
@ -6,7 +6,7 @@ body {
|
|||
text-align: center;
|
||||
}
|
||||
|
||||
.headerDiv {
|
||||
header {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
|
@ -89,7 +89,7 @@ body {
|
|||
opacity: 1;
|
||||
}
|
||||
|
||||
.footer {
|
||||
footer {
|
||||
justify-content: center;
|
||||
margin-top: 2rem;
|
||||
}
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 280 KiB |
29
readme.md
29
readme.md
|
@ -1,3 +1,7 @@
|
|||
# status
|
||||
|
||||
A status page written in Go. Join our [Matrix room](https://matrix.to/#/#status-page:exozy.me) for development discussion.
|
||||
|
||||
## TODO
|
||||
|
||||
Tech stack
|
||||
|
@ -21,22 +25,29 @@ Check online methods
|
|||
Services
|
||||
|
||||
- [x] HTML page
|
||||
- [-] Page Styling (need to wait for all features)
|
||||
- [x] Page Styling
|
||||
- [x] show service type (tcp/http)
|
||||
- [x] Increase constrast. Current RED/GREEN is contrast fail. Maybe don't show the border when service is up?
|
||||
- [x] Bundle directory contents into executable in release mode. (not necessary)
|
||||
- [-] Matrix notification (not integrated)
|
||||
- [ ] Status history (database)
|
||||
- check service status every 5 minutes
|
||||
- [ ] show historical data
|
||||
- Status history, database
|
||||
note for integration: the dumb database code is in `core/database.go`. When integrating, you don't need to touch that code much.
|
||||
- store events
|
||||
- self boot up/shutdown
|
||||
- service status after booting up
|
||||
- everytime service status change (include all status data (e.g. failure reason) in the calculation)
|
||||
- [x] self boot up/shutdown
|
||||
- [x] check service status every 5 minutes since boot
|
||||
- [x] persist data on disk
|
||||
- [x] clean up old checkpoints
|
||||
- [x] Matrix notification
|
||||
- [x] serves plain text to curl
|
||||
|
||||
Tests
|
||||
|
||||
- [ ] HTML page works
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When config file is down, those variables will be made non-optional and load from config instead of envvar.
|
||||
|
||||
- `MAUTRIX_USER_ID`: Matrix user ID, optional, e.g. `@exozymebot76397:matrix.org`g
|
||||
- `MAUTRIX_USER_ID`: Matrix user ID, optional, e.g. `@bot:exozy.me`
|
||||
- `MAUTRIX_ACCESS_TOKEN`: Matrix access token
|
||||
- `MAUTRIX_ROOM_ID`: Matrix room ID, optional, e.g. `#room-name:matrix.org`
|
||||
- `MAUTRIX_ROOM_ID`: Matrix room ID, optional, e.g. `#notifications:exozy.me`
|
||||
|
|
|
@ -1,14 +1,23 @@
|
|||
package scanner
|
||||
|
||||
import "net/http"
|
||||
import (
|
||||
x509 "crypto/x509"
|
||||
"errors"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
func CheckHTTP200(ctx Context, url string) (bool, string) {
|
||||
func CheckHTTP200(ctx Context, url, basicAuthUsername string, basicAuthPassword string) (bool, string) {
|
||||
req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
|
||||
if err != nil {
|
||||
return false, err.Error()
|
||||
}
|
||||
req.SetBasicAuth(basicAuthUsername, basicAuthPassword)
|
||||
resp, err := http.DefaultClient.Do(req)
|
||||
if err != nil {
|
||||
var tlsCertErr x509.CertificateInvalidError
|
||||
if errors.As(err, &tlsCertErr) {
|
||||
return false, "tls: failed to verify certificate: x509: CertificateInvalidError (details truncated)"
|
||||
}
|
||||
return false, err.Error()
|
||||
}
|
||||
|
||||
|
|
|
@ -12,6 +12,8 @@ type Context = context.Context
|
|||
type ServiceConfig struct {
|
||||
Description string
|
||||
Url string
|
||||
User string
|
||||
Pass string
|
||||
}
|
||||
|
||||
func (s ServiceConfig) URL() *url.URL {
|
||||
|
@ -23,40 +25,33 @@ func (s ServiceConfig) URL() *url.URL {
|
|||
}
|
||||
|
||||
type ServiceStatus struct {
|
||||
Name string
|
||||
Url string
|
||||
Type string
|
||||
Ok bool
|
||||
Status string
|
||||
Name string `json:"name"`
|
||||
Url string `json:"url"`
|
||||
Type string `json:"type"`
|
||||
Ok bool `json:"ok"`
|
||||
Status string `json:"status"`
|
||||
}
|
||||
|
||||
func TestService(service ServiceConfig, ctx context.Context) ServiceStatus {
|
||||
func CheckService(service ServiceConfig, ctx context.Context, basicAuthUsername, basicAuthPassword string) ServiceStatus {
|
||||
var serviceResult bool
|
||||
var status string
|
||||
|
||||
url := service.URL()
|
||||
switch url.Scheme {
|
||||
case "http", "https":
|
||||
{
|
||||
serviceResult, status = CheckHTTP200(ctx, url.String())
|
||||
break
|
||||
if service.User != "" && service.Pass != "" {
|
||||
serviceResult, status = CheckHTTP200(ctx, url.String(), service.User, service.Pass)
|
||||
} else {
|
||||
serviceResult, status = CheckHTTP200(ctx, url.String(), basicAuthUsername, basicAuthPassword)
|
||||
}
|
||||
|
||||
case "tcp":
|
||||
{
|
||||
// go includes port in host
|
||||
serviceResult, status = CheckTCPOpen(ctx, url.Host)
|
||||
break
|
||||
}
|
||||
// go includes port in host (url.Host is actually "authority")
|
||||
serviceResult, status = CheckTCPOpen(ctx, url.Host)
|
||||
case "icmp":
|
||||
{
|
||||
// go includes port in host
|
||||
serviceResult, status = CheckICMPUp(ctx, url.Host)
|
||||
break
|
||||
}
|
||||
// go includes port in host (url.Host is actually "authority")
|
||||
serviceResult, status = CheckICMPUp(ctx, url.Host)
|
||||
default:
|
||||
log.Panicf("I can't handle service with scheme: %#v", url.Scheme)
|
||||
break
|
||||
}
|
||||
|
||||
return ServiceStatus{
|
||||
|
@ -68,7 +63,9 @@ func TestService(service ServiceConfig, ctx context.Context) ServiceStatus {
|
|||
}
|
||||
}
|
||||
|
||||
func TestMultipleServices(ctx Context, services []ServiceConfig) []ServiceStatus {
|
||||
type ServiceStatusBatch []ServiceStatus
|
||||
|
||||
func CheckServiceBatch(ctx Context, services []ServiceConfig, basicAuthUsername, basicAuthPassword string) ServiceStatusBatch {
|
||||
var wg sync.WaitGroup
|
||||
|
||||
var data []ServiceStatus = make([]ServiceStatus, len(services))
|
||||
|
@ -77,7 +74,7 @@ func TestMultipleServices(ctx Context, services []ServiceConfig) []ServiceStatus
|
|||
wg.Add(1)
|
||||
go func(i int, config ServiceConfig) {
|
||||
defer wg.Done()
|
||||
data[i] = TestService(config, ctx)
|
||||
data[i] = CheckService(config, ctx, basicAuthUsername, basicAuthPassword)
|
||||
}(i, v)
|
||||
}
|
||||
wg.Wait()
|
||||
|
|
|
@ -2,39 +2,43 @@
|
|||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<title>exozyme - status </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>{{SiteName}}</title>
|
||||
<link rel="stylesheet" href="/public/index.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div class="headerDiv">
|
||||
<img src="/public/logo-transparent.png" alt="exozyme logo" width="135">
|
||||
<h1>exozyme status</h1>
|
||||
</div>
|
||||
<header>
|
||||
<img src="{{IconSrc}}" alt="exozyme logo" width="180">
|
||||
<h1>{{SiteName}}</h1>
|
||||
</header>
|
||||
|
||||
<ul class="serviceContainer">
|
||||
{{#.}}
|
||||
<li>
|
||||
<div class="service {{#Ok}}serviceUp{{/Ok}}{{^Ok}}serviceDown{{/Ok}}">
|
||||
<div>
|
||||
<span>{{#Ok}}UP{{/Ok}}{{^Ok}}DOWN{{/Ok}} |</span>
|
||||
<a class="serviceName" href="{{Url}}">{{Name}}</a>
|
||||
</div>
|
||||
<div class="tooltip">
|
||||
<div class="serviceStatusText">
|
||||
<span>[{{Type}}]</span>
|
||||
<span>{{Status}}</span>
|
||||
</div>
|
||||
<span class="tooltipText">{{Status}}</span>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
{{/.}}
|
||||
</ul>
|
||||
<main>
|
||||
<ul class="serviceContainer">
|
||||
{{#Data}}
|
||||
<li>
|
||||
<div class="service {{#Ok}}serviceUp{{/Ok}}{{^Ok}}serviceDown{{/Ok}}">
|
||||
<div>
|
||||
<span>{{#Ok}}UP{{/Ok}}{{^Ok}}DOWN{{/Ok}} |</span>
|
||||
<a class="serviceName" href="{{Url}}">{{Name}}</a>
|
||||
</div>
|
||||
<div class="tooltip">
|
||||
<div class="serviceStatusText">
|
||||
<span>[{{Type}}]</span>
|
||||
<span>{{Status}}</span>
|
||||
</div>
|
||||
<span class="tooltipText">{{Status}}</span>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
{{/Data}}
|
||||
</ul>
|
||||
</main>
|
||||
|
||||
<div class="footer">
|
||||
<p> Made with ❤️ by the exozyme members!</p>
|
||||
</div>
|
||||
<footer>
|
||||
<p><a href="https://git.exozy.me/exozyme/status">Source code</a></p>
|
||||
<p> Made with ❤️ by the exozyme community!</p>
|
||||
</footer>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
7
update-dinit-config
Executable file
7
update-dinit-config
Executable file
|
@ -0,0 +1,7 @@
|
|||
#!/usr/bin/fish
|
||||
go build && \
|
||||
ln -srf proto/dinit-service ~/.config/dinit.d/status && \
|
||||
ln -srf proto/dinit-updater-service ~/.config/dinit.d/status-updater && \
|
||||
for x in status status-updater
|
||||
dinitctl reload $x && dinitctl restart $x || dinitctl start $x
|
||||
end
|
13
util.go
Normal file
13
util.go
Normal file
|
@ -0,0 +1,13 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
"os"
|
||||
)
|
||||
|
||||
func removeFile(path string) {
|
||||
err := os.Remove(path)
|
||||
if err != nil && !os.IsNotExist(err) {
|
||||
log.Panic(err)
|
||||
}
|
||||
}
|
Loading…
Reference in a new issue