-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
325 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,325 @@ | ||
| <?php | ||
|
|
||
| // This is a PLUGIN TEMPLATE for Textpattern CMS. | ||
|
|
||
| // Copy this file to a new name like abc_myplugin.php. Edit the code, then | ||
| // run this file at the command line to produce a plugin for distribution: | ||
| // $ php abc_myplugin.php > abc_myplugin-0.1.txt | ||
|
|
||
| // Plugin name is optional. If unset, it will be extracted from the current | ||
| // file name. Plugin names should start with a three letter prefix which is | ||
| // unique and reserved for each plugin author ("abc" is just an example). | ||
| // Uncomment and edit this line to override: | ||
| $plugin['name'] = 'etc_cache'; | ||
|
|
||
| // Allow raw HTML help, as opposed to Textile. | ||
| // 0 = Plugin help is in Textile format, no raw HTML allowed (default). | ||
| // 1 = Plugin help is in raw HTML. Not recommended. | ||
| # $plugin['allow_html_help'] = 1; | ||
|
|
||
| $plugin['version'] = '0.2.5'; | ||
| $plugin['author'] = 'Oleg Loukianov'; | ||
| $plugin['author_uri'] = 'www.iut-fbleau.fr/projet/etc/'; | ||
| $plugin['description'] = 'Events-driven cache'; | ||
|
|
||
| // Plugin load order: | ||
| // The default value of 5 would fit most plugins, while for instance comment | ||
| // spam evaluators or URL redirectors would probably want to run earlier | ||
| // (1...4) to prepare the environment for everything else that follows. | ||
| // Values 6...9 should be considered for plugins which would work late. | ||
| // This order is user-overrideable. | ||
| $plugin['order'] = '5'; | ||
|
|
||
| // Plugin 'type' defines where the plugin is loaded | ||
| // 0 = public : only on the public side of the website (default) | ||
| // 1 = public+admin : on both the public and admin side | ||
| // 2 = library : only when include_plugin() or require_plugin() is called | ||
| // 3 = admin : only on the admin side (no AJAX) | ||
| // 4 = admin+ajax : only on the admin side (AJAX supported) | ||
| // 5 = public+admin+ajax : on both the public and admin side (AJAX supported) | ||
| $plugin['type'] = '5'; | ||
|
|
||
| // Plugin "flags" signal the presence of optional capabilities to the core plugin loader. | ||
| // Use an appropriately OR-ed combination of these flags. | ||
| // The four high-order bits 0xf000 are available for this plugin's private use | ||
| if (!defined('PLUGIN_HAS_PREFS')) define('PLUGIN_HAS_PREFS', 0x0001); // This plugin wants to receive "plugin_prefs.{$plugin['name']}" events | ||
| if (!defined('PLUGIN_LIFECYCLE_NOTIFY')) define('PLUGIN_LIFECYCLE_NOTIFY', 0x0002); // This plugin wants to receive "plugin_lifecycle.{$plugin['name']}" events | ||
|
|
||
| $plugin['flags'] = '2'; | ||
|
|
||
| // Plugin 'textpack' is optional. It provides i18n strings to be used in conjunction with gTxt(). | ||
| // Syntax: | ||
| // ## arbitrary comment | ||
| // #@event | ||
| // #@language ISO-LANGUAGE-CODE | ||
| // abc_string_name => Localized String | ||
|
|
||
| /** Uncomment me, if you need a textpack | ||
| $plugin['textpack'] = <<< EOT | ||
| #@admin | ||
| #@language en-gb | ||
| abc_sample_string => Sample String | ||
| abc_one_more => One more | ||
| #@language de-de | ||
| abc_sample_string => Beispieltext | ||
| abc_one_more => Noch einer | ||
| EOT; | ||
| **/ | ||
| // End of textpack | ||
|
|
||
| if (!defined('txpinterface')) | ||
| @include_once('zem_tpl.php'); | ||
|
|
||
| # --- BEGIN PLUGIN CODE --- | ||
| Txp::get('\Textpattern\Tag\Registry')->register('etc_cache'); | ||
|
|
||
| if (@txpinterface == 'admin') { | ||
| register_callback('etc_cache_install', 'plugin_lifecycle.etc_cache'); | ||
| new etc_Cache(); | ||
| } elseif (serverSet('HTTP_USER_AGENT') == 'etc_cache') { | ||
| global $nolog; | ||
| $nolog = true; | ||
| } | ||
|
|
||
| // ------------------------------------------------------------- | ||
|
|
||
| function etc_cache($atts, $thing = null) | ||
| { | ||
| global $prefs, $pretext; | ||
| static $lastmod = null, $times = array(); | ||
|
|
||
| extract(lAtts(array( | ||
| 'id' => !empty($atts['form']) ? $atts['form'] : null, | ||
| 'form' => '', | ||
| 'reset' => null, | ||
| 'time' => true | ||
| ), $atts)); | ||
|
|
||
| if (empty($id)) { | ||
| trigger_error(gTxt('form_not_specified')); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| $id = doSlash($id); | ||
| $now = time(); | ||
|
|
||
| if (!isset($lastmod)) { | ||
| $lastmod = strtotime($prefs['lastmod']); | ||
| } | ||
|
|
||
| if (empty($time)) { | ||
| $update = 0; | ||
| } elseif ($time === true) { | ||
| $update = $lastmod; | ||
| } elseif (!isset($times[$time = (string)$time])) { | ||
| $update = is_numeric($time) ? $now + (float)$time : (int)strtotime($time, $now); | ||
|
|
||
| if ($update > $now) { | ||
| if (!is_numeric($time)) { | ||
| $date = date_parse($time); | ||
|
|
||
| foreach (array('year', 'month', 'day', 'hour', 'minute', 'second', 'fraction') as $key) { | ||
| if ($date[$key] !== false) { | ||
| $update = -1; | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| $times[$time] = $update; | ||
| } else { | ||
| $update = $times[$time]; | ||
| } | ||
|
|
||
| $cached = $update >= 0 ? safe_row('reset, UNIX_TIMESTAMP(time) AS time, url, text', 'etc_cache', "id = '$id' AND time IS NOT NULL") : false; | ||
| $onlastmod = $cached && ($time === true || $update > $now) && ($cached['reset'] == '%' || $cached['reset'] == '1'); | ||
|
|
||
| if ($update > $now) { | ||
| $update = $onlastmod ? max(2*$now - $update, $lastmod) : 2*$now - $update; | ||
| // } elseif ($time !== true) { | ||
| // if (!isset($reset) && !isset($cached['reset'])) $reset = ''; | ||
| } elseif ($cached && !$onlastmod && $time === true) { | ||
| $update = 0; | ||
| } | ||
|
|
||
| $parse = !$cached || $update < 0 || $cached['time'] < $update; | ||
|
|
||
| if ($parse) { | ||
| $out = $form ? parse_form($form, $thing) : parse($thing); | ||
|
|
||
| if ($update >= 0) { | ||
| $renew = ($reset || !isset($cached['url']) ? "url='".doSlash($pretext['req'])."'," : '') | ||
| .(isset($reset) && $reset !== true ? "reset='".doSlash($reset)."'," : ''); | ||
|
|
||
| safe_upsert('etc_cache', "time = NOW(), $renew text = '".doSlash($out)."'", "id = '$id'"); | ||
| } | ||
| } else { | ||
| $out = $cached['text']; | ||
| } | ||
|
|
||
| return $out; | ||
| } | ||
|
|
||
| /********** Admin class ***********/ | ||
|
|
||
| class etc_Cache | ||
| { | ||
| public function __construct() | ||
| { | ||
| add_privs('etc_cache', '1,2'); | ||
| register_tab('extensions', 'etc_cache', 'Cache'); | ||
| register_callback(array($this, 'update'), 'site.update'); | ||
| register_callback(array($this, 'tab'), 'etc_cache'); | ||
| } | ||
|
|
||
| public function update($event, $step = '', $rs = null) | ||
| { | ||
| $urls = $ids = array(); | ||
| $safe_step = $step ? doSlash($step) : ''; | ||
| $filter = "'$safe_step' LIKE reset".($step ? " OR FIND_IN_SET('$safe_step', reset)" : ''); | ||
|
|
||
| foreach (safe_rows('id, url, filter', 'etc_cache', "url > '' AND reset > '' AND ($filter)") as $cache) { | ||
| if ($step && !empty($cache['filter'])) { | ||
| $items = json_decode($cache['filter'], true); | ||
|
|
||
| if (isset($items[$step]) && is_array($items[$step])) { | ||
| foreach ($items[$step] as $field => $value) { | ||
| if (isset($rs[$field]) && !in_array($rs[$field], (array)$value)) { | ||
| continue 2; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| $ids[] = $cache['id']; | ||
|
|
||
| if (!in_array($cache['url'], $urls)) { | ||
| $urls[] = $cache['url']; | ||
| } | ||
| } | ||
|
|
||
| if ($ids) { | ||
| safe_update('etc_cache', 'time = NULL', "id IN (".implode(',', quote_list($ids)).")"); | ||
| $this->ping($urls); | ||
| safe_delete('etc_cache', "time IS NULL AND url > '' AND reset > '' AND ($filter)"); | ||
| safe_optimize('etc_cache'); | ||
| } | ||
| } | ||
|
|
||
| private function ping ($urls = array()) { | ||
| static $context = null; | ||
| if (empty($urls)) return; | ||
| if (!isset($context)) { | ||
| $context = stream_context_create(array('http'=>array( | ||
| 'method'=>'GET', | ||
| 'header'=>"Cache-Control: max-age=0, no-store, no-cache\r\n" . | ||
| "Pragma: no-cache\r\n" . | ||
| "User-Agent: etc-cache\r\n" | ||
| ) | ||
| )); | ||
| } | ||
|
|
||
| foreach ((array)$urls as $url) { | ||
| $url = preg_match('/^\s*https?:/', $url) ? $url : hu.ltrim($url, '/ '); | ||
| file_get_contents($url, false, $context); | ||
| } | ||
| } | ||
|
|
||
| /*************** admin *****************/ | ||
|
|
||
| public function tab($event, $step) { | ||
| global $prefs; | ||
|
|
||
| $qid = quote_list($id = gps('id')); | ||
|
|
||
| if($step == 'save' && bouncer($step, array('save'=>true))) switch(gps('save')) { | ||
| case gTxt('save') : if ($id) safe_upsert('etc_cache', | ||
| "reset='".doSlash(gps('reset'))."', | ||
| url='".doSlash(gps('url'))."', | ||
| filter='".doSlash(gps('filter'))."'", | ||
| "id=$qid"); | ||
| break; | ||
| case gTxt('delete') : safe_delete('etc_cache', $id ? "id=$qid" : '1'); | ||
| break; | ||
| case gTxt('update') : safe_update('etc_cache', 'time=NULL', $id ? "id=$qid" : '1'); | ||
| if ($id && $url = safe_field('url', 'etc_cache', "id=$qid")) { | ||
| $this->ping($url); | ||
| } | ||
| break; | ||
| } | ||
|
|
||
| $rs = safe_rows('id, time, url, reset, filter, IF(LENGTH(text)>512, CONCAT(LEFT(text, 504), " ..."), text) AS text', 'etc_cache', '1 ORDER BY time DESC'); | ||
| $now = date_create('now'); | ||
|
|
||
| pagetop("etc_cache", "<strong>Cache</strong> settings"); | ||
| echo '<h2>Cached items ('.$prefs['lastmod'].')</h2>'.n; | ||
| echo '<table><thead><tr><th>'.dLink('etc_cache', 'save', 'save', 'Delete').'</th><th>id</th><th>time</th><th>url</th><th>reset</th><th>filter</th><th></th></tr></thead><tbody>'; | ||
|
|
||
| foreach($rs as $row) { | ||
| extract($row); | ||
| $class = 'date'.($reset == '%' && $time < $prefs['lastmod'] ? ' warning' : ''); | ||
| $datetime = date_create($time); | ||
| $diff = $datetime->diff($now); | ||
| $days = $diff->format('%d'); | ||
| $diff = (!$days ? '' : "$days day".($days == 1 ? '' : 's'). ' ').$diff->format('%H:%I hours old'); | ||
|
|
||
| echo '<form method="post" action="?event=etc_cache"><tr>'.n; | ||
| echo '<td>'.tag( | ||
| span(gTxt('delete'), array('class' => 'ui-icon ui-icon-close')), | ||
| 'button', | ||
| array( | ||
| 'name' => 'save', | ||
| 'value' => 'Delete', | ||
| 'class' => 'destroy', | ||
| 'type' => 'submit', | ||
| 'title' => gTxt('delete'), | ||
| 'aria-label' => gTxt('delete'), | ||
| ))."</td><td title='".doSpecial($text)."'>".doSpecial($id)."</td><td class='$class' title='$diff'>".doSpecial($time)."</td><td>".fInput('text', 'url', $url)."</td><td>".fInput('text', 'reset', $reset)."</td><td>".fInput('text', 'filter', $filter)."</td>"; | ||
| echo '<td class="onhover">', fInput('submit', 'save', gTxt('update')), fInput('submit', 'save', gTxt('save'), 'publish'), '</td>'; | ||
| echo sInput('save'), hInput('id', $id), tInput(); | ||
| echo '</tr></form>'; | ||
| } | ||
|
|
||
| echo '</tbody></table>'; | ||
| } | ||
| //------- end class | ||
| } | ||
|
|
||
| /*************** install *****************/ | ||
|
|
||
| function etc_cache_install($event='', $step='') | ||
| { | ||
| if($step == 'deleted') { | ||
| safe_delete('txp_prefs', "name LIKE 'etc\_cache\_%'"); | ||
| safe_query('DROP TABLE IF EXISTS '.safe_pfx('etc_cache')); | ||
| return; | ||
| } | ||
| if($step == 'enabled') { | ||
| $qc="CREATE TABLE IF NOT EXISTS ".safe_pfx('etc_cache')." ("; | ||
| $qc.= <<<EOF | ||
| `id` varchar(64) NOT NULL, | ||
| `url` varchar(255) DEFAULT NULL, | ||
| `time` DATETIME DEFAULT NULL, | ||
| `reset` varchar(255) DEFAULT '1', | ||
| `filter` varchar(767) DEFAULT NULL, | ||
| `text` mediumtext, | ||
| PRIMARY KEY (`id`) | ||
| ) ENGINE=MyISAM CHARACTER SET=utf8 ; | ||
| EOF; | ||
| safe_query($qc); | ||
| return; | ||
| } | ||
| } | ||
| # --- END PLUGIN CODE --- | ||
| if (0) { | ||
| ?> | ||
| <!-- | ||
| # --- BEGIN PLUGIN HELP --- | ||
| <p><a href="http://www.iut-fbleau.fr/projet/etc/index.php?id=52">Homepage</a></p> | ||
| # --- END PLUGIN HELP --- | ||
| --> | ||
| <?php | ||
| } | ||
| ?> |