Initial commit
commit
cdae585ee6
@ -0,0 +1 @@
|
||||
/target
|
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,6 @@
|
||||
[workspace]
|
||||
members = [
|
||||
"core",
|
||||
"cli",
|
||||
"rest-http",
|
||||
]
|
@ -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,190 @@
|
||||
# Mailpot - WIP mailing list manager
|
||||
|
||||
Crates:
|
||||
|
||||
- `core`
|
||||
- `cli` a command line tool to manage lists
|
||||
- `rest-http` a REST http server to manage lists
|
||||
|
||||
## Project goals
|
||||
|
||||
- easy setup
|
||||
- extensible through Rust API as a library
|
||||
- extensible through HTTP REST API as an HTTP server, with webhooks
|
||||
- basic management through CLI
|
||||
- replaceable lightweight web archiver
|
||||
- custom storage?
|
||||
- useful for both newsletters, discussions
|
||||
|
||||
## Initial setup
|
||||
|
||||
Check where `mpot` expects your database file to be:
|
||||
|
||||
```shell
|
||||
$ cargo run --bin mpot -- db-location
|
||||
Configuration file /home/user/.config/mailpot/config.toml doesn't exist
|
||||
```
|
||||
|
||||
Uuugh, oops.
|
||||
|
||||
```shell
|
||||
$ mkdir -p /home/user/.config/mailpot
|
||||
$ echo 'send_mail = { "type" = "ShellCommand", "value" = "/usr/bin/false" }' > /home/user/.config/mailpot/config.toml
|
||||
$ cargo run --bin mpot -- db-location
|
||||
/home/user/.local/share/mailpot/mpot.db
|
||||
```
|
||||
|
||||
Now you can initialize the database file:
|
||||
|
||||
```shell
|
||||
$ mkdir -p /home/user/.local/share/mailpot/
|
||||
$ sqlite3 /home/user/.local/share/mailpot/mpot.db < ./core/src/schema.sql
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```text
|
||||
% mpot help
|
||||
mailpot 0.1.0
|
||||
mini mailing list manager
|
||||
|
||||
USAGE:
|
||||
mpot [FLAGS] [OPTIONS] <SUBCOMMAND>
|
||||
|
||||
FLAGS:
|
||||
-d, --debug Activate debug mode
|
||||
-h, --help Prints help information
|
||||
-V, --version Prints version information
|
||||
|
||||
OPTIONS:
|
||||
-c, --config <config> Set config file
|
||||
|
||||
SUBCOMMANDS:
|
||||
create-list Create new list
|
||||
db-location Prints database filesystem location
|
||||
help Prints this message or the help of the given subcommand(s)
|
||||
list Mailing list management
|
||||
list-lists Lists all registered mailing lists
|
||||
post Post message from STDIN to list
|
||||
```
|
||||
|
||||
### Receiving mail
|
||||
|
||||
```shell
|
||||
$ cat list-request.eml | cargo run --bin mpot -- -vvvvvv post --dry-run
|
||||
```
|
||||
|
||||
<details><summary>output</summary>
|
||||
|
||||
```shell
|
||||
TRACE - Received envelope to post: Envelope {
|
||||
Subject: "unsubscribe",
|
||||
Date: "Tue, 04 Aug 2020 14:10:13 +0300",
|
||||
From: [
|
||||
Address::Mailbox {
|
||||
display_name: "Mxxxx Pxxxxxxxxxxxx",
|
||||
address_spec: "exxxxx@localhost",
|
||||
},
|
||||
],
|
||||
To: [
|
||||
Address::Mailbox {
|
||||
display_name: "",
|
||||
address_spec: "test-announce+request@localhost",
|
||||
},
|
||||
],
|
||||
Message-ID: "<ejduu.fddf8sgen4j7@localhost>",
|
||||
In-Reply-To: None,
|
||||
References: None,
|
||||
Hash: 12581897380059220314,
|
||||
}
|
||||
TRACE - unsubscribe action for addresses [Address::Mailbox { display_name: "Mxxxx Pxxxxxxxxxxxx", address_spec: "exxxxx@localhost" }] in list [#2 test-announce] test announcements <test-announce@localhost>
|
||||
TRACE - Is post related to list [#1 test] Test list <test@localhost>? false
|
||||
```
|
||||
</details>
|
||||
|
||||
```shell
|
||||
$ cat list-post.eml | cargo run --bin mpot -- -vvvvvv post --dry-run
|
||||
```
|
||||
|
||||
<details><summary>output</summary>
|
||||
|
||||
```shell
|
||||
TRACE - Received envelope to post: Envelope {
|
||||
Subject: "[test-announce] new test releases",
|
||||
Date: "Tue, 04 Aug 2020 14:10:13 +0300",
|
||||
From: [
|
||||
Address::Mailbox {
|
||||
display_name: "Mxxxx Pxxxxxxxxxxxx",
|
||||
address_spec: "exxxxx@localhost",
|
||||
},
|
||||
],
|
||||
To: [
|
||||
Address::Mailbox {
|
||||
display_name: "",
|
||||
address_spec: "test-announce@localhost",
|
||||
},
|
||||
],
|
||||
Message-ID: "<ejduu.sddf8sgen4j7@localhost>",
|
||||
In-Reply-To: None,
|
||||
References: None,
|
||||
Hash: 10220641455578979007,
|
||||
}
|
||||
TRACE - Is post related to list [#1 test] Test list <test@localhost>? false
|
||||
TRACE - Is post related to list [#2 test-announce] test announcements <test-announce@localhost>? true
|
||||
TRACE - Examining list "test announcements" <test-announce@localhost>
|
||||
TRACE - List members [
|
||||
ListMembership {
|
||||
list: 2,
|
||||
address: "exxxxx@localhost",
|
||||
name: None,
|
||||
digest: false,
|
||||
hide_address: false,
|
||||
receive_duplicates: false,
|
||||
receive_own_posts: true,
|
||||
receive_confirmation: true,
|
||||
enabled: true,
|
||||
},
|
||||
]
|
||||
TRACE - Running FixCRLF filter
|
||||
TRACE - Running PostRightsCheck filter
|
||||
TRACE - Running AddListHeaders filter
|
||||
TRACE - Running FinalizeRecipients filter
|
||||
TRACE - examining member ListMembership { list: 2, address: "exxxxx@localhost", name: None, digest: false, hide_address: false, receive_duplicates: false, receive_own_posts: true, receive_confirmation: true, enabled: true }
|
||||
TRACE - member is submitter
|
||||
TRACE - Member gets copy
|
||||
TRACE - result Ok(
|
||||
Post {
|
||||
list: MailingList {
|
||||
pk: 2,
|
||||
name: "test announcements",
|
||||
id: "test-announce",
|
||||
address: "test-announce@localhost",
|
||||
description: None,
|
||||
archive_url: None,
|
||||
},
|
||||
from: Address::Mailbox {
|
||||
display_name: "Mxxxx Pxxxxxxxxxxxx",
|
||||
address_spec: "exxxxx@localhost",
|
||||
},
|
||||
members: 1,
|
||||
bytes: 851,
|
||||
policy: None,
|
||||
to: [
|
||||
Address::Mailbox {
|
||||
display_name: "",
|
||||
address_spec: "test-announce@localhost",
|
||||
},
|
||||
],
|
||||
action: Accept {
|
||||
recipients: [
|
||||
Address::Mailbox {
|
||||
display_name: "",
|
||||
address_spec: "exxxxx@localhost",
|
||||
},
|
||||
],
|
||||
digests: [],
|
||||
},
|
||||
},
|
||||
)
|
||||
```
|
||||
</details>
|
@ -0,0 +1,21 @@
|
||||
[package]
|
||||
name = "mailpot-cli"
|
||||
version = "0.1.0"
|
||||
authors = ["Manos Pitsidianakis <el13635@mail.ntua.gr>"]
|
||||
edition = "2018"
|
||||
license = "LICENSE"
|
||||
readme = "README.md"
|
||||
description = "mailing list manager"
|
||||
repository = "https://github.com/meli/mailpot"
|
||||
keywords = ["mail", "mailing-lists" ]
|
||||
categories = ["email"]
|
||||
default-run = "mpot"
|
||||
|
||||
[[bin]]
|
||||
name = "mpot"
|
||||
path = "src/main.rs"
|
||||
|
||||
[dependencies]
|
||||
mailpot = { version = "0.1.0", path = "../core" }
|
||||
structopt = "0.3.16"
|
||||
stderrlog = "^0.5"
|
@ -0,0 +1,5 @@
|
||||
# mailpot-cli
|
||||
|
||||
```shell
|
||||
cargo run --bin mpot -- help
|
||||
```
|
@ -0,0 +1,472 @@
|
||||
/*
|
||||
* This file is part of mailpot
|
||||
*
|
||||
* Copyright 2020 - Manos Pitsidianakis
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
extern crate mailpot;
|
||||
extern crate stderrlog;
|
||||
|
||||
pub use mailpot::config::*;
|
||||
pub use mailpot::db::*;
|
||||
pub use mailpot::errors::*;
|
||||
pub use mailpot::mail::*;
|
||||
pub use mailpot::models::changesets::*;
|
||||
pub use mailpot::models::*;
|
||||
pub use mailpot::*;
|
||||
use std::path::PathBuf;
|
||||
use structopt::StructOpt;
|
||||
|
||||
#[derive(Debug, StructOpt)]
|
||||
#[structopt(
|
||||
name = "mailpot",
|
||||
about = "mini mailing list manager",
|
||||
author = "Manos Pitsidianakis <epilys@nessuent.xyz>"
|
||||
)]
|
||||
struct Opt {
|
||||
/// Activate debug mode
|
||||
#[structopt(short, long)]
|
||||
debug: bool,
|
||||
|
||||
/// Set config file
|
||||
#[structopt(short, long, parse(from_os_str))]
|
||||
#[allow(dead_code)]
|
||||
config: Option<PathBuf>,
|
||||
#[structopt(flatten)]
|
||||
cmd: Command,
|
||||
/// Silence all output
|
||||
#[structopt(short = "q", long = "quiet")]
|
||||
quiet: bool,
|
||||
/// Verbose mode (-v, -vv, -vvv, etc)
|
||||
#[structopt(short = "v", long = "verbose", parse(from_occurrences))]
|
||||
verbose: usize,
|
||||
/// Timestamp (sec, ms, ns, none)
|
||||
#[structopt(short = "t", long = "timestamp")]
|
||||
ts: Option<stderrlog::Timestamp>,
|
||||
}
|
||||
|
||||
#[derive(Debug, StructOpt)]
|
||||
enum Command {
|
||||
///Prints database filesystem location
|
||||
DbLocation,
|
||||
///Dumps database data to STDOUT
|
||||
DumpDatabase,
|
||||
///Lists all registered mailing lists
|
||||
ListLists,
|
||||
///Mailing list management
|
||||
List {
|
||||
///Selects mailing list to operate on
|
||||
list_id: String,
|
||||
#[structopt(subcommand)]
|
||||
cmd: ListCommand,
|
||||
},
|
||||
///Create new list
|
||||
CreateList {
|
||||
///List name
|
||||
#[structopt(long)]
|
||||
name: String,
|
||||
///List ID
|
||||
#[structopt(long)]
|
||||
id: String,
|
||||
///List e-mail address
|
||||
#[structopt(long)]
|
||||
address: String,
|
||||
///List description
|
||||
#[structopt(long)]
|
||||
description: Option<String>,
|
||||
///List archive URL
|
||||
#[structopt(long)]
|
||||
archive_url: Option<String>,
|
||||
},
|
||||
///Post message from STDIN to list
|
||||
Post {
|
||||
#[structopt(long)]
|
||||
dry_run: bool,
|
||||
},
|
||||
}
|
||||
|
||||
#[derive(Debug, StructOpt)]
|
||||
enum ListCommand {
|
||||
/// List members of list.
|
||||
Members,
|
||||
/// Add member to list.
|
||||
AddMember {
|
||||
/// E-mail address
|
||||
#[structopt(long)]
|
||||
address: String,
|
||||
/// Name
|
||||
#[structopt(long)]
|
||||
name: Option<String>,
|
||||
/// Send messages as digest?
|
||||
#[structopt(long)]
|
||||
digest: bool,
|
||||
/// Hide message from list when posting?
|
||||
#[structopt(long)]
|
||||
hide_address: bool,
|
||||
/// Hide message from list when posting?
|
||||
#[structopt(long)]
|
||||
/// Receive confirmation email when posting?
|
||||
receive_confirmation: Option<bool>,
|
||||
#[structopt(long)]
|
||||
/// Receive posts from list even if address exists in To or Cc header?
|
||||
receive_duplicates: Option<bool>,
|
||||
#[structopt(long)]
|
||||
/// Receive own posts from list?
|
||||
receive_own_posts: Option<bool>,
|
||||
#[structopt(long)]
|
||||
/// Is subscription enabled?
|
||||
enabled: Option<bool>,
|
||||
},
|
||||
/// Remove member from list.
|
||||
RemoveMember {
|
||||
#[structopt(long)]
|
||||
/// E-mail address
|
||||
address: String,
|
||||
},
|
||||
/// Update membership info.
|
||||
UpdateMembership {
|
||||
address: String,
|
||||
name: Option<String>,
|
||||
digest: Option<bool>,
|
||||
hide_address: Option<bool>,
|
||||
receive_duplicates: Option<bool>,
|
||||
receive_own_posts: Option<bool>,
|
||||
receive_confirmation: Option<bool>,
|
||||
enabled: Option<bool>,
|
||||
},
|
||||
/// Alias for update-membership --enabled true
|
||||
EnableMembership { address: String },
|
||||
/// Alias for update-membership --enabled false
|
||||
DisableMembership { address: String },
|
||||
/// Update mailing list details.
|
||||
Update {
|
||||
name: Option<String>,
|
||||
id: Option<String>,
|
||||
address: Option<String>,
|
||||
description: Option<String>,
|
||||
archive_url: Option<String>,
|
||||
},
|
||||
/// Show mailing list health status.
|
||||
Health,
|
||||
/// Show mailing list info.
|
||||
Info,
|
||||
}
|
||||
|
||||
fn run_app(opt: Opt) -> Result<()> {
|
||||
if opt.debug {
|
||||
println!("DEBUG: {:?}", &opt);
|
||||
}
|
||||
Configuration::init()?;
|
||||
use Command::*;
|
||||
match opt.cmd {
|
||||
DbLocation => {
|
||||
println!("{}", Database::db_path()?.display());
|
||||
}
|
||||
DumpDatabase => {
|
||||
let db = Database::open_or_create_db()?;
|
||||
let lists = db.list_lists()?;
|
||||
let mut stdout = std::io::stdout();
|
||||
serde_json::to_writer_pretty(&mut stdout, &lists)?;
|
||||
for l in &lists {
|
||||
serde_json::to_writer_pretty(&mut stdout, &db.list_members(l.pk)?)?;
|
||||
}
|
||||
}
|
||||
ListLists => {
|
||||
let db = Database::open_or_create_db()?;
|
||||
let lists = db.list_lists()?;
|
||||
if lists.is_empty() {
|
||||
println!("No lists found.");
|
||||
} else {
|
||||
for l in lists {
|
||||
println!("- {} {:?}", l.id, l);
|
||||
let list_owners = db.get_list_owners(l.pk)?;
|
||||
if list_owners.is_empty() {
|
||||
println!("\tList owners: None");
|
||||
} else {
|
||||
println!("\tList owners:");
|
||||
for o in list_owners {
|
||||
println!("\t- {}", o);
|
||||
}
|
||||
}
|
||||
if let Some(s) = db.get_list_policy(l.pk)? {
|
||||
println!("\tList policy: {}", s);
|
||||
} else {
|
||||
println!("\tList policy: None");
|
||||
}
|
||||
println!();
|
||||
}
|
||||
}
|
||||
}
|
||||
List { list_id, cmd } => {
|
||||
let db = Database::open_or_create_db()?;
|
||||
let mut lists = db.list_lists()?;
|
||||
let list = if let Some(pos) = lists.iter().position(|l| l.id == list_id) {
|
||||
lists.remove(pos)
|
||||
} else {
|
||||
return Err(format!("No list with id {} was found", list_id).into());
|
||||
};
|
||||
use ListCommand::*;
|
||||
match cmd {
|
||||
Members => {
|
||||
let members = db.list_members(list.pk)?;
|
||||
if members.is_empty() {
|
||||
println!("No members found.");
|
||||
} else {
|
||||
println!("Members of list {}", list.id);
|
||||
for l in members {
|
||||
println!("- {}", &l);
|
||||
}
|
||||
}
|
||||
}
|
||||
AddMember {
|
||||
address,
|
||||
name,
|
||||
digest,
|
||||
hide_address,
|
||||
receive_confirmation,
|
||||
receive_duplicates,
|
||||
receive_own_posts,
|
||||
enabled,
|
||||
} => {
|
||||
db.add_member(
|
||||
list.pk,
|
||||
ListMembership {
|
||||
pk: 0,
|
||||
list: list.pk,
|
||||
name,
|
||||
address,
|
||||
digest,
|
||||
hide_address,
|
||||
receive_confirmation: receive_confirmation.unwrap_or(true),
|
||||
receive_duplicates: receive_duplicates.unwrap_or(true),
|
||||
receive_own_posts: receive_own_posts.unwrap_or(false),
|
||||
enabled: enabled.unwrap_or(true),
|
||||
},
|
||||
)?;
|
||||
}
|
||||
RemoveMember { address } => {
|
||||
loop {
|
||||
println!(
|
||||
"Are you sure you want to remove membership of {} from list {}? [Yy/n]",
|
||||
address, list
|
||||
);
|
||||
let mut input = String::new();
|
||||
std::io::stdin().read_line(&mut input)?;
|
||||
if input.trim() == "Y" || input.trim() == "y" || input.trim() == "" {
|
||||
break;
|
||||
} else if input.trim() == "n" {
|
||||
return Ok(());
|
||||
}
|
||||
}
|
||||
|
||||
db.remove_member(list.pk, &address)?;
|
||||
}
|
||||
Health => {
|
||||
println!("{} health:", list);
|
||||
let list_owners = db.get_list_owners(list.pk)?;
|
||||
let list_policy = db.get_list_policy(list.pk)?;
|
||||
if list_owners.is_empty() {
|
||||
println!("\tList has no owners: you should add at least one.");
|
||||
}
|
||||
if list_policy.is_none() {
|
||||
} else {
|
||||
println!("\tList has no post policy: you should add one.");
|
||||
}
|
||||
}
|
||||
Info => {
|
||||
println!("{} info:", list);
|
||||
let list_owners = db.get_list_owners(list.pk)?;
|
||||
let list_policy = db.get_list_policy(list.pk)?;
|
||||
let members = db.list_members(list.pk)?;
|
||||
if members.is_empty() {
|
||||
println!("No members.");
|
||||
} else if members.len() == 1 {
|
||||
println!("1 member.");
|
||||
} else {
|
||||
println!("{} members.", members.len());
|
||||
}
|
||||
if list_owners.is_empty() {
|
||||
println!("List owners: None");
|
||||
} else {
|
||||
println!("List owners:");
|
||||
for o in list_owners {
|
||||
println!("\t- {}", o);
|
||||
}
|
||||
}
|
||||
if let Some(s) = list_policy {
|
||||
println!("List policy: {}", s);
|
||||
} else {
|
||||
println!("List policy: None");
|
||||
}
|
||||
}
|
||||
UpdateMembership {
|
||||
address,
|
||||
name,
|
||||
digest,
|
||||
hide_address,
|
||||
receive_duplicates,
|
||||
receive_own_posts,
|
||||
receive_confirmation,
|
||||
enabled,
|
||||
} => {
|
||||
let name = if name
|
||||
.as_ref()
|
||||
.map(|s: &String| s.is_empty())
|
||||
.unwrap_or(false)
|
||||
{
|
||||
None
|
||||
} else {
|
||||
Some(name)
|
||||
};
|
||||
let changeset = ListMembershipChangeset {
|
||||
list: list.pk,
|
||||
address,
|
||||
name,
|
||||
digest,
|
||||
hide_address,
|
||||
receive_duplicates,
|
||||
receive_own_posts,
|
||||
receive_confirmation,
|
||||
enabled,
|
||||
};
|
||||
db.update_member(changeset)?;
|
||||
}
|
||||
EnableMembership { address } => {
|
||||
let changeset = ListMembershipChangeset {
|
||||
list: list.pk,
|
||||
address,
|
||||
name: None,
|
||||
digest: None,
|
||||
hide_address: None,
|
||||
receive_duplicates: None,
|
||||
receive_own_posts: None,
|
||||
receive_confirmation: None,
|
||||
enabled: Some(true),
|
||||
};
|
||||
db.update_member(changeset)?;
|
||||
}
|
||||
DisableMembership { address } => {
|
||||
let changeset = ListMembershipChangeset {
|
||||
list: list.pk,
|
||||
address,
|
||||
name: None,
|
||||
digest: None,
|
||||
hide_address: None,
|
||||
receive_duplicates: None,
|
||||
receive_own_posts: None,
|
||||
receive_confirmation: None,
|
||||
enabled: Some(false),
|
||||
};
|
||||
db.update_member(changeset)?;
|
||||
}
|
||||
Update {
|
||||
name,
|
||||
id,
|
||||
address,
|
||||
description,
|
||||
archive_url,
|
||||
} => {
|
||||
let description = if description
|
||||
.as_ref()
|
||||
.map(|s: &String| s.is_empty())
|
||||
.unwrap_or(false)
|
||||
{
|
||||
None
|
||||
} else {
|
||||
Some(description)
|
||||
};
|
||||
let archive_url = if archive_url
|
||||
.as_ref()
|
||||
.map(|s: &String| s.is_empty())
|
||||
.unwrap_or(false)
|
||||
{
|
||||
None
|
||||
} else {
|
||||
Some(archive_url)
|
||||
};
|
||||
let changeset = MailingListChangeset {
|
||||
pk: list.pk,
|
||||
name,
|
||||
id,
|
||||
address,
|
||||
description,
|
||||
archive_url,
|
||||
};
|
||||
db.update_list(changeset)?;
|
||||
}
|
||||
}
|
||||
}
|
||||
CreateList {
|
||||
name,
|
||||
id,
|
||||
address,
|
||||
description,
|
||||
archive_url,
|
||||
} => {
|
||||
let db = Database::open_or_create_db()?;
|
||||
db.create_list(MailingList {
|
||||
pk: 0,
|
||||
name,
|
||||
id,
|
||||
description,
|
||||
address,
|
||||
archive_url,
|
||||
})?;
|
||||
}
|
||||
Post { dry_run } => {
|
||||
if opt.debug {
|
||||
println!("post dry_run{:?}", dry_run);
|
||||
}
|
||||
|
||||
use melib::Envelope;
|
||||
use std::io::Read;
|
||||
|
||||
let mut input = String::new();
|
||||
std::io::stdin().read_to_string(&mut input)?;
|
||||
match Envelope::from_bytes(input.as_bytes(), None) {
|
||||
Ok(env) => {
|
||||
let db = Database::open_or_create_db()?;
|
||||
db.post(env, input.as_bytes(), dry_run)?;
|
||||
}
|
||||
Err(err) => {
|
||||
eprintln!("Could not parse message: {}", err);
|
||||
let p = Configuration::save_message(input)?;
|
||||
eprintln!("Message saved at {}", p.display());
|
||||
return Err(err.into());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn main() -> std::result::Result<(), i32> {
|
||||
let opt = Opt::from_args();
|
||||
stderrlog::new()
|
||||
.module(module_path!())
|
||||
.module("mailpot")
|
||||
.quiet(opt.quiet)
|
||||
.verbosity(opt.verbose)
|
||||
.timestamp(opt.ts.unwrap_or(stderrlog::Timestamp::Off))
|
||||
.init()
|
||||
.unwrap();
|
||||
if let Err(err) = run_app(opt) {
|
||||
println!("{}", err);
|
||||
std::process::exit(-1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
@ -0,0 +1,23 @@
|
||||
[package]
|
||||
name = "mailpot"
|
||||
version = "0.1.0"
|
||||
authors = ["Manos Pitsidianakis <el13635@mail.ntua.gr>"]
|
||||
edition = "2018"
|
||||
license = "LICENSE"
|
||||
readme = "README.md"
|
||||
description = "mailing list manager"
|
||||
repository = "https://github.com/meli/mailpot"
|
||||
keywords = ["mail", "mailing-lists" ]
|
||||
categories = ["email"]
|
||||
|
||||
[dependencies]
|
||||
chrono = { version = "^0.4", features = ["serde", ] }
|
||||
error-chain = "0.12.4"
|
||||
#melib = { version = "*", default-features = false, features = ["smtp", "unicode_algorithms"], path="../../meli/melib", branch = "master" }
|
||||
melib = { version = "*", default-features = false, features = ["smtp", "unicode_algorithms"], git="https://github.com/meli/meli", branch = "master" }
|
||||
rusqlite = {version = "^0.27" }
|
||||
serde = { version = "^1", features = ["derive", ]}
|
||||
serde_json = "^1"
|
||||
toml = "^0.5"
|
||||
log = "0.4"
|
||||
xdg = "2.1.0"
|
@ -0,0 +1,7 @@
|
||||
# mailpot-core
|
||||
|
||||
Initialize `sqlite3` database
|
||||
|
||||
```shell
|
||||
sqlite3 mpot.db < ./src/schema.sql
|
||||
```
|
@ -0,0 +1,32 @@
|
||||
/*
|
||||
* This file is part of mailpot
|
||||
*
|
||||
* Copyright 2020 - Manos Pitsidianakis
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
use std::io::Write;
|
||||
use std::process::Command;
|
||||
|
||||
fn main() {
|
||||
println!("cargo:rerun-if-changed=src/schema.sql.m4");
|
||||
|
||||
let output = Command::new("m4")
|
||||
.arg("./src/schema.sql.m4")
|
||||
.output()
|
||||
.unwrap();
|
||||
let mut file = std::fs::File::create("./src/schema.sql").unwrap();
|
||||
file.write_all(&output.stdout).unwrap();
|
||||
}
|
@ -0,0 +1,109 @@
|
||||
/*
|
||||
* This file is part of mailpot
|
||||
*
|
||||
* Copyright 2020 - Manos Pitsidianakis
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
use super::errors::*;
|
||||
use chrono::prelude::*;
|
||||
use std::cell::RefCell;
|
||||
use std::io::{Read, Write};
|
||||
use std::os::unix::fs::PermissionsExt;
|
||||
use std::path::PathBuf;
|
||||
|
||||
thread_local!(pub static CONFIG: RefCell<Configuration> = RefCell::new(Configuration::new()));
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Clone)]
|
||||
#[serde(tag = "type", content = "value")]
|
||||
pub enum SendMail {
|
||||
Smtp(melib::smtp::SmtpServerConf),
|
||||
ShellCommand(String),
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Clone)]
|
||||
pub struct Configuration {
|
||||
pub send_mail: SendMail,
|
||||
#[serde(default = "default_storage_fn")]
|
||||
pub storage: String,
|
||||
}
|
||||
|
||||
impl Configuration {
|
||||
pub(crate) fn new() -> Self {
|
||||
Configuration {
|
||||
send_mail: SendMail::ShellCommand(String::new()),
|
||||
storage: "sqlite3".into(),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn init() -> Result<()> {
|
||||
let path =
|
||||
xdg::BaseDirectories::with_prefix("mailpot")?.place_config_file("config.toml")?;
|
||||
if !path.exists() {
|
||||
return Err(format!("Configuration file {} doesn't exist", path.display()).into());
|
||||
}
|
||||
let mut s = String::new();
|
||||
let mut file = std::fs::File::open(&path)?;
|
||||
file.read_to_string(&mut s)?;
|
||||
let config: Configuration = toml::from_str(&s)?;
|
||||
CONFIG.with(|f| {
|
||||
*f.borrow_mut() = config;
|
||||
});
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn data_directory() -> Result<PathBuf> {
|
||||
Ok(xdg::BaseDirectories::with_prefix("mailpot")?.get_data_home())
|
||||
}
|
||||
|
||||
pub fn save_message_to_path(msg: &str, mut path: PathBuf) -> Result<PathBuf> {
|
||||
let now = Local::now().timestamp();
|
||||
path.push(format!("{}-failed.eml", now));
|
||||
|
||||
let mut file = std::fs::File::create(&path)?;
|
||||
let metadata = file.metadata()?;
|
||||
let mut permissions = metadata.permissions();
|
||||
|
||||
permissions.set_mode(0o600); // Read/write for owner only.
|
||||
file.set_permissions(permissions)?;
|
||||
file.write_all(msg.as_bytes())?;
|
||||
file.flush()?;
|
||||
Ok(path)
|
||||
}
|
||||
|
||||
pub fn save_message(msg: String) -> Result<PathBuf> {
|
||||
match Configuration::data_directory()
|
||||
.and_then(|path| Self::save_message_to_path(&msg, path))
|
||||
{
|
||||
Ok(p) => return Ok(p),
|
||||
Err(err) => {
|
||||
eprintln!("{}", err);
|
||||
}
|
||||
};
|
||||
match Self::save_message_to_path(&msg, PathBuf::from(".")) {
|
||||
Ok(p) => return Ok(p),
|
||||
Err(err) => {
|
||||
eprintln!("{}", err);
|
||||
}
|
||||
}
|
||||
let temp_path = std::env::temp_dir();
|
||||
Self::save_message_to_path(&msg, temp_path)
|
||||
}
|
||||
}
|
||||
|
||||
fn default_storage_fn() -> String {
|
||||
"sqlite3".to_string()
|
||||
}
|
@ -0,0 +1,604 @@
|
||||
/*
|
||||
* This file is part of mailpot
|
||||
*
|
||||
* Copyright 2020 - Manos Pitsidianakis
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
use super::*;
|
||||
use melib::Envelope;
|
||||
use models::changesets::*;
|
||||
use rusqlite::Connection as DbConnection;
|
||||
use rusqlite::OptionalExtension;
|
||||
use std::path::PathBuf;
|
||||
|
||||
const DB_NAME: &str = "mpot.db";
|
||||
|
||||
pub struct Database {
|
||||
pub connection: DbConnection,
|
||||
}
|
||||
|
||||
impl Database {
|
||||
pub fn list_lists(&self) -> Result<Vec<DbVal<MailingList>>> {
|
||||
let mut stmt = self.connection.prepare("SELECT * FROM mailing_lists;")?;
|
||||
let list_iter = stmt.query_map([], |row| {
|
||||
let pk = row.get("pk")?;
|
||||
Ok(DbVal(
|
||||
MailingList {
|
||||
pk,
|
||||
name: row.get("name")?,
|
||||
id: row.get("id")?,
|
||||
address: row.get("address")?,
|
||||
description: row.get("description")?,
|
||||
archive_url: row.get("archive_url")?,
|
||||
},
|
||||
pk,
|
||||
))
|
||||
})?;
|
||||
|
||||
let mut ret = vec![];
|
||||
for list in list_iter {
|
||||
let list = list?;
|
||||
ret.push(list);
|
||||
}
|
||||
Ok(ret)
|
||||
}
|
||||
|
||||
pub fn get_list(&self, pk: i64) -> Result<Option<DbVal<MailingList>>> {
|
||||
let mut stmt = self
|
||||
.connection
|
||||
.prepare("SELECT * FROM mailing_lists WHERE pk = ?;")?;
|
||||
let ret = stmt
|
||||
.query_row([&pk], |row| |