added a persistent cache mechanism; used so far to cache image ids in flat view mode

git-svn-id: http://piwigo.org/svn/trunk@28432 68402e56-0260-453c-a942-63ccdbb3a9ee

4 files changed, 155 insertions, 3 deletions

diff --git a/include/cache.class.php b/include/cache.class.php
new file mode 100644
index 000000000..b1f7dde89
--- /dev/null
+++ b/include/cache.class.php
@@ -0,0 +1,143 @@
+<?php
+// +-----------------------------------------------------------------------+
+// | Piwigo - a PHP based photo gallery                                    |
+// +-----------------------------------------------------------------------+
+// | Copyright(C) 2008-2014 Piwigo Team                  http://piwigo.org |
+// | Copyright(C) 2003-2008 PhpWebGallery Team    http://phpwebgallery.net |
+// | Copyright(C) 2002-2003 Pierrick LE GALL   http://le-gall.net/pierrick |
+// +-----------------------------------------------------------------------+
+// | This program is free software; you can redistribute it and/or modify  |
+// | it under the terms of the GNU General Public License as published by  |
+// | the Free Software Foundation                                          |
+// |                                                                       |
+// | This program is distributed in the hope that it will be useful, but   |
+// | WITHOUT ANY WARRANTY; without even the implied warranty of            |
+// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
+// | General Public License for more details.                              |
+// |                                                                       |
+// | You should have received a copy of the GNU General Public License     |
+// | along with this program; if not, write to the Free Software           |
+// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
+// | USA.                                                                  |
+// +-----------------------------------------------------------------------+
+
+/**
+  Provides a persistent cache mechanism across multiple page loads/sessions etc...
+*/
+abstract class PersistentCache
+{
+  var $default_lifetime = 86400;
+  protected $instance_key = PHPWG_VERSION;
+
+  /**
+  @return a key that can be safely be used with get/set methods
+  */
+  function make_key($key)
+  {
+    if ( is_array($key) )
+    {
+      $key = implode('&', $key);
+    }
+    $key .= $this->instance_key;
+    return md5($key);
+  }
+
+  /**
+  Searches for a key in the persistent cache and fills corresponding value.
+  @param string $key
+  @param out mixed $value
+  @return false if the $key is not found in cache ($value is not modified in this case)
+  */
+  abstract function get($key, &$value);
+
+  /**
+  Sets a key/value pair in the persistent cache.
+  @param string $key - it should be the return value of make_key function
+  @param mixed $value
+  @param int $lifetime
+  @return false on error
+  */
+  abstract function set($key, $value, $lifetime=null);
+
+  /**
+  Purge the persistent cache.
+  @param boolean $all - if false only expired items will be purged
+  */
+  abstract function purge($all);
+}
+
+
+/**
+  Implementation of a persistent cache using files.
+*/
+class PersistentFileCache extends PersistentCache
+{
+  private $dir;
+
+  function __construct()
+  {
+    global $conf;
+    $this->dir = PHPWG_ROOT_PATH.$conf['data_location'].'cache/';
+  }
+
+  function get($key, &$value)
+  {
+    $loaded = @file_get_contents($this->dir.$key.'.cache');
+    if ($loaded !== false && ($loaded=unserialize($loaded)) !== false)
+    {
+      if ($loaded['expire'] > time())
+      {
+        $value = $loaded['data'];
+        return true;
+      }
+    }
+    return false;
+  }
+
+  function set($key, $value, $lifetime=null)
+  {
+    if ($lifetime === null)
+    {
+      $lifetime = $this->default_lifetime;
+    }
+
+    if (rand() % 199 == 0)
+    {
+      $this->purge(false);
+    }
+
+    $serialized = serialize( array(
+        'expire' => time() + $lifetime,
+        'data' => $value
+      ));
+
+    if (false === @file_put_contents($this->dir.$key.'.cache', $serialized))
+    {
+      mkgetdir($this->dir, MKGETDIR_DEFAULT&~MKGETDIR_DIE_ON_ERROR);
+      if (false === @file_put_contents($this->dir.$key.'.cache', $serialized))
+      {
+        return false;
+      }
+    }
+    return true;
+  }
+
+  function purge($all)
+  {
+    $files = glob($this->dir.'*.cache');
+    if (empty($files))
+    {
+      return;
+    }
+
+    $limit = time() - $this->default_lifetime;
+    foreach ($files as $file)
+    {
+      if ($all || @filemtime($file) < $limit)
+        @unlink($file);
+    }
+  }
+
+}
+
+?>
\ No newline at end of file
diff --git a/include/common.inc.php b/include/common.inc.php
index 03ca26811..3739cfa5f 100644
--- a/include/common.inc.php
+++ b/include/common.inc.php
@@ -103,6 +103,7 @@ if(isset($conf['show_php_errors']) && !empty($conf['show_php_errors']))
 include(PHPWG_ROOT_PATH . 'include/constants.php');
 include(PHPWG_ROOT_PATH . 'include/functions.inc.php');
 
+$persistent_cache = new PersistentFileCache();
 
 // Database connection
 try
diff --git a/include/functions.inc.php b/include/functions.inc.php
index 195f7f00d..03d6c6b0f 100644
--- a/include/functions.inc.php
+++ b/include/functions.inc.php
@@ -37,6 +37,7 @@ include_once( PHPWG_ROOT_PATH .'include/derivative_params.inc.php');
 include_once( PHPWG_ROOT_PATH .'include/derivative_std_params.inc.php');
 include_once( PHPWG_ROOT_PATH .'include/derivative.inc.php');
 include_once( PHPWG_ROOT_PATH .'include/template.class.php');
+include_once( PHPWG_ROOT_PATH .'include/cache.class.php');
 
 
 /**
diff --git a/include/section_init.inc.php b/include/section_init.inc.php
index cbc699d45..8ab635875 100644
--- a/include/section_init.inc.php
+++ b/include/section_init.inc.php
@@ -291,6 +291,7 @@ SELECT id
       }
       else
       {
+        $cache_key = $persistent_cache->make_key('all_iids'.$user['id'].$user['cache_update_time'].$conf['order_by']);
         unset($page['is_homepage']);
         $where_sql = '1=1';
       }
@@ -301,8 +302,10 @@ SELECT id
       $where_sql = 'category_id = '.$page['category']['id'];
     }
 
-    // main query
-    $query = '
+    if ( !isset($cache_key) || !$persistent_cache->get($cache_key, $page['items']))
+    {
+      // main query
+      $query = '
 SELECT DISTINCT(image_id)
   FROM '.IMAGE_CATEGORY_TABLE.'
     INNER JOIN '.IMAGES_TABLE.' ON id = image_id
@@ -312,7 +315,11 @@ SELECT DISTINCT(image_id)
   '.$conf['order_by'].'
 ;';
 
-    $page['items'] = query2array($query,null, 'image_id');
+      $page['items'] = query2array($query,null, 'image_id');
+      
+      if ( isset($cache_key) )
+        $persistent_cache->set($cache_key, $page['items']);
+    }
   }
 }
 // special sections