home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 March / PCWorld_2003-03_cd.bin / Software / Vyzkuste / phptriad / phptriad2-2-1.exe / php / pear / Cache / Graphics.php < prev    next >
Encoding:
PHP Script  |  2001-11-13  |  12.7 KB  |  351 lines
  1. <?php
  2. // +----------------------------------------------------------------------+
  3. // | PHP version 4.0                                                      |
  4. // +----------------------------------------------------------------------+
  5. // | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group             |
  6. // +----------------------------------------------------------------------+
  7. // | This source file is subject to version 2.0 of the PHP license,       |
  8. // | that is bundled with this package in the file LICENSE, and is        |
  9. // | available at through the world-wide-web at                           |
  10. // | http://www.php.net/license/2_02.txt.                                 |
  11. // | If you did not receive a copy of the PHP license and are unable to   |
  12. // | obtain it through the world-wide-web, please send a note to          |
  13. // | license@php.net so we can mail you a copy immediately.               |
  14. // +----------------------------------------------------------------------+
  15. // | Authors: Ulf Wendel <ulf.wendel@phpdoc.de>                           |
  16. // +----------------------------------------------------------------------+
  17. //
  18. // $Id: Graphics.php,v 1.7.2.3 2001/11/13 01:26:40 ssb Exp $
  19.  
  20. require_once 'Cache.php';
  21.  
  22. /**
  23. * Graphics disk cache.
  24. * 
  25. * The usual way to create images is to pass some arguments that describe the image 
  26. * to a script that dynamically creates an image. For every image of a page 
  27. * a new PHP interpreter gets started. This is a good way to kill your webserver.
  28. * 
  29. * When dealing with dynamically generated images you should not call another script 
  30. * to generate the images but generate the images by the script that produces the page
  31. * that contains the images. This is a major improvement but it's only half the way.
  32. * 
  33. * There's no need to rerender an image on every request. A simple disk cache can reduce
  34. * the computation time dramatically. This is what the class graphics_cache is for. 
  35. * 
  36. * Usage:
  37. * 
  38. * // create an instance of the graphics cache
  39. * $cache = new graphics_cache;
  40. *
  41. * $img = ImageCreate(...);
  42. *
  43. * // compute an ID for your image based on typical parameters
  44. * $id = m5d( $size, $colors, $label);
  45. * 
  46. * // check if it's cached
  47. * if (!($link = $cache->getImageLink($id, 'gif'))) {
  48. *  
  49. *   // hmmm, it's not cached, create it
  50. *   ...
  51. *   // cacheImageLink() and cacheImage() make the ImageGIF() call!
  52. *   // cacheImage() returns the value of ImageGIF() [etc.], cacheImageLink() returns a URL
  53. *   $link = $cache->cacheImageLink($id, $img, 'gif');
  54. * 
  55. * }
  56. *
  57. * // Ok, let's build the ImageLink
  58. * $size = getImageSize($link[0]);
  59. * printf('<img src="%s" %s>', $link[1], $size[3]);
  60. *
  61. * // for cacheImage():
  62. * // header('Content-type: image/gif'); print $cache->cacheImage($id, $img, 'gif');
  63. * 
  64. *
  65. * The class requires PHP 4.0.2+ [ImageType()]. Note that cacheImage() works with
  66. * the output buffer. Modify it if required!
  67. *
  68. * @author   Ulf Wendel <ulf.wendel@phpdoc.de>
  69. * @version  $Id: Graphics.php,v 1.7.2.3 2001/11/13 01:26:40 ssb Exp $
  70. * @package  Cache
  71. */
  72. class Cache_Graphics extends Cache {
  73.  
  74.  
  75.     /**
  76.     * Cache URL prefix.
  77.     * 
  78.     * Make sure that the cache URL prefix points to the $cache_dir, otherwise
  79.     * your links will be broken. Use setCacheURL to specify the cache_url and 
  80.     * setCacheDir() for the cache_dir.
  81.     * 
  82.     * @var  string
  83.     * @see  setCacheURL(), setCacheDir()
  84.     */
  85.     var $cache_url = '';
  86.  
  87.     /**
  88.     * Directory where cached files get stored.
  89.     * s
  90.     * Make sure that the cache_dir is writable and offers enough space. Check 
  91.     * also if your cache_url points to the directory. Use setCacheDir() to set
  92.     * the variable.
  93.     * 
  94.     * @var  string
  95.     * @see  setCacheDir(), setCacheURL()
  96.     */
  97.     var $cache_dir = '';
  98.  
  99.     /**
  100.     * Nameprefix of cached files.
  101.     * 
  102.     * Per default the prefix "graphics_" gets used. You might use this 
  103.     * for versioning or to ease (manual) clean ups.
  104.     *
  105.     * @var      string
  106.     */
  107.     var $cache_file_prefix = 'graphics_';
  108.     
  109.     
  110.     /**
  111.     * Cache container group.
  112.     *
  113.     * @var      string
  114.     */
  115.     var $cache_group = 'graphics';
  116.  
  117.     
  118.     /**
  119.     * Mapping from supported image type to a ImageType() constant.
  120.     * 
  121.     * Referr to the PHP manual for more informations on ImageType()
  122.     * 
  123.     * @var  array
  124.     * @link http://www.php.net/ImageType
  125.     */
  126.     var $imagetypes = array(
  127.                                 'gif'   => IMG_GIF, 
  128.                                 'jpg'   => IMG_JPG,
  129.                                 'png'   => IMG_PNG,
  130.                                 'wbmp'  => IMG_WBMP
  131.                             );
  132.  
  133.                             
  134.     /**
  135.     * Instantiates a cache file container.
  136.     *
  137.     */
  138.     function Cache_Graphics() {
  139.     
  140.         $this->Cache('file', array('cache_dir' => $this->cache_dir, 'filename_prefix' => $this->cache_file_prefix));
  141.         
  142.     } // end constructor
  143.  
  144.     
  145.     /**
  146.     * Returns the content of a cached image file.
  147.     * 
  148.     * This function can be used to send the image directly to the browser.
  149.     * Make sure that you send a correspondending header before sending the image itself.
  150.     *
  151.     * Always try to get the image from the cache before you compute it. See 
  152.     * the class docs for an example.
  153.     *
  154.     * @param    string  Image-ID
  155.     * @param    string  Image type: gif, jpg, png, wbmp
  156.     * @return   string  Image file contents if a cached file exists otherwise an empty string
  157.     * @see      cacheImage()
  158.     */                                    
  159.     function getImage($id, $format = 'png') {
  160.         $id = $this->generateID(array('id' => $id, 'format' => strtolower($format)));
  161.         
  162.         return $this->get($id, $this->cache_group);
  163.     } // end func getImage
  164.  
  165.     
  166.     /**
  167.     * Returns an array with a link to the cached image and the image file path.
  168.     * 
  169.     * Always try to get the image from the cache before you compute it. See 
  170.     * the class docs for an example.
  171.     *
  172.     * @param    string  Image-ID
  173.     * @param    string  Image type: gif, jpg, png, wbmp
  174.     * @return   array   [ full path to the image file, image url ]
  175.     * @throw    Cache_Error
  176.     * @see      cacheImageLink()
  177.     */
  178.     function getImageLink($id, $format = 'png') {
  179.         $id = $this->generateID(array('id' => $id, 'format' => strtolower($format)));
  180.         if (!$this->container->idExists($id, $this->cache_group)) 
  181.             return array();
  182.  
  183.         $file = $this->cache_url . $this->cache_file_prefix . $id;
  184.  
  185.         return array($this->container->getFilename($id, $this->cache_group), $file);
  186.     } // end func getImageLink
  187.     
  188.  
  189.     /**
  190.     * Create an image from the given image handler, cache it and return the file content.
  191.     *
  192.     * Always try to retrive the image from the cache before you compute it.
  193.     * 
  194.     * Warning: this function uses the output buffer. If you expect collisions 
  195.     * modify the code.
  196.     *
  197.     * @param    string  Image-ID. Used as a part of the cache filename.
  198.     *                   Use md5() to generate a "unique" ID for your image
  199.     *                   based on characteristic values such as the color, size etc.
  200.     * @param    string  Image handler to create the image from.
  201.     * @param    string  Image type: gif, jpg, png, wbmp. Also used as filename suffix.
  202.     *                   If an unsupported type is requested the functions tries to 
  203.     *                   fallback to a supported type before throwing an exeption.
  204.     * @return   string  Image content returned by ImageGIF/... 
  205.     * @throws   Cache_Error
  206.     * @access   public
  207.     * @see      getImage()
  208.     */
  209.     function cacheImage($id, $img, $format = 'png') {
  210.         if (!$id)
  211.             return new Cache_Error('You must provide an ID for and image to be cached!', __FILE__, __LINE__);
  212.  
  213.         $id = $this->generateID(array('id' => $id, 'format' => strtolower($format)));
  214.  
  215.         $types = ImageTypes();
  216.  
  217.         // Check if the requested image type is supported by the GD lib.
  218.         // If not, try a callback to the first available image type.
  219.         if (!isset($this->imagetypes[$format]) || !($types & $this->imagetypes[$format])) {
  220.             foreach ($this->imagetypes as $supported => $bitmask) {
  221.                 if ($types & $bitmask) {
  222.                     new Cache_Error("The build in GD lib does not support the image type $format. Fallback to $supported.", __FILE__, __LINE__);
  223.                 } else {
  224.                     return new Cache_Error("Hmm, is your PHP build with GD support? Can't find any supported types.", __FILE__, __LINE__);
  225.                 }
  226.             }
  227.         }
  228.  
  229.         if ($image = $this->get($id, $this->cache_group))
  230.             return $image;
  231.  
  232.         // save the image to the output buffer, write it to disk and 
  233.         // return the image.
  234.         ob_end_clean();
  235.         ob_start(); 
  236.  
  237.         if (strtoupper($format) == "JPG") {
  238.             $genFormat = "JPEG";
  239.         } else {
  240.             $genFormat = strtoupper($format);
  241.         }
  242.  
  243.         // generate the image
  244.         $func = 'Image' . $genFormat;
  245.         $func($img);
  246.         ImageDestroy($img);
  247.  
  248.         ob_end();
  249.         $image = ob_get_contents();
  250.         ob_end_clean();
  251.  
  252.         // save the generated image to disk
  253.         $this->save($id, $image, 0, $this->cache_group);
  254.  
  255.         return $image;
  256.     } // end func cacheImage
  257.     
  258.  
  259.     /**
  260.     * Create an image from the given image handler, cache it and return a url and the file path of the image.
  261.     *
  262.     * Always try to retrive the image from the cache before you compute it.
  263.     *
  264.     * @param    string  Image-ID. Used as a part of the cache filename.
  265.     *                   Use md5() to generate a "unique" ID for your image
  266.     *                   based on characteristic values such as the color, size etc.
  267.     * @param    string  Image handler to create the image from.
  268.     * @param    string  Image type: gif, jpg, png, wbmp. Also used as filename suffix.
  269.     *                   If an unsupported type is requested the functions tries to 
  270.     *                   fallback to a supported type before throwing an exeption.
  271.     * @return   array  [ full path to the image file, image url ]
  272.     * @throws   Cache_Error
  273.     * @access   public
  274.     */
  275.     function cacheImageLink($id, &$img, $format = 'png') {
  276.         if (!$id)
  277.             return new Cache_Error ('You must provide an ID for and image to be cached!', __FILE__, __LINE__);
  278.  
  279.         $id = $this->generateID( array('id' => $id, 'format' => strtolower($format)) );
  280.  
  281.         $types = ImageTypes();
  282.  
  283.         // Check if the requested image type is supported by the GD lib.
  284.         // If not, try a callback to the first available image type.
  285.         if (!isset($this->imagetypes[$format]) || !($types & $this->imagetypes[$format])) {
  286.             foreach ($this->imagetypes as $supported => $bitmask) 
  287.                 if ($types & $bitmask)
  288.                     new Cache_Error("The build in GD lib does not support the image type $format. Fallback to $supported.", __FILE__, __LINE__);
  289.                 else
  290.                     return new Cache_Error("Hmm, is your PHP build with GD support? Can't find any supported types.", __FILE__, __LINE__);
  291.         }
  292.  
  293.         $url = $this->cache_url . $this->cache_file_prefix . $id;
  294.         $ffile = $this->container->getFilename($id, $this->cache_group);
  295.  
  296.         if ($this->isCached($id, $this->cache_group) && !isExpired($id, $this->cache_group))
  297.             return array($ffile, $url);
  298.  
  299.         if (strtoupper($format) == "JPG") {
  300.             $genFormat = "JPEG";
  301.         } else {
  302.             $genFormat = strtoupper($format);
  303.         }
  304.  
  305.         $func = 'Image' . $genFormat;
  306.         $func($img, $ffile);
  307.  
  308.         ImageDestroy($img);
  309.  
  310.         return array($ffile, $url);
  311.     } // end func cacheImageLink
  312.  
  313.     
  314.     /**
  315.     * Sets the URL prefix used when rendering HTML Tags. 
  316.     * 
  317.     * Make sure that the URL matches the cache directory, 
  318.     * otherwise you'll get broken links.
  319.     * 
  320.     * @param    string
  321.     * @access   public
  322.     * @see      setCacheDir()
  323.     */
  324.     function setCacheURL($cache_url) {
  325.         if ($cache_url && '/' != substr($cache_url, 1)) 
  326.             $cache_url .= '/';
  327.             
  328.         $this->cache_url = $cache_url;
  329.         
  330.     } // end func setCacheURL
  331.  
  332.     
  333.     /**
  334.     * Sets the directory where to cache generated Images
  335.     * 
  336.     * @param    string
  337.     * @access   public
  338.     * @see      setCacheURL()
  339.     */
  340.     function setCacheDir($cache_dir) {
  341.         if ($cache_dir && '/' != substr($cache_dir, 1))
  342.             $cache_dir .= '/';
  343.  
  344.         $this->cache_dir = $cache_dir;
  345.         $this->container->cache_dir = $cache_dir;
  346.     } // end func setCacheDir
  347.     
  348.     
  349. } // end class Cache_Graphics
  350. ?>
  351.