home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Web Server / PHP.EXE / pear / Cache / Container / phplib.php < prev    next >
Encoding:
PHP Script  |  2001-03-09  |  7.9 KB  |  223 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. // |          Sebastian Bergmann <sb@sebastian-bergmann.de>               |
  17. // +----------------------------------------------------------------------+
  18. //
  19. // $Id: phplib.php,v 1.10 2001/03/08 20:39:16 uw Exp $
  20.  
  21. require_once 'Cache/Container.php';
  22.  
  23. /**
  24. * Stores cache data into a database table using PHPLibs DB abstraction.
  25. *
  26. * WARNING: Other systems might or might not support certain datatypes of 
  27. * the tables shown. As far as I know there's no large binary 
  28. * type in SQL-92 or SQL-99. Postgres seems to lack any 
  29. * BLOB or TEXT type, for MS-SQL you could use IMAGE, don't know 
  30. * about other databases. Please add sugestions for other databases to 
  31. * the inline docs.
  32. *
  33. * The field 'changed' has no meaning for the Cache itself. It's just there 
  34. * because it's a good idea to have an automatically updated timestamp
  35. * field for debugging in all of your tables.
  36. *
  37. * For _MySQL_ you need this DB table:
  38. *
  39. * CREATE TABLE cache (
  40. *   id          CHAR(32) NOT NULL DEFAULT '',
  41. *   cachegroup  VARCHAR(127) NOT NULL DEFAULT '',
  42. *   cachedata   BLOB NOT NULL DEFAULT '',
  43. *   userdata    VARCHAR(255) NOT NULL DEFAUL '',
  44. *   expires     INT(9) NOT NULL DEFAULT 0,
  45. *  
  46. *   changed     TIMESTAMP(14) NOT NULL,
  47. *  
  48. *   INDEX (expires),
  49. *   PRIMARY KEY (id, cachegroup)
  50. * )
  51. *
  52. * 
  53. * @author   Ulf Wendel  <ulf.wendel@phpdoc.de>, Sebastian Bergmann <sb@sebastian-bergmann.de>
  54. * @version  $Id: phplib.php,v 1.10 2001/03/08 20:39:16 uw Exp $
  55. * @package  Cache
  56. * @see      save()
  57. */
  58. class Cache_Container_phplib extends Cache_Container {
  59.   
  60.     /**
  61.     * Name of the DB table to store caching data
  62.     * 
  63.     * @see  Cache_Container_file::$filename_prefix
  64.     */  
  65.     var $cache_table = "cache";
  66.  
  67.     /**
  68.     * PHPLib object
  69.     * 
  70.     * @var  object PEAR_DB
  71.     */
  72.     var $db;
  73.  
  74.     /**
  75.     * Name of the PHPLib DB class to use
  76.     * 
  77.     * @var  string  
  78.     * @see  $db_path, $local_path
  79.     */
  80.     var $db_class = "";
  81.  
  82.     /**
  83.     * Filename of your local.inc
  84.     * 
  85.     * If empty, "local.inc" is assumed.
  86.     *
  87.     * @var       string
  88.     */
  89.     var $local_file = "";
  90.  
  91.     /**
  92.     * Include path for you local.inc
  93.     *
  94.     * HINT: If your're not using PHPLib's prepend.php you must 
  95.     * take care that all classes (files) references by you 
  96.     * local.inc are included automatically. So you might 
  97.     * want to write a new local2.inc that only referrs to 
  98.     * the database class (file) you're using and includes all required files.
  99.     *
  100.     * @var  string  path to your local.inc - make sure to add a trailing slash
  101.     * @see  $local_file
  102.     */
  103.     var $local_path = "";
  104.  
  105.     /**
  106.     * Creates an instance of a phplib db class to use it for storage.
  107.     *
  108.     * @param    mixed   If empty the object tries to used the 
  109.     *                   preconfigured class variables. If given it 
  110.     *                   must be an array with:
  111.     *                     db_class => name of the DB class to use
  112.     *                   optional:
  113.     *                     db_file => filename of the DB class
  114.     *                     db_path => path to the DB class
  115.     *                     local_file => kind of local.inc
  116.     *                     local_patk => path to the local.inc
  117.     *                   see $local_path for some hints.s
  118.     * @see  $local_path
  119.     */
  120.     function Cache_Container_phplib($options = "") {
  121.         if (is_array($options))
  122.             $this->setOptions($options, array("db_class", "db_file", "db_path", "local_file", "local_path"));
  123.  
  124.         if (!$this->db_class)
  125.             return new Cache_Error("No database class specified.", __FILE__, __LINE__);
  126.  
  127.         // include the required files
  128.         if ($this->db_file)
  129.             include_once($this->db_path . $this->db_file);
  130.  
  131.         if ($this->local_file)
  132.             include_once($this->local_path . $this->local_file);
  133.  
  134.         // create a db object 
  135.         $this->db = new $this->db_class;
  136.     } // end constructor
  137.  
  138.     function fetch($id, $group) {
  139.         $query = sprintf("SELECT expires, cachedata, userdata FROM %s WHERE id = '%s' AND cachegroup = '%s'",
  140.                             $this->cache_table, 
  141.                             $id,
  142.                             $group
  143.                          );
  144.         $this->db->query($query);
  145.         if (!$this->db->Next_Record())
  146.             return array(NULL, NULL, NULL);
  147.  
  148.         return array($this->db->f("expires"), $this->decode($this->db->f("cachedata")), $this->db->f("userdata"));
  149.     } // end func fetch
  150.  
  151.     /**
  152.     * Stores a dataset.
  153.     * 
  154.     * WARNING: we use the SQL command REPLACE INTO this might be 
  155.     * MySQL specific. As MySQL is very popular the method should
  156.     * work fine for 95% of you.
  157.     */
  158.     function save($id, $data, $expires, $group) {
  159.         $this->flushPreload($id, $group);
  160.  
  161.         $query = sprintf("REPLACE INTO %s (cachedata, expires, id, cachegroup) VALUES ('%s', %d, '%s', '%s')",
  162.                             $this->cache_table,
  163.                             addslashes($this->encode($data)),
  164.                             $this->getExpiresAbsolute($expires) ,
  165.                             $id,
  166.                             $group
  167.                          );
  168.         $this->db->query($query);
  169.  
  170.         return (boolean)$this->db->affected_rows(); 
  171.     } // end func save
  172.  
  173.     function delete($id, $group) {
  174.         $this->flushPreload($id, $group);
  175.         $this->db->query(
  176.                         sprintf("DELETE FROM %s WHERE id = '%s' AND cachegroup = '%s'",
  177.                             $this->cache_table,
  178.                             $id,
  179.                             $group
  180.                           )
  181.                     );
  182.  
  183.         return (boolean)$this->db->affected_rows();
  184.     } // end func delete
  185.  
  186.     function flush($group) {
  187.         $this->flushPreload();
  188.  
  189.         if ($group) {
  190.             $this->db->query(sprintf("DELETE FROM %s WHERE cachegroup = '%s'", $this->cache_table, $group));    
  191.         } else {
  192.             $this->db->query(sprintf("DELETE FROM %s", $this->cache_table));    
  193.         }
  194.  
  195.         return $this->db->affected_rows();
  196.     } // end func flush
  197.  
  198.     function idExists($id, $group) {
  199.         $this->db->query(
  200.                         sprintf("SELECT id FROM %s WHERE ID = '%s' AND cachegroup = '%s'", 
  201.                             $this->cache_table,
  202.                             $id, 
  203.                             $group
  204.                         )   
  205.                     );
  206.  
  207.         return (boolean)$this->db->nf();                         
  208.     } // end func isExists
  209.  
  210.     function garbageCollection() {
  211.         $this->flushPreload();
  212.  
  213.         $this->db->query( 
  214.                         sprintf("DELETE FORM %s WHERE expires <= %d AND expires > 0", 
  215.                             $this->cache_table, 
  216.                             time()
  217.                         )
  218.                     );
  219.  
  220.     } // end func garbageCollection
  221. }
  222. ?>
  223.