This commit is contained in:
Javier Casares 2026-02-03 15:55:48 +00:00
commit e6299a3e14
3090 changed files with 140669 additions and 2 deletions

674
LICENSE Normal file
View 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>.

View file

@ -1,2 +0,0 @@
# idrivee2-media-upload

36
assets/js/admin.js Normal file
View file

@ -0,0 +1,36 @@
/**
* IDrivee2 Media Upload - Admin JavaScript.
*
* Provides enhanced user experience for the settings page.
*
* @package iDrivee2Media
* @since 0.3.0
*/
(function ($) {
$( document ).ready(
function () {
// Add confirmation to delete buttons.
$( 'button[name="idrivee2_delete_test"]' ).on(
'click',
function (e) {
var fileName = $( this ).closest( 'form' ).find( 'input[name="test_file"]' ).val();
if ( ! confirm( 'Are you sure you want to delete ' + fileName + ' from S3?' ) ) {
e.preventDefault();
return false;
}
}
);
// Scroll to notice after page reload (if notice exists).
if ( $( '.notice' ).length ) {
$( 'html, body' ).animate(
{
scrollTop: $( '.notice' ).first().offset().top - 50
},
500
);
}
}
);
})( jQuery );

61
idrivee2-media-upload.php Normal file
View file

@ -0,0 +1,61 @@
<?php
/**
* Plugin Name: iDrivee2 Media Upload
* Plugin URI: https://github.com/javiercasares/idrivee2-media-upload
* Description: Uploads media files to iDrivee2 (S3-compatible) with enterprise-grade security and logging.
* Version: 1.0.0
* Requires at least: 6.8
* Requires PHP: 8.2
* Author: Javier Casares
* Author URI: https://www.javiercasares.com/
* License: GPL-2.0-or-later
* License URI: https://spdx.org/licenses/GPL-2.0-or-later.html
* Text Domain: idrivee2-media-upload
* Domain Path: /languages
* Network: true
*
* @package iDrivee2Media
*/
declare(strict_types=1);
namespace iDrivee2Media;
/**
* Prevent direct access to this file.
*
* If this file is called directly, abort execution for security.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Load Composer autoloader if available.
*
* @since 0.1.13
*/
$autoload = __DIR__ . '/vendor/autoload.php';
if ( file_exists( $autoload ) ) {
require_once $autoload;
}
/**
* Load plugin classes.
*
* @since 0.3.0
*/
require_once __DIR__ . '/includes/class-logger.php';
require_once __DIR__ . '/includes/class-rate-limiter.php';
require_once __DIR__ . '/includes/class-config.php';
require_once __DIR__ . '/includes/class-s3-client-factory.php';
require_once __DIR__ . '/includes/class-url-rewriter.php';
require_once __DIR__ . '/includes/class-media-uploader.php';
require_once __DIR__ . '/includes/class-admin-page.php';
require_once __DIR__ . '/includes/class-plugin.php';
/**
* Bootstrap the plugin.
*
* @since 0.3.0
*/
Plugin::get_instance( __FILE__ )->init();

View file

@ -0,0 +1,856 @@
<?php
/**
* Admin Page handler for iDrivee2 Media Upload.
*
* @package iDrivee2Media
* @since 0.3.0
*/
declare(strict_types=1);
namespace iDrivee2Media;
/**
* Prevent direct access to this file.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Admin page handler for iDrivee2 Media Upload.
*
* Manages the admin interface under Settings → iDrivee2, including settings display,
* AJAX handlers for connection testing and file uploads, and script enqueuing.
*
* @since 0.3.0
*/
class Admin_Page {
/**
* Configuration instance.
*
* @var Config
*/
private $config;
/**
* S3 client factory.
*
* @var S3_Client_Factory
*/
private $client_factory;
/**
* Logger instance.
*
* @var Logger
*/
private $logger;
/**
* Rate limiter instance.
*
* @var Rate_Limiter
*/
private $rate_limiter;
/**
* Plugin file path.
*
* @var string
*/
private $plugin_file;
/**
* Constructor.
*
* @since 0.3.0
*
* @param Config $config Configuration instance.
* @param S3_Client_Factory $client_factory S3 client factory.
* @param Logger $logger Logger instance.
* @param Rate_Limiter $rate_limiter Rate limiter instance.
* @param string $plugin_file Path to the main plugin file.
*/
public function __construct( Config $config, S3_Client_Factory $client_factory, Logger $logger, Rate_Limiter $rate_limiter, string $plugin_file ) {
$this->config = $config;
$this->client_factory = $client_factory;
$this->logger = $logger;
$this->rate_limiter = $rate_limiter;
$this->plugin_file = $plugin_file;
}
/**
* Register hooks for the admin page.
*
* @since 0.3.0
*
* @return void
*/
public function register(): void {
add_action( 'admin_menu', array( $this, 'register_settings_page' ), 20 );
add_action( 'admin_init', array( $this, 'register_settings' ) );
add_action( 'admin_init', array( $this, 'handle_test_actions' ) );
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ), 20 );
}
/**
* Register the iDrivee2 settings page under the Settings menu.
*
* Adds a submenu page to the Settings section of the admin where users
* can configure and test their iDrivee2 setup.
*
* @since 0.3.0
*
* @return void
*/
public function register_settings_page(): void {
add_options_page(
/* translators: Admin menu title. */
__( 'iDrivee2 Media Upload Settings', 'idrivee2-media-upload' ),
/* translators: Admin menu label. */
__( 'iDrivee2', 'idrivee2-media-upload' ),
'manage_options',
'idrivee2-media-upload',
array( $this, 'render_settings_page' )
);
}
/**
* Register settings with WordPress Settings API.
*
* @since 0.3.0
*
* @return void
*/
public function register_settings(): void {
register_setting(
'idrivee2_media_settings_group',
'idrivee2_media_settings',
array(
'sanitize_callback' => array( $this, 'sanitize_settings' ),
)
);
}
/**
* Handle test action POST requests.
*
* Processes test connection, upload test file, and delete test file actions.
*
* @since 0.3.0
*
* @return void
*/
public function handle_test_actions(): void {
// Only process on settings page.
if ( ! isset( $_GET['page'] ) || 'idrivee2-media-upload' !== $_GET['page'] ) {
return;
}
// Handle test connection.
if ( isset( $_POST['idrivee2_test_connection'] ) ) {
check_admin_referer( 'idrivee2_test_connection' );
if ( ! current_user_can( 'manage_options' ) ) {
wp_die( esc_html__( 'You do not have sufficient permissions to access this page.', 'idrivee2-media-upload' ) );
}
$this->handle_test_connection();
return;
}
// Handle upload test file.
if ( isset( $_POST['idrivee2_upload_test'] ) ) {
check_admin_referer( 'idrivee2_upload_test' );
if ( ! current_user_can( 'manage_options' ) ) {
wp_die( esc_html__( 'You do not have sufficient permissions to access this page.', 'idrivee2-media-upload' ) );
}
$this->handle_upload_test();
return;
}
// Handle delete test file.
if ( isset( $_POST['idrivee2_delete_test'] ) && isset( $_POST['test_file'] ) ) {
check_admin_referer( 'idrivee2_delete_test' );
if ( ! current_user_can( 'manage_options' ) ) {
wp_die( esc_html__( 'You do not have sufficient permissions to access this page.', 'idrivee2-media-upload' ) );
}
$this->handle_delete_test( sanitize_file_name( wp_unslash( $_POST['test_file'] ) ) );
return;
}
}
/**
* Handle test connection action.
*
* @since 0.3.0
*
* @return void
*/
private function handle_test_connection(): void {
// Check rate limit.
if ( $this->rate_limiter->is_rate_limited( 'test_connection', 60 ) ) {
$remaining = $this->rate_limiter->get_remaining_time( 'test_connection', 60 );
set_transient(
'idrivee2_test_result',
array(
'type' => 'error',
'message' => sprintf(
/* translators: %d is the number of seconds to wait. */
__( 'Please wait %d seconds before testing again.', 'idrivee2-media-upload' ),
$remaining
),
),
30
);
wp_safe_redirect( admin_url( 'options-general.php?page=idrivee2-media-upload' ) );
exit;
}
if ( ! $this->config->is_configured() ) {
$this->logger->warning( 'Test connection attempted with incomplete configuration' );
set_transient(
'idrivee2_test_result',
array(
'type' => 'error',
'message' => __( 'Configuration is incomplete. Please check your settings.', 'idrivee2-media-upload' ),
),
30
);
wp_safe_redirect( admin_url( 'options-general.php?page=idrivee2-media-upload' ) );
exit;
}
// Record this action for rate limiting.
$this->rate_limiter->record_action( 'test_connection', 60 );
try {
$client = $this->client_factory->create();
$client->headBucket( array( 'Bucket' => $this->config->get_bucket() ) );
$this->logger->s3_operation( 'headBucket', true );
set_transient(
'idrivee2_test_result',
array(
'type' => 'success',
'message' => __( 'Connection successful! Your S3 configuration is working correctly.', 'idrivee2-media-upload' ),
),
30
);
} catch ( \Aws\Exception\AwsException $e ) {
$this->logger->s3_operation( 'headBucket', false, '', $e->getAwsErrorMessage() ?? '' );
set_transient(
'idrivee2_test_result',
array(
'type' => 'error',
'message' => sprintf(
/* translators: %s is the error message from AWS. */
__( 'AWS Error: %s', 'idrivee2-media-upload' ),
$e->getAwsErrorMessage() ?? __( 'Unknown error', 'idrivee2-media-upload' )
),
),
30
);
} catch ( \Exception $e ) {
$this->logger->error( 'Test connection failed: ' . $e->getMessage() );
set_transient(
'idrivee2_test_result',
array(
'type' => 'error',
'message' => sprintf(
/* translators: %s is the error message. */
__( 'Error: %s', 'idrivee2-media-upload' ),
$e->getMessage()
),
),
30
);
}
wp_safe_redirect( admin_url( 'options-general.php?page=idrivee2-media-upload' ) );
exit;
}
/**
* Handle upload test file action.
*
* @since 0.3.0
*
* @return void
*/
private function handle_upload_test(): void {
// Check rate limit.
if ( $this->rate_limiter->is_rate_limited( 'upload_test', 60 ) ) {
$remaining = $this->rate_limiter->get_remaining_time( 'upload_test', 60 );
set_transient(
'idrivee2_test_result',
array(
'type' => 'error',
'message' => sprintf(
/* translators: %d is the number of seconds to wait. */
__( 'Please wait %d seconds before uploading again.', 'idrivee2-media-upload' ),
$remaining
),
),
30
);
wp_safe_redirect( admin_url( 'options-general.php?page=idrivee2-media-upload' ) );
exit;
}
// Record this action for rate limiting.
$this->rate_limiter->record_action( 'upload_test', 60 );
try {
// Generate timestamp for filename (YYYYMMDDHHMMSS).
$timestamp = gmdate( 'YmdHis' );
$file_name = 'test-' . $timestamp . '.txt';
// Create file content.
$content = 'Test file uploaded at ' . gmdate( 'Y-m-d H:i:s' ) . ' UTC';
// Initialize the S3 client.
$client = $this->client_factory->create();
// Upload to S3.
$result = $client->putObject(
array(
'Bucket' => $this->config->get_bucket(),
'Key' => $file_name,
'Body' => $content,
'ACL' => 'public-read',
)
);
// Log successful upload.
$this->logger->s3_operation( 'putObject', true, $file_name );
// Get the public URL - use CDN domain if configured, otherwise S3 ObjectURL.
$object_url = $this->get_public_url( $file_name, $result['ObjectURL'] ?? '' );
set_transient(
'idrivee2_test_result',
array(
'type' => 'success',
'message' => __( 'File uploaded successfully!', 'idrivee2-media-upload' ),
'file_name' => $file_name,
'object_url' => $object_url,
),
30
);
} catch ( \Aws\Exception\AwsException $e ) {
$this->logger->s3_operation( 'putObject', false, $file_name, $e->getAwsErrorMessage() ?? '' );
set_transient(
'idrivee2_test_result',
array(
'type' => 'error',
'message' => sprintf(
/* translators: %s is the error message from AWS. */
__( 'AWS Error: %s', 'idrivee2-media-upload' ),
$e->getAwsErrorMessage() ?? __( 'Unknown error', 'idrivee2-media-upload' )
),
),
30
);
} catch ( \Exception $e ) {
$this->logger->error( 'Test upload failed: ' . $e->getMessage() );
set_transient(
'idrivee2_test_result',
array(
'type' => 'error',
'message' => sprintf(
/* translators: %s is the error message. */
__( 'Error: %s', 'idrivee2-media-upload' ),
$e->getMessage()
),
),
30
);
}
wp_safe_redirect( admin_url( 'options-general.php?page=idrivee2-media-upload' ) );
exit;
}
/**
* Get the public URL for an uploaded file.
*
* Uses CDN domain if configured, otherwise falls back to S3 ObjectURL.
*
* @since 0.3.0
*
* @param string $file_name The file name/key in S3.
* @param string $object_url The S3 ObjectURL returned by AWS SDK.
* @return string The public URL to access the file.
*/
private function get_public_url( string $file_name, string $object_url ): string {
// If custom domain is configured, use it.
if ( $this->config->has_domain() ) {
return trailingslashit( $this->config->get_domain() ) . $file_name;
}
// Otherwise, use the S3 ObjectURL.
return $object_url;
}
/**
* Handle delete test file action.
*
* @since 0.3.0
*
* @param string $file_name The test file name to delete.
* @return void
*/
private function handle_delete_test( string $file_name ): void {
// Validate file name pattern (must be test-YYYYMMDDHHMMSS.txt).
if ( ! preg_match( '/^test-\d{14}\.txt$/', $file_name ) ) {
$this->logger->warning( 'Invalid test file name format attempted: ' . $file_name );
set_transient(
'idrivee2_test_result',
array(
'type' => 'error',
'message' => __( 'Invalid test file name format.', 'idrivee2-media-upload' ),
),
30
);
wp_safe_redirect( admin_url( 'options-general.php?page=idrivee2-media-upload' ) );
exit;
}
try {
// Initialize the S3 client.
$client = $this->client_factory->create();
// Delete object from S3.
$client->deleteObject(
array(
'Bucket' => $this->config->get_bucket(),
'Key' => $file_name,
)
);
// Log successful deletion.
$this->logger->s3_operation( 'deleteObject', true, $file_name );
set_transient(
'idrivee2_test_result',
array(
'type' => 'info',
'message' => sprintf(
/* translators: %s is the file name. */
__( 'File %s deleted successfully.', 'idrivee2-media-upload' ),
'<code>' . esc_html( $file_name ) . '</code>'
),
),
30
);
} catch ( \Aws\Exception\AwsException $e ) {
$this->logger->s3_operation( 'deleteObject', false, $file_name, $e->getAwsErrorMessage() ?? '' );
set_transient(
'idrivee2_test_result',
array(
'type' => 'error',
'message' => sprintf(
/* translators: %s is the error message from AWS. */
__( 'AWS Error: %s', 'idrivee2-media-upload' ),
$e->getAwsErrorMessage() ?? __( 'Unknown error', 'idrivee2-media-upload' )
),
),
30
);
} catch ( \Exception $e ) {
$this->logger->error( 'Test file deletion failed: ' . $e->getMessage() );
set_transient(
'idrivee2_test_result',
array(
'type' => 'error',
'message' => sprintf(
/* translators: %s is the error message. */
__( 'Error: %s', 'idrivee2-media-upload' ),
$e->getMessage()
),
),
30
);
}
wp_safe_redirect( admin_url( 'options-general.php?page=idrivee2-media-upload' ) );
exit;
}
/**
* Sanitize settings before saving.
*
* @since 0.3.0
*
* @param array<string, string> $input Input settings.
* @return array<string, string> Sanitized settings.
*/
public function sanitize_settings( array $input ): array {
$sanitized = array();
// Sanitize host.
if ( isset( $input['host'] ) ) {
$sanitized['host'] = sanitize_text_field( $input['host'] );
// Validate that host starts with https://.
if ( ! empty( $sanitized['host'] ) && ! str_starts_with( $sanitized['host'], 'https://' ) ) {
add_settings_error(
'idrivee2_media_settings',
'invalid_host',
__( 'Host URL must start with "https://".', 'idrivee2-media-upload' )
);
}
}
// Sanitize other fields.
$sanitized['key'] = isset( $input['key'] ) ? sanitize_text_field( $input['key'] ) : '';
$sanitized['secret'] = isset( $input['secret'] ) ? sanitize_text_field( $input['secret'] ) : '';
$sanitized['bucket'] = isset( $input['bucket'] ) ? sanitize_text_field( $input['bucket'] ) : '';
$sanitized['region'] = isset( $input['region'] ) ? sanitize_text_field( $input['region'] ) : '';
$sanitized['domain'] = isset( $input['domain'] ) ? sanitize_text_field( $input['domain'] ) : '';
return $sanitized;
}
/**
* Enqueue the admin JavaScript for enhanced UX.
*
* Loads the iDrivee2 admin script on the Settings → iDrivee2 page.
*
* @since 0.3.0
*
* @param string $hook The current admin page hook suffix.
* @return void
*/
public function enqueue_admin_scripts( string $hook ): void {
// Only load script on our settings page.
if ( 'settings_page_idrivee2-media-upload' !== $hook ) {
return;
}
wp_enqueue_script(
'idrivee2-media-admin',
plugin_dir_url( $this->plugin_file ) . 'assets/js/admin.js',
array( 'jquery' ),
'0.3.0',
true
);
}
/**
* Render the iDrivee2 Media Upload settings page.
*
* Displays configuration form with fields for S3 settings. Fields are
* read-only if values are defined in wp-config.php.
*
* @since 0.3.0
*
* @return void
*/
public function render_settings_page(): void {
$host = $this->config->get_host();
$access_key = $this->config->get_key();
$secret = $this->config->get_secret();
$bucket = $this->config->get_bucket();
$region = $this->config->get_region();
$domain = $this->config->get_domain();
$is_configured = $this->config->is_configured();
// Check which fields are defined in wp-config.php.
$host_in_config = $this->config->is_defined_in_wp_config( 'host' );
$key_in_config = $this->config->is_defined_in_wp_config( 'key' );
$secret_in_config = $this->config->is_defined_in_wp_config( 'secret' );
$bucket_in_config = $this->config->is_defined_in_wp_config( 'bucket' );
$region_in_config = $this->config->is_defined_in_wp_config( 'region' );
$domain_in_config = $this->config->is_defined_in_wp_config( 'domain' );
$any_in_config = $host_in_config || $key_in_config || $secret_in_config || $bucket_in_config || $region_in_config || $domain_in_config;
?>
<div class="wrap">
<h1><?php esc_html_e( 'iDrivee2 Media Upload Settings', 'idrivee2-media-upload' ); ?></h1>
<?php settings_errors(); ?>
<?php if ( $any_in_config ) : ?>
<div class="notice notice-info">
<p><?php esc_html_e( 'Some settings are defined in wp-config.php and cannot be changed here. These fields are shown as read-only.', 'idrivee2-media-upload' ); ?></p>
</div>
<?php endif; ?>
<form method="post" action="options.php">
<?php settings_fields( 'idrivee2_media_settings_group' ); ?>
<table class="form-table" role="presentation">
<tbody>
<tr>
<th scope="row">
<label for="idrivee2_host"><?php esc_html_e( 'S3 Host', 'idrivee2-media-upload' ); ?></label>
</th>
<td>
<input
type="url"
id="idrivee2_host"
name="idrivee2_media_settings[host]"
value="<?php echo esc_attr( $host ); ?>"
class="regular-text"
<?php echo $host_in_config ? 'readonly' : ''; ?>
<?php echo ! $host_in_config ? 'required' : ''; ?>
/>
<p class="description">
<?php
if ( $host_in_config ) {
esc_html_e( 'Defined in wp-config.php (IDRIVEE2_MEDIA_HOST)', 'idrivee2-media-upload' );
} else {
esc_html_e( 'S3-compatible endpoint URL. Must start with "https://".', 'idrivee2-media-upload' );
}
?>
</p>
</td>
</tr>
<tr>
<th scope="row">
<label for="idrivee2_key"><?php esc_html_e( 'Access Key ID', 'idrivee2-media-upload' ); ?></label>
</th>
<td>
<input
type="text"
id="idrivee2_key"
name="idrivee2_media_settings[key]"
value="<?php echo esc_attr( $access_key ); ?>"
class="regular-text"
<?php echo $key_in_config ? 'readonly' : ''; ?>
<?php echo ! $key_in_config ? 'required' : ''; ?>
/>
<p class="description">
<?php
if ( $key_in_config ) {
esc_html_e( 'Defined in wp-config.php (IDRIVEE2_MEDIA_KEY)', 'idrivee2-media-upload' );
} else {
esc_html_e( 'Your S3 access key ID.', 'idrivee2-media-upload' );
}
?>
</p>
</td>
</tr>
<tr>
<th scope="row">
<label for="idrivee2_secret"><?php esc_html_e( 'Secret Access Key', 'idrivee2-media-upload' ); ?></label>
</th>
<td>
<input
type="password"
id="idrivee2_secret"
name="idrivee2_media_settings[secret]"
value="<?php echo esc_attr( $secret ); ?>"
class="regular-text"
<?php echo $secret_in_config ? 'readonly' : ''; ?>
<?php echo ! $secret_in_config ? 'required' : ''; ?>
/>
<p class="description">
<?php
if ( $secret_in_config ) {
esc_html_e( 'Defined in wp-config.php (IDRIVEE2_MEDIA_SECRET)', 'idrivee2-media-upload' );
} else {
esc_html_e( 'Your S3 secret access key.', 'idrivee2-media-upload' );
}
?>
</p>
</td>
</tr>
<tr>
<th scope="row">
<label for="idrivee2_bucket"><?php esc_html_e( 'Bucket Name', 'idrivee2-media-upload' ); ?></label>
</th>
<td>
<input
type="text"
id="idrivee2_bucket"
name="idrivee2_media_settings[bucket]"
value="<?php echo esc_attr( $bucket ); ?>"
class="regular-text"
<?php echo $bucket_in_config ? 'readonly' : ''; ?>
<?php echo ! $bucket_in_config ? 'required' : ''; ?>
/>
<p class="description">
<?php
if ( $bucket_in_config ) {
esc_html_e( 'Defined in wp-config.php (IDRIVEE2_MEDIA_BUCKET)', 'idrivee2-media-upload' );
} else {
esc_html_e( 'The name of your S3 bucket.', 'idrivee2-media-upload' );
}
?>
</p>
</td>
</tr>
<tr>
<th scope="row">
<label for="idrivee2_region"><?php esc_html_e( 'Region', 'idrivee2-media-upload' ); ?></label>
</th>
<td>
<input
type="text"
id="idrivee2_region"
name="idrivee2_media_settings[region]"
value="<?php echo esc_attr( $region ); ?>"
class="regular-text"
placeholder="us-east-1"
<?php echo $region_in_config ? 'readonly' : ''; ?>
<?php echo ! $region_in_config ? 'required' : ''; ?>
/>
<p class="description">
<?php
if ( $region_in_config ) {
esc_html_e( 'Defined in wp-config.php (IDRIVEE2_MEDIA_REGION)', 'idrivee2-media-upload' );
} else {
esc_html_e( 'AWS region (e.g., us-east-1, eu-west-1).', 'idrivee2-media-upload' );
}
?>
</p>
</td>
</tr>
<tr>
<th scope="row">
<label for="idrivee2_domain"><?php esc_html_e( 'Custom CDN Domain', 'idrivee2-media-upload' ); ?></label>
</th>
<td>
<input
type="url"
id="idrivee2_domain"
name="idrivee2_media_settings[domain]"
value="<?php echo esc_attr( $domain ); ?>"
class="regular-text"
placeholder="https://cdn.example.com"
<?php echo $domain_in_config ? 'readonly' : ''; ?>
/>
<p class="description">
<?php
if ( $domain_in_config ) {
esc_html_e( 'Defined in wp-config.php (IDRIVEE2_MEDIA_DOMAIN)', 'idrivee2-media-upload' );
} else {
esc_html_e( 'Optional: Custom domain for serving media files.', 'idrivee2-media-upload' );
}
?>
</p>
</td>
</tr>
</tbody>
</table>
<?php if ( ! $any_in_config ) : ?>
<?php submit_button( __( 'Save Settings', 'idrivee2-media-upload' ) ); ?>
<?php else : ?>
<p class="description">
<?php esc_html_e( 'To modify settings defined in wp-config.php, please edit your wp-config.php file directly.', 'idrivee2-media-upload' ); ?>
</p>
<?php
// Show submit button only if at least one field can be edited.
$can_edit = ! $host_in_config || ! $key_in_config || ! $secret_in_config || ! $bucket_in_config || ! $region_in_config || ! $domain_in_config;
if ( $can_edit ) :
?>
<?php submit_button( __( 'Save Settings', 'idrivee2-media-upload' ) ); ?>
<?php endif; ?>
<?php endif; ?>
</form>
<?php if ( $is_configured ) : ?>
<hr />
<h2><?php esc_html_e( 'Test Connection', 'idrivee2-media-upload' ); ?></h2>
<p><?php esc_html_e( 'Test your S3 configuration to ensure everything is working correctly.', 'idrivee2-media-upload' ); ?></p>
<?php
// Display test results if available.
$test_result = get_transient( 'idrivee2_test_result' );
if ( $test_result ) {
delete_transient( 'idrivee2_test_result' );
$notice_class = 'notice-' . $test_result['type'];
?>
<div class="notice <?php echo esc_attr( $notice_class ); ?>">
<p><strong><?php echo wp_kses_post( $test_result['message'] ); ?></strong></p>
<?php if ( isset( $test_result['file_name'] ) && isset( $test_result['object_url'] ) ) : ?>
<p>
<?php
printf(
/* translators: %s is the file name. */
esc_html__( 'File: %s', 'idrivee2-media-upload' ),
'<code>' . esc_html( $test_result['file_name'] ) . '</code>'
);
?>
</p>
<p>
<?php esc_html_e( 'URL:', 'idrivee2-media-upload' ); ?>
<a href="<?php echo esc_url( $test_result['object_url'] ); ?>" target="_blank" rel="noopener noreferrer">
<?php echo esc_html( $test_result['object_url'] ); ?>
</a>
</p>
<form method="post" action="" style="margin-top: 10px;">
<?php wp_nonce_field( 'idrivee2_delete_test' ); ?>
<input type="hidden" name="test_file" value="<?php echo esc_attr( $test_result['file_name'] ); ?>" />
<button type="submit" name="idrivee2_delete_test" class="button button-small">
<?php esc_html_e( 'Delete this file', 'idrivee2-media-upload' ); ?>
</button>
</form>
<?php endif; ?>
</div>
<?php
}
?>
<table class="form-table" role="presentation">
<tbody>
<tr>
<th scope="row"><?php esc_html_e( 'Test Connection', 'idrivee2-media-upload' ); ?></th>
<td>
<form method="post" action="">
<?php wp_nonce_field( 'idrivee2_test_connection' ); ?>
<button type="submit" name="idrivee2_test_connection" class="button button-primary">
<?php esc_html_e( 'Test S3 Connection', 'idrivee2-media-upload' ); ?>
</button>
<p class="description">
<?php esc_html_e( 'Verify that your S3 bucket is accessible with the configured credentials.', 'idrivee2-media-upload' ); ?>
</p>
</form>
</td>
</tr>
<tr>
<th scope="row"><?php esc_html_e( 'Upload Test File', 'idrivee2-media-upload' ); ?></th>
<td>
<form method="post" action="">
<?php wp_nonce_field( 'idrivee2_upload_test' ); ?>
<button type="submit" name="idrivee2_upload_test" class="button button-secondary">
<?php esc_html_e( 'Upload Test File', 'idrivee2-media-upload' ); ?>
</button>
<p class="description">
<?php esc_html_e( 'Upload a test file to S3 with a timestamped name (test-YYYYMMDDHHMMSS.txt). The file will remain in S3 until manually deleted.', 'idrivee2-media-upload' ); ?>
</p>
</form>
</td>
</tr>
</tbody>
</table>
<?php endif; ?>
</div>
<?php
}
}

250
includes/class-config.php Normal file
View file

@ -0,0 +1,250 @@
<?php
/**
* Configuration handler for iDrivee2 Media Upload.
*
* @package iDrivee2Media
* @since 0.3.0
*/
declare(strict_types=1);
namespace iDrivee2Media;
/**
* Prevent direct access to this file.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Configuration validator and accessor for iDrivee2 constants.
*
* Validates and provides access to the five required configuration constants
* and the optional CDN domain constant. Configuration can come from either
* wp-config.php constants (priority) or WordPress options.
*
* @since 0.3.0
*/
class Config {
/**
* Required configuration keys.
*
* @var array<string>
*/
private const REQUIRED_KEYS = array(
'host',
'key',
'secret',
'bucket',
'region',
);
/**
* WordPress option name for settings.
*
* @var string
*/
private const OPTION_NAME = 'idrivee2_media_settings';
/**
* Logger instance.
*
* @var Logger|null
*/
private $logger;
/**
* Constructor.
*
* @since 0.3.1
*
* @param Logger|null $logger Optional logger instance.
*/
public function __construct( ?Logger $logger = null ) {
$this->logger = $logger;
}
/**
* Check if all required configuration values are available.
*
* Checks both wp-config.php constants and WordPress options.
*
* @since 0.3.0
*
* @return bool True if all required values are available, false otherwise.
*/
public function is_configured(): bool {
foreach ( self::REQUIRED_KEYS as $key ) {
$value = $this->get_value( $key );
if ( empty( $value ) ) {
return false;
}
}
return true;
}
/**
* Check if a configuration key is defined in wp-config.php.
*
* @since 0.3.0
*
* @param string $key Configuration key (host, key, secret, bucket, region, domain).
* @return bool True if defined in wp-config.php, false otherwise.
*/
public function is_defined_in_wp_config( string $key ): bool {
$constant_map = array(
'host' => 'IDRIVEE2_MEDIA_HOST',
'key' => 'IDRIVEE2_MEDIA_KEY',
'secret' => 'IDRIVEE2_MEDIA_SECRET',
'bucket' => 'IDRIVEE2_MEDIA_BUCKET',
'region' => 'IDRIVEE2_MEDIA_REGION',
'domain' => 'IDRIVEE2_MEDIA_DOMAIN',
);
$constant_name = $constant_map[ $key ] ?? '';
return $constant_name && defined( $constant_name );
}
/**
* Get a configuration value.
*
* Priority: wp-config.php constants first, then WordPress options.
*
* @since 0.3.0
*
* @param string $key Configuration key (host, key, secret, bucket, region, domain).
* @return string The configuration value, or empty string if not set.
*/
private function get_value( string $key ): string {
$constant_map = array(
'host' => 'IDRIVEE2_MEDIA_HOST',
'key' => 'IDRIVEE2_MEDIA_KEY',
'secret' => 'IDRIVEE2_MEDIA_SECRET',
'bucket' => 'IDRIVEE2_MEDIA_BUCKET',
'region' => 'IDRIVEE2_MEDIA_REGION',
'domain' => 'IDRIVEE2_MEDIA_DOMAIN',
);
// Check wp-config.php constant first (highest priority).
$constant_name = $constant_map[ $key ] ?? '';
if ( $constant_name && defined( $constant_name ) ) {
return (string) constant( $constant_name );
}
// Fall back to WordPress option.
$options = get_option( self::OPTION_NAME, array() );
return isset( $options[ $key ] ) ? (string) $options[ $key ] : '';
}
/**
* Get the S3 endpoint host URL.
*
* @since 0.3.0
*
* @return string The S3 endpoint URL.
*/
public function get_host(): string {
return $this->get_value( 'host' );
}
/**
* Get the S3 access key ID.
*
* @since 0.3.0
*
* @return string The access key ID.
*/
public function get_key(): string {
return $this->get_value( 'key' );
}
/**
* Get the S3 secret access key.
*
* @since 0.3.0
*
* @return string The secret access key.
*/
public function get_secret(): string {
return $this->get_value( 'secret' );
}
/**
* Get the S3 bucket name.
*
* @since 0.3.0
*
* @return string The bucket name.
*/
public function get_bucket(): string {
return $this->get_value( 'bucket' );
}
/**
* Get the AWS region.
*
* @since 0.3.0
*
* @return string The AWS region.
*/
public function get_region(): string {
return $this->get_value( 'region' );
}
/**
* Get the custom CDN domain, if defined.
*
* @since 0.3.0
*
* @return string The custom domain, or empty string if not defined.
*/
public function get_domain(): string {
return $this->get_value( 'domain' );
}
/**
* Check if a custom CDN domain is defined.
*
* @since 0.3.0
*
* @return bool True if domain is defined and non-empty.
*/
public function has_domain(): bool {
return ! empty( $this->get_domain() );
}
/**
* Update configuration options in WordPress database.
*
* @since 0.3.0
*
* @param array<string, string> $data Configuration data to save.
* @return bool True on success, false on failure.
*/
public function update_options( array $data ): bool {
// Get current options for comparison.
$old_options = get_option( self::OPTION_NAME, array() );
// Validate and sanitize data.
$options = array(
'host' => isset( $data['host'] ) ? sanitize_text_field( $data['host'] ) : '',
'key' => isset( $data['key'] ) ? sanitize_text_field( $data['key'] ) : '',
'secret' => isset( $data['secret'] ) ? sanitize_text_field( $data['secret'] ) : '',
'bucket' => isset( $data['bucket'] ) ? sanitize_text_field( $data['bucket'] ) : '',
'region' => isset( $data['region'] ) ? sanitize_text_field( $data['region'] ) : '',
'domain' => isset( $data['domain'] ) ? sanitize_text_field( $data['domain'] ) : '',
);
// Log configuration changes.
if ( $this->logger ) {
foreach ( $options as $key => $new_value ) {
$old_value = isset( $old_options[ $key ] ) ? $old_options[ $key ] : '';
if ( $old_value !== $new_value ) {
$this->logger->config_change( $key, $old_value, $new_value );
}
}
}
return update_option( self::OPTION_NAME, $options );
}
}

334
includes/class-logger.php Normal file
View file

@ -0,0 +1,334 @@
<?php
/**
* Security Logger for iDrivee2 Media Upload.
*
* @package iDrivee2Media
* @since 0.3.1
*/
declare(strict_types=1);
namespace iDrivee2Media;
/**
* Prevent direct access to this file.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Security and operational logger.
*
* Logs security events, configuration changes, S3 operations, and errors
* using WordPress debug.log when WP_DEBUG_LOG is enabled.
*
* @since 0.3.1
*/
class Logger {
/**
* Log levels.
*/
private const LEVEL_INFO = 'INFO';
private const LEVEL_WARNING = 'WARNING';
private const LEVEL_ERROR = 'ERROR';
private const LEVEL_SECURITY = 'SECURITY';
/**
* Check if logging is enabled.
*
* @since 0.3.1
*
* @return bool True if WP_DEBUG_LOG is enabled.
*/
private function is_enabled(): bool {
return defined( 'WP_DEBUG_LOG' ) && WP_DEBUG_LOG;
}
/**
* Write a log entry.
*
* @since 0.3.1
*
* @param string $level Log level (INFO, WARNING, ERROR, SECURITY).
* @param string $message Log message.
* @param array<string, mixed> $context Additional context data.
* @return void
*/
private function log( string $level, string $message, array $context = array() ): void {
if ( ! $this->is_enabled() ) {
return;
}
$user_id = get_current_user_id();
$user_info = $user_id ? get_userdata( $user_id ) : null;
$username = $user_info ? $user_info->user_login : 'anonymous';
$log_entry = sprintf(
'[iDrivee2] [%s] [User: %s] %s',
$level,
$username,
$message
);
// Add context if provided.
if ( ! empty( $context ) ) {
$log_entry .= ' | Context: ' . wp_json_encode( $context );
}
// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
error_log( $log_entry );
}
/**
* Log an info message.
*
* @since 0.3.1
*
* @param string $message Log message.
* @param array<string, mixed> $context Additional context data.
* @return void
*/
public function info( string $message, array $context = array() ): void {
$this->log( self::LEVEL_INFO, $message, $context );
}
/**
* Log a warning message.
*
* @since 0.3.1
*
* @param string $message Log message.
* @param array<string, mixed> $context Additional context data.
* @return void
*/
public function warning( string $message, array $context = array() ): void {
$this->log( self::LEVEL_WARNING, $message, $context );
}
/**
* Log an error message.
*
* @since 0.3.1
*
* @param string $message Log message.
* @param array<string, mixed> $context Additional context data.
* @return void
*/
public function error( string $message, array $context = array() ): void {
$this->log( self::LEVEL_ERROR, $message, $context );
}
/**
* Log a security event.
*
* @since 0.3.1
*
* @param string $message Log message.
* @param array<string, mixed> $context Additional context data.
* @return void
*/
public function security( string $message, array $context = array() ): void {
$this->log( self::LEVEL_SECURITY, $message, $context );
}
/**
* Log a configuration change.
*
* @since 0.3.1
*
* @param string $field Configuration field that changed.
* @param string $old_value Old value (masked if sensitive).
* @param string $new_value New value (masked if sensitive).
* @return void
*/
public function config_change( string $field, string $old_value, string $new_value ): void {
// Mask sensitive fields.
$sensitive_fields = array( 'secret', 'key' );
if ( in_array( $field, $sensitive_fields, true ) ) {
$old_value = $this->mask_value( $old_value );
$new_value = $this->mask_value( $new_value );
}
$this->security(
sprintf( 'Configuration changed: %s', $field ),
array(
'field' => $field,
'old_value' => $old_value,
'new_value' => $new_value,
)
);
}
/**
* Log an S3 operation.
*
* @since 0.3.1
*
* @param string $operation Operation type (upload, delete, headBucket, etc.).
* @param bool $success Whether the operation succeeded.
* @param string $file_name Optional file name.
* @param string $error Optional error message.
* @return void
*/
public function s3_operation( string $operation, bool $success, string $file_name = '', string $error = '' ): void {
$level = $success ? self::LEVEL_INFO : self::LEVEL_ERROR;
$message = sprintf(
'S3 %s %s',
$operation,
$success ? 'succeeded' : 'failed'
);
$context = array(
'operation' => $operation,
'success' => $success,
);
if ( $file_name ) {
$context['file'] = $file_name;
}
if ( $error ) {
$context['error'] = $error;
}
$this->log( $level, $message, $context );
// Track operation count.
$this->track_s3_operation( $operation );
}
/**
* Log an authentication failure.
*
* @since 0.3.1
*
* @param string $reason Reason for authentication failure.
* @return void
*/
public function auth_failure( string $reason ): void {
$this->security(
'Authentication failure: ' . $reason,
array(
'ip' => $this->get_client_ip(),
'user_agent' => isset( $_SERVER['HTTP_USER_AGENT'] ) ? sanitize_text_field( wp_unslash( $_SERVER['HTTP_USER_AGENT'] ) ) : '',
)
);
}
/**
* Log a rate limit violation.
*
* @since 0.3.1
*
* @param string $action Action that was rate limited.
* @return void
*/
public function rate_limit_exceeded( string $action ): void {
$this->security(
'Rate limit exceeded: ' . $action,
array(
'action' => $action,
'ip' => $this->get_client_ip(),
)
);
}
/**
* Get client IP address.
*
* @since 0.3.1
*
* @return string Client IP address.
*/
private function get_client_ip(): string {
$ip = '';
if ( isset( $_SERVER['REMOTE_ADDR'] ) ) {
$ip = sanitize_text_field( wp_unslash( $_SERVER['REMOTE_ADDR'] ) );
}
return $ip;
}
/**
* Mask a sensitive value.
*
* @since 0.3.1
*
* @param string $value Value to mask.
* @return string Masked value.
*/
private function mask_value( string $value ): string {
$length = strlen( $value );
if ( $length <= 4 ) {
return str_repeat( '*', $length );
}
// Show first 2 and last 2 characters.
return substr( $value, 0, 2 ) . str_repeat( '*', $length - 4 ) . substr( $value, -2 );
}
/**
* Track S3 operation count.
*
* @since 0.3.1
*
* @param string $operation Operation type.
* @return void
*/
private function track_s3_operation( string $operation ): void {
$option_key = 'idrivee2_s3_operations';
$stats = get_option( $option_key, array() );
// Initialize stats for today if not exists.
$today = gmdate( 'Y-m-d' );
if ( ! isset( $stats[ $today ] ) ) {
$stats[ $today ] = array();
}
if ( ! isset( $stats[ $today ][ $operation ] ) ) {
$stats[ $today ][ $operation ] = 0;
}
++$stats[ $today ][ $operation ];
// Keep only last 30 days.
$cutoff_date = gmdate( 'Y-m-d', strtotime( '-30 days' ) );
foreach ( array_keys( $stats ) as $date ) {
if ( $date < $cutoff_date ) {
unset( $stats[ $date ] );
}
}
update_option( $option_key, $stats );
}
/**
* Get S3 operation statistics.
*
* @since 0.3.1
*
* @param int $days Number of days to retrieve (default 7, max 30).
* @return array<string, array<string, int>> Statistics array indexed by date and operation.
*/
public function get_s3_stats( int $days = 7 ): array {
$days = min( $days, 30 );
$stats = get_option( 'idrivee2_s3_operations', array() );
$result = array();
for ( $i = 0; $i < $days; $i++ ) {
$timestamp = strtotime( "-$i days" );
if ( false === $timestamp ) {
continue;
}
$date = gmdate( 'Y-m-d', $timestamp );
if ( isset( $stats[ $date ] ) ) {
$result[ $date ] = $stats[ $date ];
}
}
return $result;
}
}

View file

@ -0,0 +1,213 @@
<?php
/**
* Media Uploader for iDrivee2 Media Upload.
*
* @package iDrivee2Media
* @since 0.3.0
*/
declare(strict_types=1);
namespace iDrivee2Media;
/**
* Prevent direct access to this file.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Media uploader for handling file uploads to iDrivee2.
*
* Uploads attachment files and all generated sizes to S3, deletes local copies,
* and updates the attachment GUID to point to the S3 URL.
*
* @since 0.3.0
*/
class Media_Uploader {
/**
* Configuration instance.
*
* @var Config
*/
private $config;
/**
* S3 client factory.
*
* @var S3_Client_Factory
*/
private $client_factory;
/**
* Logger instance.
*
* @var Logger
*/
private $logger;
/**
* Constructor.
*
* @since 0.3.0
*
* @param Config $config Configuration instance.
* @param S3_Client_Factory $client_factory S3 client factory.
* @param Logger $logger Logger instance.
*/
public function __construct( Config $config, S3_Client_Factory $client_factory, Logger $logger ) {
$this->config = $config;
$this->client_factory = $client_factory;
$this->logger = $logger;
}
/**
* Register hooks for media upload handling.
*
* @since 0.3.0
*
* @return void
*/
public function register(): void {
add_filter( 'wp_generate_attachment_metadata', array( $this, 'upload_attachment_to_idrivee2' ), 10, 2 );
add_filter( 'wp_update_attachment_metadata', array( $this, 'upload_attachment_to_idrivee2' ), 10, 2 );
add_action( 'edit_attachment', array( $this, 'handle_edit_attachment' ) );
}
/**
* Uploads attachment files to iDrivee2 after sizes are generated.
*
* This function pushes the original file and all generated sizes to the
* configured S3-compatible host, captures the returned ObjectURL for the
* original file, deletes the local copies, updates the attachment's GUID,
* and filters the front-end URL to use the S3 ObjectURL.
*
* @since 0.3.0
*
* @param array<string, mixed> $meta Attachment metadata, including 'file' and 'sizes'.
* @param int $attachment_id Attachment post ID.
* @return array<string, mixed> Unchanged metadata array.
*/
public function upload_attachment_to_idrivee2( array $meta, int $attachment_id ): array {
// Bail if configuration is incomplete.
if ( ! $this->config->is_configured() ) {
return $meta;
}
// Initialize the S3 client.
$client = $this->client_factory->create();
// Build list of files: original + each image size.
$upload_dir = wp_upload_dir();
$base_path = path_join( $upload_dir['basedir'], $meta['file'] );
$files = array(
'original' => $base_path,
);
if ( ! empty( $meta['sizes'] ) && is_array( $meta['sizes'] ) ) {
foreach ( $meta['sizes'] as $size ) {
$files[ $size['file'] ] = path_join( dirname( $base_path ), $size['file'] );
}
}
$object_url = '';
// Load and initialise WP_Filesystem.
if ( ! function_exists( 'WP_Filesystem' ) ) {
require_once ABSPATH . 'wp-admin/includes/file.php';
}
WP_Filesystem();
global $wp_filesystem;
// Upload each file via WP_Filesystem.
foreach ( $files as $key => $local_path ) {
// Skip if file doesn't exist.
if ( ! $wp_filesystem->exists( $local_path ) ) {
$this->logger->warning( 'Media file not found', array( 'path' => $local_path ) );
continue;
}
// Determine S3 object key.
$object_key = ( 'original' === $key )
? $meta['file']
: dirname( $meta['file'] ) . '/' . $key;
// Retrieve file contents via WP_Filesystem.
$content = $wp_filesystem->get_contents( $local_path );
if ( false === $content ) {
// Skip this file if it can't be read.
$this->logger->error( 'Failed to read media file', array( 'path' => $local_path ) );
continue;
}
// Upload to S3 from memory.
try {
$result = $client->putObject(
array(
'Bucket' => $this->config->get_bucket(),
'Key' => $object_key,
'Body' => $content,
'ACL' => 'public-read',
)
);
// Log successful upload.
$this->logger->s3_operation( 'putObject', true, basename( $object_key ) );
// Capture the ObjectURL for the original image.
if ( 'original' === $key && ! empty( $result['ObjectURL'] ) ) {
$object_url = $result['ObjectURL'];
}
// Delete local file via WP_Filesystem.
$wp_filesystem->delete( $local_path );
} catch ( \Aws\Exception\AwsException $e ) {
// Log failed upload.
$this->logger->s3_operation( 'putObject', false, basename( $object_key ), $e->getAwsErrorMessage() ?? '' );
// Continue to next file on error.
continue;
}
}
// Preserve relative path in database.
update_post_meta( $attachment_id, '_wp_attached_file', $meta['file'] );
if ( $object_url ) {
// Update the GUID in wp_posts to the S3 URL.
wp_update_post(
array(
'ID' => $attachment_id,
'guid' => $object_url,
)
);
// Override front-end URL to use the S3 ObjectURL.
add_filter(
'wp_get_attachment_url',
function ( string $url, int $id ) use ( $object_url, $attachment_id ): string {
return ( $id === $attachment_id ) ? $object_url : $url;
},
10,
2
);
}
return $meta;
}
/**
* Handle edit_attachment action as a fallback.
*
* @since 0.3.0
*
* @param int $post_id Attachment post ID.
* @return void
*/
public function handle_edit_attachment( int $post_id ): void {
$meta = wp_get_attachment_metadata( $post_id );
if ( $meta ) {
$this->upload_attachment_to_idrivee2( $meta, $post_id );
}
}
}

164
includes/class-plugin.php Normal file
View file

@ -0,0 +1,164 @@
<?php
/**
* Main Plugin class for iDrivee2 Media Upload.
*
* @package iDrivee2Media
* @since 0.3.0
*/
declare(strict_types=1);
namespace iDrivee2Media;
/**
* Prevent direct access to this file.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Main plugin orchestrator (singleton).
*
* Coordinates all plugin components with dependency injection and manages
* the plugin lifecycle.
*
* @since 0.3.0
*/
class Plugin {
/**
* Singleton instance.
*
* @var Plugin|null
*/
private static $instance = null;
/**
* Logger instance.
*
* @var Logger
*/
private $logger;
/**
* Rate limiter instance.
*
* @var Rate_Limiter
*/
private $rate_limiter;
/**
* Configuration instance.
*
* @var Config
*/
private $config;
/**
* S3 client factory.
*
* @var S3_Client_Factory
*/
private $client_factory;
/**
* Admin page handler.
*
* @var Admin_Page
*/
private $admin_page;
/**
* Media uploader.
*
* @var Media_Uploader
*/
private $media_uploader;
/**
* URL rewriter.
*
* @var URL_Rewriter
*/
private $url_rewriter;
/**
* Plugin file path.
*
* @var string
*/
private $plugin_file;
/**
* Private constructor (singleton pattern).
*
* @since 0.3.0
*
* @param string $plugin_file Path to the main plugin file.
*/
private function __construct( string $plugin_file ) {
$this->plugin_file = $plugin_file;
// Initialize logger and rate limiter.
$this->logger = new Logger();
$this->rate_limiter = new Rate_Limiter( $this->logger );
// Initialize configuration and factory.
$this->config = new Config( $this->logger );
$this->client_factory = new S3_Client_Factory( $this->config );
// Initialize components with dependency injection.
$this->admin_page = new Admin_Page( $this->config, $this->client_factory, $this->logger, $this->rate_limiter, $plugin_file );
$this->media_uploader = new Media_Uploader( $this->config, $this->client_factory, $this->logger );
$this->url_rewriter = new URL_Rewriter( $this->config );
}
/**
* Get the singleton instance.
*
* @since 0.3.0
*
* @param string $plugin_file Path to the main plugin file.
* @return Plugin The singleton instance.
*/
public static function get_instance( string $plugin_file ): Plugin {
if ( null === self::$instance ) {
self::$instance = new self( $plugin_file );
}
return self::$instance;
}
/**
* Initialize the plugin by registering all hooks.
*
* @since 0.3.0
*
* @return void
*/
public function init(): void {
// Load text domain for translations.
add_action( 'plugins_loaded', array( $this, 'load_textdomain' ), 20 );
// Register component hooks.
$this->admin_page->register();
$this->media_uploader->register();
$this->url_rewriter->register();
}
/**
* Load the plugin text domain for translations.
*
* Registers the plugin's text domain so that translation files in the
* /languages directory are loaded on the front end and in the admin.
*
* @since 0.3.0
*
* @return void
*/
public function load_textdomain(): void {
load_plugin_textdomain(
'idrivee2-media-upload',
false,
dirname( plugin_basename( $this->plugin_file ) ) . '/languages'
);
}
}

View file

@ -0,0 +1,154 @@
<?php
/**
* Rate Limiter for iDrivee2 Media Upload.
*
* @package iDrivee2Media
* @since 0.3.1
*/
declare(strict_types=1);
namespace iDrivee2Media;
/**
* Prevent direct access to this file.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Rate limiter for preventing abuse of test functions.
*
* Uses WordPress transients to track operation timestamps per user.
*
* @since 0.3.1
*/
class Rate_Limiter {
/**
* Logger instance.
*
* @var Logger
*/
private $logger;
/**
* Constructor.
*
* @since 0.3.1
*
* @param Logger $logger Logger instance.
*/
public function __construct( Logger $logger ) {
$this->logger = $logger;
}
/**
* Check if an action is rate limited.
*
* @since 0.3.1
*
* @param string $action Action identifier (e.g., 'test_connection', 'upload_test').
* @param int $seconds Minimum seconds between actions (default 60).
* @return bool True if rate limit exceeded, false if action is allowed.
*/
public function is_rate_limited( string $action, int $seconds = 60 ): bool {
$user_id = get_current_user_id();
// Users with manage_options capability have a more lenient rate limit (30 seconds instead of 60).
if ( current_user_can( 'manage_options' ) ) {
$seconds = max( 30, intval( $seconds / 2 ) );
}
$transient_key = $this->get_transient_key( $action, $user_id );
$last_time = get_transient( $transient_key );
if ( false === $last_time ) {
// No previous action, allow it.
return false;
}
$time_since_last = time() - $last_time;
if ( $time_since_last < $seconds ) {
// Rate limit exceeded.
$this->logger->rate_limit_exceeded( $action );
return true;
}
return false;
}
/**
* Record an action timestamp.
*
* @since 0.3.1
*
* @param string $action Action identifier.
* @param int $seconds Transient expiration time (default 60).
* @return void
*/
public function record_action( string $action, int $seconds = 60 ): void {
$user_id = get_current_user_id();
$transient_key = $this->get_transient_key( $action, $user_id );
set_transient( $transient_key, time(), $seconds );
}
/**
* Get remaining time until action is allowed.
*
* @since 0.3.1
*
* @param string $action Action identifier.
* @param int $seconds Minimum seconds between actions.
* @return int Seconds remaining, or 0 if action is allowed.
*/
public function get_remaining_time( string $action, int $seconds = 60 ): int {
$user_id = get_current_user_id();
// Users with manage_options capability have a more lenient rate limit.
if ( current_user_can( 'manage_options' ) ) {
$seconds = max( 30, intval( $seconds / 2 ) );
}
$transient_key = $this->get_transient_key( $action, $user_id );
$last_time = get_transient( $transient_key );
if ( false === $last_time ) {
return 0;
}
$time_since_last = time() - $last_time;
$remaining = $seconds - $time_since_last;
return (int) max( 0, $remaining );
}
/**
* Get transient key for user and action.
*
* @since 0.3.1
*
* @param string $action Action identifier.
* @param int $user_id User ID.
* @return string Transient key.
*/
private function get_transient_key( string $action, int $user_id ): string {
return sprintf( 'idrivee2_ratelimit_%s_%d', $action, $user_id );
}
/**
* Clear rate limit for a specific action.
*
* @since 0.3.1
*
* @param string $action Action identifier.
* @return void
*/
public function clear_limit( string $action ): void {
$user_id = get_current_user_id();
$transient_key = $this->get_transient_key( $action, $user_id );
delete_transient( $transient_key );
}
}

View file

@ -0,0 +1,66 @@
<?php
/**
* S3 Client Factory for iDrivee2 Media Upload.
*
* @package iDrivee2Media
* @since 0.3.0
*/
declare(strict_types=1);
namespace iDrivee2Media;
/**
* Prevent direct access to this file.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Factory for creating configured AWS S3 clients.
*
* Creates S3Client instances with the proper configuration from the Config class.
*
* @since 0.3.0
*/
class S3_Client_Factory {
/**
* Configuration instance.
*
* @var Config
*/
private $config;
/**
* Constructor.
*
* @since 0.3.0
*
* @param Config $config Configuration instance.
*/
public function __construct( Config $config ) {
$this->config = $config;
}
/**
* Create and return a configured S3Client instance.
*
* @since 0.3.0
*
* @return \Aws\S3\S3Client The configured S3 client.
*/
public function create(): \Aws\S3\S3Client {
return new \Aws\S3\S3Client(
array(
'version' => 'latest',
'region' => $this->config->get_region(),
'endpoint' => $this->config->get_host(),
'use_path_style_endpoint' => true,
'credentials' => array(
'key' => $this->config->get_key(),
'secret' => $this->config->get_secret(),
),
)
);
}
}

View file

@ -0,0 +1,98 @@
<?php
/**
* URL Rewriter for iDrivee2 Media Upload.
*
* @package iDrivee2Media
* @since 0.3.0
*/
declare(strict_types=1);
namespace iDrivee2Media;
/**
* Prevent direct access to this file.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* URL rewriter for serving media from iDrivee2 CDN.
*
* Rewrites WordPress media URLs to use the custom CDN domain when configured.
*
* @since 0.3.0
*/
class URL_Rewriter {
/**
* Configuration instance.
*
* @var Config
*/
private $config;
/**
* Constructor.
*
* @since 0.3.0
*
* @param Config $config Configuration instance.
*/
public function __construct( Config $config ) {
$this->config = $config;
}
/**
* Register hooks for URL rewriting.
*
* @since 0.3.0
*
* @return void
*/
public function register(): void {
add_filter( 'pre_option_upload_url_path', array( $this, 'filter_upload_url_path' ) );
add_filter( 'wp_get_attachment_url', array( $this, 'filter_attachment_url' ), 1, 2 );
}
/**
* Override the upload URL path with the configured iDrivee2 domain.
*
* If the IDRIVEE2_MEDIA_DOMAIN constant is defined and non-empty, this
* filter replaces the default uploads base URL so all new media items
* use the custom domain.
*
* @since 0.3.0
*
* @param string $value The original value of the upload_url_path option.
* @return string The upload_url_path, overridden to the custom domain when set.
*/
public function filter_upload_url_path( string $value ): string {
if ( $this->config->has_domain() ) {
return untrailingslashit( $this->config->get_domain() );
}
return $value;
}
/**
* Rewrite attachment URLs to use the configured iDrivee2 domain.
*
* Intercepts all calls to wp_get_attachment_url() and replaces the
* default uploads base URL with the custom IDRIVEE2_MEDIA_DOMAIN,
* ensuring front-end and AJAX previews load from the S3-compatible host.
*
* @since 0.3.0
*
* @param string $url The original attachment URL.
* @param int $post_id The attachment post ID (required by filter signature, unused).
* @return string The filtered URL, using the iDrivee2 domain if defined.
*/
public function filter_attachment_url( string $url, int $post_id ): string {
if ( $this->config->has_domain() ) {
$uploads = wp_upload_dir();
$old_base = untrailingslashit( $uploads['baseurl'] );
$new_base = untrailingslashit( $this->config->get_domain() );
return str_replace( $old_base, $new_base, $url );
}
return $url;
}
}

View file

@ -0,0 +1,120 @@
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: iDrivee2 Media Upload\n"
"POT-Creation-Date: 2025-08-06 15:40+0200\n"
"PO-Revision-Date: 2025-08-06 15:40+0200\n"
"Last-Translator: \n"
"Language-Team: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
"X-Generator: Poedit 3.6\n"
"X-Poedit-Basepath: ..\n"
"X-Poedit-Flags-xgettext: --add-comments=translators:\n"
"X-Poedit-WPHeader: idrivee2-media-upload.php\n"
"X-Poedit-SourceCharset: UTF-8\n"
"X-Poedit-KeywordsList: "
"__;_e;_n:1,2;_x:1,2c;_ex:1,2c;_nx:4c,1,2;esc_attr__;esc_attr_e;esc_attr_x:1,2c;esc_html__;esc_html_e;esc_html_x:1,2c;_n_noop:1,2;_nx_noop:3c,1,2;__ngettext_noop:1,2\n"
"X-Poedit-SearchPath-0: .\n"
"X-Poedit-SearchPathExcluded-0: *.min.js\n"
"X-Poedit-SearchPathExcluded-1: vendor\n"
#. translators: Admin menu title.
#. translators: Admin menu label.
#: idrivee2-media-upload.php:77 idrivee2-media-upload.php:79
msgid "iDrivee2"
msgstr ""
#: idrivee2-media-upload.php:122 idrivee2-media-upload.php:524
msgid "Test S3 Connection"
msgstr ""
#: idrivee2-media-upload.php:123
msgid "Testing..."
msgstr ""
#: idrivee2-media-upload.php:124 idrivee2-media-upload.php:529
msgid "Upload Test File"
msgstr ""
#: idrivee2-media-upload.php:125
msgid "Uploading..."
msgstr ""
#. translators: %s is the name of the missing constant.
#: idrivee2-media-upload.php:162
#, php-format
msgid "Missing constant %s."
msgstr ""
#: idrivee2-media-upload.php:184
msgid "Connection successful."
msgstr ""
#. translators: Error message when no file is provided.
#: idrivee2-media-upload.php:215
msgid "No file provided."
msgstr ""
#: idrivee2-media-upload.php:472
msgid "iDrivee2 Media Upload Settings"
msgstr ""
#: idrivee2-media-upload.php:476
msgid ""
"To use iDrivee2 Media Upload, please add these constants to wp-config.php:"
msgstr ""
#: idrivee2-media-upload.php:477
msgid "HOST must begin with \"https://\"."
msgstr ""
#: idrivee2-media-upload.php:489
msgid "Host"
msgstr ""
#: idrivee2-media-upload.php:493
msgid "Access Key"
msgstr ""
#: idrivee2-media-upload.php:497
msgid "Secret Key"
msgstr ""
#: idrivee2-media-upload.php:501
msgid "Bucket"
msgstr ""
#: idrivee2-media-upload.php:505
msgid "Region"
msgstr ""
#: idrivee2-media-upload.php:509
msgid "Domain"
msgstr ""
#: idrivee2-media-upload.php:515
msgid "Not defined"
msgstr ""
#. Plugin Name of the plugin/theme
msgid "iDrivee2 Media Upload"
msgstr ""
#. Plugin URI of the plugin/theme
msgid "https://github.com/javiercasares/idrivee2-media-upload"
msgstr ""
#. Description of the plugin/theme
msgid "Uploads media files to iDrivee2 (S3-compatible)."
msgstr ""
#. Author of the plugin/theme
msgid "Javier Casares"
msgstr ""
#. Author URI of the plugin/theme
msgid "https://www.javiercasares.com/"
msgstr ""

66
readme.txt Normal file
View file

@ -0,0 +1,66 @@
=== iDrivee2 Media Upload ===
Contributors: javiercasares
Tags: s3, cdn, media, upload, storage
Requires at least: 6.8
Tested up to: 6.9
Requires PHP: 8.2
Stable tag: 1.0.0
License: GPL-2.0-or-later
License URI: https://spdx.org/licenses/GPL-2.0-or-later.html
Uploads media files to iDrivee2 (S3-compatible storage) with enterprise-grade security and logging.
== Description ==
WordPress plugin that uploads media files to iDrivee2 (S3-compatible storage), deletes local copies, and serves media from a CDN. Enterprise-grade security with comprehensive logging and rate limiting.
**Features:**
* Automatic upload to S3-compatible storage
* Local file cleanup to save disk space
* CDN integration for faster media delivery
* Security logging with WP_DEBUG_LOG integration
* Rate limiting to prevent abuse
* OWASP Top 10 (2021) compliant
* PHPStan level 8 type-safe code
* WordPress.org coding standards compliant
**Security Rating: A+ (Excellent)**
== Installation ==
1. Upload the plugin files to `/wp-content/plugins/idrivee2-media-upload/`
2. Activate the plugin through the 'Plugins' screen in WordPress
3. Configure S3 credentials in Settings → iDrivee2
4. Test the connection and start uploading
== Frequently Asked Questions ==
= Does this plugin delete my local files? =
Yes. After successfully uploading to S3, local files are deleted to save disk space. Make sure your S3 configuration is correct before using.
= Can I use my own CDN domain? =
Yes. Set the IDRIVEE2_MEDIA_DOMAIN constant in wp-config.php or configure it in Settings → iDrivee2.
= Is this compatible with Multisite? =
Yes. The plugin fully supports WordPress Multisite installations.
== Changelog ==
= 1.0.0 =
* First stable release with enterprise-grade security
* Added security logging system
* Added rate limiting protection
* PHPStan level 8 compliance
* OWASP Top 10 compliant
* Complete security audit (A+ rating)
See CHANGELOG.md on GitHub for detailed version history.
== Upgrade Notice ==
= 1.0.0 =
First production-ready release with comprehensive security features.

54
uninstall.php Normal file
View file

@ -0,0 +1,54 @@
<?php
/**
* Uninstall script for iDrivee2 Media Upload.
*
* Runs when the plugin is uninstalled. Cleans up any plugin data if needed.
*
* @package iDrivee2Media
* @since 0.3.0
*/
declare(strict_types=1);
/**
* Prevent direct access to this file.
*/
if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
exit;
}
/**
* Clean up plugin data.
*
* Note: This plugin does not create any custom database tables or options.
* All data is stored in standard WordPress post meta and attachment metadata.
*
* If you want to delete all attachment metadata created by this plugin,
* uncomment the code below. WARNING: This cannot be undone.
*/
// phpcs:disable Squiz.PHP.CommentedOutCode.Found
/*
// Delete all _wp_attached_file meta that was preserved by this plugin.
// This is optional as WordPress manages this meta normally.
global $wpdb;
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
$wpdb->query(
"DELETE FROM {$wpdb->postmeta}
WHERE meta_key = '_wp_attached_file'
AND post_id IN (
SELECT ID FROM {$wpdb->posts}
WHERE post_type = 'attachment'
)"
);
// phpcs:enable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
*/
/**
* Note: Files uploaded to S3 are NOT deleted by this uninstall script.
* If you want to delete files from S3, you must do so manually using
* your S3 management console or AWS CLI.
*/

25
vendor/autoload.php vendored Normal file
View file

@ -0,0 +1,25 @@
<?php
// autoload.php @generated by Composer
if (PHP_VERSION_ID < 50600) {
if (!headers_sent()) {
header('HTTP/1.1 500 Internal Server Error');
}
$err = 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
if (!ini_get('display_errors')) {
if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') {
fwrite(STDERR, $err);
} elseif (!headers_sent()) {
echo $err;
}
}
trigger_error(
$err,
E_USER_ERROR
);
}
require_once __DIR__ . '/composer/autoload_real.php';
return ComposerAutoloaderInite60858b25bb9b11d51011ff69c492447::getLoader();

175
vendor/aws/aws-crt-php/LICENSE vendored Normal file
View file

@ -0,0 +1,175 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

1
vendor/aws/aws-crt-php/NOTICE vendored Normal file
View file

@ -0,0 +1 @@
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

35
vendor/aws/aws-crt-php/composer.json vendored Normal file
View file

@ -0,0 +1,35 @@
{
"name": "aws/aws-crt-php",
"homepage": "https://github.com/awslabs/aws-crt-php",
"description": "AWS Common Runtime for PHP",
"keywords": ["aws","amazon","sdk","crt"],
"type": "library",
"authors": [
{
"name": "AWS SDK Common Runtime Team",
"email": "aws-sdk-common-runtime@amazon.com"
}
],
"minimum-stability": "alpha",
"require": {
"php": ">=5.5"
},
"require-dev": {
"phpunit/phpunit":"^4.8.35||^5.6.3||^9.5",
"yoast/phpunit-polyfills": "^1.0"
},
"autoload": {
"classmap": [
"src/"
]
},
"suggest": {
"ext-awscrt": "Make sure you install awscrt native extension to use any of the functionality."
},
"scripts": {
"test": "./dev-scripts/run_tests.sh",
"test-extension": "@test",
"test-win": ".\\dev-scripts\\run_tests.bat"
},
"license": "Apache-2.0"
}

46
vendor/aws/aws-crt-php/format-check.py vendored Normal file
View file

@ -0,0 +1,46 @@
#!/usr/bin/env python3
import argparse
import os
from pathlib import Path
import re
from subprocess import list2cmdline, run
from tempfile import NamedTemporaryFile
CLANG_FORMAT_VERSION = '18.1.6'
INCLUDE_REGEX = re.compile(r'^ext/.*\.(c|h|inl)$')
EXCLUDE_REGEX = re.compile(r'^$')
arg_parser = argparse.ArgumentParser(description="Check with clang-format")
arg_parser.add_argument('-i', '--inplace-edit', action='store_true',
help="Edit files inplace")
args = arg_parser.parse_args()
os.chdir(Path(__file__).parent)
# create file containing list of all files to format
filepaths_file = NamedTemporaryFile(delete=False)
for dirpath, dirnames, filenames in os.walk('.'):
for filename in filenames:
# our regexes expect filepath to use forward slash
filepath = Path(dirpath, filename).as_posix()
if not INCLUDE_REGEX.match(filepath):
continue
if EXCLUDE_REGEX.match(filepath):
continue
filepaths_file.write(f"{filepath}\n".encode())
filepaths_file.close()
# use pipx to run clang-format from PyPI
# this is a simple way to run the same clang-format version regardless of OS
cmd = ['pipx', 'run', f'clang-format=={CLANG_FORMAT_VERSION}',
f'--files={filepaths_file.name}']
if args.inplace_edit:
cmd += ['-i']
else:
cmd += ['--Werror', '--dry-run']
print(f"{Path.cwd()}$ {list2cmdline(cmd)}")
if run(cmd).returncode:
exit(1)

Some files were not shown because too many files have changed in this diff Show more