Several code cleanups:
[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 ($filterData) {
45         // Return the data anyway if there is no cache extension
46         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Called!');
47         if (!isCacheInstanceValid()) {
48                 return false;
49         } // END - if
50
51         // Remove cache
52         foreach (array('config','extension','filter','modules') as $cache) {
53                 if ($GLOBALS['cache_instance']->loadCacheFile($cache)) {
54                         $GLOBALS['cache_instance']->removeCacheFile();
55                 } // END - if
56         } // END - foreach
57
58         // Return it
59         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Done!');
60         return $filterData;
61 }
62
63 // Destroy the cache on changing admin
64 function FILTER_CACHE_DESTROY_ON_ADMIN_CHANGE ($filterData) {
65         // Skip this step if the cache instance is not there
66         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Called!');
67         if (!isCacheInstanceValid()) {
68                 return false;
69         } // END - if
70
71         // Remove cache
72         if ($GLOBALS['cache_instance']->loadCacheFile('admin')) {
73                 $GLOBALS['cache_instance']->removeCacheFile();
74         } // END - if
75
76         // Return the data
77         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Done!');
78         return $filterData;
79 }
80
81 // Destroy all cache files
82 function FILTER_CACHE_DESTROY_ALL ($filterData) {
83         // Skip this step if the cache instance is not there
84         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Called!');
85         if (!isCacheInstanceValid()) {
86                 return false;
87         } // END - if
88
89         // Remove cache files
90         foreach (array('admin','admin_acls','config','extension','modules','refdepths','refsystem','themes','filter','imprint') as $cache) {
91                 // Is the cache file readable?
92                 // @TODO This should be rewritten not to load the cache file for just checking if it is there for save removal.
93                 if ($GLOBALS['cache_instance']->loadCacheFile($cache)) {
94                         // Remove the cache file
95                         $GLOBALS['cache_instance']->removeCacheFile();
96                 } // END - if
97         } // END - foreach
98
99         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Done!');
100         return $filterData;
101 }
102
103 // Filter for purging 'filter' cache
104 function FILTER_CACHE_DESTROY_FILTER ($filterData) {
105         // Skip this step if the cache instance is not there
106         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Called!');
107         if ((!isCacheInstanceValid()) || ((isConfigEntrySet('update_filter_usage')) && (getConfig('update_filter_usage') != 'Y'))) {
108                 return false;
109         } // END - if
110
111         // Remove cache files
112         if ($GLOBALS['cache_instance']->loadCacheFile('filter')) {
113                 $GLOBALS['cache_instance']->removeCacheFile();
114         } // END - if
115
116         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Done!');
117         return $filterData;
118 }
119
120 // [EOF]
121 ?>