├── .gitignore ├── system └── user │ └── addons │ └── stash │ ├── addon.setup.php │ ├── config.php │ ├── mcp.stash.php │ ├── language │ └── english │ │ └── stash_lang.php │ ├── upd.stash.php │ ├── ext.stash.php │ └── models │ └── stash_model.php ├── composer.json ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .idea/* -------------------------------------------------------------------------------- /system/user/addons/stash/addon.setup.php: -------------------------------------------------------------------------------- 1 | STASH_AUTHOR, 6 | 'author_url' => STASH_AUTHOR_URL, 7 | 'name' => STASH_NAME, 8 | 'description' => STASH_DESC, 9 | 'version' => STASH_VER, 10 | 'namespace' => STASH_NAME 11 | ); 12 | -------------------------------------------------------------------------------- /system/user/addons/stash/config.php: -------------------------------------------------------------------------------- 1 | =7.4", 19 | "ext-curl": "*" 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /system/user/addons/stash/mcp.stash.php: -------------------------------------------------------------------------------- 1 | 'Stash', 14 | 'stash_module_description' => 'Set and get template variables, EE snippets and persistent variables.', 15 | 'unknown_stash_type' => 'Stash: unknown cache type defined by the type="" parameter - ', 16 | 'bundle_entry_exists' => 'Stash: the bundle "%s", which you have specified as unique, already has an associated entry.', 17 | 'cache_flush_success' => 'Stash: the variable cache has been flushed.', 18 | 'stash_file_not_found' => 'Stash: the file "%s" was not found.', 19 | 'unknown_post_process' => 'Stash: the tag %s cannot be post-processed on %s.', 20 | ); 21 | 22 | /* End of file stash_lang.php */ 23 | /* Location: ./system/expressionengine/third_party/stash/language/english/stash_lang.php */ -------------------------------------------------------------------------------- /system/user/addons/stash/upd.stash.php: -------------------------------------------------------------------------------- 1 | db->insert( 41 | 'modules', 42 | array( 43 | 'module_name' => $this->name, 44 | 'module_version' => $this->version, 45 | 'has_cp_backend' => 'n', 46 | 'has_publish_fields' => 'n' 47 | ) 48 | ); 49 | 50 | // stash table 51 | $sql[] = " 52 | CREATE TABLE `".ee()->db->dbprefix."stash` ( 53 | `id` int(11) unsigned NOT NULL auto_increment, 54 | `site_id` int(4) unsigned NOT NULL default '1', 55 | `session_id` varchar(40) default NULL, 56 | `bundle_id` int(11) unsigned NOT NULL default '1', 57 | `key_name` varchar(255) NOT NULL, 58 | `key_label` varchar(255) default NULL, 59 | `created` int(10) unsigned NOT NULL, 60 | `expire` int(10) unsigned NOT NULL default '0', 61 | `parameters` MEDIUMTEXT, 62 | PRIMARY KEY (`id`), 63 | UNIQUE KEY `cache_key` (`key_name`(191),`bundle_id`,`site_id`,`session_id`), 64 | KEY `bundle_id` (`bundle_id`), 65 | KEY `site_id` (`site_id`), 66 | KEY `expire` (`expire`) 67 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8; 68 | "; 69 | 70 | // stash_bundles table 71 | $sql[] = " 72 | CREATE TABLE `".ee()->db->dbprefix."stash_bundles` ( 73 | `id` int(11) unsigned NOT NULL auto_increment, 74 | `bundle_name` varchar(255) NOT NULL, 75 | `bundle_label` varchar(255) default NULL, 76 | `is_locked` tinyint(1) unsigned NOT NULL default '0', 77 | PRIMARY KEY (`id`), 78 | KEY `bundle` (`bundle_name`) 79 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8; 80 | "; 81 | 82 | // foreign key constraints 83 | $sql[] = " 84 | ALTER TABLE `".ee()->db->dbprefix."stash` 85 | ADD CONSTRAINT `".ee()->db->dbprefix."stash_fk` FOREIGN KEY (`bundle_id`) REFERENCES `".ee()->db->dbprefix."stash_bundles` (`id`) ON DELETE CASCADE ON UPDATE CASCADE; 86 | "; 87 | 88 | // default bundles 89 | $sql[] = "INSERT INTO `".ee()->db->dbprefix."stash_bundles` VALUES(1, 'default', 'Default', 1);"; 90 | $sql[] = "INSERT INTO `".ee()->db->dbprefix."stash_bundles` VALUES(2, 'templates', 'Templates', 1);"; 91 | $sql[] = "INSERT INTO `".ee()->db->dbprefix."stash_bundles` VALUES(3, 'static', 'Static', 1);"; 92 | 93 | // run the queries one by one 94 | foreach ($sql as $query) 95 | { 96 | ee()->db->query($query); 97 | } 98 | 99 | return TRUE; 100 | } 101 | 102 | /** 103 | * uninstall 104 | * 105 | * @access public 106 | * @return void 107 | */ 108 | public function uninstall() 109 | { 110 | $query = ee()->db->get_where('modules', array('module_name' => 'Stash')); 111 | 112 | if ($query->row('module_id')) 113 | { 114 | if (version_compare(APP_VER, '6.0', '>=')) 115 | { 116 | ee()->db->delete('module_member_roles', array('module_id' => $query->row('module_id'))); 117 | } 118 | else 119 | { 120 | ee()->db->delete('module_member_groups', array('module_id' => $query->row('module_id'))); 121 | } 122 | } 123 | 124 | ee()->db->delete('modules', array('module_name' => 'Stash')); 125 | 126 | ee()->load->dbforge(); 127 | ee()->dbforge->drop_table('stash'); 128 | ee()->dbforge->drop_table('stash_bundles'); 129 | 130 | return TRUE; 131 | } 132 | 133 | /** 134 | * update 135 | * 136 | * @access public 137 | * @param mixed $current = '' 138 | * @return void 139 | */ 140 | public function update($current = '') 141 | { 142 | if ($current == '' OR version_compare($current, $this->version) === 0) 143 | { 144 | // up to date 145 | return FALSE; 146 | } 147 | 148 | $sql = array(); 149 | 150 | // always flush the Stash table first 151 | $sql[] = "TRUNCATE TABLE `".ee()->db->dbprefix."stash`"; 152 | 153 | // Update to 2.3.7 154 | if (version_compare($current, '2.3.7', '<')) 155 | { 156 | // increase variable max key and parameter sizes 157 | $sql[] = "ALTER TABLE `".ee()->db->dbprefix."stash` CHANGE `key_name` `key_name` VARCHAR(255) NOT NULL"; 158 | $sql[] = "ALTER TABLE `".ee()->db->dbprefix."stash` CHANGE `key_label` `key_label` VARCHAR(255) NOT NULL"; 159 | $sql[] = "ALTER TABLE `".ee()->db->dbprefix."stash` CHANGE `parameters` `parameters` MEDIUMTEXT DEFAULT NULL"; 160 | 161 | // alter the bundle table 162 | $sql[] = "ALTER TABLE `".ee()->db->dbprefix."stash_bundles` CHANGE `bundle_name` `bundle_name` VARCHAR(255) NOT NULL"; 163 | $sql[] = "ALTER TABLE `".ee()->db->dbprefix."stash_bundles` CHANGE `bundle_label` `bundle_label` VARCHAR(255) NOT NULL"; 164 | $sql[] = "ALTER TABLE `".ee()->db->dbprefix."stash_bundles` DROP `site_id`"; 165 | $sql[] = "ALTER TABLE `".ee()->db->dbprefix."stash_bundles` ADD `is_locked` TINYINT(1) NOT NULL default '0'"; 166 | 167 | // delete all bundle records - note that this will cascade and delete variables 168 | $sql[] = "DELETE FROM `".ee()->db->dbprefix."stash_bundles` WHERE 1;"; 169 | 170 | // add the 'default' and 'template' bundles, mark as locked 171 | $sql[] = "INSERT INTO `".ee()->db->dbprefix."stash_bundles` VALUES(1, 'default', 'Default', 1);"; 172 | $sql[] = "INSERT INTO `".ee()->db->dbprefix."stash_bundles` VALUES(2, 'templates', 'Templates', 1);"; 173 | $sql[] = "INSERT INTO `".ee()->db->dbprefix."stash_bundles` VALUES(3, 'static', 'Static', 1);"; 174 | 175 | foreach ($sql as $query) 176 | { 177 | ee()->db->query($query); 178 | } 179 | } 180 | 181 | // Update to 2.5.4 182 | if (version_compare($current, '2.5.4', '<')) 183 | { 184 | // change indexes 185 | $sql[] = "ALTER TABLE `".ee()->db->dbprefix."stash` 186 | DROP INDEX `key_session`, 187 | DROP INDEX `key_name`, 188 | ADD UNIQUE `cache_key` (`key_name`, `bundle_id`, `site_id`, `session_id`), 189 | ADD INDEX `expire` (`expire`)"; 190 | } 191 | 192 | foreach ($sql as $query) 193 | { 194 | ee()->db->query($query); 195 | } 196 | 197 | // update version number 198 | return TRUE; 199 | 200 | } 201 | } 202 | 203 | /* End of file upd.stash.php */ 204 | /* Location: ./system/expressionengine/third_party/stash/upd.stash.php */ -------------------------------------------------------------------------------- /system/user/addons/stash/ext.stash.php: -------------------------------------------------------------------------------- 1 | settings = $settings; 34 | } 35 | 36 | // ------------------------------------------------------ 37 | 38 | /** 39 | * Activate Extension 40 | * 41 | * @return void 42 | */ 43 | public function activate_extension() 44 | { 45 | $this->_add_hook('stash_fetch_template', 10); 46 | $this->_add_hook('stash_post_parse', 1); 47 | $this->_add_hook('template_fetch_template', 10); 48 | $this->_add_hook('template_post_parse', 1); 49 | } 50 | 51 | // ------------------------------------------------------ 52 | 53 | /** 54 | * Disable Extension 55 | * 56 | * @return void 57 | */ 58 | public function disable_extension() 59 | { 60 | ee()->db->where('class', __CLASS__); 61 | ee()->db->delete('extensions'); 62 | } 63 | 64 | // ------------------------------------------------------ 65 | 66 | /** 67 | * Update Extension 68 | * 69 | * @param string String value of current version 70 | * @return mixed void on update / FALSE if none 71 | */ 72 | public function update_extension($current = '') 73 | { 74 | if ($current == '' OR (version_compare($current, $this->version) === 0)) 75 | { 76 | return FALSE; // up to date 77 | } 78 | 79 | // Update to 2.6.5 80 | if (version_compare($current, '2.6.5', '<')) 81 | { 82 | // change existing 'template_post_parse' extension priority to highest 83 | ee()->db->where('class', __CLASS__); 84 | ee()->db->where('hook', 'template_post_parse'); 85 | ee()->db->update('extensions', array('priority' => 1)); 86 | 87 | // add new hooks 88 | $this->_add_hook('stash_fetch_template', 10); 89 | $this->_add_hook('stash_post_parse', 1); 90 | } 91 | 92 | // update table row with current version 93 | ee()->db->where('class', __CLASS__); 94 | ee()->db->update('extensions', array('version' => $this->version)); 95 | } 96 | 97 | // -------------------------------------------------------------------- 98 | 99 | /** 100 | * Add extension hook 101 | * 102 | * @access private 103 | * @param string 104 | * @param integer 105 | * @return void 106 | */ 107 | private function _add_hook($name, $priority = 10) 108 | { 109 | ee()->db->insert('extensions', 110 | array( 111 | 'class' => __CLASS__, 112 | 'method' => $name, 113 | 'hook' => $name, 114 | 'settings' => '', 115 | 'priority' => $priority, 116 | 'version' => $this->version, 117 | 'enabled' => 'y' 118 | ) 119 | ); 120 | } 121 | 122 | // ------------------------------------------------------ 123 | // 124 | /** 125 | * Method for stash_fetch_template hook 126 | * 127 | * Inject early stash embeds into the template 128 | * 129 | * @access public 130 | * @param array 131 | * @return array 132 | */ 133 | public function stash_fetch_template($row) 134 | { 135 | return $this->template_fetch_template($row); 136 | } 137 | 138 | /** 139 | * Method for template_fetch_template hook 140 | * 141 | * Inject early stash embeds into the template 142 | * 143 | * @access public 144 | * @param array 145 | * @return array 146 | */ 147 | public function template_fetch_template($row) 148 | { 149 | // get the latest version of $row 150 | if (isset(ee()->extensions->last_call) && ee()->extensions->last_call) 151 | { 152 | $row = ee()->extensions->last_call; 153 | } 154 | 155 | // do we have any stash embeds? {stash:embed name=""} or {stash:embed:name} 156 | $matches = array(); 157 | if ( ! preg_match_all("/(".LD."stash:embed)([\s|:].*?)".RD."/s", $row['template_data'], $matches)) 158 | { 159 | return $row; 160 | } 161 | 162 | // deal with any unparsed {vars} inside parameters 163 | $temp = $row['template_data']; 164 | 165 | foreach ($matches[2] as $key => $val) 166 | { 167 | if (strpos($val, LD) !== FALSE) 168 | { 169 | if (version_compare(APP_VER, '4.0', '>=')) 170 | { 171 | $matches[0][$key] = ee('Variables/Parser')->getFullTag($matches[0][$key], $temp); 172 | } 173 | else 174 | { 175 | $matches[0][$key] = ee()->functions->full_tag($matches[0][$key], $temp); 176 | } 177 | 178 | $matches[2][$key] = substr(str_replace($matches[1][$key], '', $matches[0][$key]), 0, -1); 179 | $temp = str_replace($matches[0][$key], '', $temp); 180 | } 181 | } 182 | 183 | // match up embed params with tags 184 | $embeds = array(); 185 | 186 | foreach($matches[2] as $key => $val) 187 | { 188 | $parts = preg_split("/\s+/", $val, 2); 189 | 190 | if (version_compare(APP_VER, '4.0', '>=')) 191 | { 192 | $embed_params = (isset($parts[1])) ? ee('Variables/Parser')->parseTagParameters($parts[1]) : array(); 193 | } 194 | else 195 | { 196 | $embed_params = (isset($parts[1])) ? ee()->functions->assign_parameters($parts[1]) : array(); 197 | } 198 | 199 | if ($embed_params === FALSE) 200 | { 201 | $embed_params = array(); 202 | } 203 | 204 | // support {stash:embed:context:var} 205 | if ( ! empty($parts[0])) 206 | { 207 | $embed_params['name'] = trim($parts[0], ':'); 208 | } 209 | 210 | $embeds[trim($matches[0][$key], LD.RD)] = $embed_params; 211 | } 212 | 213 | if (count($embeds) > 0) 214 | { 215 | if ( ! class_exists('Stash')) 216 | { 217 | include_once PATH_THIRD . 'stash/mod.stash.php'; 218 | } 219 | 220 | foreach($embeds as $tag => $param) 221 | { 222 | $out = ''; 223 | 224 | if ( ! empty($param)) 225 | { 226 | // process early? 227 | if ( isset($param['process']) && $param['process'] == 'start') 228 | { 229 | // mandatory parameters 230 | $param['scope'] = 'site'; 231 | $param['file'] = 'yes'; 232 | $param['save'] = 'yes'; 233 | $param['bundle'] = 'template'; 234 | #$param['process'] = 'inline'; 235 | 236 | // set default parse parameters 237 | $param['parse_tags'] = isset($param['parse_tags']) ? $param['parse_tags'] : 'yes'; 238 | $param['parse_vars'] = isset($param['parse_vars']) ? $param['parse_vars'] : 'yes'; 239 | $param['parse_conditionals'] = isset($param['parse_conditionals']) ? $param['parse_conditionals'] : 'yes'; 240 | 241 | // parse="yes"? 242 | if (isset($param['parse'])) 243 | { 244 | if ( (bool) preg_match('/1|on|yes|y/i', $param['parse'])) 245 | { 246 | // parse="yes" 247 | $param['parse_tags'] = 'yes'; 248 | $param['parse_vars'] = 'yes'; 249 | $param['parse_conditionals'] = 'yes'; 250 | } 251 | elseif ( (bool) preg_match('/^(0|off|no|n)$/i', $param['parse'])) 252 | { 253 | // parse="no" 254 | $param['parse_tags'] = 'no'; 255 | $param['parse_vars'] = 'no'; 256 | $param['parse_conditionals'] = 'no'; 257 | } 258 | } 259 | 260 | $param['parse_depth'] = isset($param['parse_depth']) ? $param['parse_depth'] : 4; 261 | $param['parse_stage'] = isset($param['parse_stage']) ? $param['parse_stage'] : 'get'; 262 | $param['replace'] = isset($param['replace']) ? $param['replace'] : 'no'; 263 | 264 | // We need to load modules/plugins, which hasn't been done by the template class at this stage in the parse order. 265 | // This only runs once - the template class won't run it again if modules[] array is populated. 266 | if (count(ee()->TMPL->modules) == 0) 267 | { 268 | ee()->TMPL->fetch_addons(); 269 | } 270 | 271 | // parse stash embed vars passed as parameters in the form stash:my_var 272 | $embed_vars = array(); 273 | 274 | foreach ($param as $key => $val) 275 | { 276 | if (strncmp($key, 'stash:', 6) == 0) 277 | { 278 | $embed_vars[substr($key, 6)] = $val; 279 | } 280 | } 281 | 282 | // merge embed variables into the session cache in case they are used in another nested (or later-parsed) stash template 283 | if ( ! empty($embed_vars)) 284 | { 285 | // create a stash array in the session if we don't have one 286 | if ( ! array_key_exists('stash', ee()->session->cache) ) 287 | { 288 | ee()->session->cache['stash'] = array(); 289 | } 290 | ee()->session->cache['stash'] = array_merge(ee()->session->cache['stash'], $embed_vars); 291 | } 292 | 293 | // instantiate Stash without initialising 294 | $s = new Stash(TRUE); 295 | 296 | // get the file 297 | $out = $s->get($param); 298 | unset($s); 299 | 300 | // minimal replace of embed vars if we're not using Stash to parse the template variables 301 | if ($param['parse_vars'] == 'no') 302 | { 303 | foreach ($embed_vars as $key => $val) 304 | { 305 | $out = str_replace(LD.'stash:'.$key.RD, $val, $out); 306 | } 307 | } 308 | 309 | // convert any nested {stash:embed} into {exp:stash:embed} tags 310 | $out = str_replace(LD.'stash:embed', LD.'exp:stash:embed', $out); 311 | } 312 | else 313 | { 314 | // convert it into a normal tag... 315 | $out = LD.'exp:'.$tag.RD; 316 | } 317 | } 318 | 319 | // Set as a global variable so it gets replaced into the template early by the Template class 320 | // $row is a copy not a reference, so this is the only way to change stuff in the actual template! 321 | // Make sure the stash embeds are prepended to beginning of the globals array so that any global vars 322 | // passed as parameters get parsed later by EE 323 | ee()->config->_global_vars = array($tag => $out) + ee()->config->_global_vars; 324 | } 325 | } 326 | 327 | return $row; 328 | } 329 | 330 | // ------------------------------------------------------ 331 | // 332 | /** 333 | * Method for stash_post_parse hook 334 | * 335 | * @param string Parsed template string 336 | * @param bool Whether an embed or not 337 | * @param integer Site ID 338 | * @return string Template string 339 | */ 340 | public function stash_post_parse($template, $sub, $site_id) 341 | { 342 | return $this->template_post_parse($template, $sub, $site_id, TRUE, FALSE); 343 | } 344 | 345 | /** 346 | * Method for template_post_parse hook 347 | * 348 | * @param string Parsed template string 349 | * @param bool Whether an embed or not 350 | * @param integer Site ID 351 | * @param bool Has the extension been called by Stash rather than EE? 352 | * @param bool Final call of this extension 353 | * @return string Template string 354 | */ 355 | public function template_post_parse($template, $sub, $site_id, $from_stash = FALSE, $final = FALSE) 356 | { 357 | // play nice with other extensions on this hook 358 | if (isset(ee()->extensions->last_call) && ee()->extensions->last_call) 359 | { 360 | $template = ee()->extensions->last_call; 361 | } 362 | 363 | // is this the final template? 364 | if ($sub == FALSE && $final == FALSE) 365 | { 366 | // check the cache for postponed tags 367 | if ( ! isset(ee()->session->cache['stash']['__template_post_parse__'])) 368 | { 369 | ee()->session->cache['stash']['__template_post_parse__'] = array(); 370 | } 371 | 372 | // an array of tags needing to be post-parsed 373 | $cache = ee()->session->cache['stash']['__template_post_parse__']; 374 | 375 | // are we capturing the final output of the rendered EE host template? 376 | $save_output = FALSE; 377 | 378 | // run any postponed stash tags 379 | if ( ! empty($cache)) 380 | { 381 | $context = ''; 382 | 383 | if ( ! class_exists('Stash')) 384 | { 385 | include_once PATH_THIRD . 'stash/mod.stash.php'; 386 | } 387 | else 388 | { 389 | // get static context if it has been set 390 | $context = Stash::$context; 391 | } 392 | 393 | // save TMPL values for later 394 | $tagparams = isset(ee()->TMPL->tagparams) ? ee()->TMPL->tagparams : array(); 395 | $tagdata = isset(ee()->TMPL->tagdata) ? ee()->TMPL->tagdata : ''; 396 | 397 | // reset tagparams so Stash is instantiated with default values 398 | ee()->TMPL->tagparams = array(); 399 | 400 | // instantiate but don't initialise 401 | $s = new Stash(TRUE); 402 | 403 | // sort by priority 404 | $cache = $s->sort_by_key($cache, 'priority', 'sort_by_integer'); 405 | 406 | // loop through, prep the Stash instance, call the postponed tag and replace output into the placeholder 407 | foreach($cache as $placeholder => $tag) 408 | { 409 | if ( strpos( $template, $placeholder ) !== FALSE) 410 | { 411 | // make sure there is a placeholder in the template 412 | // it may have been removed by advanced conditional processing 413 | ee()->TMPL->log_item("Stash: post-processing tag: " . $tag['tagproper'] . " will be replaced into " . LD . $placeholder . RD); 414 | 415 | ee()->TMPL->tagparams = $tag['tagparams']; 416 | ee()->TMPL->tagdata = $tag['tagdata']; 417 | 418 | // restore context @ pointer in context parameter 419 | if (isset(ee()->TMPL->tagparams['context']) && ee()->TMPL->tagparams['context'] == '@') 420 | { 421 | ee()->TMPL->tagparams['context'] = $context; 422 | } 423 | 424 | // restore context @ pointer if hardcoded in name parameter 425 | if (isset(ee()->TMPL->tagparams['name']) 426 | && strncmp(ee()->TMPL->tagparams['name'], '@:', 2) == 0) 427 | { 428 | ee()->TMPL->tagparams['name'] = str_replace('@', $context, ee()->TMPL->tagparams['name']); 429 | } 430 | 431 | // restore context @ pointer if hardcoded in file_name parameter 432 | if (isset(ee()->TMPL->tagparams['file_name']) 433 | && strncmp(ee()->TMPL->tagparams['file_name'], '@:', 2) == 0) 434 | { 435 | ee()->TMPL->tagparams['file_name'] = str_replace('@', $context, ee()->TMPL->tagparams['file_name']); 436 | } 437 | 438 | // initialise Stash with our custom tagparams 439 | $s->init(TRUE); 440 | 441 | // has the save_output or final_output tags been called? 442 | if ( $tag['method'] === 'save_output' || $tag['method'] === 'final_output') 443 | { 444 | // remove placeholder from the template 445 | $template = str_replace(LD.$placeholder.RD, '', $template); 446 | 447 | // allow the called method to alter/cache the entire template 448 | $template = $s->{$tag['method']}($template); 449 | } 450 | else 451 | { 452 | // call the tag 453 | $out = $s->{$tag['method']}(); 454 | 455 | // replace the output of our tag into the template placeholder 456 | $template = str_replace(LD.$placeholder.RD, $out, $template); 457 | } 458 | 459 | // remove the placeholder from the cache so we don't iterate over it in future calls of this hook 460 | unset(ee()->session->cache['stash']['__template_post_parse__'][$placeholder]); 461 | } 462 | } 463 | 464 | // restore original TMPL values 465 | ee()->TMPL->tagparams = $tagparams; 466 | ee()->TMPL->tagdata = $tagdata; 467 | } 468 | 469 | // cleanup 470 | unset($cache); 471 | 472 | // just before the template is sent to output 473 | if (FALSE == $from_stash) 474 | { 475 | // batch processing of cached variables 476 | ee()->load->model('stash_model'); 477 | 478 | // get the query queue by reference 479 | $queue = &ee()->stash_model->get_queue(); 480 | 481 | // we need to flatten the data in the queue to a string, so we can parse it 482 | // first, let's extract the data into a simple indexed array... 483 | $data = array(); 484 | 485 | foreach($queue->inserts as $table => $inserts) 486 | { 487 | foreach($inserts as $query) 488 | { 489 | $data[] = $query['parameters']; // will always exist 490 | } 491 | } 492 | 493 | foreach($queue->updates as $table => $updates) 494 | { 495 | foreach($updates as $query) 496 | { 497 | if (isset($query['parameters'])) 498 | { 499 | $data[] = $query['parameters']; 500 | } 501 | } 502 | } 503 | 504 | if ( count($data) > 0 ) 505 | { 506 | // flatten data so we can parse it 507 | $delim = '|' . ee()->functions->random() . '|'; 508 | $data = (string) implode($delim, $data); 509 | 510 | // Run template_post_parse on the flattened data. 511 | // We need to disable the in_progress recursion check in EE_Extensions::universal_call 512 | // don't even think about making this private, @pkriete ! 513 | ee()->extensions->in_progress = ''; 514 | $data = ee()->extensions->call( 515 | 'template_post_parse', 516 | $data, 517 | FALSE, 518 | ee()->config->item('site_id'), 519 | TRUE, 520 | TRUE // prevent recursion of this method 521 | ); 522 | ee()->extensions->in_progress = 'template_post_parse'; // restore recursion check 523 | 524 | // explode the data back into an array 525 | $data = (array) explode($delim, $data); 526 | 527 | // update the queues with the parsed parameter values 528 | foreach($queue->inserts as $table => $inserts) 529 | { 530 | foreach($inserts as $cache_key => $query) 531 | { 532 | $queue->inserts[$table][$cache_key]['parameters'] = array_shift($data); 533 | } 534 | } 535 | 536 | foreach($queue->updates as $table => $updates) 537 | { 538 | foreach($updates as $cache_key => $query) 539 | { 540 | if (isset($query['parameters'])) 541 | { 542 | $queue->updates[$table][$cache_key]['parameters'] = array_shift($data); 543 | } 544 | } 545 | } 546 | 547 | unset($data); 548 | } 549 | 550 | // process inserts/updates queue 551 | ee()->TMPL->log_item("Stash: batch processing queued queries"); 552 | ee()->stash_model->process_queue(); 553 | } 554 | } 555 | 556 | return $template; 557 | } 558 | } 559 | 560 | /* End of file ext.stash.php */ 561 | /* Location: ./system/expressionengine/third_party/stash/ext.stash.php */ -------------------------------------------------------------------------------- /system/user/addons/stash/models/stash_model.php: -------------------------------------------------------------------------------- 1 | 1, 21 | 'template' => 2, 22 | 'static' => 3 23 | ); 24 | 25 | // name of cache files 26 | private $_static_file = 'index.html'; 27 | 28 | // placeholder for indexes 29 | private $_index_key = '[index]'; 30 | 31 | public function __construct() 32 | { 33 | parent::__construct(); 34 | 35 | // batch processing of queued queries 36 | self::$queue = new stdClass(); 37 | self::$queue->inserts = array(); 38 | self::$queue->updates = array(); 39 | 40 | // Process the queue on shutdown. 41 | // Note that as PHP-FPM does not support this function, 42 | // we call process_queue() in Stash_ext::template_post_parse() as well. 43 | // But, you ask, so why do this at all? 44 | // Because if you SET/UPDATE a Stash variable outside of an EE 45 | // template, you can't rely on extension hooks being triggered 46 | register_shutdown_function(array($this, "process_queue")); 47 | } 48 | 49 | /** 50 | * Insert key for user session 51 | * 52 | * @param string $key 53 | * @param integer $bundle_id 54 | * @param string|null $session_id 55 | * @param integer $site_id 56 | * @param integer $expire 57 | * @param string $parameters 58 | * @param string $label 59 | * @return boolean 60 | */ 61 | public function insert_key(string $key, int $bundle_id = 1, string $session_id = NULL, int $site_id = 1, int $expire = 0, string $parameters = '', string $label = '') 62 | { 63 | $cache_key = $key . '_'. $bundle_id .'_' .$site_id . '_' . $session_id; 64 | 65 | $data = array( 66 | 'key_name' => $key, 67 | 'bundle_id' => $bundle_id, 68 | 'session_id' => $session_id, 69 | 'site_id' => $site_id, 70 | 'created' => ee()->localize->now, 71 | 'expire' => $expire, 72 | 'parameters' => $parameters, 73 | 'key_label' => $label 74 | ); 75 | 76 | if ($result = $this->queue_insert('stash', $cache_key, $data)) 77 | { 78 | // store a record of the key 79 | self::$inserted_keys[] = $cache_key; 80 | 81 | // cache result to eliminate need for a query in future gets 82 | self::$keys[$cache_key] = $parameters; 83 | 84 | return TRUE; 85 | } 86 | 87 | return FALSE; 88 | } 89 | 90 | /** 91 | * Check to see if a key has been inserted within this page load 92 | * 93 | * @param string $cache_key 94 | * @return bool 95 | */ 96 | public function is_inserted_key($cache_key) 97 | { 98 | return in_array($cache_key, self::$inserted_keys) ? TRUE : FALSE; 99 | } 100 | 101 | /** 102 | * Update key for user session 103 | * 104 | * @param string $key 105 | * @param int $bundle_id 106 | * @param string $session_id 107 | * @param integer $site_id 108 | * @param integer $expire 109 | * @param string|null $parameters 110 | * @return boolean 111 | */ 112 | public function update_key(string $key, int $bundle_id = 1, string $session_id = '', int $site_id = 1, int $expire = 0, string $parameters = NULL) 113 | { 114 | $cache_key = $key . '_'. $bundle_id .'_' .$site_id . '_' . $session_id; 115 | 116 | $data = array( 117 | 'key_name' => $key, 118 | 'bundle_id' => $bundle_id, 119 | 'site_id' => $site_id, 120 | 'created' => ee()->localize->now, 121 | 'expire' => $expire, 122 | ); 123 | 124 | if ($parameters !== NULL) 125 | { 126 | $data += array('parameters' => $parameters); 127 | } 128 | 129 | if ( ! empty($session_id)) 130 | { 131 | $data += array('session_id' => $session_id); 132 | } 133 | 134 | if ($result = $this->queue_update('stash', $cache_key, $data)) 135 | { 136 | // update cache 137 | self::$keys[$cache_key] = $parameters; 138 | 139 | return TRUE; 140 | } 141 | 142 | return FALSE; 143 | } 144 | 145 | /** 146 | * Refresh key for user session 147 | * 148 | * @param string $key 149 | * @param int $bundle_id 150 | * @param string $session_id 151 | * @param integer $site_id 152 | * @param integer $refresh Seconds to expiry date 153 | * @return boolean 154 | */ 155 | public function refresh_key(string $key, int $bundle_id = 1, string $session_id = '', int $site_id = 1, int $refresh = 0) 156 | { 157 | $expire = ee()->localize->now + $refresh; 158 | return $this->update_key($key, $bundle_id, $session_id, $site_id, $expire); 159 | } 160 | 161 | /** 162 | * Get key value 163 | * 164 | * @param string $key 165 | * @param int $bundle_id 166 | * @param string $session_id 167 | * @param integer $site_id 168 | * @param string $col 169 | * @return bool|string 170 | */ 171 | public function get_key(string $key, int $bundle_id = 1, string $session_id = '', int $site_id = 1, string $col = 'parameters') 172 | { 173 | $cache_key = $key . '_' . $bundle_id .'_' . $session_id . $site_id . '_' . $col; 174 | 175 | if ( ! isset(self::$keys[$cache_key])) 176 | { 177 | $this->db->select($col .', created, expire') 178 | ->from('stash') 179 | ->where('key_name', $key) 180 | ->where('bundle_id', $bundle_id) 181 | ->where('site_id', $site_id) 182 | ->limit(1); 183 | if ( ! empty($session_id)) 184 | { 185 | $this->db->where('session_id', $session_id); 186 | } 187 | 188 | $result = $this->db->get(); 189 | 190 | if ($result->num_rows() === 1) 191 | { 192 | $key_created = $result->row('created'); 193 | $key_expire = $result->row('expire'); 194 | 195 | // if this key expires soon and is scoped to user session, refresh it 196 | if ($key_expire > 0 && $session_id !== '_global' && ! empty($session_id)) 197 | { 198 | $refresh = $key_expire - $key_created; // refresh period (seconds) 199 | $expire = $key_expire - ee()->localize->now; // time to expiry (seconds) 200 | 201 | if ( ($refresh / $expire) > 2 ) 202 | { 203 | // more than half the refresh time has passed since the last time key was accessed 204 | // so let's refresh the key expiry 205 | $this->refresh_key($key, $bundle_id, $session_id, $site_id, $refresh); 206 | } 207 | } 208 | 209 | // cache result 210 | self::$keys[$cache_key] = $result->row($col); 211 | } 212 | else 213 | { 214 | // Cache empty result, this will get overwritten if the key is inserted later on 215 | // Otherwise it will prevent repeated unnecessary queries for empty variables 216 | self::$keys[$cache_key] = ''; 217 | } 218 | } 219 | if (self::$keys[$cache_key] === '') 220 | { 221 | return FALSE; 222 | } 223 | 224 | return self::$keys[$cache_key]; 225 | } 226 | 227 | /** 228 | * Get key expiry date 229 | * 230 | * @param string $key 231 | * @param string $session_id 232 | * @param integer $site_id 233 | * @return int | boolean 234 | */ 235 | public function get_key_expiry(string $key, int $bundle_id = 1, string $session_id = '', int $site_id = 1) 236 | { 237 | $cache_key = $key . '_'. $bundle_id .'_' .$site_id . '_' . $session_id; 238 | 239 | if ( isset(self::$keys[$cache_key])) 240 | { 241 | return self::$keys[$cache_key]['expire']; 242 | } 243 | 244 | return FALSE; 245 | } 246 | 247 | /** 248 | * Delete key(s) by name, optionally limited to keys registered with the user session 249 | * 250 | * @param string $key 251 | * @param bool|integer $bundle_id 252 | * @param string|null $session_id 253 | * @param integer $site_id 254 | * @param integer $invalidate Delay until cached item expires (seconds) 255 | * @return boolean 256 | */ 257 | public function delete_key(string $key, $bundle_id = FALSE, string $session_id = NULL, int $site_id = 1, int $invalidate=0) 258 | { 259 | $this->db->where('key_name', $key) 260 | ->where('site_id', $site_id); 261 | 262 | // match a specific bundle 263 | if ($bundle_id) 264 | { 265 | $this->db->where('bundle_id', $bundle_id); 266 | } 267 | 268 | if ( ! is_null($session_id)) 269 | { 270 | $this->db->where('session_id', $session_id); 271 | 272 | if ($session_id !== '_global') 273 | { 274 | // make sure we only delete the user's variable 275 | $this->db->limit(1); 276 | } 277 | } 278 | 279 | // get matching key(s) 280 | $query = $this->db->select('id, site_id, key_name, key_label, session_id, bundle_id')->get('stash'); 281 | 282 | if ($query->num_rows() > 0) 283 | { 284 | if ( $this->delete_cache($query->result(), TRUE, $invalidate)) 285 | { 286 | // deleted, now remove the key from the internal key cache 287 | $cache_key = $key . '_'. $bundle_id .'_' .$site_id . '_' . $session_id; 288 | 289 | if ( isset(self::$keys[$cache_key])) 290 | { 291 | unset(self::$keys[$cache_key]); 292 | } 293 | 294 | return TRUE; 295 | } 296 | } 297 | 298 | return FALSE; 299 | } 300 | 301 | /** 302 | * Delete key(s) matching a regular expression, and/or scope, and/or bundle 303 | * 304 | * @param int|bool $bundle_id 305 | * @param string|null $session_id 306 | * @param integer $site_id 307 | * @param string|null $regex a regular expression 308 | * @param integer $invalidate Delay until cached item expires (seconds) 309 | * @return boolean 310 | */ 311 | public function delete_matching_keys($bundle_id = FALSE, string $session_id=NULL, int $site_id = 1, string $regex=NULL, int $invalidate=0) 312 | { 313 | $deleted = FALSE; // have keys been deleted from the database? 314 | $clear_static = TRUE; // attempt to delete corresponding *individual* static cache files? 315 | 316 | // Can we clear the entire static cache in one go (to minimize disk access)? 317 | if (ee()->config->item('stash_static_cache_enabled') 318 | && $regex === NULL 319 | && $invalidate === 0) 320 | { 321 | if ( ! $bundle_id || $this->_can_static_cache($bundle_id) ) 322 | { 323 | if ( is_null($session_id) || $session_id === 'site' || $session_id === 'all') 324 | { 325 | $this->_delete_dir('/', $site_id); 326 | $clear_static = FALSE; 327 | } 328 | } 329 | } 330 | 331 | // clear the db 332 | $this->db->where('site_id', $site_id); 333 | 334 | // match a specific bundle 335 | if ($bundle_id) 336 | { 337 | $this->db->where('bundle_id', $bundle_id); 338 | } 339 | 340 | // match session_id 341 | if ( ! is_null($session_id)) 342 | { 343 | // scope supplied? 344 | if ($session_id === 'user') 345 | { 346 | // all user-scoped variables 347 | $this->db->where('session_id !=', '_global'); 348 | } 349 | elseif($session_id === 'site') 350 | { 351 | // all site-scoped variables 352 | $this->db->where('session_id', '_global'); 353 | } 354 | else 355 | { 356 | // a specific user session 357 | $this->db->where('session_id', $session_id); 358 | } 359 | } 360 | 361 | // match key_name regex 362 | if ( ! is_null($regex)) 363 | { 364 | $this->db->where('key_name RLIKE ', $this->db->escape($regex), FALSE); 365 | } 366 | 367 | // get matching keys 368 | $query = $this->db->select('id, site_id, key_name, key_label, session_id, bundle_id')->get('stash'); 369 | 370 | if ($query->num_rows() > 0) 371 | { 372 | $deleted = $this->delete_cache($query->result(), $clear_static, $invalidate); 373 | } 374 | 375 | if ($deleted) 376 | { 377 | // deleted successfully, reset the static key cache 378 | self::$keys = array(); 379 | } 380 | 381 | return $deleted; 382 | } 383 | 384 | /** 385 | * Delete an array of variables in a given site 386 | * 387 | * @param array $vars An array of objects 388 | * @param boolean $clear_static Clear the static cache too, for variables in the static bundle? 389 | * @param integer $invalidate Delay until cached item expires (seconds) 390 | * @param bool $call_hook 391 | * @return boolean 392 | */ 393 | protected function delete_cache(array $vars, bool $clear_static = TRUE, int $invalidate = 0, bool $call_hook = TRUE) 394 | { 395 | // get a list of variable ids 396 | $ids = array(); 397 | foreach ($vars as $row) 398 | { 399 | $ids[] = $row->id; 400 | } 401 | 402 | // delete any db records 403 | $result = FALSE; 404 | 405 | if ($invalidate > 0) 406 | { 407 | // "Soft delete" - update variables to expire at random intervals within 408 | // the invalidation period and so help prevent cache stampedes. 409 | // When the variables are subsequently pruned, this function is triggered 410 | // again and any corresponding caches will be deleted 411 | $result = $this->_invalidate($ids, $invalidate); 412 | } 413 | else 414 | { 415 | // delete immediately 416 | $result = ee()->db->where_in('id', $ids)->delete('stash'); 417 | 418 | // delete corresponding caches 419 | foreach ($vars as $row) 420 | { 421 | if ($clear_static) 422 | { 423 | // delete any corresponding static cache files, individually 424 | $this->delete_static_cache($row->key_name, $row->bundle_id, $row->site_id); 425 | } 426 | 427 | // ------------------------------------- 428 | // 'stash_delete' hook 429 | // ------------------------------------- 430 | if (ee()->extensions->active_hook('stash_delete') === TRUE 431 | && $call_hook === TRUE) 432 | { 433 | ee()->extensions->call('stash_delete', array( 434 | 'key_name' => $row->key_name, 435 | 'key_label' => $row->key_label, 436 | 'bundle_id' => $row->bundle_id, 437 | 'session_id' => $row->session_id, 438 | 'site_id' => $row->site_id 439 | )); 440 | } 441 | } 442 | } 443 | 444 | return $result; 445 | } 446 | 447 | /** 448 | * Flush the entire cache for a given site, immediately 449 | * 450 | * @param integer $site_id 451 | * @return boolean 452 | */ 453 | public function flush_cache(int $site_id = 1) 454 | { 455 | // delete all variables saved in the db 456 | if ($result = ee()->db->where('site_id', $site_id)->delete('stash')) 457 | { 458 | // remove all files in the static dir, if static caching is enabled 459 | if ( ee()->config->item('stash_static_cache_enabled')) 460 | { 461 | $this->_delete_dir('/', $site_id); 462 | } 463 | 464 | // ------------------------------------- 465 | // 'stash_flush_cache' hook 466 | // ------------------------------------- 467 | if (ee()->extensions->active_hook('stash_flush_cache') === TRUE) 468 | { 469 | ee()->extensions->call('stash_flush_cache', $site_id); 470 | } 471 | 472 | return $result; 473 | } 474 | 475 | return FALSE; 476 | } 477 | 478 | /** 479 | * Update variables to expire at random intervals within the 480 | * invalidation period and so help prevent cache stampedes 481 | * 482 | * @param array $ids An array of variable ids 483 | * @param integer $period the invalidation period in seconds 484 | * @return boolean 485 | */ 486 | private function _invalidate(array $ids, int $period=0) 487 | { 488 | $now = ee()->localize->now; 489 | 490 | if (count($ids) > 1) 491 | { 492 | // sort low to high 493 | sort($ids); 494 | 495 | // get the last id value and the count 496 | $id_end = end($ids); 497 | $id_count = count($ids)-1; 498 | 499 | // what we're doing here is approximately dividing the expiry delay across the target ids, 500 | // increasing the delay according the original id value, so that variables 501 | // generated later in the original template, get regenerated later too 502 | ee()->db->where_in('id', $ids); 503 | $this->db->set('expire', 'FLOOR (' . ee()->localize->now . ' + '.$period.' - ( ('.$id_end.' - id) / '.$id_count.' * ' . $period . ' ))', false); 504 | return $this->db->update('stash'); 505 | } 506 | else 507 | { 508 | // invalidating a single item 509 | ee()->db->where('id', $ids[0]); 510 | $this->db->set('expire', ee()->localize->now); 511 | return $this->db->update('stash'); 512 | } 513 | } 514 | 515 | /** 516 | * Prune expired keys 517 | * 518 | * @return boolean 519 | */ 520 | public function prune_keys() 521 | { 522 | $query = $this->db->get_where('stash', array( 523 | 'expire <' => ee()->localize->now, 524 | 'expire !=' => '0' 525 | )); 526 | 527 | // ------------------------------------- 528 | // 'stash_prune' hook 529 | // ------------------------------------- 530 | if (ee()->extensions->active_hook('stash_prune') === TRUE) 531 | { 532 | ee()->extensions->call('stash_prune', $query->result_array()); 533 | } 534 | 535 | if ($query->num_rows() > 0) 536 | { 537 | if ($deleted = $this->delete_cache($query->result(), TRUE, 0, FALSE)) 538 | { 539 | return TRUE; 540 | } 541 | } 542 | 543 | return FALSE; 544 | } 545 | 546 | /** 547 | * Get a bundle id from the name 548 | * 549 | * @param string $bundle 550 | * @return bool|int 551 | */ 552 | public function get_bundle_by_name(string $bundle) 553 | { 554 | $cache_key = $bundle; 555 | 556 | if ( ! isset(self::$bundle_ids[$cache_key])) 557 | { 558 | $result = $this->db->select('id') 559 | ->from('stash_bundles') 560 | ->where('bundle_name', $bundle) 561 | ->limit(1) 562 | ->get(); 563 | 564 | if ($result->num_rows() === 1) 565 | { 566 | self::$bundle_ids[$cache_key] = $result->row('id'); 567 | } 568 | else 569 | { 570 | self::$bundle_ids[$cache_key] = FALSE; 571 | } 572 | } 573 | return self::$bundle_ids[$cache_key]; 574 | } 575 | 576 | 577 | /** 578 | * Get a bundle name from the id 579 | * 580 | * @param integer $bundle_id 581 | * @return bool|string 582 | */ 583 | public function get_bundle_by_id(int $bundle_id) 584 | { 585 | if ( ! $bundle_name = array_search($bundle_id, self::$bundle_ids) ) 586 | { 587 | $result = $this->db->select('bundle_name') 588 | ->from('stash_bundles') 589 | ->where('id', $bundle_id) 590 | ->limit(1) 591 | ->get(); 592 | 593 | if ($result->num_rows() === 1) 594 | { 595 | $bundle_name = $result->row('bundle_name'); 596 | self::$bundle_ids[$bundle_name] = $bundle_id; 597 | } 598 | else 599 | { 600 | $bundle_name = FALSE; 601 | } 602 | } 603 | 604 | return $bundle_name; 605 | } 606 | 607 | /** 608 | * Insert a bundle 609 | * 610 | * @param string $bundle 611 | * @param string $bundle_label 612 | * @return bool|int 613 | */ 614 | public function insert_bundle(string $bundle, string $bundle_label = '') 615 | { 616 | $data = array( 617 | 'bundle_name' => $bundle, 618 | 'bundle_label' => $bundle_label 619 | ); 620 | 621 | if ( $result = $this->db->insert('stash_bundles', $data) ) 622 | { 623 | return $this->db->insert_id(); 624 | } 625 | 626 | return FALSE; 627 | } 628 | 629 | /** 630 | * Check if there is at least one entry for the bundle in this site 631 | * 632 | * @param int $bundle_id 633 | * @param int $site_id 634 | * @return bool 635 | */ 636 | public function bundle_entry_exists(int $bundle_id, int $site_id = 1) 637 | { 638 | $result = $this->db->select('id') 639 | ->from('stash') 640 | ->where('bundle_id', $bundle_id) 641 | ->where('site_id', $site_id) 642 | ->limit(1) 643 | ->get(); 644 | 645 | if ($result->num_rows() === 1) 646 | { 647 | return TRUE; 648 | } 649 | 650 | return FALSE; 651 | } 652 | 653 | /** 654 | * Count the number of entries for a given bundle 655 | * 656 | * @param int $bundle_id 657 | * @param int $site_id 658 | * @return int 659 | */ 660 | public function bundle_entry_count(int $bundle_id, int $site_id = 1) 661 | { 662 | $result = $this->db->select('COUNT(id) AS row_count') 663 | ->from('stash') 664 | ->where('bundle_id', $bundle_id) 665 | ->where('site_id', $site_id) 666 | ->get(); 667 | 668 | if ($result->num_rows() === 1) 669 | { 670 | return $result->row('row_count'); 671 | } 672 | 673 | return 0; 674 | } 675 | 676 | 677 | /* 678 | ================================================================ 679 | Static cache handler 680 | ================================================================ 681 | */ 682 | 683 | /** 684 | * Check if the variable can be cached as a static file and write it 685 | * 686 | * @param string|array $data 687 | * @return boolean 688 | */ 689 | protected function write_static_cache($data) 690 | { 691 | if ( ! isset($data['bundle_id'])) { 692 | return FALSE; 693 | } 694 | 695 | // write to static file cache? 696 | if ($this->_can_static_cache($data['bundle_id'])) 697 | { 698 | // extract the associated uri from the variable key 699 | $uri = $this->parse_uri_from_key($data['key_name']); 700 | 701 | // cache that mother 702 | return $this->_write_file($uri, $data['site_id'], $data['parameters']); 703 | } 704 | 705 | return FALSE; 706 | } 707 | 708 | /** 709 | * Delete the associated static file for a given variable 710 | * 711 | * @param string $key 712 | * @param integer $bundle_id 713 | * @param int $site_id 714 | * @return boolean 715 | */ 716 | protected function delete_static_cache(string $key, int $bundle_id, int $site_id) 717 | { 718 | // write to static file cache? 719 | if ($this->_can_static_cache($bundle_id)) 720 | { 721 | // extract the associated uri from the variable key 722 | $uri = $this->parse_uri_from_key($key); 723 | 724 | // delete the cache file 725 | return $this->_delete_file($uri, $site_id); 726 | } 727 | 728 | return FALSE; 729 | } 730 | 731 | /** 732 | * Write a static file 733 | * 734 | * @param string $uri 735 | * @param int $site_id 736 | * @param string|null $parameters 737 | * @return boolean 738 | */ 739 | private function _write_file(string $uri, int $site_id, string $parameters = NULL) 740 | { 741 | ee()->load->helper('file'); 742 | 743 | if ($path = $this->_path($uri, $site_id)) 744 | { 745 | // Make sure the directory exists 746 | if (file_exists($path) || @mkdir($path, 0777, TRUE)) 747 | { 748 | // Write the static file 749 | if (@write_file($path.$this->_static_file, $parameters, 'w+')) 750 | { 751 | return TRUE; 752 | } 753 | 754 | } 755 | } 756 | return FALSE; 757 | } 758 | 759 | /** 760 | * Delete a static file 761 | * 762 | * @param string $uri 763 | * @param int $site_id 764 | * @return boolean 765 | */ 766 | private function _delete_file(string $uri = '/', int $site_id = 1) 767 | { 768 | if ($path = ($this->_path($uri, $site_id) && @unlink($this->_path($uri, $site_id) . $this->_static_file))) 769 | { 770 | return TRUE; 771 | } 772 | return FALSE; 773 | } 774 | 775 | /** 776 | * Recursively delete directories and files in a static cache directory 777 | * 778 | * @param string $uri 779 | * @param int $site_id 780 | * @return boolean 781 | */ 782 | private function _delete_dir(string $uri, int $site_id) 783 | { 784 | ee()->load->helper('file'); 785 | 786 | if ( $path = ($this->_path($uri, $site_id) && delete_files($this->_path($uri, $site_id), true))) 787 | { 788 | return TRUE; 789 | } 790 | return FALSE; 791 | } 792 | 793 | /** 794 | * Returns the path to the cache directory, if it exists 795 | * 796 | * @param string $uri 797 | * @param int $site_id 798 | * @return bool|string 799 | */ 800 | private function _path(string $uri = '/', int $site_id = 1) 801 | { 802 | // Get parts 803 | $path = ee()->config->item('stash_static_basepath'); 804 | 805 | // Check the supplied cache path exists 806 | if ( ! file_exists($path)) 807 | { 808 | return FALSE; 809 | } 810 | 811 | // Blacklist of characters we don't want to allow as directory names in the cache 812 | $bad = ee()->config->item('stash_static_character_blacklist') 813 | ? (array) ee()->config->item('stash_static_character_blacklist') 814 | : array(LD, RD, '<', '>', ':', '"', '\\', '|', '*', '.'); 815 | $new_uri = str_replace($bad, '', $uri); 816 | 817 | if ($uri !== $new_uri) 818 | { 819 | return FALSE; 820 | } 821 | 822 | // Build the path 823 | return trim($path.'/'.$site_id.'/'.trim($uri, '/')).'/'; 824 | } 825 | 826 | /** 827 | * Check that static cache is enabled, and the bundle is static 828 | * 829 | * @param integer $bundle_id 830 | * @return boolean 831 | */ 832 | private function _can_static_cache(int $bundle_id) 833 | { 834 | if ( ee()->config->item('stash_static_cache_enabled')) 835 | { 836 | if ($this->get_bundle_by_id($bundle_id) === 'static') 837 | { 838 | return TRUE; 839 | } 840 | } 841 | 842 | return FALSE; 843 | } 844 | 845 | 846 | /* 847 | ================================================================ 848 | Utility 849 | ================================================================ 850 | */ 851 | 852 | /** 853 | * Parse a URI from a stash variable key (typically, the uri of a cached page) 854 | * 855 | * @param string $key 856 | * @return string 857 | */ 858 | public function parse_uri_from_key(string $key) 859 | { 860 | $uri = explode(':', $key); 861 | return $uri[0] === $this->_index_key ? '' : $uri[0]; 862 | } 863 | 864 | /** 865 | * Getter: returns the index key placeholder 866 | * 867 | * @return string 868 | */ 869 | public function get_index_key() 870 | { 871 | return $this->_index_key; 872 | } 873 | 874 | /** 875 | * Prepare INSERT IGNORE BATCH SQL query 876 | * 877 | * @param string $table The table to insert into 878 | * @param Array $data Array in form of "Column" => "Value", ... 879 | * @return void 880 | */ 881 | protected function insert_ignore_batch(string $table, array $data) 882 | { 883 | $_keys = array(); 884 | $_prepared = array(); 885 | 886 | foreach ($data as $row) 887 | { 888 | $_values = array(); 889 | 890 | // static caching - save an index of the variable only? 891 | if (ee()->config->item('stash_static_cache_index') 892 | && $this->_can_static_cache($row['bundle_id'])) 893 | { 894 | $row['parameters'] = ''; // remove variable content 895 | } 896 | 897 | foreach ($row as $col => $val) 898 | { 899 | // add key 900 | if ( ! in_array($col, $_keys) ) 901 | { 902 | $_keys[] = $col; 903 | } 904 | 905 | // add values 906 | $_values[] = $this->db->escape($val); 907 | } 908 | $_prepared[] = '(' . implode(',', $_values) . ')'; 909 | } 910 | 911 | $this->db->query('INSERT IGNORE INTO '.$this->db->dbprefix.$table.' ('.implode(',',$_keys).') VALUES '.implode(',', array_values($_prepared)).';'); 912 | } 913 | 914 | /** 915 | * Queue an insert for batch processing later 916 | * 917 | * @param string $table The table to insert into 918 | * @param string $cache_key Unique key identifying this variable 919 | * @param Array $data Array in form of "Column" => "Value", ... 920 | * @return boolean 921 | */ 922 | protected function queue_insert(string $table, string $cache_key, array $data) 923 | { 924 | if ( ! isset(self::$queue->inserts[$table])) 925 | { 926 | self::$queue->inserts[$table] = array(); 927 | } 928 | elseif( isset(self::$queue->inserts[$table][$cache_key])) 929 | { 930 | // insert already queued 931 | return FALSE; 932 | } 933 | 934 | self::$queue->inserts[$table][$cache_key] = $data; 935 | return TRUE; 936 | } 937 | 938 | /** 939 | * Queue an update for batch processing later 940 | * 941 | * @param string $table The table to insert into 942 | * @param string $cache_key Unique key identifying this variable 943 | * @param array $data Array in form of "Column" => "Value", ... 944 | * @return boolean 945 | */ 946 | protected function queue_update(string $table, string $cache_key, array $data) 947 | { 948 | if ( ! isset(self::$queue->updates[$table])) 949 | { 950 | self::$queue->updates[$table] = array(); 951 | } 952 | 953 | // overwrite any existing key, so that only the last update to same cached item actually runs 954 | self::$queue->updates[$table][$cache_key] = $data; 955 | return TRUE; 956 | } 957 | 958 | /** 959 | * Process queued queries 960 | * 961 | * @return void 962 | */ 963 | public function process_queue() 964 | { 965 | // batch inserts - must run first 966 | foreach(self::$queue->inserts as $table => $data) 967 | { 968 | $this->insert_ignore_batch($table, $data); 969 | 970 | // write to static file cache 971 | foreach($data as $query) 972 | { 973 | $this->write_static_cache($query); 974 | } 975 | } 976 | 977 | // run each queued update in order 978 | if (count(self::$queue->updates) > 0) 979 | { 980 | // update keys 981 | foreach(self::$queue->updates as $table => $data) 982 | { 983 | foreach($data as $query) 984 | { 985 | // required columns 986 | $where = array( 987 | 'key_name' => $query['key_name'], 988 | 'bundle_id' => $query['bundle_id'], 989 | 'site_id' => $query['site_id'] 990 | ); 991 | 992 | if ( isset($query['session_id'])) 993 | { 994 | $where += array('session_id' => $query['session_id']); 995 | unset($query['session_id']); 996 | } 997 | 998 | // update db 999 | $this->db->where($where); 1000 | $this->db->update($table, $query); 1001 | 1002 | // update static file cache 1003 | $this->write_static_cache($query); 1004 | } 1005 | } 1006 | } 1007 | 1008 | // reset the queue 1009 | self::$queue->inserts = self::$queue->updates = array(); 1010 | } 1011 | 1012 | /** 1013 | * Get the Queue object by reference 1014 | * 1015 | * @return stdClass 1016 | */ 1017 | public function &get_queue() 1018 | { 1019 | return self::$queue; 1020 | } 1021 | 1022 | } 1023 | 1024 | /* End of file stash_model.php */ 1025 | /* Location: ./system/expressionengine/third_party/stash/models/stash_model.php */ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------