Ticket #617: pluginCache.3.diff

build/manifests/jelix-lib.mn

@@ -723 +723 @@
-! WSDLException.class.php
-! WSDLStruct.class.php
-! WSException.class.php
+
+cd lib/jelix/cache/
+  jCache.class.php
+
+cd lib/jelix/plugins/coord
+  cache
+
+cd lib/jelix/plugins/coord/cache
+  plugin.xml
+  cache.coord.php
+  cache.coord.ini.php.dist
+  lib/jelix/init.php

lib/jelix/plugins/coord/cache/plugin.xml

@@ +1 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<plugin name="cache">
+        <version major="1" minor="1" status="" copixversion=""  date="2008-06-11" />
+        <author name="Hadrien Lanneau" email="contact@hadrien.eu" website="http://www.hadrien.eu" role="creator" />
+        <description>
+                File cache
+        </description>
+</plugin>

lib/jelix/plugins/coord/cache/cache.coord.php

@@ +1 @@
+<?php
+/**
+* @package    jelix
+* @subpackage coord_plugin
+* @author     Hadrien Lanneau (contact at hadrien dot eu)
+* @copyright  2001-2005 CopixTeam, 2005-2007 Laurent Jouanneau, 2007 Frédéric Guillot, 2007 Antoine Detante
+* @copyright  2008 Hadrien.eu
+*
+* This class was get originally from an experimental branch of the Copix project
+* (PluginAuth, Copix 2.3dev20050901, http://www.copix.org)
+* Few lines of code are still copyrighted 2001-2005 CopixTeam (LGPL licence).
+* Initial authors of this Copix classes are Gerald Croes and Laurent Jouanneau,
+* and this class was adapted for Jelix by Laurent Jouanneau
+*
+* @licence  http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public Licence, see LICENCE file
+*/
+
+require(
+        JELIX_LIB_PATH . 'cache/jCache.class.php'
+);
+
+class CacheCoordPlugin implements jICoordPlugin
+{
+        /**
+         * Activate cache
+         *
+         * @var boolean
+         **/
+        public $activated = false;
+        /**
+         * time expiration (in milliseconds)
+         *
+         * @var Integer
+         **/
+        private $_expires;
+        
+        /**
+         * Cache filename
+         *
+         * @var string
+         **/
+        private $_fileKey;
+        
+        /**
+         * Cache folder path
+         *
+         * @var string
+         **/
+        public $path;
+        
+        /**
+         * path into cache folder
+         *
+         * @var string
+         **/
+        private $_localPath;
+        
+        
+        public function __construct($config)
+        {
+                if (isset($config['cache']) and
+                        $config['cache'] == 1)
+                {
+                        $this->activated = true;
+                        
+                        if (isset($config['path']))
+                        {
+                                $this->path = JELIX_APP_TEMP_PATH .
+                                        $config['path'] .
+                                        DIRECTORY_SEPARATOR;
+                        }
+                        else
+                        {
+                                $this->path = JELIX_APP_TEMP_PATH . 'cache/';
+                        }
+                }
+        }
+        
+        /**
+         * Get request params and check file cached
+         * @param {array} $params Params array
+         * @return void
+         **/
+        public function beforeAction($params)
+        {
+                // Check if cache is activated and if this request ask for cache
+                if ($this->activated and
+                        isset($params['cache.expires']))
+                {
+                        global $gJCoord;
+                        // create a path from module/action
+                        $this->_localPath .= 
+                                $gJCoord->moduleName . '/' .
+                                str_replace(
+                                        ':',
+                                        '_',
+                                        $gJCoord->actionName
+                                ) . '/';
+                        
+                        jFile::createDir(
+                                $this->path .
+                                $this->_localPath
+                        );
+                        
+                        // get md5 key from get params
+                        $this->_fileKey = md5(
+                                serialize(
+                                        $gJCoord->request->params
+                                )
+                        );
+                        
+                        // Test file time
+                        $this->_expires = $params['cache.expires'];
+                        if (@filemtime(
+                                        $this->path .
+                                        $this->_localPath .
+                                        $this->_fileKey
+                                ) < time() - $this->_expires)
+                        {
+                                // Start cache
+                                ob_start();
+                        }
+                        else
+                        {
+                                // Include cached file
+                                include(
+                                        $this->path .
+                                        $this->_localPath .
+                                        $this->_fileKey
+                                );
+                                exit();
+                        }
+                }
+        }
+        public function beforeOutput()
+        {
+                
+        }
+        public function afterProcess()
+        {
+                if ($this->activated and
+                        $this->_expires)
+                {
+                        // end cache
+                        $cache = ob_get_contents();
+                        ob_end_flush();
+                        
+                        // Write in file
+                        jFile::write(
+                                $this->path .
+                                        $this->_localPath .
+                                        $this->_fileKey,
+                                $cache
+                        );
+                }
+        }
+}

lib/jelix/plugins/coord/cache/cache.coord.ini.php.dist

@@ +1 @@
+;<?php die(''); ?>
+;for security reasons , don't remove or modify the first line
+
+;============= Main parameters
+
+; Activate cache (deactivate on dev mode)
+cache = on
+
+; Path parameter from app temp folder 
+;path = "cache"

lib/jelix/init.php

@@ -125 +125 @@
-$gLibPath=array('Db'=>JELIX_LIB_PATH.'db/', 'Dao'=>JELIX_LIB_PATH.'dao/',
- 'Forms'=>JELIX_LIB_PATH.'forms/', 'Event'=>JELIX_LIB_PATH.'events/',
- 'Tpl'=>JELIX_LIB_PATH.'tpl/', 'Acl'=>JELIX_LIB_PATH.'acl/', 'Controller'=>JELIX_LIB_PATH.'controllers/',
-
+
+
-
-/**
- * __autoload function used by php to try to load an unknown class
- */
-function __autoload($class){
-
+|jCache
-        $f=$GLOBALS['gLibPath'][$m[1]].$class.'.class.php';
-    }elseif(preg_match('/^cDao(?:Record)?_(.+)_Jx_(.+)_Jx_(.+)$/', $class, $m)){
-        // pour les dao stockés en sessions notament

lib/jelix/cache/jCache.class.php

@@ +1 @@
+<?php
+/**
+* jCache : interact with cache plugin
+*/
+class jCache
+{
+        /**
+         * Clean cache for a particular selector
+         *
+         * @param {string} $actSel Page selector to clean
+         * @return Boolean
+         * @author Hadrien
+         **/
+        static function clean($actSel)
+        {
+                global $gJCoord;
+                
+                if (!isset($gJCoord->plugins['cache']))
+                {
+                        return false;
+                }
+                
+                $sel = new jSelectorAct(
+                        $actSel,
+                        true
+                );
+                
+                jFile::removeDir(
+                        $gJCoord->plugins['cache']->path .
+                        $sel->module . '/' .
+                                $sel->controller . '_' .
+                                $sel->method
+                );
+                
+                return true;
+        }
+}