Malin/MeDBia
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add videodb media index with Docker stack

Browse Source 
- Add videodb PHP/MySQL media collection manager (Blu-ray, DVD, CD)
- Dockerfile: PHP 8.1 + Apache with GD/mysqli/exif extensions
- docker-compose.yml: app on port 6761 + MySQL 8.0 with health checks
- docker-entrypoint.sh: auto-generates config.inc.php from env vars,
  waits for MySQL, initializes DB schema idempotently
- init-db.php: CLI schema installer using app's own prefix_query() logic
- Persistent volumes for DB, cache, and cover images

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Malin
2026-05-11 09:49:52 +02:00
commit f55c91276e
1230 changed files with 252321 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1573
videodb/vendor/james-heinrich/phpthumb/docs/phpthumb.changelog.txt vendored Normal file
View File

File diff suppressed because it is too large Load Diff

372
videodb/vendor/james-heinrich/phpthumb/docs/phpthumb.faq.txt vendored Normal file
View File

@@ -0,0 +1,372 @@
//////////////////////////////////////////////////////////////////
// phpThumb() by James Heinrich <info@silisoftware.com> //
// available at http://phpthumb.sourceforge.net //
// and/or https://github.com/JamesHeinrich/phpThumb //
//////////////////////////////////////////////////////////////////
/// //
// Frequently Asked Questions (FAQ) about phpThumb() //
// ///
//////////////////////////////////////////////////////////////////
Q: My question isn't answered here, how do I get support?
A: Please visit http://support.silisoftware.com for any
questions, suggestions, bugs, etc.
Q: I think I found a bug, what's the first thing I should do?
A: Please make sure you're using the latest version:
https://github.com/JamesHeinrich/phpThumb
There's a good chance I may have already fixed the bug, so
please make sure you can reproduce it with the latest version
before reporting the bug.
Q: phpThumb doesn't work as expected, and it may be a server
configuration issue -- how do I check?
A: Please run /demo/demo.check.php to find out how your server
matches up with the recommended configuration and for
suggestions on what to change for improved performance.
Q: What is the GPL? Can I use this for commercial sites?
A: See the GPL FAQ: http://www.gnu.org/licenses/gpl-faq.html
In general, if you just want to call phpThumb.php in the
standard <img src="phpThumb.php?src=pic.jpg&w=100"> manner
then there is no problem, you're free to do this no matter
if you site is commercial or not, or what license your code
is released under.
If you're calling phpThumb() as an object then you will
probably run into license issues, so consult the above FAQ
and the GPL itself.
No matter if you use phpThumb() commercially or not, no
payment is required. However, donations are always welcome
and can be made at http://phpthumb.sourceforge.net
Q: Some images generate thumbnails, but some fail (the original
non-resized image is output instead).
A: Your PHP installation does not have a high enough memory_limit
and ImageMagick is not installed on the server. The PHP memory
required is 5 times the number of pixels in the image.
For example:
640x480x5 = 1.5MB
1600x1200x5 = 9.2MB
You can adjust the PHP memory limit in php.ini (if you have
permission on your server to do so), or (better yet) install
ImageMagick on the server and that will bypass the memory limit
issue. If you can't do either of the above, you can resize the
images manually (with your favourite image editor) to a size
that your memory_limit setting can handle, and/or you can
re-save the images with an image editor that can embed an EXIF
thumbnail (Photoshop for example) which phpThumb can use as an
image source (lower image quality, but perhaps better than
nothing).
Q: Is there are way to determine the new height and width of the
generated thumbnail (so I can put it in the <img> width/height)?
A: The problem is that phpThumb.php returns an image -- there is no
way to pass on any additional info such as width/height.
However, you can do something like this:
require_once('phpthumb.functions.php');
$pic = 'picture.jpg';
list($source_w, $source_h) = GetImageSize($pic);
$max_w = 375;
$max_h = 400;
list($newW, $newH) = phpthumb_functions::ProportionalResize(
$source_w, $source_h, $max_w, $max_h);
$url = 'phpThumb.php?src='.$pic.'&w='.$max_w.'&h='.$max_h;
echo "<img src=\"$url\" width=\"$newW\" height=\"$newH\">';
Q: I'm getting is this error message:
Failed: RenderToFile(<filename>) failed because
!is_resource($this->gdimg_output)
A: You missed the call to GenerateThumbnail() before
RenderToFile() or OutputThumbnail.
See /demo/phpThumb.demo.object.php for an example.
Q: I'm trying to save a phpThumb-generated image in Internet
Explorer and it saves in BMP format, why?
A: This is not phpThumb's fault, it is an IE issue:
http://support.microsoft.com/default.aspx?scid=kb;en-us;810978
http://support.microsoft.com/default.aspx?scid=kb;en-us;260650
Q: PNG images with transparent areas show up with gray background
in the areas that are supposed to be transparent.
A: Internet Explorer has had a broken PNG alpha-channel display
implementation for a decade, so it may never get fixed. Other
major browsers generally handle alpha-transparent PNGs fine.
See http://www.silisoftware.com/png_transparency/
For an alpha-channel PNG display in IE hack, see this page:
http://www.koivi.com/ie-png-transparency/
Q: I'm getting "<filename> does not exist" when I know the
file does exist
A: Check that these two values are present and properly
configured in phpThumb.config.php (introduced in v1.6.0):
$PHPTHUMB_CONFIG['allow_src_above_docroot'] (default=false)
$PHPTHUMB_CONFIG['allow_src_above_phpthumb'] (default=true)
If your images are outside DOCUMENT_ROOT (this includes if
you have an image upload form, most likely the images will
get uploaded to "/tmp/<file>" or similar) then you will have
to configure 'allow_src_above_docroot' to true.
Make sure whatever user the webserver is running as has read
permission to the file/directory you're reading from
Q: Should I use phpThumb.php, or use phpThumb() as an object?
A: phpThumb.php is easier to use (less coding) for basic uses.
phpThumb.php handles all caching; your own object will need
to have its own caching code. If you just want to display a
thumbnailed version of an existing image, use phpThumb.php
If you want to render one (or more) thumbnails to static
files (during upload, for example), that's an appropriate
use for the object mode. Also, phpThumb.config.php is only
used by phpThumb.php, so if you instantiate your own object
you need to manually set all configuration options because
phpThumb.config.php has NO effect. So, to repeat:
**always use phpThumb.php unless you NEED to have an object**
Q: The first time I go to a page which contains thumbnails I
don't actually see the thumbnail, I just get a browser image
placeholder (or no image). As soon as I hit refresh, all the
thumbnail images pop into place really fast.
A: You can try and see if it works better with
$PHPTHUMB_CONFIG['cache_force_passthru'] = false;
but typically the default setting works better.
Note: There were some maybe-undefined variables prior to
v1.7.9 that contributed to this behavior. If you notice
this happening in v1.7.9 or newer please email me at
info@silisoftware.com
Q: Are there any front-end GUI interfaces to phpThumb()?
A: See /demo/readme.demo.txt
Q: Are there / have there been any security issues in phpThumb?
A: http://secunia.com/product/5199/
Q: Why can't Flash work with images output from phpThumb()?
A: Flash doesn't like progressive JPEG. Set:
$PHPTHUMB_CONFIG['output_interlace'] = false;
Q: Image quality is not very good - why?
A: If you're using GD v1.x, no way around it. Upgrade to GD v2.x
Q: Image quality is very bad, very pixelated -- why?
A: You may be trying to resize images larger than the available
PHP memory, so phpThumb is simply extracting and using the
EXIF thumbnail as the image source, which is usually about
160x120 (so if you resize it to 640x480 it will look very bad).
To calculate the required size for memory_limit in php.ini,
calculate the number of pixels in the image and multiply by 5:
For example, 1600x1200 = 1600 * 1200 * 5 = 9600000 = 10M
Easy solution: install ImageMagick
Q: Can I save the generated thumbnail to a file?
A: Yes, there are several ways to do so; the best way is to call
phpThumb as an object and call RenderToFile() to save the
thumbnail to whatever filename you want.
See /demo/phpThumb.demo.object.php for an example.
The other way is to use the 'file' parameter (see
/docs/phpthumb.readme.txt) but this parameter is deprecated
and does not work in phpThumb v1.7.5 and newer.
Q: "Off-server thumbnailing is not allowed" -- how do I enable it?
A: By default, phpThumb() only makes thumbnails for the same
domain that it is running on. To allow it to make thumbnails
for a limited number of other domains, add them
(in phpThumb.config.php) like this:
$PHPTHUMB_CONFIG['nohotlink_valid_domains'] = array(
@$_SERVER['HTTP_HOST'], 'example.com', 'www.example.com',
'subdomain.example.net', 'example.org');
To disable off-server thumbnail blocking, just set:
$PHPTHUMB_CONFIG['nohotlink_enabled'] = false;
Q: Is it possible to set the parameters (like w/h/fltr[]) in
the config, so that they can't be changed over the URL?
A: Take a look at $PHPTHUMB_DEFAULTS at the bottom of
phpThumb.config.php You'll want to set
$PHPTHUMB_DEFAULTS_GETSTRINGOVERRIDE = false
possibly also
$PHPTHUMB_DEFAULTS_DISABLEGETPARAMS = true
You may also want to investigate
$PHPTHUMB_CONFIG['high_security_enabled'] = true
(see the example at the bottom of phpThumb.config.php
for how to call images in HighSecurity mode)
Q: Is there a way to use phpThumb() object to create thumbnails
without the parameters in the URL showing the location of
the image etc?
A: There is a demo in /demo/phpThumb.demo.object.php. You could
modify this into your own file, but there still remains the
problem of passing parameters to the file, whether it's
phpThumb.php or your own instantiation of a phpThumb() object.
I would suggest is putting as many of the common parameters
into phpThumb.config.php as possible under $PHPTHUMB_DEFAULTS,
so you then don't have to pass them for each image. If you
don't want people modifying the parameters, turn on
$PHPTHUMB_CONFIG['high_security_enabled'] and set a password
(you'll need to generate the <img> tags with phpThumbURL()
provided at the bottom of phpThumb.config.php). If you don't
want people accessing your source images at all, you can
place them outside DOCUMENT_ROOT on your server (as long as
phpThumb/PHP has read access to the directory). The other
option is to put your source images in a MySQL database
and set $PHPTHUMB_CONFIG['mysql_query'] and related
parameters in phpThumb.config.php to pull your source images
from the database. That way it's impossible to retrieve the
images except through phpThumb.php, and if high_security is
enabled, then nobody can modify the parameters to view
anything except what you want to show. So, yes, it's possible
to use your own object, but it's probably better to use
phpThumb.php if possible -- one notable issue is that
phpThumb.php handles all the caching, so you're on your own
to deal with that if you create your own object.
Q: How do I write the output thumbnail back to a database instead
of outputting to the browser or a file?
A: See /demo/phpThumb.demo.object.php Basically you need to call
$this->GenerateThumbnail() then $this->RenderOutput() and then
the output raw image data is found in $this->outputImageData
Q: phpThumb runs slowly, as if the images aren't cached, when I use HTTP source
images (not on my server). How can I make it go faster?
A: $PHPTHUMB_CONFIG['cache_source_filemtime_ignore_remote'] = true;
// if true, remote source images will not be checked for modification date and
// cached image will be used if available, even if source image is changed or removed
Q: What does the "cache_default_only_suffix" configuration option do?
A: Cache files are normally created with big ugly names like
"phpThumb_cache_www.example.com_src1a482c2c760463795ff18faf073b389f_par3e099041c2f4a73041a7f5d7e7fc481a_dat1119952152.jpeg"
but if cache_default_only_suffix is enabled, cache filenames are simplified to
"pic_thumb.jpg" (for example). The problem is that only one version of that
thumbnail is possible, and you can never call it again with a different size,
or different filters, etc. Generally you don't want that enabled, but it's
there because some people asked for it.
Q: Why is the visual size of rotated images smaller than the unrotated images?
A: phpThumb fits the rotated image into the 'w' and 'h' dimensions.
Try not specifying a 'w' parameter: phpThumb.php?src=file.png&ra=15
That should leave the image the apparent same size as the unrotated image
(in actual fact the canvas size is enlarged to fit the rotated image in it).
Q: phpThumb.demo.check.php says Safe Mode is off for Master but on for Local,
and I checked php.ini and it's already set off. How do I disable safe mode?
A: Your PHP was probably installed as an Apache module. If so, you have to set
php_admin_value safe_mode "Off"
in your domain settings (usually between <VirtualHost> tags in httpd.conf).
Then you have to restart Apache.
Q: How can I purge cached files when I delete the source image?
A: You can either let phpThumb's built-in cache purging features (see phpThumb.config.php)
take effect, or you can manually walk through your source images to delete and find
the matching cache files and delete them:
if ($dh = opendir($sourcedir)) {
while ($file = readddir($dh)) {
if ($file == $WhatIwantToDelete) {
$md5 = md5_file($sourcedir.'/'.$file);
unlink($phpthumb_cache_dir.'/phpThumb_cache_www.example.com_src'.$md5.'*.*');
}
}
closedir($dh);
}
Q: Is it safe to delete cache files?
A: Yes, it is safe to delete any cache files and/or directories. phpThumb will
automatically re-create them as needed. Also, take a look at the "cache_max*"
settings in phpThumb.config.php for automatic cache purging.
Q: How can I find the filename that phpThumb.php will use to
cache a particular image?
A: It's not easily possible to get the cache filename. You can
see the method used to calculate it in SetCacheFilename()
in phpthumb.class.php (around line 2991-3090). If you need
to know where an image will be rendered to, it may be
easier and better to call phpThumb as an object and handle
your own caching. See /demo/phpThumb.demo.object.simple.php
for an example.
Q: Can I make thumbnails from a PDF?
A: Yes, as long as you have both ImageMagick and GhostScript
installed. The AFPL version of GhostScript seems to work
better than the GNU version (at least for me it does).
http://www.imagemagick.org
http://www.cs.wisc.edu/~ghost/
You may want to use the "sfn" (Source Frame Number)
parameter of phpThumb to specify which page to thumbnail.
Q: Can I make a thumbnail of a webpage?
A: Possibly, but it's not easy. Theoretically, if you have
html2ps, GhostScript and ImageMagick all installed it should
be possible, but I have not tested that. Other projects that
attempt to generate thumbnails from webpages include:
http://www.boutell.com/webthumb/
Q: When I resize an animated GIF the new "smaller" version is
actually a larger file size -- why?
A: Animated GIFs use a variety of temporal and spatial compression
techniques. The source GIF is probably very well optimized, but
when each frame is resized some of the desirable compression
properties could be negatively affected (the number of colours
can increase; dithered areas compress very poorly compared to
solid areas of colour). ImageMagick may also not produce the
most filesize-optimized animated GIF possible.
Q: Can I use source images from (same or another) server that uses
a script with parameters to display images? For example:
http://sourceforge.net/sflogo.php?group_id=106407&type=5
(displays a PNG image, 210x62)
A: Yes, you should be able to use phpThumb like that no problem.
If the source image is on a different server you need to set
$PHPTHUMB_CONFIG['nohotlink_valid_domains'] to contain the source
domain(s) [eg: sourceforge.net] if it's a small list of possible
source domains, or make sure $PHPTHUMB_CONFIG['nohotlink_enabled']
is set to false to allow creating source images from any domain/IP.
You will also need to properly encode the image source (using PHP
function rawurlencode):
/phpThumb.php?src=http%3A%2F%2Fsourceforge.net%2Fsflogo.php%3Fgroup_id%3D106407%26type%3D5&w=100
Q: phpThumb is the best software in the world, how can I donate?
A: There's a handy "Support this project" button at the top of
http://phpthumb.sourceforge.net which will take you through
the process (and give SourceForge a ~5% cut), or if you prefer
you can send PayPal donations directly to info@silisoftware.com
Q: What is the proper name for this script/program/library?
A: The official name is "phpThumb()" but it may be written
as simply "phpThumb" in short form (or where parentheses
are not permitted), or "phpthumb" in case-insensitive
environments. The following is a non-exhaustive sample of
unacceptable forms: PHPthumb; phpThumbs; phpthump;
phpthumbnailer; phpThumbnail; PHP Thumb; Phpthumb; etc.

682
videodb/vendor/james-heinrich/phpthumb/docs/phpthumb.readme.txt vendored Normal file
View File

@@ -0,0 +1,682 @@
//////////////////////////////////////////////////////////////////
// phpThumb() by James Heinrich <info@silisoftware.com> //
// available at http://phpthumb.sourceforge.net //
// and/or https://github.com/JamesHeinrich/phpThumb //
//////////////////////////////////////////////////////////////////
/// //
// This code is released under the GNU GPL: //
// http://www.gnu.org/copyleft/gpl.html //
// //
// phpThumb() is free to use according to the terms of the GPL. //
// GPL FAQ: http://gnu.org/licenses/gpl-faq.html //
// //
// Donations are gratefully accepted from happy users :) //
// See http://phpthumb.sourceforge.net //
// ///
//////////////////////////////////////////////////////////////////
============
Description:
============
phpThumb() uses the GD library to create thumbnails from images (GIF, PNG
or JPEG) on the fly. The output size is configurable (can be larger or
smaller than the source), and the source may be the entire image or only a
portion of the original image. True color and resampling is used if
GD v2.0+ is available, otherwise low-color and simple resizing is used.
Source image can be a physical file on the server or can be retrieved from
a database. GIFs are supported on all versions of GD even if GD does not
have native GIF support thanks to the GIFutil class by Fabien Ezber.
AntiHotlinking feature prevents other people from using your server to
resize their thumbnails, or link to your images from another server. The
cache feature reduces server load.
========
Support:
========
First, read this file.
Then read phpthumb.faq.txt
Then run /demo/phpThumb.demo.check.php
If you still think it's a bug, or can't figure it out, please go to
http://support.silisoftware.com
=============
Installation:
=============
1) Download from either official site:
* https://github.com/JamesHeinrich/phpThumb (current development version)
* http://phpthumb.sourceforge.net (occasional releases + documentation)
2) unzip to a location of your choice on your server, putting it in its
own subdirectory (e.g. /phpThumb/ is useful but not required)
3) rename phpThumb.config.php.default -> phpThumb.config.php
4) edit phpThumb.config.php as needed to suit your server configuration.
* the only setting you must set is 'high_security_password'
* most other values are auto-detected, but your particular server config
may necessitate setting other values such as 'document_root' or
'imagemagick_path'
* see also "Configuration" section below
5) Check your server configuration by opening
/phpThumb/demo/phpThumb.demo.check.php in your browser. Settings that are
highlighted green are good; yellow/orange/red may need to be adjusted.
======
Usage:
======
Call phpThumb() just like you would a normal image (i.e. as the SRC attribute
of an IMG tag):
<img src="phpThumb.php?src=/image.jpg&w=100&hash=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx">
To generate the hash value you must include the phpThumb.config.php file and use the
phpThumbURL function to generate the URL including the hash value:
echo '<img src="'.htmlspecialchars(phpThumbURL('src=/images/pic.jpg&w=50', '/path/to/phpThumb.php')).'">';
The hash is calculated with the 'high_security_password' config value, so you
must generate a complex password value for that setting in phpThumb.config.php
(once, when installing phpThumb).
See the "demo" link on http://phpthumb.sourceforge.net for more usage examples.
Parameters that can be passed are listed below under "URL Parameters".
NOTE: It's recommended you use the local image filename
wherever possible (rather than http://) because performance
is much better, less (or no) use of temp files, and the
last-modified check for cached files doesn't work for
remote files.
To access files over a LAN with Windows share names you
must use the network name (or IP) and not a mapped drive
name, for example:
//othercomputer/file.jpg - good
//192.168.2.1/file.jpg - good
z:/file.jpg - won't work
This is a PHP limitation (see www.php.net/file-exists)
Note: you may want to use "/" slashes instead of "\" if
you have magic_quotes_gpc enabled to avoid stripslashes
problems, although either slash should work if
magic_quotes_gpc is disabled
================================
Alternate PATH_INFO-style Usage:
================================
phpThumb.php can also be called by passing parameters not
after the usual "?" but like this:
phpThumb.php/<params>=<values>;<w>x<h>;<image>
For example:
phpThumb.php/100;pic.jpg
phpThumb.php/100;images/pic.jpg
phpThumb.php/100;/images/pic.jpg
phpThumb.php/100x200;pic.jpg
phpThumb.php/x200;pic.jpg
phpThumb.php/f=jpeg;q=50;100x200;pic.jpg
phpThumb.php/fltr[]=usm;100;pic.jpg
<image> must be the last item. Dimensions must be the second-
last item. As many key/value pairs for parameters can be
passed before those last two items, with each pair joined by
equals ("=") and separated by semicolon (";")
==============================================
Calling as an object (not using phpThumb.php):
==============================================
NOTE: most people don't need to and should not do this. If you just want to
display resized images, please just use phpThumb.php, not the object mode.
To render output to one (or more) files instead of the browser, you should
skip phpThumb.php and instantiate your own object. Please take a look at
/demo/phpThumb.demo.object.php for details.
Note: phpThumb.php is where the caching code is located, if you instantiate
your own phpThumb() object that code is bypassed and it's up to you to
handle the reading and writing of cached files.
==============
Configuration:
==============
There are some configuration options you may (but are not required to) change.
Most configuration options can be set when you call phpThumb() - see list below),
but default configuration options (such as cache directory) are in
phpThumb.config.php - this is the only file you should ever modify.
IMPORTANT:
The configuration file is distributed as phpThumb.config.php.default to prevent
accidental overwriting of old configuration settings. Please migrate your old
settings to the new file (if upgrading), or delete your old config and rename
the default to phpThumb.config.php since newer releases may include settings not
present in your older configuration file.
The configuration options you should maybe modify are:
* high_security_password - required to generate the secure hashed URLs for
phpThumb using phpThumbURL() in phpThumb.config.php
Password must be sufficiently complex (typically means at least 20 mixed
alpha/numeric/punctuation characters). You can generate a good password
at http://www.silisoftware.com/tools/password-random.php
* cache_directory - thumbnailing is slow and processor-intensive. Enabling
caching will dramatically speed up future thumbnail serving
* imagemagick_path - Most image-processing functions can be processed faster
if ImageMagick is available on the server.
* max_source_pixels - This should be auto-detected, but if auto-detection
fails and you get an invalid image from large source images, set this to
about 20% of your available PHP memory limit.
The amount of memory required for phpThumb depends on several factors:
* the dimensions of the source image
* the dimensions of the output image
* whether unsharp masking is applied
* whether watermarks are applied, etc.
The auto-detection of memory limits works as a general "safe" value. You
may be able to exceed the auto value by a small or large amount, depending
on whether you apply watermarks and/or sharpening, and the output size of
your thumbnails. If ImageMagick is available then the amount of available
PHP memory is usually not an issue.
///////////////////////////////////////////////////////////////////////////
Note: High-Security mode is VERY STRONGLY recommended enabled in all cases.
Each call to phpThumb.php needs to be made through the function supplied
at the bottom of phpThumb.config.php which create the hash:
require_once('phpThumb.config.php');
echo '<img src="'.phpThumbURL('src=pic.jpg&w=50', '/path/to/phpThumb.php').'">';
///////////////////////////////////////////////////////////////////////////
===========
Parameters:
===========
src = filename of source image
new = create new image, not thumbnail of existing image.
Requires "w" and "h" parameters set.
[ex: &new=FF0000|75] - red background, 75% opacity
Set to hex color string of background. Opacity is
optional (defaults to 100% opaque).
w = max width of output thumbnail in pixels
h = max height of output thumbnail in pixels
wp = max width for portrait images
hp = max height for portrait images
wl = max width for landscape images
hl = max height for landscape images
ws = max width for square images
hs = max height for square images
f = output image format, one of:
("jpeg", "png", "gif", "webp", "wbmp", "ico", "bmp")
q = JPEG compression (1=worst, 95=best, 75=default)
sx = left side of source rectangle (default = 0)
(values 0 < sx < 1 represent percentage)
sy = top side of source rectangle (default = 0)
(values 0 < sy < 1 represent percentage)
sw = width of source rectangle (default = fullwidth)
(values 0 < sw < 1 represent percentage)
sh = height of source rectangle (default = fullheight)
(values 0 < sh < 1 represent percentage)
zc = zoom-crop. Will auto-crop off the larger dimension
so that the image will fill the smaller dimension
(requires both "w" and "h", overrides "iar", "far")
Set to "1" or "C" to zoom-crop towards the center,
or set to "T", "B", "L", "R", "TL", "TR", "BL", "BR"
to gravitate towards top/left/bottom/right directions
(requies ImageMagick for values other than "C" or "1")
ica = ImageCropAuto, requires (PHP 5 >= 5.5.0, PHP 7)
https://www.php.net/manual/en/function.imagecropauto.php
value can be 0-4 (IMG_CROP_DEFAULT, IMG_CROP_TRANSPARENT,
IMG_CROP_BLACK, IMG_CROP_WHITE, IMG_CROP_SIDES) or can be
"5|<threshold>|<bgcolor>" where <threshold> is between 0
and 1, and <bgcolor> is the hex background color
bg = background hex color (default = FFFFFF)
bc = border hex color (default = 000000)
fltr = filter system. Call as an array as follows:
- "brit" (Brightness) [ex: &fltr[]=brit|<value>]
where <value> is the amount +/- to adjust brightness
(range -255 to 255)
Available in PHP5 with bundled GD only.
- "cont" (Constrast) [ex: &fltr[]=cont|<value>]
where <value> is the amount +/- to adjust contrast
(range -255 to 255)
Available in PHP5 with bundled GD only.
- "gam" (Gamma Correction) [ex: &fltr[]=gam|<value>]
where <value> can be a number 0.01 to 10 (default 1.0)
Must be >0 (zero gives no effect). There is no max,
although beyond 10 is pretty useless. Negative
numbers actually do something, maybe not quite the
desired effect, but interesting nonetheless.
- "sat" (SATuration) [ex: &fltr[]=sat|<value>]
where <value> is a number between zero (no change)
and -100 (complete desaturation = grayscale), or it
can be any positive number for increased saturation.
- "ds" (DeSaturate) [ex: &fltr[]=ds|<value>]
is an alias for "sat" except values are inverted
(positive values remove color, negative values boost
saturation)
- "gray" (Grayscale) [ex: &fltr[]=gray]
remove all color from image, make it grayscale
- "th" (Threshold) [ex: &fltr[]=th|<value>]
makes image greyscale, then sets all pixels brighter
than <value> (range 0-255) to white, and all pixels
darker than <value> to black
- "rcd" (Reduce Color Depth) [ex: &fltr[]=rcd|<c>|<d>]
where <c> is the number of colors (2-256) you want
in the output image, and <d> is "1" for dithering
(deault) or "0" for no dithering
- "clr" (Colorize) [ex: &fltr[]=clr|<value>|<color>]
where <value> is a number between 0 and 100 for the
amount of colorization, and <color> is the hex color
to colorize to.
- "sep" (Sepia) [ex: &fltr[]=sep|<value>|<color>]
where <value> is a number between 0 and 100 for the
amount of colorization (default=50), and <color> is
the hex color to colorize to (default=A28065).
Note: this behaves differently when applied by
ImageMagick, in which case 80 is default, and lower
values give brighter/yellower images and higher
values give darker/bluer images
- "usm" (UnSharpMask) [ex: &fltr[]=usm|<a>|<r>|<t>]
where <a> is the amount (default = 80, range 0-255),
<r> is the radius (default = 0.5, range 0.0-10.0),
<t> is the threshold (default = 3, range 0-50).
- "blur" (Blur) [ex: &fltr[]=blur|<radius>]
where (0 < <radius> < 25) (default = 1)
- "gblr" (Gaussian Blur) [ex: &fltr[]=gblr]
Available in PHP5 with bundled GD only.
- "sblr" (Selective Blur) [ex: &fltr[]=gblr]
Available in PHP5 with bundled GD only.
- "smth" (Smooth) [ex: &fltr[]=smth|<value>]
where <value> is the weighting value for the matrix
(range -10 to 10, default 6)
Available in PHP5 with bundled GD only.
- "lvl" (Levels)
[ex: &fltr[]=lvl|<channel>|<method>|<threshold>
where <channel> can be one of 'r', 'g', 'b', 'a' (for
Red, Green, Blue, Alpha respectively), or '*' for all
RGB channels (default) based on grayscale average.
ImageMagick methods can support multiple channels
(eg "lvl|rg|3") but internal methods cannot (they will
use first character of channel string as channel)
<method> can be one of:
0=Internal RGB;
1=Internal Grayscale;
2=ImageMagick Contrast-Stretch (default)
3=ImageMagick Normalize (may appear over-saturated)
<threshold> is how much of brightest/darkest pixels
will be clipped in percent (default = 0.1%)
Using default parameters (&fltr[]=lvl) is similar to
Auto Contrast in Adobe Photoshop.
- "wb" (White Balance) [ex: &fltr[]=wb|<c>]
where <c> is the target hex color to white balance
on, this color is what "should be" white, or light
gray. The filter attempts to maintain brightness so
any gray color can theoretically be used. If <c> is
omitted the filter guesses based on brightest pixels
in each of RGB
OR <c> can be the percent of white clipping used
to calculate auto-white-balance (default = 0.1%)
NOTE: "wb" in default settings already gives an effect
similar to "lvl", there is usually no need to use "lvl"
if "wb" is already used.
- "hist" (Histogram)
[ex: &fltr[]=hist|<b>|<c>|<w>|<h>|<a>|<o>|<x>|<y>]
Where <b> is the color band(s) to display, from back
to front (one or more of "rgba*" for Red Green Blue
Alpha and Grayscale respectively);
<c> is a semicolon-separated list of hex colors to
use for each graph band (defaults to FF0000, 00FF00,
0000FF, 999999, FFFFFF respectively);
<w> and <h> are the width and height of the overlaid
histogram in pixels, or if <= 1 then percentage of
source image width/height;
<a> is the alignment (same as for "wmi" and "wmt");
<o> is opacity from 0 (transparent) to 100 (opaque)
(requires PHP v4.3.2, otherwise 100% opaque);
<x> and <y> are the edge margin in pixels (or percent
if 0 < (x|y) < 1)
- "over" (OVERlay/underlay image) overlays an image on
the thumbnail, or overlays the thumbnail on another
image (to create a picture frame for example)
[ex: &fltr[]=over|<i>|<u>|<m>|<o>]
where <i> is the image filename; <u> is "0" (default)
for overlay the image on top of the thumbnail or "1"
for overlay the thumbnail on top of the image; <m> is
the margin - can be absolute pixels, or if < 1 is a
percentage of the thumbnail size [must be < 0.5]
(default is 0 for overlay and 10% for underlay);
<o> is opacity (0 = transparent, 100 = opaque)
(requires PHP v4.3.2, otherwise 100% opaque);
(thanks raynerapeØgmail*com, shabazz3Ømsu*edu)
- "wmi" (WaterMarkImage)
[ex: &fltr[]=wmi|<f>|<a>|<o>|<x>|<y>|<r>] where
<f> is the filename of the image to overlay;
<a> is the alignment (one of BR, BL, TR, TL, C,
R, L, T, B, *) where B=bottom, T=top, L=left,
R=right, C=centre, *=tile)
*or*
an absolute position in pixels (from top-left
corner of canvas to top-left corner of overlay)
in format {xoffset}x{yoffset} (eg: "10x20")
note: this is center position of image if <x>
and <y> are set
<o> is opacity from 0 (transparent) to 100 (opaque)
(requires PHP v4.3.2, otherwise 100% opaque);
<x> and <y> are the edge (and inter-tile) margin in
pixels (or percent if 0 < (x|y) < 1)
*or*
if <a> is absolute-position format then <x> and
<y> represent maximum width and height that the
watermark image will be scaled to fit inside
<r> is rotation angle of overlaid watermark
- "wmt" (WaterMarkText)
[ex: &fltr[]=wmt|<t>|<s>|<a>|<c>|<f>|<o>|<m>|<n>|<b>|<O>|<x>|<h>]
where:
<t> is the text to use as a watermark;
URLencoded Unicode HTMLentities must be used for
characters beyond chr(127). For example, the
"eighth note" character (U+266A) is represented
as "&#9834;" and then urlencoded to "%26%239834%3B"
Any instance of metacharacters will be replaced
with their calculated value. Currently supported:
^Fb = source image filesize in bytes
^Fk = source image filesize in kilobytes
^Fm = source image filesize in megabytes
^X = source image width in pixels
^Y = source image height in pixels
^x = thumbnail width in pixels
^y = thumbnail height in pixels
^^ = the character ^
<s> is the font size (1-5 for built-in font, or point
size for TrueType fonts);
<a> is the alignment (one of BR, BL, TR, TL, C, R, L,
T, B, * where B=bottom, T=top, L=left, R=right,
C=centre, *=tile);
note: * does not work for built-in font "wmt"
*or*
an absolute position in pixels (from top-left
corner of canvas to top-left corner of overlay)
in format {xoffset}x{yoffset} (eg: "10x20")
<c> is the hex color of the text;
<f> is the filename of the TTF file (optional, if
omitted a built-in font will be used);
<o> is opacity from 0 (transparent) to 100 (opaque)
(requires PHP v4.3.2, otherwise 100% opaque);
<m> is the edge (and inter-tile) margin in percent;
<n> is the angle
<b> is the hex color of the background;
<O> is background opacity from 0 (transparent) to
100 (opaque)
(requires PHP v4.3.2, otherwise 100% opaque);
<x> is the direction(s) in which the background is
extended (either 'x' or 'y' (or both, but both
will obscure entire image))
Note: works with TTF fonts only, not built-in
<h> is the scale multiplier for line height/spacing
default is 1.0
- "flip" [ex: &fltr[]=flip|x or &fltr[]=flip|y]
flip image on X or Y axis
- "ric" [ex: &fltr[]=ric|<x>|<y>]
rounds off the corners of the image (to transparent
for PNG output), where <x> is the horizontal radius
of the curve and <y> is the vertical radius
- "elip" [ex: &fltr[]=elip]
similar to rounded corners but more extreme
- "mask" [ex: &fltr[]=mask|filename.png|<i>]
greyscale values of mask are applied as the alpha
channel to the main image. White is opaque, black
is transparent, unless the <i> (invert) parameter is
set to 1 in which case black is opaque and white is
transparent
- "bvl" (BeVeL) [ex: &fltr[]=bvl|<w>|<c1>|<c2>]
where <w> is the bevel width, <c1> is the hex color
for the top and left shading, <c2> is the hex color
for the bottom and right shading
- "bord" (BORDer) [ex: &fltr[]=bord|<w>|<rx>|<ry>|<c>
where <w> is the width in pixels, <rx> and <ry> are
horizontal and vertical radii for rounded corners,
and <c> is the hex color of the border
- "fram" (FRAMe) draws a frame, similar to "bord" but
more configurable
[ex: &fltr[]=fram|<w1>|<w2>|<c1>|<c2>|<c3>]
where <w1> is the width of the main border, <w2> is
the width of each side of the bevel part, <c1> is the
hex color of the main border, <c2> is the highlight
bevel color, <c3> is the shadow bevel color
- "drop" (DROP shadow)
[ex: &fltr[]=drop|<d>|<w>|<clr>|<a>|<o>]
where <d> is distance from image to shadow, <w> is
width of shadow fade (not yet implemented), <clr> is
the hex color of the shadow, <a> is the angle of the
shadow (default=225), <o> is opacity (0=transparent,
100=opaque, default=100) (not yet implemented)
- "crop" (CROP image)
[ex: &fltr[]=crop|<l>|<r>|<t>|<b>]
where <l> is the number of pixels to crop from the left
side of the resized image; <r>, <t>, <b> are for right,
top and bottom respectively. Where (0 < x < 1) the
value will be used as a percentage of width/height.
Left and top crops take precedence over right and
bottom values. Cropping will be limited such that at
least 1 pixel of width and height always remains.
- "rot" (ROTate)
[ex: &fltr[]=rot|<a>|<b>]
where <a> is the rotation angle in degrees; <b> is the
background hex color. Similar to regular "ra" parameter
but is applied in filter order after regular processing
so you can rotate output of other filters.
- "size" (reSIZE)
[ex: &fltr[]=size|<x>|<y>|<s>]
where <x> is the horizontal dimension in pixels, <y> is
the vertical dimension in pixels, <s> is boolean whether
to stretch (if 1) or resize proportionately (0, default)
<x> and <y> will be interpreted as percentage of current
output image size if values are (0 < X < 1)
NOTE: do NOT use this filter unless absolutely necessary.
It is only provided for cases where other filters need to
have absolute positioning based on source image and the
resultant image should be resized after other filters are
applied. This filter is less efficient than the standard
resizing procedures.
- "stc" (Source Transparent Color)
[ex: &fltr[]=stc|<c>|<n>|<x>]
where <c> is the hex color of the target color to be made
transparent; <n> is the minimum threshold in percent (all
pixels within <n>% of the target color will be 100%
transparent, default <n>=5); <x> is the maximum threshold
in percent (all pixels more than <x>% from the target
color will be 100% opaque, default <x>=10); pixels between
the two thresholds will be partially transparent.
md5s = MD5 hash of the source image -- if this parameter is
passed with the hash of the source image then the
source image is not checked for existence or
modification and the cached file is used (if
available). If 'md5s' is passed an empty string then
phpThumb.php dies and outputs the correct MD5 hash
value. This parameter is the single-file equivalent
of 'cache_source_filemtime_ignore_*' configuration
parameters
xto = EXIF Thumbnail Only - set to only extract EXIF
thumbnail and not do any additional processing
ra = Rotate by Angle: angle of rotation in degrees
positive = counterclockwise, negative = clockwise
ar = Auto Rotate: set to "x" to use EXIF orientation
stored by camera. Can also be set to "l" or "L"
for landscape, or "p" or "P" for portrait. "l"
and "P" rotate the image clockwise, "L" and "p"
rotate the image counter-clockwise.
sfn = Source Frame Number - use this frame/page number for
multi-frame/multi-page source images (GIF, TIFF, etc)
aoe = Output Allow Enlarging - override the setting for
$CONFIG['output_allow_enlarging'] (1=on, 0=off)
("far" and "iar" both override this and allow output
larger than input)
iar = Ignore Aspect Ratio - disable proportional resizing
and stretch image to fit "h" & "w" (which must both
be set). (1=on, 0=off) (overrides "far")
far = Force Aspect Ratio - image will be created at size
specified by "w" and "h" (which must both be set).
Alignment: L=left,R=right,T=top,B=bottom,C=center
BL,BR,TL,TR use the appropriate direction if the
image is landscape or portrait.
dpi = Dots Per Inch - input DPI setting when importing from
vector image format such as PDF, WMF, etc
sia = Save Image As - default filename to save generated
image as. Specify the base filename, the extension
(eg: ".png") will be automatically added
maxb = MAXimum Byte size - output quality is auto-set to
fit thumbnail into "maxb" bytes (compression
quality is adjusted for JPEG, bit depth is adjusted
for PNG and GIF)
down = filename to save image to. If this is set the
browser will prompt to save to this filename rather
than display the image
// Deprecated:
file = if set then thumbnail will be rendered to this
filename, not output and not cached.
(Deprecated. Disabled by default since v1.6.0,
unavailable in v1.7.5 and later. You should
instantiate your own object instead)
goto = URL to redirect to after rendering image to file
* Must begin with "http://"
* Requires file parameter set
(Deprecated. Disabled by default since v1.6.0,
unavailable in v1.7.5 and later. You should
instantiate your own object instead)
err = custom error image filename instead of showing
error messages (for use on production sites)
(Deprecated. Disabled by default since v1.6.0,
unavailable in v1.7.5 and later. You should
instantiate your own object instead)
==============
General Notes:
==============
* Always use the local image filename wherever possible
rather than a full http:// URL because performance is
much better, less (or no) use of temp files, and the
last-modified check for cached files doesn't work for
remote files. For example:
good: phpThumb.php?src=/images/nicepic.jpg
bad: phpThumb.php?src=/home/httpd/example/images/nicepic.jpg
worse: phpThumb.php?src=http://example.com/images/nicepic.jpg
* Thumbnails will be scaled proportionately to fit in a
box of at most (width * height) pixels
(unless "iar" is set)
* Thumbnail caching for URL or database sources requires
an absolute directory name for $config_cache_directory
Physical file cached thumbnails will be recreated if
the source file changes, but remote/database files
cannot (modification time isn't readily available)
* If you need a GUI interface to phpThumb(), or for a user
to specify crop settings, or something like that please
see the list of known programs in /demo/readme.demos.txt
* Cropping images can be specified with either exact pixel
values for sx/sy/sw/sh parameters, or if those are set
to a value >0 and <1 then these are interpreted as a
percentage of the source image width/height. For example,
to crop 25% off all sides, you would specify parameters:
phpThumb.php?src=pic.jpg&sx=.25&sy=.25&sw=.5&sh=.5
* phpThumb() may have tempfile access issues on servers
where Safe Mode is enabled, specificly when accessing
a file over HTTP, or when a non-bundled version of GD
is in use. Specifying "config_temp_directory" may help
* Properly resolving /~user/ style filenames requires
apache_lookup_uri(), which is missing or broken in
Apache2, or if PHP is not installed as an Apache module.
phpThumb() does try and work around this if it is
unavailable, but you may have to specify a full filename
for "src" if you encounter problems.
* phpThumb() should work with PHP v4.0.6+, but seems to
have a few quirks before v4.1.0
EXIF thumbnail extraction requires PHP v4.2.0+
Image rotation requires PHP v4.3.0+. There have been
reports of problems with PHP older than v4.3.3
Partial transparency for overlays requires PHP v4.3.2+
Some image filters require PHP v5.0.0+
Run /demo/phpThumb.demo.check.php to examine your server
* phpThumb() works better and faster when ImageMagick is
available. Most functions will work with only GD2, but
speed is much faster with ImageMagick, and much larger
images can be processed with ImageMagick than GD.
* phpThumb() works with GD v1.x, but works better with
GD v2.0+ because of the true-color image support
and ImageCopyResampled(). Also, there appears to be a
bug in ImageCopyResized() which is used with GD v1.x
where the bottom and/or right line of pixels is set
to the background color (due to a rounding error?)
NOTE: Please use the bundled version of GD if at all
possible (with PHP v4.3.0+) because the non-bundled
version has bugs which may cause PHP to crash:
* http://bugs.php.net/bug.php?id=21518
* http://bugs.php.net/bug.php?id=24174
phpThumb() has a workaround for the above bug but
there may be other bugs, and the workaround is slow.
Alpha transparent output requires GD >= 2.0.1 and
PHP >= 4.3.2
Most (if not all) filters require GD v2.x to function
at all. But many filters can be handled by ImageMagick
instead of GD.
* Filters handled by ImageMagick or GD:
- brit;cont;ds;sat;gray;clr;sep;gam;neg;th;rcd;flip;edge;
emb;lvl;blur;gblr;usm;wb;
* Filters handled only by ImageMagick:
- none yet
* Filters handled only by GD + PHP5:
- sblr;mean;smth;
* Filters handled only by GD2:
- bvl;wmi;wmt;over;hist;fram;drop;mask;elip;ric;bord;
* Some browsers, notably Internet Explorer (before v7.0),
have problems with PNG transparency. See description:
http://www.silisoftware.com/png_alpha_transparency/
http://trific.ath.cx/web/png/
There are some work-around fixes for this IE problem, eg:
http://www.twinhelix.com/css/iepngfix/demo/
===============
Thanks & Links:
===============
* Original image used in phpThumb logo provided by
Mark James: http://www.famfamfam.com/lab/icons/
========================================
== phpThumb Commercial License (pTCL) ==
========================================
See /docs/phpthumb.license.commercial.txt
for details on the terms of the license.
Current list of pTCL licensees:
(updated list at http://www.phpthumb.com/)
1) Accomplish Hosting, LLC
http://www.accomplishhosting.com
effective 2007-Apr-28 (lifetime license)
2) Eric Pujol
http://www.kaprikorn.fr/
effective 2007-Sep-29 (lifetime license)
3) CalemEAM Inc.
http://www.calemeam.com/
effective 2010-Jun-14 (lifetime license)