Cache
[ class tree: Cache ] [ index: Cache ] [ all elements ]

Source for file db.php

Documentation is available at db.php

  1. <?php
  2. // +----------------------------------------------------------------------+
  3. // | PEAR :: Cache                                                        |
  4. // +----------------------------------------------------------------------+
  5. // | Copyright (c) 1997-2003 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. // |          Chuck Hagenbuch <chuck@horde.org>                           |
  18. // +----------------------------------------------------------------------+
  19. //
  20. // $Id: db.php 315100 2011-08-17 19:32:23Z cweiske $
  21.  
  22. require_once 'DB.php';
  23. require_once 'Cache/Container.php';
  24.  
  25. /**
  26. * PEAR/DB Cache Container.
  27. *
  28. * WARNING: Other systems might or might not support certain datatypes of
  29. * the tables shown. As far as I know there's no large binary
  30. * type in SQL-92 or SQL-99. Postgres seems to lack any
  31. * BLOB or TEXT type, for MS-SQL you could use IMAGE, don't know
  32. * about other databases. Please add sugestions for other databases to
  33. * the inline docs.
  34. *
  35. * The field 'changed' has no meaning for the Cache itself. It's just there
  36. * because it's a good idea to have an automatically updated timestamp
  37. * field for debugging in all of your tables.
  38. *
  39. * For _MySQL_ you need this DB table:
  40. *
  41. * CREATE TABLE cache (
  42. *   id          CHAR(32) NOT null DEFAULT '',
  43. *   cachegroup  VARCHAR(127) NOT null DEFAULT '',
  44. *   cachedata   BLOB NOT null DEFAULT '',
  45. *   userdata    VARCHAR(255) NOT null DEFAULT '',
  46. *   expires     INT(9) NOT null DEFAULT 0,
  47. *
  48. *   changed     TIMESTAMP(14) NOT null,
  49. *
  50. *   INDEX (expires),
  51. *   PRIMARY KEY (id, cachegroup)
  52. * )
  53. *
  54. @author   Sebastian Bergmann <sb@sebastian-bergmann.de>
  55. @version  $Id: db.php 315100 2011-08-17 19:32:23Z cweiske $
  56. @package  Cache
  57. */
  58. {
  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 = '';
  66.  
  67.     /**
  68.     * PEAR DB dsn to use.
  69.     *
  70.     * @var  string 
  71.     */
  72.     var $dsn = '';
  73.  
  74.     /**
  75.     * PEAR DB object
  76.     *
  77.     * @var  object PEAR_DB 
  78.     */
  79.     var $db;
  80.  
  81.     function Cache_Container_db($options)
  82.     {
  83.         $this->setAllowedOptions(array('dsn''cache_table'));
  84.         $this->setOptions($options);
  85.         if (!$this->hasBeenSet('dsn'))
  86.         {
  87.             return new Cache_Error('No dsn specified!'__FILE____LINE__);
  88.         }
  89.  
  90.         $this->db = DB::connect($this->dsntrue);
  91.         if (PEAR::isError($this->db)) {
  92.             return new Cache_Error('DB::connect failed: ' . DB::errorMessage($this->db)__FILE____LINE__);
  93.         }
  94.         $this->db->setFetchMode(DB_FETCHMODE_ASSOC);
  95.     }
  96.  
  97.     function fetch($id$group)
  98.     {
  99.         $query sprintf("SELECT cachedata, userdata, expires FROM %s WHERE id = '%s' AND cachegroup = '%s'",
  100.                          $this->cache_table,
  101.                          addslashes($id),
  102.                          addslashes($group)
  103.                          );
  104.  
  105.         $res $this->db->query($query);
  106.  
  107.         if (PEAR::isError($res)) {
  108.             return new Cache_Error('DB::query failed: ' . DB::errorMessage($res)__FILE____LINE__);
  109.         }
  110.         $row $res->fetchRow();
  111.         if (is_array($row)) {
  112.             $data = array($row['expires']$this->decode($row['cachedata'])$row['userdata']);
  113.         else {
  114.             $data = array(nullnullnull);
  115.         }
  116.         // last used required by the garbage collection
  117.         // WARNING: might be MySQL specific
  118.         $query sprintf("UPDATE %s SET changed = (NOW() + 0) WHERE id = '%s' AND cachegroup = '%s'",
  119.                             $this->cache_table,
  120.                             addslashes($id),
  121.                             addslashes($group)
  122.                           );
  123.  
  124.         $res $this->db->query($query);
  125.  
  126.         if (PEAR::isError($res)) {
  127.             return new Cache_Error('DB::query failed: ' . DB::errorMessage($res)__FILE____LINE__);
  128.         }
  129.         return $data;
  130.     }
  131.  
  132.     /**
  133.     * Stores a dataset.
  134.     *
  135.     * WARNING: we use the SQL command REPLACE INTO this might be
  136.     * MySQL specific. As MySQL is very popular the method should
  137.     * work fine for 95% of you.
  138.     */
  139.     function save($id$data$expires$group$userdata)
  140.     {
  141.         $this->flushPreload($id$group);
  142.  
  143.         $query sprintf("REPLACE INTO %s (userdata, cachedata, expires, id, cachegroup) VALUES ('%s', '%s', %d, '%s', '%s')",
  144.                          $this->cache_table,
  145.                          addslashes($userdata),
  146.                          addslashes($this->encode($data)),
  147.                           $this->getExpiresAbsolute($expires,
  148.                          addslashes($id),
  149.                          addslashes($group)
  150.                         );
  151.  
  152.         $res $this->db->query($query);
  153.  
  154.         if (PEAR::isError($res)) {
  155.             return new Cache_Error('DB::query failed: ' . DB::errorMessage($res__FILE____LINE__);
  156.         }
  157.     }
  158.  
  159.     function remove($id$group)
  160.     {
  161.         $this->flushPreload($id$group);
  162.  
  163.         $query sprintf("DELETE FROM %s WHERE id = '%s' and cachegroup = '%s'",
  164.                          $this->cache_table,
  165.                          addslashes($id),
  166.                          addslashes($group)
  167.                         );
  168.  
  169.         $res $this->db->query($query);
  170.  
  171.         if (PEAR::isError($res)) {
  172.             return new Cache_Error('DB::query failed: ' . DB::errorMessage($res)__FILE____LINE__);
  173.         }
  174.     }
  175.  
  176.     function flush($group '')
  177.     {
  178.         $this->flushPreload();
  179.  
  180.          if ($group{
  181.             $query sprintf("DELETE FROM %s WHERE cachegroup = '%s'"$this->cache_tableaddslashes($group));
  182.         else {
  183.             $query sprintf("DELETE FROM %s"$this->cache_table);
  184.         }
  185.  
  186.         $res $this->db->query($query);
  187.  
  188.         if (PEAR::isError($res))
  189.             return new Cache_Error('DB::query failed: ' . DB::errorMessage($res)__FILE____LINE__);
  190.     }
  191.  
  192.     function idExists($id$group)
  193.     {
  194.         $query sprintf("SELECT id FROM %s WHERE ID = '%s' AND cachegroup = '%s'",
  195.                          $this->cache_table,
  196.                          addslashes($id),
  197.                          addslashes($group)
  198.                         );
  199.  
  200.         $res $this->db->query($query);
  201.  
  202.         if (PEAR::isError($res)) {
  203.             return new Cache_Error('DB::query failed: ' . DB::errorMessage($res)__FILE____LINE__);
  204.         }
  205.         $row $res->fetchRow();
  206.  
  207.         if (is_array($row)) {
  208.             return true;
  209.         }
  210.         return false;
  211.     }
  212.  
  213.     function garbageCollection($maxlifetime)
  214.     {
  215.         $this->flushPreload();
  216.  
  217.         $query sprintf('DELETE FROM %s WHERE (expires <= %d AND expires > 0) OR changed <= %d',
  218.                          $this->cache_table,
  219.                          time(),
  220.                          time($maxlifetime
  221.                        );
  222.  
  223.         $res $this->db->query($query);
  224.  
  225.         $query sprintf('select sum(length(cachedata)) as CacheSize from %s',
  226.                          $this->cache_table
  227.                        );
  228.         $cachesize $this->db->GetOne($query);
  229.         if (PEAR::isError($cachesize)) {
  230.             return new Cache_Error('DB::query failed: ' . DB::errorMessage($cachesize)__FILE____LINE__);
  231.         }
  232.  
  233.         //if cache is to big.
  234.         if ($cachesize $this->highwater{
  235.             //find the lowwater mark.
  236.             $query sprintf('select length(cachedata) as size, changed from %s order by changed DESC',
  237.                                      $this->cache_table
  238.                        );
  239.             $res $this->db->query($query);
  240.             if (PEAR::isError($res)) {
  241.                 return new Cache_Error('DB::query failed: ' . DB::errorMessage($res)__FILE____LINE__);
  242.             }
  243.  
  244.             $numrows $this->db->numRows($res);
  245.             $keep_size = 0;
  246.             while ($keep_size $this->lowwater && $numrows--{
  247.                 $entry $res->fetchRow(DB_FETCHMODE_ASSOC);
  248.                 $keep_size += $entry['size'];
  249.             }
  250.  
  251.             //delete all entries, which were changed before the "lowwwater mark"
  252.             $query sprintf('delete from %s where changed <= '.($entry['changed'$entry['changed': 0),
  253.                                      $this->cache_table
  254.                                    );
  255.             $res $this->db->query($query);
  256.         }
  257.  
  258.         if (PEAR::isError($res)) {
  259.             return new Cache_Error('DB::query failed: ' . DB::errorMessage($res)__FILE____LINE__);
  260.         }
  261.     }
  262.  
  263. }
  264. ?>

Documentation generated on Mon, 11 Mar 2019 15:44:49 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.