mirror of
https://git.swurl.xyz/swirl/pacebin.git
synced 2024-11-22 04:49:19 +02:00
initial
This commit is contained in:
swirl
commit
7eb00b49f8
|
|
@ -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/>.
|
||||||
|
|
@ -0,0 +1,35 @@
|
||||||
|
prefix=/usr/local
|
||||||
|
confdir=/etc
|
||||||
|
systemd_dir=${DESTDIR}${confdir}/systemd/system
|
||||||
|
nginx_dir=${DESTDIR}${confdir}/nginx
|
||||||
|
bindir=${DESTDIR}${prefix}/bin
|
||||||
|
|
||||||
|
CC := gcc
|
||||||
|
CFLAGS := -O2
|
||||||
|
|
||||||
|
BIN := pacebin
|
||||||
|
|
||||||
|
SOURCE := main.c mongoose.c
|
||||||
|
OBJ := mongoose.o main.o
|
||||||
|
DEPS := mongoose.h index.h
|
||||||
|
LIBS := -lcrypt
|
||||||
|
|
||||||
|
all: $(BIN)
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -f $(OBJ)
|
||||||
|
|
||||||
|
$(BIN): $(OBJ)
|
||||||
|
$(CC) $(CFLAGS) -o $@ $^ $(LIBS)
|
||||||
|
|
||||||
|
install-nginx:
|
||||||
|
@install -Dm644 doc/pastebin.nginx ${nginx_dir}/sites-available/pastebin
|
||||||
|
|
||||||
|
install-systemd:
|
||||||
|
@install -Dm644 doc/pastebin.service ${systemd_dir}/pastebin.service
|
||||||
|
@install -Dm644 doc/pastebin.conf ${DESTDIR}/${confdir}/pastebin.conf
|
||||||
|
|
||||||
|
install-bin:
|
||||||
|
@install -Dm755 ${BIN} ${bindir}/${BIN}
|
||||||
|
|
||||||
|
install: install-bin install-nginx install-systemd
|
||||||
|
|
@ -0,0 +1,152 @@
|
||||||
|
A dead-simple, self-hostable, filesystem-backed pastebin, written in C using [Mongoose](https://cesanta.com).
|
||||||
|
|
||||||
|
This project is largely based off of my [clink](https://git.swurl.xyz/swirl/clink) project. Almost all the main code comes from there, and it uses the exact same design philosophies.
|
||||||
|
|
||||||
|
Please access this project on my [Gitea](https://git.swurl.xyz/swirl/pacebin) instance, NOT GitHub.
|
||||||
|
|
||||||
|
# Features
|
||||||
|
- Tiny executable size (~80kb)
|
||||||
|
- No dependencies, just libc
|
||||||
|
- Extremely simple to use--basic POST and GET
|
||||||
|
- No bloated webapp, just a simple reverse proxy
|
||||||
|
- Super light on resources
|
||||||
|
- Basic and easy paste deletion
|
||||||
|
- Custom short paste links
|
||||||
|
- Fast!
|
||||||
|
- Basic filesystem storage--easy to manage without external programs/libraries
|
||||||
|
|
||||||
|
# Self-Hosting
|
||||||
|
You can host this yourself.
|
||||||
|
|
||||||
|
Note: all commands here are done as root.
|
||||||
|
|
||||||
|
## Building & Installing
|
||||||
|
To build this project, you'll need a libc implementation (only tested with glibc), optionally a separate libcrypt implementation, and Git. Most Linux distributions should have all of these by default, but in case yours doesn't:
|
||||||
|
- `pacman -S glibc libxcrypt git`
|
||||||
|
- `emerge --ask sys-libs/glibc dev-vcs/git`
|
||||||
|
- `apt install glibc git`
|
||||||
|
|
||||||
|
1. Clone this repository:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.swurl.xyz/swirl/pacebin && cd pacebin
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Compile:
|
||||||
|
```bash
|
||||||
|
make
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Now, you need to install. NGINX and systemd files are provided in this project; you may choose not to install them.
|
||||||
|
|
||||||
|
For all install commands, you may optionally provide `prefix` and `DESTDIR` options. This is useful for packagers; i.e. for a PKGBUILD: `make prefix=/usr DESTDIR=${pkgdir} install`.
|
||||||
|
|
||||||
|
Available install commands are as follows:
|
||||||
|
- `make install` installs the executable, NGINX, and systemd files.
|
||||||
|
- `make install-bin` installs the executable file.
|
||||||
|
- `make install-systemd` installs the systemd file, as well as its environment file.
|
||||||
|
- `make install-nginx` installs the NGINX file.
|
||||||
|
|
||||||
|
For example, on a non-systemd system using NGINX, you would run `make install-bin install-nginx`.
|
||||||
|
|
||||||
|
4. If using systemd, change the environment file to reflect your desired options:
|
||||||
|
```bash
|
||||||
|
vim /etc/pacebin.conf
|
||||||
|
```
|
||||||
|
|
||||||
|
5. You can now enable and start the service:
|
||||||
|
```bash
|
||||||
|
systemctl enable --now pacebin
|
||||||
|
```
|
||||||
|
|
||||||
|
The server should now be running on localhost at port 8081.
|
||||||
|
|
||||||
|
## NGINX Reverse Proxy
|
||||||
|
An NGINX file is provided with this project. Sorry, no support for Apache or lighttpd or anything else; should've chosen a better HTTP server.
|
||||||
|
|
||||||
|
For this, you'll need [NGINX](https://nginx.org/en/download.html) (obviously), certbot, and its NGINX plugin. Most Linux distributions should have these in their repositories, i.e.:
|
||||||
|
- `pacman -S nginx certbot-nginx`
|
||||||
|
- `emerge --ask www-servers/nginx app-crypt/certbot-nginx`
|
||||||
|
- `apt install nginx python-certbot-nginx`
|
||||||
|
|
||||||
|
This section assumes you've already followed the last.
|
||||||
|
|
||||||
|
1. Change the domain in the NGINX file:
|
||||||
|
```bash
|
||||||
|
sed -i 's/your.doma.in/[DOMAIN HERE]' /etc/nginx/sites-available/pacebin
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Enable the site:
|
||||||
|
```bash
|
||||||
|
ln -s /etc/nginx/sites-{available,enabled}/pacebin
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Enable HTTPS for the site:
|
||||||
|
```bash
|
||||||
|
certbot --nginx -d [DOMAIN HERE]
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Enable and start NGINX:
|
||||||
|
```bash
|
||||||
|
systemctl enable --now nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
If it's already running, reload:
|
||||||
|
```bash
|
||||||
|
systemctl reload nginx
|
||||||
|
```
|
||||||
|
|
||||||
|
Your site should be running at https://your.doma.in. Test it by going there, and trying the examples. If they don't work, open an issue.
|
||||||
|
|
||||||
|
# Contributions
|
||||||
|
Contributions are always welcome.
|
||||||
|
|
||||||
|
# FAQ
|
||||||
|
## A user has made a paste containing bad content! What do I do?
|
||||||
|
Clean it up, janny!
|
||||||
|
|
||||||
|
Deleting a paste can be done simply by running:
|
||||||
|
```bash
|
||||||
|
rm /srv/pacebin/*/BADLINKHERE
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace `/srv/pacebin` with whatever your data directory is.
|
||||||
|
|
||||||
|
## Can I blacklist certain words from being used in pastes or custom short links?
|
||||||
|
No. While it might be possible through some NGINX stuff, **this is not supported nor it is encouraged.**
|
||||||
|
|
||||||
|
## Is this an IP grabber?
|
||||||
|
No, unless someone links to grabify or something. If access logs are turned on, then the server administrator can see your IP, but management of access logs is up to them.
|
||||||
|
|
||||||
|
## Can I use this without a reverse proxy?
|
||||||
|
Probably, I don't know. Won't have HTTPS though, so either way, I heavily recommend you use a reverse proxy.
|
||||||
|
|
||||||
|
## What's the seed for?
|
||||||
|
The seed is used for generating deletion keys. Do not share it whatsoever.
|
||||||
|
|
||||||
|
## What operating systems are supported?
|
||||||
|
I've only tested it on my Arch Linux server, but it should work perfectly fine on all Linux distributions. Probably doesn't work on Windows.
|
||||||
|
|
||||||
|
## Can I run this in a subdirectory of my site?
|
||||||
|
Yes. Simply put the `proxy_pass` directive in a subdirectory, i.e.:
|
||||||
|
```
|
||||||
|
location /paste {
|
||||||
|
proxy_pass http://localhost:8081;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Why'd you make this?
|
||||||
|
Every pastebin sucks. Simple as. All of the self-hostable options I could find had problems, including:
|
||||||
|
- Loads of unnecessary dependencies
|
||||||
|
- Huge executable size (Go lol)
|
||||||
|
- Used some bloated webapp with no basic API
|
||||||
|
- Feature bloat; i.e. encryption, password protection, file upload, syntax highlighting, etc.
|
||||||
|
- Written in Ruby, or some other bad language
|
||||||
|
- No direct reverse-proxy (or in some cases, even HTTP) support
|
||||||
|
- Reliance on statically serving the index files
|
||||||
|
- Reliance on static configuration like the host
|
||||||
|
- Reliance on other services (i.e. link shorteners)
|
||||||
|
|
||||||
|
This project is intended to be a pastebin that is **as simple as possible**. Literally just make, view, and delete pastes. That's it.
|
||||||
|
|
||||||
|
If you, by chance, need encryption, password protection, etc. then use PrivateBin or something.
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
BIN="BINDIR/BINNAME"
|
||||||
|
# replace this with the path to clink (usually /usr/local/bin/pacebin by default)
|
||||||
|
DIR="/srv/pacebin"
|
||||||
|
PORT=8081
|
||||||
|
SEED="secret"
|
||||||
|
|
@ -0,0 +1,12 @@
|
||||||
|
server {
|
||||||
|
rewrite_log on;
|
||||||
|
server_name your.doma.in;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_pass http://localhost:8081;
|
||||||
|
}
|
||||||
|
|
||||||
|
listen 80 ; # use certbot to enable https
|
||||||
|
listen [::]:80 ;
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,10 @@
|
||||||
|
[Unit]
|
||||||
|
Description=serve pacebin instance
|
||||||
|
After=network.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
EnvironmentFile=/etc/pacebin.conf
|
||||||
|
ExecStart=/bin/sh -c '${BIN} -d "${DIR}" -p ${PORT} -s "${SEED}"'
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
const char *INDEX_HTML =
|
||||||
|
"<!DOCTYPE html>\r\n"
|
||||||
|
"<html lang=en>\r\n"
|
||||||
|
" <head>\r\n"
|
||||||
|
" <title>A Minimal, Filesystem-Backed Pastebin</title>\r\n"
|
||||||
|
" <meta charset='utf-8'>\r\n"
|
||||||
|
" <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>\r\n"
|
||||||
|
" <meta http-equiv='Content-Type' content='text/html; charset=utf-8'>\r\n"
|
||||||
|
" <meta name='viewport' content='width=device-width, initial-scale=1'>\r\n"
|
||||||
|
" <meta content='A super simple, minimal, and filesystem-backed pastebin.' name='description'>\r\n"
|
||||||
|
" </head>\r\n"
|
||||||
|
" <body style='font-family: monospace; max-width: 80ch;'>\r\n"
|
||||||
|
"\r\n"
|
||||||
|
"<header>\r\n"
|
||||||
|
"A Minimal, Filesystem-Backed Pastebin\r\n"
|
||||||
|
"</header>\r\n"
|
||||||
|
"\r\n"
|
||||||
|
"<style>\r\n"
|
||||||
|
"@media (max-width: 1000px) {\r\n"
|
||||||
|
" pre code {\r\n"
|
||||||
|
" display: block;\r\n"
|
||||||
|
" max-width: 100%%;\r\n"
|
||||||
|
" overflow-x: auto;\r\n"
|
||||||
|
" -webkit-overflow-scrolling: touch;\r\n"
|
||||||
|
" padding: 0 5px 5px 0;\r\n"
|
||||||
|
" }\r\n"
|
||||||
|
"}\r\n"
|
||||||
|
"</style>\r\n"
|
||||||
|
"\r\n"
|
||||||
|
"<pre><code>Examples:\r\n"
|
||||||
|
" 1. Create a paste\r\n"
|
||||||
|
" $ curl -d \"some content\" %s\r\n"
|
||||||
|
" %s/502fb5543c36014f\r\n"
|
||||||
|
"\r\n"
|
||||||
|
" 2. Create a paste with a custom path\r\n"
|
||||||
|
" $ curl -d \"some content\" %s/some-content\r\n"
|
||||||
|
" %s/some-content\r\n"
|
||||||
|
"\r\n"
|
||||||
|
" 3. Deleting a paste\r\n"
|
||||||
|
" $ TMP=$(mktemp)\r\n"
|
||||||
|
" $ LINK=$(curl -sS %s -d \"some content\" -D $TMP)\r\n"
|
||||||
|
" $ # Paste created, headers stored in temp file\r\n"
|
||||||
|
" $ DEL=$(cat $TMP | grep -i delete-with | awk '{print$2}'| tr -d '\\r')\r\n"
|
||||||
|
" $ # Gets the deletion key, in the 'X-Delete-With' header\r\n"
|
||||||
|
" $ curl $LINK\r\n"
|
||||||
|
" some content\r\n"
|
||||||
|
" $ curl $LINK -X DELETE -d $DEL\r\n"
|
||||||
|
" $ curl $LINK\r\n"
|
||||||
|
" Not found\r\n"
|
||||||
|
" $ # Paste has been deleted</code></pre>\r\n"
|
||||||
|
"\r\n"
|
||||||
|
"<footer style='white-space: pre;'>Source code: <a href='https://short.swurl.xyz/pacebin'>short.swurl.xyz/pacebin</a></a>\r\n"
|
||||||
|
"</footer>\r\n"
|
||||||
|
"</html>\r\n";
|
||||||
|
|
||||||
|
|
@ -0,0 +1,254 @@
|
||||||
|
#include "mongoose.h"
|
||||||
|
#include "index.h"
|
||||||
|
|
||||||
|
#include <string.h>
|
||||||
|
#include <sys/stat.h>
|
||||||
|
#include <ctype.h>
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
#include <unistd.h>
|
||||||
|
#include <crypt.h>
|
||||||
|
#include <time.h>
|
||||||
|
|
||||||
|
char *port = "8081";
|
||||||
|
char *data_dir = "/srv/pacebin";
|
||||||
|
char *seed = "secret";
|
||||||
|
|
||||||
|
static struct mg_http_serve_opts s_http_server_opts;
|
||||||
|
|
||||||
|
static void rec_mkdir(const char *dir) {
|
||||||
|
char tmp[256];
|
||||||
|
char *p = NULL;
|
||||||
|
size_t len;
|
||||||
|
|
||||||
|
snprintf(tmp, sizeof(tmp),"%s",dir);
|
||||||
|
len = strlen(tmp);
|
||||||
|
if (tmp[len - 1] == '/')
|
||||||
|
tmp[len - 1] = 0;
|
||||||
|
for (p = tmp + 1; *p; p++)
|
||||||
|
if (*p == '/') {
|
||||||
|
*p = 0;
|
||||||
|
mkdir(tmp, S_IRWXU);
|
||||||
|
*p = '/';
|
||||||
|
}
|
||||||
|
mkdir(tmp, S_IRWXU);
|
||||||
|
}
|
||||||
|
|
||||||
|
bool file_exists(char *filename) {
|
||||||
|
struct stat buffer;
|
||||||
|
return (stat (filename, &buffer) == 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
char *get_paste_filename(char *link) {
|
||||||
|
char *filename = malloc(strlen(data_dir) + strlen(link) + 8);
|
||||||
|
sprintf(filename, "%s/paste/%s", data_dir, link);
|
||||||
|
return filename;
|
||||||
|
}
|
||||||
|
|
||||||
|
char *get_del_filename(char *link) {
|
||||||
|
char *filename = malloc(strlen(data_dir) + strlen(link) + 6);
|
||||||
|
sprintf(filename, "%s/del/%s", data_dir, link);
|
||||||
|
return filename;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool paste_exists(char *link) {
|
||||||
|
return file_exists(get_paste_filename(link));
|
||||||
|
}
|
||||||
|
|
||||||
|
FILE *get_paste_file(char *link, const char *mode) {
|
||||||
|
return fopen(get_paste_filename(link), mode);
|
||||||
|
}
|
||||||
|
|
||||||
|
FILE *get_del_file(char *link, const char *mode) {
|
||||||
|
return fopen(get_del_filename(link), mode);
|
||||||
|
}
|
||||||
|
|
||||||
|
char *gen_random_link() {
|
||||||
|
srand(time(NULL));
|
||||||
|
char *short_link = malloc(17);
|
||||||
|
do {
|
||||||
|
for(size_t i = 0; i < 16; ++i) {
|
||||||
|
sprintf(short_link + i, "%x", rand() % 16);
|
||||||
|
}
|
||||||
|
} while (paste_exists(short_link));
|
||||||
|
return short_link;
|
||||||
|
}
|
||||||
|
|
||||||
|
char *gen_del_key(char *link) {
|
||||||
|
char *salt = malloc(20);
|
||||||
|
char *rand_str = malloc(17);
|
||||||
|
srand(time(NULL));
|
||||||
|
for (size_t i = 0; i < 16; ++i) {
|
||||||
|
rand_str[i] = 37 + (rand() % 90); // random printable char
|
||||||
|
if (rand_str[i] == 92 || rand_str[i] == 58 ||
|
||||||
|
rand_str[i] == 59 || rand_str[i] == 42) --i; // chars not allowed for salts
|
||||||
|
}
|
||||||
|
rand_str[16] = 0;
|
||||||
|
sprintf(salt, "$6$%s", rand_str);
|
||||||
|
|
||||||
|
char *use_link = malloc(strlen(link) + strlen(seed) + 1);
|
||||||
|
sprintf(use_link, "%s%s", seed, link);
|
||||||
|
|
||||||
|
char *del_key = crypt(use_link, salt);
|
||||||
|
|
||||||
|
return del_key;
|
||||||
|
}
|
||||||
|
|
||||||
|
void trim(char *str) {
|
||||||
|
char *_str = str;
|
||||||
|
int len = strlen(_str);
|
||||||
|
|
||||||
|
while(*_str && *_str == '/') ++_str, --len;
|
||||||
|
|
||||||
|
memmove(str, _str, len + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
void handle_post(struct mg_connection *nc, char *content, char *host, char *link) {
|
||||||
|
char *short_link;
|
||||||
|
if (strlen(link) == 0) {
|
||||||
|
short_link = gen_random_link();
|
||||||
|
} else if (strlen(link) >= 255) {
|
||||||
|
return mg_http_reply(nc, 413, "", "paste link length can not exceed 255 characters");
|
||||||
|
} else {
|
||||||
|
short_link = link;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (paste_exists(short_link)) {
|
||||||
|
return mg_http_reply(nc, 500, "", "a paste named %s already exists", short_link);
|
||||||
|
}
|
||||||
|
|
||||||
|
FILE *url = get_paste_file(short_link, "w+");
|
||||||
|
fputs(content, url);
|
||||||
|
fclose(url);
|
||||||
|
|
||||||
|
FILE *del = get_del_file(short_link, "w+");
|
||||||
|
char *del_key = gen_del_key(short_link);
|
||||||
|
fputs(del_key, del);
|
||||||
|
fclose(del);
|
||||||
|
|
||||||
|
char *del_header = malloc(256);
|
||||||
|
sprintf(del_header, "X-Delete-With: %s\r\n", del_key);
|
||||||
|
|
||||||
|
mg_http_reply(nc, 201, del_header, "http://%s/%s", host, short_link);
|
||||||
|
}
|
||||||
|
|
||||||
|
void handle_delete(struct mg_connection *nc, char *link, char *del_key) {
|
||||||
|
if (paste_exists(link)) {
|
||||||
|
FILE *del = get_del_file(link, "r");
|
||||||
|
char *key = malloc(256);
|
||||||
|
fgets(key, 255, del);
|
||||||
|
if (strcmp(key, del_key) == 0) {
|
||||||
|
remove(get_paste_filename(link));
|
||||||
|
remove(get_del_filename(link));
|
||||||
|
mg_http_reply(nc, 204, "", "");
|
||||||
|
} else {
|
||||||
|
mg_http_reply(nc, 403, "", "incorrect deletion key");
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
mg_http_reply(nc, 404, "", "this paste does not exist");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
static void ev_handler(struct mg_connection *nc, int ev, void *p, void *f) {
|
||||||
|
if (ev == MG_EV_HTTP_MSG) {
|
||||||
|
struct mg_http_message *hm = (struct mg_http_message *) p;
|
||||||
|
char *uri = malloc(hm->uri.len + 1);
|
||||||
|
|
||||||
|
snprintf(uri, hm->uri.len + 1, "%s", hm->uri.ptr);
|
||||||
|
trim(uri);
|
||||||
|
|
||||||
|
struct mg_str *mhost = mg_http_get_header(hm, "Host");
|
||||||
|
char *host = malloc(mhost->len + 1);
|
||||||
|
snprintf(host, mhost->len + 1, "%s", mhost->ptr);
|
||||||
|
|
||||||
|
char *body = strdup(hm->body.ptr);
|
||||||
|
|
||||||
|
if (strncmp(hm->method.ptr, "POST", hm->method.len) == 0) {
|
||||||
|
handle_post(nc, body, host, uri); // FIXME: return 400 on bad Content-Type
|
||||||
|
} else if (strncmp(hm->method.ptr, "DELETE", hm->method.len) == 0) {
|
||||||
|
handle_delete(nc, uri, body);
|
||||||
|
} else if (strncmp(hm->method.ptr, "GET", hm->method.len) == 0) {
|
||||||
|
if (strlen(uri) == 0) {
|
||||||
|
return mg_http_reply(nc, 200, "Content-Type: text/html\r\n", INDEX_HTML,
|
||||||
|
host, host, host, host, host); // FIXME: need better solution
|
||||||
|
}
|
||||||
|
|
||||||
|
mg_http_serve_dir(nc, hm, &s_http_server_opts);
|
||||||
|
} else {
|
||||||
|
mg_http_reply(nc, 405, "Allow: GET, POST, DELETE\r\n", "");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
int main(int argc, char *argv[]) {
|
||||||
|
int index;
|
||||||
|
int c;
|
||||||
|
|
||||||
|
opterr = 0;
|
||||||
|
setvbuf(stdout, NULL, _IONBF, 0);
|
||||||
|
|
||||||
|
while ((c = getopt (argc, argv, "p:d:s:h")) != -1) {
|
||||||
|
switch (c) {
|
||||||
|
case 'p':
|
||||||
|
port = optarg;
|
||||||
|
break;
|
||||||
|
case 'd':
|
||||||
|
data_dir = optarg;
|
||||||
|
break;
|
||||||
|
case 's':
|
||||||
|
seed = optarg;
|
||||||
|
break;
|
||||||
|
case 'h':
|
||||||
|
printf("pacebin: a minimal pastebin\n");
|
||||||
|
printf("usage: %s [-p port] [-d data_dir] [-s seed]\n\n", argv[0]);
|
||||||
|
printf("options:\n");
|
||||||
|
printf("-p <port>\t\tport to use (default 8081)\n");
|
||||||
|
printf("-d <data directory>\tdirectory to store data (default /srv/pacebin)\n");
|
||||||
|
printf("-s <seed>\t\tsecret seed to use (DO NOT SHARE THIS; default 'secret')\n\n");
|
||||||
|
printf("source: https://short.swurl.xyz/pacebin (submit bug reports, suggestions, etc. here)\n");
|
||||||
|
return 0;
|
||||||
|
case '?':
|
||||||
|
if (optopt == 'p' || optopt == 'd' || optopt == 's') {
|
||||||
|
fprintf(stderr, "Option -%c requires an argument.\n", optopt);
|
||||||
|
}
|
||||||
|
else if (isprint (optopt)) {
|
||||||
|
fprintf(stderr, "Unknown option `-%c'.\n", optopt);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
fprintf(stderr, "Unknown option character `\\x%x'.\n", optopt);
|
||||||
|
}
|
||||||
|
return 1;
|
||||||
|
default:
|
||||||
|
abort();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (index = optind; index < argc; index++) {
|
||||||
|
printf ("Non-option argument %s\n", argv[index]);
|
||||||
|
}
|
||||||
|
|
||||||
|
rec_mkdir(strcat(strdup(data_dir), "/paste"));
|
||||||
|
rec_mkdir(strcat(strdup(data_dir), "/del"));
|
||||||
|
struct mg_mgr mgr;
|
||||||
|
struct mg_connection *nc;
|
||||||
|
|
||||||
|
char *root = malloc(strlen(data_dir) + 7);
|
||||||
|
snprintf(root, strlen(data_dir) + 7, "%s/paste", data_dir);
|
||||||
|
memset(&s_http_server_opts, 0, sizeof(s_http_server_opts));
|
||||||
|
s_http_server_opts.root_dir = root;
|
||||||
|
|
||||||
|
mg_mgr_init(&mgr);
|
||||||
|
printf("Starting web server on port %s\n", port);
|
||||||
|
char *str_port = malloc(20);
|
||||||
|
sprintf(str_port, "http://0.0.0.0:%s", port);
|
||||||
|
nc = mg_http_listen(&mgr, str_port, ev_handler, &mgr);
|
||||||
|
if (nc == NULL) {
|
||||||
|
printf("Failed to create listener\n");
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
for (;;) { mg_mgr_poll(&mgr, 1000); }
|
||||||
|
mg_mgr_free(&mgr);
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,737 @@
|
||||||
|
// Copyright (c) 2004-2013 Sergey Lyubka
|
||||||
|
// Copyright (c) 2013-2021 Cesanta Software Limited
|
||||||
|
// All rights reserved
|
||||||
|
//
|
||||||
|
// This software is dual-licensed: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License version 2 as
|
||||||
|
// published by the Free Software Foundation. For the terms of this
|
||||||
|
// license, see <http://www.gnu.org/licenses/>.
|
||||||
|
//
|
||||||
|
// You are free to use this software under the terms of the GNU General
|
||||||
|
// Public License, 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.
|
||||||
|
//
|
||||||
|
// Alternatively, you can license this software under a commercial
|
||||||
|
// license, as set out in <https://www.cesanta.com/license>.
|
||||||
|
|
||||||
|
#ifndef MONGOOSE_H
|
||||||
|
#define MONGOOSE_H
|
||||||
|
|
||||||
|
#define MG_VERSION "7.4"
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
extern "C" {
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef MG_ENABLE_SOCKET
|
||||||
|
#define MG_ENABLE_SOCKET 1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef MG_ENABLE_IPV6
|
||||||
|
#define MG_ENABLE_IPV6 0
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef MG_ENABLE_LOG
|
||||||
|
#define MG_ENABLE_LOG 1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// Set MG_ENABLE_WINSOCK=0 for Win32 builds with external IP stack (like LWIP)
|
||||||
|
#ifndef MG_ENABLE_WINSOCK
|
||||||
|
#define MG_ENABLE_WINSOCK 1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef MG_ENABLE_DIRLIST
|
||||||
|
#define MG_ENABLE_DIRLIST 0
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef MG_ENABLE_CUSTOM_RANDOM
|
||||||
|
#define MG_ENABLE_CUSTOM_RANDOM 0
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef MG_ENABLE_PACKED_FS
|
||||||
|
#define MG_ENABLE_PACKED_FS 0
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// Granularity of the send/recv IO buffer growth
|
||||||
|
#ifndef MG_IO_SIZE
|
||||||
|
#define MG_IO_SIZE 2048
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// Maximum size of the recv IO buffer
|
||||||
|
#ifndef MG_MAX_RECV_BUF_SIZE
|
||||||
|
#define MG_MAX_RECV_BUF_SIZE (3 * 1024 * 1024)
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef MG_MAX_HTTP_HEADERS
|
||||||
|
#define MG_MAX_HTTP_HEADERS 40
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef MG_PATH_MAX
|
||||||
|
#define MG_PATH_MAX PATH_MAX
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#define MG_ARCH_CUSTOM 0
|
||||||
|
#define MG_ARCH_UNIX 1
|
||||||
|
#define MG_ARCH_WIN32 2
|
||||||
|
#define MG_ARCH_ESP32 3
|
||||||
|
#define MG_ARCH_ESP8266 4
|
||||||
|
#define MG_ARCH_FREERTOS_TCP 5
|
||||||
|
#define MG_ARCH_FREERTOS_LWIP 6
|
||||||
|
|
||||||
|
#if !defined(MG_ARCH)
|
||||||
|
#if defined(__unix__) || defined(__APPLE__)
|
||||||
|
#define MG_ARCH MG_ARCH_UNIX
|
||||||
|
#elif defined(_WIN32)
|
||||||
|
#define MG_ARCH MG_ARCH_WIN32
|
||||||
|
#elif defined(ICACHE_FLASH) || defined(ICACHE_RAM_ATTR)
|
||||||
|
#define MG_ARCH MG_ARCH_ESP8266
|
||||||
|
#elif defined(ESP_PLATFORM)
|
||||||
|
#define MG_ARCH MG_ARCH_ESP32
|
||||||
|
#elif defined(FREERTOS_IP_H)
|
||||||
|
#define MG_ARCH MG_ARCH_FREERTOS_TCP
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if !defined(MG_ARCH)
|
||||||
|
#error "MG_ARCH is not specified and we couldn't guess it."
|
||||||
|
#endif
|
||||||
|
#endif // !defined(MG_ARCH)
|
||||||
|
|
||||||
|
#if !defined(PRINTF_LIKE)
|
||||||
|
#if defined(__GNUC__) || defined(__clang__) || defined(__TI_COMPILER_VERSION__)
|
||||||
|
#define PRINTF_LIKE(f, a) __attribute__((format(printf, f, a)))
|
||||||
|
#else
|
||||||
|
#define PRINTF_LIKE(f, a)
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if MG_ARCH == MG_ARCH_CUSTOM
|
||||||
|
#include <mongoose_custom.h>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if MG_ARCH == MG_ARCH_ESP32
|
||||||
|
|
||||||
|
#include <ctype.h>
|
||||||
|
#include <dirent.h>
|
||||||
|
#include <errno.h>
|
||||||
|
#include <fcntl.h>
|
||||||
|
#include <limits.h>
|
||||||
|
#include <netdb.h>
|
||||||
|
#include <stdarg.h>
|
||||||
|
#include <stddef.h>
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
#include <string.h>
|
||||||
|
#include <sys/stat.h>
|
||||||
|
#include <sys/types.h>
|
||||||
|
#include <time.h>
|
||||||
|
|
||||||
|
#define MG_DIRSEP '/'
|
||||||
|
#define MG_INT64_FMT "%lld"
|
||||||
|
#ifndef MG_PATH_MAX
|
||||||
|
#define MG_PATH_MAX 128
|
||||||
|
#endif
|
||||||
|
#undef MG_ENABLE_DIRLIST
|
||||||
|
#define MG_ENABLE_DIRLIST 1
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if MG_ARCH == MG_ARCH_ESP8266
|
||||||
|
|
||||||
|
#include <ctype.h>
|
||||||
|
#include <dirent.h>
|
||||||
|
#include <errno.h>
|
||||||
|
#include <fcntl.h>
|
||||||
|
#include <limits.h>
|
||||||
|
#include <netdb.h>
|
||||||
|
#include <stdarg.h>
|
||||||
|
#include <stdbool.h>
|
||||||
|
#include <stddef.h>
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
#include <string.h>
|
||||||
|
#include <sys/stat.h>
|
||||||
|
#include <sys/time.h>
|
||||||
|
#include <sys/types.h>
|
||||||
|
#include <time.h>
|
||||||
|
|
||||||
|
#include <esp_system.h>
|
||||||
|
|
||||||
|
#define MG_DIRSEP '/'
|
||||||
|
#define MG_INT64_FMT "%lld"
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if MG_ARCH == MG_ARCH_FREERTOS_LWIP
|
||||||
|
|
||||||
|
#include <stdarg.h>
|
||||||
|
#include <stdbool.h>
|
||||||
|
#include <stdint.h>
|
||||||
|
#include <string.h>
|
||||||
|
|
||||||
|
#if defined(__GNUC__)
|
||||||
|
#include <sys/stat.h>
|
||||||
|
#include <sys/time.h>
|
||||||
|
#else
|
||||||
|
typedef long suseconds_t;
|
||||||
|
struct timeval {
|
||||||
|
time_t tv_sec;
|
||||||
|
suseconds_t tv_usec;
|
||||||
|
};
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#include <FreeRTOS.h>
|
||||||
|
#include <task.h>
|
||||||
|
|
||||||
|
#include <lwip/sockets.h>
|
||||||
|
|
||||||
|
#if LWIP_SOCKET != 1
|
||||||
|
// Sockets support disabled in LWIP by default
|
||||||
|
#error Set LWIP_SOCKET variable to 1 (in lwipopts.h)
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if LWIP_POSIX_SOCKETS_IO_NAMES != 0
|
||||||
|
// LWIP_POSIX_SOCKETS_IO_NAMES must be disabled in posix-compatible OS
|
||||||
|
// enviroment (freertos mimics to one) otherwise names like `read` and `write`
|
||||||
|
// conflict
|
||||||
|
#error LWIP_POSIX_SOCKETS_IO_NAMES must be set to 0 (in lwipopts.h) for FreeRTOS
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#define MG_INT64_FMT "%lld"
|
||||||
|
#define MG_DIRSEP '/'
|
||||||
|
|
||||||
|
// Re-route calloc/free to the FreeRTOS's functions, don't use stdlib
|
||||||
|
static inline void *mg_calloc(int cnt, size_t size) {
|
||||||
|
void *p = pvPortMalloc(cnt * size);
|
||||||
|
if (p != NULL) memset(p, 0, size);
|
||||||
|
return p;
|
||||||
|
}
|
||||||
|
#define calloc(a, b) mg_calloc((a), (b))
|
||||||
|
#define free(a) vPortFree(a)
|
||||||
|
#define malloc(a) pvPortMalloc(a)
|
||||||
|
|
||||||
|
#define gmtime_r(a, b) gmtime(a)
|
||||||
|
|
||||||
|
#endif // MG_ARCH == MG_ARCH_FREERTOS_LWIP
|
||||||
|
|
||||||
|
#if MG_ARCH == MG_ARCH_FREERTOS_TCP
|
||||||
|
|
||||||
|
#include <ctype.h>
|
||||||
|
#include <errno.h>
|
||||||
|
#include <limits.h>
|
||||||
|
#include <stdarg.h>
|
||||||
|
#include <stdbool.h>
|
||||||
|
#include <stddef.h>
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
#include <string.h>
|
||||||
|
#include <sys/stat.h>
|
||||||
|
#include <time.h>
|
||||||
|
|
||||||
|
#include <FreeRTOS.h>
|
||||||
|
#include <FreeRTOS_IP.h>
|
||||||
|
#include <FreeRTOS_Sockets.h>
|
||||||
|
#include <task.h>
|
||||||
|
|
||||||
|
#define MG_INT64_FMT "%lld"
|
||||||
|
#define MG_DIRSEP '/'
|
||||||
|
|
||||||
|
// Why FreeRTOS-TCP did not implement a clean BSD API, but its own thing
|
||||||
|
// with FreeRTOS_ prefix, is beyond me
|
||||||
|
#define IPPROTO_TCP FREERTOS_IPPROTO_TCP
|
||||||
|
#define IPPROTO_UDP FREERTOS_IPPROTO_UDP
|
||||||
|
#define AF_INET FREERTOS_AF_INET
|
||||||
|
#define SOCK_STREAM FREERTOS_SOCK_STREAM
|
||||||
|
#define SOCK_DGRAM FREERTOS_SOCK_DGRAM
|
||||||
|
#define SO_BROADCAST 0
|
||||||
|
#define SO_ERROR 0
|
||||||
|
#define SOL_SOCKET 0
|
||||||
|
#define SO_REUSEADDR 0
|
||||||
|
#define sockaddr_in freertos_sockaddr
|
||||||
|
#define sockaddr freertos_sockaddr
|
||||||
|
#define accept(a, b, c) FreeRTOS_accept((a), (b), (c))
|
||||||
|
#define connect(a, b, c) FreeRTOS_connect((a), (b), (c))
|
||||||
|
#define bind(a, b, c) FreeRTOS_bind((a), (b), (c))
|
||||||
|
#define listen(a, b) FreeRTOS_listen((a), (b))
|
||||||
|
#define socket(a, b, c) FreeRTOS_socket((a), (b), (c))
|
||||||
|
#define send(a, b, c, d) FreeRTOS_send((a), (b), (c), (d))
|
||||||
|
#define recv(a, b, c, d) FreeRTOS_recv((a), (b), (c), (d))
|
||||||
|
#define setsockopt(a, b, c, d, e) FreeRTOS_setsockopt((a), (b), (c), (d), (e))
|
||||||
|
#define sendto(a, b, c, d, e, f) FreeRTOS_sendto((a), (b), (c), (d), (e), (f))
|
||||||
|
#define recvfrom(a, b, c, d, e, f) \
|
||||||
|
FreeRTOS_recvfrom((a), (b), (c), (d), (e), (f))
|
||||||
|
#define closesocket(x) FreeRTOS_closesocket(x)
|
||||||
|
#define gethostbyname(x) FreeRTOS_gethostbyname(x)
|
||||||
|
#define getsockname(a, b, c) (-1)
|
||||||
|
|
||||||
|
// Re-route calloc/free to the FreeRTOS's functions, don't use stdlib
|
||||||
|
static inline void *mg_calloc(int cnt, size_t size) {
|
||||||
|
void *p = pvPortMalloc(cnt * size);
|
||||||
|
if (p != NULL) memset(p, 0, size);
|
||||||
|
return p;
|
||||||
|
}
|
||||||
|
#define calloc(a, b) mg_calloc((a), (b))
|
||||||
|
#define free(a) vPortFree(a)
|
||||||
|
#define malloc(a) pvPortMalloc(a)
|
||||||
|
|
||||||
|
#define gmtime_r(a, b) gmtime(a)
|
||||||
|
|
||||||
|
#if !defined(__GNUC__)
|
||||||
|
// copied from GCC on ARM; for some reason useconds are signed
|
||||||
|
typedef long suseconds_t;
|
||||||
|
struct timeval {
|
||||||
|
time_t tv_sec;
|
||||||
|
suseconds_t tv_usec;
|
||||||
|
};
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef EINPROGRESS
|
||||||
|
#define EINPROGRESS pdFREERTOS_ERRNO_EINPROGRESS
|
||||||
|
#endif
|
||||||
|
#ifndef EWOULDBLOCK
|
||||||
|
#define EWOULDBLOCK pdFREERTOS_ERRNO_EWOULDBLOCK
|
||||||
|
#endif
|
||||||
|
#ifndef EAGAIN
|
||||||
|
#define EAGAIN pdFREERTOS_ERRNO_EAGAIN
|
||||||
|
#endif
|
||||||
|
#ifndef EINTR
|
||||||
|
#define EINTR pdFREERTOS_ERRNO_EINTR
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif // MG_ARCH == MG_ARCH_FREERTOS_TCP
|
||||||
|
|
||||||
|
#if MG_ARCH == MG_ARCH_UNIX
|
||||||
|
|
||||||
|
#define _DARWIN_UNLIMITED_SELECT 1 // No limit on file descriptors
|
||||||
|
|
||||||
|
#include <arpa/inet.h>
|
||||||
|
#include <ctype.h>
|
||||||
|
#include <dirent.h>
|
||||||
|
#include <errno.h>
|
||||||
|
#include <fcntl.h>
|
||||||
|
#include <inttypes.h>
|
||||||
|
#include <limits.h>
|
||||||
|
#include <netdb.h>
|
||||||
|
#include <netinet/tcp.h>
|
||||||
|
#include <signal.h>
|
||||||
|
#include <stdarg.h>
|
||||||
|
#include <stdbool.h>
|
||||||
|
#include <stddef.h>
|
||||||
|
#include <stdint.h>
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
#include <string.h>
|
||||||
|
#include <sys/select.h>
|
||||||
|
#include <sys/socket.h>
|
||||||
|
#include <sys/stat.h>
|
||||||
|
#include <sys/time.h>
|
||||||
|
#include <sys/types.h>
|
||||||
|
#include <time.h>
|
||||||
|
#include <unistd.h>
|
||||||
|
|
||||||
|
#define MG_DIRSEP '/'
|
||||||
|
#define MG_INT64_FMT "%" PRId64
|
||||||
|
#undef MG_ENABLE_DIRLIST
|
||||||
|
#define MG_ENABLE_DIRLIST 1
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if MG_ARCH == MG_ARCH_WIN32
|
||||||
|
|
||||||
|
#ifndef WIN32_LEAN_AND_MEAN
|
||||||
|
#define WIN32_LEAN_AND_MEAN
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef _CRT_SECURE_NO_WARNINGS
|
||||||
|
#define _CRT_SECURE_NO_WARNINGS
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef _WINSOCK_DEPRECATED_NO_WARNINGS
|
||||||
|
#define _WINSOCK_DEPRECATED_NO_WARNINGS
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#include <ctype.h>
|
||||||
|
#include <errno.h>
|
||||||
|
#include <fcntl.h>
|
||||||
|
#include <limits.h>
|
||||||
|
#include <stdarg.h>
|
||||||
|
#include <stddef.h>
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <stdlib.h>
|
||||||
|
#include <string.h>
|
||||||
|
#include <sys/stat.h>
|
||||||
|
#include <sys/types.h>
|
||||||
|
#include <time.h>
|
||||||
|
|
||||||
|
#if defined(_MSC_VER) && _MSC_VER < 1700
|
||||||
|
#define __func__ ""
|
||||||
|
typedef __int64 int64_t;
|
||||||
|
typedef unsigned __int64 uint64_t;
|
||||||
|
typedef unsigned char uint8_t;
|
||||||
|
typedef char int8_t;
|
||||||
|
typedef unsigned short uint16_t;
|
||||||
|
typedef short int16_t;
|
||||||
|
typedef unsigned int uint32_t;
|
||||||
|
typedef int int32_t;
|
||||||
|
typedef enum { false = 0, true = 1 } bool;
|
||||||
|
#else
|
||||||
|
#include <stdbool.h>
|
||||||
|
#include <stdint.h>
|
||||||
|
#include <ws2tcpip.h>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#include <winsock2.h>
|
||||||
|
|
||||||
|
// Protect from calls like std::snprintf in app code
|
||||||
|
// See https://github.com/cesanta/mongoose/issues/1047
|
||||||
|
#ifndef __cplusplus
|
||||||
|
#define snprintf _snprintf
|
||||||
|
#define vsnprintf _vsnprintf
|
||||||
|
#define strdup(x) _strdup(x)
|
||||||
|
#endif
|
||||||
|
|
||||||
|
typedef unsigned suseconds_t;
|
||||||
|
typedef int socklen_t;
|
||||||
|
#define MG_DIRSEP '\\'
|
||||||
|
#ifndef PATH_MAX
|
||||||
|
#define PATH_MAX MAX_PATH
|
||||||
|
#endif
|
||||||
|
#ifndef EINPROGRESS
|
||||||
|
#define EINPROGRESS WSAEINPROGRESS
|
||||||
|
#endif
|
||||||
|
#ifndef EWOULDBLOCK
|
||||||
|
#define EWOULDBLOCK WSAEWOULDBLOCK
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifndef va_copy
|
||||||
|
#ifdef __va_copy
|
||||||
|
#define va_copy __va_copy
|
||||||
|
#else
|
||||||
|
#define va_copy(x, y) (x) = (y)
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
#ifndef S_ISDIR
|
||||||
|
#define S_ISDIR(x) (((x) &_S_IFMT) == _S_IFDIR)
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#define MG_INT64_FMT "%I64d"
|
||||||
|
|
||||||
|
#undef MG_ENABLE_DIRLIST
|
||||||
|
#define MG_ENABLE_DIRLIST 1
|
||||||
|
|
||||||
|
// https://lgtm.com/rules/2154840805/ -gmtime, localtime, ctime and asctime
|
||||||
|
static __inline struct tm *gmtime_r(time_t *t, struct tm *tm) {
|
||||||
|
(void) tm;
|
||||||
|
return gmtime(t);
|
||||||
|
}
|
||||||
|
|
||||||
|
static __inline struct tm *localtime_r(time_t *t, struct tm *tm) {
|
||||||
|
(void) tm;
|
||||||
|
return localtime(t);
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#include <ctype.h>
|
||||||
|
#include <string.h>
|
||||||
|
|
||||||
|
struct mg_str {
|
||||||
|
const char *ptr; // Pointer to string data
|
||||||
|
size_t len; // String len
|
||||||
|
};
|
||||||
|
|
||||||
|
#define MG_NULL_STR \
|
||||||
|
{ NULL, 0 }
|
||||||
|
|
||||||
|
// Using macro to avoid shadowing C++ struct constructor, see #1298
|
||||||
|
#define mg_str(s) mg_str_s(s)
|
||||||
|
|
||||||
|
struct mg_str mg_str(const char *s);
|
||||||
|
struct mg_str mg_str_n(const char *s, size_t n);
|
||||||
|
int mg_lower(const char *s);
|
||||||
|
int mg_ncasecmp(const char *s1, const char *s2, size_t len);
|
||||||
|
int mg_casecmp(const char *s1, const char *s2);
|
||||||
|
int mg_vcmp(const struct mg_str *s1, const char *s2);
|
||||||
|
int mg_vcasecmp(const struct mg_str *str1, const char *str2);
|
||||||
|
int mg_strcmp(const struct mg_str str1, const struct mg_str str2);
|
||||||
|
struct mg_str mg_strstrip(struct mg_str s);
|
||||||
|
struct mg_str mg_strdup(const struct mg_str s);
|
||||||
|
const char *mg_strstr(const struct mg_str haystack, const struct mg_str needle);
|
||||||
|
|
||||||
|
#if MG_ENABLE_LOG
|
||||||
|
#define LOG(level, args) \
|
||||||
|
do { \
|
||||||
|
if (mg_log_prefix((level), __FILE__, __LINE__, __func__)) mg_log args; \
|
||||||
|
} while (0)
|
||||||
|
enum { LL_NONE, LL_ERROR, LL_INFO, LL_DEBUG, LL_VERBOSE_DEBUG };
|
||||||
|
bool mg_log_prefix(int ll, const char *file, int line, const char *fname);
|
||||||
|
void mg_log(const char *fmt, ...) PRINTF_LIKE(1, 2);
|
||||||
|
void mg_log_set(const char *spec);
|
||||||
|
void mg_log_set_callback(void (*fn)(const void *, size_t, void *), void *param);
|
||||||
|
#else
|
||||||
|
#define LOG(level, args) (void) 0
|
||||||
|
#define mg_log_set(x) (void) (x)
|
||||||
|
#endif
|
||||||
|
|
||||||
|
struct mg_timer {
|
||||||
|
unsigned long period_ms; // Timer period in milliseconds
|
||||||
|
unsigned flags; // Possible flags values below
|
||||||
|
void (*fn)(void *); // Function to call
|
||||||
|
void *arg; // Function argument
|
||||||
|
unsigned long expire; // Expiration timestamp in milliseconds
|
||||||
|
struct mg_timer *next; // Linkage in g_timers list
|
||||||
|
};
|
||||||
|
|
||||||
|
#define MG_TIMER_REPEAT 1 // Call function periodically, otherwise run once
|
||||||
|
#define MG_TIMER_RUN_NOW 2 // Call immediately when timer is set
|
||||||
|
|
||||||
|
extern struct mg_timer *g_timers; // Global list of timers
|
||||||
|
|
||||||
|
void mg_timer_init(struct mg_timer *, unsigned long ms, unsigned,
|
||||||
|
void (*fn)(void *), void *);
|
||||||
|
void mg_timer_free(struct mg_timer *);
|
||||||
|
void mg_timer_poll(unsigned long uptime_ms);
|
||||||
|
|
||||||
|
char *mg_file_read(const char *path, size_t *size);
|
||||||
|
bool mg_file_write(const char *path, const void *buf, size_t len);
|
||||||
|
bool mg_file_printf(const char *path, const char *fmt, ...);
|
||||||
|
void mg_random(void *buf, size_t len);
|
||||||
|
bool mg_globmatch(const char *pattern, size_t plen, const char *s, size_t n);
|
||||||
|
bool mg_commalist(struct mg_str *s, struct mg_str *k, struct mg_str *v);
|
||||||
|
uint16_t mg_ntohs(uint16_t net);
|
||||||
|
uint32_t mg_ntohl(uint32_t net);
|
||||||
|
uint32_t mg_crc32(uint32_t crc, const char *buf, size_t len);
|
||||||
|
char *mg_hexdump(const void *buf, size_t len);
|
||||||
|
char *mg_hex(const void *buf, size_t len, char *dst);
|
||||||
|
void mg_unhex(const char *buf, size_t len, unsigned char *to);
|
||||||
|
unsigned long mg_unhexn(const char *s, size_t len);
|
||||||
|
int mg_asprintf(char **buf, size_t size, const char *fmt, ...);
|
||||||
|
int mg_vasprintf(char **buf, size_t size, const char *fmt, va_list ap);
|
||||||
|
int64_t mg_to64(struct mg_str str);
|
||||||
|
int mg_check_ip_acl(struct mg_str acl, uint32_t remote_ip);
|
||||||
|
double mg_time(void);
|
||||||
|
unsigned long mg_millis(void);
|
||||||
|
void mg_usleep(unsigned long usecs);
|
||||||
|
|
||||||
|
#define mg_htons(x) mg_ntohs(x)
|
||||||
|
#define mg_htonl(x) mg_ntohl(x)
|
||||||
|
|
||||||
|
// Expands to a string representation of its argument: e.g.
|
||||||
|
// MG_STRINGIFY_LITERAL(5) expands to "5"
|
||||||
|
#if !defined(_MSC_VER) || _MSC_VER >= 1900
|
||||||
|
#define MG_STRINGIFY_LITERAL(...) #__VA_ARGS__
|
||||||
|
#else
|
||||||
|
#define MG_STRINGIFY_LITERAL(x) #x
|
||||||
|
#endif
|
||||||
|
// Expands to a string representation of its argument, which can be a macro:
|
||||||
|
// #define FOO 123
|
||||||
|
// MG_STRINGIFY_MACRO(FOO) // Expands to 123
|
||||||
|
#define MG_STRINGIFY_MACRO(x) MG_STRINGIFY_LITERAL(x)
|
||||||
|
|
||||||
|
// Linked list management macros
|
||||||
|
#define LIST_ADD_HEAD(type_, head_, elem_) \
|
||||||
|
do { \
|
||||||
|
(elem_)->next = (*head_); \
|
||||||
|
*(head_) = (elem_); \
|
||||||
|
} while (0)
|
||||||
|
|
||||||
|
#define LIST_ADD_TAIL(type_, head_, elem_) \
|
||||||
|
do { \
|
||||||
|
type_ **h = head_; \
|
||||||
|
while (*h != NULL) h = &(*h)->next; \
|
||||||
|
*h = (elem_); \
|
||||||
|
} while (0)
|
||||||
|
|
||||||
|
#define LIST_DELETE(type_, head_, elem_) \
|
||||||
|
do { \
|
||||||
|
type_ **h = head_; \
|
||||||
|
while (*h != (elem_)) h = &(*h)->next; \
|
||||||
|
*h = (elem_)->next; \
|
||||||
|
} while (0)
|
||||||
|
|
||||||
|
enum { MG_FS_READ = 1, MG_FS_WRITE = 2, MG_FS_DIR = 4 };
|
||||||
|
|
||||||
|
// Filesystem API functions
|
||||||
|
// stat() returns MG_FS_* flags and populates file size and modification time
|
||||||
|
// list() calls fn() for every directory entry, allowing to list a directory
|
||||||
|
struct mg_fs {
|
||||||
|
int (*stat)(const char *path, size_t *size, time_t *mtime);
|
||||||
|
void (*list)(const char *path, void (*fn)(const char *, void *), void *);
|
||||||
|
struct mg_fd *(*open)(const char *path, int flags); // Open file
|
||||||
|
void (*close)(struct mg_fd *fd); // Close file
|
||||||
|
size_t (*read)(void *fd, void *buf, size_t len); // Read file
|
||||||
|
size_t (*write)(void *fd, const void *buf, size_t len); // Write file
|
||||||
|
size_t (*seek)(void *fd, size_t offset); // Set file position
|
||||||
|
};
|
||||||
|
|
||||||
|
// File descriptor
|
||||||
|
struct mg_fd {
|
||||||
|
void *fd;
|
||||||
|
struct mg_fs *fs;
|
||||||
|
};
|
||||||
|
|
||||||
|
extern struct mg_fs mg_fs_posix; // POSIX open/close/read/write/seek
|
||||||
|
extern struct mg_fs mg_fs_packed; // Packed FS, see examples/complete
|
||||||
|
|
||||||
|
unsigned short mg_url_port(const char *url);
|
||||||
|
int mg_url_is_ssl(const char *url);
|
||||||
|
struct mg_str mg_url_host(const char *url);
|
||||||
|
struct mg_str mg_url_user(const char *url);
|
||||||
|
struct mg_str mg_url_pass(const char *url);
|
||||||
|
const char *mg_url_uri(const char *url);
|
||||||
|
|
||||||
|
#include <stddef.h>
|
||||||
|
|
||||||
|
struct mg_iobuf {
|
||||||
|
unsigned char *buf; // Pointer to stored data
|
||||||
|
size_t size; // Total size available
|
||||||
|
size_t len; // Current number of bytes
|
||||||
|
};
|
||||||
|
|
||||||
|
int mg_iobuf_init(struct mg_iobuf *, size_t);
|
||||||
|
int mg_iobuf_resize(struct mg_iobuf *, size_t);
|
||||||
|
void mg_iobuf_free(struct mg_iobuf *);
|
||||||
|
size_t mg_iobuf_add(struct mg_iobuf *, size_t, const void *, size_t, size_t);
|
||||||
|
size_t mg_iobuf_del(struct mg_iobuf *, size_t ofs, size_t len);
|
||||||
|
|
||||||
|
struct mg_connection;
|
||||||
|
typedef void (*mg_event_handler_t)(struct mg_connection *, int ev,
|
||||||
|
void *ev_data, void *fn_data);
|
||||||
|
void mg_call(struct mg_connection *c, int ev, void *ev_data);
|
||||||
|
void mg_error(struct mg_connection *c, const char *fmt, ...);
|
||||||
|
|
||||||
|
enum {
|
||||||
|
MG_EV_ERROR, // Error char *error_message
|
||||||
|
MG_EV_POLL, // mg_mgr_poll iteration unsigned long *millis
|
||||||
|
MG_EV_RESOLVE, // Host name is resolved NULL
|
||||||
|
MG_EV_CONNECT, // Connection established NULL
|
||||||
|
MG_EV_ACCEPT, // Connection accepted NULL
|
||||||
|
MG_EV_READ, // Data received from socket struct mg_str *
|
||||||
|
MG_EV_WRITE, // Data written to socket long *bytes_written
|
||||||
|
MG_EV_CLOSE, // Connection closed NULL
|
||||||
|
MG_EV_HTTP_MSG, // HTTP request/response struct mg_http_message *
|
||||||
|
MG_EV_HTTP_CHUNK, // HTTP chunk (partial msg) struct mg_http_message *
|
||||||
|
MG_EV_USER, // Starting ID for user events
|
||||||
|
};
|
||||||
|
|
||||||
|
struct mg_addr {
|
||||||
|
uint16_t port; // TCP or UDP port in network byte order
|
||||||
|
uint32_t ip; // IP address in network byte order
|
||||||
|
uint8_t ip6[16]; // IPv6 address
|
||||||
|
bool is_ip6; // True when address is IPv6 address
|
||||||
|
};
|
||||||
|
|
||||||
|
struct mg_mgr {
|
||||||
|
struct mg_connection *conns; // List of active connections
|
||||||
|
unsigned long nextid; // Next connection ID
|
||||||
|
void *userdata; // Arbitrary user data pointer
|
||||||
|
#if MG_ARCH == MG_ARCH_FREERTOS_TCP
|
||||||
|
SocketSet_t ss; // NOTE(lsm): referenced from socket struct
|
||||||
|
#endif
|
||||||
|
};
|
||||||
|
|
||||||
|
struct mg_connection {
|
||||||
|
struct mg_connection *next; // Linkage in struct mg_mgr :: connections
|
||||||
|
struct mg_mgr *mgr; // Our container
|
||||||
|
struct mg_addr peer; // Remote address. For listeners, local address
|
||||||
|
void *fd; // Connected socket, or LWIP data
|
||||||
|
unsigned long id; // Auto-incrementing unique connection ID
|
||||||
|
struct mg_iobuf recv; // Incoming data
|
||||||
|
struct mg_iobuf send; // Outgoing data
|
||||||
|
mg_event_handler_t fn; // User-specified event handler function
|
||||||
|
void *fn_data; // User-specified function parameter
|
||||||
|
mg_event_handler_t pfn; // Protocol-specific handler function
|
||||||
|
void *pfn_data; // Protocol-specific function parameter
|
||||||
|
char label[50]; // Arbitrary label
|
||||||
|
void *tls; // TLS specific data
|
||||||
|
unsigned is_listening : 1; // Listening connection
|
||||||
|
unsigned is_client : 1; // Outbound (client) connection
|
||||||
|
unsigned is_accepted : 1; // Accepted (server) connection
|
||||||
|
unsigned is_resolving : 1; // Non-blocking DNS resolution is in progress
|
||||||
|
unsigned is_connecting : 1; // Non-blocking connect is in progress
|
||||||
|
unsigned is_tls : 1; // TLS-enabled connection
|
||||||
|
unsigned is_tls_hs : 1; // TLS handshake is in progress
|
||||||
|
unsigned is_udp : 1; // UDP connection
|
||||||
|
unsigned is_websocket : 1; // WebSocket connection
|
||||||
|
unsigned is_hexdumping : 1; // Hexdump in/out traffic
|
||||||
|
unsigned is_draining : 1; // Send remaining data, then close and free
|
||||||
|
unsigned is_closing : 1; // Close and free the connection immediately
|
||||||
|
unsigned is_readable : 1; // Connection is ready to read
|
||||||
|
unsigned is_writable : 1; // Connection is ready to write
|
||||||
|
};
|
||||||
|
|
||||||
|
void mg_mgr_poll(struct mg_mgr *, int ms);
|
||||||
|
void mg_mgr_init(struct mg_mgr *);
|
||||||
|
void mg_mgr_free(struct mg_mgr *);
|
||||||
|
|
||||||
|
struct mg_connection *mg_listen(struct mg_mgr *, const char *url,
|
||||||
|
mg_event_handler_t fn, void *fn_data);
|
||||||
|
struct mg_connection *mg_connect(struct mg_mgr *, const char *url,
|
||||||
|
mg_event_handler_t fn, void *fn_data);
|
||||||
|
bool mg_send(struct mg_connection *, const void *, size_t);
|
||||||
|
int mg_printf(struct mg_connection *, const char *fmt, ...);
|
||||||
|
int mg_vprintf(struct mg_connection *, const char *fmt, va_list ap);
|
||||||
|
char *mg_straddr(struct mg_connection *, char *, size_t);
|
||||||
|
bool mg_aton(struct mg_str str, struct mg_addr *addr);
|
||||||
|
char *mg_ntoa(const struct mg_addr *addr, char *buf, size_t len);
|
||||||
|
|
||||||
|
struct mg_connection *mg_mkpipe(struct mg_mgr *, mg_event_handler_t, void *);
|
||||||
|
void mg_mgr_wakeup(struct mg_connection *pipe);
|
||||||
|
|
||||||
|
struct mg_http_header {
|
||||||
|
struct mg_str name; // Header name
|
||||||
|
struct mg_str value; // Header value
|
||||||
|
};
|
||||||
|
|
||||||
|
struct mg_http_message {
|
||||||
|
struct mg_str method, uri, query, proto; // Request/response line
|
||||||
|
struct mg_http_header headers[MG_MAX_HTTP_HEADERS]; // Headers
|
||||||
|
struct mg_str body; // Body
|
||||||
|
struct mg_str head; // Request + headers
|
||||||
|
struct mg_str chunk; // Chunk for chunked encoding, or partial body
|
||||||
|
struct mg_str message; // Request + headers + body
|
||||||
|
};
|
||||||
|
|
||||||
|
// Parameter for mg_http_serve_dir()
|
||||||
|
struct mg_http_serve_opts {
|
||||||
|
const char *root_dir; // Web root directory, must be non-NULL
|
||||||
|
const char *extra_headers; // Extra HTTP headers to add in responses
|
||||||
|
const char *mime_types; // Extra mime types, ext1=type1,ext2=type2,..
|
||||||
|
struct mg_fs *fs; // Filesystem implementation. Use NULL for POSIX
|
||||||
|
};
|
||||||
|
|
||||||
|
// Parameter for mg_http_next_multipart
|
||||||
|
struct mg_http_part {
|
||||||
|
struct mg_str name; // Form field name
|
||||||
|
struct mg_str filename; // Filename for file uploads
|
||||||
|
struct mg_str body; // Part contents
|
||||||
|
};
|
||||||
|
|
||||||
|
int mg_http_parse(const char *s, size_t len, struct mg_http_message *);
|
||||||
|
int mg_http_get_request_len(const unsigned char *buf, size_t buf_len);
|
||||||
|
void mg_http_printf_chunk(struct mg_connection *cnn, const char *fmt, ...);
|
||||||
|
void mg_http_write_chunk(struct mg_connection *c, const char *buf, size_t len);
|
||||||
|
void mg_http_delete_chunk(struct mg_connection *c, struct mg_http_message *hm);
|
||||||
|
struct mg_connection *mg_http_listen(struct mg_mgr *, const char *url,
|
||||||
|
mg_event_handler_t fn, void *fn_data);
|
||||||
|
struct mg_connection *mg_http_connect(struct mg_mgr *, const char *url,
|
||||||
|
mg_event_handler_t fn, void *fn_data);
|
||||||
|
void mg_http_serve_dir(struct mg_connection *, struct mg_http_message *hm,
|
||||||
|
struct mg_http_serve_opts *opts);
|
||||||
|
void mg_http_serve_file(struct mg_connection *, struct mg_http_message *hm,
|
||||||
|
const char *path, struct mg_http_serve_opts *opts);
|
||||||
|
void mg_http_reply(struct mg_connection *, int status_code, const char *headers,
|
||||||
|
const char *body_fmt, ...);
|
||||||
|
struct mg_str *mg_http_get_header(struct mg_http_message *, const char *name);
|
||||||
|
int mg_http_get_var(const struct mg_str *, const char *name, char *, size_t);
|
||||||
|
int mg_url_decode(const char *s, size_t n, char *to, size_t to_len, int form);
|
||||||
|
size_t mg_url_encode(const char *s, size_t n, char *buf, size_t len);
|
||||||
|
bool mg_http_match_uri(const struct mg_http_message *, const char *glob);
|
||||||
|
struct mg_str mg_http_get_header_var(struct mg_str s, struct mg_str v);
|
||||||
|
size_t mg_http_next_multipart(struct mg_str, size_t, struct mg_http_part *);
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
#endif // MONGOOSE_H
|
||||||
|
|
||||||
Loading…
Reference in New Issue