initial commit

This commit is contained in:
2024-04-29 13:12:44 +05:45
commit 34887303c5
19300 changed files with 5268802 additions and 0 deletions

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

@@ -0,0 +1,69 @@
# Exec with fallback
[![Latest Stable Version](http://poser.pugx.org/rosell-dk/exec-with-fallback/v)](https://packagist.org/packages/rosell-dk/exec-with-fallback)
[![Build Status](https://github.com/rosell-dk/exec-with-fallback/actions/workflows/php.yml/badge.svg)](https://github.com/rosell-dk/exec-with-fallback/actions/workflows/php.yml)
[![Software License](http://poser.pugx.org/rosell-dk/exec-with-fallback/license)](https://github.com/rosell-dk/exec-with-fallback/blob/master/LICENSE)
[![PHP Version Require](http://poser.pugx.org/rosell-dk/exec-with-fallback/require/php)](https://packagist.org/packages/rosell-dk/exec-with-fallback)
[![Daily Downloads](http://poser.pugx.org/rosell-dk/exec-with-fallback/d/daily)](https://packagist.org/packages/rosell-dk/exec-with-fallback)
Some shared hosts may have disabled *exec()*, but leaved *proc_open()*, *passthru()*, *popen()* or *shell_exec()* open. In case you want to easily fall back to emulating *exec()* with one of these, you have come to the right library.
This library can be useful if you a writing code that is meant to run on a broad spectrum of systems, as it makes your exec() call succeed on more of these systems.
## Usage:
Simply swap out your current *exec()* calls with *ExecWithFallback::exec()*. The signatures are exactly the same.
```php
use ExecWithFallback\ExecWithFallback;
$result = ExecWithFallback::exec('echo "hi"', $output, $result_code);
// $output (array) now holds the output
// $result_code (int) now holds the result code
// $return (string | false) is now false in case of failure or the last line of the output
```
Note that while the signatures are the same, errors are not exactly the same. There is a reason for that. On some systems, a real `exec()` call results in a FATAL error when the function has been disabled. That is: An error, that cannot be catched. You probably don't want to halt execution on some systems, but not on other. But if you do, use `ExecWithFallback::execNoMercy` instead of `ExecWithFallback::exec`. In case no emulations are available, it calls *exec()*, ensuring exact same error handling as normal *exec()*.
If you have `function_exists('exec')` in your code, you probably want to change them to `ExecWithFallback::anyAvailable()`
## Installing
`composer require rosell-dk/exec-with-fallback`
## Implementation
*ExecWithFallback::exec()* first checks if *exec()* is available and calls it, if it is. In case *exec* is unavailable (deactivated on server), or exec() returns false, it moves on to checking if *passthru()* is available and so on. The order is as follows:
- exec()
- passthru()
- popen()
- proc_open()
- shell_exec()
In case all functions are unavailable, a normal exception is thrown (class: Exception). This is more gentle behavior than real exec(), which on some systems throws FATAL error when the function is disabled. If you want exactly same errors, use `ExecWithFallback::execNoMercy` instead, which instead of throwing an exception calls *exec*, which will result in a throw (to support older PHP, you need to catch both Exception and Throwable. And note that you cannot catch on all systems, because some throws FATAL)
In case none succeeded, but at least one failed by returning false, false is returned. Again to mimic *exec()* behavior.
PS: As *shell_exec()* does not support *$result_code*, it will only be used when $result_code isn't supplied. *system()* is not implemented, as it cannot return the last line of output and there is no way to detect if your code relies on that.
If you for some reason want to run a specific exec() emulation, you can use the corresponding class directly, ie *ProcOpen::exec()*.
## Is it worth it?
Well, often these functions are often all enabled or all disabled. So on the majority of systems, it will not make a difference. But on the other hand: This library is easily installed, very lightweight and very well tested.
**easily installed**\
Install with composer (`composer require rosell-dk/exec-with-fallback`) and substitute your *exec()* calls.
**lightweight**\
The library is extremely lightweight. In case *exec()* is available, it is called immediately and only the main file is autoloaded. In case all are unavailable, it only costs a little loop, amounting to five *function_exists()* calls, and again, only the main file is autoloaded. In case *exec()* is unavailable, but one of the others are available, only that implementation is autoloaded, besides the main file.
**well tested**\
I made sure that the function behaves exactly like *exec()*, and wrote a lot of test cases. It is tested on ubuntu, windows, mac (all in several versions). It is tested in PHP 7.0, 7.1, 7.2, 7.3, 7.4 and 8.0. And it is tested in different combinations of disabled functions.
**going to be maintained**\
I'm going to use this library in [webp-convert](https://github.com/rosell-dk/webp-convert), which is used in many projects. So it is going to be widely used. While I don't expect much need for maintenance for this project, it is going to be there, if needed.
**Con: risk of being recognized as malware**
There is a slight risk that a lazy malware creator uses this library for his malware. The risk is however very small, as the library isn't suitable for malware. First off, the library doesn't try *system()*, as that function does not return output and thus cannot be used to emulate *exec()*. A malware creator would desire to try all possible ways to get his malware executed. Secondly, malware creators probably don't use composer for their malware and would probably want a single function instead of having it spread over multiple files. Third, the library here use a lot of efford in getting the emululated functions to behave exactly as exec(). This concern is probably non-existant for malware creators, who probably cares more about the effect of running the malware. Lastly, a malware creator would want to write his own function instead of copying code found on the internet. Copying stuff would impose a chance that the code is used by another malware creator which increases the risk of anti malware software recognizing it as malware.
## Do you like what I do?
Perhaps you want to support my work, so I can continue doing it :)
- [Become a backer or sponsor on Patreon](https://www.patreon.com/rosell).
- [Buy me a Coffee](https://ko-fi.com/rosell)

View File

@@ -0,0 +1,67 @@
{
"name": "rosell-dk/exec-with-fallback",
"description": "An exec() with fallback to emulations (proc_open, etc)",
"type": "library",
"license": "MIT",
"keywords": ["exec", "open_proc", "command", "fallback", "sturdy", "resiliant"],
"scripts": {
"ci": [
"@test",
"@phpcs-all",
"@composer validate --no-check-all --strict",
"@phpstan-global"
],
"test": "./vendor/bin/phpunit --coverage-text",
"test-41": "phpunit --coverage-text --configuration 'phpunit-41.xml.dist'",
"phpunit": "phpunit --coverage-text",
"test-no-cov": "phpunit --no-coverage",
"cs-fix-all": [
"php-cs-fixer fix src"
],
"cs-fix": "php-cs-fixer fix",
"cs-dry": "php-cs-fixer fix --dry-run --diff",
"phpcs": "phpcs --standard=PSR2",
"phpcs-all": "phpcs --standard=PSR2 src",
"phpcbf": "phpcbf --standard=PSR2",
"phpstan": "vendor/bin/phpstan analyse src --level=4",
"phpstan-global-old": "~/.composer/vendor/bin/phpstan analyse src --level=4",
"phpstan-global": "~/.config/composer/vendor/bin/phpstan analyse src --level=4"
},
"extra": {
"scripts-descriptions": {
"ci": "Run tests before CI",
"phpcs": "Checks coding styles (PSR2) of file/dir, which you must supply. To check all, supply 'src'",
"phpcbf": "Fix coding styles (PSR2) of file/dir, which you must supply. To fix all, supply 'src'",
"cs-fix-all": "Fix the coding style of all the source files, to comply with the PSR-2 coding standard",
"cs-fix": "Fix the coding style of a PHP file or directory, which you must specify.",
"test": "Launches the preconfigured PHPUnit"
}
},
"autoload": {
"psr-4": { "ExecWithFallback\\": "src/" }
},
"autoload-dev": {
"psr-4": { "ExecWithFallback\\Tests\\": "tests/" }
},
"authors": [
{
"name": "Bjørn Rosell",
"homepage": "https://www.bitwise-it.dk/contact",
"role": "Project Author"
}
],
"require": {
"php": "^5.6 | ^7.0 | ^8.0"
},
"suggest": {
"php-stan/php-stan": "Suggested for dev, in order to analyse code before committing"
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^2.11",
"phpunit/phpunit": "^9.3",
"squizlabs/php_codesniffer": "3.*"
},
"config": {
"sort-packages": true
}
}

View File

@@ -0,0 +1,3 @@
parameters:
ignoreErrors:
- '#PHPDoc tag @param.*Unexpected token "&"#'

View File

@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" verbose="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
<coverage>
<include>
<directory suffix=".php">src/</directory>
</include>
<report>
<clover outputFile="build/logs/clover.xml"/>
<html outputDirectory="build/coverage"/>
<text outputFile="build/coverage.txt"/>
</report>
</coverage>
<testsuites>
<testsuite name=":vendor Test Suite">
<directory suffix="Test.php">./tests/</directory>
</testsuite>
</testsuites>
<logging>
<junit outputFile="build/report.junit.xml"/>
</logging>
</phpunit>

View File

@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php"
backupGlobals="false"
backupStaticAttributes="false"
colors="true"
verbose="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false">
<testsuites>
<testsuite name=":vendor Test Suite">
<directory suffix="Test.php">./tests/</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">src/</directory>
</whitelist>
</filter>
<logging>
<log type="junit" target="build/report.junit.xml"/>
<log type="coverage-clover" target="build/logs/clover.xml"/>
<log type="coverage-text" target="build/coverage.txt"/>
<log type="coverage-html" target="build/coverage"/>
</logging>
</phpunit>

View File

@@ -0,0 +1,39 @@
<?php
namespace ExecWithFallback;
/**
* Check if any of the methods are available on the system.
*
* @package ExecWithFallback
* @author Bjørn Rosell <it@rosell.dk>
*/
class Availability extends ExecWithFallback
{
/**
* Check if any of the methods are available on the system.
*
* @param boolean $needResultCode Whether the code using this library is going to supply $result_code to the exec
* call. This matters because shell_exec is only available when not.
*/
public static function anyAvailable($needResultCode = true)
{
foreach (self::$methods as $method) {
if (self::methodAvailable($method, $needResultCode)) {
return true;
}
}
return false;
}
public static function methodAvailable($method, $needResultCode = true)
{
if (!ExecWithFallback::functionEnabled($method)) {
return false;
}
if ($needResultCode) {
return ($method != 'shell_exec');
}
return true;
}
}

View File

@@ -0,0 +1,127 @@
<?php
namespace ExecWithFallback;
/**
* Execute command with exec(), open_proc() or whatever available
*
* @package ExecWithFallback
* @author Bjørn Rosell <it@rosell.dk>
*/
class ExecWithFallback
{
protected static $methods = ['exec', 'passthru', 'popen', 'proc_open', 'shell_exec'];
/**
* Check if any of the methods are available on the system.
*
* @param boolean $needResultCode Whether the code using this library is going to supply $result_code to the exec
* call. This matters because shell_exec is only available when not.
*/
public static function anyAvailable($needResultCode = true)
{
return Availability::anyAvailable($needResultCode);
}
/**
* Check if a function is enabled (function_exists as well as ini is tested)
*
* @param string $functionName The name of the function
*
* @return boolean If the function is enabled
*/
public static function functionEnabled($functionName)
{
if (!function_exists($functionName)) {
return false;
}
if (function_exists('ini_get')) {
if (ini_get('safe_mode')) {
return false;
}
$d = ini_get('disable_functions') . ',' . ini_get('suhosin.executor.func.blacklist');
if ($d === false) {
$d = '';
}
$d = preg_replace('/,\s*/', ',', $d);
if (strpos(',' . $d . ',', ',' . $functionName . ',') !== false) {
return false;
}
}
return is_callable($functionName);
}
/**
* Execute. - A substitute for exec()
*
* Same signature and results as exec(): https://www.php.net/manual/en/function.exec.php
* In case neither exec(), nor emulations are available, it throws an Exception.
* This is more gentle than real exec(), which on some systems throws a FATAL when exec() is disabled
* If you want the more acurate substitute, which might halt execution, use execNoMercy() instead.
*
* @param string $command The command to execute
* @param string &$output (optional)
* @param int &$result_code (optional)
*
* @return string | false The last line of output or false in case of failure
* @throws \Exception If no methods are available
*/
public static function exec($command, &$output = null, &$result_code = null)
{
foreach (self::$methods as $method) {
if (self::functionEnabled($method)) {
if (func_num_args() >= 3) {
if ($method == 'shell_exec') {
continue;
}
$result = self::runExec($method, $command, $output, $result_code);
} else {
$result = self::runExec($method, $command, $output);
}
if ($result !== false) {
return $result;
}
}
}
if (isset($result) && ($result === false)) {
return false;
}
throw new \Exception('exec() is not available');
}
/**
* Execute. - A substitute for exec(), with exact same errors thrown if exec() is missing.
*
* Danger: On some systems, this results in a fatal (non-catchable) error.
*/
public static function execNoMercy($command, &$output = null, &$result_code = null)
{
if (func_num_args() == 3) {
return ExecWithFallbackNoMercy::exec($command, $output, $result_code);
} else {
return ExecWithFallbackNoMercy::exec($command, $output);
}
}
public static function runExec($method, $command, &$output = null, &$result_code = null)
{
switch ($method) {
case 'exec':
return exec($command, $output, $result_code);
case 'passthru':
return Passthru::exec($command, $output, $result_code);
case 'popen':
return POpen::exec($command, $output, $result_code);
case 'proc_open':
return ProcOpen::exec($command, $output, $result_code);
case 'shell_exec':
if (func_num_args() == 4) {
return ShellExec::exec($command, $output, $result_code);
} else {
return ShellExec::exec($command, $output);
}
}
return false;
}
}

View File

@@ -0,0 +1,56 @@
<?php
namespace ExecWithFallback;
/**
* Execute command with exec(), open_proc() or whatever available
*
* @package ExecWithFallback
* @author Bjørn Rosell <it@rosell.dk>
*/
class ExecWithFallbackNoMercy
{
/**
* Execute. - A substitute for exec()
*
* Same signature and results as exec(): https://www.php.net/manual/en/function.exec.php
*
* This is our hardcore version of our exec(). It does not merely throw an Exception, if
* no methods are available. It calls exec().
* This ensures exactly same behavior as normal exec() - the same error is thrown.
* You might want that. But do you really?
* DANGER: On some systems, calling a disabled exec() results in a fatal (non-catchable) error.
*
* @param string $command The command to execute
* @param string &$output (optional)
* @param int &$result_code (optional)
*
* @return string | false The last line of output or false in case of failure
* @throws \Exception|\Error If no methods are available. Note: On some systems, it is FATAL!
*/
public static function exec($command, &$output = null, &$result_code = null)
{
foreach (self::$methods as $method) {
if (self::functionEnabled($method)) {
if (func_num_args() >= 3) {
if ($method == 'shell_exec') {
continue;
}
$result = self::runExec($method, $command, $output, $result_code);
} else {
$result = self::runExec($method, $command, $output);
}
if ($result !== false) {
return $result;
}
}
}
if (isset($result) && ($result === false)) {
return false;
}
// MIGHT THROW FATAL!
return exec($command, $output, $result_code);
}
}

View File

@@ -0,0 +1,60 @@
<?php
namespace ExecWithFallback;
/**
* Emulate exec() with system()
*
* @package ExecWithFallback
* @author Bjørn Rosell <it@rosell.dk>
*/
class POpen
{
/**
* Emulate exec() with system()
*
* @param string $command The command to execute
* @param string &$output (optional)
* @param int &$result_code (optional)
*
* @return string | false The last line of output or false in case of failure
*/
public static function exec($command, &$output = null, &$result_code = null)
{
$handle = @popen($command, "r");
if ($handle === false) {
return false;
}
$result = '';
while (!@feof($handle)) {
$result .= fread($handle, 1024);
}
//Note: Unix Only:
// pclose() is internally implemented using the waitpid(3) system call.
// To obtain the real exit status code the pcntl_wexitstatus() function should be used.
$result_code = pclose($handle);
$theOutput = preg_split('/\s*\r\n|\s*\n\r|\s*\n|\s*\r/', $result);
// remove the last element if it is blank
if ((count($theOutput) > 0) && ($theOutput[count($theOutput) -1] == '')) {
array_pop($theOutput);
}
if (count($theOutput) == 0) {
return '';
}
if (gettype($output) == 'array') {
foreach ($theOutput as $line) {
$output[] = $line;
}
} else {
$output = $theOutput;
}
return $theOutput[count($theOutput) -1];
}
}

View File

@@ -0,0 +1,58 @@
<?php
namespace ExecWithFallback;
/**
* Emulate exec() with passthru()
*
* @package ExecWithFallback
* @author Bjørn Rosell <it@rosell.dk>
*/
class Passthru
{
/**
* Emulate exec() with passthru()
*
* @param string $command The command to execute
* @param string &$output (optional)
* @param int &$result_code (optional)
*
* @return string | false The last line of output or false in case of failure
*/
public static function exec($command, &$output = null, &$result_code = null)
{
ob_start();
// Note: We use try/catch in order to close output buffering in case it throws
try {
passthru($command, $result_code);
} catch (\Exception $e) {
ob_get_clean();
passthru($command, $result_code);
} catch (\Throwable $e) {
ob_get_clean();
passthru($command, $result_code);
}
$result = ob_get_clean();
// split new lines. Also remove trailing space, as exec() does
$theOutput = preg_split('/\s*\r\n|\s*\n\r|\s*\n|\s*\r/', $result);
// remove the last element if it is blank
if ((count($theOutput) > 0) && ($theOutput[count($theOutput) -1] == '')) {
array_pop($theOutput);
}
if (count($theOutput) == 0) {
return '';
}
if (gettype($output) == 'array') {
foreach ($theOutput as $line) {
$output[] = $line;
}
} else {
$output = $theOutput;
}
return $theOutput[count($theOutput) -1];
}
}

View File

@@ -0,0 +1,67 @@
<?php
namespace ExecWithFallback;
/**
* Emulate exec() with proc_open()
*
* @package ExecWithFallback
* @author Bjørn Rosell <it@rosell.dk>
*/
class ProcOpen
{
/**
* Emulate exec() with proc_open()
*
* @param string $command The command to execute
* @param string &$output (optional)
* @param int &$result_code (optional)
*
* @return string | false The last line of output or false in case of failure
*/
public static function exec($command, &$output = null, &$result_code = null)
{
$descriptorspec = array(
//0 => array("pipe", "r"),
1 => array("pipe", "w"),
//2 => array("pipe", "w"),
//2 => array("file", "/tmp/error-output.txt", "a")
);
$cwd = getcwd(); // or is "/tmp" better?
$processHandle = proc_open($command, $descriptorspec, $pipes, $cwd);
$result = "";
if (is_resource($processHandle)) {
// Got this solution here:
// https://stackoverflow.com/questions/5673740/php-or-apache-exec-popen-system-and-proc-open-commands-do-not-execute-any-com
//fclose($pipes[0]);
$result = stream_get_contents($pipes[1]);
fclose($pipes[1]);
//fclose($pipes[2]);
$result_code = proc_close($processHandle);
// split new lines. Also remove trailing space, as exec() does
$theOutput = preg_split('/\s*\r\n|\s*\n\r|\s*\n|\s*\r/', $result);
// remove the last element if it is blank
if ((count($theOutput) > 0) && ($theOutput[count($theOutput) -1] == '')) {
array_pop($theOutput);
}
if (count($theOutput) == 0) {
return '';
}
if (gettype($output) == 'array') {
foreach ($theOutput as $line) {
$output[] = $line;
}
} else {
$output = $theOutput;
}
return $theOutput[count($theOutput) -1];
} else {
return false;
}
}
}

View File

@@ -0,0 +1,69 @@
<?php
namespace ExecWithFallback;
/**
* Emulate exec() with system()
*
* @package ExecWithFallback
* @author Bjørn Rosell <it@rosell.dk>
*/
class ShellExec
{
/**
* Emulate exec() with shell_exec()
*
* @param string $command The command to execute
* @param string &$output (optional)
* @param int &$result_code (optional)
*
* @return string | false The last line of output or false in case of failure
*/
public static function exec($command, &$output = null, &$result_code = null)
{
$resultCodeSupplied = (func_num_args() >= 3);
if ($resultCodeSupplied) {
throw new \Exception('ShellExec::exec() does not support $result_code argument');
}
$result = shell_exec($command);
// result:
// - A string containing the output from the executed command,
// - false if the pipe cannot be established
// - or null if an error occurs or the command produces no output.
if ($result === false) {
return false;
}
if (is_null($result)) {
// hm, "null if an error occurs or the command produces no output."
// What were they thinking?
// And yes, it does return null, when no output, which is confirmed in the test "echo hi 1>/dev/null"
// What should we do? Throw or accept?
// Perhaps shell_exec throws in newer versions of PHP instead of returning null.
// We are counting on it until proved wrong.
return '';
}
$theOutput = preg_split('/\s*\r\n|\s*\n\r|\s*\n|\s*\r/', $result);
// remove the last element if it is blank
if ((count($theOutput) > 0) && ($theOutput[count($theOutput) -1] == '')) {
array_pop($theOutput);
}
if (count($theOutput) == 0) {
return '';
}
if (gettype($output) == 'array') {
foreach ($theOutput as $line) {
$output[] = $line;
}
} else {
$output = $theOutput;
}
return $theOutput[count($theOutput) -1];
}
}

View File

@@ -0,0 +1,9 @@
<?php
include 'vendor/autoload.php';
//include 'src/ExecWithFallback.php';
use ExecWithFallback\ExecWithFallback;
use ExecWithFallback\Tests\ExecWithFallbackTest;
ExecWithFallback::exec('echo hello');
ExecWithFallbackTest::testExec();

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

@@ -0,0 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.1/phpunit.xsd"
backupGlobals="false"
backupStaticAttributes="false"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="false"
processIsolation="false"
stopOnFailure="false"
bootstrap="vendor/autoload.php"
>
<testsuites>
<testsuite name="HtaccessCapabilitTester Test Suite">
<directory>./tests/</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">src/</directory>
<exclude>
<directory>./vendor</directory>
<directory>./tests</directory>
</exclude>
</whitelist>
</filter>
<logging>
<log type="junit" target="build/report.junit.xml"/>
<log type="coverage-clover" target="coverage.clover"/>
<log type="coverage-text" target="build/coverage.txt"/>
<log type="coverage-html" target="build/coverage"/>
</logging>
</phpunit>

View File

@@ -0,0 +1,334 @@
<?php
namespace HtaccessCapabilityTester;
use \HtaccessCapabilityTester\Testers\AbstractTester;
use \HtaccessCapabilityTester\Testers\AddTypeTester;
use \HtaccessCapabilityTester\Testers\ContentDigestTester;
use \HtaccessCapabilityTester\Testers\CrashTester;
use \HtaccessCapabilityTester\Testers\CustomTester;
use \HtaccessCapabilityTester\Testers\DirectoryIndexTester;
use \HtaccessCapabilityTester\Testers\HeaderSetTester;
use \HtaccessCapabilityTester\Testers\HtaccessEnabledTester;
use \HtaccessCapabilityTester\Testers\InnocentRequestTester;
use \HtaccessCapabilityTester\Testers\ModuleLoadedTester;
use \HtaccessCapabilityTester\Testers\PassInfoFromRewriteToScriptThroughRequestHeaderTester;
use \HtaccessCapabilityTester\Testers\PassInfoFromRewriteToScriptThroughEnvTester;
use \HtaccessCapabilityTester\Testers\RewriteTester;
use \HtaccessCapabilityTester\Testers\RequestHeaderTester;
use \HtaccessCapabilityTester\Testers\ServerSignatureTester;
/**
* Main entrance.
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class HtaccessCapabilityTester
{
/** @var string The dir where the test files should be put */
protected $baseDir;
/** @var string The base url that the tests can be run from (corresponds to $baseDir) */
protected $baseUrl;
/** @var string Additional info regarding last test (often empty) */
public $infoFromLastTest;
/** @var string Status code from last test (can be empty) */
public $statusCodeOfLastRequest;
/** @var HttpRequesterInterface The object used to make the HTTP request */
private $requester;
/** @var TestFilesLineUpperInterface The object used to line up the test files */
private $testFilesLineUpper;
/**
* Constructor.
*
* @param string $baseDir Directory on the server where the test files can be put
* @param string $baseUrl The base URL of the test files
*
* @return void
*/
public function __construct($baseDir, $baseUrl)
{
$this->baseDir = $baseDir;
$this->baseUrl = $baseUrl;
}
/**
* Run a test, store the info and return the status.
*
* @param AbstractTester $tester
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
private function runTest($tester)
{
//$tester->setHtaccessCapabilityTester($this);
if (isset($this->requester)) {
$tester->setHttpRequester($this->requester);
}
if (isset($this->testFilesLineUpper)) {
$tester->setTestFilesLineUpper($this->testFilesLineUpper);
}
//$tester->setHtaccessCapabilityTester($this);
$cacheKeys = [$this->baseDir, $tester->getCacheKey()];
if (TestResultCache::isCached($cacheKeys)) {
$testResult = TestResultCache::getCached($cacheKeys);
} else {
$testResult = $tester->run($this->baseDir, $this->baseUrl);
TestResultCache::cache($cacheKeys, $testResult);
}
$this->infoFromLastTest = $testResult->info;
$this->statusCodeOfLastRequest = $testResult->statusCodeOfLastRequest;
return $testResult->status;
}
/**
* Run a test, store the info and return the status.
*
* @param HttpRequesterInterface $requester
*
* @return void
*/
public function setHttpRequester($requester)
{
$this->requester = $requester;
}
/**
* Set object responsible for lining up the test files.
*
* @param TestFilesLineUpperInterface $testFilesLineUpper
* @return void
*/
public function setTestFilesLineUpper($testFilesLineUpper)
{
$this->testFilesLineUpper = $testFilesLineUpper;
}
/**
* Test if .htaccess files are enabled
*
* Apache can be configured to completely ignore .htaccess files. This test examines
* if .htaccess files are proccesed.
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function htaccessEnabled()
{
return $this->runTest(new HtaccessEnabledTester());
}
/**
* Test if a module is loaded.
*
* This test detects if directives inside a "IfModule" is run for a given module
*
* @param string $moduleName A valid Apache module name (ie "rewrite")
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function moduleLoaded($moduleName)
{
return $this->runTest(new ModuleLoadedTester($moduleName));
}
/**
* Test if rewriting works.
*
* The .htaccess in this test uses the following directives:
* - IfModule
* - RewriteEngine
* - Rewrite
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function rewriteWorks()
{
return $this->runTest(new RewriteTester());
}
/**
* Test if AddType works.
*
* The .htaccess in this test uses the following directives:
* - IfModule (core)
* - AddType (mod_mime, FileInfo)
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function addTypeWorks()
{
return $this->runTest(new AddTypeTester());
}
/**
* Test if setting a Response Header with the Header directive works.
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function headerSetWorks()
{
return $this->runTest(new HeaderSetTester());
}
/**
* Test if setting a Request Header with the RequestHeader directive works.
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function requestHeaderWorks()
{
return $this->runTest(new RequestHeaderTester());
}
/**
* Test if ContentDigest directive works.
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function contentDigestWorks()
{
return $this->runTest(new ContentDigestTester());
}
/**
* Test if ServerSignature directive works.
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function serverSignatureWorks()
{
return $this->runTest(new ServerSignatureTester());
}
/**
* Test if DirectoryIndex works.
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function directoryIndexWorks()
{
return $this->runTest(new DirectoryIndexTester());
}
/**
* Test a complex construct for passing information from a rewrite to a script through a request header.
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function passingInfoFromRewriteToScriptThroughRequestHeaderWorks()
{
return $this->runTest(new PassInfoFromRewriteToScriptThroughRequestHeaderTester());
}
/**
* Test if an environment variable can be set in a rewrite rule and received in PHP.
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function passingInfoFromRewriteToScriptThroughEnvWorks()
{
return $this->runTest(new PassInfoFromRewriteToScriptThroughEnvTester());
}
/**
* Call one of the methods of this class (not all allowed).
*
* @param string $functionCall ie "rewriteWorks()"
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
/*
public function callMethod($functionCall)
{
switch ($functionCall) {
case 'htaccessEnabled()':
return $this->htaccessEnabled();
case 'rewriteWorks()':
return $this->rewriteWorks();
case 'addTypeWorks()':
return $this->addTypeWorks();
case 'headerSetWorks()':
return $this->headerSetWorks();
case 'requestHeaderWorks()':
return $this->requestHeaderWorks();
case 'contentDigestWorks()':
return $this->contentDigestWorks();
case 'directoryIndexWorks()':
return $this->directoryIndexWorks();
case 'passingInfoFromRewriteToScriptThroughRequestHeaderWorks()':
return $this->passingInfoFromRewriteToScriptThroughRequestHeaderWorks();
case 'passingInfoFromRewriteToScriptThroughEnvWorks()':
return $this->passingInfoFromRewriteToScriptThroughEnvWorks();
default:
throw new \Exception('The method is not callable');
}
// TODO: moduleLoaded($moduleName)
}*/
/**
* Crash-test some .htaccess rules.
*
* Tests if the server can withstand the given rules without going fatal.
*
* - success: if the rules does not result in status 500.
* - failure: if the rules results in status 500 while a request to a file in a directory
* without any .htaccess succeeds (<> 500)
* - inconclusive: if the rules results in status 500 while a request to a file in a directory
* without any .htaccess also fails (500)
*
* @param string $rules Rules to crash-test
* @param string $subDir (optional) Subdir for the .htaccess to reside.
* if left out, a unique string will be generated
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function crashTest($rules, $subDir = null)
{
return $this->runTest(new CrashTester($rules, $subDir));
}
/**
* Test an innocent request to a text file.
*
* If this fails, everything else will also fail.
*
* Possible reasons for failure:
* - A .htaccess in a parent folder has forbidden tags / syntax errors
*
* Possible reasons for inconclusive (= test could not be run)
* - 403 Forbidden
* - 404 Not Found
* - Request fails (ie due to timeout)
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function innocentRequestWorks()
{
return $this->runTest(new InnocentRequestTester());
}
/**
* Run a custom test.
*
* @param array $definition
*
* @return bool|null true=success, false=failure, null=inconclusive
*/
public function customTest($definition)
{
return $this->runTest(new CustomTester($definition));
}
}

View File

@@ -0,0 +1,15 @@
<?php
namespace HtaccessCapabilityTester;
interface HttpRequesterInterface
{
/**
* Make a HTTP request to a URL.
*
* @return HttpResponse A HttpResponse object, which simply contains body, status code and response headers.
* In case the request itself fails, the status code is "0" and the body should contain
* error description (if available)
*/
public function makeHttpRequest($url);
}

View File

@@ -0,0 +1,75 @@
<?php
namespace HtaccessCapabilityTester;
/**
* Class for holding properties of a HttpResponse
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class HttpResponse
{
/* @var string the body of the response */
public $body;
/* @var string the status code of the response */
public $statusCode;
/* @var array the response headers keyed by lowercased field name */
public $headersMapLowerCase;
/**
* Constructor.
*
* @param string $body
* @param string $statusCode
* @param array $headersMap Map of headers, keyed by field name.
* There is only one value (string) for each key.
* If there are multiple values, they must be separated by comma
*
* @return void
*/
public function __construct($body, $statusCode, $headersMap)
{
$this->body = $body;
$this->statusCode = $statusCode;
$this->headersMapLowerCase = array_change_key_case($headersMap, CASE_LOWER);
}
/**
* Check if the response has a header
*
* @param string $fieldName
* @return bool
*/
public function hasHeader($fieldName)
{
$fieldName = strtolower($fieldName);
return (isset($this->headersMapLowerCase[$fieldName]));
}
/**
* Check if the response has a header with a given value
*
* @param string $fieldName
* @param string $fieldValue
* @return bool
*/
public function hasHeaderValue($fieldName, $fieldValue)
{
$fieldName = strtolower($fieldName);
if (!isset($this->headersMapLowerCase[$fieldName])) {
return false;
}
$values = explode(',', $this->headersMapLowerCase[$fieldName]);
foreach ($values as $value) {
if (trim($value) == $fieldValue) {
return true;
}
}
return false;
}
}

View File

@@ -0,0 +1,48 @@
<?php
namespace HtaccessCapabilityTester;
class SimpleHttpRequester implements HttpRequesterInterface
{
/**
* Make a HTTP request to a URL.
*
* @param string $url The URL to make the HTTP request to
*
* @return HttpResponse A HttpResponse object, which simply contains body, status code and response headers.
* In case the request itself fails, the status code is "0" and the body should contain
* error description (if available)
*/
public function makeHttpRequest($url)
{
// PS: We suppress the E_WARNING level error generated on failure
$body = @file_get_contents($url);
if ($body === false) {
//$body = '';
return new HttpResponse('The following request failed: file_get_contents(' . $url . ')', '0', []);
}
// $http_response_header materializes out of thin air when file_get_contents() is called
// Get status code
$statusLine = $http_response_header[0];
preg_match('{HTTP\/\S*\s(\d{3})}', $statusLine, $match);
$statusCode = $match[1];
// Create headers map
$headersMap = [];
foreach ($http_response_header as $header) {
$pos = strpos($header, ':');
if ($pos > 0) {
$fieldName = strtolower(trim(substr($header, 0, $pos)));
$value = trim(substr($header, $pos + 1));
if (!isset($headersMap[$fieldName])) {
$headersMap[$fieldName] = $value;
} else {
$headersMap[$fieldName] .= ', ' . $value;
}
}
}
return new HttpResponse($body, $statusCode, $headersMap);
}
}

View File

@@ -0,0 +1,99 @@
<?php
namespace HtaccessCapabilityTester;
class SimpleTestFileLineUpper implements TestFilesLineUpperInterface
{
private function writeFileIfMissingOrChanged($file)
{
$success = true;
list($filename, $content) = $file;
$dir = dirname($filename);
if (!is_dir($dir)) {
if (!mkdir($dir, 0777, true)) {
// TODO: Use custom exception
throw new \Exception('Failed creating dir: ' . $dir);
}
}
if (file_exists($filename)) {
// file already exists, now check if content is the same
$existingContent = file_get_contents($filename);
if (($existingContent === false) || ($content != $existingContent)) {
$success = file_put_contents($filename, $content);
}
} else {
$success = file_put_contents($filename, $content);
}
if (!$success) {
// TODO: Use custom exception
throw new \Exception('Failed creating file: ' . $filename);
}
}
/**
* Write missing and changed files.
*
* @param array $files The files that needs to be there
*
* @return void
*/
private function writeMissingAndChangedFiles($files)
{
foreach ($files as $file) {
$this->writeFileIfMissingOrChanged($file);
}
}
/**
* Remove unused files.
*
* @param array $files The files that needs to be there (others will be removed)
*
* @return void
*/
private function removeUnusedFiles($files)
{
$dirs = [];
foreach ($files as $file) {
list($filename, $content) = $file;
$dir = dirname($filename);
if (!isset($dirs[$dir])) {
$dirs[$dir] = [];
}
$dirs[$dir][] = basename($filename);
}
foreach ($dirs as $dir => $filesSupposedToBeInDir) {
$fileIterator = new \FilesystemIterator($dir);
while ($fileIterator->valid()) {
$filename = $fileIterator->getFilename();
if (!in_array($filename, $filesSupposedToBeInDir)) {
unlink($dir . '/' . $filename);
}
$fileIterator->next();
}
}
}
/**
* Line-up test files.
*
* This method should make sure that the files passed in are there and are up-to-date.
* - If a file is missing, it should be created.
* - If a file has changed content, it should be updated
* - If the directory contains a file/dir that should not be there, it should be removed
*
* @param array $files The files that needs to be there
*
* @return void
*/
public function lineUp($files)
{
// 1. Put missing files / changed files
$this->writeMissingAndChangedFiles($files);
// 2. Remove unused files
$this->removeUnusedFiles($files);
}
}

View File

@@ -0,0 +1,20 @@
<?php
namespace HtaccessCapabilityTester;
interface TestFilesLineUpperInterface
{
/**
* Line-up test files.
*
* This method should make sure that the files passed in are there and are up-to-date.
* - If a file is missing, it should be created.
* - If a file has changed content, it should be updated
* - If the directory contains a file/dir that should not be there, it should be removed
*
* @param array $files The files that needs to be there
*
* @return void
*/
public function lineUp($files);
}

View File

@@ -0,0 +1,39 @@
<?php
namespace HtaccessCapabilityTester;
/**
* Class for holding properties of a TestResult
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since the beginning
*/
class TestResult
{
/* @var bool|null The result, null if inconclusive */
public $status;
/* @var string Information about how the test failed / became inconclusive */
public $info;
/* @var string Status code of last request in the test */
public $statusCodeOfLastRequest;
/**
* Constructor.
*
* @param bool|null $status
* @param string $info
* @param string $statusCodeOfLastRequest (optional)
*
* @return void
*/
public function __construct($status, $info, $statusCodeOfLastRequest = null)
{
$this->status = $status;
$this->info = $info;
$this->statusCodeOfLastRequest = $statusCodeOfLastRequest;
}
}

View File

@@ -0,0 +1,81 @@
<?php
namespace HtaccessCapabilityTester;
use \HtaccessCapabilityTester\Testers\AbstractTester;
/**
* Class caching test results
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since the beginning
*/
class TestResultCache
{
/* @var array Array for caching */
protected static $cache;
/**
*
* @param array $cacheKeys Two keys for caching (usually: basedir and the getCacheKey() for the Tester)
* @param TestResult $testResult The test result to cache
*
* @return void
*/
public static function cache($cacheKeys, $testResult)
{
if (!isset(self::$cache)) {
self::$cache = [];
}
list($key1, $key2) = $cacheKeys;
if (!isset(self::$cache[$key1])) {
self::$cache[$key1] = [];
}
self::$cache[$key1][$key2] = $testResult;
}
/**
* Check if in cache.
*
* @param array $cacheKeys Keys for caching (usually: basedir and the getCacheKey() for the Tester)
*
* @return bool
*/
public static function isCached($cacheKeys)
{
if (!isset(self::$cache)) {
return false;
}
list($key1, $key2) = $cacheKeys;
if (!isset(self::$cache[$key1])) {
return false;
}
if (!isset(self::$cache[$key1][$key2])) {
return false;
}
return true;
}
/**
* Get from cache.
*
* @param array $cacheKeys Keys for caching (usually: basedir and the getCacheKey() for the Tester)
*
* @return TestResult The test result
*/
public static function getCached($cacheKeys)
{
if (!self::isCached($cacheKeys)) {
throw new \Exception('Not in cache');
}
list($key1, $key2) = $cacheKeys;
return self::$cache[$key1][$key2];
}
public static function clear()
{
self::$cache = null;
}
}

View File

@@ -0,0 +1,191 @@
<?php
namespace HtaccessCapabilityTester\Testers;
use \HtaccessCapabilityTester\HtaccessCapabilityTester;
use \HtaccessCapabilityTester\HttpRequesterInterface;
use \HtaccessCapabilityTester\HttpResponse;
use \HtaccessCapabilityTester\SimpleHttpRequester;
use \HtaccessCapabilityTester\SimpleTestFileLineUpper;
use \HtaccessCapabilityTester\TestFilesLineUpperInterface;
use \HtaccessCapabilityTester\TestResult;
abstract class AbstractTester
{
/** @var string The dir where the test files should be put */
protected $baseDir;
/** @var string The base url that the tests can be run from (corresponds to $baseDir) */
protected $baseUrl;
/** @var string Subdir to put .htaccess files in */
protected $subDir;
/** @var array Test files for the test */
protected $testFiles;
/** @var HttpRequesterInterface An object for making the HTTP request */
protected $httpRequester;
/** @var HttpResponse The response of the previous HTTP request (if any) */
public $lastHttpResponse;
/** @var TestFilesLineUpperInterface An object for lining up the test-files */
protected $testFilesLineUpper;
/** @var HtaccessCapabilityTester The HtaccessCapabilityTester to use for subtests */
private $hct;
/**
* Register the test files using the "registerTestFile" method
*
* @return void
*/
abstract protected function registerTestFiles();
/**
* Child classes must implement this method, which tells which subdir the
* test files are to be put.
*
* @return string A subdir for the test files
*/
abstract protected function getSubDir();
/**
* Get key for caching purposes.
*
* Return a unique key. The default is to use the subdir. However, if a concrete Tester class
* can test different things, it must override this method and make sure to return a different
* key per thing it can test
*
* @return string A key it can be cached under
*/
public function getCacheKey()
{
return $this->getSubDir();
}
public function getBaseDir()
{
return $this->baseDir;
}
public function getBaseUrl()
{
return $this->baseUrl;
}
/**
* Child classes must that implement the registerTestFiles method must call
* this method to register each test file.
*
* @return void
*/
protected function registerTestFile($filename, $content)
{
$this->testFiles[] = [$this->baseDir . '/' . $filename, $content];
}
/**
* Last moment preparations before running the test
*
* @param string $baseDir Directory on the server where the test files can be put
* @param string $baseUrl The base URL of the test files
*
* @throws \Exception In case the test cannot be prepared due to serious issues
*/
protected function prepareForRun($baseDir, $baseUrl)
{
$this->baseDir = $baseDir;
$this->baseUrl = $baseUrl;
$this->testFiles = [];
$this->registerTestFiles();
$this->lineUpTestFiles();
}
abstract public function run($baseDir, $baseUrl);
/**
* Constructor.
*
* @return void
*/
public function __construct()
{
$this->subDir = $this->getSubDir();
}
/**
* Make a HTTP request to a URL.
*
* @param string $url The URL to make the HTTP request to
*
* @return HttpResponse A HttpResponse object, which simply contains body and status code.
*/
protected function makeHttpRequest($url)
{
if (!isset($this->httpRequester)) {
$this->httpRequester = new SimpleHttpRequester();
}
$this->lastHttpResponse = $this->httpRequester->makeHttpRequest($url);
return $this->lastHttpResponse;
}
/**
* Set HTTP requester object, which handles making HTTP requests.
*
* @param HttpRequesterInterface $httpRequester The HTTPRequester to use
* @return void
*/
public function setHttpRequester($httpRequester)
{
$this->httpRequester = $httpRequester;
if (isset($this->hct)) {
$this->hct->setHttpRequester($this->httpRequester);
}
}
public function lineUpTestFiles()
{
if (!isset($this->testFilesLineUpper)) {
$this->testFilesLineUpper = new SimpleTestFileLineUpper();
}
$this->testFilesLineUpper->lineUp($this->testFiles);
}
/**
* Set object responsible for lining up the test files.
*
* @param TestFilesLineUpperInterface $testFilesLineUpper
* @return void
*/
public function setTestFilesLineUpper($testFilesLineUpper)
{
$this->testFilesLineUpper = $testFilesLineUpper;
if (isset($this->hct)) {
$this->hct->setTestFilesLineUpper($this->testFilesLineUpper);
}
}
/**
* Get HtaccessCapabilityTester.
*
* Some tests use HtaccessCapabilityTester to run other tests.
* This gets such object with baseDir and baseUrl set up
*
* @return HtaccessCapabilityTester
*/
public function getHtaccessCapabilityTester()
{
if (!isset($this->hct)) {
$this->hct = new HtaccessCapabilityTester($this->baseDir, $this->baseUrl);
if (isset($this->testFilesLineUpper)) {
$this->hct->setTestFilesLineUpper($this->testFilesLineUpper);
}
if (isset($this->httpRequester)) {
$this->hct->setHttpRequester($this->httpRequester);
}
}
return $this->hct;
}
}

View File

@@ -0,0 +1,44 @@
<?php
namespace HtaccessCapabilityTester\Testers;
/**
* Class for testing if AddType works
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class AddTypeTester extends CustomTester
{
/**
* Constructor.
*
* @return void
*/
public function __construct()
{
$htaccessFile = <<<'EOD'
<IfModule mod_mime.c>
AddType image/gif .test
</IfModule>
EOD;
$test = [
'subdir' => 'add-type',
'files' => [
['.htaccess', $htaccessFile],
['request-me.test', 'hi'],
],
'request' => 'request-me.test',
'interpretation' => [
['success', 'headers', 'contains-key-value', 'Content-Type', 'image/gif'],
['inconclusive', 'status-code', 'not-equals', '200'],
['failure', 'headers', 'not-contains-key-value', 'Content-Type', 'image/gif'],
]
];
parent::__construct($test);
}
}

View File

@@ -0,0 +1,54 @@
<?php
namespace HtaccessCapabilityTester\Testers;
/**
* Class for testing if setting ContentDigest works
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class ContentDigestTester extends CustomTester
{
/**
* Constructor.
*
* @return void
*/
public function __construct()
{
$test = [
'subdir' => 'content-digest',
'subtests' => [
[
'subdir' => 'on',
'files' => [
['.htaccess', 'ContentDigest On'],
['request-me.txt', 'hi'],
],
'request' => 'request-me.txt',
'interpretation' => [
['failure', 'headers', 'not-contains-key', 'Content-MD5'],
]
],
[
'subdir' => 'off',
'files' => [
['.htaccess', 'ContentDigest Off'],
['request-me.txt', "hi"],
],
'request' => 'request-me.txt',
'interpretation' => [
['failure', 'headers', 'contains-key', 'Content-MD5'],
['inconclusive', 'status-code', 'not-equals', '200'],
['success', 'status-code', 'equals', '200'],
]
]
]
];
parent::__construct($test);
}
}

View File

@@ -0,0 +1,87 @@
<?php
namespace HtaccessCapabilityTester\Testers;
use \HtaccessCapabilityTester\TestResult;
/**
* Class for testing if a .htaccess results in a 500 Internal Server Error
* (ie due to being malformed or containing directives that are unknown or not allowed)
*
* Notes:
* - The tester only reports failure on a 500 Internal Server Error. All other status codes (even server errors)
* are treated as a success. The assumption here is that malformed .htaccess files / .htaccess
* files containing unknown or disallowed directives always results in a 500
* - If your purpose is to test if a request succeeds (response 200 Ok), you should create your own class.
* (note that if you want to ensure that a php will succeed, make sure that a php is requested)
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class CrashTester extends CustomTester
{
/**
* @param string $htaccessRules The rules to check
* @param string $subSubDir subdir for the test files. If not supplied, a fingerprint of the rules will be used
*/
public function __construct($htaccessRules, $subSubDir = null)
{
if (is_null($subSubDir)) {
$subSubDir = hash('md5', $htaccessRules);
}
$test = [
'subdir' => 'crash-tester/' . $subSubDir,
'subtests' => [
[
'subdir' => 'the-suspect',
'files' => [
['.htaccess', $htaccessRules],
['request-me.txt', 'thanks'],
],
'request' => [
'url' => 'request-me.txt',
'bypass-standard-error-handling' => ['403', '404', '500']
],
'interpretation' => [
['success', 'status-code', 'not-equals', '500'],
// Otherwise fall through to next subtest
]
],
[
'subdir' => 'the-innocent',
'files' => [
['.htaccess', '# I am no trouble'],
['request-me.txt', 'thanks'],
],
'request' => [
'url' => 'request-me.txt',
'bypass-standard-error-handling' => ['403', '404', '500']
],
'interpretation' => [
// The suspect crashed. But if the innocent crashes too, we cannot judge
['inconclusive', 'status-code', 'equals', '500'],
// The innocent did not crash. The suspect is guilty!
['failure'],
]
],
]
];
parent::__construct($test);
}
/**
* Child classes must implement this method, which tells which subdir the
* test files are to be put.
*
* @return string A subdir for the test files
*/
public function getSubDir()
{
return 'crash-tester';
}
}

View File

@@ -0,0 +1,230 @@
<?php
namespace HtaccessCapabilityTester\Testers;
use \HtaccessCapabilityTester\HtaccessCapabilityTester;
use \HtaccessCapabilityTester\HttpRequesterInterface;
use \HtaccessCapabilityTester\HttpResponse;
use \HtaccessCapabilityTester\SimpleHttpRequester;
use \HtaccessCapabilityTester\TestResult;
use \HtaccessCapabilityTester\Testers\Helpers\ResponseInterpreter;
class CustomTester extends AbstractTester
{
/** @var array A definition defining the test */
protected $test;
/** @var array For convenience, all tests */
private $tests;
/**
* Constructor.
*
* @param array $test The test (may contain subtests)
*
* @return void
*/
public function __construct($test)
{
$this->test = $test;
if (isset($test['subtests'])) {
$this->tests = $test['subtests'];
// Add main subdir to subdir for all subtests
foreach ($this->tests as &$subtest) {
if (isset($subtest['subdir'])) {
$subtest['subdir'] = $test['subdir'] . '/' . $subtest['subdir'];
}
}
} else {
$this->tests = [$test];
}
//echo '<pre>' . print_r($this->tests, true) . '</pre>';
//echo json_encode($this->tests) . '<br>';
parent::__construct();
}
/**
* Register the test files using the "registerTestFile" method
*
* @return void
*/
protected function registerTestFiles()
{
foreach ($this->tests as $test) {
if (isset($test['files'])) {
foreach ($test['files'] as $file) {
// Two syntaxes are allowed:
// - Simple array (ie: ['0.txt', '0']
// - Named, ie: ['filename' => '0.txt', 'content' => '0']
// The second makes more readable YAML definitions
if (isset($file['filename'])) {
$filename = $file['filename'];
$content = $file['content'];
} else {
list ($filename, $content) = $file;
}
$this->registerTestFile($test['subdir'] . '/' . $filename, $content);
}
}
}
}
public function getSubDir()
{
return $this->test['subdir'];
}
/**
* Standard Error handling
*
* @param HttpResponse $response
*
* @return TestResult|null If no errors, null is returned, otherwise a TestResult
*/
private function standardErrorHandling($response)
{
switch ($response->statusCode) {
case '0':
return new TestResult(null, $response->body);
case '403':
return new TestResult(null, '403 Forbidden');
case '404':
return new TestResult(null, '404 Not Found');
case '500':
$hct = $this->getHtaccessCapabilityTester();
// Run innocent request / get it from cache. This sets
// $statusCodeOfLastRequest, which we need now
$hct->innocentRequestWorks();
if ($hct->statusCodeOfLastRequest == '500') {
return new TestResult(null, 'Errored with 500. Everything errors with 500.');
} else {
return new TestResult(
false,
'Errored with 500. ' .
'Not all goes 500, so it must be a forbidden directive in the .htaccess'
);
}
}
return null;
}
/**
* Checks if standard error handling should be bypassed on the test.
*
* This stuff is controlled in the test definition. More precisely, by the "bypass-standard-error-handling"
* property bellow the "request" property. If this property is set to ie ['404', '500'], the standard error
* handler will be bypassed for those codes (but still be in effect for ie '403'). If set to ['all'], all
* standard error handling will be bypassed.
*
* @param array $test the subtest
* @param HttpResponse $response the response
*
* @return bool true if error handling should be bypassed
*/
private function bypassStandardErrorHandling($test, $response)
{
if (!(isset($test['request']['bypass-standard-error-handling']))) {
return false;
}
$bypassErrors = $test['request']['bypass-standard-error-handling'];
if (in_array($response->statusCode, $bypassErrors) || in_array('all', $bypassErrors)) {
return true;
}
return false;
}
/**
* Run single test
*
* @param array $test the subtest to run
*
* @return TestResult Returns a test result
*/
private function realRunSubTest($test)
{
$requestUrl = $this->baseUrl . '/' . $test['subdir'] . '/';
if (isset($test['request']['url'])) {
$requestUrl .= $test['request']['url'];
} else {
$requestUrl .= $test['request'];
}
//echo $requestUrl . '<br>';
$response = $this->makeHttpRequest($requestUrl);
// Standard error handling
if (!($this->bypassStandardErrorHandling($test, $response))) {
$errorResult = $this->standardErrorHandling($response);
if (!is_null($errorResult)) {
return $errorResult;
}
}
return ResponseInterpreter::interpret($response, $test['interpretation']);
}
/**
* Run
*
* @param string $baseDir Directory on the server where the test files can be put
* @param string $baseUrl The base URL of the test files
*
* @return TestResult Returns a test result
* @throws \Exception In case the test cannot be run due to serious issues
*/
private function realRun($baseDir, $baseUrl)
{
$this->prepareForRun($baseDir, $baseUrl);
$result = null;
foreach ($this->tests as $i => $test) {
/*
Disabled, as I'm no longer sure if it is that useful
if (isset($test['requirements'])) {
$hct = $this->getHtaccessCapabilityTester();
foreach ($test['requirements'] as $requirement) {
$requirementResult = $hct->callMethod($requirement);
if (!$requirementResult) {
// Skip test
continue 2;
}
}
}*/
if (isset($test['request'])) {
$result = $this->realRunSubTest($test);
if ($result->info != 'no-match') {
return $result;
}
}
}
if (is_null($result)) {
$result = new TestResult(null, 'Nothing to test!');
}
return $result;
}
/**
* Run
*
* @param string $baseDir Directory on the server where the test files can be put
* @param string $baseUrl The base URL of the test files
*
* @return TestResult Returns a test result
* @throws \Exception In case the test cannot be run due to serious issues
*/
public function run($baseDir, $baseUrl)
{
$testResult = $this->realRun($baseDir, $baseUrl);
// A test might not create a request if it has an unfulfilled requirement
if (isset($this->lastHttpResponse)) {
$testResult->statusCodeOfLastRequest = $this->lastHttpResponse->statusCode;
}
return $testResult;
}
}

View File

@@ -0,0 +1,48 @@
<?php
namespace HtaccessCapabilityTester\Testers;
/**
* Class for testing if DirectoryIndex works
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class DirectoryIndexTester extends CustomTester
{
/**
* Constructor.
*
* @return void
*/
public function __construct()
{
$htaccessFile = <<<'EOD'
<IfModule mod_dir.c>
DirectoryIndex index2.html
</IfModule>
EOD;
$test = [
'subdir' => 'directory-index',
'files' => [
['.htaccess', $htaccessFile],
['index.html', "0"],
['index2.html', "1"]
],
'request' => [
'url' => '', // We request the index, that is why its empty
'bypass-standard-error-handling' => ['404']
],
'interpretation' => [
['success', 'body', 'equals', '1'],
['failure', 'body', 'equals', '0'],
['failure', 'status-code', 'equals', '404'], // "index.html" might not be set to index
]
];
parent::__construct($test);
}
}

View File

@@ -0,0 +1,43 @@
<?php
namespace HtaccessCapabilityTester\Testers;
/**
* Class for testing if Header works
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class HeaderSetTester extends CustomTester
{
/**
* Constructor.
*
* @return void
*/
public function __construct()
{
$htaccessFile = <<<'EOD'
<IfModule mod_headers.c>
Header set X-Response-Header-Test: test
</IfModule>
EOD;
$test = [
'subdir' => 'header-set',
'files' => [
['.htaccess', $htaccessFile],
['request-me.txt', "hi"],
],
'request' => 'request-me.txt',
'interpretation' => [
['success', 'headers', 'contains-key-value', 'X-Response-Header-Test', 'test'],
['failure'],
]
];
parent::__construct($test);
}
}

View File

@@ -0,0 +1,168 @@
<?php
namespace HtaccessCapabilityTester\Testers\Helpers;
use \HtaccessCapabilityTester\HttpResponse;
use \HtaccessCapabilityTester\TestResult;
use \HtaccessCapabilityTester\Testers\AbstractTester;
/**
* Class for interpreting responses using a defined interpretation table.
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class ResponseInterpreter
{
/**
* Parse status string (failure | success | inconclusive) to bool|null.
*
* @param string $statusString (failure | success | inconclusive)
* @return bool|null
*/
private static function parseStatusString($statusString)
{
$status = null;
switch ($statusString) {
case 'failure':
$status = false;
break;
case 'inconclusive':
$status = null;
break;
case 'success':
$status = true;
break;
}
return $status;
}
/**
* Interpret headers line
*
* @param HttpResponse $response
* @param string $operator (has-key | )
* @param string $fieldName field name of the header
* @param string $fieldValue (optional) field value to look for. Only required when
* operator is "contains-key-value" or "not-contains-key-value"
* @return bool true if the condition matches, false otherwise
*/
private static function evaluateHeadersLine($response, $operator, $fieldName, $fieldValue)
{
switch ($operator) {
case 'contains-key':
return $response->hasHeader($fieldName);
case 'not-contains-key':
return (!($response->hasHeader($fieldName)));
case 'contains-key-value':
return $response->hasHeaderValue($fieldName, $fieldValue);
case 'not-contains-key-value':
return (!($response->hasHeaderValue($fieldName, $fieldValue)));
}
return false;
}
/**
* Interpret string line (body or status-code)
*
* @param HttpResponse $response
* @param string $property ("body" or "status-code")
* @param string $operator (is-empty | equals | not-equals | begins-with)
* @param string $arg1 (only required for some operators)
*
* @return bool true if the condition matches, false otherwise
*/
private static function evaluateStringLine($response, $property, $operator, $arg1)
{
$val = '';
switch ($property) {
case 'status-code':
$val = $response->statusCode;
break;
case 'body':
$val = $response->body;
break;
}
switch ($operator) {
case 'is-empty':
return ($val == '');
case 'equals':
return ($val == $arg1);
case 'not-equals':
return ($val != $arg1);
case 'begins-with':
return (strpos($val, $arg1) === 0);
}
return false;
}
/**
* Interpret line.
*
* @param HttpResponse $response
* @param array $line
*
* @return TestResult|null If the condition matches, a TestResult is returned, otherwise null
*/
private static function interpretLine($response, $line)
{
// ie:
// ['inconclusive', 'body', 'is-empty'],
// ['failure', 'statusCode', 'equals', '500']
// ['success', 'headers', 'contains-key-value', 'X-Response-Header-Test', 'test'],
$status = self::parseStatusString($line[0]);
if (!isset($line[1])) {
return new TestResult($status, '');
}
$propertyToExamine = $line[1];
$operator = $line[2];
$arg1 = (isset($line[3]) ? $line[3] : '');
$arg2 = (isset($line[4]) ? $line[4] : '');
if ($propertyToExamine == 'headers') {
$match = self::evaluateHeadersLine($response, $operator, $arg1, $arg2);
} else {
$match = self::evaluateStringLine($response, $propertyToExamine, $operator, $arg1);
}
if ($match) {
$reason = $propertyToExamine . ' ' . $operator;
if (isset($line[3])) {
$reason .= ' "' . implode('" "', array_slice($line, 3)) . '"';
}
/*
if (($propertyToExamine == 'status-code') && ($operator == 'not-equals') && (gettype($val) == 'string')) {
$reason .= ' - it was: ' . $val;
}*/
return new TestResult($status, $reason);
}
return null;
}
/**
* Interpret a response using an interpretation table.
*
* @param HttpResponse $response
* @param array $interpretationTable
*
* @return TestResult If there is no match, the test result will have status = false and
* info = "no-match".
*/
public static function interpret($response, $interpretationTable)
{
foreach ($interpretationTable as $i => $line) {
$testResult = self::interpretLine($response, $line);
if (!is_null($testResult)) {
return $testResult;
}
}
return new TestResult(null, 'no-match');
}
}

View File

@@ -0,0 +1,108 @@
<?php
namespace HtaccessCapabilityTester\Testers;
use \HtaccessCapabilityTester\HtaccessCapabilityTester;
use \HtaccessCapabilityTester\TestResult;
/**
* Class for testing if .htaccess files are processed
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class HtaccessEnabledTester extends AbstractTester
{
/**
* Child classes must implement this method, which tells which subdir the
* test files are to be put.
*
* @return string A subdir for the test files
*/
public function getSubDir()
{
return 'htaccess-enabled';
}
/**
* Register the test files using the "registerTestFile" method
*
* @return void
*/
public function registerTestFiles()
{
// No test files for this test
}
/**
* Run the test.
*
* @param string $baseDir Directory on the server where the test files can be put
* @param string $baseUrl The base URL of the test files
*
* @return TestResult Returns a test result
*/
public function run($baseDir, $baseUrl)
{
$this->prepareForRun($baseDir, $baseUrl);
/*
PS: We could implement this as a definition:
- [success, serverSignatureWorks, is-success]
- [success, contentDigestWorks, is-success]
- [failure, serverSignatureWorks, is-failure]
- [success, canCrash, is-success]
*/
$status = null;
$info = '';
$hct = $this->getHtaccessCapabilityTester();
// If we can find anything that works, well the .htaccess must have been proccesed!
if ($hct->serverSignatureWorks() // Override: None, Status: Core, REQUIRES PHP
|| $hct->contentDigestWorks() // Override: Options, Status: Core
|| $hct->addTypeWorks() // Override: FileInfo, Status: Base, Module: mime
|| $hct->directoryIndexWorks() // Override: Indexes, Status: Base, Module: mod_dir
|| $hct->rewriteWorks() // Override: FileInfo, Status: Extension, Module: rewrite
|| $hct->headerSetWorks() // Override: FileInfo, Status: Extension, Module: headers
) {
$status = true;
} else {
// The serverSignatureWorks() test is special because if it comes out as a failure,
// we can be *almost* certain that the .htaccess has been completely disabled
$serverSignatureWorks = $hct->serverSignatureWorks();
if ($serverSignatureWorks === false) {
$status = false;
$info = 'ServerSignature directive does not work - and it is in core';
} else {
// Last bullet in the gun:
// Try an .htaccess with syntax errors in it.
// (we do this lastly because it may generate an entry in the error log)
$crashTestResult = $hct->crashTest('aoeu', 'htaccess-enabled-malformed-htaccess');
if (is_null($crashTestResult)) {
// Two scenarios:
// 1: All requests fails (without response code)
// 2: The crash test could not figure it out (ie if even innocent requests crashes)
$status = null;
$info = 'all requests fails (even innocent ones)';
} elseif ($crashTestResult === false) {
// It crashed, - which means .htaccess is processed!
$status = true;
$info = 'syntax error in an .htaccess causes crash';
} else {
// It did not crash. So the .htaccess is not processed, as syntax errors
// makes servers crash
$status = false;
$info = 'syntax error in an .htaccess does not cause crash';
}
}
}
return new TestResult($status, $info);
}
}

View File

@@ -0,0 +1,39 @@
<?php
namespace HtaccessCapabilityTester\Testers;
use \HtaccessCapabilityTester\TestResult;
/**
* Class for testing if an innocent request for a txt file succeeds
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class InnocentRequestTester extends CustomTester
{
public function __construct()
{
$test = [
'subdir' => 'innocent-request',
'files' => [
['request-me.txt', 'thank you my dear'],
],
'request' => [
'url' => 'request-me.txt',
'bypass-standard-error-handling' => ['all']
],
'interpretation' => [
['success', 'status-code', 'equals', '200'],
['inconclusive', 'status-code', 'equals', '0'],
['inconclusive', 'status-code', 'equals', '403'],
['inconclusive', 'status-code', 'equals', '404'],
['failure'],
]
];
parent::__construct($test);
}
}

View File

@@ -0,0 +1,369 @@
<?php
namespace HtaccessCapabilityTester\Testers;
use \HtaccessCapabilityTester\TestResult;
/**
* Class for testing if a module is loaded.
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class ModuleLoadedTester extends AbstractTester
{
/* @var string A valid Apache module name (ie "rewrite") */
protected $moduleName;
/**
* Constructor.
*
* @return void
*/
public function __construct($moduleName)
{
$this->moduleName = $moduleName;
}
/**
* Child classes must implement this method, which tells which subdir the
* test files are to be put.
*
* @return string A subdir for the test files
*/
public function getSubDir()
{
return 'module-loaded/' . $this->moduleName;
}
/**
* Register the test files using the "registerTestFile" method
*
* @return void
*/
public function registerTestFiles()
{
// No test files for this test
}
private function getServerSignatureBasedTest()
{
// Test files, method : Using ServerSignature
// --------------------------------------------------
// Requires (in order not to be inconclusive):
// - Override: All
// - Status: Core
// - Directives: ServerSignature, IfModule
// - PHP?: Yes
$php = <<<'EOD'
<?php
if (isset($_SERVER['SERVER_SIGNATURE']) && ($_SERVER['SERVER_SIGNATURE'] != '')) {
echo 1;
} else {
echo 0;
}
EOD;
$htaccess = <<<'EOD'
# The beauty of this trick is that ServerSignature is available in core.
# (it requires no modules and cannot easily be made forbidden)
# However, it requires PHP to check for the effect
ServerSignature Off
<IfModule mod_xxx.c>
ServerSignature On
</IfModule>
EOD;
$htaccess = str_replace('mod_xxx', 'mod_' . $this->moduleName, $htaccess);
return [
'subdir' => $this->getSubDir() . '/server-signature',
'files' => [
['.htaccess', $htaccess],
['test.php', $php],
],
'request' => 'test.php',
'interpretation' => [
['success', 'body', 'equals', '1'],
['failure', 'body', 'equals', '0'],
// This time we do not fail for 500 because it is very unlikely that any of the
// directives used are forbidden
]
];
}
/**
* @return array
*/
private function getRewriteBasedTest()
{
// Test files, method: Using Rewrite
// --------------------------------------------------
// Requires (in order not to be inconclusive)
// - Module: mod_rewrite
// - Override: FileInfo
// - Directives: RewriteEngine, RewriteRule and IfModule
// - PHP?: No
$htaccess = <<<'EOD'
RewriteEngine On
<IfModule mod_xxx.c>
RewriteRule ^request-me\.txt$ 1.txt [L]
</IfModule>
<IfModule !mod_xxx.c>
RewriteRule ^request-me\.txt$ 0.txt [L]
</IfModule>
EOD;
$htaccess = str_replace('mod_xxx', 'mod_' . $this->moduleName, $htaccess);
return [
'subdir' => $this->getSubDir() . '/rewrite',
'files' => [
['.htaccess', $htaccess],
['0.txt', '0'],
['1.txt', '1'],
['request-me.txt', 'Redirect failed even though rewriting has been proven to work. Strange!'],
],
'request' => 'request-me.txt',
'interpretation' => [
['success', 'body', 'equals', '1'],
['failure', 'body', 'equals', '0'],
//['inconclusive', 'status-code', 'not-equals', '200'],
]
];
}
/**
* @return array
*/
private function getHeaderSetBasedTest()
{
// Test files, method: Using Response Header
// --------------------------------------------------
// Requires (in order not to be inconclusive)
// - Module: mod_headers
// - Override: FileInfo
// - Directives: Header and IfModule
// - PHP?: No
$htaccess = <<<'EOD'
<IfModule mod_xxx.c>
Header set X-Response-Header-Test: 1
</IfModule>
<IfModule !mod_xxx.c>
Header set X-Response-Header-Test: 0
</IfModule>
EOD;
$htaccess = str_replace('mod_xxx', 'mod_' . $this->moduleName, $htaccess);
return [
'subdir' => $this->getSubDir() . '/header-set',
'files' => [
['.htaccess', $htaccess],
['request-me.txt', 'thanks'],
],
'request' => 'request-me.txt',
'interpretation' => [
['success', 'headers', 'contains-key-value', 'X-Response-Header-Test', '1'],
['failure', 'headers', 'contains-key-value', 'X-Response-Header-Test', '0'],
]
];
}
/**
* @return array
*/
private function getContentDigestBasedTest()
{
// Test files, method: Using ContentDigest
// --------------------------------------------------
//
// Requires (in order not to be inconclusive)
// - Module: None - its in core
// - Override: Options
// - Directives: ContentDigest
// - PHP?: No
$htaccess = <<<'EOD'
<IfModule mod_xxx.c>
ContentDigest On
</IfModule>
<IfModule !mod_xxx.c>
ContentDigest Off
</IfModule>
EOD;
$htaccess = str_replace('mod_xxx', 'mod_' . $this->moduleName, $htaccess);
return [
'subdir' => $this->getSubDir() . '/content-digest',
'files' => [
['.htaccess', $htaccess],
['request-me.txt', 'thanks'],
],
'request' => 'request-me.txt',
'interpretation' => [
['success', 'headers', 'contains-key', 'Content-MD5'],
['failure', 'headers', 'not-contains-key', 'Content-MD5'],
]
];
}
/**
* @return array
*/
private function getDirectoryIndexBasedTest()
{
// Test files, method: Using DirectoryIndex
// --------------------------------------------------
//
// Requires (in order not to be inconclusive)
// - Module: mod_dir (Status: Base)
// - Override: Indexes
// - Directives: DirectoryIndex
// - PHP?: No
$htaccess = <<<'EOD'
<IfModule mod_xxx.c>
DirectoryIndex 1.html
</IfModule>
<IfModule !mod_xxx.c>
DirectoryIndex 0.html
</IfModule>
EOD;
$htaccess = str_replace('mod_xxx', 'mod_' . $this->moduleName, $htaccess);
return [
'subdir' => $this->getSubDir() . '/directory-index',
'files' => [
['.htaccess', $htaccess],
['0.html', '0'],
['1.html', '1'],
],
'request' => '', // empty - in order to request the index
'interpretation' => [
['success', 'body', 'equals', '1'],
['failure', 'body', 'equals', '0'],
]
];
}
/**
* @return array
*/
private function getAddTypeBasedTest()
{
// Test files, method: Using AddType
// --------------------------------------------------
//
// Requires (in order not to be inconclusive)
// - Module: mod_mime
// - Override: FileInfo
// - Directives: AddType and IfModule
// - PHP?: No
$htaccess = <<<'EOD'
<IfModule mod_xxx.c>
AddType image/gif .test
</IfModule>
<IfModule !mod_xxx.c>
AddType image/jpeg .test
</IfModule>
EOD;
$htaccess = str_replace('mod_xxx', 'mod_' . $this->moduleName, $htaccess);
return [
'subdir' => $this->getSubDir() . '/add-type',
'files' => [
['.htaccess', $htaccess],
['request-me.test', 'hi'],
],
'request' => 'request-me.test',
'interpretation' => [
['success', 'headers', 'contains-key-value', 'Content-Type', 'image/gif'],
['failure', 'headers', 'contains-key-value', 'Content-Type', 'image/jpeg'],
]
];
}
/**
* @return bool|null
*/
private function run2()
{
$hct = $this->getHtaccessCapabilityTester();
$testResult = $hct->customTest($this->getServerSignatureBasedTest());
if (!is_null($testResult)) {
// PHP
return $testResult;
}
if ($hct->contentDigestWorks()) {
// Override: Options
return $hct->customTest($this->getContentDigestBasedTest());
}
if ($hct->addTypeWorks()) {
// Override: FileInfo, Status: Base (mod_mime)
return $hct->customTest($this->getAddTypeBasedTest());
}
if ($hct->directoryIndexWorks()) {
// Override: Indexes, Status: Base (mod_dir)
return $hct->customTest($this->getDirectoryIndexBasedTest());
}
if ($hct->rewriteWorks()) {
// Override: FileInfo, Module: mod_rewrite
return $hct->customTest($this->getRewriteBasedTest());
}
if ($hct->headerSetWorks()) {
//Override: FileInfo, Module: mod_headers
return $hct->customTest($this->getHeaderSetBasedTest());
}
return null;
}
/**
* Run the test.
*
* @param string $baseDir Directory on the server where the test files can be put
* @param string $baseUrl The base URL of the test files
*
* @return TestResult Returns a test result
*/
public function run($baseDir, $baseUrl)
{
$this->prepareForRun($baseDir, $baseUrl);
$hct = $this->getHtaccessCapabilityTester();
$htaccessEnabledTest = $hct->htaccessEnabled();
if ($htaccessEnabledTest === false) {
return new TestResult(false, '.htaccess files are ignored');
} elseif (is_null($htaccessEnabledTest)) {
// We happen to know that if that test cannot establish anything,
// then none of the usual weapons works - we can surrender right away
return new TestResult(null, 'no methods available - we surrender early');
}
$status = $this->run2();
if (is_null($status)) {
return new TestResult(null, 'no methods worked');
} else {
return new TestResult($status, '');
}
}
}

View File

@@ -0,0 +1,81 @@
<?php
namespace HtaccessCapabilityTester\Testers;
/**
* Class for testing if an environment variable can be set in a rewrite rule and received in PHP.
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class PassInfoFromRewriteToScriptThroughEnvTester extends CustomTester
{
/**
* Constructor.
*
* @return void
*/
public function __construct()
{
$htaccessFile = <<<'EOD'
<IfModule mod_rewrite.c>
# Testing if we can pass environment variable from .htaccess to script in a RewriteRule
# We pass document root, because that can easily be checked by the script
RewriteEngine On
RewriteRule ^test\.php$ - [E=PASSTHROUGHENV:%{DOCUMENT_ROOT},L]
</IfModule>
EOD;
$phpFile = <<<'EOD'
<?php
/**
* Get environment variable set with mod_rewrite module
* Return false if the environment variable isn't found
*/
function getEnvPassedInRewriteRule($envName) {
// Environment variables passed through the REWRITE module have "REWRITE_" as a prefix
// (in Apache, not Litespeed, if I recall correctly).
// Multiple iterations causes multiple REWRITE_ prefixes, and we get many environment variables set.
// We simply look for an environment variable that ends with what we are looking for.
// (so make sure to make it unique)
$len = strlen($envName);
foreach ($_SERVER as $key => $item) {
if (substr($key, -$len) == $envName) {
return $item;
}
}
return false;
}
$result = getEnvPassedInRewriteRule('PASSTHROUGHENV');
if ($result === false) {
echo '0';
exit;
}
echo ($result == $_SERVER['DOCUMENT_ROOT'] ? '1' : '0');
EOD;
$test = [
'subdir' => 'pass-info-from-rewrite-to-script-through-env',
'files' => [
['.htaccess', $htaccessFile],
['test.php', $phpFile],
],
'request' => 'test.php',
'interpretation' => [
['success', 'body', 'equals', '1'],
['failure', 'body', 'equals', '0'],
['inconclusive', 'body', 'begins-with', '<' . '?php'],
['inconclusive']
]
];
parent::__construct($test);
}
}

View File

@@ -0,0 +1,65 @@
<?php
namespace HtaccessCapabilityTester\Testers;
/**
* Say you have a rewrite rule that points to a PHP script and you would like to pass some information
* along to the PHP. Usually, you will just pass it in the query string. But this won't do if the information
* is sensitive. In that case, there are some tricks available. The trick being tested here sets tells the
* RewriteRule directive to set an environment variable which a RequestHeader directive picks up on and passes
* on to the script in a request header.
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class PassInfoFromRewriteToScriptThroughRequestHeaderTester extends CustomTester
{
/**
* Constructor.
*
* @return void
*/
public function __construct()
{
$htaccessFile = <<<'EOD'
<IfModule mod_rewrite.c>
RewriteEngine On
# We pass document root, because that can easily be checked by the script
RewriteRule ^test\.php$ - [E=PASSTHROUGHHEADER:%{DOCUMENT_ROOT},L]
<IfModule mod_headers.c>
RequestHeader set PASSTHROUGHHEADER "%{PASSTHROUGHHEADER}e" env=PASSTHROUGHHEADER
</IfModule>
</IfModule>
EOD;
$phpFile = <<<'EOD'
<?php
if (isset($_SERVER['HTTP_PASSTHROUGHHEADER'])) {
echo ($_SERVER['HTTP_PASSTHROUGHHEADER'] == $_SERVER['DOCUMENT_ROOT'] ? 1 : 0);
exit;
}
echo '0';
EOD;
$test = [
'subdir' => 'pass-info-from-rewrite-to-script-through-request-header',
'files' => [
['.htaccess', $htaccessFile],
['test.php', $phpFile],
],
'request' => 'test.php',
'interpretation' => [
['success', 'body', 'equals', '1'],
['failure', 'body', 'equals', '0'],
['inconclusive', 'body', 'begins-with', '<' . '?php'],
['inconclusive']
]
];
parent::__construct($test);
}
}

View File

@@ -0,0 +1,59 @@
<?php
namespace HtaccessCapabilityTester\Testers;
/**
* Class for testing if RequestHeader works
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class RequestHeaderTester extends CustomTester
{
/**
* Constructor.
*
* @return void
*/
public function __construct()
{
$htaccessFile = <<<'EOD'
<IfModule mod_headers.c>
# Certain hosts seem to strip non-standard request headers,
# so we use a standard one to avoid a false negative
RequestHeader set User-Agent "request-header-test"
</IfModule>
EOD;
$phpFile = <<<'EOD'
<?php
if (isset($_SERVER['HTTP_USER_AGENT'])) {
echo (($_SERVER['HTTP_USER_AGENT'] == 'request-header-test') ? "1" : "0");
} else {
echo "0";
}
EOD;
// PS:
// There is a little edge case: When .htaccess is disabled AND phps are either not processed
// or access is denied. This ought to return *failure*, but it currently returns *inconclusive*.
$test = [
'subdir' => 'request-header',
'files' => [
['.htaccess', $htaccessFile],
['test.php', $phpFile],
],
'request' => 'test.php',
'interpretation' => [
['success', 'body', 'equals', '1'],
['failure', 'body', 'equals', '0'],
['inconclusive', 'body', 'begins-with', '<' . '?php'],
]
];
parent::__construct($test);
}
}

View File

@@ -0,0 +1,93 @@
<?php
namespace HtaccessCapabilityTester\Testers;
/**
* Class for testing if rewriting works at the tested location.
*
* The tester reports success when:
* - a rewrite is proven to be working
*
* The tester reports failure when:
* - Server does not have mod_rewrite installed
* - Server is set up to ignore .htaccess files in the directory
* - Server disallows any the following directives in the directory: RewriteEngine, Rewrite, IfModule
* (if disallowed, the result is either a 500 Internal Server Error or that the directive is
* ignored, depending on whether Nonfatal is set)
* - The request results in a 500 Internal Server Error due to another problem than a disallowed
* directive (this is, there is a risk for a false negative)
*
* The test works by creating an .htaccess which redirects requests to "0.txt"
* to "1.txt" and then requesting "0.txt".
*
* Notes:
* - The test might result in the following being written to the error log:
* "RewriteEngine not allowed here"
* - We are not redirecting to a php, because that would additionally require phps
* to be run in that directory
* - We are wrapping the .htaccess directives in a "<IfModule mod_rewrite.c>" and therefore this test
* also relies on the IfModule directive being allowed. It probably usually is, as it is harmless.
* Also, it is good practice to use it, so in most cases it is good that this is checked
* too. Actually, the <IfModule> wrap isn't neccessary for our test to work, as the test
* identifies a 500 Internal Error as test failure. However, not having the wrap would
* cause the test to generate an entry in the error log when mod_rewrite isn't installed
* (regardless if overrides are configured to Nonfatal or not):
* "Invalid command 'RewriteEngine', perhaps misspelled or defined by a module not included
* in the server configuration"
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class RewriteTester extends CustomTester
{
/**
* Constructor.
*
* @return void
*/
public function __construct()
{
$htaccessFile = <<<'EOD'
# Testing for mod_rewrite
# -----------------------
# If mod_rewrite is enabled, redirect to 1.txt, which returns "1".
# If mod_rewrite is disabled, the rewriting fails, and we end at 0.txt, which returns "0".
#
# Notes:
# - We are not redirecting to a php, because that would additionally require phps
# to be run in that directory
# - We are wrapping it in a "<IfModule mod_rewrite.c>" and therefore this test also relies
# on the IfModule directive being allowed. It probably usually is, as it is harmless.
# Also, it is good practice to use it, so in most cases it is good that this is checked
# too. Actually, the <IfModule> wrap isn't neccessary for our test to work, as the test
# identifies a 500 Internal Error as test failure. However, not having the wrap would
# cause the test to generate an entry in the error log when mod_rewrite isn't installed
# (regardless if configured to Nonfatal or not): "Invalid command 'RewriteEngine', perhaps
# misspelled or defined by a module not included
# in the server configuration"
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteRule ^0\.txt$ 1\.txt [L]
</IfModule>
EOD;
$test = [
'subdir' => 'rewrite',
'files' => [
['.htaccess', $htaccessFile],
['0.txt', "0"],
['1.txt', "1"]
],
'request' => '0.txt',
'interpretation' => [
['success', 'body', 'equals', '1'],
['failure', 'body', 'equals', '0'],
]
];
parent::__construct($test);
}
}

View File

@@ -0,0 +1,93 @@
<?php
namespace HtaccessCapabilityTester\Testers;
/**
* Class for testing if ServerSignature works
*
* Testing the ServerSignature directive is of interest because the directive is a core feature.
* If a core feature doesn't work, well, it it would seem that .htaccess files are disabled completely.
* The test is thus special. If it returns *failure* it is highly probable that the .htaccess file has
* not been read.
*
* Unfortunately, the test requires PHP to examine if a server variable has been set. So the test is not
* unlikely to come out inconclusive due to a 403 Forbidden.
*
* Note that the test assumes that the ServerSignature directive has not been disallowed even though
* it is technically possible to do so by setting *AllowOverride* to *None* and by setting *AllowOverrideList*
* to a list that does not include *ServerSignature*.
*
* @package HtaccessCapabilityTester
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since 0.7
*/
class ServerSignatureTester extends CustomTester
{
/**
* Constructor.
*
* @return void
*/
public function __construct()
{
$phpOn = <<<'EOD'
<?php
if (isset($_SERVER['SERVER_SIGNATURE']) && ($_SERVER['SERVER_SIGNATURE'] != '')) {
echo 1;
} else {
echo 0;
}
EOD;
$phpOff = <<<'EOD'
<?php
if (isset($_SERVER['SERVER_SIGNATURE']) && ($_SERVER['SERVER_SIGNATURE'] != '')) {
echo 0;
} else {
echo 1;
}
EOD;
// PS:
// There is a little edge case: When .htaccess is disabled AND phps are either not processed
// or access is denied. This ought to return *failure*, but it currently returns *inconclusive*.
$test = [
'subdir' => 'server-signature',
'subtests' => [
[
'subdir' => 'on',
'files' => [
['.htaccess', 'ServerSignature On'],
['test.php', $phpOn],
],
'request' => [
'url' => 'test.php',
],
'interpretation' => [
['inconclusive', 'body', 'isEmpty'],
['inconclusive', 'status-code', 'not-equals', '200'],
['failure', 'body', 'equals', '0'],
],
],
[
'subdir' => 'off',
'files' => [
['.htaccess', 'ServerSignature Off'],
['test.php', $phpOff],
],
'request' => 'test.php',
'interpretation' => [
['inconclusive', 'body', 'isEmpty'],
['success', 'body', 'equals', '1'],
['failure', 'body', 'equals', '0'],
['inconclusive']
]
]
]
];
parent::__construct($test);
}
}

View File

@@ -0,0 +1,9 @@
MIT License
Copyright (c) 2018 Bjørn Rosell
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@@ -0,0 +1,55 @@
<?php
namespace ImageMimeTypeGuesser\Detectors;
use ImageMimeTypeGuesser\Detectors\AbstractDetector;
abstract class AbstractDetector
{
/**
* Try to detect mime type of image
*
* Returns:
* - mime type (string) (if it is in fact an image, and type could be determined)
* - false (if it is not an image type that the server knowns about)
* - null (if nothing can be determined)
*
* @param string $filePath The path to the file
* @return string|false|null mimetype (if it is an image, and type could be determined),
* false (if it is not an image type that the server knowns about)
* or null (if nothing can be determined)
*/
abstract protected function doDetect($filePath);
/**
* Create an instance of this class
*
* @param string $filePath The path to the file
* @return static
*/
public static function createInstance()
{
return new static();
}
/**
* Detect mime type of file (for images only)
*
* Returns:
* - mime type (string) (if it is in fact an image, and type could be determined)
* - false (if it is not an image type that the server knowns about)
* - null (if nothing can be determined)
*
* @param string $filePath The path to the file
* @return string|false|null mimetype (if it is an image, and type could be determined),
* false (if it is not an image type that the server knowns about)
* or null (if nothing can be determined)
*/
public static function detect($filePath)
{
if (!@file_exists($filePath)) {
return false;
}
return self::createInstance()->doDetect($filePath);
}
}

View File

@@ -0,0 +1,43 @@
<?php
namespace ImageMimeTypeGuesser\Detectors;
use \ImageMimeTypeGuesser\Detectors\AbstractDetector;
class ExifImageType extends AbstractDetector
{
/**
* Try to detect mime type of image using *exif_imagetype*.
*
* Returns:
* - mime type (string) (if it is in fact an image, and type could be determined)
* - false (if it is not an image type that the server knowns about)
* - null (if nothing can be determined)
*
* @param string $filePath The path to the file
* @return string|false|null mimetype (if it is an image, and type could be determined),
* false (if it is not an image type that the server knowns about)
* or null (if nothing can be determined)
*/
protected function doDetect($filePath)
{
// exif_imagetype is fast, however not available on all systems,
// It may return false. In that case we can rely on that the file is not an image (and return false)
if (function_exists('exif_imagetype')) {
try {
$imageType = exif_imagetype($filePath);
return ($imageType ? image_type_to_mime_type($imageType) : false);
} catch (\Exception $e) {
// Might for example get "Read error!"
// (for some reason, this happens on very small files)
// We handle such errors as indeterminable (null)
return null;
// well well, don't let this stop us
//echo $e->getMessage();
//throw($e);
}
}
return null;
}
}

View File

@@ -0,0 +1,44 @@
<?php
namespace ImageMimeTypeGuesser\Detectors;
class FInfo extends AbstractDetector
{
/**
* Try to detect mime type of image using *finfo* class.
*
* Returns:
* - mime type (string) (if it is in fact an image, and type could be determined)
* - false (if it is not an image type that the server knowns about)
* - null (if nothing can be determined)
*
* @param string $filePath The path to the file
* @return string|false|null mimetype (if it is an image, and type could be determined),
* false (if it is not an image type that the server knowns about)
* or null (if nothing can be determined)
*/
protected function doDetect($filePath)
{
if (class_exists('finfo')) {
// phpcs:ignore PHPCompatibility.PHP.NewClasses.finfoFound
$finfo = new \finfo(FILEINFO_MIME);
$result = $finfo->file($filePath);
if ($result === false) {
// false means an error occured
return null;
} else {
$mime = explode('; ', $result);
$result = $mime[0];
if (strpos($result, 'image/') === 0) {
return $result;
} else {
return false;
}
}
}
return null;
}
}

View File

@@ -0,0 +1,36 @@
<?php
namespace ImageMimeTypeGuesser\Detectors;
class GetImageSize extends AbstractDetector
{
/**
* Try to detect mime type of image using *getimagesize()*.
*
* Returns:
* - mime type (string) (if it is in fact an image, and type could be determined)
* - false (if it is not an image type that the server knowns about)
* - null (if nothing can be determined)
*
* @param string $filePath The path to the file
* @return string|false|null mimetype (if it is an image, and type could be determined),
* false (if it is not an image type that the server knowns about)
* or null (if nothing can be determined)
*/
protected function doDetect($filePath)
{
// getimagesize is slower than exif_imagetype
// It may not return "mime". In that case we can rely on that the file is not an image (and return false)
if (function_exists('getimagesize')) {
try {
$imageSize = getimagesize($filePath);
return (isset($imageSize['mime']) ? $imageSize['mime'] : false);
} catch (\Exception $e) {
// well well, don't let this stop us either
return null;
}
}
return null;
}
}

View File

@@ -0,0 +1,45 @@
<?php
namespace ImageMimeTypeGuesser\Detectors;
class MimeContentType extends AbstractDetector
{
/**
* Try to detect mime type of image using *mime_content_type()*.
*
* Returns:
* - mime type (string) (if it is in fact an image, and type could be determined)
* - false (if it is not an image type that the server knowns about)
* - null (if nothing can be determined)
*
* @param string $filePath The path to the file
* @return string|false|null mimetype (if it is an image, and type could be determined),
* false (if it is not an image type that the server knowns about)
* or null (if nothing can be determined)
*/
protected function doDetect($filePath)
{
// mime_content_type supposedly used to be deprecated, but it seems it isn't anymore
// it may return false on failure.
if (function_exists('mime_content_type')) {
try {
$result = mime_content_type($filePath);
if ($result !== false) {
if (strpos($result, 'image/') === 0) {
return $result;
} else {
return false;
}
}
} catch (\Exception $e) {
// we are unstoppable!
// TODO:
// We should probably throw... - we will do in version 1.0.0
//throw $e;
}
}
return null;
}
}

View File

@@ -0,0 +1,144 @@
<?php
namespace ImageMimeTypeGuesser\Detectors;
use \ImageMimeTypeGuesser\Detectors\AbstractDetector;
class SniffFirstFourBytes extends AbstractDetector
{
/**
* Try to detect mime type by sniffing the first four bytes.
*
* Returns:
* - mime type (string) (if it is in fact an image, and type could be determined)
* - false (if it is not an image type that the server knowns about)
* - null (if nothing can be determined)
*
* @param string $filePath The path to the file
* @return string|false|null mimetype (if it is an image, and type could be determined),
* false (if it is not an image type that the server knowns about)
* or null (if nothing can be determined)
*/
protected function doDetect($filePath)
{
$handle = @fopen($filePath, 'r');
if ($handle === false) {
return null;
}
// 20 bytes is sufficient for all our sniffers, except image/svg+xml.
// The svg sniffer takes care of reading more
$sampleBin = @fread($handle, 20);
if ($sampleBin === false) {
return null;
}
$firstByte = $sampleBin[0];
$sampleHex = strtoupper(bin2hex($sampleBin));
$hexPatterns = [];
$binPatterns = [];
// https://www.rapidtables.com/convert/number/hex-to-ascii.html
switch ($firstByte) {
case "\x00":
$hexPatterns[] = ['image/x-icon', "/^00000(1?2)00/"];
if (preg_match("/^.{8}6A502020/", $sampleHex) === 1) {
// jpeg-2000 - a bit more complex, as block size may vary
// https://www.file-recovery.com/jp2-signature-format.htm
$block1Size = hexdec("0x" . substr($sampleHex, 0, 8));
$moreBytes = @fread($handle, $block1Size + 4 + 8);
if ($moreBytes !== false) {
$sampleBin .= $moreBytes;
}
if (substr($sampleBin, $block1Size + 4, 4) == 'ftyp') {
$subtyp = substr($sampleBin, $block1Size + 8, 4);
if ($subtyp == 'mjp2') {
return 'video/mj2';
} else {
return 'image/' . rtrim($subtyp);
}
}
}
break;
case "8":
$binPatterns[] = ['application/psd', "/^8BPS/"];
break;
case "B":
$binPatterns[] = ['image/bmp', "/^BM/"];
break;
case "G":
$binPatterns[] = ['image/gif', "/^GIF8(7|9)a/"];
break;
case "I":
$hexPatterns[] = ['image/tiff', "/^(49492A00|4D4D002A)/"];
break;
case "R":
// PS: Another library is more specific: /^RIFF.{4}WEBPVP/
// Is "VP" always there?
$binPatterns[] = ['image/webp', "/^RIFF.{4}WEBP/"];
break;
case "<":
// Another library looks for end bracket for svg.
// We do not, as it requires more bytes read.
// Note that <xml> tag might be big too... - so we read in 200 extra
$moreBytes = @fread($handle, 200);
if ($moreBytes !== false) {
$sampleBin .= $moreBytes;
}
$binPatterns[] = ['image/svg+xml', "/^(<\?xml[^>]*\?>.*)?<svg/is"];
break;
case "f":
//$hexPatterns[] = ['image/heic', "/667479706865(6963|6978|7663|696D|6973|766D|7673)/"];
//$hexPatterns[] = ['image/heif', "/667479706D(69|73)6631)/"];
$binPatterns[] = ['image/heic', "/ftyphe(ic|ix|vc|im|is|vm|vs)/"];
$binPatterns[] = ['image/heif', "/ftypm(i|s)f1/"];
break;
case "\x89":
$hexPatterns[] = ['image/png', "/^89504E470D0A1A0A/"];
break;
case "\xFF":
$hexPatterns[] = ['image/jpeg', "/^FFD8FF(DB|E0|EE|E1)/"];
break;
}
foreach ($hexPatterns as list($mime, $pattern)) {
if (preg_match($pattern, $sampleHex) === 1) {
return $mime;
}
}
foreach ($binPatterns as list($mime, $pattern)) {
if (preg_match($pattern, $sampleBin) === 1) {
return $mime;
}
}
return null;
/*
https://en.wikipedia.org/wiki/List_of_file_signatures
https://github.com/zjsxwc/mime-type-sniffer/blob/master/src/MimeTypeSniffer/MimeTypeSniffer.php
http://phil.lavin.me.uk/2011/12/php-accurately-detecting-the-type-of-a-file/
*/
// TODO: JPEG 2000
// mime types: image/jp2, image/jpf, image/jpx, image/jpm
// http://fileformats.archiveteam.org/wiki/JPEG_2000
// https://www.file-recovery.com/jp2-signature-format.htm
/*
From: https://github.com/Tinram/File-Identifier/blob/master/src/FileSignatures.php
'JPG 2000' => '00 00 00 0c 6a 50 20 20 0d 0a 87 0a',
https://filesignatures.net/index.php?page=search&search=JP2&mode=EXT
*/
}
}

View File

@@ -0,0 +1,42 @@
<?php
namespace ImageMimeTypeGuesser\Detectors;
class Stack extends AbstractDetector
{
/**
* Try to detect mime type of image using all available detectors.
*
* Returns:
* - mime type (string) (if it is in fact an image, and type could be determined)
* - false (if it is not an image type that the server knowns about)
* - null (if nothing can be determined)
*
* @param string $filePath The path to the file
* @return string|false|null mimetype (if it is an image, and type could be determined),
* false (if it is not an image type that the server knowns about)
* or null (if nothing can be determined)
*/
protected function doDetect($filePath)
{
$detectors = [
'FInfo',
'SniffFirstFourBytes',
'ExifImageType',
//'GetImageSize', // Disabled, as documentation says it is unreliable
'MimeContentType',
];
foreach ($detectors as $className) {
$result = call_user_func(
array("\\ImageMimeTypeGuesser\\Detectors\\" . $className, 'detect'),
$filePath
);
if (!is_null($result)) {
return $result;
}
}
return null; // undetermined
}
}

View File

@@ -0,0 +1,90 @@
<?php
/**
* ImageMimeTypeGuesser - Detect / guess mime type of an image
*
* @link https://github.com/rosell-dk/image-mime-type-guesser
* @license MIT
*/
namespace ImageMimeTypeGuesser;
class GuessFromExtension
{
/**
* Make a wild guess based on file extension.
*
* - and I mean wild!
*
* Only most popular image types are recognized.
* Many are not. See this list: https://www.iana.org/assignments/media-types/media-types.xhtml
* - and the constants here: https://secure.php.net/manual/en/function.exif-imagetype.php
*
* If no mapping found, nothing is returned
*
* TODO: jp2, jpx, ...
* Returns:
* - mimetype (if file extension could be mapped to an image type),
* - false (if file extension could be mapped to a type known not to be an image type)
* - null (if file extension could not be mapped to any mime type, using our little list)
*
* @param string $filePath The path to the file
* @return string|false|null mimetype (if file extension could be mapped to an image type),
* false (if file extension could be mapped to a type known not to be an image type)
* or null (if file extension could not be mapped to any mime type, using our little list)
*/
public static function guess($filePath)
{
if (!@file_exists($filePath)) {
return false;
}
/*
Not using pathinfo, as it is locale aware, and I'm not sure if that could lead to problems
if (!function_exists('pathinfo')) {
// This is really a just in case! - We do not expect this to happen.
// - in fact we have a test case asserting that this does not happen.
return null;
//
$fileExtension = pathinfo($filePath, PATHINFO_EXTENSION);
$fileExtension = strtolower($fileExtension);
}*/
$result = preg_match('#\\.([^.]*)$#', $filePath, $matches);
if ($result !== 1) {
return null;
}
$fileExtension = $matches[1];
// Trivial image mime types
if (in_array($fileExtension, ['apng', 'avif', 'bmp', 'gif', 'jpeg', 'png', 'tiff', 'webp'])) {
return 'image/' . $fileExtension;
}
// Common extensions that are definitely not images
if (in_array($fileExtension, ['txt', 'doc', 'zip', 'gz', 'exe'])) {
return false;
}
// Non-trivial image mime types
switch ($fileExtension) {
case 'ico':
case 'cur':
return 'image/x-icon'; // or perhaps 'vnd.microsoft.icon' ?
case 'jpg':
return 'image/jpeg';
case 'svg':
return 'image/svg+xml';
case 'tif':
return 'image/tiff';
}
// We do not know this extension, return null
return null;
}
}

View File

@@ -0,0 +1,134 @@
<?php
/**
* ImageMimeTypeGuesser - Detect / guess mime type of an image
*
* The library is born out of a discussion here:
* https://github.com/rosell-dk/webp-convert/issues/98
*
* @link https://github.com/rosell-dk/image-mime-type-guesser
* @license MIT
*/
namespace ImageMimeTypeGuesser;
use \ImageMimeTypeGuesser\Detectors\Stack;
class ImageMimeTypeGuesser
{
/**
* Try to detect mime type of image using all available detectors (the "stack" detector).
*
* Returns:
* - mime type (string) (if it is in fact an image, and type could be determined)
* - false (if it is not an image type that the server knowns about)
* - null (if nothing can be determined)
*
* @param string $filePath The path to the file
* @return string|false|null mimetype (if it is an image, and type could be determined),
* false (if it is not an image type that the server knowns about)
* or null (if nothing can be determined)
*/
public static function detect($filePath)
{
return Stack::detect($filePath);
}
/**
* Try to detect mime type of image. If that fails, make a guess based on the file extension.
*
* Try to detect mime type of image using "stack" detector (all available methods, until one succeeds)
* If that fails (null), fall back to wild west guessing based solely on file extension.
*
* Returns:
* - mime type (string) (if it is an image, and type could be determined / mapped from file extension))
* - false (if it is not an image type that the server knowns about)
* - null (if nothing can be determined)
*
* @param string $filePath The path to the file
* @return string|false|null mimetype (if it is an image, and type could be determined),
* false (if it is not an image type that the server knowns about)
* or null (if nothing can be determined)
*/
public static function guess($filePath)
{
$detectionResult = self::detect($filePath);
if (!is_null($detectionResult)) {
return $detectionResult;
}
// fall back to the wild west method
return GuessFromExtension::guess($filePath);
}
/**
* Try to detect mime type of image. If that fails, make a guess based on the file extension.
*
* Try to detect mime type of image using "stack" detector (all available methods, until one succeeds)
* If that fails (false or null), fall back to wild west guessing based solely on file extension.
*
* Returns:
* - mime type (string) (if it is an image, and type could be determined / mapped from file extension)
* - false (if it is not an image type that the server knowns about)
* - null (if nothing can be determined)
*
* @param string $filePath The path to the file
* @return string|false|null mimetype (if it is an image, and type could be determined / guessed),
* false (if it is not an image type that the server knowns about)
* or null (if nothing can be determined)
*/
public static function lenientGuess($filePath)
{
$detectResult = self::detect($filePath);
if ($detectResult === false) {
// The server does not recognize this image type.
// - but perhaps it is because it does not know about this image type.
// - so we turn to mapping the file extension
return GuessFromExtension::guess($filePath);
} elseif (is_null($detectResult)) {
// the mime type could not be determined
// perhaps we also in this case want to turn to mapping the file extension
return GuessFromExtension::guess($filePath);
}
return $detectResult;
}
/**
* Check if the *detected* mime type is in a list of accepted mime types.
*
* @param string $filePath The path to the file
* @param string[] $mimeTypes Mime types to accept
* @return bool Whether the detected mime type is in the $mimeTypes array or not
*/
public static function detectIsIn($filePath, $mimeTypes)
{
return in_array(self::detect($filePath), $mimeTypes);
}
/**
* Check if the *guessed* mime type is in a list of accepted mime types.
*
* @param string $filePath The path to the file
* @param string[] $mimeTypes Mime types to accept
* @return bool Whether the detected / guessed mime type is in the $mimeTypes array or not
*/
public static function guessIsIn($filePath, $mimeTypes)
{
return in_array(self::guess($filePath), $mimeTypes);
}
/**
* Check if the *leniently guessed* mime type is in a list of accepted mime types.
*
* @param string $filePath The path to the file
* @param string[] $mimeTypes Mime types to accept
* @return bool Whether the detected / leniently guessed mime type is in the $mimeTypes array or not
*/
public static function lenientGuessIsIn($filePath, $mimeTypes)
{
return in_array(self::lenientGuess($filePath), $mimeTypes);
}
}

View File

@@ -0,0 +1,9 @@
MIT License
Copyright (c) 2018 Bjørn Rosell
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@@ -0,0 +1,99 @@
<?php
namespace WebPConvertCloudService;
use \WebPConvertCloudService\WebPConvertCloudService;
class AccessCheck
{
private static function accessDenied($msg)
{
WebPConvertCloudService::exitWithError(WebPConvertCloudService::ERROR_ACCESS_DENIED, $msg);
}
/**
* Test an IP (ie "212.67.80.1") against a pattern (ie "212.*")
*/
private static function testIpPattern($ip, $pattern)
{
$regEx = '/^' . str_replace('*', '.*', $pattern) . '$/';
if (preg_match($regEx, $ip)) {
return true;
}
return false;
}
public static function runAccessChecks($options)
{
$accessOptions = $options['access'];
$onWhitelist = false;
if (isset($accessOptions['whitelist']) && count($accessOptions['whitelist']) > 0) {
foreach ($accessOptions['whitelist'] as $whitelistItem) {
if (isset($whitelistItem['ip'])) {
if (!self::testIpPattern($_SERVER['REMOTE_ADDR'], $whitelistItem['ip'])) {
continue;
}
}
$onWhitelist = true;
if (!isset($whitelistItem['api-key']) || $whitelistItem['api-key'] == '') {
// This item requires no api key
// Access granted!
return;
}
if (isset($_POST['salt']) && isset($_POST['api-key-crypted'])) {
if (CRYPT_BLOWFISH == 1) {
// Strip off the first 28 characters (the first 6 are always "$2y$10$". The next 22 is the salt)
$cryptedKey = substr(crypt($whitelistItem['api-key'], '$2y$10$' . $_POST['salt'] . '$'), 28);
if ($_POST['api-key-crypted'] == $cryptedKey) {
// Access granted!
return;
}
} else {
// trouble...
}
} else {
$hashingRequired = (
isset($whitelistItem['require-api-key-to-be-crypted-in-transfer']) &&
$whitelistItem['require-api-key-to-be-crypted-in-transfer']
);
if (!$hashingRequired && isset($_POST['api-key'])) {
if ($_POST['api-key'] == $whitelistItem['api-key']) {
// Access granted!
return;
}
}
}
}
}
if ($onWhitelist) {
if (isset($_POST['salt']) && isset($_POST['api-key-crypted'])) {
self::accessDenied('Invalid api key');
} else {
if (isset($_POST['api-key'])) {
self::accessDenied('Either api key is invalid, or you must crypt the api key');
} else {
if (isset($_POST['salt']) && isset($_POST['api-key-crypted'])) {
self::accessDenied('You need to supply a valid api key');
} else {
if (!isset($_POST['api-key-crypted'])) {
self::accessDenied('You need to supply an api key');
} else {
if (!isset($_POST['salt'])) {
self::accessDenied('You must supply salt to go with you encripted api key');
}
}
}
}
}
} else {
self::accessDenied('Access denied');
}
}
}

View File

@@ -0,0 +1,139 @@
<?php
namespace WebPConvertCloudService;
use \WebPConvertCloudService\WebPConvertCloudService;
use \WebPConvert\WebPConvert;
class Serve
{
private static function configurationError($msg)
{
WebPConvertCloudService::exitWithError(WebPConvertCloudService::ERROR_CONFIGURATION, $msg);
}
private static function accessDenied($msg)
{
WebPConvertCloudService::exitWithError(WebPConvertCloudService::ERROR_ACCESS_DENIED, $msg);
}
private static function runtimeError($msg)
{
WebPConvertCloudService::exitWithError(WebPConvertCloudService::ERROR_RUNTIME, $msg);
}
public static function serve($options)
{
$uploaddir = $options['destination-dir'] ;
if (!is_dir($uploaddir)) {
if (!@mkdir($uploaddir, 0775, true)) {
self::configurationError('Could not create folder for converted files: ' . $uploaddir);
}
@chmod($uploaddir, 0775);
}
/*
if (!isset($_POST['hash'])) {
self::accessDenied('Restricted access. Hash required, but missing');
}*/
if (!isset($_FILES['file'])) {
self::runtimeError('No file was supplied');
}
if (!isset($_FILES['file']['error'])) {
self::runtimeError('Invalid parameters');
}
if (is_array($_FILES['file']['error'])) {
self::runtimeError('Cannot convert multiple files');
}
switch ($_FILES['file']['error']) {
case UPLOAD_ERR_OK:
break;
case UPLOAD_ERR_NO_FILE:
self::runtimeError('No file sent');
break;
case UPLOAD_ERR_INI_SIZE:
case UPLOAD_ERR_FORM_SIZE:
self::runtimeError('Exceeded filesize limit.');
break;
default:
self::runtimeError('Unknown error.');
}
if ($_FILES['file']['size'] == 0) {
self::accessDenied('File size is zero. Perhaps exceeded filesize limit?');
}
// Undefined | Multiple Files | $_FILES Corruption Attack
// If this request falls under any of them, treat it invalid.
/*if ($_FILES['file']['size'] > 1000000) {
throw new RuntimeException('Exceeded filesize limit.');
}*/
// DO NOT TRUST $_FILES['upfile']['mime'] VALUE !!
// Check MIME Type by yourself.
if (function_exists('finfo_file') && (defined('FILEINFO_MIME_TYPE'))) {
$r = finfo_open(FILEINFO_MIME_TYPE);
if (false === $ext = array_search(
finfo_file($r, $_FILES['file']['tmp_name']),
array(
'jpg' => 'image/jpeg',
'png' => 'image/png',
'gif' => 'image/gif',
),
true
)) {
self::accessDenied('Invalid file format.');
}
} else {
$ext = 'jpg'; // We set it to something, in case above fails.
}
$uploadfile = $uploaddir . '/' . sha1_file($_FILES['file']['tmp_name']) . '.' . $ext;
//echo $uploadfile;
if (move_uploaded_file($_FILES['file']['tmp_name'], $uploadfile)) {
// File is valid, and was successfully uploaded
$source = $uploadfile;
/*
if (!empty($password)) {
$hash = md5(md5_file($source) . $password);
if ($hash != $_POST['hash']) {
self::accessDenied('Wrong password.');
}
}
*/
$destination = $uploadfile . '.webp';
if (isset($_POST['options'])) {
// Merge in options in $_POST, overwriting the webp-convert options in config
$convertOptionsInPost = (array) json_decode($_POST['options'], true);
$convertOptions = array_merge($options['webp-convert'], $convertOptionsInPost);
} else {
$convertOptions = $options['webp-convert'];
}
try {
WebPConvert::convert($source, $destination, $convertOptions);
header('Content-type: application/octet-stream');
echo file_get_contents($destination);
unlink($source);
unlink($destination);
} catch (\Exception $e) {
echo 'Conversion failed!';
echo $e->getMessage();
}
} else {
// Possible file upload attack!
self::configurationError('Failed to move uploaded file');
//echo 'Failed to move uploaded file';
}
}
}

View File

@@ -0,0 +1,113 @@
<?php
/**
*
* @link https://github.com/rosell-dk/webp-convert-cloud-service
* @license MIT
*/
namespace WebPConvertCloudService;
use WebPConvertCloudService\Serve;
use WebPConvertCloudService\AccessCheck;
class WebPConvertCloudService
{
public $options;
const ERROR_CONFIGURATION = 0;
const ERROR_ACCESS_DENIED = 1;
const ERROR_RUNTIME = 2;
/*
example yaml:
destination-dir: '../conversions'
access:
allowed-hosts:
- bitwise-it.dk
allowed-ips:
- 127.0.0.1
secret: 'my dog is white'
whitelist:
-
label: 'rosell.dk'
ip: 212.14.2.1
secret: 'aoeuth8aoeuh'
-
label: 'public'
secret: '9tita8hoetua'
webp-convert:
quality: 80
...
*/
/*
public function loadConfig()
{
$configDir = __DIR__;
$parentFolders = explode('/', $configDir);
$poppedFolders = [];
while (!(file_exists(implode('/', $parentFolders) . '/wpc-config.yaml')) && count($parentFolders) > 0) {
array_unshift($poppedFolders, array_pop($parentFolders));
}
if (count($parentFolders) == 0) {
self::exitWithError(
WebPConvertCloudService::ERROR_SERVER_SETUP,
'wpc-config.yaml not found in any parent folders.'
);
}
$configFilePath = implode('/', $parentFolders) . '/wpc-config.yaml';
try {
$options = \Spyc::YAMLLoad($configFilePath);
} catch (\Exception $e) {
self::exitWithError(WebPConvertCloudService::ERROR_SERVER_SETUP, 'Error parsing wpc-config.yaml.');
}
}*/
public static function exitWithError($errorCode, $msg)
{
$returnObject = [
'success' => 0,
'errorCode' => $errorCode,
'errorMessage' => $msg,
];
echo json_encode($returnObject);
exit;
}
public static function handleRequest($options)
{
//$this->options = static::loadConfig();
if (!isset($options)) {
self::exitWithError(self::ERROR_SERVER_SETUP, 'No options was supplied');
}
$action = (isset($_POST['action']) ? $_POST['action'] : 'convert');
// Handle actions that does not require access check
switch ($action) {
case 'api-version':
echo '2';
exit;
}
AccessCheck::runAccessChecks($options);
// Handle actions that requires access check
switch ($action) {
case 'check-access':
echo "You have access!\n";
break;
case 'convert':
Serve::serve($options);
break;
}
}
}

View File

@@ -0,0 +1,9 @@
MIT License
Copyright (c) 2018 Bjørn Rosell
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" backupGlobals="false" backupStaticAttributes="false" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="false" processIsolation="false" stopOnFailure="false" bootstrap="vendor/autoload.php">
<coverage>
<include>
<directory suffix=".php">src/</directory>
</include>
<exclude>
<directory>./vendor</directory>
<directory>./tests</directory>
</exclude>
<report>
<clover outputFile="build/coverage.clover"/>
<html outputDirectory="build/coverage"/>
<text outputFile="build/coverage.txt"/>
</report>
</coverage>
<testsuites>
<testsuite name="WebPConvert Test Suite">
<directory>./tests/</directory>
</testsuite>
</testsuites>
<logging>
<junit outputFile="build/report.junit.xml"/>
</logging>
</phpunit>

View File

@@ -0,0 +1,112 @@
<?php
namespace WebPConvert\Convert;
use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput\ConverterNotFoundException;
use WebPConvert\Convert\Converters\AbstractConverter;
/**
* Make converters from their ids.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class ConverterFactory
{
/**
* Get classname of a converter (by id)
*
* @param string $converterId Id of converter (ie "cwebp")
*
* @throws ConverterNotFoundException If there is no converter with that id.
* @return string Fully qualified class name of converter
*/
public static function converterIdToClassname($converterId)
{
switch ($converterId) {
case 'ffmpeg':
$classNameShort = 'FFMpeg';
break;
case 'imagickbinary':
$classNameShort = 'ImagickBinary';
break;
case 'imagemagick':
$classNameShort = 'ImageMagick';
break;
case 'gmagickbinary':
$classNameShort = 'GmagickBinary';
break;
case 'graphicsmagick':
$classNameShort = 'GraphicsMagick';
break;
default:
$classNameShort = ucfirst($converterId);
}
$className = 'WebPConvert\\Convert\\Converters\\' . $classNameShort;
if (is_callable([$className, 'convert'])) {
return $className;
} else {
throw new ConverterNotFoundException('There is no converter with id:' . $converterId);
}
}
/**
* Make a converter instance by class name.
*
* @param string $converterClassName Fully qualified class name
* @param string $source The path to the file to convert
* @param string $destination The path to save the converted file to
* @param array $options (optional)
* @param \WebPConvert\Loggers\BaseLogger $logger (optional)
*
* @throws ConverterNotFoundException If the specified converter class isn't found
* @return AbstractConverter An instance of the specified converter
*/
public static function makeConverterFromClassname(
$converterClassName,
$source,
$destination,
$options = [],
$logger = null
) {
if (!is_callable([$converterClassName, 'convert'])) {
throw new ConverterNotFoundException(
'There is no converter with class name:' . $converterClassName . ' (or it is not a converter)'
);
}
//$converter = new $converterClassName($source, $destination, $options, $logger);
return call_user_func(
[$converterClassName, 'createInstance'],
$source,
$destination,
$options,
$logger
);
}
/**
* Make a converter instance by either id or class name.
*
* @param string $converterIdOrClassName Either a converter ID or a fully qualified class name
* @param string $source The path to the file to convert
* @param string $destination The path to save the converted file to
* @param array $options (optional)
* @param \WebPConvert\Loggers\BaseLogger $logger (optional)
*
* @throws ConverterNotFoundException If the specified converter class isn't found
* @return AbstractConverter An instance of the specified converter
*/
public static function makeConverter($converterIdOrClassName, $source, $destination, $options = [], $logger = null)
{
// We take it that all lowercase means it is an id rather than a class name
if (strtolower($converterIdOrClassName) == $converterIdOrClassName) {
$converterClassName = self::converterIdToClassname($converterIdOrClassName);
} else {
$converterClassName = $converterIdOrClassName;
}
return self::makeConverterFromClassname($converterClassName, $source, $destination, $options, $logger);
}
}

View File

@@ -0,0 +1,387 @@
<?php
// TODO:
// Read this: https://sourcemaking.com/design_patterns/strategy
namespace WebPConvert\Convert\Converters;
use WebPConvert\Helpers\InputValidator;
use WebPConvert\Helpers\MimeType;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Convert\Converters\BaseTraits\AutoQualityTrait;
use WebPConvert\Convert\Converters\BaseTraits\DestinationPreparationTrait;
use WebPConvert\Convert\Converters\BaseTraits\LoggerTrait;
use WebPConvert\Convert\Converters\BaseTraits\OptionsTrait;
use WebPConvert\Convert\Converters\BaseTraits\WarningLoggerTrait;
use WebPConvert\Exceptions\WebPConvertException;
use WebPConvert\Loggers\BaseLogger;
/**
* Base for all converter classes.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
abstract class AbstractConverter
{
use AutoQualityTrait;
use OptionsTrait;
use WarningLoggerTrait;
use DestinationPreparationTrait;
use LoggerTrait;
/**
* The actual conversion is be done by a concrete converter extending this class.
*
* At the stage this method is called, the abstract converter has taken preparational steps.
* - It has created the destination folder (if neccesary)
* - It has checked the input (valid mime type)
* - It has set up an error handler, mostly in order to catch and log warnings during the doConvert fase
*
* Note: This method is not meant to be called from the outside. Use the static *convert* method for converting
* or, if you wish, create an instance with ::createInstance() and then call ::doConvert()
*
* @throws ConversionFailedException in case conversion failed in an antipiciated way (or subclass)
* @throws \Exception in case conversion failed in an unantipiciated way
*/
abstract protected function doActualConvert();
/**
* Whether or not the converter supports lossless encoding (even for jpegs)
*
* PS: Converters that supports lossless encoding all use the EncodingAutoTrait, which
* overrides this function.
*
* @return boolean Whether the converter supports lossless encoding (even for jpegs).
*/
public function supportsLossless()
{
return false;
}
/** @var string The filename of the image to convert (complete path) */
protected $source;
/** @var string Where to save the webp (complete path) */
protected $destination;
/**
* Check basis operationality
*
* Converters may override this method for the purpose of performing basic operationaly checks. It is for
* running general operation checks for a conversion method.
* If some requirement is not met, it should throw a ConverterNotOperationalException (or subtype)
*
* The method is called internally right before calling doActualConvert() method.
* - It SHOULD take options into account when relevant. For example, a missing api key for a
* cloud converter should be detected here
* - It should NOT take the actual filename into consideration, as the purpose is *general*
* For that pupose, converters should override checkConvertability
* Also note that doConvert method is allowed to throw ConverterNotOperationalException too.
*
* @return void
*/
public function checkOperationality()
{
}
/**
* Converters may override this for the purpose of performing checks on the concrete file.
*
* This can for example be used for rejecting big uploads in cloud converters or rejecting unsupported
* image types.
*
* @return void
*/
public function checkConvertability()
{
}
/**
* Constructor.
*
* @param string $source path to source file
* @param string $destination path to destination
* @param array $options (optional) options for conversion
* @param BaseLogger $logger (optional)
*/
final public function __construct($source = '', $destination = '', $options = [], $logger = null)
{
if ($source == '') {
return;
}
InputValidator::checkSourceAndDestination($source, $destination);
$this->source = $source;
$this->destination = $destination;
$this->setLogger($logger);
$this->setProvidedOptions($options);
if (!isset($this->options['_skip_input_check'])) {
$this->logLn('WebP Convert 2.9.0 ignited', 'bold');
$this->logLn('PHP version: ' . phpversion());
if (isset($_SERVER['SERVER_SOFTWARE'])) {
$this->logLn('Server software: ' . $_SERVER['SERVER_SOFTWARE']);
}
$this->logLn('');
if (isset($this->options['log-call-arguments']) && $this->options['log-call-arguments']) {
$this->logLn('source: ' . $this->source);
$this->logLn('destination: ' . $this->destination);
$this->logLn('');
}
$this->logLn(self::getConverterDisplayName() . ' converter ignited', 'bold');
}
}
/**
* Get source.
*
* @return string The source.
*/
public function getSource()
{
return $this->source;
}
/**
* Get destination.
*
* @return string The destination.
*/
public function getDestination()
{
return $this->destination;
}
/**
* Set destination.
*
* @param string $destination path to destination
* @return void
*/
public function setDestination($destination)
{
$this->destination = $destination;
}
/**
* Get converter name for display (defaults to the class name (short)).
*
* Converters can override this.
*
* @return string A display name, ie "Gd"
*/
protected static function getConverterDisplayName()
{
// https://stackoverflow.com/questions/19901850/how-do-i-get-an-objects-unqualified-short-class-name/25308464
return substr(strrchr('\\' . static::class, '\\'), 1);
}
/**
* Get converter id (defaults to the class name lowercased)
*
* Converters can override this.
*
* @return string A display name, ie "Gd"
*/
protected static function getConverterId()
{
return strtolower(self::getConverterDisplayName());
}
/**
* Create an instance of this class
*
* @param string $source The path to the file to convert
* @param string $destination The path to save the converted file to
* @param array $options (optional)
* @param \WebPConvert\Loggers\BaseLogger $logger (optional)
*
* @return static
*/
public static function createInstance($source, $destination, $options = [], $logger = null)
{
return new static($source, $destination, $options, $logger);
}
protected function logReduction($source, $destination)
{
$sourceSize = filesize($source);
$destSize = filesize($destination);
$this->log(round(($sourceSize - $destSize) / $sourceSize * 100) . '% ');
if ($sourceSize < 10000) {
$this->logLn('(went from ' . strval($sourceSize) . ' bytes to ' . strval($destSize) . ' bytes)');
} else {
$this->logLn('(went from ' . round($sourceSize / 1024) . ' kb to ' . round($destSize / 1024) . ' kb)');
}
}
/**
* Run conversion.
*
* @return void
*/
private function doConvertImplementation()
{
$beginTime = microtime(true);
$this->activateWarningLogger();
$this->checkOptions();
// Prepare destination folder
$this->createWritableDestinationFolder();
$this->removeExistingDestinationIfExists();
if (!isset($this->options['_skip_input_check'])) {
// Check that a file can be written to destination
$this->checkDestinationWritable();
}
$this->checkOperationality();
$this->checkConvertability();
if ($this->options['log-call-arguments']) {
$this->logOptions();
$this->logLn('');
}
$this->runActualConvert();
$source = $this->source;
$destination = $this->destination;
if (!@file_exists($destination)) {
throw new ConversionFailedException('Destination file is not there: ' . $destination);
} elseif (@filesize($destination) === 0) {
unlink($destination);
throw new ConversionFailedException('Destination file was completely empty');
} else {
if (!isset($this->options['_suppress_success_message'])) {
$this->ln();
$this->log('Converted image in ' . round((microtime(true) - $beginTime) * 1000) . ' ms');
$sourceSize = @filesize($source);
if ($sourceSize !== false) {
$this->log(', reducing file size with ');
$this->logReduction($source, $destination);
}
}
}
$this->deactivateWarningLogger();
}
//private function logEx
/**
* Start conversion.
*
* Usually it would be more convenience to call the static convert method, but alternatively you can call
* call ::createInstance to get an instance and then ::doConvert().
*
* @return void
*/
public function doConvert()
{
try {
//trigger_error('hello', E_USER_ERROR);
$this->doConvertImplementation();
} catch (WebPConvertException $e) {
$this->logLn('');
/*
if (isset($e->description) && ($e->description != '')) {
$this->log('Error: ' . $e->description . '. ', 'bold');
} else {
$this->log('Error: ', 'bold');
}
*/
$this->log('Error: ', 'bold');
$this->logLn($e->getMessage(), 'bold');
throw $e;
} catch (\Exception $e) {
$className = get_class($e);
$classNameParts = explode("\\", $className);
$shortClassName = array_pop($classNameParts);
$this->logLn('');
$this->logLn($shortClassName . ' thrown in ' . $e->getFile() . ':' . $e->getLine(), 'bold');
$this->logLn('Message: "' . $e->getMessage() . '"', 'bold');
$this->logLn('Trace:');
foreach ($e->getTrace() as $trace) {
//$this->logLn(print_r($trace, true));
if (isset($trace['file']) && isset($trace['line'])) {
$this->logLn(
$trace['file'] . ':' . $trace['line']
);
}
}
throw $e;
} catch (\Throwable $e) {
$className = get_class($e);
$classNameParts = explode("\\", $className);
$shortClassName = array_pop($classNameParts);
$this->logLn('');
$this->logLn($shortClassName . ' thrown in ' . $e->getFile() . ':' . $e->getLine(), 'bold');
$this->logLn('Message: "' . $e->getMessage() . '"', 'bold');
throw $e;
}
}
/**
* Runs the actual conversion (after setup and checks)
* Simply calls the doActualConvert() of the actual converter.
* However, in the EncodingAutoTrait, this method is overridden to make two conversions
* and select the smallest.
*
* @return void
*/
protected function runActualConvert()
{
$this->doActualConvert();
}
/**
* Convert an image to webp.
*
* @param string $source path to source file
* @param string $destination path to destination
* @param array $options (optional) options for conversion
* @param BaseLogger $logger (optional)
*
* @throws ConversionFailedException in case conversion fails in an antipiciated way
* @throws \Exception in case conversion fails in an unantipiciated way
* @return void
*/
public static function convert($source, $destination, $options = [], $logger = null)
{
$c = self::createInstance($source, $destination, $options, $logger);
$c->doConvert();
//echo $instance->id;
}
/**
* Get mime type for image (best guess).
*
* It falls back to using file extension. If that fails too, false is returned
*
* PS: Is it a security risk to fall back on file extension?
* - By setting file extension to "jpg", one can lure our library into trying to convert a file, which isn't a jpg.
* hmm, seems very unlikely, though not unthinkable that one of the converters could be exploited
*
* @return string|false|null mimetype (if it is an image, and type could be determined / guessed),
* false (if it is not an image type that the server knowns about)
* or null (if nothing can be determined)
*/
public function getMimeTypeOfSource()
{
return MimeType::getMimeTypeDetectionResult($this->source);
}
}

View File

@@ -0,0 +1,186 @@
<?php
namespace WebPConvert\Convert\Converters\BaseTraits;
use WebPConvert\Convert\Helpers\JpegQualityDetector;
/**
* Trait for handling the "quality:auto" option.
*
* This trait is only used in the AbstractConverter class. It has been extracted into a
* trait in order to bundle the methods concerning auto quality.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
trait AutoQualityTrait
{
abstract public function logLn($msg, $style = '');
abstract public function getMimeTypeOfSource();
/** @var boolean Whether the quality option has been processed or not */
private $processed = false;
/** @var boolean Whether the quality of the source could be detected or not (set upon processing) */
private $qualityCouldNotBeDetected = false;
/** @var integer The calculated quality (set upon processing - on successful detection) */
private $calculatedQuality;
/**
* Determine if quality detection is required but failing.
*
* It is considered "required" when:
* - Mime type is "image/jpeg"
* - Quality is set to "auto"
*
* If quality option hasn't been proccessed yet, it is triggered.
*
* @return boolean
*/
public function isQualityDetectionRequiredButFailing()
{
$this->processQualityOptionIfNotAlready();
return $this->qualityCouldNotBeDetected;
}
/**
* Get calculated quality.
*
* If the "quality" option is a number, that number is returned.
* If mime type of source is something else than "image/jpeg", the "default-quality" option is returned
* If quality is "auto" and source is a jpeg image, it will be attempted to detect jpeg quality.
* In case of failure, the value of the "default-quality" option is returned.
* In case of success, the detected quality is returned, or the value of the "max-quality" if that is lower.
*
* @return int
*/
public function getCalculatedQuality()
{
$this->processQualityOptionIfNotAlready();
return $this->calculatedQuality;
}
/**
* Process the quality option if it is not already processed.
*
* @return void
*/
private function processQualityOptionIfNotAlready()
{
if (!$this->processed) {
$this->processed = true;
$this->processQualityOption();
}
}
/**
* Process the quality option.
*
* Sets the private property "calculatedQuality" according to the description for the getCalculatedQuality
* function.
* In case quality detection was attempted and failed, the private property "qualityCouldNotBeDetected" is set
* to true. This is used by the "isQualityDetectionRequiredButFailing" (and documented there too).
*
* @return void
*/
private function processQualityOption()
{
$options = $this->options;
$source = $this->source;
/*
Mapping from old options to new options:
quality: "auto", max-quality: 85, default-quality: 75
becomes: quality: 85, auto-limit: true
quality: 80
becomes: quality: 80, auto-limit: false
*/
$q = $options['quality'];
$useDeprecatedDefaultQuality = false;
if ($q == 'auto') {
$q = $options['quality'] = $options['max-quality'];
$this->logLn(
'*Setting "quality" to "auto" is deprecated. ' .
'Instead, set "quality" to a number (0-100) and "auto-limit" to true. '
);
$this->logLn(
'*"quality" has been set to: ' . $options['max-quality'] . ' (took the value of "max-quality").*'
);
if (!$this->options2->getOptionById('auto-limit')->isValueExplicitlySet()) {
$options['auto-limit'] = true;
$this->logLn(
'*"auto-limit" has been set to: true."*'
);
} else {
$this->logLn(
'*PS: "auto-limit" is set to false, as it was set explicitly to false in the options."*'
);
}
$useDeprecatedDefaultQuality = true;
}
if ($options['auto-limit']) {
if (($this->/** @scrutinizer ignore-call */getMimeTypeOfSource() == 'image/jpeg')) {
$this->logLn('Running auto-limit');
$this->logLn(
'Quality setting: ' . $q . '. '
);
$q = JpegQualityDetector::detectQualityOfJpg($source);
if (is_null($q)) {
$this->/** @scrutinizer ignore-call */logLn(
'Quality of source image could not be established (Imagick or GraphicsMagick is required). ' .
'Sorry, no auto-limit functionality for you. '
);
if ($useDeprecatedDefaultQuality) {
$q = $options['default-quality'];
$this->/** @scrutinizer ignore-call */logLn(
'Using default-quality (' . $q . ').'
);
} else {
$q = $options['quality'];
$this->/** @scrutinizer ignore-call */logLn(
'Using supplied quality (' . $q . ').'
);
}
$this->qualityCouldNotBeDetected = true;
} else {
$this->logLn(
'Quality of jpeg: ' . $q . '. '
);
if ($q < $options['quality']) {
$this->logLn(
'Auto-limit result: ' . $q . ' ' .
'(limiting applied).'
);
} else {
$q = $options['quality'];
$this->logLn(
'Auto-limit result: ' . $q . ' ' .
'(no limiting needed this time).'
);
}
}
$q = min($q, $options['max-quality']);
} else {
$this->logLn('Bypassing auto-limit (it is only active for jpegs)');
$this->logLn('Quality: ' . $q . '. ');
}
} else {
$this->logLn(
'Quality: ' . $q . '. '
);
if (($this->getMimeTypeOfSource() == 'image/jpeg')) {
$this->logLn(
'Consider enabling "auto-limit" option. This will prevent unnecessary high quality'
);
}
}
$this->calculatedQuality = $q;
}
}

View File

@@ -0,0 +1,101 @@
<?php
namespace WebPConvert\Convert\Converters\BaseTraits;
use WebPConvert\Convert\Exceptions\ConversionFailed\FileSystemProblems\CreateDestinationFileException;
use WebPConvert\Convert\Exceptions\ConversionFailed\FileSystemProblems\CreateDestinationFolderException;
/**
* Trait for handling options
*
* This trait is currently only used in the AbstractConverter class. It has been extracted into a
* trait in order to bundle the methods concerning options.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
trait DestinationPreparationTrait
{
abstract public function getDestination();
abstract public function logLn($msg, $style = '');
/**
* Create writable folder in provided path (if it does not exist already)
*
* @throws CreateDestinationFolderException if folder cannot be removed
* @return void
*/
private function createWritableDestinationFolder()
{
$destination = $this->getDestination();
$folder = dirname($destination);
if (!file_exists($folder)) {
$this->logLn('Destination folder does not exist. Creating folder: ' . $folder);
// TODO: what if this is outside open basedir?
// see http://php.net/manual/en/ini.core.php#ini.open-basedir
// Trying to create the given folder (recursively)
if (!mkdir($folder, 0777, true)) {
throw new CreateDestinationFolderException(
'Failed creating folder. Check the permissions!',
'Failed creating folder: ' . $folder . '. Check permissions!'
);
}
}
}
/**
* Check that we can write file at destination.
*
* It is assumed that the folder already exists (that ::createWritableDestinationFolder() was called first)
*
* @throws CreateDestinationFileException if file cannot be created at destination
* @return void
*/
private function checkDestinationWritable()
{
$destination = $this->getDestination();
$dirName = dirname($destination);
if (@is_writable($dirName) && @is_executable($dirName)) {
// all is well
return;
}
// The above might fail on Windows, even though dir is writable
// So, to be absolute sure that we cannot write, we make an actual write test (writing a dummy file)
// No harm in doing that for non-Windows systems either.
if (file_put_contents($destination, 'dummy') !== false) {
// all is well, after all
unlink($destination);
return;
}
throw new CreateDestinationFileException(
'Cannot create file: ' . basename($destination) . ' in dir:' . dirname($destination)
);
}
/**
* Remove existing destination.
*
* @throws CreateDestinationFileException if file cannot be removed
* @return void
*/
private function removeExistingDestinationIfExists()
{
$destination = $this->getDestination();
if (file_exists($destination)) {
// A file already exists in this folder...
// We delete it, to make way for a new webp
if (!unlink($destination)) {
throw new CreateDestinationFileException(
'Existing file cannot be removed: ' . basename($destination)
);
}
}
}
}

View File

@@ -0,0 +1,71 @@
<?php
namespace WebPConvert\Convert\Converters\BaseTraits;
/**
* Trait for providing logging capabilities.
*
* This trait is currently only used in the AbstractConverter class. It has been extracted into a
* trait in order to bundle the methods concerning logging.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
trait LoggerTrait
{
/** @var \WebPConvert\Loggers\BaseLogger The logger (or null if not set) */
protected $logger;
/**
* Set logger
*
* @param \WebPConvert\Loggers\BaseLogger $logger (optional) $logger
* @return void
*/
public function setLogger($logger = null)
{
$this->logger = $logger;
}
/**
* Write a line to the logger.
*
* @param string $msg The line to write.
* @param string $style (optional) Ie "italic" or "bold"
* @return void
*/
public function logLn($msg, $style = '')
{
if (isset($this->logger)) {
$this->logger->logLn($msg, $style);
}
}
/**
* New line
*
* @return void
*/
protected function ln()
{
if (isset($this->logger)) {
$this->logger->ln();
}
}
/**
* Write to the logger, without newline
*
* @param string $msg What to write.
* @param string $style (optional) Ie "italic" or "bold"
* @return void
*/
public function log($msg, $style = '')
{
if (isset($this->logger)) {
$this->logger->log($msg, $style);
}
}
}

View File

@@ -0,0 +1,581 @@
<?php
namespace WebPConvert\Convert\Converters\BaseTraits;
use WebPConvert\Convert\Converters\Stack;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConversionSkippedException;
use WebPConvert\Options\Exceptions\InvalidOptionValueException;
use WebPConvert\Options\Exceptions\InvalidOptionTypeException;
use WebPConvert\Options\GhostOption;
use WebPConvert\Options\Options;
use WebPConvert\Options\OptionFactory;
/**
* Trait for handling options
*
* This trait is currently only used in the AbstractConverter class. It has been extracted into a
* trait in order to bundle the methods concerning options.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
trait OptionsTrait
{
abstract public function log($msg, $style = '');
abstract public function logLn($msg, $style = '');
abstract protected function getMimeTypeOfSource();
/** @var array Provided conversion options (array of simple objects)*/
public $providedOptions;
/** @var array Calculated conversion options (merge of default options and provided options)*/
protected $options;
/** @var Options */
protected $options2;
/**
* Get the "general" options (options that are standard in the meaning that they
* are generally available (unless specifically marked as unsupported by a given converter)
*
* @param string $imageType (png | jpeg) The image type - determines the defaults
*
* @return array Array of options
*/
public function getGeneralOptions($imageType)
{
$isPng = ($imageType == 'png');
/*
return [
//new IntegerOption('auto-limit-adjustment', 5, -100, 100),
new BooleanOption('log-call-arguments', false),
new BooleanOption('skip', false),
new BooleanOption('use-nice', false),
new ArrayOption('jpeg', []),
new ArrayOption('png', [])
];*/
$introMd = 'https://github.com/rosell-dk/webp-convert/blob/master/docs/v2.0/' .
'converting/introduction-for-converting.md';
return OptionFactory::createOptions([
['encoding', 'string', [
'title' => 'Encoding',
'description' => 'Set encoding for the webp. ' .
'If you choose "auto", webp-convert will ' .
'convert to both lossy and lossless and pick the smallest result',
'default' => 'auto',
'enum' => ['auto', 'lossy', 'lossless'],
'ui' => [
'component' => 'select',
'links' => [['Guide', $introMd . '#auto-selecting-between-losslesslossy-encoding']],
]
]],
['quality', 'int', [
'title' => 'Quality (Lossy)',
'description' =>
'Quality for lossy encoding. ' .
'In case you enable "auto-limit", you can consider this property a maximum quality.',
'default' => ($isPng ? 85 : 75),
'default-png' => 85,
'default-jpeg' => 75,
//'minimum' => 0,
//'maximum' => 100,
"oneOf" => [
["type" => "number", "minimum" => 0, 'maximum' => 100],
["type" => "string", "enum" => ["auto"]]
],
'ui' => [
'component' => 'slider',
'display' => "option('encoding') != 'lossless'"
]
]],
['auto-limit', 'boolean', [
'title' => 'Auto-limit',
'description' =>
'Enable this option to prevent an unnecessarily high quality setting for low ' .
'quality jpegs. It works by adjusting quality setting down to the quality of the jpeg. ' .
'Converting ie a jpeg with quality:50 to ie quality:80 does not get you better quality ' .
'than converting it to quality:80, but it does get you a much bigger file - so you ' .
'really should enable this option.' . "\n\n" .
'The option is ignored for PNG and never adjusts quality up. ' . "\n\n" .
'The feature requires Imagick, ImageMagick or Gmagick in order to detect the quality of ' .
'the jpeg. ' . "\n\n" .
'PS: The "auto-limit" option is relative new. However, before this option, you could achieve ' .
'the same by setting quality to "auto" and specifying a "max-quality" and a "default-quality". ' .
'These are deprecated now, but still works.',
'default' => true,
'ui' => [
'component' => 'checkbox',
'advanced' => true,
'links' => [
[
'Guide',
$introMd . '#preventing-unnecessarily-high-quality-setting-for-low-quality-jpegs'
]
],
'display' => "option('encoding') != 'lossless'"
]
]],
['alpha-quality', 'int', [
'title' => 'Alpha quality',
'description' =>
'Quality of alpha channel. ' .
'Often, there is no need for high quality transparency layer and in some cases you ' .
'can tweak this all the way down to 10 and save a lot in file size. The option only ' .
'has effect with lossy encoding, and of course only on images with transparency.',
'default' => 85,
'minimum' => 0,
'maximum' => 100,
'ui' => [
'component' => 'slider',
'links' => [['Guide', $introMd . '#alpha-quality']],
'display' => "(option('encoding') != 'lossless') && (imageType!='jpeg')"
]
]],
['near-lossless', 'int', [
'title' => '"Near lossless" quality',
'description' =>
'This option allows you to get impressively better compression for lossless encoding, with ' .
'minimal impact on visual quality. The range is 0 (maximum preprocessing) to 100 (no ' .
'preprocessing). Read the guide for more info.',
'default' => 60,
'minimum' => 0,
'maximum' => 100,
'ui' => [
'component' => 'slider',
'links' => [['Guide', $introMd . '#near-lossless']],
'display' => "option('encoding') != 'lossy'"
]
]],
['metadata', 'string', [
'title' => 'Metadata',
'description' =>
'Determines which metadata that should be copied over to the webp. ' .
'Setting it to "all" preserves all metadata, setting it to "none" strips all metadata. ' .
'*cwebp* can take a comma-separated list of which kinds of metadata that should be copied ' .
'(ie "exif,icc"). *gd* will always remove all metadata and *ffmpeg* will always keep all ' .
'metadata. The rest can either strip all or keep all (they will keep all, unless the option ' .
'is set to *none*)',
'default' => 'none',
'ui' => [
'component' => 'multi-select',
'options' => ['all', 'none', 'exif', 'icc', 'xmp'],
]
// TODO: set regex validation
]],
['method', 'int', [
'title' => 'Reduction effort (0-6)',
'description' =>
'Controls the trade off between encoding speed and the compressed file size and quality. ' .
'Possible values range from 0 to 6. 0 is fastest. 6 results in best quality and compression. ' .
'PS: The option corresponds to the "method" option in libwebp',
'default' => 6,
'minimum' => 0,
'maximum' => 6,
'ui' => [
'component' => 'slider',
'advanced' => true,
]
]],
['sharp-yuv', 'boolean', [
'title' => 'Sharp YUV',
'description' =>
'Better RGB->YUV color conversion (sharper and more accurate) at the expense of a little extra ' .
'conversion time.',
'default' => true,
'ui' => [
'component' => 'checkbox',
'advanced' => true,
'links' => [
['Ctrl.blog', 'https://www.ctrl.blog/entry/webp-sharp-yuv.html'],
],
]
]],
['auto-filter', 'boolean', [
'title' => 'Auto-filter',
'description' =>
'Turns auto-filter on. ' .
'This algorithm will spend additional time optimizing the filtering strength to reach a well-' .
'balanced quality. Unfortunately, it is extremely expensive in terms of computation. It takes ' .
'about 5-10 times longer to do a conversion. A 1MB picture which perhaps typically takes about ' .
'2 seconds to convert, will takes about 15 seconds to convert with auto-filter. ',
'default' => false,
'ui' => [
'component' => 'checkbox',
'advanced' => true,
]
]],
['low-memory', 'boolean', [
'title' => 'Low memory',
'description' =>
'Reduce memory usage of lossy encoding at the cost of ~30% longer encoding time and marginally ' .
'larger output size. Only effective when the *method* option is 3 or more. Read more in ' .
'[the docs](https://developers.google.com/speed/webp/docs/cwebp)',
'default' => false,
'ui' => [
'component' => 'checkbox',
'advanced' => true,
'display' => "(option('encoding') != 'lossless') && (option('method')>2)"
]
]],
['preset', 'string', [
'title' => 'Preset',
'description' =>
'Using a preset will set many of the other options to suit a particular type of ' .
'source material. It even overrides them. It does however not override the quality option. ' .
'"none" means that no preset will be set',
'default' => 'none',
'enum' => ['none', 'default', 'photo', 'picture', 'drawing', 'icon', 'text'],
'ui' => [
'component' => 'select',
'advanced' => true,
]
]],
['size-in-percentage', 'int', ['default' => null, 'minimum' => 0, 'maximum' => 100, 'allow-null' => true]],
['skip', 'boolean', ['default' => false]],
['log-call-arguments', 'boolean', ['default' => false]],
// TODO: use-nice should not be a "general" option
//['use-nice', 'boolean', ['default' => false]],
['jpeg', 'array', ['default' => []]],
['png', 'array', ['default' => []]],
// Deprecated options
['default-quality', 'int', [
'default' => ($isPng ? 85 : 75),
'minimum' => 0,
'maximum' => 100,
'deprecated' => true]
],
['max-quality', 'int', ['default' => 85, 'minimum' => 0, 'maximum' => 100, 'deprecated' => true]],
]);
}
/**
* Get the unique options for a converter
*
* @param string $imageType (png | jpeg) The image type - determines the defaults
*
* @return array Array of options
*/
public function getUniqueOptions($imageType)
{
return [];
}
/**
* Create options.
*
* The options created here will be available to all converters.
* Individual converters may add options by overriding this method.
*
* @param string $imageType (png | jpeg) The image type - determines the defaults
*
* @return void
*/
protected function createOptions($imageType = 'png')
{
$this->options2 = new Options();
$this->options2->addOptions(... $this->getGeneralOptions($imageType));
$this->options2->addOptions(... $this->getUniqueOptions($imageType));
}
/**
* Set "provided options" (options provided by the user when calling convert().
*
* This also calculates the protected options array, by merging in the default options, merging
* jpeg and png options and merging prefixed options (such as 'vips-quality').
* The resulting options array are set in the protected property $this->options and can be
* retrieved using the public ::getOptions() function.
*
* @param array $providedOptions (optional)
* @return void
*/
public function setProvidedOptions($providedOptions = [])
{
$imageType = ($this->getMimeTypeOfSource() == 'image/png' ? 'png' : 'jpeg');
$this->createOptions($imageType);
$this->providedOptions = $providedOptions;
if (isset($this->providedOptions['png'])) {
if ($this->getMimeTypeOfSource() == 'image/png') {
$this->providedOptions = array_merge($this->providedOptions, $this->providedOptions['png']);
// $this->logLn(print_r($this->providedOptions, true));
unset($this->providedOptions['png']);
}
}
if (isset($this->providedOptions['jpeg'])) {
if ($this->getMimeTypeOfSource() == 'image/jpeg') {
$this->providedOptions = array_merge($this->providedOptions, $this->providedOptions['jpeg']);
unset($this->providedOptions['jpeg']);
}
}
// merge down converter-prefixed options
$converterId = self::getConverterId();
$strLen = strlen($converterId);
foreach ($this->providedOptions as $optionKey => $optionValue) {
if (substr($optionKey, 0, $strLen + 1) == ($converterId . '-')) {
$this->providedOptions[substr($optionKey, $strLen + 1)] = $optionValue;
unset($this->providedOptions[$optionKey]);
}
}
// Create options (Option objects)
foreach ($this->providedOptions as $optionId => $optionValue) {
$this->options2->setOrCreateOption($optionId, $optionValue);
}
//$this->logLn(print_r($this->options2->getOptions(), true));
//$this->logLn($this->options2->getOption('hello'));
// Create flat associative array of options
$this->options = $this->options2->getOptions();
// - Merge $defaultOptions into provided options
//$this->options = array_merge($this->getDefaultOptions(), $this->providedOptions);
//$this->logOptions();
}
/**
* Get the resulting options after merging provided options with default options.
*
* Note that the defaults depends on the mime type of the source. For example, the default value for quality
* is "auto" for jpegs, and 85 for pngs.
*
* @return array An associative array of options: ['metadata' => 'none', ...]
*/
public function getOptions()
{
return $this->options;
}
/**
* Change an option specifically.
*
* This method is probably rarely neeeded. We are using it to change the "encoding" option temporarily
* in the EncodingAutoTrait.
*
* @param string $id Id of option (ie "metadata")
* @param mixed $value The new value.
* @return void
*/
protected function setOption($id, $value)
{
$this->options[$id] = $value;
$this->options2->setOrCreateOption($id, $value);
}
/**
* Check options.
*
* @throws InvalidOptionTypeException if an option have wrong type
* @throws InvalidOptionValueException if an option value is out of range
* @throws ConversionSkippedException if 'skip' option is set to true
* @return void
*/
protected function checkOptions()
{
$this->options2->check();
if ($this->options['skip']) {
if (($this->getMimeTypeOfSource() == 'image/png') && isset($this->options['png']['skip'])) {
throw new ConversionSkippedException(
'skipped conversion (configured to do so for PNG)'
);
} else {
throw new ConversionSkippedException(
'skipped conversion (configured to do so)'
);
}
}
}
public function logOptions()
{
$this->logLn('');
$this->logLn('Options:');
$this->logLn('------------');
$unsupported = $this->getUnsupportedDefaultOptions();
$received = [];
$implicitlySet = [];
foreach ($this->options2->getOptionsMap() as $id => $option) {
if (in_array($id, [
'png', 'jpeg', '_skip_input_check', '_suppress_success_message', 'skip', 'log_call_arguments'
])) {
continue;
}
if ($option->isValueExplicitlySet()) {
$received[] = $option;
} else {
if (($option instanceof GhostOption) || in_array($id, $unsupported)) {
//$received[] = $option;
} else {
if (!$option->isDeprecated()) {
$implicitlySet[] = $option;
}
}
}
}
if (count($received) > 0) {
foreach ($received as $option) {
$this->log('- ' . $option->getId() . ': ');
if ($option instanceof GhostOption) {
$this->log(' (unknown to ' . $this->getConverterId() . ')', 'bold');
$this->logLn('');
continue;
}
$this->log($option->getValueForPrint());
if ($option->isDeprecated()) {
$this->log(' (deprecated)', 'bold');
}
if (in_array($option->getId(), $unsupported)) {
if ($this instanceof Stack) {
//$this->log(' *(passed on)*');
} else {
$this->log(' (unsupported by ' . $this->getConverterId() . ')', 'bold');
}
}
$this->logLn('');
}
$this->logLn('');
$this->logLn(
'Note that these are the resulting options after merging down the "jpeg" and "png" options and any ' .
'converter-prefixed options'
);
}
if (count($implicitlySet) > 0) {
$this->logLn('');
$this->logLn('Defaults:');
$this->logLn('------------');
$this->logLn(
'The following options was not set, so using the following defaults:'
);
foreach ($implicitlySet as $option) {
$this->log('- ' . $option->getId() . ': ');
$this->log($option->getValueForPrint());
/*if ($option instanceof GhostOption) {
$this->log(' **(ghost)**');
}*/
$this->logLn('');
}
}
}
// to be overridden by converters
protected function getUnsupportedDefaultOptions()
{
return [];
}
public function getUnsupportedGeneralOptions()
{
return $this->getUnsupportedDefaultOptions();
}
/**
* Get unique option definitions.
*
* Gets definitions of the converters "unique" options (that is, those options that
* are not general). It was added in order to give GUI's a way to automatically adjust
* their setting screens.
*
* @param bool $filterOutOptionsWithoutUI If options without UI defined should be filtered out
* @param string $imageType (png | jpeg) The image type - determines the defaults
*
* @return array Array of options definitions - ready to be json encoded, or whatever
*/
public function getUniqueOptionDefinitions($filterOutOptionsWithoutUI = true, $imageType = 'jpeg')
{
$uniqueOptions = new Options();
//$uniqueOptions->addOptions(... $this->getUniqueOptions($imageType));
foreach ($this->getUniqueOptions($imageType) as $uoption) {
$uoption->setId(self::getConverterId() . '-' . $uoption->getId());
$uniqueOptions->addOption($uoption);
}
$optionDefinitions = $uniqueOptions->getDefinitions();
if ($filterOutOptionsWithoutUI) {
$optionDefinitions = array_filter($optionDefinitions, function ($value) {
return !is_null($value['ui']);
});
$optionDefinitions = array_values($optionDefinitions); // re-index
}
return $optionDefinitions;
}
/**
* Get general option definitions.
*
* Gets definitions of all general options (not just the ones supported by current converter)
* For UI's, as a way to automatically adjust their setting screens.
*
* @param bool $filterOutOptionsWithoutUI If options without UI defined should be filtered out
* @param string $imageType (png | jpeg) The image type - determines the defaults
*
* @return array Array of options definitions - ready to be json encoded, or whatever
*/
public function getGeneralOptionDefinitions($filterOutOptionsWithoutUI = true, $imageType = 'jpeg')
{
$generalOptions = new Options();
$generalOptions->addOptions(... $this->getGeneralOptions($imageType));
//$generalOptions->setUI($this->getUIForGeneralOptions($imageType));
$optionDefinitions = $generalOptions->getDefinitions();
if ($filterOutOptionsWithoutUI) {
$optionDefinitions = array_filter($optionDefinitions, function ($value) {
return !is_null($value['ui']);
});
$optionDefinitions = array_values($optionDefinitions); // re-index
}
return $optionDefinitions;
}
public function getSupportedGeneralOptions($imageType = 'png')
{
$unsupportedGeneral = $this->getUnsupportedDefaultOptions();
$generalOptionsArr = $this->getGeneralOptions($imageType);
$supportedIds = [];
foreach ($generalOptionsArr as $i => $option) {
if (in_array($option->getId(), $unsupportedGeneral)) {
unset($generalOptionsArr[$i]);
}
}
return $generalOptionsArr;
}
/**
* Get general option definitions.
*
* Gets definitions of the converters "general" options. (that is, those options that
* It was added in order to give GUI's a way to automatically adjust their setting screens.
*
* @param string $imageType (png | jpeg) The image type - determines the defaults
*
* @return array Array of options definitions - ready to be json encoded, or whatever
*/
public function getSupportedGeneralOptionDefinitions($imageType = 'png')
{
$generalOptions = new Options();
$generalOptions->addOptions(... $this->getSupportedGeneralOptions($imageType));
return $generalOptions->getDefinitions();
}
public function getSupportedGeneralOptionIds()
{
$supportedGeneralOptions = $this->getSupportedGeneralOptions();
$supportedGeneralIds = [];
foreach ($supportedGeneralOptions as $option) {
$supportedGeneralIds[] = $option->getId();
}
return $supportedGeneralIds;
}
}

View File

@@ -0,0 +1,175 @@
<?php
namespace WebPConvert\Convert\Converters\BaseTraits;
/**
* Trait for handling warnings (by logging them)
*
* This trait is currently only used in the AbstractConverter class. It has been extracted into a
* trait in order to bundle the methods concerning options.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
trait WarningLoggerTrait
{
abstract public function logLn($msg, $style = '');
/** @var string|array|null Previous error handler (stored in order to be able pass warnings on) */
private $previousErrorHandler;
/** @var boolean Suppress ALL warnings? (both from log and from bubbling up) */
private $suppressWarnings;
/** @var int Count number of warnings */
private $warningCounter;
/**
* Handle warnings and notices during conversion by logging them and passing them on.
*
* The function is a callback used with "set_error_handler".
* It is declared public because it needs to be accessible from the point where the warning is triggered.
*
* PS: The fifth parameter ($errcontext) of an error handler is deprecated since PHP 7.2, however we have
* it here to avoid calling another error handler with too few parameters (see #266)
*
* @param integer $errno
* @param string $errstr
* @param string $errfile
* @param integer $errline
* @param array $errcontext
*
* @return false|null|void
*/
public function warningHandler($errno, $errstr, $errfile, $errline, $errcontext = null)
{
/*
We do NOT do the following (even though it is generally recommended):
if (!(error_reporting() & $errno)) {
// This error code is not included in error_reporting, so let it fall
// through to the standard PHP error handler
return false;
}
- Because we want to log all warnings and errors (also the ones that was suppressed with @)
https://secure.php.net/manual/en/language.operators.errorcontrol.php
If we were to decide suppressing the ones with @, I could do this:
if (error_reporting() == 0) {
/// @ sign temporary disabled error reporting
return;
}
[https://stackoverflow.com/questions/7380782/error-suppression-operator-and-set-error-handler]
However, that would also disable the warnings on systems with error reporting set to E_NONE.
And I really want the conversion log file to contain these warnings on all systems.
If it was possible to suppress the warnings with @ without suppressing warnings on systems
with error reporting set to E_NONE, I would do that.
*/
$this->warningCounter++;
if ($this->suppressWarnings) {
return;
}
$errorTypes = [
E_WARNING => "Warning",
E_NOTICE => "Notice",
E_STRICT => "Strict Notice",
E_DEPRECATED => "Deprecated",
E_USER_DEPRECATED => "User Deprecated",
/*
The following can never be catched by a custom error handler:
E_PARSE, E_ERROR, E_CORE_ERROR, E_CORE_WARNING, E_COMPILE_ERROR, E_COMPILE_WARNING
We do do not currently trigger the following:
E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
But we may want to do that at some point, like this:
trigger_error('Your version of Gd is very old', E_USER_WARNING);
in that case, remember to add them to this array
*/
];
if (isset($errorTypes[$errno])) {
$errType = $errorTypes[$errno];
} else {
$errType = "Unknown error/warning/notice ($errno)";
}
$msg = $errType . ': ' . $errstr . ' in ' . $errfile . ', line ' . $errline . ', PHP ' . PHP_VERSION .
' (' . PHP_OS . ')';
$this->logLn('');
$this->logLn($msg, 'italic');
$this->logLn('');
if (!is_null($this->previousErrorHandler)) {
// If previousErrorHandler is this very error handler, exit to avoid recursion
// (this could happen if ::activateWarningLogger() were called twice)
if (is_array($this->previousErrorHandler) &&
isset($this->previousErrorHandler[0]) &&
($this->previousErrorHandler[0] == $this)
) {
return false;
} else {
return call_user_func($this->previousErrorHandler, $errno, $errstr, $errfile, $errline, $errcontext);
}
} else {
return false;
}
}
/**
* Activate warning logger.
*
* Sets the error handler and stores the previous so our error handler can bubble up warnings
*
* @return void
*/
protected function activateWarningLogger()
{
$this->suppressWarnings = false;
$this->warningCounter = 0;
$this->previousErrorHandler = set_error_handler(
array($this, "warningHandler"),
E_WARNING | E_USER_WARNING | E_NOTICE | E_USER_NOTICE
);
}
/**
* Deactivate warning logger.
*
* Restores the previous error handler.
*
* @return void
*/
protected function deactivateWarningLogger()
{
restore_error_handler();
}
protected function disableWarningsTemporarily()
{
$this->suppressWarnings = true;
}
protected function reenableWarnings()
{
$this->suppressWarnings = false;
}
protected function getWarningCount()
{
return $this->warningCounter;
}
protected function resetWarningCount()
{
$this->warningCounter = 0;
}
}

View File

@@ -0,0 +1,72 @@
<?php
namespace WebPConvert\Convert\Converters\ConverterTraits;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Helpers\PhpIniSizes;
/**
* Trait for converters that works by uploading to a cloud service.
*
* The trait adds a method for checking against upload limits.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
trait CloudConverterTrait
{
/**
* Test that filesize is below "upload_max_filesize" and "post_max_size" values in php.ini.
*
* @param string $iniSettingId Id of ini setting (ie "upload_max_filesize")
*
* @throws ConversionFailedException if filesize is larger than the ini setting
* @return void
*/
private function checkFileSizeVsIniSetting($iniSettingId)
{
$fileSize = @filesize($this->source);
if ($fileSize === false) {
return;
}
$sizeInIni = PhpIniSizes::getIniBytes($iniSettingId);
if ($sizeInIni === false) {
// Not sure if we should throw an exception here, or not...
return;
}
if ($sizeInIni < $fileSize) {
throw new ConversionFailedException(
'File is larger than your ' . $iniSettingId . ' (set in your php.ini). File size:' .
round($fileSize / 1024) . ' kb. ' .
$iniSettingId . ' in php.ini: ' . ini_get($iniSettingId) .
' (parsed as ' . round($sizeInIni / 1024) . ' kb)'
);
}
}
/**
* Check convertability of cloud converters (that file is not bigger than limits set in php.ini).
*
* Performs the same as ::Convertability(). It is here so converters that overrides the
* ::Convertability() still has a chance to do the checks.
*
* @throws ConversionFailedException if filesize is larger than "upload_max_filesize" or "post_max_size"
* @return void
*/
public function checkConvertabilityCloudConverterTrait()
{
$this->checkFileSizeVsIniSetting('upload_max_filesize');
$this->checkFileSizeVsIniSetting('post_max_size');
}
/**
* Check convertability of cloud converters (file upload limits).
*/
public function checkConvertability()
{
$this->checkConvertabilityCloudConverterTrait();
}
}

View File

@@ -0,0 +1,72 @@
<?php
namespace WebPConvert\Convert\Converters\ConverterTraits;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Convert\Converters\AbstractConverter;
/**
* Trait for converters that works by uploading to a cloud service.
*
* The trait adds a method for checking against upload limits.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
trait CurlTrait
{
/**
* Check basis operationality for converters relying on curl.
*
* Performs the same as ::checkOperationality(). It is here so converters that overrides the
* ::checkOperationality() still has a chance to do the checks.
*
* @throws SystemRequirementsNotMetException
* @return void
*/
public function checkOperationalityForCurlTrait()
{
if (!extension_loaded('curl')) {
throw new SystemRequirementsNotMetException('Required cURL extension is not available.');
}
if (!function_exists('curl_init')) {
throw new SystemRequirementsNotMetException('Required url_init() function is not available.');
}
if (!function_exists('curl_file_create')) {
throw new SystemRequirementsNotMetException(
'Required curl_file_create() function is not available (requires PHP > 5.5).'
);
}
}
/**
* Check basis operationality for converters relying on curl
*
* @throws SystemRequirementsNotMetException
* @return void
*/
public function checkOperationality()
{
$this->checkOperationalityForCurlTrait();
}
/**
* Init curl.
*
* @throws SystemRequirementsNotMetException if curl could not be initialized
* @return resource|\CurlHandle curl handle (from PHP8: CurlHandle)
*/
protected static function initCurl()
{
// Get curl handle
$ch = \curl_init();
if ($ch === false) {
throw new SystemRequirementsNotMetException('Could not initialise cURL.');
}
return $ch;
}
}

View File

@@ -0,0 +1,91 @@
<?php
//namespace WebPConvert\Convert\Converters\BaseTraits;
namespace WebPConvert\Convert\Converters\ConverterTraits;
/**
* Trait for converters that supports lossless encoding and thus the "lossless:auto" option.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
trait EncodingAutoTrait
{
abstract protected function doActualConvert();
abstract public function getSource();
abstract public function getDestination();
abstract public function setDestination($destination);
abstract public function getOptions();
abstract protected function setOption($optionName, $optionValue);
abstract protected function logLn($msg, $style = '');
abstract protected function log($msg, $style = '');
abstract protected function ln();
abstract protected function logReduction($source, $destination);
public function supportsLossless()
{
return true;
}
/** Default is to not pass "lossless:auto" on, but implement it.
*
* The Stack converter passes it on (it does not even use this trait)
* WPC currently implements it, but this might be configurable in the future.
*
*/
public function passOnEncodingAuto()
{
return false;
}
private function convertTwoAndSelectSmallest()
{
$destination = $this->getDestination();
$destinationLossless = $destination . '.lossless.webp';
$destinationLossy = $destination . '.lossy.webp';
$this->logLn(
'Encoding is set to auto - converting to both lossless and lossy and selecting the smallest file'
);
$this->ln();
$this->logLn('Converting to lossy');
$this->setDestination($destinationLossy);
$this->setOption('encoding', 'lossy');
$this->doActualConvert();
$this->log('Reduction: ');
$this->logReduction($this->getSource(), $destinationLossy);
$this->ln();
$this->logLn('Converting to lossless');
$this->setDestination($destinationLossless);
$this->setOption('encoding', 'lossless');
$this->doActualConvert();
$this->log('Reduction: ');
$this->logReduction($this->getSource(), $destinationLossless);
$this->ln();
if (filesize($destinationLossless) > filesize($destinationLossy)) {
$this->logLn('Picking lossy');
unlink($destinationLossless);
rename($destinationLossy, $destination);
} else {
$this->logLn('Picking lossless');
unlink($destinationLossy);
rename($destinationLossless, $destination);
}
$this->setDestination($destination);
$this->setOption('encoding', 'auto');
}
protected function runActualConvert()
{
if (!$this->passOnEncodingAuto() && ($this->getOptions()['encoding'] == 'auto') && $this->supportsLossless()) {
$this->convertTwoAndSelectSmallest();
} else {
$this->doActualConvert();
}
}
}

View File

@@ -0,0 +1,107 @@
<?php
namespace WebPConvert\Convert\Converters\ConverterTraits;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use ExecWithFallback\ExecWithFallback;
/**
* Trait for converters that uses exec() or similar
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
trait ExecTrait
{
abstract protected function logLn($msg, $style = '');
/**
* Helper function for examining if "nice" command is available
*
* @return boolean true if nice is available
*/
protected static function hasNiceSupport()
{
ExecWithFallback::exec("nice 2>&1", $niceOutput);
if (is_array($niceOutput) && isset($niceOutput[0])) {
if (preg_match('/usage/', $niceOutput[0]) || (preg_match('/^\d+$/', $niceOutput[0]))) {
/*
* Nice is available - default niceness (+10)
* https://www.lifewire.com/uses-of-commands-nice-renice-2201087
* https://www.computerhope.com/unix/unice.htm
*/
return true;
}
return false;
}
return false; // to satisfy phpstan
}
protected function checkNiceSupport()
{
$ok = self::hasNiceSupport();
if ($ok) {
$this->logLn('Tested "nice" command - it works :)');
} else {
$this->logLn(
'**No "nice" support. To save a few ms, you can disable the "use-nice" option.**'
);
}
return $ok;
}
protected static function niceOption()
{
return ['use-nice', 'boolean', [
'title' => 'Use nice',
'description' =>
'If *use-nice* is set, it will be examined if the *nice* command is available. ' .
'If it is, the binary is executed using *nice*. This assigns low priority to the process and ' .
'will save system resources - but result in slower conversion.',
'default' => true,
'ui' => [
'component' => 'checkbox',
'advanced' => true
]
]];
}
/**
* Logs output from the exec call.
*
* @param array $output
*
* @return void
*/
protected function logExecOutput($output)
{
if (is_array($output) && count($output) > 0) {
$this->logLn('');
$this->logLn('Output:', 'italic');
foreach ($output as $line) {
$this->logLn(print_r($line, true));
}
$this->logLn('');
}
}
/**
* Check basic operationality of exec converters (that the "exec" or similar function is available)
*
* @throws WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException
* @return void
*/
public function checkOperationalityExecTrait()
{
if (!ExecWithFallback::anyAvailable()) {
throw new SystemRequirementsNotMetException(
'exec() is not enabled (nor is alternative methods, such as proc_open())'
);
}
}
}

View File

@@ -0,0 +1,979 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Converters\BaseTraits\WarningLoggerTrait;
use WebPConvert\Convert\Converters\ConverterTraits\EncodingAutoTrait;
use WebPConvert\Convert\Converters\ConverterTraits\ExecTrait;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperationalException;
use WebPConvert\Helpers\BinaryDiscovery;
use WebPConvert\Options\OptionFactory;
use ExecWithFallback\ExecWithFallback;
/**
* Convert images to webp by calling cwebp binary.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class Cwebp extends AbstractConverter
{
use EncodingAutoTrait;
use ExecTrait;
protected function getUnsupportedDefaultOptions()
{
return [];
}
/**
* Get the options unique for this converter
*
* @return array Array of options
*/
public function getUniqueOptions($imageType)
{
$binariesForOS = [];
if (isset(self::$suppliedBinariesInfo[PHP_OS])) {
foreach (self::$suppliedBinariesInfo[PHP_OS] as $i => list($file, $hash, $version)) {
$binariesForOS[] = $file;
}
}
return OptionFactory::createOptions([
self::niceOption(),
['try-cwebp', 'boolean', [
'title' => 'Try plain cwebp command',
'description' =>
'If set, the converter will try executing "cwebp -version". In case it succeeds, ' .
'and the version is higher than those working cwebps found using other methods, ' .
'the conversion will be done by executing this cwebp.',
'default' => true,
'ui' => [
'component' => 'checkbox',
'advanced' => true
]
]],
['try-discovering-cwebp', 'boolean', [
'title' => 'Try discovering cwebp binary',
'description' =>
'If set, the converter will try to discover installed cwebp binaries using a "which -a cwebp" ' .
'command, or in case that fails, a "whereis -b cwebp" command. These commands will find ' .
'cwebp binaries residing in PATH',
'default' => true,
'ui' => [
'component' => 'checkbox',
'advanced' => true
]
]],
['try-common-system-paths', 'boolean', [
'title' => 'Try locating cwebp in common system paths',
'description' =>
'If set, the converter will look for a cwebp binaries residing in common system locations ' .
'such as "/usr/bin/cwebp". If such exist, it is assumed that they are valid cwebp binaries. ' .
'A version check will be run on the binaries found (they are executed with the "-version" flag. ' .
'The cwebp with the highest version found using this method and the other enabled methods will ' .
'be used for the actual conversion.' .
'Note: All methods for discovering cwebp binaries are per default enabled. You can save a few ' .
'microseconds by disabling some, but it is probably not worth it, as your ' .
'setup will then become less resilient to system changes.',
'default' => true,
'ui' => [
'component' => 'checkbox',
'advanced' => true
]
]],
['try-supplied-binary-for-os', 'boolean', [
'title' => 'Try precompiled cwebp binaries',
'description' =>
'If set, the converter will try use a precompiled cwebp binary that comes with webp-convert. ' .
'But only if it has a higher version that those found by other methods. As the library knows ' .
'the versions of its bundled binaries, no additional time is spent executing them with the ' .
'"-version" parameter. The binaries are hash-checked before executed. ' .
'The library btw. comes with several versions of precompiled cwebps because they have different ' .
'dependencies - some works on some systems and others on others.',
'default' => true,
'ui' => [
'component' => 'checkbox',
'advanced' => true
]
]],
['skip-these-precompiled-binaries', 'string', [
'title' => 'Skip these precompiled binaries',
'description' =>
'',
'default' => '',
'ui' => [
'component' => 'multi-select',
'advanced' => true,
'options' => $binariesForOS,
'display' => "option('cwebp-try-supplied-binary-for-os') == true"
]
]],
['rel-path-to-precompiled-binaries', 'string', [
'title' => 'Rel path to precompiled binaries',
'description' =>
'',
'default' => './Binaries',
'ui' => [
'component' => '',
'advanced' => true,
'display' => "option('cwebp-try-supplied-binary-for-os') == true"
],
'sensitive' => true
]],
['command-line-options', 'string', [
'title' => 'Command line options',
'description' =>
'',
'default' => '',
'ui' => [
'component' => 'input',
'advanced' => true,
]
]],
]);
}
// OS-specific binaries included in this library, along with hashes
// If other binaries are going to be added, notice that the first argument is what PHP_OS returns.
// (possible values, see here: https://stackoverflow.com/questions/738823/possible-values-for-php-os)
// Got the precompiled binaries here: https://developers.google.com/speed/webp/docs/precompiled
// Note when changing binaries:
// 1: Do NOT use "." in filename. It causes unzipping to fail on some hosts
// 2: Set permission to 775. 755 causes unzipping to fail on some hosts
private static $suppliedBinariesInfo = [
'WINNT' => [
['cwebp-120-windows-x64.exe', '2849fd06012a9eb311b02a4f8918ae4b16775693bc21e95f4cc6a382eac299f9', '1.2.0'],
// Keep the 1.1.0 version a while, in case some may have problems with the 1.2.0 version
['cwebp-110-windows-x64.exe', '442682869402f92ad2c8b3186c02b0ea6d6da68d2f908df38bf905b3411eb9fb', '1.1.0'],
],
'Darwin' => [
['cwebp-110-mac-10_15', 'bfce742da09b959f9f2929ba808fed9ade25c8025530434b6a47d217a6d2ceb5', '1.1.0'],
],
'SunOS' => [
// Got this from ewww Wordpress plugin, which unfortunately still uses the old 0.6.0 versions
// Can you help me get a 1.0.3 version?
['cwebp-060-solaris', '1febaffbb18e52dc2c524cda9eefd00c6db95bc388732868999c0f48deb73b4f', '0.6.0']
],
'FreeBSD' => [
// Got this from ewww Wordpress plugin, which unfortunately still uses the old 0.6.0 versions
// Can you help me get a 1.0.3 version?
['cwebp-060-fbsd', 'e5cbea11c97fadffe221fdf57c093c19af2737e4bbd2cb3cd5e908de64286573', '0.6.0']
],
'Linux' => [
// PS: Some experience the following error with 1.20:
// /lib/x86_64-linux-gnu/libm.so.6: version `GLIBC_2.29' not found
// (see #278)
['cwebp-120-linux-x86-64', 'f1b7dc03e95535a6b65852de07c0404be4dba078af48369f434ee39b2abf8f4e', '1.2.0'],
// As some experience the an error with 1.20 (see #278), we keep the 1.10
['cwebp-110-linux-x86-64', '1603b07b592876dd9fdaa62b44aead800234c9474ff26dc7dd01bc0f4785c9c6', '1.1.0'],
// Statically linked executable
// It may be that it on some systems works, where the dynamically linked does not (see #196)
[
'cwebp-103-linux-x86-64-static',
'ab96f01b49336da8b976c498528080ff614112d5985da69943b48e0cb1c5228a',
'1.0.3'
],
// Old executable for systems in case all of the above fails
['cwebp-061-linux-x86-64', '916623e5e9183237c851374d969aebdb96e0edc0692ab7937b95ea67dc3b2568', '0.6.1'],
]
];
/**
* Check all hashes of the precompiled binaries.
*
* This isn't used when converting, but can be used as a startup check.
*/
public static function checkAllHashes()
{
foreach (self::$suppliedBinariesInfo as $os => $arr) {
foreach ($arr as $i => list($filename, $expectedHash)) {
$actualHash = hash_file("sha256", __DIR__ . '/Binaries/' . $filename);
if ($expectedHash != $actualHash) {
throw new \Exception(
'Hash for ' . $filename . ' is incorrect! ' .
'Checksum is: ' . $actualHash . ', ' .
', but expected: ' . $expectedHash .
'. Did you transfer with FTP, but not in binary mode? '
);
}
}
}
}
public function checkOperationality()
{
$this->checkOperationalityExecTrait();
$options = $this->options;
if (!$options['try-supplied-binary-for-os'] &&
!$options['try-common-system-paths'] &&
!$options['try-cwebp'] &&
!$options['try-discovering-cwebp']
) {
throw new ConverterNotOperationalException(
'Configured to neither try pure cwebp command, ' .
'nor look for cweb binaries in common system locations and ' .
'nor to use one of the supplied precompiled binaries. ' .
'But these are the only ways this converter can convert images. No conversion can be made!'
);
}
}
private function executeBinary($binary, $commandOptions, $useNice)
{
//$version = $this->detectVersion($binary);
// Redirect stderr to same place as stdout with "2>&1"
// https://www.brianstorti.com/understanding-shell-script-idiom-redirect/
$command = ($useNice ? 'nice ' : '') . $binary . ' ' . $commandOptions . ' 2>&1';
//$logger->logLn('command options:' . $commandOptions);
$this->logLn('Trying to convert by executing the following command:');
$startExecuteBinaryTime = self::startTimer();
;
$this->logLn($command);
ExecWithFallback::exec($command, $output, $returnCode);
$this->logExecOutput($output);
$this->logTimeSpent($startExecuteBinaryTime, 'Executing cwebp binary took: ');
$this->logLn('');
/*
if ($returnCode == 255) {
if (isset($output[0])) {
// Could be an error like 'Error! Cannot open output file' or 'Error! ...preset... '
$this->logLn(print_r($output[0], true));
}
}*/
//$logger->logLn(self::msgForExitCode($returnCode));
return intval($returnCode);
}
/**
* Use "escapeshellarg()" on all arguments in a commandline string of options
*
* For example, passing '-sharpness 5 -crop 10 10 40 40 -low_memory' will result in:
* [
* "-sharpness '5'"
* "-crop '10' '10' '40' '40'"
* "-low_memory"
* ]
* @param string $commandLineOptions string which can contain multiple commandline options
* @return array Array of command options
*/
private static function escapeShellArgOnCommandLineOptions($commandLineOptions)
{
if (!ctype_print($commandLineOptions)) {
throw new ConversionFailedException(
'Non-printable characters are not allowed in the extra command line options'
);
}
if (preg_match('#[^a-zA-Z0-9_\s\-]#', $commandLineOptions)) {
throw new ConversionFailedException('The extra command line options contains inacceptable characters');
}
$cmdOptions = [];
$arr = explode(' -', ' ' . $commandLineOptions);
foreach ($arr as $cmdOption) {
$pos = strpos($cmdOption, ' ');
$cName = '';
if (!$pos) {
$cName = $cmdOption;
if ($cName == '') {
continue;
}
$cmdOptions[] = '-' . $cName;
} else {
$cName = substr($cmdOption, 0, $pos);
$cValues = substr($cmdOption, $pos + 1);
$cValuesArr = explode(' ', $cValues);
foreach ($cValuesArr as &$cArg) {
$cArg = escapeshellarg($cArg);
}
$cValues = implode(' ', $cValuesArr);
$cmdOptions[] = '-' . $cName . ' ' . $cValues;
}
}
return $cmdOptions;
}
/**
* Build command line options for a given version of cwebp.
*
* The "-near_lossless" param is not supported on older versions of cwebp, so skip on those.
*
* @param string $version Version of cwebp (ie "1.0.3")
* @return string
*/
private function createCommandLineOptions($version)
{
$this->logLn('Creating command line options for version: ' . $version);
// we only need two decimal places for version.
// convert to number to make it easier to compare
$version = preg_match('#^\d+\.\d+#', $version, $matches);
$versionNum = 0;
if (isset($matches[0])) {
$versionNum = floatval($matches[0]);
} else {
$this->logLn(
'Could not extract version number from the following version string: ' . $version,
'bold'
);
}
//$this->logLn('version:' . strval($versionNum));
$options = $this->options;
$cmdOptions = [];
// Metadata (all, exif, icc, xmp or none (default))
// Comma-separated list of existing metadata to copy from input to output
if ($versionNum >= 0.3) {
$cmdOptions[] = '-metadata ' . $options['metadata'];
} else {
$this->logLn('Ignoring metadata option (requires cwebp 0.3)', 'italic');
}
// preset. Appears first in the list as recommended in the docs
if (!is_null($options['preset'])) {
if ($options['preset'] != 'none') {
$cmdOptions[] = '-preset ' . escapeshellarg($options['preset']);
}
}
// Size
$addedSizeOption = false;
if (!is_null($options['size-in-percentage'])) {
$sizeSource = filesize($this->source);
if ($sizeSource !== false) {
$targetSize = floor($sizeSource * $options['size-in-percentage'] / 100);
$cmdOptions[] = '-size ' . $targetSize;
$addedSizeOption = true;
}
}
// quality
if (!$addedSizeOption) {
$cmdOptions[] = '-q ' . $this->getCalculatedQuality();
}
// alpha-quality
if ($this->options['alpha-quality'] !== 100) {
$cmdOptions[] = '-alpha_q ' . escapeshellarg($this->options['alpha-quality']);
}
// Losless PNG conversion
if ($options['encoding'] == 'lossless') {
// No need to add -lossless when near-lossless is used (on version >= 0.5)
if (($options['near-lossless'] === 100) || ($versionNum < 0.5)) {
$cmdOptions[] = '-lossless';
}
}
// Near-lossles
if ($options['near-lossless'] !== 100) {
if ($versionNum < 0.5) {
$this->logLn('Ignoring near-lossless option (requires cwebp 0.5)', 'italic');
} else {
// The "-near_lossless" flag triggers lossless encoding. We don't want that to happen,
// we want the "encoding" option to be respected, and we need it to be in order for
// encoding=auto to work.
// So: Only set when "encoding" is set to "lossless"
if ($options['encoding'] == 'lossless') {
$cmdOptions[] = '-near_lossless ' . $options['near-lossless'];
} else {
$this->logLn(
'The near-lossless option ignored for lossy'
);
}
}
}
// Autofilter
if ($options['auto-filter'] === true) {
$cmdOptions[] = '-af';
}
// SharpYUV
if ($options['sharp-yuv'] === true) {
if ($versionNum >= 0.6) { // #284
$cmdOptions[] = '-sharp_yuv';
} else {
$this->logLn('Ignoring sharp-yuv option (requires cwebp 0.6)', 'italic');
}
}
// Built-in method option
$cmdOptions[] = '-m ' . strval($options['method']);
// Built-in low memory option
if ($options['low-memory']) {
$cmdOptions[] = '-low_memory';
}
// command-line-options
if ($options['command-line-options']) {
/*
In some years, we can use the splat instead (requires PHP 5.6)
array_push(
$cmdOptions,
...self::escapeShellArgOnCommandLineOptions($options['command-line-options'])
);
*/
foreach (self::escapeShellArgOnCommandLineOptions($options['command-line-options']) as $cmdLineOption) {
array_push($cmdOptions, $cmdLineOption);
}
}
// Source file
$cmdOptions[] = escapeshellarg($this->source);
// Output
$cmdOptions[] = '-o ' . escapeshellarg($this->destination);
$commandOptions = implode(' ', $cmdOptions);
//$this->logLn('command line options:' . $commandOptions);
return $commandOptions;
}
private function checkHashForSuppliedBinary($binaryFile, $hash)
{
// File exists, now generate its hash
// hash_file() is normally available, but it is not always
// - https://stackoverflow.com/questions/17382712/php-5-3-20-undefined-function-hash
// If available, validate that hash is correct.
if (function_exists('hash_file')) {
$this->logLn(
'Checking checksum for supplied binary: ' . $binaryFile
);
$startHashCheckTime = self::startTimer();
$binaryHash = hash_file('sha256', $binaryFile);
if ($binaryHash != $hash) {
$this->logLn(
'Binary checksum of supplied binary is invalid! ' .
'Did you transfer with FTP, but not in binary mode? ' .
'File:' . $binaryFile . '. ' .
'Expected checksum: ' . $hash . '. ' .
'Actual checksum:' . $binaryHash . '.',
'bold'
);
return false;
;
}
$this->logTimeSpent($startHashCheckTime, 'Checksum test took: ');
}
return true;
}
/**
* Get supplied binary info for current OS.
* paths are made absolute and checked. Missing are removed
*
* @return array Two arrays.
* First array: array of files (absolute paths)
* Second array: array of info objects (absolute path, hash and version)
*/
private function getSuppliedBinaryInfoForCurrentOS()
{
$this->log('Checking if we have a supplied precompiled binary for your OS (' . PHP_OS . ')... ');
// Try supplied binary (if available for OS, and hash is correct)
$options = $this->options;
if (!isset(self::$suppliedBinariesInfo[PHP_OS])) {
$this->logLn('No we dont - not for that OS');
return [];
}
$filesFound = [];
$info = [];
$files = self::$suppliedBinariesInfo[PHP_OS];
if (count($files) == 1) {
$this->logLn('We do.');
} else {
$this->logLn('We do. We in fact have ' . count($files));
}
$skipThese = explode(',', $this->options['skip-these-precompiled-binaries']);
//$this->logLn('However, skipping' . print_r($skipThese, true));
foreach ($files as $i => list($file, $hash, $version)) {
//$file = $info[0];
//$hash = $info[1];
$binaryFile = __DIR__ . '/' . $options['rel-path-to-precompiled-binaries'] . '/' . $file;
// Replace "/./" with "/" in path (we could alternatively use realpath)
//$binaryFile = preg_replace('#\/\.\/#', '/', $binaryFile);
// The file should exist, but may have been removed manually.
/*
if (!file_exists($binaryFile)) {
$this->logLn('Supplied binary not found! It ought to be here:' . $binaryFile, 'italic');
return false;
}*/
if (in_array($file, $skipThese)) {
$this->logLn('Skipped: ' . $file . ' (was told to in the "skip-these-precompiled-binaries" option)');
continue;
}
$realPathResult = realpath($binaryFile);
if ($realPathResult === false) {
$this->logLn('Supplied binary not found! It ought to be here:' . $binaryFile, 'italic');
continue;
}
$binaryFile = $realPathResult;
$filesFound[] = $realPathResult;
$info[] = [$realPathResult, $hash, $version, $file];
}
return [$filesFound, $info];
}
private function who()
{
ExecWithFallback::exec('whoami 2>&1', $whoOutput, $whoReturnCode);
if (($whoReturnCode == 0) && (isset($whoOutput[0]))) {
return 'user: "' . $whoOutput[0] . '"';
} else {
return 'the user that the command was run with';
}
}
/**
* Detect the version of a cwebp binary.
*
* @param string $binary The binary to detect version for (path to cwebp or simply "cwebp")
*
* @return string|int Version string (ie "1.0.2") OR return code, in case of failure
*/
private function detectVersion($binary)
{
$command = $binary . ' -version 2>&1';
$this->log('- Executing: ' . $command);
ExecWithFallback::exec($command, $output, $returnCode);
if ($returnCode == 0) {
if (isset($output[0])) {
$this->logLn('. Result: version: *' . $output[0] . '*');
return $output[0];
}
} else {
$this->log('. Result: ');
if ($returnCode == 127) {
$this->logLn(
'*Exec failed* (the cwebp binary was not found at path: ' . $binary .
', or it had missing library dependencies)'
);
} else {
if ($returnCode == 126) {
$this->logLn(
'*Exec failed*. ' .
'Permission denied (' . $this->who() . ' does not have permission to execute that binary)'
);
} else {
$this->logLn(
'*Exec failed* (return code: ' . $returnCode . ')'
);
$this->logExecOutput($output);
}
}
return $returnCode;
}
return ''; // Will not happen. Just so phpstan doesn't complain
}
/**
* Check versions for an array of binaries.
*
* @param array $binaries array of binaries to detect the version of
*
* @return array the "detected" key holds working binaries and their version numbers, the
* the "failed" key holds failed binaries and their error codes.
*/
private function detectVersions($binaries)
{
$binariesWithVersions = [];
$binariesWithFailCodes = [];
foreach ($binaries as $binary) {
$versionStringOrFailCode = $this->detectVersion($binary);
// $this->logLn($binary . ': ' . $versionString);
if (gettype($versionStringOrFailCode) == 'string') {
$binariesWithVersions[$binary] = $versionStringOrFailCode;
} else {
$binariesWithFailCodes[$binary] = $versionStringOrFailCode;
}
}
return ['detected' => $binariesWithVersions, 'failed' => $binariesWithFailCodes];
}
private function logBinariesFound($binaries, $startTime)
{
if (count($binaries) == 0) {
$this->logLn('Found 0 binaries' . self::getTimeStr($startTime));
} else {
$this->logLn('Found ' . count($binaries) . ' binaries' . self::getTimeStr($startTime));
foreach ($binaries as $binary) {
$this->logLn('- ' . $binary);
}
}
}
private function logDiscoverAction($optionName, $description)
{
if ($this->options[$optionName]) {
$this->logLn(
'Discovering binaries ' . $description . ' ' .
'(to skip this step, disable the "' . $optionName . '" option)'
);
} else {
$this->logLn(
'Skipped discovering binaries ' . $description . ' ' .
'(enable "' . $optionName . '" if you do not want to skip that step)'
);
}
}
private static function startTimer()
{
if (function_exists('microtime')) {
return microtime(true);
} else {
return 0;
}
}
private static function readTimer($startTime)
{
if (function_exists('microtime')) {
$endTime = microtime(true);
$seconds = ($endTime - $startTime);
return round(($seconds * 1000));
} else {
return 0;
}
}
private static function getTimeStr($startTime, $pre = ' (spent ', $post = ')')
{
if (function_exists('microtime')) {
$ms = self::readTimer($startTime);
return $pre . $ms . ' ms' . $post;
}
return '';
}
private function logTimeSpent($startTime, $pre = 'Spent: ')
{
if (function_exists('microtime')) {
$ms = self::readTimer($startTime);
$this->logLn($pre . $ms . ' ms');
}
}
/**
* @return array Two arrays (in an array).
* First array: binaries found,
* Second array: supplied binaries info for current OS
*/
private function discoverCwebpBinaries()
{
$this->logLn(
'Looking for cwebp binaries.'
);
$startDiscoveryTime = self::startTimer();
$binaries = [];
if (defined('WEBPCONVERT_CWEBP_PATH')) {
$this->logLn('WEBPCONVERT_CWEBP_PATH was defined, so using that path and ignoring any other');
return [[constant('WEBPCONVERT_CWEBP_PATH')],[[], []]];
}
if (!empty(getenv('WEBPCONVERT_CWEBP_PATH'))) {
$this->logLn(
'WEBPCONVERT_CWEBP_PATH environment variable was set, so using that path and ignoring any other'
);
return [[getenv('WEBPCONVERT_CWEBP_PATH')],[[], []]];
}
if ($this->options['try-cwebp']) {
$startTime = self::startTimer();
$this->logLn(
'Discovering if a plain cwebp call works (to skip this step, disable the "try-cwebp" option)'
);
$result = $this->detectVersion('cwebp');
if (gettype($result) == 'string') {
$this->logLn('We could get the version, so yes, a plain cwebp call works ' .
'(spent ' . self::readTimer($startTime) . ' ms)');
$binaries[] = 'cwebp';
} else {
$this->logLn('Nope a plain cwebp call does not work' . self::getTimeStr($startTime));
}
} else {
$this->logLn(
'Skipped discovering if a plain cwebp call works' .
' (enable the "try-cwebp" option if you do not want to skip that step)'
);
}
// try-discovering-cwebp
$startTime = self::startTimer();
$this->logDiscoverAction('try-discovering-cwebp', 'using "which -a cwebp" command.');
if ($this->options['try-discovering-cwebp']) {
$moreBinaries = BinaryDiscovery::discoverInstalledBinaries('cwebp');
$this->logBinariesFound($moreBinaries, $startTime);
$binaries = array_merge($binaries, $moreBinaries);
}
// 'try-common-system-paths'
$startTime = self::startTimer();
$this->logDiscoverAction('try-common-system-paths', 'by peeking in common system paths');
if ($this->options['try-common-system-paths']) {
$moreBinaries = BinaryDiscovery::discoverInCommonSystemPaths('cwebp');
$this->logBinariesFound($moreBinaries, $startTime);
$binaries = array_merge($binaries, $moreBinaries);
}
// try-supplied-binary-for-os
$suppliedBinariesInfo = [[], []];
$startTime = self::startTimer();
$this->logDiscoverAction('try-supplied-binary-for-os', 'which are distributed with the webp-convert library');
if ($this->options['try-supplied-binary-for-os']) {
$suppliedBinariesInfo = $this->getSuppliedBinaryInfoForCurrentOS();
$moreBinaries = $suppliedBinariesInfo[0];
$this->logBinariesFound($moreBinaries, $startTime);
//$binaries = array_merge($binaries, $moreBinaries);
}
$this->logTimeSpent($startDiscoveryTime, 'Discovering cwebp binaries took: ');
$this->logLn('');
return [array_values(array_unique($binaries)), $suppliedBinariesInfo];
}
/**
* Try executing a cwebp binary (or command, like: "cwebp")
*
* @param string $binary
* @param string $version Version of cwebp (ie "1.0.3")
* @param boolean $useNice Whether to use "nice" command or not
*
* @return boolean success or not.
*/
private function tryCwebpBinary($binary, $version, $useNice)
{
//$this->logLn('Trying binary: ' . $binary);
$commandOptions = $this->createCommandLineOptions($version);
$returnCode = $this->executeBinary($binary, $commandOptions, $useNice);
if ($returnCode == 0) {
// It has happened that even with return code 0, there was no file at destination.
if (!file_exists($this->destination)) {
$this->logLn('executing cweb returned success code - but no file was found at destination!');
return false;
} else {
$this->logLn('Success');
return true;
}
} else {
$this->logLn(
'Exec failed (return code: ' . $returnCode . ')'
);
return false;
}
}
/**
* Helper for composing an error message when no converters are working.
*
* @param array $versions The array which we get from calling ::detectVersions($binaries)
* @return string An informative and to the point error message.
*/
private function composeMeaningfullErrorMessageNoVersionsWorking($versions)
{
// TODO: Take "supplied" into account
// PS: array_values() is used to reindex
$uniqueFailCodes = array_values(array_unique(array_values($versions['failed'])));
$justOne = (count($versions['failed']) == 1);
if (count($uniqueFailCodes) == 1) {
if ($uniqueFailCodes[0] == 127) {
return 'No cwebp binaries located. Check the conversion log for details.';
}
}
// If there are more failures than 127, the 127 failures are unintesting.
// It is to be expected that some of the common system paths does not contain a cwebp.
$uniqueFailCodesBesides127 = array_values(array_diff($uniqueFailCodes, [127]));
if (count($uniqueFailCodesBesides127) == 1) {
if ($uniqueFailCodesBesides127[0] == 126) {
return 'No cwebp binaries could be executed (permission denied for ' . $this->who() . ').';
}
}
$errorMsg = '';
if ($justOne) {
$errorMsg .= 'The cwebp file found cannot be can be executed ';
} else {
$errorMsg .= 'None of the cwebp files can be executed ';
}
if (count($uniqueFailCodesBesides127) == 1) {
$errorMsg .= '(failure code: ' . $uniqueFailCodesBesides127[0] . ')';
} else {
$errorMsg .= '(failure codes: ' . implode(', ', $uniqueFailCodesBesides127) . ')';
}
return $errorMsg;
}
protected function doActualConvert()
{
list($foundBinaries, $suppliedBinariesInfo) = $this->discoverCwebpBinaries();
$suppliedBinaries = $suppliedBinariesInfo[0];
$allBinaries = array_merge($foundBinaries, $suppliedBinaries);
//$binaries = $this->discoverCwebpBinaries();
if (count($allBinaries) == 0) {
$this->logLn('No cwebp binaries found!');
$discoverOptions = [
'try-supplied-binary-for-os',
'try-common-system-paths',
'try-cwebp',
'try-discovering-cwebp'
];
$disabledDiscoverOptions = [];
foreach ($discoverOptions as $discoverOption) {
if (!$this->options[$discoverOption]) {
$disabledDiscoverOptions[] = $discoverOption;
}
}
if (count($disabledDiscoverOptions) == 0) {
throw new SystemRequirementsNotMetException(
'No cwebp binaries found.'
);
} else {
throw new SystemRequirementsNotMetException(
'No cwebp binaries found. Try enabling the "' .
implode('" option or the "', $disabledDiscoverOptions) . '" option.'
);
}
}
$detectedVersions = [];
if (count($foundBinaries) > 0) {
$this->logLn(
'Detecting versions of the cwebp binaries found' .
(count($suppliedBinaries) > 0 ? ' (except supplied binaries)' : '.')
);
$startDetectionTime = self::startTimer();
$versions = $this->detectVersions($foundBinaries);
$detectedVersions = $versions['detected'];
$this->logTimeSpent($startDetectionTime, 'Detecting versions took: ');
}
//$suppliedVersions = [];
$suppliedBinariesHash = [];
$suppliedBinariesFilename = [];
$binaryVersions = $detectedVersions;
foreach ($suppliedBinariesInfo[1] as list($path, $hash, $version, $filename)) {
$binaryVersions[$path] = $version;
$suppliedBinariesHash[$path] = $hash;
$suppliedBinariesFilename[$path] = $filename;
}
//$binaryVersions = array_merge($detectedVersions, $suppliedBinariesInfo);
// TODO: reimplement
/*
$versions['supplied'] = $suppliedBinariesInfo;
$binaryVersions = $versions['detected'];
if ((count($binaryVersions) == 0) && (count($suppliedBinaries) == 0)) {
// No working cwebp binaries found, no supplied binaries found
throw new SystemRequirementsNotMetException(
$this->composeMeaningfullErrorMessageNoVersionsWorking($versions)
);
}*/
// Sort binaries so those with highest numbers comes first
arsort($binaryVersions);
$this->logLn(
'Binaries ordered by version number.'
);
foreach ($binaryVersions as $binary => $version) {
$this->logLn('- ' . $binary . ': (version: ' . $version . ')');
}
// Execute!
$this->logLn(
'Starting conversion, using the first of these. If that should fail, ' .
'the next will be tried and so on.'
);
$useNice = ($this->options['use-nice'] && $this->checkNiceSupport());
$success = false;
foreach ($binaryVersions as $binary => $version) {
if (isset($suppliedBinariesHash[$binary])) {
if (!$this->checkHashForSuppliedBinary($binary, $suppliedBinariesHash[$binary])) {
continue;
}
}
if ($this->tryCwebpBinary($binary, $version, $useNice)) {
$success = true;
break;
} else {
if (isset($suppliedBinariesFilename[$binary])) {
$this->logLn(
'Note: You can prevent trying this precompiled binary, by setting the ' .
'"skip-these-precompiled-binaries" option to "' . $suppliedBinariesFilename[$binary] . '"'
);
}
}
}
// cwebp sets file permissions to 664 but instead ..
// .. $this->source file permissions should be used
if ($success) {
$fileStatistics = stat($this->source);
if ($fileStatistics !== false) {
// Apply same permissions as source file, but strip off the executable bits
$permissions = $fileStatistics['mode'] & 0000666;
chmod($this->destination, $permissions);
}
} else {
throw new SystemRequirementsNotMetException('Failed converting. Check the conversion log for details.');
}
}
}

View File

@@ -0,0 +1,389 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Converters\ConverterTraits\CloudConverterTrait;
use WebPConvert\Convert\Converters\ConverterTraits\CurlTrait;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperationalException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\InvalidApiKeyException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Options\BooleanOption;
use WebPConvert\Options\SensitiveStringOption;
use WebPConvert\Options\OptionFactory;
/**
* Convert images to webp using ewww cloud service.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class Ewww extends AbstractConverter
{
use CloudConverterTrait;
use CurlTrait;
/** @var array Array of invalid or exceeded api keys discovered during conversions (during the request) */
public static $nonFunctionalApiKeysDiscoveredDuringConversion;
public function getUniqueOptions($imageType)
{
return OptionFactory::createOptions([
['api-key', 'string', [
'title' => 'Ewww API key',
'description' => 'ewww API key. ' .
'If you choose "auto", webp-convert will ' .
'convert to both lossy and lossless and pick the smallest result',
'default' => '',
'sensitive' => true,
'ui' => [
'component' => 'password',
]
]],
['check-key-status-before-converting', 'boolean', [
'title' => 'Check key status before converting',
'description' =>
'If enabled, the api key will be validated (relative inexpensive) before trying ' .
'to convert. For automatic conversions, you should enable it. Otherwise you run the ' .
'risk that the same files will be uploaded to ewww cloud service over and over again, ' .
'in case the key has expired. For manually triggered conversions, you can safely disable ' .
'the option.',
'default' => true,
'ui' => [
'component' => 'checkbox',
]
]],
]);
}
protected function getUnsupportedDefaultOptions()
{
return [
'alpha-quality',
'auto-filter',
'encoding',
'low-memory',
'method',
'near-lossless',
'preset',
'sharp-yuv',
'size-in-percentage',
];
}
/**
* Get api key from options or environment variable
*
* @return string|false api key or false if none is set
*/
private function getKey()
{
if (!empty($this->options['api-key'])) {
return $this->options['api-key'];
}
if (defined('WEBPCONVERT_EWWW_API_KEY')) {
return constant('WEBPCONVERT_EWWW_API_KEY');
}
if (!empty(getenv('WEBPCONVERT_EWWW_API_KEY'))) {
return getenv('WEBPCONVERT_EWWW_API_KEY');
}
return false;
}
/**
* Check operationality of Ewww converter.
*
* @throws SystemRequirementsNotMetException if system requirements are not met (curl)
* @throws ConverterNotOperationalException if key is missing or invalid, or quota has exceeded
*/
public function checkOperationality()
{
$apiKey = $this->getKey();
if ($apiKey === false) {
if (isset($this->options['key'])) {
throw new InvalidApiKeyException(
'The "key" option has been renamed to "api-key" in webp-convert 2.0. ' .
'You must change the configuration accordingly.'
);
}
throw new InvalidApiKeyException('Missing API key.');
}
if (strlen($apiKey) < 20) {
throw new InvalidApiKeyException(
'Api key is invalid. Api keys are supposed to be 32 characters long - ' .
'the provided api key is much shorter'
);
}
// Check for curl requirements
$this->checkOperationalityForCurlTrait();
if ($this->options['check-key-status-before-converting']) {
$keyStatus = self::getKeyStatus($apiKey);
switch ($keyStatus) {
case 'great':
break;
case 'exceeded':
throw new ConverterNotOperationalException('Quota has exceeded');
//break;
case 'invalid':
throw new InvalidApiKeyException('Api key is invalid');
//break;
}
}
}
/*
public function checkConvertability()
{
// check upload limits
$this->checkConvertabilityCloudConverterTrait();
}
*/
// Although this method is public, do not call directly.
// You should rather call the static convert() function, defined in AbstractConverter, which
// takes care of preparing stuff before calling doConvert, and validating after.
protected function doActualConvert()
{
$options = $this->options;
$ch = self::initCurl();
//$this->logLn('api key:' . $this->getKey());
$postData = [
'api_key' => $this->getKey(),
'webp' => '1',
'file' => curl_file_create($this->source),
'quality' => $this->getCalculatedQuality(),
'metadata' => ($options['metadata'] == 'none' ? '0' : '1')
];
curl_setopt_array(
$ch,
[
CURLOPT_URL => "https://optimize.exactlywww.com/v2/",
CURLOPT_HTTPHEADER => [
'User-Agent: WebPConvert',
'Accept: image/*'
],
CURLOPT_POSTFIELDS => $postData,
CURLOPT_BINARYTRANSFER => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HEADER => false,
CURLOPT_SSL_VERIFYPEER => false
]
);
$response = curl_exec($ch);
if (curl_errno($ch)) {
throw new ConversionFailedException(curl_error($ch));
}
// The API does not always return images.
// For example, it may return a message such as '{"error":"invalid","t":"exceeded"}
// Messages has a http content type of ie 'text/html; charset=UTF-8
// Images has application/octet-stream.
// So verify that we got an image back.
if (curl_getinfo($ch, CURLINFO_CONTENT_TYPE) != 'application/octet-stream') {
//echo curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
curl_close($ch);
/*
For bogus or expired key it returns: {"error":"invalid","t":"exceeded"}
For exceeded key it returns: {"error":"exceeded"}
*/
$responseObj = json_decode($response);
if (isset($responseObj->error)) {
$this->logLn('We received the following error response: ' . $responseObj->error);
$this->logLn('Complete response: ' . json_encode($responseObj));
// Store the invalid key in array so it can be received once the Stack is completed
// (even when stack succeeds)
if (!isset(self::$nonFunctionalApiKeysDiscoveredDuringConversion)) {
self::$nonFunctionalApiKeysDiscoveredDuringConversion = [];
}
if (!in_array($options['api-key'], self::$nonFunctionalApiKeysDiscoveredDuringConversion)) {
self::$nonFunctionalApiKeysDiscoveredDuringConversion[] = $options['api-key'];
}
if ($responseObj->error == "invalid") {
throw new InvalidApiKeyException('The api key is invalid (or expired)');
} else {
throw new InvalidApiKeyException('The quota is exceeded for the api-key');
}
}
throw new ConversionFailedException(
'ewww api did not return an image. It could be that the key is invalid. Response: '
. $response
);
}
// Not sure this can happen. So just in case
if ($response == '') {
throw new ConversionFailedException('ewww api did not return anything');
}
$success = file_put_contents($this->destination, $response);
if (!$success) {
throw new ConversionFailedException('Error saving file');
}
}
/**
* Keep subscription alive by optimizing a jpeg
* (ewww closes accounts after 6 months of inactivity - and webp conversions seems not to be counted? )
*/
public static function keepSubscriptionAlive($source, $key)
{
try {
$ch = curl_init();
} catch (\Exception $e) {
return 'curl is not installed';
}
if ($ch === false) {
return 'curl could not be initialized';
}
curl_setopt_array(
$ch,
[
CURLOPT_URL => "https://optimize.exactlywww.com/v2/",
CURLOPT_HTTPHEADER => [
'User-Agent: WebPConvert',
'Accept: image/*'
],
CURLOPT_POSTFIELDS => [
'api_key' => $key,
'webp' => '0',
'file' => curl_file_create($source),
'domain' => $_SERVER['HTTP_HOST'],
'quality' => 60,
'metadata' => 0
],
CURLOPT_BINARYTRANSFER => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HEADER => false,
CURLOPT_SSL_VERIFYPEER => false
]
);
$response = curl_exec($ch);
if (curl_errno($ch)) {
return 'curl error' . curl_error($ch);
}
if (curl_getinfo($ch, CURLINFO_CONTENT_TYPE) != 'application/octet-stream') {
curl_close($ch);
/* May return this: {"error":"invalid","t":"exceeded"} */
$responseObj = json_decode($response);
if (isset($responseObj->error)) {
return 'The key is invalid';
}
return 'ewww api did not return an image. It could be that the key is invalid. Response: ' . $response;
}
// Not sure this can happen. So just in case
if ($response == '') {
return 'ewww api did not return anything';
}
return true;
}
/*
public static function blacklistKey($key)
{
}
public static function isKeyBlacklisted($key)
{
}*/
/**
* Return "great", "exceeded" or "invalid"
*/
public static function getKeyStatus($key)
{
$ch = self::initCurl();
curl_setopt($ch, CURLOPT_URL, "https://optimize.exactlywww.com/verify/");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, [
'api_key' => $key
]);
curl_setopt($ch, CURLOPT_USERAGENT, 'WebPConvert');
$response = curl_exec($ch);
// echo $response;
if (curl_errno($ch)) {
throw new \Exception(curl_error($ch));
}
curl_close($ch);
// Possible responses:
// “great” = verification successful
// “exceeded” = indicates a valid key with no remaining image credits.
// an empty response indicates that the key is not valid
if ($response == '') {
return 'invalid';
}
$responseObj = json_decode($response);
if (isset($responseObj->error)) {
if ($responseObj->error == 'invalid') {
return 'invalid';
} else {
throw new \Exception('Ewww returned unexpected error: ' . $response);
}
}
if (!isset($responseObj->status)) {
throw new \Exception('Ewww returned unexpected response to verify request: ' . $response);
}
switch ($responseObj->status) {
case 'great':
case 'exceeded':
return $responseObj->status;
}
throw new \Exception('Ewww returned unexpected status to verify request: "' . $responseObj->status . '"');
}
public static function isWorkingKey($key)
{
return (self::getKeyStatus($key) == 'great');
}
public static function isValidKey($key)
{
return (self::getKeyStatus($key) != 'invalid');
}
public static function getQuota($key)
{
$ch = self::initCurl();
curl_setopt($ch, CURLOPT_URL, "https://optimize.exactlywww.com/quota/");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, [
'api_key' => $key
]);
curl_setopt($ch, CURLOPT_USERAGENT, 'WebPConvert');
$response = curl_exec($ch);
return $response; // ie -830 23. Seems to return empty for invalid keys
// or empty
//echo $response;
}
}

View File

@@ -0,0 +1,178 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Converters\ConverterTraits\ExecTrait;
use WebPConvert\Convert\Converters\ConverterTraits\EncodingAutoTrait;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Options\OptionFactory;
use ExecWithFallback\ExecWithFallback;
//use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput\TargetNotFoundException;
/**
* Convert images to webp by calling imagemagick binary.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class FFMpeg extends AbstractConverter
{
use ExecTrait;
use EncodingAutoTrait;
protected function getUnsupportedDefaultOptions()
{
return [
'alpha-quality',
'auto-filter',
'low-memory',
'metadata',
'near-lossless',
'sharp-yuv',
'size-in-percentage',
];
}
/**
* Get the options unique for this converter
*
* @return array Array of options
*/
public function getUniqueOptions($imageType)
{
return OptionFactory::createOptions([
self::niceOption()
]);
}
private function getPath()
{
if (defined('WEBPCONVERT_FFMPEG_PATH')) {
return constant('WEBPCONVERT_FFMPEG_PATH');
}
if (!empty(getenv('WEBPCONVERT_FFMPEG_PATH'))) {
return getenv('WEBPCONVERT_FFMPEG_PATH');
}
return 'ffmpeg';
}
public function isInstalled()
{
ExecWithFallback::exec($this->getPath() . ' -version 2>&1', $output, $returnCode);
return ($returnCode == 0);
}
// Check if webp delegate is installed
public function isWebPDelegateInstalled()
{
ExecWithFallback::exec($this->getPath() . ' -version 2>&1', $output, $returnCode);
foreach ($output as $line) {
if (preg_match('# --enable-libwebp#i', $line)) {
return true;
}
}
return false;
}
/**
* Check (general) operationality of imagack converter executable
*
* @throws SystemRequirementsNotMetException if system requirements are not met
*/
public function checkOperationality()
{
$this->checkOperationalityExecTrait();
if (!$this->isInstalled()) {
throw new SystemRequirementsNotMetException(
'ffmpeg is not installed (cannot execute: "' . $this->getPath() . '")'
);
}
if (!$this->isWebPDelegateInstalled()) {
throw new SystemRequirementsNotMetException('ffmpeg was compiled without libwebp');
}
}
/**
* Build command line options
*
* @return string
*/
private function createCommandLineOptions()
{
// PS: Available webp options for ffmpeg are documented here:
// https://www.ffmpeg.org/ffmpeg-codecs.html#libwebp
$commandArguments = [];
$commandArguments[] = '-i';
$commandArguments[] = escapeshellarg($this->source);
// preset. Appears first in the list as recommended in the cwebp docs
if (!is_null($this->options['preset'])) {
if ($this->options['preset'] != 'none') {
$commandArguments[] = '-preset ' . $this->options['preset'];
}
}
// Overwrite existing files?, yes!
$commandArguments[] = '-y';
if ($this->isQualityDetectionRequiredButFailing()) {
// quality:auto was specified, but could not be determined.
// we cannot apply the max-quality logic, but we can provide auto quality
// simply by not specifying the quality option.
} else {
$commandArguments[] = '-qscale ' . escapeshellarg($this->getCalculatedQuality());
}
if ($this->options['encoding'] == 'lossless') {
$commandArguments[] = '-lossless 1';
} else {
$commandArguments[] = '-lossless 0';
}
if ($this->options['metadata'] == 'none') {
// Unfortunately there seems to be no easy solution available for removing all metadata.
}
// compression_level maps to method, according to https://www.ffmpeg.org/ffmpeg-codecs.html#libwebp
$commandArguments[] = '-compression_level ' . $this->options['method'];
$commandArguments[] = escapeshellarg($this->destination);
return implode(' ', $commandArguments);
}
protected function doActualConvert()
{
//$this->logLn($this->getVersion());
$command = $this->getPath() . ' ' . $this->createCommandLineOptions() . ' 2>&1';
$useNice = ($this->options['use-nice'] && $this->checkNiceSupport());
if ($useNice) {
$command = 'nice ' . $command;
}
$this->logLn('Executing command: ' . $command);
ExecWithFallback::exec($command, $output, $returnCode);
$this->logExecOutput($output);
if ($returnCode == 0) {
$this->logLn('success');
} else {
$this->logLn('return code: ' . $returnCode);
}
if ($returnCode == 127) {
throw new SystemRequirementsNotMetException('ffmpeg is not installed');
}
if ($returnCode != 0) {
throw new SystemRequirementsNotMetException('The exec() call failed');
}
}
}

View File

@@ -0,0 +1,536 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInputException;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
/**
* Convert images to webp using gd extension.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class Gd extends AbstractConverter
{
public function supportsLossless()
{
return false;
}
protected function getUnsupportedDefaultOptions()
{
return [
'alpha-quality',
'auto-filter',
'encoding',
'low-memory',
'metadata',
'method',
'near-lossless',
'preset',
'sharp-yuv',
'size-in-percentage',
];
}
private $errorMessageWhileCreating = '';
private $errorNumberWhileCreating;
/**
* Check (general) operationality of Gd converter.
*
* @throws SystemRequirementsNotMetException if system requirements are not met
*/
public function checkOperationality()
{
if (!extension_loaded('gd')) {
throw new SystemRequirementsNotMetException('Required Gd extension is not available.');
}
if (!function_exists('imagewebp')) {
throw new SystemRequirementsNotMetException(
'Gd has been compiled without webp support.'
);
}
if (!function_exists('imagepalettetotruecolor')) {
if (!self::functionsExist([
'imagecreatetruecolor', 'imagealphablending', 'imagecolorallocatealpha',
'imagefilledrectangle', 'imagecopy', 'imagedestroy', 'imagesx', 'imagesy'
])) {
throw new SystemRequirementsNotMetException(
'Gd cannot convert palette color images to RGB. ' .
'Even though it would be possible to convert RGB images to webp with Gd, ' .
'we refuse to do it. A partial working converter causes more trouble than ' .
'a non-working. To make this converter work, you need the imagepalettetotruecolor() ' .
'function to be enabled on your system.'
);
}
}
}
/**
* Check if specific file is convertable with current converter / converter settings.
*
* @throws SystemRequirementsNotMetException if Gd has been compiled without support for image type
*/
public function checkConvertability()
{
$mimeType = $this->getMimeTypeOfSource();
switch ($mimeType) {
case 'image/png':
if (!function_exists('imagecreatefrompng')) {
throw new SystemRequirementsNotMetException(
'Gd has been compiled without PNG support and can therefore not convert this PNG image.'
);
}
break;
case 'image/jpeg':
if (!function_exists('imagecreatefromjpeg')) {
throw new SystemRequirementsNotMetException(
'Gd has been compiled without Jpeg support and can therefore not convert this jpeg image.'
);
}
}
}
/**
* Find out if all functions exists.
*
* @return boolean
*/
private static function functionsExist($functionNamesArr)
{
foreach ($functionNamesArr as $functionName) {
if (!function_exists($functionName)) {
return false;
}
}
return true;
}
/**
* Try to convert image pallette to true color on older systems that does not have imagepalettetotruecolor().
*
* The aim is to function as imagepalettetotruecolor, but for older systems.
* So, if the image is already rgb, nothing will be done, and true will be returned
* PS: Got the workaround here: https://secure.php.net/manual/en/function.imagepalettetotruecolor.php
*
* @param resource|\GdImage $image
* @return boolean TRUE if the convertion was complete, or if the source image already is a true color image,
* otherwise FALSE is returned.
*/
private function makeTrueColorUsingWorkaround(&$image)
{
//return $this->makeTrueColor($image);
/*
if (function_exists('imageistruecolor') && imageistruecolor($image)) {
return true;
}*/
if (self::functionsExist(['imagecreatetruecolor', 'imagealphablending', 'imagecolorallocatealpha',
'imagefilledrectangle', 'imagecopy', 'imagedestroy', 'imagesx', 'imagesy'])) {
$dst = imagecreatetruecolor(imagesx($image), imagesy($image));
if ($dst === false) {
return false;
}
$success = false;
//prevent blending with default black
if (imagealphablending($dst, false) !== false) {
//change the RGB values if you need, but leave alpha at 127
$transparent = imagecolorallocatealpha($dst, 255, 255, 255, 127);
if ($transparent !== false) {
//simpler than flood fill
if (imagefilledrectangle($dst, 0, 0, imagesx($image), imagesy($image), $transparent) !== false) {
//restore default blending
if (imagealphablending($dst, true) !== false) {
if (imagecopy($dst, $image, 0, 0, 0, 0, imagesx($image), imagesy($image)) !== false) {
$success = true;
}
};
}
}
}
if ($success) {
imagedestroy($image);
$image = $dst;
} else {
imagedestroy($dst);
}
return $success;
} else {
// The necessary methods for converting color palette are not avalaible
return false;
}
}
/**
* Try to convert image pallette to true color.
*
* Try to convert image pallette to true color. If imagepalettetotruecolor() exists, that is used (available from
* PHP >= 5.5.0). Otherwise using workaround found on the net.
*
* @param resource|\GdImage $image
* @return boolean TRUE if the convertion was complete, or if the source image already is a true color image,
* otherwise FALSE is returned.
*/
private function makeTrueColor(&$image)
{
if (function_exists('imagepalettetotruecolor')) {
return imagepalettetotruecolor($image);
} else {
$this->logLn(
'imagepalettetotruecolor() is not available on this system - using custom implementation instead'
);
return $this->makeTrueColorUsingWorkaround($image);
}
}
/**
* Create Gd image resource from source
*
* @throws InvalidInputException if mime type is unsupported or could not be detected
* @throws ConversionFailedException if imagecreatefrompng or imagecreatefromjpeg fails
* @return resource|\GdImage $image The created image
*/
private function createImageResource()
{
$mimeType = $this->getMimeTypeOfSource();
switch ($mimeType) {
case 'image/png':
$image = imagecreatefrompng($this->source);
if ($image === false) {
throw new ConversionFailedException(
'Gd failed when trying to load/create image (imagecreatefrompng() failed)'
);
}
return $image;
case 'image/jpeg':
$image = imagecreatefromjpeg($this->source);
if ($image === false) {
throw new ConversionFailedException(
'Gd failed when trying to load/create image (imagecreatefromjpeg() failed)'
);
}
return $image;
}
throw new InvalidInputException('Unsupported mime type');
}
/**
* Try to make image resource true color if it is not already.
*
* @param resource|\GdImage $image The image to work on
* @return boolean|null True if it is now true color. False if it is NOT true color. null, if we cannot tell
*/
protected function tryToMakeTrueColorIfNot(&$image)
{
$whatIsItNow = null;
$mustMakeTrueColor = false;
if (function_exists('imageistruecolor')) {
if (imageistruecolor($image)) {
$this->logLn('image is true color');
return true;
} else {
$this->logLn('image is not true color');
$mustMakeTrueColor = true;
$whatIsItNow = false;
}
} else {
$this->logLn('It can not be determined if image is true color');
$mustMakeTrueColor = true;
}
if ($mustMakeTrueColor) {
$this->logLn('converting color palette to true color');
$success = $this->makeTrueColor($image);
if ($success) {
return true;
} else {
$this->logLn(
'FAILED converting color palette to true color. '
);
}
}
return $whatIsItNow;
}
/**
*
* @param resource|\GdImage $image
* @return boolean true if alpha blending was set successfully, false otherwise
*/
protected function trySettingAlphaBlending($image)
{
if (function_exists('imagealphablending')) {
// TODO: Should we set second parameter to false instead?
// As here: https://www.texelate.co.uk/blog/retaining-png-transparency-with-php-gd
// (PS: I have backed up some local changes - to Gd.php, which includes changing that param
// to false. But I didn't finish up back then and now I forgot, so need to retest before
// changing anything...
if (!imagealphablending($image, true)) {
$this->logLn('Warning: imagealphablending() failed');
return false;
}
} else {
$this->logLn(
'Warning: imagealphablending() is not available on your system.' .
' Converting PNGs with transparency might fail on some systems'
);
return false;
}
if (function_exists('imagesavealpha')) {
if (!imagesavealpha($image, true)) {
$this->logLn('Warning: imagesavealpha() failed');
return false;
}
} else {
$this->logLn(
'Warning: imagesavealpha() is not available on your system. ' .
'Converting PNGs with transparency might fail on some systems'
);
return false;
}
return true;
}
protected function errorHandlerWhileCreatingWebP($errno, $errstr, $errfile, $errline)
{
$this->errorNumberWhileCreating = $errno;
$this->errorMessageWhileCreating = $errstr . ' in ' . $errfile . ', line ' . $errline .
', PHP ' . PHP_VERSION . ' (' . PHP_OS . ')';
//return false;
}
/**
*
* @param resource|\GdImage $image
* @return void
*/
protected function destroyAndRemove($image)
{
imagedestroy($image);
if (file_exists($this->destination)) {
unlink($this->destination);
}
}
/**
*
* @param resource|\GdImage $image
* @return void
*/
protected function tryConverting($image)
{
// Danger zone!
// Using output buffering to generate image.
// In this zone, Do NOT do anything that might produce unwanted output
// Do NOT call $this->logLn
// --------------------------------- (start of danger zone)
$addedZeroPadding = false;
set_error_handler(array($this, "errorHandlerWhileCreatingWebP"));
// This line may trigger log, so we need to do it BEFORE ob_start() !
$q = $this->getCalculatedQuality();
ob_start();
// Adding this try/catch is perhaps not neccessary.
// I'm not certain that the error handler takes care of Throwable errors.
// and - sorry - was to lazy to find out right now. So for now: better safe than sorry. #320
$error = null;
$success = false;
try {
// Beware: This call can throw FATAL on windows (cannot be catched)
// This for example happens on palette images
$success = imagewebp($image, null, $q);
} catch (\Exception $e) {
$error = $e;
} catch (\Throwable $e) {
$error = $e;
}
if (!is_null($error)) {
restore_error_handler();
ob_end_clean();
$this->destroyAndRemove($image);
throw $error;
}
if (!$success) {
$this->destroyAndRemove($image);
ob_end_clean();
restore_error_handler();
throw new ConversionFailedException(
'Failed creating image. Call to imagewebp() failed.',
$this->errorMessageWhileCreating
);
}
// The following hack solves an `imagewebp` bug
// See https://stackoverflow.com/questions/30078090/imagewebp-php-creates-corrupted-webp-files
if (ob_get_length() % 2 == 1) {
echo "\0";
$addedZeroPadding = true;
}
$output = ob_get_clean();
restore_error_handler();
if ($output == '') {
$this->destroyAndRemove($image);
throw new ConversionFailedException(
'Gd failed: imagewebp() returned empty string'
);
}
// --------------------------------- (end of danger zone).
if ($this->errorMessageWhileCreating != '') {
switch ($this->errorNumberWhileCreating) {
case E_WARNING:
$this->logLn('An warning was produced during conversion: ' . $this->errorMessageWhileCreating);
break;
case E_NOTICE:
$this->logLn('An notice was produced during conversion: ' . $this->errorMessageWhileCreating);
break;
default:
$this->destroyAndRemove($image);
throw new ConversionFailedException(
'An error was produced during conversion',
$this->errorMessageWhileCreating
);
//break;
}
}
if ($addedZeroPadding) {
$this->logLn(
'Fixing corrupt webp by adding a zero byte ' .
'(older versions of Gd had a bug, but this hack fixes it)'
);
}
$success = file_put_contents($this->destination, $output);
if (!$success) {
$this->destroyAndRemove($image);
throw new ConversionFailedException(
'Gd failed when trying to save the image. Check file permissions!'
);
}
/*
Previous code was much simpler, but on a system, the hack was not activated (a file with uneven number of bytes
was created). This is puzzeling. And the old code did not provide any insights.
Also, perhaps having two subsequent writes to the same file could perhaps cause a problem.
In the new code, there is only one write.
However, a bad thing about the new code is that the entire webp file is read into memory. This might cause
memory overflow with big files.
Perhaps we should check the filesize of the original and only use the new code when it is smaller than
memory limit set in PHP by a certain factor.
Or perhaps only use the new code on older versions of Gd
https://wordpress.org/support/topic/images-not-seen-on-chrome/#post-11390284
Here is the old code:
$success = imagewebp($image, $this->destination, $this->getCalculatedQuality());
if (!$success) {
throw new ConversionFailedException(
'Gd failed when trying to save the image as webp (call to imagewebp() failed). ' .
'It probably failed writing file. Check file permissions!'
);
}
// This hack solves an `imagewebp` bug
// See https://stackoverflow.com/questions/30078090/imagewebp-php-creates-corrupted-webp-files
if (filesize($this->destination) % 2 == 1) {
file_put_contents($this->destination, "\0", FILE_APPEND);
}
*/
}
// Although this method is public, do not call directly.
// You should rather call the static convert() function, defined in AbstractConverter, which
// takes care of preparing stuff before calling doConvert, and validating after.
protected function doActualConvert()
{
$versionString = gd_info()["GD Version"];
$this->logLn('GD Version: ' . $versionString);
// Btw: Check out processWebp here:
// https://github.com/Intervention/image/blob/master/src/Intervention/Image/Gd/Encoder.php
// Create image resource
$image = $this->createImageResource();
// Try to convert color palette if it is not true color
$isItTrueColorNow = $this->tryToMakeTrueColorIfNot($image);
if ($isItTrueColorNow === false) {
// our tests shows that converting palette fails on all systems,
throw new ConversionFailedException(
'Cannot convert image because it is a palette image and the palette image cannot ' .
'be converted to RGB (which is required). To convert to RGB, we would need ' .
'imagepalettetotruecolor(), which is not available on your system. ' .
'Our workaround does not have the neccasary functions for converting to RGB either.'
);
}
if (is_null($isItTrueColorNow)) {
$isWindows = preg_match('/^win/i', PHP_OS);
$isMacDarwin = preg_match('/^darwin/i', PHP_OS); // actually no problem in PHP 7.4 and 8.0
if ($isWindows || $isMacDarwin) {
throw new ConversionFailedException(
'Cannot convert image because it appears to be a palette image and the palette image ' .
'cannot be converted to RGB, as you do not have imagepalettetotruecolor() enabled. ' .
'Converting palette on ' .
($isWindows ? 'Windows causes FATAL error' : 'Mac causes halt') .
'So we abort now'
);
}
}
if ($this->getMimeTypeOfSource() == 'image/png') {
if (function_exists('version_compare')) {
if (version_compare($versionString, "2.1.1", "<=")) {
$this->logLn(
'BEWARE: Your version of Gd looses the alpha chanel when converting to webp.' .
'You should upgrade Gd, use another converter or stop converting PNGs. ' .
'See: https://github.com/rosell-dk/webp-convert/issues/238'
);
} elseif (version_compare($versionString, "2.2.4", "<=")) {
$this->logLn(
'BEWARE: Older versions of Gd looses the alpha chanel when converting to webp.' .
'We have not tested if transparency fails on your (rather old) version of Gd. ' .
'Please let us know. ' .
'See: https://github.com/rosell-dk/webp-convert/issues/238'
);
}
}
// Try to set alpha blending
$this->trySettingAlphaBlending($image);
}
// Try to convert it to webp
$this->tryConverting($image);
// End of story
imagedestroy($image);
}
}

View File

@@ -0,0 +1,173 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Convert\Converters\ConverterTraits\EncodingAutoTrait;
//use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput\TargetNotFoundException;
/**
* Convert images to webp using Gmagick extension.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class Gmagick extends AbstractConverter
{
use EncodingAutoTrait;
protected function getUnsupportedDefaultOptions()
{
return [
'near-lossless',
'size-in-percentage',
];
}
/**
* Check (general) operationality of Gmagick converter.
*
* Note:
* It may be that Gd has been compiled without jpeg support or png support.
* We do not check for this here, as the converter could still be used for the other.
*
* @throws SystemRequirementsNotMetException if system requirements are not met
*/
public function checkOperationality()
{
if (!extension_loaded('Gmagick')) {
throw new SystemRequirementsNotMetException('Required Gmagick extension is not available.');
}
if (!class_exists('Gmagick')) {
throw new SystemRequirementsNotMetException(
'Gmagick is installed, but not correctly. The class Gmagick is not available'
);
}
$im = new \Gmagick($this->source);
if (!in_array('WEBP', $im->queryformats())) {
throw new SystemRequirementsNotMetException('Gmagick was compiled without WebP support.');
}
}
/**
* Check if specific file is convertable with current converter / converter settings.
*
* @throws SystemRequirementsNotMetException if Gmagick does not support image type
*/
public function checkConvertability()
{
$im = new \Gmagick();
$mimeType = $this->getMimeTypeOfSource();
switch ($mimeType) {
case 'image/png':
if (!in_array('PNG', $im->queryFormats())) {
throw new SystemRequirementsNotMetException(
'Gmagick has been compiled without PNG support and can therefore not convert this PNG image.'
);
}
break;
case 'image/jpeg':
if (!in_array('JPEG', $im->queryFormats())) {
throw new SystemRequirementsNotMetException(
'Gmagick has been compiled without Jpeg support and can therefore not convert this Jpeg image.'
);
}
break;
}
}
// Although this method is public, do not call directly.
// You should rather call the static convert() function, defined in AbstractConverter, which
// takes care of preparing stuff before calling doConvert, and validating after.
protected function doActualConvert()
{
// PS: graphicsmagick options are documented here: (search for "webp:")
// http://www.graphicsmagick.org/GraphicsMagick.html
$options = $this->options;
try {
$im = new \Gmagick($this->source);
} catch (\Exception $e) {
throw new ConversionFailedException(
'Failed creating Gmagick object of file',
'Failed creating Gmagick object of file: "' . $this->source . '" - Gmagick threw an exception.',
$e
);
}
$im->setimageformat('WEBP');
// setimageoption() has not always been there, so check first. #169
if (method_exists($im, 'setimageoption')) {
// Finally cracked setting webp options.
// See #167
// - and https://stackoverflow.com/questions/47294962/how-to-write-lossless-webp-files-with-perlmagick
if (!is_null($options['preset'])) {
if ($options['preset'] != 'none') {
$imageHint = $options['preset'];
switch ($imageHint) {
case 'drawing':
case 'icon':
case 'text':
$imageHint = 'graph';
$this->logLn(
'The "preset" value was mapped to "graph" because gmagick does not support "drawing",' .
' "icon" and "text", but grouped these into one option: "graph".'
);
}
$im->setimageoption('webp', 'image-hint', $imageHint);
}
}
$im->setimageoption('webp', 'method', $options['method']);
$im->setimageoption('webp', 'lossless', $options['encoding'] == 'lossless' ? 'true' : 'false');
$im->setimageoption('webp', 'alpha-quality', $options['alpha-quality']);
if ($options['auto-filter'] === true) {
$im->setimageoption('webp', 'auto-filter', 'true');
}
if ($options['sharp-yuv'] === true) {
$im->setimageoption('webp', 'use-sharp-yuv', 'true');
}
}
/*
low-memory seems not to be supported:
$im->setimageoption('webp', 'low-memory', $options['low-memory'] ? true : false);
*/
if ($options['metadata'] == 'none') {
// Strip metadata and profiles
$im->stripImage();
}
// Ps: Imagick automatically uses same quality as source, when no quality is set
// This feature is however not present in Gmagick
// TODO: However, it might be possible after all - see #91
$im->setcompressionquality($this->getCalculatedQuality());
// We call getImageBlob().
// That method is undocumented, but it is there!
// - just like it is in imagick, as pointed out here:
// https://www.php.net/manual/ru/gmagick.readimageblob.php
/** @scrutinizer ignore-call */
$imageBlob = $im->getImageBlob();
$success = @file_put_contents($this->destination, $imageBlob);
if (!$success) {
throw new ConversionFailedException('Failed writing file');
}
}
}

View File

@@ -0,0 +1,28 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
/**
* Non-functional converter, just here to tell you that it has been renamed.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class GmagickBinary extends AbstractConverter
{
public function checkOperationality()
{
throw new ConversionFailedException(
'This converter has changed ID from "gmagickbinary" to "graphicsmagick". You need to change!'
);
}
protected function doActualConvert()
{
$this->checkOperationality();
}
}

View File

@@ -0,0 +1,220 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Converters\ConverterTraits\EncodingAutoTrait;
use WebPConvert\Convert\Converters\ConverterTraits\ExecTrait;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Options\OptionFactory;
use ExecWithFallback\ExecWithFallback;
//use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput\TargetNotFoundException;
/**
* Convert images to webp by calling gmagick binary (gm).
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class GraphicsMagick extends AbstractConverter
{
use ExecTrait;
use EncodingAutoTrait;
protected function getUnsupportedDefaultOptions()
{
return [
'near-lossless',
'size-in-percentage',
];
}
/**
* Get the options unique for this converter
*
* @return array Array of options
*/
public function getUniqueOptions($imageType)
{
return OptionFactory::createOptions([
self::niceOption()
]);
}
private function getPath()
{
if (defined('WEBPCONVERT_GRAPHICSMAGICK_PATH')) {
return constant('WEBPCONVERT_GRAPHICSMAGICK_PATH');
}
if (!empty(getenv('WEBPCONVERT_GRAPHICSMAGICK_PATH'))) {
return getenv('WEBPCONVERT_GRAPHICSMAGICK_PATH');
}
return 'gm';
}
public function isInstalled()
{
ExecWithFallback::exec($this->getPath() . ' -version 2>&1', $output, $returnCode);
return ($returnCode == 0);
}
public function getVersion()
{
ExecWithFallback::exec($this->getPath() . ' -version 2>&1', $output, $returnCode);
if (($returnCode == 0) && isset($output[0])) {
return preg_replace('#http.*#', '', $output[0]);
}
return 'unknown';
}
// Check if webp delegate is installed
public function isWebPDelegateInstalled()
{
ExecWithFallback::exec($this->getPath() . ' -version 2>&1', $output, $returnCode);
foreach ($output as $line) {
if (preg_match('#WebP.*yes#i', $line)) {
return true;
}
}
return false;
}
/**
* Check (general) operationality of imagack converter executable
*
* @throws SystemRequirementsNotMetException if system requirements are not met
*/
public function checkOperationality()
{
$this->checkOperationalityExecTrait();
if (!$this->isInstalled()) {
throw new SystemRequirementsNotMetException('gmagick is not installed');
}
if (!$this->isWebPDelegateInstalled()) {
throw new SystemRequirementsNotMetException('webp delegate missing');
}
}
/**
* Build command line options
*
* @return string
*/
private function createCommandLineOptions()
{
// For available webp options, check out:
// https://github.com/kstep/graphicsmagick/blob/master/coders/webp.c
$commandArguments = [];
/*
if ($this->isQualityDetectionRequiredButFailing()) {
// Unlike imagick binary, it seems gmagick binary uses a fixed
// quality (75) when quality is omitted
// So we cannot simply omit in order to get same quality as source.
// But perhaps there is another way?
// Check out #91 - it is perhaps as easy as this: "-define jpeg:preserve-settings"
}
*/
$commandArguments[] = '-quality ' . escapeshellarg($this->getCalculatedQuality());
$options = $this->options;
// preset
if (!is_null($options['preset'])) {
if ($options['preset'] != 'none') {
$imageHint = $options['preset'];
switch ($imageHint) {
case 'drawing':
case 'icon':
case 'text':
$imageHint = 'graph';
$this->logLn(
'Note: the preset was mapped to "graph" because graphicsmagick does not support ' .
'"drawing", "icon" and "text", but grouped these into one option: "graph".'
);
}
$commandArguments[] = '-define webp:image-hint=' . escapeshellarg($imageHint);
}
}
// encoding
if ($options['encoding'] == 'lossless') {
// Btw:
// I am not sure if we should set "quality" for lossless.
// Quality should not apply to lossless, but my tests shows that it does in some way for gmagick
// setting it low, you get bad visual quality and small filesize. Setting it high, you get the opposite
// Some claim it is a bad idea to set quality, but I'm not so sure.
// https://stackoverflow.com/questions/4228027/
// First, I do not just get bigger images when setting quality, as toc777 does.
// Secondly, the answer is very old and that bad behaviour is probably fixed by now.
$commandArguments[] = '-define webp:lossless=true';
} else {
$commandArguments[] = '-define webp:lossless=false';
}
if ($options['auto-filter'] === true) {
$commandArguments[] = '-define webp:auto-filter=true';
}
if ($options['alpha-quality'] !== 100) {
$commandArguments[] = '-define webp:alpha-quality=' . strval($options['alpha-quality']);
}
if ($options['low-memory']) {
$commandArguments[] = '-define webp:low-memory=true';
}
if ($options['sharp-yuv'] === true) {
$commandArguments[] = '-define webp:use-sharp-yuv=true';
}
if ($options['metadata'] == 'none') {
$commandArguments[] = '-strip';
}
$commandArguments[] = '-define webp:method=' . $options['method'];
$commandArguments[] = escapeshellarg($this->source);
$commandArguments[] = escapeshellarg('webp:' . $this->destination);
return implode(' ', $commandArguments);
}
protected function doActualConvert()
{
//$this->logLn('Using quality:' . $this->getCalculatedQuality());
$this->logLn('Version: ' . $this->getVersion());
$command = $this->getPath() . ' convert ' . $this->createCommandLineOptions() . ' 2>&1';
$useNice = ($this->options['use-nice'] && $this->checkNiceSupport());
if ($useNice) {
$command = 'nice ' . $command;
}
$this->logLn('Executing command: ' . $command);
ExecWithFallback::exec($command, $output, $returnCode);
$this->logExecOutput($output);
if ($returnCode == 0) {
$this->logLn('success');
} else {
$this->logLn('return code: ' . $returnCode);
}
if ($returnCode == 127) {
throw new SystemRequirementsNotMetException('gmagick is not installed');
}
if ($returnCode != 0) {
$this->logLn('command:' . $command);
$this->logLn('return code:' . $returnCode);
$this->logLn('output:' . print_r(implode("\n", $output), true));
throw new SystemRequirementsNotMetException('The exec() call failed');
}
}
}

View File

@@ -0,0 +1,274 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Converters\ConverterTraits\ExecTrait;
use WebPConvert\Convert\Converters\ConverterTraits\EncodingAutoTrait;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Helpers\BinaryDiscovery;
use WebPConvert\Options\OptionFactory;
use ExecWithFallback\ExecWithFallback;
//use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput\TargetNotFoundException;
/**
* Convert images to webp by calling imagemagick binary.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class ImageMagick extends AbstractConverter
{
use ExecTrait;
use EncodingAutoTrait;
protected function getUnsupportedDefaultOptions()
{
return [
'size-in-percentage',
];
}
/**
* Get the options unique for this converter
*
* @return array Array of options
*/
public function getUniqueOptions($imageType)
{
return OptionFactory::createOptions([
self::niceOption(),
['try-common-system-paths', 'boolean', [
'title' => 'Try locating ImageMagick in common system paths',
'description' =>
'If set, the converter will look for a ImageMagick binaries residing in common system locations ' .
'such as "/usr/bin/convert". ' .
'If such exist, it is assumed that they are valid ImageMagick binaries. ',
'default' => true,
'ui' => [
'component' => 'checkbox',
'advanced' => true
]
]],
]);
}
// To futher improve this converter, I could check out:
// https://github.com/Orbitale/ImageMagickPHP
private function getPath()
{
if (defined('WEBPCONVERT_IMAGEMAGICK_PATH')) {
return constant('WEBPCONVERT_IMAGEMAGICK_PATH');
}
if (!empty(getenv('WEBPCONVERT_IMAGEMAGICK_PATH'))) {
return getenv('WEBPCONVERT_IMAGEMAGICK_PATH');
}
if ($this->options['try-common-system-paths']) {
$binaries = BinaryDiscovery::discoverInCommonSystemPaths('convert');
if (!empty($binaries)) {
return $binaries[0];
}
}
return 'convert';
}
private function getVersion()
{
ExecWithFallback::exec($this->getPath() . ' -version 2>&1', $output, $returnCode);
if (($returnCode == 0) && isset($output[0])) {
return $output[0];
} else {
return 'unknown';
}
}
public function isInstalled()
{
ExecWithFallback::exec($this->getPath() . ' -version 2>&1', $output, $returnCode);
return ($returnCode == 0);
}
// Check if webp delegate is installed
public function isWebPDelegateInstalled()
{
ExecWithFallback::exec($this->getPath() . ' -list delegate 2>&1', $output, $returnCode);
foreach ($output as $line) {
if (preg_match('#webp\\s*=#i', $line)) {
return true;
}
}
// try other command
ExecWithFallback::exec($this->getPath() . ' -list configure 2>&1', $output, $returnCode);
foreach ($output as $line) {
if (preg_match('#DELEGATE.*webp#i', $line)) {
return true;
}
}
return false;
// PS, convert -version does not output delegates on travis, so it is not reliable
}
/**
* Check (general) operationality of imagack converter executable
*
* @throws SystemRequirementsNotMetException if system requirements are not met
*/
public function checkOperationality()
{
$this->checkOperationalityExecTrait();
if (!$this->isInstalled()) {
throw new SystemRequirementsNotMetException(
'imagemagick is not installed (cannot execute: "' . $this->getPath() . '")'
);
}
if (!$this->isWebPDelegateInstalled()) {
throw new SystemRequirementsNotMetException('webp delegate missing');
}
}
/**
* Build command line options
*
* @param string $versionNumber. Ie "6.9.10-23"
* @return string
*/
private function createCommandLineOptions($versionNumber = 'unknown')
{
// Available webp options for imagemagick are documented here:
// - https://imagemagick.org/script/webp.php
// - https://github.com/ImageMagick/ImageMagick/blob/main/coders/webp.c
// We should perhaps implement low-memory. Its already in cwebp, it
// could perhaps be promoted to a general option
$commandArguments = [];
if ($this->isQualityDetectionRequiredButFailing()) {
// quality:auto was specified, but could not be determined.
// we cannot apply the max-quality logic, but we can provide auto quality
// simply by not specifying the quality option.
} else {
$commandArguments[] = '-quality ' . escapeshellarg($this->getCalculatedQuality());
}
$options = $this->options;
if (!is_null($options['preset'])) {
// "image-hint" is at least available from 6.9.4-0 (I can't see further back)
if ($options['preset'] != 'none') {
$imageHint = $options['preset'];
switch ($imageHint) {
case 'drawing':
case 'icon':
case 'text':
$imageHint = 'graph';
$this->logLn(
'The "preset" value was mapped to "graph" because imagemagick does not support "drawing",' .
' "icon" and "text", but grouped these into one option: "graph".'
);
}
$commandArguments[] = '-define webp:image-hint=' . escapeshellarg($imageHint);
}
}
if ($options['encoding'] == 'lossless') {
// lossless is at least available from 6.9.4-0 (I can't see further back)
$commandArguments[] = '-define webp:lossless=true';
}
if ($options['low-memory']) {
// low-memory is at least available from 6.9.4-0 (I can't see further back)
$commandArguments[] = '-define webp:low-memory=true';
}
if ($options['auto-filter'] === true) {
// auto-filter is at least available from 6.9.4-0 (I can't see further back)
$commandArguments[] = '-define webp:auto-filter=true';
}
if ($options['metadata'] == 'none') {
$commandArguments[] = '-strip';
}
if ($options['alpha-quality'] !== 100) {
// alpha-quality is at least available from 6.9.4-0 (I can't see further back)
$commandArguments[] = '-define webp:alpha-quality=' . strval($options['alpha-quality']);
}
if ($options['sharp-yuv'] === true) {
if (version_compare($versionNumber, '7.0.8-26', '>=')) {
$commandArguments[] = '-define webp:use-sharp-yuv=true';
} else {
$this->logLn(
'Note: "sharp-yuv" option is not supported in your version of ImageMagick. ' .
'ImageMagic >= 7.0.8-26 is required',
'italic'
);
}
}
if ($options['near-lossless'] != 100) {
if (version_compare($versionNumber, '7.0.10-54', '>=')) { // #299
$commandArguments[] = '-define webp:near-lossless=' . escapeshellarg($options['near-lossless']);
} else {
$this->logLn(
'Note: "near-lossless" option is not supported in your version of ImageMagick. ' .
'ImageMagic >= 7.0.10-54 is required',
'italic'
);
}
}
// "method" is at least available from 6.9.4-0 (I can't see further back)
$commandArguments[] = '-define webp:method=' . $options['method'];
$commandArguments[] = escapeshellarg($this->source);
$commandArguments[] = escapeshellarg('webp:' . $this->destination);
return implode(' ', $commandArguments);
}
protected function doActualConvert()
{
$version = $this->getVersion();
$this->logLn($version);
preg_match('#\d+\.\d+\.\d+[\d\.\-]+#', $version, $matches);
$versionNumber = (isset($matches[0]) ? $matches[0] : 'unknown');
$this->logLn('Extracted version number: ' . $versionNumber);
$command = $this->getPath() . ' ' . $this->createCommandLineOptions($versionNumber) . ' 2>&1';
$useNice = ($this->options['use-nice'] && $this->checkNiceSupport());
if ($useNice) {
$command = 'nice ' . $command;
}
$this->logLn('Executing command: ' . $command);
ExecWithFallback::exec($command, $output, $returnCode);
$this->logExecOutput($output);
if ($returnCode == 0) {
$this->logLn('success');
} else {
$this->logLn('return code: ' . $returnCode);
}
if ($returnCode == 127) {
throw new SystemRequirementsNotMetException('imagemagick is not installed');
}
if ($returnCode != 0) {
throw new SystemRequirementsNotMetException('The exec call failed');
}
}
}

View File

@@ -0,0 +1,229 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Convert\Exceptions\ConversionFailed\FileSystemProblems\CreateDestinationFileException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Convert\Converters\ConverterTraits\EncodingAutoTrait;
//use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput\TargetNotFoundException;
/**
* Convert images to webp using Imagick extension.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class Imagick extends AbstractConverter
{
use EncodingAutoTrait;
protected function getUnsupportedDefaultOptions()
{
return [
'size-in-percentage',
];
}
/**
* Check operationality of Imagick converter.
*
* Note:
* It may be that Gd has been compiled without jpeg support or png support.
* We do not check for this here, as the converter could still be used for the other.
*
* @throws SystemRequirementsNotMetException if system requirements are not met
* @return void
*/
public function checkOperationality()
{
if (!extension_loaded('imagick')) {
throw new SystemRequirementsNotMetException('Required iMagick extension is not available.');
}
if (!class_exists('\\Imagick')) {
throw new SystemRequirementsNotMetException(
'iMagick is installed, but not correctly. The class Imagick is not available'
);
}
$im = new \Imagick();
if (!in_array('WEBP', $im->queryFormats('WEBP'))) {
throw new SystemRequirementsNotMetException('iMagick was compiled without WebP support.');
}
}
/**
* Check if specific file is convertable with current converter / converter settings.
*
* @throws SystemRequirementsNotMetException if Imagick does not support image type
*/
public function checkConvertability()
{
$im = new \Imagick();
$mimeType = $this->getMimeTypeOfSource();
switch ($mimeType) {
case 'image/png':
if (!in_array('PNG', $im->queryFormats('PNG'))) {
throw new SystemRequirementsNotMetException(
'Imagick has been compiled without PNG support and can therefore not convert this PNG image.'
);
}
break;
case 'image/jpeg':
if (!in_array('JPEG', $im->queryFormats('JPEG'))) {
throw new SystemRequirementsNotMetException(
'Imagick has been compiled without Jpeg support and can therefore not convert this Jpeg image.'
);
}
break;
}
}
/**
*
* It may also throw an ImagickException if imagick throws an exception
* @throws CreateDestinationFileException if imageblob could not be saved to file
*/
protected function doActualConvert()
{
/*
* More about iMagick's WebP options:
* - Inspect source code: https://github.com/ImageMagick/ImageMagick/blob/master/coders/webp.c#L559
* (search for "webp:")
* - http://www.imagemagick.org/script/webp.php
* - https://developers.google.com/speed/webp/docs/cwebp
* - https://stackoverflow.com/questions/37711492/imagemagick-specific-webp-calls-in-php
*/
$options = $this->options;
// This might throw - we let it!
$im = new \Imagick($this->source);
//$im = new \Imagick();
//$im->pingImage($this->source);
//$im->readImage($this->source);
$version = \Imagick::getVersion();
$this->logLn('ImageMagic API version (full): ' . $version['versionString']);
preg_match('#\d+\.\d+\.\d+[\d\.\-]+#', $version['versionString'], $matches);
$versionNumber = (isset($matches[0]) ? $matches[0] : 'unknown');
$this->logLn('ImageMagic API version (just the number): ' . $versionNumber);
// Note: good enough for info, but not entirely reliable - see #304
$extVersion = (defined('\Imagick::IMAGICK_EXTVER') ? \Imagick::IMAGICK_EXTVER : phpversion('imagick'));
$this->logLn('Imagic extension version: ' . $extVersion);
$im->setImageFormat('WEBP');
if (!is_null($options['preset'])) {
if ($options['preset'] != 'none') {
$imageHint = $options['preset'];
switch ($imageHint) {
case 'drawing':
case 'icon':
case 'text':
$imageHint = 'graph';
$this->logLn(
'The "preset" value was mapped to "graph" because imagick does not support "drawing",' .
' "icon" and "text", but grouped these into one option: "graph".'
);
}
$im->setOption('webp:image-hint', $imageHint);
}
}
$im->setOption('webp:method', $options['method']);
$im->setOption('webp:lossless', $options['encoding'] == 'lossless' ? 'true' : 'false');
$im->setOption('webp:low-memory', $options['low-memory'] ? 'true' : 'false');
$im->setOption('webp:alpha-quality', $options['alpha-quality']);
if ($options['near-lossless'] != 100) {
if (version_compare($versionNumber, '7.0.10-54', '>=')) {
$im->setOption('webp:near-lossless', $options['near-lossless']);
} else {
$this->logLn(
'Note: near-lossless is not supported in your version of ImageMagick. ' .
'ImageMagic >= 7.0.10-54 is required',
'italic'
);
}
}
if ($options['auto-filter'] === true) {
$im->setOption('webp:auto-filter', 'true');
}
if ($options['sharp-yuv'] === true) {
if (version_compare($versionNumber, '7.0.8-26', '>=')) {
$im->setOption('webp:use-sharp-yuv', 'true');
} else {
$this->logLn(
'Note: "sharp-yuv" option is not supported in your version of ImageMagick. ' .
'ImageMagic >= 7.0.8-26 is required',
'italic'
);
}
}
if ($options['metadata'] == 'none') {
// To strip metadata, we need to use the stripImage() method. However, that method does not only remove
// metadata, but color profiles as well. We want to keep the color profiles, so we grab it now to be able
// to restore it. (Thanks, Max Eremin: https://www.php.net/manual/en/imagick.stripimage.php#120380)
// Grab color profile (to be able to restore them)
$profiles = $im->getImageProfiles("icc", true);
// Strip metadata (and color profiles)
$im->stripImage();
// Restore color profiles
if (!empty($profiles)) {
$im->profileImage("icc", $profiles['icc']);
}
}
if ($this->isQualityDetectionRequiredButFailing()) {
// Luckily imagick is a big boy, and automatically converts with same quality as
// source, when the quality isn't set.
// So we simply do not set quality.
// This actually kills the max-quality functionality. But I deem that this is more important
// because setting image quality to something higher than source generates bigger files,
// but gets you no extra quality. When failing to limit quality, you at least get something
// out of it
$this->logLn('Converting without setting quality in order to achieve auto quality');
} else {
$im->setImageCompressionQuality($this->getCalculatedQuality());
}
// https://stackoverflow.com/questions/29171248/php-imagick-jpeg-optimization
// setImageFormat
// TODO: Read up on
// https://www.smashingmagazine.com/2015/06/efficient-image-resizing-with-imagemagick/
// https://github.com/nwtn/php-respimg
// TODO:
// Should we set alpha channel for PNG's like suggested here:
// https://gauntface.com/blog/2014/09/02/webp-support-with-imagemagick-and-php ??
// It seems that alpha channel works without... (at least I see completely transparerent pixels)
// We used to use writeImageFile() method. But we now use getImageBlob(). See issue #43
// This might throw - we let it!
$imageBlob = $im->getImageBlob();
$success = file_put_contents($this->destination, $imageBlob);
if (!$success) {
throw new CreateDestinationFileException('Failed writing file');
}
// Btw: check out processWebp() method here:
// https://github.com/Intervention/image/blob/master/src/Intervention/Image/Imagick/Encoder.php
}
}

View File

@@ -0,0 +1,28 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
/**
* Non-functional converter, just here to tell you that it has been renamed.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class ImagickBinary extends AbstractConverter
{
public function checkOperationality()
{
throw new ConversionFailedException(
'This converter has changed ID from "imagickbinary" to "imagemagick". You need to change!'
);
}
protected function doActualConvert()
{
$this->checkOperationality();
}
}

View File

@@ -0,0 +1,287 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\ConverterFactory;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperationalException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConversionSkippedException;
use WebPConvert\Options\BooleanOption;
use WebPConvert\Options\ArrayOption;
use WebPConvert\Options\GhostOption;
use WebPConvert\Options\SensitiveArrayOption;
use WebPConvert\Options\OptionFactory;
//use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput\TargetNotFoundException;
/**
* Convert images to webp by trying a stack of converters until success.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class Stack extends AbstractConverter
{
protected function getUnsupportedDefaultOptions()
{
return [
'alpha-quality',
'auto-filter',
'encoding',
'low-memory',
'metadata',
'method',
'near-lossless',
'preset',
'sharp-yuv',
'size-in-percentage',
'skip',
'default-quality',
'quality',
'max-quality',
];
}
public function getUniqueOptions($imageType)
{
return OptionFactory::createOptions([
['converters', 'array', [
'title' => 'Converters',
'description' => 'Converters to try, ordered by priority.',
'default' => self::getAvailableConverters(),
'sensitive' => true,
'ui' => [
'component' => 'multi-select',
'options' => self::getAvailableConverters(),
'advanced' => true
]
]],
['converter-options', 'array', [
'title' => 'Converter options',
'description' =>
'Extra options for specific converters.',
'default' => [],
'sensitive' => true,
'ui' => null
]],
['preferred-converters', 'array', [
'title' => 'Preferred converters',
'description' =>
'With this option you can move specified converters to the top of the stack. ' .
'The converters are specified by id.',
'default' => [],
'ui' => null
]],
['extra-converters', 'array', [
'title' => 'Extra converters',
'description' =>
'Add extra converters to the bottom of the stack',
'default' => [],
'sensitive' => true,
'ui' => null
]],
['shuffle', 'boolean', [
'title' => 'Shuffle',
'description' =>
'Shuffles the converter order on each conversion. ' .
'Can for example be used to spread out requests on multiple cloud converters',
'default' => false,
'ui' => [
'component' => 'checkbox',
'advanced' => true
]
]],
]);
/*
return [
new SensitiveArrayOption('converters', self::getAvailableConverters()),
new SensitiveArrayOption('converter-options', []),
new BooleanOption('shuffle', false),
new ArrayOption('preferred-converters', []),
new SensitiveArrayOption('extra-converters', [])
];*/
}
/**
* Get available converters (ids) - ordered by awesomeness.
*
* @return array An array of ids of converters that comes with this library
*/
public static function getAvailableConverters()
{
return [
'cwebp', 'vips', 'imagick', 'gmagick', 'imagemagick', 'graphicsmagick', 'wpc', 'ffmpeg', 'ewww', 'gd'
];
}
/**
* Check (general) operationality of imagack converter executable
*
* @throws SystemRequirementsNotMetException if system requirements are not met
*/
public function checkOperationality()
{
if (count($this->options['converters']) == 0) {
throw new ConverterNotOperationalException(
'Converter stack is empty! - no converters to try, no conversion can be made!'
);
}
// TODO: We should test if all converters are found in order to detect problems early
//$this->logLn('Stack converter ignited');
}
protected function doActualConvert()
{
$options = $this->options;
$beginTimeStack = microtime(true);
$anyRuntimeErrors = false;
$converters = $options['converters'];
if (count($options['extra-converters']) > 0) {
$converters = array_merge($converters, $options['extra-converters']);
/*foreach ($options['extra-converters'] as $extra) {
$converters[] = $extra;
}*/
}
// preferred-converters
if (count($options['preferred-converters']) > 0) {
foreach (array_reverse($options['preferred-converters']) as $prioritizedConverter) {
foreach ($converters as $i => $converter) {
if (is_array($converter)) {
$converterId = $converter['converter'];
} else {
$converterId = $converter;
}
if ($converterId == $prioritizedConverter) {
unset($converters[$i]);
array_unshift($converters, $converter);
break;
}
}
}
// perhaps write the order to the log? (without options) - but this requires some effort
}
// shuffle
if ($options['shuffle']) {
shuffle($converters);
}
//$this->logLn(print_r($converters));
//$options['converters'] = $converters;
//$defaultConverterOptions = $options;
$defaultConverterOptions = [];
foreach ($this->options2->getOptionsMap() as $id => $option) {
// Right here, there used to be a check that ensured that unknown options was not passed down to the
// converters (" && !($option instanceof GhostOption)"). But well, as the Stack doesn't know about
// converter specific options, such as "try-cwebp", these was not passed down (see #259)
// I'm not sure why the check was made in the first place, but it does not seem neccessary, as the
// converters simply ignore unknown options. So the check has now been removed.
if ($option->isValueExplicitlySet()) {
$defaultConverterOptions[$id] = $option->getValue();
}
}
//unset($defaultConverterOptions['converters']);
//unset($defaultConverterOptions['converter-options']);
$defaultConverterOptions['_skip_input_check'] = true;
$defaultConverterOptions['_suppress_success_message'] = true;
unset($defaultConverterOptions['converters']);
unset($defaultConverterOptions['extra-converters']);
unset($defaultConverterOptions['converter-options']);
unset($defaultConverterOptions['preferred-converters']);
unset($defaultConverterOptions['shuffle']);
// $this->logLn('converters: ' . print_r($converters, true));
//return;
foreach ($converters as $converter) {
if (is_array($converter)) {
$converterId = $converter['converter'];
$converterOptions = isset($converter['options']) ? $converter['options'] : [];
} else {
$converterId = $converter;
$converterOptions = [];
if (isset($options['converter-options'][$converterId])) {
// Note: right now, converter-options are not meant to be used,
// when you have several converters of the same type
$converterOptions = $options['converter-options'][$converterId];
}
}
$converterOptions = array_merge($defaultConverterOptions, $converterOptions);
/*
if ($converterId != 'stack') {
//unset($converterOptions['converters']);
//unset($converterOptions['converter-options']);
} else {
//$converterOptions['converter-options'] =
$this->logLn('STACK');
$this->logLn('converterOptions: ' . print_r($converterOptions, true));
}*/
$beginTime = microtime(true);
$this->ln();
$this->logLn($converterId . ' converter ignited', 'bold');
$converter = ConverterFactory::makeConverter(
$converterId,
$this->source,
$this->destination,
$converterOptions,
$this->logger
);
try {
$converter->doConvert();
//self::runConverterWithTiming($converterId, $source, $destination, $converterOptions, false, $logger);
$this->logLn($converterId . ' succeeded :)');
//throw new ConverterNotOperationalException('...');
return;
} catch (ConverterNotOperationalException $e) {
$this->logLn($e->getMessage());
} catch (ConversionSkippedException $e) {
$this->logLn($e->getMessage());
} catch (ConversionFailedException $e) {
$this->logLn($e->getMessage(), 'italic');
$prev = $e->getPrevious();
if (!is_null($prev)) {
$this->logLn($prev->getMessage(), 'italic');
$this->logLn(' in ' . $prev->getFile() . ', line ' . $prev->getLine(), 'italic');
$this->ln();
}
//$this->logLn($e->getTraceAsString());
$anyRuntimeErrors = true;
}
$this->logLn($converterId . ' failed in ' . round((microtime(true) - $beginTime) * 1000) . ' ms');
}
$this->ln();
$this->logLn('Stack failed in ' . round((microtime(true) - $beginTimeStack) * 1000) . ' ms');
// Hm, Scrutinizer complains that $anyRuntimeErrors is always false. But that is not true!
if ($anyRuntimeErrors) {
// At least one converter failed
throw new ConversionFailedException(
'None of the converters in the stack could convert the image.'
);
} else {
// All converters threw a SystemRequirementsNotMetException
throw new ConverterNotOperationalException('None of the converters in the stack are operational');
}
}
}

View File

@@ -0,0 +1,306 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Converters\ConverterTraits\EncodingAutoTrait;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Options\BooleanOption;
use WebPConvert\Options\IntegerOption;
//require '/home/rosell/.composer/vendor/autoload.php';
/**
* Convert images to webp using Vips extension.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class Vips extends AbstractConverter
{
use EncodingAutoTrait;
protected function getUnsupportedDefaultOptions()
{
return [
'auto-filter',
'size-in-percentage',
];
}
/**
* Get the options unique for this converter
*
* @return array Array of options
*/
public function getUniqueOptions($imageType)
{
$ssOption = new BooleanOption('smart-subsample', false);
$ssOption->markDeprecated();
return [
$ssOption
];
}
/**
* Check operationality of Vips converter.
*
* @throws SystemRequirementsNotMetException if system requirements are not met
*/
public function checkOperationality()
{
if (!extension_loaded('vips')) {
throw new SystemRequirementsNotMetException('Required Vips extension is not available.');
}
if (!function_exists('vips_image_new_from_file')) {
throw new SystemRequirementsNotMetException(
'Vips extension seems to be installed, however something is not right: ' .
'the function "vips_image_new_from_file" is not available.'
);
}
if (!function_exists('vips_call')) {
throw new SystemRequirementsNotMetException(
'Vips extension seems to be installed, however something is not right: ' .
'the function "vips_call" is not available.'
);
}
if (!function_exists('vips_error_buffer')) {
throw new SystemRequirementsNotMetException(
'Vips extension seems to be installed, however something is not right: ' .
'the function "vips_error_buffer" is not available.'
);
}
/** @scrutinizer ignore-call */ vips_error_buffer(); // clear error buffer
$result = /** @scrutinizer ignore-call */ vips_call('webpsave', null);
if ($result == -1) {
$message = vips_error_buffer();
if (strpos($message, 'VipsOperation: class "webpsave" not found') === 0) {
throw new SystemRequirementsNotMetException(
'Vips has not been compiled with webp support.'
);
}
}
}
/**
* Check if specific file is convertable with current converter / converter settings.
*
* @throws SystemRequirementsNotMetException if Vips does not support image type
*/
public function checkConvertability()
{
// It seems that png and jpeg are always supported by Vips
// - so nothing needs to be done here
if (function_exists('vips_version')) {
$this->logLn('vipslib version: ' . vips_version());
}
$this->logLn('vips extension version: ' . phpversion('vips'));
}
/**
* Create vips image resource from source file
*
* @throws ConversionFailedException if image resource cannot be created
* @return resource vips image resource
*/
private function createImageResource()
{
// We are currently using vips_image_new_from_file(), but we could consider
// calling vips_jpegload / vips_pngload instead
$result = /** @scrutinizer ignore-call */ vips_image_new_from_file($this->source, []);
if ($result === -1) {
/*throw new ConversionFailedException(
'Failed creating new vips image from file: ' . $this->source
);*/
$message = /** @scrutinizer ignore-call */ vips_error_buffer();
throw new ConversionFailedException($message);
}
if (!is_array($result)) {
throw new ConversionFailedException(
'vips_image_new_from_file did not return an array, which we expected'
);
}
if (count($result) != 1) {
throw new ConversionFailedException(
'vips_image_new_from_file did not return an array of length 1 as we expected ' .
'- length was: ' . count($result)
);
}
$im = array_shift($result);
return $im;
}
/**
* Create parameters for webpsave
*
* @return array the parameters as an array
*/
private function createParamsForVipsWebPSave()
{
// webpsave options are described here:
// https://libvips.github.io/libvips/API/current/VipsForeignSave.html#vips-webpsave
// near_lossless option is described here: https://github.com/libvips/libvips/pull/430
// NOTE: When a new option becomes available, we MUST remember to add
// it to the array of possibly unsupported options in webpsave() !
$options = [
"Q" => $this->getCalculatedQuality(),
'lossless' => ($this->options['encoding'] == 'lossless'),
'strip' => $this->options['metadata'] == 'none',
];
// Only set the following options if they differ from the default of vipslib
// This ensures we do not get warning if that property isn't supported
if ($this->options['smart-subsample'] !== false) {
// PS: The smart-subsample option is now deprecated, as it turned out
// it was corresponding to the "sharp-yuv" option (see #280)
$options['smart_subsample'] = $this->options['smart-subsample'];
$this->logLn(
'*Note: the "smart-subsample" option is now deprecated. It turned out it corresponded to ' .
'the general option "sharp-yuv". You should use "sharp-yuv" instead.*'
);
}
if ($this->options['sharp-yuv'] !== false) {
$options['smart_subsample'] = $this->options['sharp-yuv'];
}
if ($this->options['alpha-quality'] !== 100) {
$options['alpha_q'] = $this->options['alpha-quality'];
}
if (!is_null($this->options['preset']) && ($this->options['preset'] != 'none')) {
// preset. 0:default, 1:picture, 2:photo, 3:drawing, 4:icon, 5:text, 6:last
$options['preset'] = array_search(
$this->options['preset'],
['default', 'picture', 'photo', 'drawing', 'icon', 'text']
);
}
if ($this->options['near-lossless'] !== 100) {
if ($this->options['encoding'] == 'lossless') {
// We only let near_lossless have effect when encoding is set to lossless
// otherwise encoding=auto would not work as expected
// Available in https://github.com/libvips/libvips/pull/430, merged 1 may 2016
// seems it corresponds to release 8.4.2
$options['near_lossless'] = true;
// In Vips, the near-lossless value is controlled by Q.
// this differs from how it is done in cwebp, where it is an integer.
// We have chosen same option syntax as cwebp
$options['Q'] = $this->options['near-lossless'];
}
}
if ($this->options['method'] !== 4) {
$options['reduction_effort'] = $this->options['method'];
}
return $options;
}
/**
* Convert with vips extension.
*
* Tries to create image resource and save it as webp using the calculated options.
* Vips fails when a parameter is not supported, but we detect this and unset that parameter and try again
* (recursively call itself until there is no more of these kind of errors).
*
* @param resource $im A vips image resource to save
* @throws ConversionFailedException if conversion fails.
*/
private function webpsave($im, $options)
{
/** @scrutinizer ignore-call */ vips_error_buffer(); // clear error buffer
$result = /** @scrutinizer ignore-call */ vips_call('webpsave', $im, $this->destination, $options);
//trigger_error('test-warning', E_USER_WARNING);
if ($result === -1) {
$message = /** @scrutinizer ignore-call */ vips_error_buffer();
$nameOfPropertyNotFound = '';
if (preg_match("#no property named .(.*).#", $message, $matches)) {
$nameOfPropertyNotFound = $matches[1];
} elseif (preg_match("#(.*)\\sunsupported$#", $message, $matches)) {
// Actually, I am not quite sure if this ever happens.
// I got a "near_lossless unsupported" error message in a build, but perhaps it rather a warning
if (in_array($matches[1], [
'lossless',
'alpha_q',
'near_lossless',
'smart_subsample',
'reduction_effort',
'preset'
])) {
$nameOfPropertyNotFound = $matches[1];
}
}
if ($nameOfPropertyNotFound != '') {
$msg = 'Note: Your version of vipslib does not support the "' .
$nameOfPropertyNotFound . '" property';
switch ($nameOfPropertyNotFound) {
case 'alpha_q':
$msg .= ' (It was introduced in vips 8.4)';
break;
case 'near_lossless':
$msg .= ' (It was introduced in vips 8.4)';
break;
case 'smart_subsample':
$msg .= ' (its the vips equalent to the "sharp-yuv" option. It was introduced in vips 8.4)';
break;
case 'reduction_effort':
$msg .= ' (its the vips equalent to the "method" option. It was introduced in vips 8.8.0)';
break;
case 'preset':
$msg .= ' (It was introduced in vips 8.4)';
break;
}
$msg .= '. The option is ignored.';
$this->logLn($msg, 'bold');
unset($options[$nameOfPropertyNotFound]);
$this->webpsave($im, $options);
} else {
throw new ConversionFailedException($message);
}
}
}
/**
* Convert with vips extension.
*
* Tries to create image resource and save it as webp using the calculated options.
* Vips fails when a parameter is not supported, but we detect this and unset that parameter and try again
* (repeat until success).
*
* @throws ConversionFailedException if conversion fails.
*/
protected function doActualConvert()
{
/*
$im = \Jcupitt\Vips\Image::newFromFile($this->source);
//$im->writeToFile(__DIR__ . '/images/small-vips.webp', ["Q" => 10]);
$im->webpsave($this->destination, [
"Q" => 80,
//'near_lossless' => true
]);
return;*/
$im = $this->createImageResource();
$options = $this->createParamsForVipsWebPSave();
$this->webpsave($im, $options);
}
}

View File

@@ -0,0 +1,415 @@
<?php
namespace WebPConvert\Convert\Converters;
use WebPConvert\Convert\Converters\AbstractConverter;
use WebPConvert\Convert\Converters\ConverterTraits\CloudConverterTrait;
use WebPConvert\Convert\Converters\ConverterTraits\CurlTrait;
use WebPConvert\Convert\Converters\ConverterTraits\EncodingAutoTrait;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperationalException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\SystemRequirementsNotMetException;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational\InvalidApiKeyException;
use WebPConvert\Options\BooleanOption;
use WebPConvert\Options\IntegerOption;
use WebPConvert\Options\SensitiveStringOption;
use WebPConvert\Options\OptionFactory;
/**
* Convert images to webp using Wpc (a cloud converter based on WebP Convert).
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class Wpc extends AbstractConverter
{
use CloudConverterTrait;
use CurlTrait;
use EncodingAutoTrait;
protected function getUnsupportedDefaultOptions()
{
return [];
}
public function getUniqueOptions($imageType)
{
return OptionFactory::createOptions([
['api-key', 'string', [
'title' => 'API key',
'description' => 'The API key is set up on the remote. Copy that.',
'default' => '',
'sensitive' => true,
'ui' => [
'component' => 'password',
'advanced' => false,
'display' => "option('wpc-api-version') != 0"
]
]],
['secret', 'string', [
'title' => 'Secret',
'description' => '',
'default' => '',
'sensitive' => true,
'ui' => [
'component' => 'password',
'advanced' => false,
'display' => "option('wpc-api-version') == 0"
]
]],
['api-url', 'string', [
'title' => 'API url',
'description' => 'The endpoint of the web service. Copy it from the remote setup',
'default' => '',
'sensitive' => true,
'ui' => [
'component' => 'password',
'advanced' => false,
]
]],
['api-version', 'int', [
'title' => 'API version',
'description' =>
'Refers to the major version of Wpc. ' .
'It is probably 2, as it is a long time since 2.0 was released',
'default' => 2,
'minimum' => 0,
'maximum' => 2,
'ui' => [
'component' => 'select',
'advanced' => false,
'options' => [0, 1, 2],
]
]],
['crypt-api-key-in-transfer', 'boolean', [
'title' => 'Crypt API key in transfer',
'description' =>
'If checked, the api key will be crypted in requests. ' .
'Crypting the api-key protects it from being stolen during transfer',
'default' => false,
'ui' => [
'component' => 'checkbox',
'advanced' => true,
'display' => "option('wpc-api-version') >= 1"
]
]],
]);
/*return [
new SensitiveStringOption('api-key', ''),
new SensitiveStringOption('secret', ''),
new SensitiveStringOption('api-url', ''),
new SensitiveStringOption('url', ''), // DO NOT USE. Only here to keep the protection
new IntegerOption('api-version', 2, 0, 2),
new BooleanOption('crypt-api-key-in-transfer', false) // new in api v.1
];*/
}
public function supportsLossless()
{
return ($this->options['api-version'] >= 2);
}
public function passOnEncodingAuto()
{
// We could make this configurable. But I guess passing it on is always to be preferred
// for api >= 2.
return ($this->options['api-version'] >= 2);
}
private static function createRandomSaltForBlowfish()
{
$salt = '';
$validCharsForSalt = array_merge(
range('A', 'Z'),
range('a', 'z'),
range('0', '9'),
['.', '/']
);
for ($i = 0; $i < 22; $i++) {
$salt .= $validCharsForSalt[array_rand($validCharsForSalt)];
}
return $salt;
}
/**
* Get api key from options or environment variable
*
* @return string api key or empty string if none is set
*/
private function getApiKey()
{
if ($this->options['api-version'] == 0) {
if (!empty($this->options['secret'])) {
return $this->options['secret'];
}
} elseif ($this->options['api-version'] >= 1) {
if (!empty($this->options['api-key'])) {
return $this->options['api-key'];
}
}
if (defined('WEBPCONVERT_WPC_API_KEY')) {
return constant('WEBPCONVERT_WPC_API_KEY');
}
if (!empty(getenv('WEBPCONVERT_WPC_API_KEY'))) {
return getenv('WEBPCONVERT_WPC_API_KEY');
}
return '';
}
/**
* Get url from options or environment variable
*
* @return string URL to WPC or empty string if none is set
*/
private function getApiUrl()
{
if (!empty($this->options['api-url'])) {
return $this->options['api-url'];
}
if (defined('WEBPCONVERT_WPC_API_URL')) {
return constant('WEBPCONVERT_WPC_API_URL');
}
if (!empty(getenv('WEBPCONVERT_WPC_API_URL'))) {
return getenv('WEBPCONVERT_WPC_API_URL');
}
return '';
}
/**
* Check operationality of Wpc converter.
*
* @throws SystemRequirementsNotMetException if system requirements are not met (curl)
* @throws ConverterNotOperationalException if key is missing or invalid, or quota has exceeded
*/
public function checkOperationality()
{
$options = $this->options;
$apiVersion = $options['api-version'];
if ($this->getApiUrl() == '') {
if (isset($this->options['url']) && ($this->options['url'] != '')) {
throw new ConverterNotOperationalException(
'The "url" option has been renamed to "api-url" in webp-convert 2.0. ' .
'You must change the configuration accordingly.'
);
}
throw new ConverterNotOperationalException(
'Missing URL. You must install Webp Convert Cloud Service on a server, ' .
'or the WebP Express plugin for Wordpress - and supply the url.'
);
}
if ($apiVersion == 0) {
if (!empty($this->getApiKey())) {
// if secret is set, we need md5() and md5_file() functions
if (!function_exists('md5')) {
throw new ConverterNotOperationalException(
'A secret has been set, which requires us to create a md5 hash from the secret and the file ' .
'contents. ' .
'But the required md5() PHP function is not available.'
);
}
if (!function_exists('md5_file')) {
throw new ConverterNotOperationalException(
'A secret has been set, which requires us to create a md5 hash from the secret and the file ' .
'contents. But the required md5_file() PHP function is not available.'
);
}
}
} else {
if ($options['crypt-api-key-in-transfer']) {
if (!function_exists('crypt')) {
throw new ConverterNotOperationalException(
'Configured to crypt the api-key, but crypt() function is not available.'
);
}
if (!defined('CRYPT_BLOWFISH')) {
throw new ConverterNotOperationalException(
'Configured to crypt the api-key. ' .
'That requires Blowfish encryption, which is not available on your current setup.'
);
}
}
}
// Check for curl requirements
$this->checkOperationalityForCurlTrait();
}
/*
public function checkConvertability()
{
// check upload limits
$this->checkConvertabilityCloudConverterTrait();
// TODO: some from below can be moved up here
}
*/
private function createOptionsToSend()
{
$optionsToSend = $this->options;
if ($this->isQualityDetectionRequiredButFailing()) {
// quality was set to "auto", but we could not meassure the quality of the jpeg locally
// Ask the cloud service to do it, rather than using what we came up with.
$optionsToSend['quality'] = 'auto';
} else {
$optionsToSend['quality'] = $this->getCalculatedQuality();
}
// The following are unset for security reasons.
unset($optionsToSend['converters']);
unset($optionsToSend['secret']);
unset($optionsToSend['api-key']);
unset($optionsToSend['api-url']);
$apiVersion = $optionsToSend['api-version'];
if ($apiVersion == 1) {
// Lossless can be "auto" in api 2, but in api 1 "auto" is not supported
//unset($optionsToSend['lossless']);
} elseif ($apiVersion == 2) {
//unset($optionsToSend['png']);
//unset($optionsToSend['jpeg']);
// The following are unset for security reasons.
unset($optionsToSend['cwebp-command-line-options']);
unset($optionsToSend['command-line-options']);
}
return $optionsToSend;
}
private function createPostData()
{
$options = $this->options;
$postData = [
'file' => curl_file_create($this->source),
'options' => json_encode($this->createOptionsToSend()),
'servername' => (isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : '')
];
$apiVersion = $options['api-version'];
$apiKey = $this->getApiKey();
if ($apiVersion == 0) {
$postData['hash'] = md5(md5_file($this->source) . $apiKey);
} else {
//$this->logLn('api key: ' . $apiKey);
if ($options['crypt-api-key-in-transfer']) {
$salt = self::createRandomSaltForBlowfish();
$postData['salt'] = $salt;
// Strip off the first 28 characters (the first 6 are always "$2y$10$". The next 22 is the salt)
$postData['api-key-crypted'] = substr(crypt($apiKey, '$2y$10$' . $salt . '$'), 28);
} else {
$postData['api-key'] = $apiKey;
}
}
return $postData;
}
protected function doActualConvert()
{
$ch = self::initCurl();
//$this->logLn('api url: ' . $this->getApiUrl());
curl_setopt_array($ch, [
CURLOPT_URL => $this->getApiUrl(),
CURLOPT_POST => 1,
CURLOPT_POSTFIELDS => $this->createPostData(),
CURLOPT_BINARYTRANSFER => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HEADER => false,
CURLOPT_SSL_VERIFYPEER => false
]);
$response = curl_exec($ch);
if (curl_errno($ch)) {
$this->logLn('Curl error: ', 'bold');
$this->logLn(curl_error($ch));
throw new ConverterNotOperationalException('Curl error:');
}
// Check if we got a 404
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($httpCode == 404) {
curl_close($ch);
throw new ConversionFailedException(
'WPC was not found at the specified URL - we got a 404 response.'
);
}
// Check for empty response
if (empty($response)) {
throw new ConversionFailedException(
'Error: Unexpected result. We got nothing back. ' .
'HTTP CODE: ' . $httpCode . '. ' .
'Content type:' . curl_getinfo($ch, CURLINFO_CONTENT_TYPE)
);
};
// The WPC cloud service either returns an image or an error message
// Images has application/octet-stream.
// Verify that we got an image back.
if (curl_getinfo($ch, CURLINFO_CONTENT_TYPE) != 'application/octet-stream') {
curl_close($ch);
if (substr($response, 0, 1) == '{') {
$responseObj = json_decode($response, true);
if (isset($responseObj['errorCode'])) {
switch ($responseObj['errorCode']) {
case 0:
throw new ConverterNotOperationalException(
'There are problems with the server setup: "' .
$responseObj['errorMessage'] . '"'
);
case 1:
throw new InvalidApiKeyException(
'Access denied. ' . $responseObj['errorMessage']
);
default:
throw new ConversionFailedException(
'Conversion failed: "' . $responseObj['errorMessage'] . '"'
);
}
}
}
// WPC 0.1 returns 'failed![error messag]' when conversion fails. Handle that.
if (substr($response, 0, 7) == 'failed!') {
throw new ConversionFailedException(
'WPC failed converting image: "' . substr($response, 7) . '"'
);
}
$this->logLn('Bummer, we did not receive an image');
$this->log('What we received starts with: "');
$this->logLn(
str_replace("\r", '', str_replace("\n", '', htmlentities(substr($response, 0, 400)))) . '..."'
);
throw new ConversionFailedException('Unexpected result. We did not receive an image but something else.');
//throw new ConverterNotOperationalException($response);
}
$success = file_put_contents($this->destination, $response);
curl_close($ch);
if (!$success) {
throw new ConversionFailedException('Error saving file. Check file permissions');
}
}
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Convert\Exceptions\ConversionFailed;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
class ConversionSkippedException extends ConversionFailedException
{
public $description = 'The converter declined converting';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperationalException;
class InvalidApiKeyException extends ConverterNotOperationalException
{
public $description = 'The converter is not operational (access denied)';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperational;
use WebPConvert\Convert\Exceptions\ConversionFailed\ConverterNotOperationalException;
class SystemRequirementsNotMetException extends ConverterNotOperationalException
{
public $description = 'The converter is not operational (system requirements not met)';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Convert\Exceptions\ConversionFailed;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
class ConverterNotOperationalException extends ConversionFailedException
{
public $description = 'The converter is not operational';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Convert\Exceptions\ConversionFailed\FileSystemProblems;
use WebPConvert\Convert\Exceptions\ConversionFailed\FileSystemProblemsException;
class CreateDestinationFileException extends FileSystemProblemsException
{
public $description = 'The converter could not create destination file. Check file permisions!';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Convert\Exceptions\ConversionFailed\FileSystemProblems;
use WebPConvert\Convert\Exceptions\ConversionFailed\FileSystemProblemsException;
class CreateDestinationFolderException extends FileSystemProblemsException
{
public $description = 'The converter could not create destination folder. Check file permisions!';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Convert\Exceptions\ConversionFailed;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
class FileSystemProblemsException extends ConversionFailedException
{
public $description = 'Filesystem problems';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput;
use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInputException;
class ConverterNotFoundException extends InvalidInputException
{
public $description = 'The converter does not exist.';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput;
use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInputException;
class InvalidImageTypeException extends InvalidInputException
{
public $description = 'The converter does not handle the supplied image type';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInput;
use WebPConvert\Convert\Exceptions\ConversionFailed\InvalidInputException;
class TargetNotFoundException extends InvalidInputException
{
public $description = 'The converter could not locate source file';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Convert\Exceptions\ConversionFailed;
use WebPConvert\Convert\Exceptions\ConversionFailedException;
class InvalidInputException extends ConversionFailedException
{
public $description = 'Invalid input';
}

View File

@@ -0,0 +1,31 @@
<?php
namespace WebPConvert\Convert\Exceptions;
use WebPConvert\Exceptions\WebPConvertException;
/**
* ConversionFailedException is the base exception in the hierarchy for conversion errors.
*
* Exception hierarchy from here:
*
* WebpConvertException
* ConversionFailedException
* ConversionSkippedException
* ConverterNotOperationalException
* InvalidApiKeyException
* SystemRequirementsNotMetException
* FileSystemProblemsException
* CreateDestinationFileException
* CreateDestinationFolderException
* InvalidInputException
* ConverterNotFoundException
* InvalidImageTypeException
* InvalidOptionValueException
* TargetNotFoundException
*/
class ConversionFailedException extends WebPConvertException
{
//public $description = 'Conversion failed';
public $description = '';
}

View File

@@ -0,0 +1,169 @@
<?php
namespace WebPConvert\Convert\Helpers;
use ExecWithFallback\ExecWithFallback;
/**
* Try to detect quality of a jpeg image using various tools.
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class JpegQualityDetector
{
/**
* Try to detect quality of jpeg using imagick extension.
*
* Note that the detection might fail for two different reasons:
* 1) Imagick is not installed
* 2) Imagick for some reason fails to detect quality for some images
*
* In both cases, null is returned.
*
* @param string $filename A complete file path to file to be examined
* @return int|null Quality, or null if it was not possible to detect quality
*/
private static function detectQualityOfJpgUsingImagick($filename)
{
if (extension_loaded('imagick') && class_exists('\\Imagick')) {
try {
$img = new \Imagick($filename);
// The required function is available as from PECL imagick v2.2.2
if (method_exists($img, 'getImageCompressionQuality')) {
$quality = $img->getImageCompressionQuality();
if ($quality === 0) {
// We have experienced that this Imagick method returns 0 for some images,
// (even though the imagemagick binary is able to detect the quality)
// ie "/test/images/quality-undetectable-with-imagick.jpg". See #208
$quality = null;
}
return $quality;
}
} catch (\Exception $e) {
// Well well, it just didn't work out.
// - But perhaps next method will work...
} catch (\Throwable $e) {
}
}
return null;
}
/**
* Try to detect quality of jpeg using imagick binary.
*
* Note that the detection might fail for three different reasons:
* 1) exec function is not available
* 2) the 'identify' command is not available on the system
* 3) imagemagick for some reason fails to detect quality for some images
*
* In the first two cases, null is returned.
* In the third case, 92 is returned. This is what imagemagick returns when it cannot detect the quality.
* and unfortunately we cannot distinguish between the situation where the quality is undetectable
* and the situation where the quality is actually 92 (at least, I have not found a way to do so)
*
* @param string $filename A complete file path to file to be examined
* @return int|null Quality, or null if it was not possible to detect quality
*/
private static function detectQualityOfJpgUsingImageMagick($filename)
{
if (ExecWithFallback::anyAvailable()) {
// Try Imagick using exec, and routing stderr to stdout (the "2>$1" magic)
try {
ExecWithFallback::exec(
"identify -format '%Q' " . escapeshellarg($filename) . " 2>&1",
$output,
$returnCode
);
//echo 'out:' . print_r($output, true);
if ((intval($returnCode) == 0) && (is_array($output)) && (count($output) == 1)) {
return intval($output[0]);
}
} catch (\Exception $e) {
// its ok, there are other fish in the sea
} catch (\Throwable $e) {
}
}
return null;
}
/**
* Try to detect quality of jpeg using graphicsmagick binary.
*
* It seems that graphicsmagick is never able to detect the quality! - and always returns
* the default quality, which is 75.
* However, as this might be solved in future versions, the method might be useful one day.
* But we treat "75" as a failure to detect and shall return null in that case.
*
* @param string $filename A complete file path to file to be examined
* @return int|null Quality, or null if it was not possible to detect quality
*/
private static function detectQualityOfJpgUsingGraphicsMagick($filename)
{
if (ExecWithFallback::anyAvailable()) {
// Try GraphicsMagick
try {
ExecWithFallback::exec(
"gm identify -format '%Q' " . escapeshellarg($filename) . " 2>&1",
$output,
$returnCode
);
if ((intval($returnCode) == 0) && (is_array($output)) && (count($output) == 1)) {
$quality = intval($output[0]);
// It seems that graphicsmagick is (currently) never able to detect the quality!
// - and always returns 75 as a fallback
// We shall therefore treat 75 as a failure to detect. (#209)
if ($quality == 75) {
return null;
}
return $quality;
}
} catch (\Exception $e) {
} catch (\Throwable $e) {
}
}
return null;
}
/**
* Try to detect quality of jpeg.
*
* Note: This method does not throw errors, but might dispatch warnings.
* You can use the WarningsIntoExceptions class if it is critical to you that nothing gets "printed"
*
* @param string $filename A complete file path to file to be examined
* @return int|null Quality, or null if it was not possible to detect quality
*/
public static function detectQualityOfJpg($filename)
{
//trigger_error('warning test', E_USER_WARNING);
// Test that file exists in order not to break things.
if (!file_exists($filename)) {
// One could argue that it would be better to throw an Exception...?
return null;
}
// Try Imagick extension, if available
$quality = self::detectQualityOfJpgUsingImagick($filename);
if (is_null($quality)) {
$quality = self::detectQualityOfJpgUsingImageMagick($filename);
}
if (is_null($quality)) {
$quality = self::detectQualityOfJpgUsingGraphicsMagick($filename);
}
return $quality;
}
}

View File

@@ -0,0 +1,70 @@
<?php
namespace WebPConvert\Convert\Helpers;
/**
* Get/parse shorthandsize strings from php.ini as bytes.
*
* Parse strings like "1k" into bytes (1024).
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.0.0
*/
class PhpIniSizes
{
/**
* Parse a shordhandsize string as the ones returned by ini_get()
*
* Parse a shorthandsize string having the syntax allowed in php.ini and returned by ini_get().
* Ie "1K" => 1024.
* Strings without units are also accepted.
* The shorthandbytes syntax is described here: https://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes
*
* @param string $shortHandSize A size string of the type returned by ini_get()
* @return float|false The parsed size (beware: it is float, do not check high numbers for equality),
* or false if parse error
*/
public static function parseShortHandSize($shortHandSize)
{
$result = preg_match("#^\\s*(\\d+(?:\\.\\d+)?)([bkmgtpezy]?)\\s*$#i", $shortHandSize, $matches);
if ($result !== 1) {
return false;
}
// Truncate, because that is what php does.
$digitsValue = floor($matches[1]);
if ((count($matches) >= 3) && ($matches[2] != '')) {
$unit = $matches[2];
// Find the position of the unit in the ordered string which is the power
// of magnitude to multiply a kilobyte by.
$position = stripos('bkmgtpezy', $unit);
return floatval($digitsValue * pow(1024, $position));
} else {
return $digitsValue;
}
}
/*
* Get the size of an php.ini option.
*
* Calls ini_get() and parses the size to a number.
* If the configuration option is null, does not exist, or cannot be parsed as a shorthandsize, false is returned
*
* @param string $varname The configuration option name.
* @return float|false The parsed size or false if the configuration option does not exist
*/
public static function getIniBytes($iniVarName)
{
$iniVarValue = ini_get($iniVarName);
if (($iniVarValue == '') || $iniVarValue === false) {
return false;
}
return self::parseShortHandSize($iniVarValue);
}
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Exceptions\InvalidInput;
use WebPConvert\Exceptions\InvalidInputException;
class InvalidImageTypeException extends InvalidInputException
{
public $description = 'The converter does not handle the supplied image type';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Exceptions\InvalidInput;
use WebPConvert\Exceptions\InvalidInputException;
class TargetNotFoundException extends InvalidInputException
{
public $description = 'The converter could not locate source file';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Exceptions;
use WebPConvert\Exceptions\WebPConvertException;
class InvalidInputException extends WebPConvertException
{
public $description = 'Invalid input';
}

View File

@@ -0,0 +1,10 @@
<?php
namespace WebPConvert\Exceptions;
use WebPConvert\Exceptions\WebPConvertException;
class SanityException extends WebPConvertException
{
public $description = 'Sanity check failed';
}

View File

@@ -0,0 +1,44 @@
<?php
namespace WebPConvert\Exceptions;
/**
* WebPConvertException is the base exception for all exceptions in this library.
*
* Note that the parameters for the constructor differs from that of the Exception class.
* We do not use exception code here, but are instead allowing two version of the error message:
* a short version and a long version.
* The short version may not contain special characters or dynamic content.
* The detailed version may.
* If the detailed version isn't provided, getDetailedMessage will return the short version.
*
*/
class WebPConvertException extends \Exception
{
public $description = '';
protected $detailedMessage;
protected $shortMessage;
public function getDetailedMessage()
{
return $this->detailedMessage;
}
public function getShortMessage()
{
return $this->shortMessage;
}
public function __construct($shortMessage = "", $detailedMessage = "", $previous = null)
{
$detailedMessage = ($detailedMessage != '') ? $detailedMessage : $shortMessage;
$this->detailedMessage = $detailedMessage;
$this->shortMessage = $shortMessage;
parent::__construct(
$detailedMessage,
0,
$previous
);
}
}

View File

@@ -0,0 +1,109 @@
<?php
namespace WebPConvert\Helpers;
use WebPConvert\Helpers\FileExists;
use ExecWithFallback\ExecWithFallback;
/**
* Discover multiple paths of a binary
*
* @package WebPConvert
* @author Bjørn Rosell <it@rosell.dk>
* @since Class available since Release 2.3.0
*/
class BinaryDiscovery
{
// Common system paths
private static $commonSystemPaths = [
'/usr/bin',
'/usr/local/bin',
'/usr/gnu/bin',
'/usr/syno/bin',
'/bin',
];
/**
* Discover binaries by looking in common system paths.
*
* We try a small set of common system paths, such as "/usr/bin".
*
* @param string $binary the binary to look for (ie "cwebp")
*
* @return array binaries found in common system locations
*/
public static function discoverInCommonSystemPaths($binary)
{
$binaries = [];
foreach (self::$commonSystemPaths as $dir) {
// PS: FileExists might throw if exec() or similar is unavailable. We let it.
// - this class assumes exec is available
if (FileExists::fileExistsTryHarder($dir . '/' . $binary)) {
$binaries[] = $dir . '/' . $binary;
}
}
return $binaries;
}
/**
* Discover installed binaries using ie "whereis -b cwebp"
*
* @return array Array of cwebp paths discovered (possibly empty)
*/
private static function discoverBinariesUsingWhereIs($binary)
{
// This method was added due to #226.
ExecWithFallback::exec('whereis -b ' . $binary . ' 2>&1', $output, $returnCode);
if (($returnCode == 0) && (isset($output[0]))) {
$result = $output[0];
// Ie: "cwebp: /usr/bin/cwebp /usr/local/bin/cwebp"
if (preg_match('#^' . $binary . ':\s(.*)$#', $result, $matches)) {
return explode(' ', $matches[1]);
}
}
return [];
}
/**
* Discover installed binaries using "which -a cwebp"
*
* @param string $binary the binary to look for (ie "cwebp")
*
* @return array Array of paths discovered (possibly empty)
*/
private static function discoverBinariesUsingWhich($binary)
{
// As suggested by @cantoute here:
// https://wordpress.org/support/topic/sh-1-usr-local-bin-cwebp-not-found/
ExecWithFallback::exec('which -a ' . $binary . ' 2>&1', $output, $returnCode);
if ($returnCode == 0) {
return $output;
}
return [];
}
/**
* Discover binaries using "which -a" or, if that fails "whereis -b"
*
* These commands only searces within $PATH. So it only finds installed binaries (which is good,
* as it would be unsafe to deal with binaries found scattered around)
*
* @param string $binary the binary to look for (ie "cwebp")
*
* @return array binaries found in common system locations
*/
public static function discoverInstalledBinaries($binary)
{
$paths = self::discoverBinariesUsingWhich($binary);
if (count($paths) > 0) {
return $paths;
}
$paths = self::discoverBinariesUsingWhereIs($binary);
if (count($paths) > 0) {
return $paths;
}
return [];
}
}

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