v2.0.0
This commit is contained in:
parent
c98dcb7b50
commit
be6f679724
19 changed files with 13721 additions and 5952 deletions
674
LICENSE
Normal file
674
LICENSE
Normal file
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
|
@ -1,8 +1,20 @@
|
|||
= 1.2.0 =
|
||||
= 2.0.0 =
|
||||
|
||||
* Logged failed email deliveries with status and error details in the log list and detail views.
|
||||
* Captured the SMTP debug conversation for each email and surfaced it inside the log detail view.
|
||||
* Fixed fatal errors in the SMTP bootstrap by restoring configuration and log cleanup hooks.
|
||||
* Comprehensive security audit and hardening.
|
||||
* Enhanced nonce validation across all forms and actions.
|
||||
* Improved input sanitization and validation.
|
||||
* Enhanced password encryption and migration system.
|
||||
* Secure handling of superglobals and transients.
|
||||
* Strengthened regex patterns and port number validation.
|
||||
* Fixed potential security vulnerabilities in form handling.
|
||||
* Added Reply-To email and name configuration fields for custom reply addresses.
|
||||
* Added email statistics tracking system with daily counters and visual charts.
|
||||
* Added statistics page with Chart.js visualization and multisite support.
|
||||
* Added statistics retention settings (configurable from 1 to 365 days).
|
||||
* Access control and form handling improvements.
|
||||
* WordPress Multisite rate limiting enhancements.
|
||||
* Empty password field handling.
|
||||
* Code quality improvements throughout the plugin.
|
||||
|
||||
= 1.1.0 =
|
||||
|
||||
|
|
|
|||
|
|
@ -7,6 +7,9 @@
|
|||
|
||||
namespace Robotstxt_SMTP;
|
||||
|
||||
// Security check.
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
use PHPMailer\PHPMailer\PHPMailer;
|
||||
use PHPMailer\PHPMailer\SMTP;
|
||||
use Robotstxt_SMTP\Admin\Settings_Page;
|
||||
|
|
@ -16,16 +19,32 @@ use WP_Error;
|
|||
* Main plugin class.
|
||||
*/
|
||||
class Plugin {
|
||||
/**
|
||||
* Custom post type used to store email logs.
|
||||
*/
|
||||
/**
|
||||
* Custom post type used to store email logs.
|
||||
*/
|
||||
private const LOG_POST_TYPE = 'robotstxt_smtp_log';
|
||||
|
||||
/**
|
||||
* Cron hook used to trigger the log cleanup.
|
||||
*/
|
||||
/**
|
||||
* Retrieves the custom post type identifier used for SMTP logs.
|
||||
*
|
||||
* @since 1.1.1
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_log_post_type(): string {
|
||||
return self::LOG_POST_TYPE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Cron hook used to trigger the log cleanup.
|
||||
*/
|
||||
private const CRON_HOOK = 'robotstxt_smtp_cleanup_logs';
|
||||
|
||||
/**
|
||||
* Cron hook used to trigger statistics cleanup.
|
||||
*/
|
||||
private const STATS_CRON_HOOK = 'robotstxt_smtp_cleanup_stats';
|
||||
|
||||
/**
|
||||
* Holds the class instance.
|
||||
*
|
||||
|
|
@ -47,6 +66,17 @@ class Plugin {
|
|||
*/
|
||||
private array $current_debug_log = array();
|
||||
|
||||
/**
|
||||
* Holds rate limit error if checking failed.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @var WP_Error|null
|
||||
*/
|
||||
private ?WP_Error $rate_limit_error = null;
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Retrieves the plugin instance.
|
||||
*
|
||||
|
|
@ -83,16 +113,28 @@ class Plugin {
|
|||
*/
|
||||
public function run(): void {
|
||||
add_action( 'phpmailer_init', array( $this, 'configure_phpmailer' ) );
|
||||
add_filter( 'pre_wp_mail', array( $this, 'pre_wp_mail_rate_limit_check' ), 1 );
|
||||
add_action( 'phpmailer_init', array( $this, 'enforce_rate_limit_in_phpmailer' ), 5 );
|
||||
add_filter( 'wp_mail_from', array( $this, 'filter_mail_from' ) );
|
||||
add_filter( 'wp_mail_from_name', array( $this, 'filter_mail_from_name' ) );
|
||||
add_action( 'phpmailer_init', array( $this, 'configure_reply_to' ), 20 );
|
||||
|
||||
add_action( 'init', array( $this, 'register_log_post_type' ) );
|
||||
add_action( 'init', array( $this, 'maybe_schedule_cleanup' ) );
|
||||
add_action( 'init', array( $this, 'maybe_schedule_stats_cleanup' ) );
|
||||
add_action( 'wp_mail_succeeded', array( $this, 'handle_wp_mail_succeeded' ) );
|
||||
add_action( 'wp_mail_failed', array( $this, 'handle_wp_mail_failed' ) );
|
||||
add_action( self::CRON_HOOK, array( $this, 'cleanup_logs' ) );
|
||||
add_action( self::STATS_CRON_HOOK, array( $this, 'cleanup_stats' ) );
|
||||
|
||||
// Initialize statistics table.
|
||||
Statistics::get_instance();
|
||||
|
||||
if ( is_admin() ) {
|
||||
add_action( 'admin_init', array( $this, 'migrate_plaintext_credentials' ) );
|
||||
add_action( 'admin_init', array( $this, 'handle_encryption_notice_dismissal' ) );
|
||||
add_action( 'admin_notices', array( $this, 'display_encryption_unavailable_notice' ) );
|
||||
add_action( 'network_admin_notices', array( $this, 'display_encryption_unavailable_notice' ) );
|
||||
$this->register_admin();
|
||||
}
|
||||
}
|
||||
|
|
@ -119,7 +161,7 @@ class Plugin {
|
|||
register_post_type(
|
||||
self::LOG_POST_TYPE,
|
||||
array(
|
||||
'labels' => array(
|
||||
'labels' => array(
|
||||
'name' => esc_html__( 'SMTP Logs', 'robotstxt-smtp' ),
|
||||
'singular_name' => esc_html__( 'SMTP Log', 'robotstxt-smtp' ),
|
||||
),
|
||||
|
|
@ -154,6 +196,17 @@ class Plugin {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Schedules the automatic statistics cleanup task.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function maybe_schedule_stats_cleanup(): void {
|
||||
if ( false === wp_next_scheduled( self::STATS_CRON_HOOK ) ) {
|
||||
wp_schedule_event( time() + HOUR_IN_SECONDS, 'daily', self::STATS_CRON_HOOK );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters the "From" email address used by WordPress.
|
||||
*
|
||||
|
|
@ -190,6 +243,43 @@ class Plugin {
|
|||
return $from_name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures Reply-To header if configured and not already set.
|
||||
*
|
||||
* This method runs with priority 20 on phpmailer_init to allow
|
||||
* WordPress and other plugins to set Reply-To first. If no Reply-To
|
||||
* exists and the settings include reply_to_email, it will be added.
|
||||
*
|
||||
* @param PHPMailer $phpmailer Mailer instance.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function configure_reply_to( PHPMailer $phpmailer ): void {
|
||||
$settings = $this->get_mailer_settings();
|
||||
|
||||
// Check if reply-to email is configured.
|
||||
$reply_to_email = isset( $settings['reply_to_email'] ) ? sanitize_email( $settings['reply_to_email'] ) : '';
|
||||
|
||||
// If no reply-to email configured, nothing to do.
|
||||
if ( empty( $reply_to_email ) || ! is_email( $reply_to_email ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Check if Reply-To header already exists.
|
||||
// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
|
||||
if ( ! empty( $phpmailer->getReplyToAddresses() ) ) {
|
||||
// Reply-To already set by wp_mail() or another plugin, don't override.
|
||||
return;
|
||||
}
|
||||
|
||||
// Get reply-to name (optional).
|
||||
$reply_to_name = isset( $settings['reply_to_name'] ) ? sanitize_text_field( $settings['reply_to_name'] ) : '';
|
||||
|
||||
// Add the Reply-To header.
|
||||
// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
|
||||
$phpmailer->addReplyTo( $reply_to_email, $reply_to_name );
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the stored mailer settings merged with defaults.
|
||||
*
|
||||
|
|
@ -210,6 +300,22 @@ class Plugin {
|
|||
|
||||
$settings = wp_parse_args( $settings, $defaults );
|
||||
|
||||
$settings['password'] = \Robotstxt_SMTP_Encryption::decrypt( $settings['password'] ?? '' );
|
||||
$settings['amazon_ses_access_key'] = \Robotstxt_SMTP_Encryption::decrypt( $settings['amazon_ses_access_key'] ?? '' );
|
||||
$settings['amazon_ses_secret_key'] = \Robotstxt_SMTP_Encryption::decrypt( $settings['amazon_ses_secret_key'] ?? '' );
|
||||
|
||||
if ( ! is_string( $settings['password'] ) ) {
|
||||
$settings['password'] = '';
|
||||
}
|
||||
|
||||
if ( ! is_string( $settings['amazon_ses_access_key'] ) ) {
|
||||
$settings['amazon_ses_access_key'] = '';
|
||||
}
|
||||
|
||||
if ( ! is_string( $settings['amazon_ses_secret_key'] ) ) {
|
||||
$settings['amazon_ses_secret_key'] = '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters the SMTP settings before they are consumed by the mailer.
|
||||
*
|
||||
|
|
@ -220,6 +326,230 @@ class Plugin {
|
|||
return (array) \apply_filters( 'robotstxt_smtp_mailer_settings', $settings );
|
||||
}
|
||||
|
||||
/**
|
||||
* Automatically migrates plaintext credentials to encrypted format.
|
||||
*
|
||||
* This method runs once during admin_init to detect and encrypt any
|
||||
* credentials that were stored in plaintext (from pre-1.2.1 installations).
|
||||
* Uses a transient to prevent repeated checks after migration is complete.
|
||||
*
|
||||
* @since 1.2.2
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function migrate_plaintext_credentials(): void {
|
||||
// Check if migration has already been completed.
|
||||
$migration_check_key = 'robotstxt_smtp_credentials_migration_checked';
|
||||
if ( get_transient( $migration_check_key ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Check if encryption is available.
|
||||
if ( ! \Robotstxt_SMTP_Encryption::is_encryption_available() ) {
|
||||
// Set transient to retry in 1 hour if encryption becomes available.
|
||||
set_transient( $migration_check_key, true, HOUR_IN_SECONDS );
|
||||
return;
|
||||
}
|
||||
|
||||
$needs_migration = false;
|
||||
$is_network_mode = Settings_Page::is_network_mode_enabled();
|
||||
|
||||
// Load raw settings without decryption.
|
||||
if ( $is_network_mode ) {
|
||||
$settings = get_site_option( Settings_Page::NETWORK_OPTION_NAME, array() );
|
||||
} else {
|
||||
$settings = get_option( Settings_Page::OPTION_NAME, array() );
|
||||
}
|
||||
|
||||
if ( ! is_array( $settings ) ) {
|
||||
$settings = array();
|
||||
}
|
||||
|
||||
// Check each credential field for plaintext values.
|
||||
$credential_fields = array( 'password', 'amazon_ses_access_key', 'amazon_ses_secret_key' );
|
||||
|
||||
foreach ( $credential_fields as $field ) {
|
||||
if ( ! isset( $settings[ $field ] ) || '' === $settings[ $field ] ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// If the value is not encrypted and not empty, it needs migration.
|
||||
if ( ! \Robotstxt_SMTP_Encryption::is_encrypted( $settings[ $field ] ) ) {
|
||||
$needs_migration = true;
|
||||
$settings[ $field ] = \Robotstxt_SMTP_Encryption::encrypt( $settings[ $field ] );
|
||||
}
|
||||
}
|
||||
|
||||
// Save migrated credentials if any were found.
|
||||
if ( $needs_migration ) {
|
||||
if ( $is_network_mode ) {
|
||||
update_site_option( Settings_Page::NETWORK_OPTION_NAME, $settings );
|
||||
} else {
|
||||
update_option( Settings_Page::OPTION_NAME, $settings );
|
||||
}
|
||||
}
|
||||
|
||||
// Set transient to prevent future checks (valid for 30 days).
|
||||
// After 30 days, it will check again in case new plaintext credentials were added.
|
||||
set_transient( $migration_check_key, true, 30 * DAY_IN_SECONDS );
|
||||
}
|
||||
|
||||
/**
|
||||
* Displays an admin notice when encryption is unavailable.
|
||||
*
|
||||
* Shows a warning in the WordPress admin when encryption cannot be enabled,
|
||||
* explaining what's missing and how to fix it. Only displays on plugin settings
|
||||
* pages and can be dismissed for 7 days.
|
||||
*
|
||||
* @since 1.2.2
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function display_encryption_unavailable_notice(): void {
|
||||
// Only show on plugin settings pages.
|
||||
$screen = get_current_screen();
|
||||
if ( null === $screen || false === strpos( $screen->id, 'robotstxt-smtp' ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Check if encryption is available.
|
||||
if ( \Robotstxt_SMTP_Encryption::is_encryption_available() ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Check if notice has been dismissed.
|
||||
$dismissed_key = 'robotstxt_smtp_encryption_notice_dismissed';
|
||||
if ( get_transient( $dismissed_key ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Check if there are any stored credentials that need encryption.
|
||||
$is_network_mode = Settings_Page::is_network_mode_enabled();
|
||||
if ( $is_network_mode ) {
|
||||
$settings = get_site_option( Settings_Page::NETWORK_OPTION_NAME, array() );
|
||||
} else {
|
||||
$settings = get_option( Settings_Page::OPTION_NAME, array() );
|
||||
}
|
||||
|
||||
if ( ! is_array( $settings ) ) {
|
||||
$settings = array();
|
||||
}
|
||||
|
||||
// Check if there are any credentials stored.
|
||||
$has_credentials = false;
|
||||
$credential_fields = array( 'password', 'amazon_ses_access_key', 'amazon_ses_secret_key' );
|
||||
foreach ( $credential_fields as $field ) {
|
||||
if ( ! empty( $settings[ $field ] ) ) {
|
||||
$has_credentials = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Only show notice if there are credentials to protect.
|
||||
if ( ! $has_credentials ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Determine what's missing.
|
||||
$missing_requirements = array();
|
||||
|
||||
if ( ! extension_loaded( 'openssl' ) ) {
|
||||
$missing_requirements[] = __( 'OpenSSL PHP extension is not loaded', 'robotstxt-smtp' );
|
||||
} elseif ( ! in_array( 'aes-256-gcm', openssl_get_cipher_methods(), true ) ) {
|
||||
$missing_requirements[] = __( 'AES-256-GCM cipher is not supported by OpenSSL', 'robotstxt-smtp' );
|
||||
}
|
||||
|
||||
if ( ! defined( 'AUTH_KEY' ) || '' === AUTH_KEY ) {
|
||||
$missing_requirements[] = __( 'AUTH_KEY is not defined in wp-config.php', 'robotstxt-smtp' );
|
||||
}
|
||||
|
||||
if ( ! defined( 'AUTH_SALT' ) || '' === AUTH_SALT ) {
|
||||
$missing_requirements[] = __( 'AUTH_SALT is not defined in wp-config.php', 'robotstxt-smtp' );
|
||||
}
|
||||
|
||||
if ( empty( $missing_requirements ) ) {
|
||||
// Encryption should be available but check failed - don't show notice.
|
||||
return;
|
||||
}
|
||||
|
||||
// Generate dismiss URL.
|
||||
$dismiss_url = add_query_arg(
|
||||
array(
|
||||
'robotstxt_smtp_dismiss_encryption_notice' => '1',
|
||||
'_wpnonce' => wp_create_nonce( 'robotstxt_smtp_dismiss_encryption_notice' ),
|
||||
)
|
||||
);
|
||||
|
||||
?>
|
||||
<div class="notice notice-warning is-dismissible">
|
||||
<p>
|
||||
<strong><?php esc_html_e( 'ROBOTSTXT SMTP: Credential Encryption Unavailable', 'robotstxt-smtp' ); ?></strong>
|
||||
</p>
|
||||
<p>
|
||||
<?php esc_html_e( 'Your SMTP credentials are currently stored without encryption because the following requirements are not met:', 'robotstxt-smtp' ); ?>
|
||||
</p>
|
||||
<ul style="list-style: disc; margin-left: 20px;">
|
||||
<?php foreach ( $missing_requirements as $requirement ) : ?>
|
||||
<li><?php echo esc_html( $requirement ); ?></li>
|
||||
<?php endforeach; ?>
|
||||
</ul>
|
||||
<p>
|
||||
<?php
|
||||
printf(
|
||||
/* translators: %s: Link to WordPress security keys documentation */
|
||||
esc_html__( 'To enable credential encryption, please ensure OpenSSL is installed and %s are defined in your wp-config.php file.', 'robotstxt-smtp' ),
|
||||
'<a href="https://api.wordpress.org/secret-key/1.1/salt/" target="_blank" rel="noopener noreferrer">' . esc_html__( 'WordPress authentication keys', 'robotstxt-smtp' ) . '</a>'
|
||||
);
|
||||
?>
|
||||
</p>
|
||||
<p>
|
||||
<a href="<?php echo esc_url( $dismiss_url ); ?>" class="button button-secondary">
|
||||
<?php esc_html_e( 'Dismiss for 7 days', 'robotstxt-smtp' ); ?>
|
||||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<?php
|
||||
}
|
||||
|
||||
/**
|
||||
* Handles dismissal of the encryption unavailable notice.
|
||||
*
|
||||
* Sets a transient when the user clicks "Dismiss for 7 days" to prevent
|
||||
* the notice from showing again for the specified period.
|
||||
*
|
||||
* @since 1.2.2
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function handle_encryption_notice_dismissal(): void {
|
||||
// Check if this is a dismissal request.
|
||||
$dismiss_action = filter_input( INPUT_GET, 'robotstxt_smtp_dismiss_encryption_notice', FILTER_UNSAFE_RAW );
|
||||
if ( '1' !== $dismiss_action ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Verify nonce.
|
||||
$nonce_raw = filter_input( INPUT_GET, '_wpnonce', FILTER_UNSAFE_RAW );
|
||||
$nonce = $nonce_raw ? sanitize_text_field( wp_unslash( $nonce_raw ) ) : '';
|
||||
|
||||
if ( ! wp_verify_nonce( $nonce, 'robotstxt_smtp_dismiss_encryption_notice' ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Check capability.
|
||||
if ( ! current_user_can( 'manage_options' ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Set transient to dismiss notice for 7 days.
|
||||
set_transient( 'robotstxt_smtp_encryption_notice_dismissed', true, 7 * DAY_IN_SECONDS );
|
||||
|
||||
// Redirect to clean URL.
|
||||
$redirect_url = remove_query_arg( array( 'robotstxt_smtp_dismiss_encryption_notice', '_wpnonce' ) );
|
||||
wp_safe_redirect( $redirect_url );
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures PHPMailer to use the stored SMTP settings.
|
||||
*
|
||||
|
|
@ -296,9 +626,15 @@ class Plugin {
|
|||
* @return void
|
||||
*/
|
||||
public function handle_wp_mail_succeeded( array $mail_data ): void {
|
||||
// Track email for statistics.
|
||||
Statistics::get_instance()->increment_today();
|
||||
|
||||
$logging = $this->get_logging_settings();
|
||||
|
||||
if ( ! $logging['enabled'] ) {
|
||||
// Track email for rate limiting.
|
||||
$this->track_email_sent();
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
|
|
@ -420,14 +756,80 @@ class Plugin {
|
|||
*
|
||||
* @return array<int, string>
|
||||
*/
|
||||
/**
|
||||
* Redacts sensitive authentication data from SMTP log messages.
|
||||
*
|
||||
* Removes or masks authentication credentials including:
|
||||
* - AUTH PLAIN/LOGIN commands with base64-encoded credentials
|
||||
* - Base64-encoded authentication responses
|
||||
* - Server authentication challenges
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @param string $message Log message from PHPMailer SMTP debug output.
|
||||
* @return string Sanitized message with credentials redacted.
|
||||
*/
|
||||
private function redact_smtp_credentials( string $message ): string {
|
||||
// Redact AUTH PLAIN command with base64 credentials.
|
||||
// Matches AUTH PLAIN anywhere in line, not just at start.
|
||||
$message = preg_replace(
|
||||
'/\bAUTH\s+PLAIN\s+[A-Za-z0-9+\/=]+/i',
|
||||
'AUTH PLAIN [REDACTED]',
|
||||
$message
|
||||
);
|
||||
|
||||
// Redact AUTH LOGIN command with base64 credentials.
|
||||
// Matches AUTH LOGIN anywhere in line.
|
||||
$message = preg_replace(
|
||||
'/\bAUTH\s+LOGIN\s+[A-Za-z0-9+\/=]+/i',
|
||||
'AUTH LOGIN [REDACTED]',
|
||||
$message
|
||||
);
|
||||
|
||||
// Redact other AUTH mechanisms with credentials.
|
||||
// Handles CRAM-MD5, DIGEST-MD5, XOAUTH2, NTLM, GSSAPI, EXTERNAL.
|
||||
$message = preg_replace(
|
||||
'/\bAUTH\s+(CRAM-MD5|DIGEST-MD5|XOAUTH2|NTLM|GSSAPI|EXTERNAL)\s+[A-Za-z0-9+\/=\-_\.]+/i',
|
||||
'AUTH ${1} [REDACTED]',
|
||||
$message
|
||||
);
|
||||
|
||||
// Redact base64 challenge-response (server sends 334 + base64).
|
||||
// The 334 code indicates server is awaiting authentication data.
|
||||
$message = preg_replace(
|
||||
'/\b334\s+[A-Za-z0-9+\/=]+/',
|
||||
'334 [CHALLENGE REDACTED]',
|
||||
$message
|
||||
);
|
||||
|
||||
// Redact standalone base64 strings (likely auth responses).
|
||||
// Matches lines that are predominantly base64 (20+ chars).
|
||||
// Preserves optional timestamp prefix [123] or similar.
|
||||
$message = preg_replace(
|
||||
'/^(\[\d+\]\s*)?([A-Za-z0-9+\/=]{20,})\s*$/mi',
|
||||
'${1}[CREDENTIAL REDACTED]',
|
||||
$message
|
||||
);
|
||||
|
||||
return $message;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanitizes and prepares debug log entries for storage or display.
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @return array Sanitized debug log entries with credentials redacted.
|
||||
*/
|
||||
private function get_sanitized_debug_log(): array {
|
||||
if ( empty( $this->current_debug_log ) ) {
|
||||
return array();
|
||||
}
|
||||
|
||||
$sanitized = array_map(
|
||||
static function ( $entry ): string {
|
||||
return sanitize_textarea_field( (string) $entry );
|
||||
function ( $entry ): string {
|
||||
$entry = sanitize_textarea_field( (string) $entry );
|
||||
return $this->redact_smtp_credentials( $entry );
|
||||
},
|
||||
$this->current_debug_log
|
||||
);
|
||||
|
|
@ -462,6 +864,22 @@ class Plugin {
|
|||
$this->cleanup_logs_by_days( $logging['days'] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs statistics cleanup when triggered by cron.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function cleanup_stats(): void {
|
||||
$settings = $this->get_mailer_settings();
|
||||
$days = isset( $settings['stats_retention_days'] ) ? absint( $settings['stats_retention_days'] ) : 28;
|
||||
|
||||
if ( $days <= 0 ) {
|
||||
return;
|
||||
}
|
||||
|
||||
Statistics::get_instance()->cleanup_old_stats( $days );
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes all stored logs.
|
||||
*
|
||||
|
|
@ -661,4 +1079,201 @@ class Plugin {
|
|||
'days' => isset( $settings['logs_retention_days'] ) ? (int) $settings['logs_retention_days'] : 0,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tracks that an email was sent for rate limiting purposes.
|
||||
*
|
||||
* Increments counters for per-second, per-hour, and per-day windows.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private function track_email_sent(): void {
|
||||
$scope = $this->settings_page ? $this->settings_page->get_scope() : Settings_Page::SCOPE_SITE;
|
||||
|
||||
$key_second = $this->get_rate_limit_transient_key( $scope, 'second' );
|
||||
$count = (int) ( Settings_Page::SCOPE_NETWORK === $scope ? get_site_transient( $key_second ) : get_transient( $key_second ) );
|
||||
++$count;
|
||||
if ( Settings_Page::SCOPE_NETWORK === $scope ) {
|
||||
set_site_transient( $key_second, $count, 1 );
|
||||
} else {
|
||||
set_transient( $key_second, $count, 1 );
|
||||
}
|
||||
|
||||
$key_hour = $this->get_rate_limit_transient_key( $scope, 'hour' );
|
||||
$count = (int) ( Settings_Page::SCOPE_NETWORK === $scope ? get_site_transient( $key_hour ) : get_transient( $key_hour ) );
|
||||
++$count;
|
||||
if ( Settings_Page::SCOPE_NETWORK === $scope ) {
|
||||
set_site_transient( $key_hour, $count, HOUR_IN_SECONDS );
|
||||
} else {
|
||||
set_transient( $key_hour, $count, HOUR_IN_SECONDS );
|
||||
}
|
||||
|
||||
$key_day = $this->get_rate_limit_transient_key( $scope, 'day' );
|
||||
$count = (int) ( Settings_Page::SCOPE_NETWORK === $scope ? get_site_transient( $key_day ) : get_transient( $key_day ) );
|
||||
++$count;
|
||||
if ( Settings_Page::SCOPE_NETWORK === $scope ) {
|
||||
set_site_transient( $key_day, $count, DAY_IN_SECONDS );
|
||||
} else {
|
||||
set_transient( $key_day, $count, DAY_IN_SECONDS );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if sending an email would exceed configured rate limits.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @return true|WP_Error True if sending is allowed, WP_Error if rate limit exceeded.
|
||||
*/
|
||||
private function check_rate_limit() {
|
||||
if ( ! $this->settings_page ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
$settings = $this->settings_page->get_settings();
|
||||
$scope = $this->settings_page->get_scope();
|
||||
|
||||
if ( isset( $settings['rate_limit_per_second'] ) && $settings['rate_limit_per_second'] > 0 ) {
|
||||
$key = $this->get_rate_limit_transient_key( $scope, 'second' );
|
||||
$count = (int) ( Settings_Page::SCOPE_NETWORK === $scope ? get_site_transient( $key ) : get_transient( $key ) );
|
||||
|
||||
if ( $count >= $settings['rate_limit_per_second'] ) {
|
||||
return new WP_Error(
|
||||
'rate_limit_exceeded_second',
|
||||
sprintf(
|
||||
/* translators: %d: rate limit per second */
|
||||
__( 'Rate limit exceeded: Maximum %d emails per second.', 'robotstxt-smtp' ),
|
||||
$settings['rate_limit_per_second']
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
if ( isset( $settings['rate_limit_per_hour'] ) && $settings['rate_limit_per_hour'] > 0 ) {
|
||||
$key = $this->get_rate_limit_transient_key( $scope, 'hour' );
|
||||
$count = (int) ( Settings_Page::SCOPE_NETWORK === $scope ? get_site_transient( $key ) : get_transient( $key ) );
|
||||
|
||||
if ( $count >= $settings['rate_limit_per_hour'] ) {
|
||||
return new WP_Error(
|
||||
'rate_limit_exceeded_hour',
|
||||
sprintf(
|
||||
/* translators: %d: rate limit per hour */
|
||||
__( 'Rate limit exceeded: Maximum %d emails per hour.', 'robotstxt-smtp' ),
|
||||
$settings['rate_limit_per_hour']
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
if ( isset( $settings['rate_limit_per_day'] ) && $settings['rate_limit_per_day'] > 0 ) {
|
||||
$key = $this->get_rate_limit_transient_key( $scope, 'day' );
|
||||
$count = (int) ( Settings_Page::SCOPE_NETWORK === $scope ? get_site_transient( $key ) : get_transient( $key ) );
|
||||
|
||||
if ( $count >= $settings['rate_limit_per_day'] ) {
|
||||
return new WP_Error(
|
||||
'rate_limit_exceeded_day',
|
||||
sprintf(
|
||||
/* translators: %d: rate limit per day */
|
||||
__( 'Rate limit exceeded: Maximum %d emails per 24 hours.', 'robotstxt-smtp' ),
|
||||
$settings['rate_limit_per_day']
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the transient key for rate limiting counters.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @param string $scope Scope identifier (network or site).
|
||||
* @param string $window Time window (second, hour, day).
|
||||
* @return string Transient key.
|
||||
*/
|
||||
private function get_rate_limit_transient_key( string $scope, string $window ): string {
|
||||
if ( Settings_Page::SCOPE_NETWORK === $scope ) {
|
||||
return "robotstxt_smtp_rate_limit_{$window}_network";
|
||||
}
|
||||
|
||||
return "robotstxt_smtp_rate_limit_{$window}_" . get_current_blog_id();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets current send counts for all time windows.
|
||||
*
|
||||
* Used for debugging and displaying current usage.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @return array<string, int> Current counts keyed by window (second, hour, day).
|
||||
*/
|
||||
public function get_current_send_counts(): array {
|
||||
if ( ! $this->settings_page ) {
|
||||
return array(
|
||||
'second' => 0,
|
||||
'hour' => 0,
|
||||
'day' => 0,
|
||||
);
|
||||
}
|
||||
|
||||
$scope = $this->settings_page->get_scope();
|
||||
|
||||
return array(
|
||||
'second' => (int) ( Settings_Page::SCOPE_NETWORK === $scope ? get_site_transient( $this->get_rate_limit_transient_key( $scope, 'second' ) ) : get_transient( $this->get_rate_limit_transient_key( $scope, 'second' ) ) ),
|
||||
'hour' => (int) ( Settings_Page::SCOPE_NETWORK === $scope ? get_site_transient( $this->get_rate_limit_transient_key( $scope, 'hour' ) ) : get_transient( $this->get_rate_limit_transient_key( $scope, 'hour' ) ) ),
|
||||
'day' => (int) ( Settings_Page::SCOPE_NETWORK === $scope ? get_site_transient( $this->get_rate_limit_transient_key( $scope, 'day' ) ) : get_transient( $this->get_rate_limit_transient_key( $scope, 'day' ) ) ),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks rate limits before sending an email.
|
||||
*
|
||||
* Hooks into 'pre_wp_mail' to prevent sending if rate limit is exceeded.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @param null|bool $return Short-circuit return value.
|
||||
* @return null|bool|WP_Error Null to continue, WP_Error if rate limit exceeded.
|
||||
*
|
||||
* @phpcs:disable WordPress.NamingConventions.ValidFunctionName.ParameterNameInvalid -- WordPress core filter uses $return parameter name.
|
||||
*/
|
||||
public function pre_wp_mail_rate_limit_check( $return ) {
|
||||
if ( null !== $return ) {
|
||||
return $return;
|
||||
}
|
||||
|
||||
$check = $this->check_rate_limit();
|
||||
|
||||
if ( is_wp_error( $check ) ) {
|
||||
$this->rate_limit_error = $check;
|
||||
}
|
||||
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforces rate limits in phpmailer_init if check failed earlier.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @param PHPMailer $phpmailer PHPMailer instance.
|
||||
* @return void
|
||||
* @throws \PHPMailer\PHPMailer\Exception If rate limit exceeded.
|
||||
*
|
||||
* @phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.Found -- Required by WordPress action hook signature.
|
||||
*/
|
||||
public function enforce_rate_limit_in_phpmailer( PHPMailer $phpmailer ): void {
|
||||
if ( isset( $this->rate_limit_error ) && is_wp_error( $this->rate_limit_error ) ) {
|
||||
$error = $this->rate_limit_error;
|
||||
unset( $this->rate_limit_error );
|
||||
|
||||
// phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped -- Exception message not output to browser.
|
||||
throw new \PHPMailer\PHPMailer\Exception( $error->get_error_message(), $error->get_error_code() );
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
222
includes/class-robotstxt-smtp-encryption.php
Normal file
222
includes/class-robotstxt-smtp-encryption.php
Normal file
|
|
@ -0,0 +1,222 @@
|
|||
<?php
|
||||
/**
|
||||
* Encryption utility for ROBOTSTXT SMTP plugin.
|
||||
*
|
||||
* Provides AES-256-GCM encryption for sensitive data using WordPress authentication salts.
|
||||
* Encryption keys are derived using PBKDF2 (10,000 iterations) for enhanced security.
|
||||
*
|
||||
* @package Robotstxt_SMTP
|
||||
* @since 1.2.1
|
||||
*/
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Class Robotstxt_SMTP_Encryption
|
||||
*
|
||||
* Handles encryption and decryption of sensitive credentials.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*/
|
||||
class Robotstxt_SMTP_Encryption {
|
||||
|
||||
/**
|
||||
* Encryption cipher method.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private const CIPHER = 'aes-256-gcm';
|
||||
|
||||
/**
|
||||
* Prefix for encrypted values to identify them.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private const PREFIX = 'enc:v1:';
|
||||
|
||||
/**
|
||||
* Encrypts a plaintext string using AES-256-GCM.
|
||||
*
|
||||
* Requires AUTH_KEY and AUTH_SALT to be defined in wp-config.php.
|
||||
* Returns the original plaintext if encryption is not available.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @param string $plaintext The plaintext to encrypt.
|
||||
* @return string Encrypted string with prefix, or original plaintext if encryption unavailable.
|
||||
*/
|
||||
public static function encrypt( string $plaintext ): string {
|
||||
// Return empty strings as-is.
|
||||
if ( '' === $plaintext ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
// Check if already encrypted.
|
||||
if ( self::is_encrypted( $plaintext ) ) {
|
||||
return $plaintext;
|
||||
}
|
||||
|
||||
// Check if encryption is available.
|
||||
if ( ! self::is_encryption_available() ) {
|
||||
return $plaintext;
|
||||
}
|
||||
|
||||
// Generate random IV (Initialization Vector).
|
||||
$iv_length = openssl_cipher_iv_length( self::CIPHER );
|
||||
$iv = openssl_random_pseudo_bytes( $iv_length );
|
||||
|
||||
// Derive encryption key from WordPress constants.
|
||||
$key = self::get_encryption_key();
|
||||
|
||||
// Encrypt the data.
|
||||
$tag = '';
|
||||
$ciphertext = openssl_encrypt(
|
||||
$plaintext,
|
||||
self::CIPHER,
|
||||
$key,
|
||||
OPENSSL_RAW_DATA,
|
||||
$iv,
|
||||
$tag,
|
||||
'',
|
||||
16
|
||||
);
|
||||
|
||||
if ( false === $ciphertext ) {
|
||||
// Encryption failed, return plaintext.
|
||||
return $plaintext;
|
||||
}
|
||||
|
||||
// Combine IV + ciphertext + tag and encode.
|
||||
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode -- Used for encryption, not obfuscation.
|
||||
$encrypted = base64_encode( $iv . $ciphertext . $tag );
|
||||
|
||||
return self::PREFIX . $encrypted;
|
||||
}
|
||||
|
||||
/**
|
||||
* Decrypts an encrypted string.
|
||||
*
|
||||
* Returns the original string if it's not encrypted or decryption fails.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @param string $encrypted The encrypted string (with prefix).
|
||||
* @return string Decrypted plaintext or original string if not encrypted.
|
||||
*/
|
||||
public static function decrypt( string $encrypted ): string {
|
||||
// Return empty strings as-is.
|
||||
if ( '' === $encrypted ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
// Check if it's actually encrypted.
|
||||
if ( ! self::is_encrypted( $encrypted ) ) {
|
||||
return $encrypted;
|
||||
}
|
||||
|
||||
// Check if decryption is available.
|
||||
if ( ! self::is_encryption_available() ) {
|
||||
// Can't decrypt without proper setup, return as-is.
|
||||
return $encrypted;
|
||||
}
|
||||
|
||||
// Remove prefix.
|
||||
$encrypted_data = substr( $encrypted, strlen( self::PREFIX ) );
|
||||
|
||||
// Decode from base64.
|
||||
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode -- Used for decryption, not obfuscation.
|
||||
$decoded = base64_decode( $encrypted_data, true );
|
||||
|
||||
if ( false === $decoded ) {
|
||||
// Invalid base64, return original.
|
||||
return $encrypted;
|
||||
}
|
||||
|
||||
// Extract IV, ciphertext, and tag.
|
||||
$iv_length = openssl_cipher_iv_length( self::CIPHER );
|
||||
$tag_length = 16;
|
||||
|
||||
if ( strlen( $decoded ) < ( $iv_length + $tag_length + 1 ) ) {
|
||||
// Data too short, corrupted.
|
||||
return $encrypted;
|
||||
}
|
||||
|
||||
$iv = substr( $decoded, 0, $iv_length );
|
||||
$tag = substr( $decoded, -$tag_length );
|
||||
$ciphertext = substr( $decoded, $iv_length, -$tag_length );
|
||||
|
||||
// Derive encryption key.
|
||||
$key = self::get_encryption_key();
|
||||
|
||||
// Decrypt.
|
||||
$plaintext = openssl_decrypt(
|
||||
$ciphertext,
|
||||
self::CIPHER,
|
||||
$key,
|
||||
OPENSSL_RAW_DATA,
|
||||
$iv,
|
||||
$tag
|
||||
);
|
||||
|
||||
if ( false === $plaintext ) {
|
||||
// Decryption failed (wrong key, corrupted data, etc).
|
||||
return $encrypted;
|
||||
}
|
||||
|
||||
return $plaintext;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a string is encrypted (has the encryption prefix).
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @param string $value The value to check.
|
||||
* @return bool True if encrypted, false otherwise.
|
||||
*/
|
||||
public static function is_encrypted( string $value ): bool {
|
||||
return 0 === strpos( $value, self::PREFIX );
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if encryption is available and properly configured.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @return bool True if encryption is available, false otherwise.
|
||||
*/
|
||||
public static function is_encryption_available(): bool {
|
||||
// Check if OpenSSL extension is loaded.
|
||||
if ( ! extension_loaded( 'openssl' ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Check if AES-256-GCM is supported.
|
||||
if ( ! in_array( self::CIPHER, openssl_get_cipher_methods(), true ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Check if WordPress AUTH_KEY and AUTH_SALT are defined.
|
||||
if ( ! defined( 'AUTH_KEY' ) || '' === AUTH_KEY || ! defined( 'AUTH_SALT' ) || '' === AUTH_SALT ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Derives a 256-bit encryption key from WordPress AUTH_KEY and AUTH_SALT.
|
||||
*
|
||||
* @since 1.2.1
|
||||
*
|
||||
* @return string Binary encryption key (32 bytes for AES-256).
|
||||
*/
|
||||
private static function get_encryption_key(): string {
|
||||
$key_material = AUTH_KEY . AUTH_SALT;
|
||||
$salt = defined( 'SECURE_AUTH_KEY' ) ? SECURE_AUTH_KEY : 'robotstxt_smtp_salt';
|
||||
|
||||
return hash_pbkdf2( 'sha256', $key_material, $salt, 10000, 32, true );
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -7,6 +7,8 @@
|
|||
|
||||
namespace Robotstxt_SMTP\Admin;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
use PHPMailer\PHPMailer\SMTP;
|
||||
|
||||
/**
|
||||
|
|
|
|||
287
includes/class-statistics.php
Normal file
287
includes/class-statistics.php
Normal file
|
|
@ -0,0 +1,287 @@
|
|||
<?php
|
||||
/**
|
||||
* Email statistics tracking for ROBOTSTXT SMTP plugin.
|
||||
*
|
||||
* Provides daily email statistics with support for WordPress Multisite.
|
||||
* Tracks emails sent per day per site and handles automatic cleanup.
|
||||
*
|
||||
* @package Robotstxt_SMTP
|
||||
* @since 1.3.0
|
||||
*/
|
||||
|
||||
namespace Robotstxt_SMTP;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* Class Statistics
|
||||
*
|
||||
* Handles email statistics tracking and retrieval.
|
||||
*
|
||||
* @since 1.3.0
|
||||
*/
|
||||
class Statistics {
|
||||
|
||||
/**
|
||||
* Database table name (without prefix).
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private const TABLE_NAME = 'robotstxt_smtp_stats';
|
||||
|
||||
/**
|
||||
* Database version for migration tracking.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private const DB_VERSION = '1.0';
|
||||
|
||||
/**
|
||||
* Option name for storing database version.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private const DB_VERSION_OPTION = 'robotstxt_smtp_stats_db_version';
|
||||
|
||||
/**
|
||||
* Singleton instance.
|
||||
*
|
||||
* @var Statistics|null
|
||||
*/
|
||||
private static ?Statistics $instance = null;
|
||||
|
||||
/**
|
||||
* Gets the singleton instance.
|
||||
*
|
||||
* @return Statistics
|
||||
*/
|
||||
public static function get_instance(): Statistics {
|
||||
if ( null === self::$instance ) {
|
||||
self::$instance = new self();
|
||||
}
|
||||
|
||||
return self::$instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Private constructor to enforce singleton.
|
||||
*/
|
||||
private function __construct() {
|
||||
$this->maybe_create_table();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the full table name with WordPress prefix.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_table_name(): string {
|
||||
global $wpdb;
|
||||
return $wpdb->base_prefix . self::TABLE_NAME;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates the statistics table if it doesn't exist.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private function maybe_create_table(): void {
|
||||
$installed_version = get_site_option( self::DB_VERSION_OPTION, '0' );
|
||||
|
||||
if ( version_compare( $installed_version, self::DB_VERSION, '>=' ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
global $wpdb;
|
||||
$table_name = self::get_table_name();
|
||||
$charset_collate = $wpdb->get_charset_collate();
|
||||
|
||||
$sql = "CREATE TABLE {$table_name} (
|
||||
id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
|
||||
blog_id bigint(20) unsigned NOT NULL DEFAULT 1,
|
||||
date date NOT NULL,
|
||||
emails_sent bigint(20) unsigned NOT NULL DEFAULT 0,
|
||||
PRIMARY KEY (id),
|
||||
UNIQUE KEY blog_date (blog_id, date),
|
||||
KEY date_idx (date),
|
||||
KEY blog_id_idx (blog_id)
|
||||
) {$charset_collate};";
|
||||
|
||||
require_once ABSPATH . 'wp-admin/includes/upgrade.php';
|
||||
dbDelta( $sql );
|
||||
|
||||
update_site_option( self::DB_VERSION_OPTION, self::DB_VERSION );
|
||||
}
|
||||
|
||||
/**
|
||||
* Increments the email counter for today.
|
||||
*
|
||||
* @param int|null $blog_id Blog ID (defaults to current blog).
|
||||
*
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
public function increment_today( ?int $blog_id = null ): bool {
|
||||
global $wpdb;
|
||||
|
||||
if ( null === $blog_id ) {
|
||||
$blog_id = get_current_blog_id();
|
||||
}
|
||||
|
||||
$table_name = self::get_table_name();
|
||||
$today = current_time( 'Y-m-d' );
|
||||
|
||||
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
|
||||
$result = $wpdb->query(
|
||||
$wpdb->prepare(
|
||||
"INSERT INTO {$table_name} (blog_id, date, emails_sent)
|
||||
VALUES (%d, %s, 1)
|
||||
ON DUPLICATE KEY UPDATE emails_sent = emails_sent + 1",
|
||||
$blog_id,
|
||||
$today
|
||||
)
|
||||
);
|
||||
|
||||
return false !== $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets statistics for a specific date range.
|
||||
*
|
||||
* @param string $start_date Start date (Y-m-d format).
|
||||
* @param string $end_date End date (Y-m-d format).
|
||||
* @param int|null $blog_id Blog ID (null for all sites).
|
||||
*
|
||||
* @return array<int, object> Array of statistics objects.
|
||||
*/
|
||||
public function get_stats( string $start_date, string $end_date, ?int $blog_id = null ): array {
|
||||
global $wpdb;
|
||||
|
||||
$table_name = self::get_table_name();
|
||||
|
||||
if ( null !== $blog_id ) {
|
||||
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
|
||||
$results = $wpdb->get_results(
|
||||
$wpdb->prepare(
|
||||
"SELECT blog_id, date, emails_sent
|
||||
FROM {$table_name}
|
||||
WHERE blog_id = %d
|
||||
AND date BETWEEN %s AND %s
|
||||
ORDER BY date ASC",
|
||||
$blog_id,
|
||||
$start_date,
|
||||
$end_date
|
||||
)
|
||||
);
|
||||
} else {
|
||||
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
|
||||
$results = $wpdb->get_results(
|
||||
$wpdb->prepare(
|
||||
"SELECT blog_id, date, emails_sent
|
||||
FROM {$table_name}
|
||||
WHERE date BETWEEN %s AND %s
|
||||
ORDER BY date ASC, blog_id ASC",
|
||||
$start_date,
|
||||
$end_date
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
return is_array( $results ) ? $results : array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets total emails sent for a date range.
|
||||
*
|
||||
* @param string $start_date Start date (Y-m-d format).
|
||||
* @param string $end_date End date (Y-m-d format).
|
||||
* @param int|null $blog_id Blog ID (null for all sites).
|
||||
*
|
||||
* @return int Total emails sent.
|
||||
*/
|
||||
public function get_total( string $start_date, string $end_date, ?int $blog_id = null ): int {
|
||||
global $wpdb;
|
||||
|
||||
$table_name = self::get_table_name();
|
||||
|
||||
if ( null !== $blog_id ) {
|
||||
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
|
||||
$total = $wpdb->get_var(
|
||||
$wpdb->prepare(
|
||||
"SELECT SUM(emails_sent)
|
||||
FROM {$table_name}
|
||||
WHERE blog_id = %d
|
||||
AND date BETWEEN %s AND %s",
|
||||
$blog_id,
|
||||
$start_date,
|
||||
$end_date
|
||||
)
|
||||
);
|
||||
} else {
|
||||
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
|
||||
$total = $wpdb->get_var(
|
||||
$wpdb->prepare(
|
||||
"SELECT SUM(emails_sent)
|
||||
FROM {$table_name}
|
||||
WHERE date BETWEEN %s AND %s",
|
||||
$start_date,
|
||||
$end_date
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
return absint( $total );
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets statistics aggregated by blog for multisite.
|
||||
*
|
||||
* @param string $start_date Start date (Y-m-d format).
|
||||
* @param string $end_date End date (Y-m-d format).
|
||||
*
|
||||
* @return array<int, object> Array with blog_id and total_emails.
|
||||
*/
|
||||
public function get_stats_by_blog( string $start_date, string $end_date ): array {
|
||||
global $wpdb;
|
||||
|
||||
$table_name = self::get_table_name();
|
||||
|
||||
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
|
||||
$results = $wpdb->get_results(
|
||||
$wpdb->prepare(
|
||||
"SELECT blog_id, SUM(emails_sent) as total_emails
|
||||
FROM {$table_name}
|
||||
WHERE date BETWEEN %s AND %s
|
||||
GROUP BY blog_id
|
||||
ORDER BY total_emails DESC",
|
||||
$start_date,
|
||||
$end_date
|
||||
)
|
||||
);
|
||||
|
||||
return is_array( $results ) ? $results : array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes statistics older than specified days.
|
||||
*
|
||||
* @param int $days Number of days to retain.
|
||||
*
|
||||
* @return int Number of rows deleted.
|
||||
*/
|
||||
public function cleanup_old_stats( int $days ): int {
|
||||
global $wpdb;
|
||||
|
||||
$table_name = self::get_table_name();
|
||||
$cutoff_date = gmdate( 'Y-m-d', strtotime( "-{$days} days" ) );
|
||||
|
||||
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
|
||||
$deleted = $wpdb->query(
|
||||
$wpdb->prepare(
|
||||
"DELETE FROM {$table_name} WHERE date < %s",
|
||||
$cutoff_date
|
||||
)
|
||||
);
|
||||
|
||||
return absint( $deleted );
|
||||
}
|
||||
}
|
||||
BIN
languages/robotstxt-smtp-ca.mo
Normal file
BIN
languages/robotstxt-smtp-ca.mo
Normal file
Binary file not shown.
1479
languages/robotstxt-smtp-ca.po
Normal file
1479
languages/robotstxt-smtp-ca.po
Normal file
File diff suppressed because it is too large
Load diff
BIN
languages/robotstxt-smtp-es_ES.mo
Normal file
BIN
languages/robotstxt-smtp-es_ES.mo
Normal file
Binary file not shown.
1479
languages/robotstxt-smtp-es_ES.po
Normal file
1479
languages/robotstxt-smtp-es_ES.po
Normal file
File diff suppressed because it is too large
Load diff
1374
languages/robotstxt-smtp.pot
Normal file
1374
languages/robotstxt-smtp.pot
Normal file
File diff suppressed because it is too large
Load diff
18
readme.txt
18
readme.txt
|
|
@ -1,11 +1,12 @@
|
|||
=== SMTP (by ROBOTSTXT) ===
|
||||
Contributors: robotstxt
|
||||
Contributors: javiercasares
|
||||
Tags: smtp, email, mail
|
||||
Requires at least: 6.0
|
||||
Requires at least: 6.5
|
||||
Tested up to: 6.9
|
||||
Stable tag: 2.0.0
|
||||
Requires PHP: 8.2
|
||||
Stable tag: 1.2.0
|
||||
License: GPLv3 or later
|
||||
Version: 2.0.0
|
||||
License: GPL-3.0-or-later
|
||||
License URI: https://www.gnu.org/licenses/gpl-3.0.html
|
||||
|
||||
Send every site email through a fully configurable SMTP server managed from the WordPress dashboard.
|
||||
|
|
@ -64,10 +65,13 @@ Yes. From the network dashboard you can decide whether the configuration is glob
|
|||
|
||||
== Changelog ==
|
||||
|
||||
= 1.2.0 =
|
||||
= 2.0.0 =
|
||||
|
||||
* Logged failed email deliveries with status and error details in the log list and detail views.
|
||||
* Captured the SMTP debug conversation for each email and surfaced it inside the log detail view.
|
||||
* Added Reply-To email and name configuration fields for custom reply addresses.
|
||||
* Added email statistics tracking system with daily counters and visual charts.
|
||||
* Added statistics page with Chart.js visualization and multisite support.
|
||||
* Added statistics retention settings (configurable from 1 to 365 days).
|
||||
* Implemented security improvements and password field enhancements.
|
||||
|
||||
= 1.1.0 =
|
||||
|
||||
|
|
|
|||
|
|
@ -1,20 +1,21 @@
|
|||
<?php
|
||||
/**
|
||||
* Plugin Name: SMTP (by ROBOTSTXT)
|
||||
* Plugin URI: https://www.robotstxt.es/
|
||||
* Plugin URI: https://git.robotstxt.es/ROBOTSTXT/robotstxt-smtp
|
||||
* Description: Configure WordPress to send emails through SMTP with detailed controls.
|
||||
* Version: 1.2.0
|
||||
* Requires at least: 6.0
|
||||
* Version: 2.0.0
|
||||
* Requires at least: 6.5
|
||||
* Requires PHP: 8.2
|
||||
* Network: true
|
||||
* Security: robotstxt@robotstxt.es
|
||||
* Author: ROBOTSTXT
|
||||
* Author URI: https://www.robotstxt.es/
|
||||
* Text Domain: robotstxt-smtp
|
||||
* Domain Path: /languages
|
||||
* License: GPL-3.0-or-later
|
||||
* License URI: https://www.gnu.org/licenses/gpl-3.0.html
|
||||
* Gitea Plugin URI: ROBOTSTXT/robotstxt-smtp
|
||||
* Gitea Plugin URI: https://git.robotstxt.es/ROBOTSTXT/robotstxt-smtp
|
||||
* Plugin ID: did:plc:yodoiqooeu3l3lwuolyha3zs
|
||||
* Primary Branch: main
|
||||
*
|
||||
* @package Robotstxt_SMTP
|
||||
*/
|
||||
|
|
@ -24,7 +25,7 @@ if ( ! defined( 'ABSPATH' ) ) {
|
|||
}
|
||||
|
||||
if ( ! defined( 'ROBOTSTXT_SMTP_VERSION' ) ) {
|
||||
define( 'ROBOTSTXT_SMTP_VERSION', '1.2.0' );
|
||||
define( 'ROBOTSTXT_SMTP_VERSION', '2.0.0' );
|
||||
}
|
||||
|
||||
if ( ! defined( 'ROBOTSTXT_SMTP_FILE' ) ) {
|
||||
|
|
@ -47,6 +48,10 @@ if ( ! defined( 'ROBOTSTXT_SMTP_BASENAME' ) ) {
|
|||
define( 'ROBOTSTXT_SMTP_BASENAME', plugin_basename( ROBOTSTXT_SMTP_FILE ) );
|
||||
}
|
||||
|
||||
if ( ! defined( 'ROBOTSTXT_SMTP_IS_MULTISITE' ) ) {
|
||||
define( 'ROBOTSTXT_SMTP_IS_MULTISITE', is_multisite() );
|
||||
}
|
||||
|
||||
if ( ! class_exists( 'PHPMailer\PHPMailer\PHPMailer' ) ) {
|
||||
require_once ABSPATH . WPINC . '/PHPMailer/PHPMailer.php';
|
||||
}
|
||||
|
|
@ -59,7 +64,9 @@ if ( ! class_exists( 'PHPMailer\PHPMailer\SMTP' ) ) {
|
|||
require_once ABSPATH . WPINC . '/PHPMailer/SMTP.php';
|
||||
}
|
||||
|
||||
require_once ROBOTSTXT_SMTP_PATH . 'includes/class-robotstxt-smtp-encryption.php';
|
||||
require_once ROBOTSTXT_SMTP_PATH . 'includes/class-smtp-diagnostics-client.php';
|
||||
require_once ROBOTSTXT_SMTP_PATH . 'includes/class-statistics.php';
|
||||
require_once ROBOTSTXT_SMTP_PATH . 'includes/class-settings-page.php';
|
||||
require_once ROBOTSTXT_SMTP_PATH . 'includes/class-plugin.php';
|
||||
|
||||
|
|
@ -118,3 +125,7 @@ if ( robotstxt_smtp_dependencies_satisfied() ) {
|
|||
} else {
|
||||
robotstxt_smtp_register_dependency_notice();
|
||||
}
|
||||
|
||||
// Initialize ROBOTSTXT updater (auto-configures from plugin headers).
|
||||
require_once __DIR__ . '/robotstxt-updater.php';
|
||||
Robotstxt_Updater::init( __FILE__ );
|
||||
|
|
|
|||
383
robotstxt-updater.php
Normal file
383
robotstxt-updater.php
Normal file
|
|
@ -0,0 +1,383 @@
|
|||
<?php
|
||||
/**
|
||||
* Generic JSON-based updater for ROBOTSTXT plugins.
|
||||
*
|
||||
* This file is designed to be copied to any ROBOTSTXT plugin.
|
||||
* It auto-configures itself by reading the plugin headers.
|
||||
*
|
||||
* @package ROBOTSTXT
|
||||
* @version 1.0.0
|
||||
*/
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
if ( ! class_exists( 'Robotstxt_Updater' ) ) {
|
||||
/**
|
||||
* Class Robotstxt_Updater
|
||||
*
|
||||
* Generic updater that works with any plugin.
|
||||
* Reads plugin headers and constructs update URL automatically.
|
||||
*/
|
||||
class Robotstxt_Updater {
|
||||
|
||||
/**
|
||||
* Plugin file path.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private string $plugin_file_path;
|
||||
|
||||
/**
|
||||
* Plugin basename (e.g., 'my-plugin/my-plugin.php').
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private string $plugin_basename;
|
||||
|
||||
/**
|
||||
* Plugin slug (directory name).
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private string $plugin_slug;
|
||||
|
||||
/**
|
||||
* Remote JSON URL.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private string $json_url;
|
||||
|
||||
/**
|
||||
* Cache key.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private string $cache_key;
|
||||
|
||||
/**
|
||||
* Plugin headers.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private array $plugin_data;
|
||||
|
||||
/**
|
||||
* Initialize the updater.
|
||||
*
|
||||
* Usage in your main plugin file:
|
||||
* require_once __DIR__ . '/robotstxt-updater.php';
|
||||
* Robotstxt_Updater::init( __FILE__ );
|
||||
*
|
||||
* @param string $plugin_file_path Absolute path to the main plugin file.
|
||||
*/
|
||||
public static function init( string $plugin_file_path ): void {
|
||||
$instance = new self( $plugin_file_path );
|
||||
$instance->register();
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $plugin_file_path Absolute path to the main plugin file.
|
||||
*/
|
||||
private function __construct( string $plugin_file_path ) {
|
||||
$this->plugin_file_path = $plugin_file_path;
|
||||
$this->plugin_basename = plugin_basename( $plugin_file_path );
|
||||
$this->plugin_slug = dirname( $this->plugin_basename );
|
||||
$this->plugin_data = $this->get_plugin_data();
|
||||
$this->json_url = $this->build_json_url();
|
||||
$this->cache_key = 'robotstxt_updater_' . md5( $this->plugin_basename );
|
||||
}
|
||||
|
||||
/**
|
||||
* Register WordPress hooks.
|
||||
*/
|
||||
private function register(): void {
|
||||
add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'inject_update_info' ) );
|
||||
add_filter( 'plugins_api', array( $this, 'provide_plugin_details' ), 10, 3 );
|
||||
add_action( 'admin_init', array( $this, 'handle_cache_clear' ) );
|
||||
add_action( 'robotstxt_updater_clear_cache', array( $this, 'clear_cache' ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get plugin headers.
|
||||
*
|
||||
* @return array Plugin data.
|
||||
*/
|
||||
private function get_plugin_data(): array {
|
||||
if ( ! function_exists( 'get_plugin_data' ) ) {
|
||||
require_once ABSPATH . 'wp-admin/includes/plugin.php';
|
||||
}
|
||||
|
||||
return get_plugin_data( $this->plugin_file_path, false, false );
|
||||
}
|
||||
|
||||
/**
|
||||
* Build JSON URL from plugin headers.
|
||||
*
|
||||
* Tries to use "Gitea Plugin URI" header to construct the URL.
|
||||
* Falls back to Plugin URI if Gitea URI is not available.
|
||||
*
|
||||
* @return string JSON URL.
|
||||
*/
|
||||
private function build_json_url(): string {
|
||||
// Try Gitea Plugin URI (format: "OWNER/REPO" or full URL).
|
||||
if ( ! empty( $this->plugin_data['Gitea Plugin URI'] ) ) {
|
||||
$gitea_uri = $this->plugin_data['Gitea Plugin URI'];
|
||||
|
||||
// If it's already a full URL, use it.
|
||||
if ( str_starts_with( $gitea_uri, 'http' ) ) {
|
||||
// Extract base URL and construct JSON path.
|
||||
return rtrim( $gitea_uri, '/' ) . '/raw/branch/main/update.json';
|
||||
}
|
||||
|
||||
// If it's in format "OWNER/REPO", construct full URL.
|
||||
if ( preg_match( '#^[^/]+/[^/]+$#', $gitea_uri ) ) {
|
||||
return "https://git.robotstxt.es/{$gitea_uri}/raw/branch/main/update.json";
|
||||
}
|
||||
}
|
||||
|
||||
// Fallback: try to extract from Plugin URI.
|
||||
if ( ! empty( $this->plugin_data['PluginURI'] ) ) {
|
||||
$plugin_uri = $this->plugin_data['PluginURI'];
|
||||
if ( str_contains( $plugin_uri, 'git.robotstxt.es' ) ) {
|
||||
return rtrim( $plugin_uri, '/' ) . '/raw/branch/main/update.json';
|
||||
}
|
||||
}
|
||||
|
||||
// Last resort: construct from plugin slug.
|
||||
return "https://git.robotstxt.es/ROBOTSTXT/{$this->plugin_slug}/raw/branch/main/update.json";
|
||||
}
|
||||
|
||||
/**
|
||||
* Inject update info into WP's plugin update transient.
|
||||
*
|
||||
* @param object|mixed $transient The update_plugins transient.
|
||||
*
|
||||
* @return object The modified transient.
|
||||
*/
|
||||
public function inject_update_info( $transient ) {
|
||||
if ( ! is_object( $transient ) ) {
|
||||
$transient = new stdClass();
|
||||
}
|
||||
|
||||
if ( empty( $transient->checked ) || ! is_array( $transient->checked ) ) {
|
||||
return $transient;
|
||||
}
|
||||
|
||||
if ( empty( $transient->checked[ $this->plugin_basename ] ) ) {
|
||||
return $transient;
|
||||
}
|
||||
|
||||
$current_version = $transient->checked[ $this->plugin_basename ];
|
||||
$remote = $this->get_remote_data();
|
||||
|
||||
if ( empty( $remote['version'] ) || empty( $remote['download_url'] ) ) {
|
||||
return $transient;
|
||||
}
|
||||
|
||||
if ( ! $this->is_compatible( $remote ) ) {
|
||||
return $transient;
|
||||
}
|
||||
|
||||
if ( version_compare( $remote['version'], $current_version, '>' ) ) {
|
||||
$update = (object) array(
|
||||
'slug' => $remote['slug'] ?? $this->plugin_slug,
|
||||
'plugin' => $this->plugin_basename,
|
||||
'new_version' => $remote['version'],
|
||||
'url' => $remote['homepage'] ?? $this->plugin_data['PluginURI'] ?? '',
|
||||
'package' => $remote['download_url'],
|
||||
'tested' => $remote['tested'] ?? '',
|
||||
'requires' => $remote['requires'] ?? '',
|
||||
'requires_php' => $remote['requires_php'] ?? '',
|
||||
);
|
||||
|
||||
$transient->response[ $this->plugin_basename ] = $update;
|
||||
}
|
||||
|
||||
return $transient;
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide "View details" modal content.
|
||||
*
|
||||
* @param false|object|array $result The result object or array.
|
||||
* @param string $action The type of information being requested.
|
||||
* @param object $args Plugin API arguments.
|
||||
*
|
||||
* @return false|object The plugin information object or false.
|
||||
*/
|
||||
public function provide_plugin_details( $result, string $action, object $args ) {
|
||||
if ( 'plugin_information' !== $action ) {
|
||||
return $result;
|
||||
}
|
||||
|
||||
if ( empty( $args->slug ) || $args->slug !== $this->plugin_slug ) {
|
||||
return $result;
|
||||
}
|
||||
|
||||
$remote = $this->get_remote_data();
|
||||
|
||||
if ( empty( $remote['version'] ) ) {
|
||||
return $result;
|
||||
}
|
||||
|
||||
return (object) array(
|
||||
'name' => $remote['name'] ?? $this->plugin_data['Name'] ?? $this->plugin_slug,
|
||||
'slug' => $remote['slug'] ?? $this->plugin_slug,
|
||||
'version' => $remote['version'],
|
||||
'author' => $remote['author'] ?? $this->plugin_data['Author'] ?? '',
|
||||
'homepage' => $remote['homepage'] ?? $this->plugin_data['PluginURI'] ?? '',
|
||||
'requires' => $remote['requires'] ?? '',
|
||||
'tested' => $remote['tested'] ?? '',
|
||||
'requires_php' => $remote['requires_php'] ?? '',
|
||||
'sections' => array(
|
||||
'description' => $remote['description'] ?? $this->plugin_data['Description'] ?? '',
|
||||
'changelog' => $remote['changelog'] ?? '',
|
||||
),
|
||||
'download_link' => $remote['download_url'] ?? '',
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get remote data with caching and HMAC signature verification.
|
||||
*
|
||||
* @return array Remote data.
|
||||
*/
|
||||
private function get_remote_data(): array {
|
||||
$cached = get_site_transient( $this->cache_key );
|
||||
|
||||
// Verify HMAC signature if AUTH_SALT is defined and cache has signature.
|
||||
if ( false !== $cached && defined( 'AUTH_SALT' ) && '' !== AUTH_SALT ) {
|
||||
if ( is_array( $cached ) && isset( $cached['signature'], $cached['data'] ) ) {
|
||||
$expected_sig = hash_hmac( 'sha256', $this->cache_key . serialize( $cached['data'] ), AUTH_SALT );
|
||||
|
||||
if ( hash_equals( $expected_sig, $cached['signature'] ) ) {
|
||||
// Signature valid, return data.
|
||||
return is_array( $cached['data'] ) ? $cached['data'] : array();
|
||||
}
|
||||
|
||||
// Signature invalid, delete corrupted cache.
|
||||
delete_site_transient( $this->cache_key );
|
||||
$cached = false;
|
||||
}
|
||||
}
|
||||
|
||||
// If no valid cache, fetch fresh data.
|
||||
if ( false === $cached ) {
|
||||
$remote = $this->fetch_json();
|
||||
|
||||
// Store with HMAC signature if AUTH_SALT is available.
|
||||
if ( defined( 'AUTH_SALT' ) && '' !== AUTH_SALT ) {
|
||||
$payload = array(
|
||||
'data' => $remote ?: array(),
|
||||
'timestamp' => time(),
|
||||
'signature' => hash_hmac( 'sha256', $this->cache_key . serialize( $remote ?: array() ), AUTH_SALT ),
|
||||
);
|
||||
set_site_transient( $this->cache_key, $payload, 6 * HOUR_IN_SECONDS );
|
||||
} else {
|
||||
// Fallback to standard caching.
|
||||
set_site_transient( $this->cache_key, $remote ?: array(), 6 * HOUR_IN_SECONDS );
|
||||
}
|
||||
|
||||
return is_array( $remote ) ? $remote : array();
|
||||
}
|
||||
|
||||
// Legacy cache format without signature (backward compatibility).
|
||||
return is_array( $cached ) ? $cached : array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch JSON from remote URL.
|
||||
*
|
||||
* @return array Decoded JSON data.
|
||||
*/
|
||||
private function fetch_json(): array {
|
||||
$response = wp_remote_get(
|
||||
$this->json_url,
|
||||
array(
|
||||
'timeout' => 10,
|
||||
'headers' => array(
|
||||
'Accept' => 'application/json',
|
||||
),
|
||||
)
|
||||
);
|
||||
|
||||
if ( is_wp_error( $response ) ) {
|
||||
return array();
|
||||
}
|
||||
|
||||
$code = (int) wp_remote_retrieve_response_code( $response );
|
||||
if ( $code < 200 || $code >= 300 ) {
|
||||
return array();
|
||||
}
|
||||
|
||||
$body = wp_remote_retrieve_body( $response );
|
||||
$data = json_decode( $body, true );
|
||||
|
||||
return is_array( $data ) ? $data : array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Check compatibility.
|
||||
*
|
||||
* @param array $remote Remote data.
|
||||
*
|
||||
* @return bool True if compatible.
|
||||
*/
|
||||
private function is_compatible( array $remote ): bool {
|
||||
if ( ! empty( $remote['requires_php'] ) ) {
|
||||
if ( version_compare( PHP_VERSION, $remote['requires_php'], '<' ) ) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
if ( ! empty( $remote['requires'] ) ) {
|
||||
if ( version_compare( get_bloginfo( 'version' ), $remote['requires'], '<' ) ) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle manual cache clear via URL parameter.
|
||||
*/
|
||||
public function handle_cache_clear(): void {
|
||||
// Check if this is a cache clear request first.
|
||||
$clear_cache = filter_input( INPUT_GET, 'robotstxt_clear_update_cache', FILTER_UNSAFE_RAW );
|
||||
if ( null === $clear_cache ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// This is a cache clear request - now verify nonce.
|
||||
$nonce_raw = filter_input( INPUT_GET, '_wpnonce', FILTER_UNSAFE_RAW );
|
||||
$nonce = $nonce_raw ? sanitize_text_field( wp_unslash( $nonce_raw ) ) : '';
|
||||
|
||||
if ( ! wp_verify_nonce( $nonce, 'robotstxt_clear_update_cache' ) ) {
|
||||
wp_die( esc_html__( 'Security check failed', 'robotstxt-smtp' ) );
|
||||
}
|
||||
|
||||
// Check permissions.
|
||||
if ( ! current_user_can( 'update_plugins' ) ) {
|
||||
wp_die( esc_html__( 'You do not have sufficient permissions to access this page.', 'robotstxt-smtp' ) );
|
||||
}
|
||||
|
||||
$this->clear_cache();
|
||||
wp_safe_redirect( remove_query_arg( array( 'robotstxt_clear_update_cache', '_wpnonce' ) ) );
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear update cache.
|
||||
*/
|
||||
public function clear_cache(): void {
|
||||
delete_site_transient( $this->cache_key );
|
||||
delete_site_transient( 'update_plugins' );
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -143,10 +143,10 @@ if ( ! function_exists( 'robotstxt_smtp_uninstall_delete_logs' ) ) {
|
|||
robotstxt_smtp_uninstall_cleanup_network();
|
||||
|
||||
if ( function_exists( 'is_multisite' ) && is_multisite() ) {
|
||||
$sites = get_sites( array( 'fields' => 'ids' ) );
|
||||
$robotstxt_smtp_sites = get_sites( array( 'fields' => 'ids' ) );
|
||||
|
||||
foreach ( $sites as $site_id ) {
|
||||
switch_to_blog( (int) $site_id );
|
||||
foreach ( $robotstxt_smtp_sites as $robotstxt_smtp_site_id ) {
|
||||
switch_to_blog( (int) $robotstxt_smtp_site_id );
|
||||
robotstxt_smtp_uninstall_cleanup_site();
|
||||
restore_current_blog();
|
||||
}
|
||||
|
|
|
|||
27
update.json
Normal file
27
update.json
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
{
|
||||
"name": "SMTP (by ROBOTSTXT)",
|
||||
"slug": "robotstxt-smtp",
|
||||
"version": "2.0.0",
|
||||
"download_url": "https://git.robotstxt.es/ROBOTSTXT/robotstxt-smtp/releases/download/2.0.0/robotstxt-smtp-2.0.0.zip",
|
||||
"requires": "6.5",
|
||||
"requires_php": "8.2",
|
||||
"tested": "6.9",
|
||||
"last_updated": "2026-01-29",
|
||||
"author": "ROBOTSTXT",
|
||||
"author_profile": "https://www.robotstxt.es/",
|
||||
"homepage": "https://git.robotstxt.es/ROBOTSTXT/robotstxt-smtp",
|
||||
"description": "Configure WordPress to send emails through SMTP with detailed controls. Supports multiple SMTP providers, logging, diagnostics, and network/site-level configuration.",
|
||||
"changelog": "<h3>2.0.0 - 2026-01-29</h3><ul><li><strong>Security:</strong> Comprehensive security audit and hardening</li><li><strong>Security:</strong> Enhanced nonce validation across all forms and actions</li><li><strong>Security:</strong> Improved input sanitization and validation</li><li><strong>Security:</strong> Enhanced password encryption and migration</li><li><strong>Security:</strong> Secure handling of superglobals and transients</li><li><strong>Security:</strong> Strengthened regex patterns and port number validation</li><li><strong>Added:</strong> Reply-To header support for Amazon SES</li><li><strong>Fixed:</strong> Access control and form handling improvements</li><li><strong>Fixed:</strong> WordPress Multisite rate limiting enhancements</li><li><strong>Fixed:</strong> Empty password field handling</li><li><strong>Improved:</strong> Code quality and PHPDoc documentation</li></ul><h3>1.2.0 - 2026-01-27</h3><ul><li>Enhanced DNS blacklist checking with error handling</li><li>Added rate limiting for DNSBL queries</li><li>Improved caching mechanism for DNS results</li><li>Fixed warnings in SMTP diagnostics</li><li>Security improvements and code optimization</li></ul>",
|
||||
"sections": {
|
||||
"description": "Configure WordPress to send emails through SMTP with detailed controls. Supports multiple SMTP providers, logging, diagnostics, and network/site-level configuration.",
|
||||
"changelog": "<h3>2.0.0 - 2026-01-29</h3><ul><li><strong>Security:</strong> Comprehensive security audit and hardening</li><li><strong>Security:</strong> Enhanced nonce validation across all forms and actions</li><li><strong>Security:</strong> Improved input sanitization and validation</li><li><strong>Security:</strong> Enhanced password encryption and migration</li><li><strong>Security:</strong> Secure handling of superglobals and transients</li><li><strong>Security:</strong> Strengthened regex patterns and port number validation</li><li><strong>Added:</strong> Reply-To header support for Amazon SES</li><li><strong>Fixed:</strong> Access control and form handling improvements</li><li><strong>Fixed:</strong> WordPress Multisite rate limiting enhancements</li><li><strong>Fixed:</strong> Empty password field handling</li><li><strong>Improved:</strong> Code quality and PHPDoc documentation</li></ul><h3>1.2.0 - 2026-01-27</h3><ul><li>Enhanced DNS blacklist checking with error handling</li><li>Added rate limiting for DNSBL queries</li><li>Improved caching mechanism for DNS results</li><li>Fixed warnings in SMTP diagnostics</li><li>Security improvements and code optimization</li></ul>"
|
||||
},
|
||||
"banners": {
|
||||
"low": "",
|
||||
"high": ""
|
||||
},
|
||||
"icons": {
|
||||
"1x": "",
|
||||
"2x": ""
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue