1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 <?php
/*-----8<--------------------------------------------------------------------
*
* BEdita - a semantic content management framework
*
* Copyright 2008-2011 ChannelWeb Srl, Chialab Srl
*
* This file is part of BEdita: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* BEdita is distributed WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with BEdita (see LICENSE.LGPL).
* If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
*
*------------------------------------------------------------------->8-----
*/
/**
* Utility model class
* Execute utility operations
*
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $LastChangedDate$
*
* $Id$
*/
class Utility extends AppModel {
public $useTable = false;
/**
* response of Utility::call()
* @var array, it contains
* 'results' => the results of the operation, it can be an array and depends from operation,
* 'message' => message to display at user,
* 'log' => log message
*/
protected $response = array('results' => null, 'message' => null, 'log' => null);
/**
* call a specific utility operation and eventually log errors
*
* @param string $operation, the name of the operation.
* It is also the name of the method called and the name of log file written
* @param array $options, default 'log' => false, no file log written
* other options can be seen in the relative utility operation
* @return array of response (Utility::response)
* @throws BeditaException
*/
public function call($operation, $options = array()) {
if (!method_exists($this, $operation)) {
throw new BeditaException(__("Error: utility operation doesn't found", true), array("operation" => $operation));
}
$options = array_merge(array('log' => false), $options);
$this->clearResponse();
$this->{$operation}($options);
if (empty($this->response["message"])) {
$this->response["message"] = $operation . " " . __("operation done", true);
}
if ($options['log'] && !empty($this->response["log"])) {
if (is_array($this->response["log"])) {
$this->response["log"] = implode(PHP_EOL, $this->response["log"]);
}
CakeLog::write($operation, $this->response['log']);
$this->response['message'] .= __("Some errors occured. For more information look at", true) . " " . LOGS . $operation . ".log";
}
return $this->response;
}
/**
* utility operation
* update stream fields according to Stream::updateStreamFields
*
* @param array $options
*/
protected function updateStreamFields($options) {
$id = (!empty($options['id']))? $options['id'] : null;
$this->response['results'] = ClassRegistry::init("Stream")->updateStreamFields($id);
}
/**
* utility operation
* rebuild index for search text according to SearchText::rebuildIndex()
*
* @param array $options
* 'returnOnlyFailed' => true (default) to return only failed results
* 'delete' => delete index first (default false)
* 'type' => index object type only (default unset -> all types)
* 'log' => true to log errors
* 'min' => min ID to index
* 'max' => max ID to index
*/
protected function rebuildIndex($options) {
$searchText = ClassRegistry::init("SearchText");
$this->response['results'] = $searchText->rebuildIndex($options);
if (!empty($options['log'])) {
$msg = "";
$this->response['log'] = array();
if (!empty($this->response['results']['failed'])) {
$this->response['log'][] = "Failed rebuilding indexes for these objects";
$this->response['log'] += $this->buildLogItems($this->response['results']['failed']);
$msg .= count($this->response['results']['failed']) . " " . __("objects rebuilding failed.", true) . PHP_EOL;
}
if (!empty($this->response['results']['langTextFailed'])) {
$this->response['log'][] = "Failed rebuilding translations indexes for these objects";
$this->response['log'] += $this->buildLogItems($this->response['results']['langTextFailed']);
$msg .= count($this->response['results']['langTextFailed']) . " " . __("translations rebuilding failed.", true) . PHP_EOL;
}
if (!empty($this->response['log'])) {
$this->response['message'] = "rebuildIndex " . __("operation done", true) . PHP_EOL . $msg;
}
}
}
/**
* utility operation
* clear media cache, remove image thumbs according to Stream::clearMediaCache()
*
* @param array $options
* 'log' => true to log errors
*/
protected function clearMediaCache($options) {
$streamModel = ClassRegistry::init("Stream");
$this->response['results'] = $streamModel->clearMediaCache();
if ($this->response['results'] === false) {
$this->response['message'] = __("No streams found", true);
} elseif (!empty($this->response['results']['failed'])) {
if (!empty($options['log'])) {
$this->response['log'] = $this->buildLogItems($this->response['results']['failed']);
}
$msg .= count($this->response['results']['failed']) . " " . __("errors cleaning media cache.", true) . "\n";
$this->response['message'] = "clearMediaCache " . __("operation done", true) . ".\n" . $msg;
}
}
/**
* utility operation
* delete log files according to BeSystem::emptyLogs()
*
* @param array $options
* 'filename' => null (default delete all log files) the log file to delete,
* 'basePath' => LOGS (default) the log directory path
* 'log' => true to log errors
*/
protected function emptyLogs($options) {
$options = array_merge(array('filename' => null, 'basePath' => LOGS), $options);
$this->response['results'] = BeLib::getObject("BeSystem")->emptyLogs($options['filename'], $options['basePath']);
if (!empty($this->response['results']['failed']) && !empty($options['log'])) {
$this->response['log'] = $this->buildLogItems($this->response['results']['failed']);
}
}
/**
* utility operation
* cleanup cached files according to BeSystem::cleanupCache()
*
* @param array $options
* 'basePath' => TMP (default) the path on which search and clear cache
* 'frontendsToo' => true (default) to clean also frontends cache
* 'cleanAll' => false (default) clean all folders in tmp/cache not just 'models', 'persistent' and 'views'
*/
protected function cleanupCache($options = array()) {
$defaults = array(
'basePath' => BEDITA_CORE_PATH . DS .'tmp' . DS,
'frontendsToo' => true,
'cleanAll' => false);
$options = array_merge($defaults, $options);
$this->response['results'] = BeLib::getObject('BeSystem')->cleanupCache($options['basePath'],
$options['frontendsToo'], $options['cleanAll']);
if (!empty($this->response['results']['failed']) && !empty($options['log'])) {
$this->response['log'] = $this->buildLogItems($this->response['results']['failed']);
}
}
/**
* build an array of log items
* loop the $data array and build an array of string built with all key => value pairs
*
* @param array $data, multidimensional array as
* 0 => array('id' => 1, '.....'fieldname' => 'value_1', ...),
* 1 => array('id' => 2, '.....'fieldname' => 'value_2', ...)
* @return string
*/
private function buildLogItems(array $data = array()) {
$log = array();
foreach ($data as $failItem) {
$logstring = "";
foreach ($failItem as $key => $val) {
$logstring .= $key . " => " . $val . "; ";
}
$log[] = $logstring;
}
return $log;
}
/**
* clear Utility::response
*/
private function clearResponse() {
$this->response = array('results' => null, 'message' => null, 'log' => null);
}
}
?>