Moved all FILTER_FOO() filter functions to an own include directory:
[mailer.git] / inc / filter / cache_filter.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 06/02/2011 *
4  * ===================                          Last change: 06/02/2011 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : _filter.php                                      *
8  * -------------------------------------------------------------------- *
9  * Short description : Filters for ext-                                 *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Filter fuer ext-                                 *
12  * -------------------------------------------------------------------- *
13  * $Revision::                                                        $ *
14  * $Date::                                                            $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author::                                                          $ *
17  * -------------------------------------------------------------------- *
18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
19  * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
20  * For more information visit: http://www.mxchange.org                  *
21  *                                                                      *
22  * This program is free software; you can redistribute it and/or modify *
23  * it under the terms of the GNU General Public License as published by *
24  * the Free Software Foundation; either version 2 of the License, or    *
25  * (at your option) any later version.                                  *
26  *                                                                      *
27  * This program is distributed in the hope that it will be useful,      *
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
30  * GNU General Public License for more details.                         *
31  *                                                                      *
32  * You should have received a copy of the GNU General Public License    *
33  * along with this program; if not, write to the Free Software          *
34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
35  * MA  02110-1301  USA                                                  *
36  ************************************************************************/
37
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
40         die();
41 } // END - if
42
43 // Destroy the cache on extension changes
44 function FILTER_CACHE_DESTROY_ON_EXT_CHANGE ($data) {
45         // Return the data anyway if there is no cache extension
46         if (!isCacheInstanceValid()) return $data;
47
48         // Remove cache
49         foreach (array('config','extension','filter','modules') as $cache) {
50                 if ($GLOBALS['cache_instance']->loadCacheFile($cache)) $GLOBALS['cache_instance']->removeCacheFile();
51         } // END - foreach
52
53         // Return it
54         return $data;
55 }
56
57 // Destroy the cache on changing admin
58 function FILTER_CACHE_DESTROY_ON_ADMIN_CHANGE ($data) {
59         // Skip this step if the cache instance is not there
60         if (!isCacheInstanceValid()) return false;
61
62         // Remove cache
63         if ($GLOBALS['cache_instance']->loadCacheFile('admin')) $GLOBALS['cache_instance']->removeCacheFile();
64
65         // Return the data
66         return $data;
67 }
68
69 // Destroy all cache files
70 function FILTER_CACHE_DESTROY_ALL () {
71         // Skip this step if the cache instance is not there
72         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Called!');
73         if (!isCacheInstanceValid()) return false;
74
75         // Remove cache files
76         foreach (array('admin','admin_acls','config','extension','modules','refdepths','refsystem','themes','filter','imprint') as $cache) {
77                 // Is the cache file readable?
78                 // @TODO This should be rewritten not to load the cache file for just checking if it is there for save removal.
79                 if ($GLOBALS['cache_instance']->loadCacheFile($cache)) {
80                         // Remove the cache file
81                         $GLOBALS['cache_instance']->removeCacheFile();
82                 } // END - if
83         } // END - foreach
84         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Done!');
85 }
86
87 // Filter for purging 'filter' cache
88 function FILTER_CACHE_DESTROY_FILTER () {
89         // Skip this step if the cache instance is not there
90         if ((!isCacheInstanceValid()) || (getConfig('update_filter_usage') != 'Y')) return false;
91
92         // Remove cache files
93         if ($GLOBALS['cache_instance']->loadCacheFile('filter')) $GLOBALS['cache_instance']->removeCacheFile();
94 }
95
96 // [EOF]
97 ?>