1: <?php
  2: 
  3: // include the config file
  4: if(!isset($config)) {
  5:     require_once '../util/AlphaConfig.inc';
  6:     $config = AlphaConfig::getInstance();
  7: 
  8:     require_once $config->get('app.root').'alpha/util/AlphaAutoLoader.inc';
  9: }
 10: 
 11: /**
 12:  *
 13:  * Controller used to clear out the CMS cache when required
 14:  *
 15:  * @package alpha::controller
 16:  * @since 1.0
 17:  * @author John Collins <dev@alphaframework.org>
 18:  * @version $Id: CacheManager.php 1624 2012-12-21 12:17:55Z alphadevx $
 19:  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
 20:  * @copyright Copyright (c) 2012, John Collins (founder of Alpha Framework).
 21:  * All rights reserved.
 22:  *
 23:  * <pre>
 24:  * Redistribution and use in source and binary forms, with or
 25:  * without modification, are permitted provided that the
 26:  * following conditions are met:
 27:  *
 28:  * * Redistributions of source code must retain the above
 29:  *   copyright notice, this list of conditions and the
 30:  *   following disclaimer.
 31:  * * Redistributions in binary form must reproduce the above
 32:  *   copyright notice, this list of conditions and the
 33:  *   following disclaimer in the documentation and/or other
 34:  *   materials provided with the distribution.
 35:  * * Neither the name of the Alpha Framework nor the names
 36:  *   of its contributors may be used to endorse or promote
 37:  *   products derived from this software without specific
 38:  *   prior written permission.
 39:  *
 40:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 41:  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 42:  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 43:  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 44:  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 45:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 46:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 47:  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 48:  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 49:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 50:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 51:  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 52:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 53:  * </pre>
 54:  *
 55:  */
 56: class CacheManager extends AlphaController implements AlphaControllerInterface {
 57:     /**
 58:      * The root of the cache directory
 59:      *
 60:      * @var string
 61:      * @since 1.0
 62:      */
 63:     private $dataDir;
 64: 
 65:     /**
 66:      * Trace logger
 67:      *
 68:      * @var Logger
 69:      * @since 1.0
 70:      */
 71:     private static $logger = null;
 72: 
 73:     /**
 74:      * constructor to set up the object
 75:      *
 76:      * @since 1.0
 77:      */
 78:     public function __construct() {
 79:         self::$logger = new Logger('CacheManager');
 80:         self::$logger->debug('>>__construct()');
 81: 
 82:         global $config;
 83: 
 84:         // ensure that the super class constructor is called, indicating the rights group
 85:         parent::__construct('Admin');
 86: 
 87:         $this->setTitle('Cache Manager');
 88:         $this->dataDir  = $config->get('app.file.store.dir').'cache/';
 89: 
 90:         self::$logger->debug('<<__construct');
 91:     }
 92: 
 93:     /**
 94:      * Handle GET requests
 95:      *
 96:      * @param array $params
 97:      * @throws IllegalArguementException
 98:      * @since 1.0
 99:      */
100:     public function doGET($params) {
101:         self::$logger->debug('>>doGET($params=['.var_export($params, true).'])');
102: 
103:         global $config;
104: 
105:         if(!is_array($params))
106:             throw new IllegalArguementException('Bad $params ['.var_export($params, true).'] passed to doGET method!');
107: 
108: 
109:         echo AlphaView::displayPageHead($this);
110: 
111:         echo '<h2>Listing contents of cache directory: '.$this->dataDir.'</h2>';
112: 
113:         $fileCount = AlphaFileUtils::listDirectoryContents($this->dataDir, 0, array('.htaccess'));
114: 
115:         echo '<h2>Total of '.$fileCount.' files in the cache.</h2>';
116: 
117:         echo '<form action="'.$_SERVER['REQUEST_URI'].'" method="post" name="clearForm" id="clearForm">';
118:         echo '<input type="hidden" name="clearCache" id="clearCache" value="false"/>';
119:         $js = "$('#dialogDiv').text('Are you sure you want to delete all files in the cache?');
120:                 $('#dialogDiv').dialog({
121:                 buttons: {
122:                     'OK': function(event, ui) {
123:                         $('#clearCache').attr('value', 'true');
124:                         $('#clearForm').submit();
125:                     },
126:                     'Cancel': function(event, ui) {
127:                         $(this).dialog('close');
128:                     }
129:                 }
130:             })
131:             $('#dialogDiv').dialog('open');
132:             return false;";
133:         $button = new Button($js, "Clear cache", "clearBut");
134:         echo $button->render();
135: 
136:         echo AlphaView::renderSecurityFields();
137:         echo '</form>';
138: 
139:         echo AlphaView::displayPageFoot($this);
140: 
141:         self::$logger->debug('<<doGET');
142:     }
143: 
144:     /**
145:      * Handle POST requests
146:      *
147:      * @param array $params
148:      * @throws SecurityException
149:      * @throws IllegalArguementException
150:      * @since 1.0
151:      */
152:     public function doPOST($params) {
153:         self::$logger->debug('>>doPOST($params=['.var_export($params, true).'])');
154: 
155:         try {
156:             // check the hidden security fields before accepting the form POST data
157:             if(!$this->checkSecurityFields())
158:                 throw new SecurityException('This page cannot accept post data from remote servers!');
159: 
160:             if(!is_array($params))
161:                 throw new IllegalArguementException('Bad $params ['.var_export($params, true).'] passed to doPOST method!');
162: 
163:             if (isset($params['clearCache']) && $params['clearCache'] == 'true') {
164:                 try {
165:                     AlphaFileUtils::deleteDirectoryContents($this->dataDir, array('.htaccess'));
166: 
167:                     $this->setStatusMessage(AlphaView::displayUpdateMessage('Cache contents deleted successfully.'));
168: 
169:                     self::$logger->info('Cache contents deleted successfully by user ['.$_SESSION['currentUser']->get('displayName').'].');
170:                 }catch (AlphaException $e) {
171:                     self::$logger->error($e->getMessage());
172:                     $this->setStatusMessage(AlphaView::displayErrorMessage($e->getMessage()));
173:                 }
174:             }
175: 
176:             $this->doGET($params);
177:         }catch(SecurityException $e) {
178:             $this->setStatusMessage(AlphaView::displayErrorMessage($e->getMessage()));
179: 
180:             self::$logger->warn($e->getMessage());
181:         }catch(IllegalArguementException $e) {
182:             self::$logger->error($e->getMessage());
183:             $this->setStatusMessage(AlphaView::displayErrorMessage($e->getMessage()));
184:         }
185: 
186:         echo AlphaView::displayPageFoot($this);
187:         self::$logger->debug('<<doPOST');
188:     }
189: 
190:     /**
191:      * Use this callback to inject in the admin menu template fragment
192:      *
193:      * @since 1.2
194:      */
195:     public function after_displayPageHead_callback() {
196:         $menu = AlphaView::loadTemplateFragment('html', 'adminmenu.phtml', array());
197: 
198:         return $menu;
199:     }
200: }
201: 
202: // now build the new controller if this file is called directly
203: if ('CacheManager.php' == basename($_SERVER['PHP_SELF'])) {
204:     $controller = new CacheManager();
205: 
206:     if(!empty($_POST)) {
207:         $controller->doPOST($_QUERY);
208:     }else{
209:         $controller->doGET($_GET);
210:     }
211: }
212: 
213: ?>