changed git call from https to git readonly
[atutor.git] / mods / photo_album / classes / phpThumb_1.7.2 / phpThumb.config.php.default
1 <?php
2 //////////////////////////////////////////////////////////////
3 ///  phpThumb() by James Heinrich <info@silisoftware.com>   //
4 //        available at http://phpthumb.sourceforge.net     ///
5 //////////////////////////////////////////////////////////////
6 ///                                                         //
7 // See: phpthumb.readme.txt for usage instructions          //
8 //                                                         ///
9 //////////////////////////////////////////////////////////////
10
11 ob_start();
12 if (!file_exists(dirname(__FILE__).'/phpthumb.functions.php') || !include_once(dirname(__FILE__).'/phpthumb.functions.php')) {
13         ob_end_flush();
14         die('failed to include_once(phpthumb.functions.php) - realpath="'.realpath(dirname(__FILE__).'/phpthumb.functions.php').'"');
15 }
16 ob_end_clean();
17
18 // START USER CONFIGURATION SECTION:
19
20 // * DocumentRoot configuration
21 // phpThumb() depends on $_SERVER['DOCUMENT_ROOT'] to resolve path/filenames. This value is usually correct,
22 // but has been known to be broken on some servers. This value allows you to override the default value.
23 // Do not modify from the auto-detect default value unless you are having problems.
24 //$PHPTHUMB_CONFIG['document_root'] = '/home/httpd/httpdocs';
25 //$PHPTHUMB_CONFIG['document_root'] = 'c:\\webroot\\example.com\\www';
26 //$PHPTHUMB_CONFIG['document_root'] = $_SERVER['DOCUMENT_ROOT'];
27 //$PHPTHUMB_CONFIG['document_root'] = realpath((@$_SERVER['DOCUMENT_ROOT'] && file_exists(@$_SERVER['DOCUMENT_ROOT'].$_SERVER['PHP_SELF'])) ? $_SERVER['DOCUMENT_ROOT'] : str_replace(dirname(@$_SERVER['PHP_SELF']), '', str_replace(DIRECTORY_SEPARATOR, '/', realpath('.'))));
28 $PHPTHUMB_CONFIG['document_root'] = realpath((getenv('DOCUMENT_ROOT') && ereg('^'.preg_quote(realpath(getenv('DOCUMENT_ROOT'))), realpath(__FILE__))) ? getenv('DOCUMENT_ROOT') : str_replace(dirname(@$_SERVER['PHP_SELF']), '', str_replace(DIRECTORY_SEPARATOR, '/', dirname(__FILE__))));
29
30 // * Cache directory configuration (choose only one of these - leave the other lines commented-out):
31 // Note: this directory must be writable (usually chmod 777 is neccesary) for caching to work.
32 // If the directory is not writable no error will be generated but caching will be disabled.
33 $PHPTHUMB_CONFIG['cache_directory'] = dirname(__FILE__).'/cache/';                            // set the cache directory relative to the phpThumb() installation
34 //$PHPTHUMB_CONFIG['cache_directory'] = $PHPTHUMB_CONFIG['document_root'].'/phpthumb/cache/'; // set the cache directory to an absolute directory for all source images
35 //$PHPTHUMB_CONFIG['cache_directory'] = './cache/';                                           // set the cache directory relative to the source image - must start with '.' (will not work to cache URL- or database-sourced images, please use an absolute directory name)
36 //$PHPTHUMB_CONFIG['cache_directory'] = null;                                                 // disable thumbnail caching (not recommended)
37
38 $PHPTHUMB_CONFIG['cache_disable_warning'] = false; // If [cache_directory] is non-existant or not writable, and [cache_disable_warning] is false, an error image will be generated warning to either set the cache directory or disable the warning (to avoid people not knowing about the cache)
39
40
41 // * Cache culling: phpThumb can automatically limit the contents of the cache directory
42 //   based on last-access date and/or number of files and/or total filesize.
43
44 //$PHPTHUMB_CONFIG['cache_maxage'] = null;            // never delete cached thumbnails based on last-access time
45 $PHPTHUMB_CONFIG['cache_maxage'] = 86400 * 90;        // delete cached thumbnails that haven't been accessed in more than [90 days] (value is maximum time since last access in seconds to avoid deletion)
46
47 //$PHPTHUMB_CONFIG['cache_maxsize'] = null;           // never delete cached thumbnails based on byte size of cache directory
48 $PHPTHUMB_CONFIG['cache_maxsize'] = 10 * 1024 * 1024; // delete least-recently-accessed cached thumbnails when more than [10MB] of cached files are present (value is maximum bytesize of all cached files)
49
50 //$PHPTHUMB_CONFIG['cache_maxfiles'] = null;          // never delete cached thumbnails based on number of cached files
51 $PHPTHUMB_CONFIG['cache_maxfiles'] = 500;             // delete least-recently-accessed cached thumbnails when more than [500] cached files are present (value is maximum number of cached files to keep)
52
53
54 // * Source image cache configuration
55 $PHPTHUMB_CONFIG['cache_source_enabled']   = false;                               // if true, source images obtained via HTTP are cached to $PHPTHUMB_CONFIG['cache_source_directory']
56 $PHPTHUMB_CONFIG['cache_source_directory'] = dirname(__FILE__).'/cache/source/';  // set the cache directory for unprocessed source images
57
58 // * cache source modification date configuration
59 $PHPTHUMB_CONFIG['cache_source_filemtime_ignore_local']  = false; // if true, local 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
60 $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. WARNING: cached performance MUCH slower if this is set to false.
61
62
63 // * Simplified cache filename configuration
64 // Instead of creating unique cache filenames for all parameter combinations, create "simple" cache files (eg: "pic_thumb.jpg")
65 // If cache_default_only_suffix is non-empty, GETstring parameters (except 'src') are ignored and only $PHPTHUMB_DEFAULTS
66 // parameters (set at the bottom of phpThumb.config.php) are used for processing.
67 // The '*' character MUST be used to represent the source image name
68 $PHPTHUMB_CONFIG['cache_default_only_suffix'] = '';           // cached in normal phpThumb manner
69 //$PHPTHUMB_CONFIG['cache_default_only_suffix'] = '*_thumb';  // cache 'pic.jpg' becomes 'pic_thumb.jpg' (or 'pic_thumb.png' if PNG output is selected, etc)
70 //$PHPTHUMB_CONFIG['cache_default_only_suffix'] = 'small-*';  // cache 'pic.jpg' becomes 'small-pic.jpg' (or 'small-pic.png' if PNG output is selected, etc)
71
72 $PHPTHUMB_CONFIG['cache_prefix'] = 'phpThumb_cache_'.str_replace('www.', '', @$_SERVER['SERVER_NAME']);
73 //$PHPTHUMB_CONFIG['cache_prefix'] = 'phpThumb_cache';                         // allow phpThumb to share 1 set of cached files even if accessed under different servername/domains on same server
74
75 $PHPTHUMB_CONFIG['cache_force_passthru'] = true;  // if true, cached image data will always be passed to browser; if false, HTTP redirect will be used instead
76
77
78
79 // * Temp directory configuration
80 // phpThumb() may need to create temp files. Usually the system temp dir is writable and can be used.
81 // Leave this value as NULL in most cases. If you get errors about "failed to open <filename> for writing"
82 // you should change this to a full pathname to a directory you do have write access to.
83 //$PHPTHUMB_CONFIG['temp_directory'] = '/tmp/';
84 $PHPTHUMB_CONFIG['temp_directory'] = null;
85
86
87 // maximum number of pixels in source image to attempt to process entire image.
88 // If this is zero then no limit on source image dimensions.
89 // If this is nonzero then this is the maximum number of pixels the source image
90 // can have to be processed normally, otherwise the embedded EXIF thumbnail will
91 // be used (if available) or an "image too large" notice will be displayed.
92 // This is to be used for large source images (> 1600x1200) and low PHP memory
93 // limits. If PHP runs out of memory the script will usually just die with no output.
94 // To calculate this number, multiply the dimensions of the largest image
95 // you can process with your memory limitation (e.g. 1600 * 1200 = 1920000)
96 // As a general guideline, this number will be about 20% of your PHP memory
97 // configuration, so 8M = 1,677,722; 16M = 3,355,443; 32M = 6,710,886; etc.
98 if (phpthumb_functions::version_compare_replacement(phpversion(), '4.3.2', '>=') && !defined('memory_get_usage') && !@ini_get('memory_limit')) {
99         // memory_get_usage() will only be defined if your PHP is compiled with the --enable-memory-limit configuration option.
100         $PHPTHUMB_CONFIG['max_source_pixels'] = 0;         // no memory limit
101 } else {
102         // calculate default max_source_pixels as 20% of memory limit configuration
103         $PHPTHUMB_CONFIG['max_source_pixels'] = round(max(intval(ini_get('memory_limit')), intval(get_cfg_var('memory_limit'))) * 1048576 * 0.20);
104         //$PHPTHUMB_CONFIG['max_source_pixels'] = 0;       // no memory limit
105         //$PHPTHUMB_CONFIG['max_source_pixels'] = 1920000; // allow 1600x1200 images (2Mpx), no larger (about 10MB memory required)
106         //$PHPTHUMB_CONFIG['max_source_pixels'] = 3355443; // 16MB memory limit
107         //$PHPTHUMB_CONFIG['max_source_pixels'] = 3871488; // allow 2272x1704 images (4Mpx), no larger (about 16MB memory required)
108 }
109
110
111 // ImageMagick configuration
112 // If source image is larger than available memory limits as defined above in
113 // 'max_source_pixels' AND ImageMagick's "convert" program is available, phpThumb()
114 // will call ImageMagick to perform the thumbnailing of the source image to bypass
115 // the memory limitation. Leaving the value as NULL will cause phpThumb() to
116 // attempt to detect ImageMagick's presence with `which`
117 if (strtoupper(substr(PHP_OS, 0, 3)) == 'WIN') {
118         // Windows: set absolute pathname
119         $PHPTHUMB_CONFIG['imagemagick_path'] = 'C:/Program Files/ImageMagick-6.2.5-Q16/convert.exe';
120 } else {
121         // *nix: set absolute pathname to "convert", or leave as null if "convert" is in the path
122         //$PHPTHUMB_CONFIG['imagemagick_path'] = '/usr/local/bin/convert';
123         $PHPTHUMB_CONFIG['imagemagick_path'] = null;
124 }
125
126
127 // * Default output configuration:
128 $PHPTHUMB_CONFIG['output_format']    = 'jpeg'; // default output format ('jpeg', 'png' or 'gif') - thumbnail will be output in this format (if available in your version of GD). This is always overridden by ?f=___ GETstring parameter
129 $PHPTHUMB_CONFIG['output_maxwidth']  = 0;      // default maximum thumbnail width.  If this is zero then default width  is the width  of the source image. This is always overridden by ?w=___ GETstring parameter
130 $PHPTHUMB_CONFIG['output_maxheight'] = 0;      // default maximum thumbnail height. If this is zero then default height is the height of the source image. This is always overridden by ?h=___ GETstring parameter
131 $PHPTHUMB_CONFIG['output_interlace'] = true;   // if true: interlaced output for GIF/PNG, progressive output for JPEG; if false: non-interlaced for GIF/PNG, baseline for JPEG.
132
133 // * Error message configuration
134 $PHPTHUMB_CONFIG['error_image_width']           = 400;      // default width for error images
135 $PHPTHUMB_CONFIG['error_image_height']          = 100;      // default height for error images
136 $PHPTHUMB_CONFIG['error_message_image_default'] = '';       // Set this to the name of a generic error image (e.g. '/images/error.png') that you want displayed in place of any error message that may occur. This setting is overridden by the 'err' parameter, which does the same thing.
137 $PHPTHUMB_CONFIG['error_bgcolor']               = 'CCCCFF'; // background color of error message images
138 $PHPTHUMB_CONFIG['error_textcolor']             = 'FF0000'; // color of text in error messages
139 $PHPTHUMB_CONFIG['error_fontsize']              = 1;        // size of text in error messages, from 1 (smallest) to 5 (largest)
140 $PHPTHUMB_CONFIG['error_die_on_error']          = true;     // die with error message on any fatal error (recommended with standalone phpThumb.php)
141 $PHPTHUMB_CONFIG['error_silent_die_on_error']   = false;    // simply die with no output of any kind on fatal errors (not recommended)
142 $PHPTHUMB_CONFIG['error_die_on_source_failure'] = true;     // die with error message if source image cannot be processed by phpThumb() (usually because source image is corrupt in some way). If false the source image will be passed through unprocessed, if true (default) an error message will be displayed.
143
144 // * Off-server Thumbnailing Configuration:
145 $PHPTHUMB_CONFIG['nohotlink_enabled']           = true;                                     // If false will allow thumbnailing from any source domain
146 $PHPTHUMB_CONFIG['nohotlink_valid_domains']     = array(@$_SERVER['HTTP_HOST']);            // This is the list of domains for which thumbnails are allowed to be created. The default value of the current domain should be fine in most cases, but if neccesary you can add more domains in here, in the format 'www.example.com'
147 $PHPTHUMB_CONFIG['nohotlink_erase_image']       = true;                                     // if true thumbnail is covered up with $PHPTHUMB_CONFIG['nohotlink_fill_color'] before text is applied, if false text is written over top of thumbnail
148 $PHPTHUMB_CONFIG['nohotlink_text_message']      = 'Off-server thumbnailing is not allowed'; // text of error message
149
150 // * Off-server Linking Configuration:
151 $PHPTHUMB_CONFIG['nooffsitelink_enabled']       = true;                                       // If false will allow thumbnails to be linked to from any domain, if true only domains listed below in 'nooffsitelink_valid_domains' will be allowed.
152 $PHPTHUMB_CONFIG['nooffsitelink_valid_domains'] = array(@$_SERVER['HTTP_HOST']);              // This is the list of domains for which thumbnails are allowed to be created. The default value of the current domain should be fine in most cases, but if neccesary you can add more domains in here, in the format 'www.example.com'
153 $PHPTHUMB_CONFIG['nooffsitelink_require_refer'] = false;                                      // If false will allow standalone calls to phpThumb(). If true then only requests with a $_SERVER['HTTP_REFERER'] value in 'nooffsitelink_valid_domains' are allowed.
154 $PHPTHUMB_CONFIG['nooffsitelink_erase_image']   = true;                                       // if true thumbnail is covered up with $PHPTHUMB_CONFIG['nohotlink_fill_color'] before text is applied, if false text is written over top of thumbnail
155 $PHPTHUMB_CONFIG['nooffsitelink_text_message']  = 'Image taken from '.@$_SERVER['HTTP_HOST']; // text of error message
156
157
158 // * Border & Background default colors
159 $PHPTHUMB_CONFIG['border_hexcolor']     = '000000'; // Default border color - usual HTML-style hex color notation (overidden with 'bc' parameter)
160 $PHPTHUMB_CONFIG['background_hexcolor'] = 'FFFFFF'; // Default background color when thumbnail aspect ratio does not match fixed-dimension box - usual HTML-style hex color notation (overridden with 'bg' parameter)
161
162 // * Watermark configuration
163 $PHPTHUMB_CONFIG['ttf_directory'] = dirname(__FILE__).'/fonts'; // Base directory for TTF font files
164 //$PHPTHUMB_CONFIG['ttf_directory'] = 'c:/windows/fonts';
165
166
167 // * MySQL configuration
168 // You may want to pull data from a database rather than a physical file
169 // If so, modify the $PHPTHUMB_CONFIG['mysql_query'] line to suit your database structure
170 // Note: the data retrieved must be the actual binary data of the image, not a URL or filename
171 // see http://www.billy-corgan.com/blog/archive/000143.php for a brief tutorial on this section
172
173 $PHPTHUMB_CONFIG['mysql_query'] = '';
174 //$PHPTHUMB_CONFIG['mysql_query'] = 'SELECT `picture` FROM `products` WHERE (`id` = \''.mysql_escape_string(@$_GET['id']).'\')';
175
176 // These 4 values must be modified if $PHPTHUMB_CONFIG['mysql_query'] is not empty, but may be ignored if $PHPTHUMB_CONFIG['mysql_query'] is blank.
177 $PHPTHUMB_CONFIG['mysql_hostname'] = 'localhost';
178 $PHPTHUMB_CONFIG['mysql_username'] = '';
179 $PHPTHUMB_CONFIG['mysql_password'] = '';
180 $PHPTHUMB_CONFIG['mysql_database'] = '';
181
182
183 // * Security configuration
184 $PHPTHUMB_CONFIG['high_security_enabled']    = false;  // if enabled, requires 'high_security_password' set to at least 5 characters, and requires the use of phpThumbURL() function (at the bottom of phpThumb.config.php) to generate hashed URLs
185 $PHPTHUMB_CONFIG['high_security_password']   = '';     // required if 'high_security_enabled' is true, must be at least 5 characters long
186 $PHPTHUMB_CONFIG['disable_debug']            = false;  // prevent phpThumb from displaying any information about your system. If true, phpThumbDebug and error messages will be disabled
187 $PHPTHUMB_CONFIG['allow_src_above_docroot']  = false;  // if true, allow src to be anywhere in filesystem; if false (default) only allow src within document_root
188 $PHPTHUMB_CONFIG['allow_src_above_phpthumb'] = true;   // if true (default), allow src to be anywhere in filesystem; if false only allow src within sub-directory of phpThumb installation
189 $PHPTHUMB_CONFIG['allow_parameter_file']     = false;  // if true, allow use of 'file' parameter; if false (default) the 'file' parameter is disabled/ignored
190 $PHPTHUMB_CONFIG['allow_parameter_goto']     = false;  // if true, allow use of 'goto' parameter; if false (default) the 'goto' parameter is disabled/ignored
191
192
193 // * HTTP UserAgent configuration
194 //$PHPTHUMB_CONFIG['http_user_agent'] = '';                                                                                      // PHP default: none
195 //$PHPTHUMB_CONFIG['http_user_agent'] = 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)';                                    // Windows XP, Internet Explorer
196 $PHPTHUMB_CONFIG['http_user_agent'] = 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.12) Gecko/20050915 Firefox/1.0.7'; // Windows XP, Firefox
197
198
199 // * Compatability settings
200 $PHPTHUMB_CONFIG['disable_pathinfo_parsing']        = false;  // if true, $_SERVER[PATH_INFO] is not parsed. May be needed on some server configurations to allow normal behavior.
201 $PHPTHUMB_CONFIG['disable_imagecopyresampled']      = false;  // if true, ImageCopyResampled is replaced with ImageCopyResampleBicubic. May be needed for buggy versions of PHP-GD.
202 $PHPTHUMB_CONFIG['disable_onlycreateable_passthru'] = true;   // if true, any image that can be parsed by GetImageSize() can be passed through; if false, only images that can be converted to GD by ImageCreateFrom(JPEG|GIF|PNG) functions are allowed
203
204
205 // * Speed optimizations configuration
206 $PHPTHUMB_CONFIG['prefer_imagemagick']           = true;  // If true, use ImageMagick to resize thumbnails if possible, since it is usually faster than GD functions; if false only use ImageMagick if PHP memory limit is too low.
207 $PHPTHUMB_CONFIG['use_exif_thumbnail_for_speed'] = false; // If true, and EXIF thumbnail is available, and is larger or equal to output image dimensions, use EXIF thumbnail rather than actual source image for generating thumbnail. Benefit is only speed, avoiding resizing large image.
208 $PHPTHUMB_CONFIG['allow_local_http_src']         = false; // If true, 'src' parameter can be "http://<thishostname>/path/image.ext" instead of just "/path/image.ext"; if false then display warning message to encourage more efficient local-filename calling.
209
210 // END USER CONFIGURATION SECTION
211
212 ///////////////////////////////////////////////////////////////////////////////
213
214 // START DEFAULT PARAMETERS SECTION
215 // If any parameters are constant across ALL images, you can set them here
216
217 $PHPTHUMB_DEFAULTS_GETSTRINGOVERRIDE = true;  // if true, any parameters in the URL will override the defaults set here; if false, any parameters set here cannot be overridden in the URL
218 $PHPTHUMB_DEFAULTS_DISABLEGETPARAMS  = false; // if true, GETstring parameters will be ignored (except for 'src') and only below default parameters will be used; if false, both default and GETstring parameters will be used (depending on $PHPTHUMB_DEFAULTS_GETSTRINGOVERRIDE). Will be auto-set true if !empty($PHPTHUMB_CONFIG['cache_default_only_suffix'])
219
220 //$PHPTHUMB_DEFAULTS['w']    = 100;
221 //$PHPTHUMB_DEFAULTS['fltr'] = array('blur|10');
222 //$PHPTHUMB_DEFAULTS['q']    =  90;
223
224
225 // END DEFAULT PARAMETERS SECTION
226
227
228
229 ///////////////////////////////////////////////////////////////////////////////
230 // Function for generating hashed calls to phpThumb if 'high_security_enabled'
231 // example:
232 //   require_once('phpThumb.config.php');
233 //   echo '<img src="'.phpThumbURL('src=pic.jpg&w=50').'">';
234
235 function phpThumbURL($ParameterString) {
236         global $PHPTHUMB_CONFIG;
237         return str_replace(@$PHPTHUMB_CONFIG['document_root'], '', dirname(__FILE__)).DIRECTORY_SEPARATOR.'phpThumb.php?'.$ParameterString.'&hash='.md5($ParameterString.@$PHPTHUMB_CONFIG['high_security_password']);
238 }
239
240 ///////////////////////////////////////////////////////////////////////////////
241
242 ?>