commit
0cf9a4ea20
@ -1,3 +1,5 @@
|
||||
/target
|
||||
chain.dat
|
||||
*~
|
||||
chain.dat
|
||||
flamegraph.svg
|
||||
|
File diff suppressed because it is too large
Load Diff
@ -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,22 @@
|
||||
FEATURES:="api,always-aggregate"
|
||||
|
||||
markov:
|
||||
cargo build --release --features $(FEATURES)
|
||||
strip target/release/markov
|
||||
|
||||
install:
|
||||
-rc-service markov shutdown && sleep 0.6
|
||||
-rc-service markov stop
|
||||
cp -f target/release/markov /usr/local/bin/markov
|
||||
rc-service markov start
|
||||
|
||||
reinstall: uninstall
|
||||
cp -f target/release/markov /usr/local/bin/markov
|
||||
rm -f /var/nginx/markov.dat
|
||||
rc-service markov start
|
||||
sleep 0.2
|
||||
curl -X PUT --data-binary @default http://127.0.0.1:8001/put
|
||||
|
||||
uninstall:
|
||||
-rc-service markov stop
|
||||
rm -f /usr/local/bin/markov
|
@ -1,6 +0,0 @@
|
||||
Generate strings from markov chain of stdin
|
||||
|
||||
Usage:
|
||||
|
||||
$ cat corpus | markov
|
||||
$ cat corpus | markov <n of outputs to generate>
|
@ -0,0 +1,75 @@
|
||||
# genmarkov
|
||||
HTTP server connecting to a Markov chain
|
||||
|
||||
# Build requirements
|
||||
Unix & Rust nightly are currently requirements to build, for now.
|
||||
|
||||
# Configuration
|
||||
When ran with no arguments, `markov` will attempt to load the config file at `markov.toml`. If it does not exist, it will use the default configuration. (On debug builds, it will also create the default `markov.toml`.)
|
||||
|
||||
An example default configuration file is provided at [./markov.toml](markov.toml).
|
||||
|
||||
When ran with an argument specifying the config file however, it will attempt to load that. If it fails to load the file, the default will be used.
|
||||
|
||||
## Config file entries
|
||||
| Name | Description | Default | Optional |
|
||||
|-------------------------|---------------------------------------------------------|------------------|----------|
|
||||
| `bindpoint` | Address or Unix domain socket for the server to bind to | `127.0.0.1:8001` | No |
|
||||
| `file` | File to save and load the chain from | `chain.dat` | No |
|
||||
| `max_content_length` | Max request body length to allow | `4194304` (4MB) | No |
|
||||
| `max_gen_size` | Max number of strings for a request to generate at once | `256` | No |
|
||||
| `save_interval_secs` | Number of seconds to ensure waiting before saving chain | `2` | Yes |
|
||||
| `trust_x_forwarded_for` | Trust the `X-Forwarded-For` HTTP header | `false` | No |
|
||||
| `filter` | Remove characters from incoming and/or outgoing text | None | Yes |
|
||||
|
||||
### AF_UNIX note
|
||||
When binding to a Unix domain socket, prefix the path with `unix:/` (e.g. `unix://var/markov.socket`)
|
||||
The server will not attempt to remove already existing sockets at the path, so ensure there isn't one before launching.
|
||||
|
||||
## Logging
|
||||
|
||||
Set the `RUST_LOG` environment variable to one of the following to switch runtime logging levels.
|
||||
* `trace` - Most verbose
|
||||
* `debug` - Verbose
|
||||
* `info` - Show input and output to/from the chain and requests
|
||||
* `warn` - Only show warnings (default)
|
||||
* `error` - Only show errors
|
||||
|
||||
## Signals
|
||||
On Unix systems at runtime, some signals are trapped:
|
||||
|
||||
| Signal | Description |
|
||||
|-----------|------------------------------------------------------------------------|
|
||||
| `SIGUSR1` | Immediately save the chain |
|
||||
| `SIGUSR2` | Immediately load the chain |
|
||||
| `SIGQUIT` | Ensure the chain is properly saved and then immediately call `abort()` |
|
||||
| `SIGINT` | Perform a full graceful shutdown |
|
||||
|
||||
# Usage
|
||||
The server exposes several paths for access of the chain
|
||||
|
||||
## Feeding
|
||||
### `PUT /put`
|
||||
Request body is fed to the chain
|
||||
|
||||
#### NOTE
|
||||
Strings fed to the chain must be valid UTF-8 and a size below the value specified in the config file.
|
||||
|
||||
## Generating
|
||||
### `GET /get`
|
||||
Generate a string from the chain
|
||||
|
||||
### `GET /get/<number>`
|
||||
Generate `<number>` strings from the chain
|
||||
|
||||
### `GET /get/sentance`
|
||||
Generate a single sentance from the chain
|
||||
|
||||
### `GET /get/sentance/<number>`
|
||||
Generate `<number>` sentances from the chain
|
||||
|
||||
#### NOTE
|
||||
Number of strings/sentances must be lower than the value specified in the config file.
|
||||
|
||||
# License
|
||||
GPL'd with <3
|
@ -0,0 +1,10 @@
|
||||
bindpoint = '127.0.0.1:8001'
|
||||
file = 'chain.dat'
|
||||
max_content_length = 4194304
|
||||
max_gen_size = 256
|
||||
save_interval_secs = 2
|
||||
trust_x_forwarded_for = false
|
||||
|
||||
[filter]
|
||||
inbound = ''
|
||||
outbound = ''
|
@ -0,0 +1,55 @@
|
||||
//! API errors
|
||||
//use super::*;
|
||||
use std::{
|
||||
error,
|
||||
fmt,
|
||||
};
|
||||
use warp::{
|
||||
Rejection,
|
||||
Reply,
|
||||
};
|
||||
|
||||
#[derive(Debug)]
|
||||
pub enum ApiError {
|
||||
Body,
|
||||
}
|
||||
|
||||
impl ApiError
|
||||
{
|
||||
#[inline] fn error_code(&self) -> warp::http::StatusCode
|
||||
{
|
||||
status!(match self {
|
||||
Self::Body => 422,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl warp::reject::Reject for ApiError{}
|
||||
impl error::Error for ApiError{}
|
||||
impl std::fmt::Display for ApiError
|
||||
{
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
|
||||
{
|
||||
match self {
|
||||
Self::Body => write!(f, "invalid data in request body"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl From<std::str::Utf8Error> for ApiError
|
||||
{
|
||||
fn from(_: std::str::Utf8Error) -> Self
|
||||
{
|
||||
Self::Body
|
||||
}
|
||||
}
|
||||
|
||||
// Handles API rejections
|
||||
pub async fn rejection(err: Rejection) -> Result<impl Reply, Rejection>
|
||||
{
|
||||
if let Some(api) = err.find::<ApiError>() {
|
||||
Ok(warp::reply::with_status(format!("ApiError: {}\n", api), api.error_code()))
|
||||
} else {
|
||||
Err(err)
|
||||
}
|
||||
}
|
@ -0,0 +1,32 @@
|
||||
//! For API calls if enabled
|
||||
use super::*;
|
||||
use std::{
|
||||
iter,
|
||||
convert::Infallible,
|
||||
};
|
||||
use futures::{
|
||||
stream::{
|
||||
self,
|
||||
BoxStream,
|
||||
StreamExt,
|
||||
},
|
||||
};
|
||||
pub mod error;
|
||||
use error::ApiError;
|
||||
|
||||
mod single;
|
||||
|
||||
#[inline] fn aggregate(mut body: impl Buf) -> Result<String, std::str::Utf8Error>
|
||||
{
|
||||
std::str::from_utf8(&body.to_bytes()).map(ToOwned::to_owned)
|
||||
}
|
||||
|
||||
pub async fn single(host: IpAddr, num: Option<usize>, body: impl Buf) -> Result<impl warp::Reply, warp::reject::Rejection>
|
||||
{
|
||||
single::single_stream(host, num, body).await
|
||||
.map(|rx| Response::new(Body::wrap_stream(rx.map(move |x| {
|
||||
info!("{} <- {:?}", host, x);
|
||||
x
|
||||
}))))
|
||||
.map_err(warp::reject::custom)
|
||||
}
|
@ -0,0 +1,47 @@
|
||||
//! Handler for /single/
|
||||
use super::*;
|
||||
|
||||
//TODO: Change to stream impl like normal `feed` has, instead of taking aggregate?
|
||||
pub async fn single_stream(host: IpAddr, num: Option<usize>, body: impl Buf) -> Result<BoxStream<'static, Result<String, Infallible>>, ApiError>
|
||||
{
|
||||
let body = aggregate(body)?;
|
||||
info!("{} <- {:?}", host, &body[..]);
|
||||
|
||||
let mut chain = Chain::new();
|
||||
|
||||
if_debug! {
|
||||
let timer = std::time::Instant::now();
|
||||
}
|
||||
cfg_if! {
|
||||
if #[cfg(feature="split-newlines")] {
|
||||
for body in body.split('\n').filter(|line| !line.trim().is_empty()) {
|
||||
feed::feed(&mut chain, body, 1..);
|
||||
}
|
||||
}else {
|
||||
feed::feed(&mut chain, body, 1..);
|
||||
}
|
||||
}
|
||||
if_debug!{
|
||||
trace!("Write took {}ms", timer.elapsed().as_millis());
|
||||
}
|
||||
if chain.is_empty() {
|
||||
Ok(stream::empty().boxed())
|
||||
} else {
|
||||
match num {
|
||||
|
||||
None => Ok(stream::iter(iter::once(Ok(chain.generate_str()))).boxed()),
|
||||
Some(num) => {
|
||||
let (mut tx, rx) = mpsc::channel(num);
|
||||
tokio::spawn(async move {
|
||||
for string in chain.str_iter_for(num) {
|
||||
if let Err(e) = tx.send(string).await {
|
||||
error!("Failed to send string to body, aborting: {:?}", e.0);
|
||||
break;
|
||||
}
|
||||
}
|
||||
});
|
||||
Ok(StreamExt::map(rx, |x| Ok::<_, Infallible>(x)).boxed())
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
@ -0,0 +1,171 @@
|
||||
//! For binding to sockets
|
||||
use super::*;
|
||||
use futures::{
|
||||
prelude::*,
|
||||
};
|
||||
use std::{
|
||||
marker::{
|
||||
Send,
|
||||
Unpin,
|
||||
},
|
||||
fmt,
|
||||
error,
|
||||
path::{
|
||||
Path,
|
||||
PathBuf,
|
||||
},
|
||||
};
|
||||
use tokio::{
|
||||
io::{
|
||||
self,
|
||||
AsyncRead,
|
||||
AsyncWrite,
|
||||
},
|
||||
};
|
||||
|
||||
#[derive(Debug)]
|
||||
pub enum BindError<E>
|
||||
{
|
||||
IO(io::Error),
|
||||
Warp(warp::Error),
|
||||
Other(E),
|
||||
}
|
||||
|
||||
impl<E: error::Error + 'static> error::Error for BindError<E>
|
||||
{
|
||||
fn source(&self) -> Option<&(dyn error::Error + 'static)> {
|
||||
Some(match &self {
|
||||
Self::IO(io) => io,
|
||||
Self::Other(o) => o,
|
||||
Self::Warp(w) => w,
|
||||
})
|
||||
}
|
||||
}
|
||||
impl<E: fmt::Display> fmt::Display for BindError<E>
|
||||
{
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
|
||||
{
|
||||
match self {
|
||||
Self::IO(io) => write!(f, "io error: {}", io),
|
||||
Self::Other(other) => write!(f, "{}", other),
|
||||
Self::Warp(warp) => write!(f, "server error: {}", warp),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct BindpointParseError;
|
||||
|
||||
impl error::Error for BindpointParseError{}
|
||||
impl fmt::Display for BindpointParseError
|
||||
{
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
|
||||
{
|
||||
write!(f, "Failed to parse bindpoint as IP or unix domain socket")
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, PartialOrd)]
|
||||
pub enum Bindpoint
|
||||
{
|
||||
Unix(PathBuf),
|
||||
TCP(SocketAddr),
|
||||
}
|
||||
|
||||
impl fmt::Display for Bindpoint
|
||||
{
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
|
||||
{
|
||||
match self {
|
||||
Self::Unix(unix) => write!(f, "unix:/{}", unix.to_string_lossy()),
|
||||
Self::TCP(tcp) => write!(f, "{}", tcp),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl std::str::FromStr for Bindpoint
|
||||
{
|
||||
type Err = BindpointParseError;
|
||||
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||
Ok(if let Ok(ip) = s.parse::<SocketAddr>() {
|
||||
Self::TCP(ip)
|
||||
} else if s.starts_with("unix:/") {
|
||||
Self::Unix(PathBuf::from(&s[6..].to_owned()))
|
||||
} else {
|
||||
return Err(BindpointParseError);
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
fn bind_unix(to: impl AsRef<Path>) -> io::Result<impl TryStream<Ok= impl AsyncRead + AsyncWrite + Send + Unpin + 'static + Send, Error = impl Into<Box<dyn std::error::Error + Send + Sync>>>>
|
||||
{
|
||||
debug!("Binding to AF_UNIX: {:?}", to.as_ref());
|
||||
let listener = tokio::net::UnixListener::bind(to)?;
|
||||
Ok(listener)
|
||||
}
|
||||
|
||||
pub fn serve<F>(server: warp::Server<F>, bind: Bindpoint, signal: impl Future<Output=()> + Send + 'static) -> Result<(Bindpoint, BoxFuture<'static, ()>), BindError<std::convert::Infallible>>
|
||||
where F: Filter + Clone + Send + Sync + 'static,
|
||||
<F::Future as TryFuture>::Ok: warp::Reply,
|
||||
{
|
||||
Ok(match bind {
|
||||
Bindpoint::TCP(sock) => server.try_bind_with_graceful_shutdown(sock, signal).map(|(sock, fut)| (Bindpoint::TCP(sock), fut.boxed())).map_err(BindError::Warp)?,
|
||||
Bindpoint::Unix(unix) => {
|
||||
(Bindpoint::Unix(unix.clone()),
|
||||
server.serve_incoming_with_graceful_shutdown(bind_unix(unix).map_err(BindError::IO)?, signal).boxed())
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
impl From<SocketAddr> for Bindpoint
|
||||
{
|
||||
fn from(from: SocketAddr) -> Self
|
||||
{
|
||||
Self::TCP(from)
|
||||
}
|
||||
}
|
||||
|
||||
pub fn try_serve<F>(server: warp::Server<F>, bind: impl TryBindpoint, signal: impl Future<Output=()> + Send + 'static) -> Result<(Bindpoint, BoxFuture<'static, ()>), BindError<impl error::Error + 'static>>
|
||||
where F: Filter + Clone + Send + Sync + 'static,
|
||||
<F::Future as TryFuture>::Ok: warp::Reply,
|
||||
{
|
||||
serve(server, bind.try_parse().map_err(BindError::Other)?, signal).map_err(BindError::coerce)
|
||||
}
|
||||
|
||||
pub trait TryBindpoint: Sized
|
||||
{
|
||||
type Err: error::Error + 'static;
|
||||
fn try_parse(self) -> Result<Bindpoint, Self::Err>;
|
||||
}
|
||||
|
||||
impl TryBindpoint for Bindpoint
|
||||
{
|
||||
type Err = std::convert::Infallible;
|
||||
fn try_parse(self) -> Result<Bindpoint, Self::Err>
|
||||
{
|
||||
Ok(self)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: AsRef<str>> TryBindpoint for T
|
||||
{
|
||||
type Err = BindpointParseError;
|
||||
fn try_parse(self) -> Result<Bindpoint, Self::Err>
|
||||
{
|
||||
self.as_ref().parse()
|
||||
}
|
||||
}
|
||||
|
||||
impl BindError<std::convert::Infallible>
|
||||
{
|
||||
pub fn coerce<T>(self) -> BindError<T>
|
||||
{
|
||||
match self {
|
||||
Self::Warp(w) => BindError::Warp(w),
|
||||
Self::IO(w) => BindError::IO(w),
|
||||
#[cold] _ => unreachable!(),
|
||||
}
|
||||
}
|
||||
}
|
@ -0,0 +1,28 @@
|
||||
use libc::{
|
||||
c_void,
|
||||
};
|
||||
/// Copy slice of bytes only
|
||||
///
|
||||
/// # Notes
|
||||
/// `dst` and `src` must not overlap. See [move_slice].
|
||||
pub fn copy_slice(dst: &mut [u8], src: &[u8]) -> usize
|
||||
{
|
||||
let sz = std::cmp::min(dst.len(),src.len());
|
||||
unsafe {
|
||||
libc::memcpy(&mut dst[0] as *mut u8 as *mut c_void, &src[0] as *const u8 as *const c_void, sz);
|
||||
}
|
||||
sz
|
||||
}
|
||||
|
||||
/// Move slice of bytes only
|
||||
///
|
||||
/// # Notes
|
||||
/// `dst` and `src` can overlap.
|
||||
pub fn move_slice(dst: &mut [u8], src: &[u8]) -> usize
|
||||
{
|
||||
let sz = std::cmp::min(dst.len(),src.len());
|
||||
unsafe {
|
||||
libc::memmove(&mut dst[0] as *mut u8 as *mut c_void, &src[0] as *const u8 as *const c_void, sz);
|
||||
}
|
||||
sz
|
||||
}
|
@ -0,0 +1,175 @@
|
||||
//! Stream related things
|
||||
use super::*;
|
||||
use std::{
|
||||
task::{
|
||||
Poll,
|
||||
Context,
|
||||
},
|
||||
pin::Pin,
|
||||
};
|
||||
use tokio::{
|
||||
io::{
|
||||
AsyncBufRead,
|
||||
AsyncRead,
|
||||
},
|
||||
prelude::*,
|
||||
};
|
||||
use futures::{
|
||||
stream::{
|
||||
Stream,
|
||||
StreamExt,
|
||||
Fuse,
|
||||
},
|
||||
};
|
||||
use pin_project::pin_project;
|
||||
|
||||
/// Converts a stream of byte-containing objects into an `AsyncRead` and `AsyncBufRead`er.
|
||||
#[pin_project]
|
||||
pub struct StreamReader<I, T>
|
||||
where I: Stream<Item=T>
|
||||
{
|
||||
#[pin]
|
||||
source: Fuse<I>,
|
||||
buffer: Vec<u8>,
|
||||
}
|
||||
|
||||
impl<T, I> StreamReader<I, T>
|
||||
where I: Stream<Item=T>,
|
||||
T: AsRef<[u8]>
|
||||
{
|
||||
/// The current buffer
|
||||
pub fn buffer(&self) -> &[u8]
|
||||
{
|
||||
&self.buffer[..]
|
||||
}
|
||||
/// Consume into the original stream
|
||||
pub fn into_inner(self) -> I
|
||||
{
|
||||
self.source.into_inner()
|
||||
}
|
||||
/// Create a new instance with a buffer capacity
|
||||
pub fn with_capacity(source: I, cap: usize) -> Self
|
||||
{
|
||||
Self {
|
||||
source: source.fuse(),
|
||||
buffer: Vec::with_capacity(cap)
|
||||
}
|
||||
}
|
||||
/// Create a new instance from this stream
|
||||
pub fn new(source: I) -> Self
|
||||
{
|
||||
Self {
|
||||
source: source.fuse(),
|
||||
buffer: Vec::new(),
|
||||
}
|
||||
}
|
||||
/// Attempt to add to this buffer
|
||||
#[cold] fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<usize>
|
||||
{
|
||||
let this = self.project();
|
||||
match this.source.poll_next(cx) {
|
||||
Poll::Ready(None) => Poll::Ready(0),
|
||||
Poll::Ready(Some(buf)) if buf.as_ref().len() > 0 => {
|
||||
let buf = buf.as_ref();
|
||||
this.buffer.extend_from_slice(buf);
|
||||
Poll::Ready(buf.len())
|
||||
},
|
||||
_ => Poll::Pending,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: AsRef<[u8]>, I: Stream<Item=T>> AsyncRead for StreamReader<I,T>
|
||||
{
|
||||
fn poll_read(self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8]) -> Poll<io::Result<usize>> {
|
||||
let this = self.project();
|
||||
if this.buffer.len() != 0 {
|
||||
// We can fill the whole buffer, do it.
|
||||
Poll::Ready(Ok(bytes::copy_slice(buf, this.buffer.drain(..buf.len()).as_slice())))
|
||||
} else {
|
||||
// Buffer is empty, try to fill it
|
||||
match match this.source.poll_next(cx) {
|
||||
Poll::Ready(None) => Poll::Ready(0),
|
||||
Poll::Ready(Some(buf)) if buf.as_ref().len() > 0 => {
|
||||
let buf = buf.as_ref();
|
||||
this.buffer.extend_from_slice(buf);
|
||||
Poll::Ready(buf.len())
|
||||
},
|
||||
_ => Poll::Pending,
|
||||
} {
|
||||
Poll::Ready(0) => Poll::Ready(Ok(0)),
|
||||
Poll::Ready(x) => {
|
||||
// x has been written
|
||||
Poll::Ready(Ok(bytes::copy_slice(buf, this.buffer.drain(..x).as_slice())))
|
||||
},
|
||||
_ => Poll::Pending,
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
impl<T: AsRef<[u8]>, I: Stream<Item=T>> AsyncBufRead for StreamReader<I,T>
|
||||
{
|
||||
fn poll_fill_buf(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<&[u8]>> {
|
||||
let this = self.project();
|
||||
if this.buffer.len() < 1 {
|
||||
// Fetch more into buffer
|
||||
match match this.source.poll_next(cx) {
|
||||
Poll::Ready(None) => Poll::Ready(0),
|
||||
Poll::Ready(Some(buf)) if buf.as_ref().len() > 0 => {
|
||||
let buf = buf.as_ref();
|
||||
this.buffer.extend_from_slice(buf);
|
||||
Poll::Ready(buf.len())
|
||||
},
|
||||
_ => Poll::Pending,
|
||||
} {
|
||||
Poll::Ready(0) => Poll::Ready(Ok(&[])), // should we return EOF error here?
|
||||
Poll::Ready(x) => Poll::Ready(Ok(&this.buffer[..x])),
|
||||
_ => Poll::Pending
|
||||
}
|
||||
} else {
|
||||
Poll::Ready(Ok(&this.buffer[..]))
|
||||
}
|
||||
}
|
||||
fn consume(self: Pin<&mut Self>, amt: usize) {
|
||||
self.project().buffer.drain(..amt);
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests
|
||||
{
|
||||
use super::*;
|
||||
use tokio::{
|
||||
sync::{
|
||||
mpsc,
|
||||
},
|
||||
};
|
||||
#[tokio::test]
|
||||
async fn stream_of_vec()
|
||||
{
|
||||
let (mut tx, rx) = mpsc::channel(16);
|
||||
let sender = tokio::spawn(async move {
|
||||
tx.send("Hello ").await.unwrap();
|
||||
tx.send("world").await.unwrap();
|
||||
tx.send("\n").await.unwrap();
|
||||
tx.send("How ").await.unwrap();
|
||||
tx.send("are ").await.unwrap();
|
||||
tx.send("you").await.unwrap();
|
||||
});
|
||||
|
||||
let mut reader = StreamReader::new(rx);
|
||||
|
||||
let mut output = String::new();
|
||||
let mut read;
|
||||
while {read = reader.read_line(&mut output).await.expect("Failed to read"); read!=0} {
|
||||
println!("Read: {}", read);
|
||||
}
|
||||
|
||||
println!("Done: {:?}", output);
|
||||
sender.await.expect("Child panic");
|
||||
assert_eq!(&output[..], "Hello world\nHow are you");
|
||||
}
|
||||
}
|
@ -0,0 +1,141 @@
|
||||
//! Server config
|
||||
use super::*;
|
||||
use std::{
|
||||
net::SocketAddr,
|
||||
path::Path,
|
||||
io,
|
||||
borrow::Cow,
|
||||
num::NonZeroU64,
|
||||
};
|
||||
use tokio::{
|
||||
fs::OpenOptions,
|
||||
prelude::*,
|
||||
time::Duration,
|
||||
io::BufReader,
|
||||
};
|
||||
|
||||
pub const DEFAULT_FILE_LOCATION: &'static str = "markov.toml";
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Hash, Serialize, Deserialize)]
|
||||
pub struct Config
|
||||
{
|
||||
pub bindpoint: String,
|
||||
pub file: String,
|
||||
pub max_content_length: u64,
|
||||
pub max_gen_size: usize,
|
||||
pub save_interval_secs: Option<NonZeroU64>,
|
||||
pub trust_x_forwarded_for: bool,
|
||||
#[serde(default)]
|
||||
pub filter: FilterConfig,
|
||||
}
|
||||
|
||||
#[derive(Debug, Default, Clone, PartialEq, Eq, PartialOrd, Hash, Serialize, Deserialize)]
|
||||
pub struct FilterConfig
|
||||
{
|
||||
inbound: String,
|
||||
#[serde(default)]
|
||||
outbound: String,
|
||||
}
|
||||
|
||||
impl FilterConfig
|
||||
{
|
||||
pub fn get_inbound_filter(&self) -> sanitise::filter::Filter
|
||||
{
|
||||
let filt: sanitise::filter::Filter = self.inbound.parse().unwrap();
|
||||
if !filt.is_empty()
|
||||
{
|
||||
info!("Loaded inbound filter: {:?}", filt.iter().collect::<String>());
|
||||
}
|
||||
filt
|
||||
}
|
||||
pub fn get_outbound_filter(&self) -> sanitise::filter::Filter
|
||||
{
|
||||
let filt: sanitise::filter::Filter = self.outbound.parse().unwrap();
|
||||
if !filt.is_empty()
|
||||
{
|
||||
info!("Loaded outbound filter: {:?}", filt.iter().collect::<String>());
|
||||
}
|
||||
filt
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for Config
|
||||
{
|
||||
#[inline]
|
||||
fn default() -> Self
|
||||
{
|
||||
Self {
|
||||
bindpoint: SocketAddr::from(([127,0,0,1], 8001)).to_string(),
|
||||
file: "chain.dat".to_owned(),
|
||||
max_content_length: 1024 * 1024 * 4,
|
||||
max_gen_size: 256,
|
||||
save_interval_secs: Some(unsafe{NonZeroU64::new_unchecked(2)}),
|
||||
trust_x_forwarded_for: false,
|
||||
filter: Default::default(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Config
|
||||
{
|
||||
pub fn save_interval(&self) -> Option<Duration>
|
||||
{
|
||||
self.save_interval_secs.map(|x| Duration::from_secs(x.into()))
|
||||
}
|
||||
pub async fn load(from: impl AsRef<Path>) -> io::Result<Self>
|
||||
{
|
||||
let file = OpenOptions::new()
|
||||
.read(true)
|
||||
.open(from).await?;
|
||||
|
||||
let mut buffer= String::new();
|
||||
let reader = BufReader::new(file);
|
||||
let mut lines = reader.lines();
|
||||
while let Some(line) = lines.next_line().await? {
|
||||
buffer.push_str(&line[..]);
|
||||
buffer.push('\n');
|
||||
}
|
||||
toml::de::from_str(&buffer[..]).map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))
|
||||
}
|
||||
|
||||
pub async fn save(&self, to: impl AsRef<Path>) -> io::Result<()>
|
||||
{
|
||||
let config = toml::ser::to_string_pretty(self).map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))?;
|
||||
let mut file = OpenOptions::new()
|
||||
.write(true)
|
||||
.create(true)
|
||||
.truncate(true)
|
||||
.open(to).await?;
|
||||
file.write_all(config.as_bytes()).await?;
|
||||
file.shutdown().await?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
/// Try to load config file specified by args, or default config file
|
||||
pub fn load() -> impl futures::future::Future<Output =Option<Config>>
|
||||
{
|
||||
load_args(std::env::args().skip(1))
|
||||
}
|
||||
|
||||
async fn load_args<I: Iterator<Item=String>>(mut from: I) -> Option<Config>
|
||||
{
|
||||
let place = if let Some(arg) = from.next() {
|
||||
trace!("File {:?} provided", arg);
|
||||
Cow::Owned(arg)
|
||||
} else {
|
||||
warn!("No config file provided. Using default location {:?}", DEFAULT_FILE_LOCATION);
|
||||
Cow::Borrowed(DEFAULT_FILE_LOCATION)
|
||||
};
|
||||
|
||||
match Config::load(place.as_ref()).await {
|
||||
Ok(cfg) => {
|
||||
info!("Loaded config file {:?}", place);
|
||||
Some(cfg)
|
||||
},
|
||||
Err(err) => {
|
||||
error!("Failed to load config file from {:?}: {}", place, err);
|
||||
None
|
||||
},
|
||||
}
|
||||
}
|
@ -0,0 +1,152 @@
|
||||
//! Extensions
|
||||
use std::{
|
||||
iter,
|
||||
ops::{
|
||||
Range,
|
||||
Deref,DerefMut,
|
||||
},
|
||||
marker::{
|
||||
PhantomData,
|
||||
Send,
|
||||
},
|
||||
};
|
||||
|
||||
pub trait StringJoinExt: Sized
|
||||
{
|
||||
fn join<P: AsRef<str>>(self, sep: P) -> String;
|
||||
}
|
||||
|
||||
impl<I,T> StringJoinExt for I
|
||||
where I: IntoIterator<Item=T>,
|
||||
T: AsRef<str>
|
||||
{
|
||||
fn join<P: AsRef<str>>(self, se |