Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@lisps
lisps committed Oct 28, 2013
1 parent 6dadf8c commit d590888
Show file tree
Hide file tree
Showing 5 changed files with 704 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
const
=====
====== Const Plugin for DokuWiki ======

Dokuwiki Plugin
All documentation for the Const Plugin is available online at:

* http://dokuwiki.org/plugin:const

(c) 2013 by lisps

This plugin uses the evalmath class (http://www.phpclasses.org/package/2695-PHP-Safely-evaluate-mathematical-expressions.html) by Miles Kaufmann (BSD License).

See LICENSE for license info.
259 changes: 259 additions & 0 deletions action.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,259 @@
<?php
/**
* DokuWiki Plugin const (Action Component)
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author lisps
*/

if (!defined('DOKU_INC'))
define('DOKU_INC', realpath(dirname(__FILE__) . '/../../') . '/');
if (!defined('DOKU_PLUGIN'))
define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');

require_once(DOKU_PLUGIN . 'action.php');

/**
* All DokuWiki plugins to extend the parser/rendering mechanism
* need to inherit from this class
*/
class action_plugin_const extends DokuWiki_Action_Plugin {
/**
* return some info
*/
private $autoindexer = 0;
private $invalidate = FALSE;

/**
* offsets-at-character-position. recorded as tuples {charpos,offset}, where charpos is the
* position in the MODIFIED data, not the position in the original data, and offset is the
* CUMULATIVE offset at that position, not the offset relative to the previous location.
*/
var $offsets = array();

/**
* pagename for which calculation is made
*
*/
var $page = '';

/**
* During the run, contains the original wiki data.
*/
var $original;

/**
* During the run, contains the modified wiki data.
*/
var $wikified;


//hook before rendering starts
function register(&$controller) {
$controller->register_hook('PARSER_WIKITEXT_PREPROCESS', 'BEFORE', $this, '_doreplace');
$controller->register_hook('PARSER_HANDLER_DONE', 'BEFORE', $this, '_fixsecedit');
$controller->register_hook('PARSER_CACHE_USE', 'BEFORE', $this, '_cache_control');
}


function _replacecallback($hits) {
return ($this->autoindexer++);
}

//trigger
function _doreplace(&$event, $param) {
global $ID;

require_once(dirname(__FILE__) . "/class.evalmath.php");
$math = new evalmath();

$this->invalidate = FALSE;

$this->original = $event->data;
$this->wikified = $this->original;

//catch anonymous access
$username=isset($_SERVER['REMOTE_USER'])?$_SERVER['REMOTE_USER']:"anonymous";

//get const definitions
$data = array();
if (preg_match('§<const[^>]*>([^<]*)</const>§', $event->data, $data) > 0) {
//split entries
$data = array_pop($data);
$data = preg_split('/[\r\n]+/', $data, -1, PREG_SPLIT_NO_EMPTY);

//process wiki-data
$autoindex = 0;
foreach ($data as $entry) {
//normal const
$item = explode("=", trim($entry));
if (count($item) === 2) {
//special string-replace
switch ($item[1]) {
case "%USER%":
$item[1] = $username;
$this->invalidate = TRUE;
break; //pagename
case "%ID%":
$item[1] = noNS(cleanID(getID()));
break; //pagename
case "%NAMESPACE%":
$item[1] = getNS(cleanID(getID()));
break; //namespace
case "%RANDOM%":
$item[1] = strval(rand());
$this->invalidate = TRUE;
break; //random number
case "%YEAR%":
$item[1] = date("Y");
break; //current year
case "%MONTH%":
$item[1] = date("m");
break; //current month
case "%MONTHNAME%":
$item[1] = date("F");
break; //current month
case "%WEEK%":
$item[1] = date("W");
$this->invalidate = TRUE;
break; //current week (iso)
case "%DAY%":
$item[1] = date("d");
$this->invalidate = TRUE;
break; //current day
case "%DAYNAME%":
$item[1] = date("l");
$this->invalidate = TRUE;
break; //current day
case "%AUTOINDEX%":
$item[1] = "%%INDEX#" . (++$autoindex) . "%%"; //special automatic indexer
break;
default:
$item[1] = trim($item[1]);
break;
}

//replace in wiki
$this->wikified = str_replace("%%" . trim($item[0]) . "%%", $item[1], $this->wikified);

//load evaluator
@$math->evaluate($item[0]."=".$item[1]);
} else {
//evaluate expression
$item = explode(":", $entry);
if (count($item) === 2) {
$this->wikified = str_replace("%%" . trim($item[0]) . "%%", @$math->evaluate($item[1]), $this->wikified);
}
}
}

//autoindex?
while ($autoindex > 0) {
$this->autoindexer = 1;
//replace all
$this->wikified = preg_replace_callback("|%%INDEX#" . $autoindex . "%%|", array(
$this,
"_replacecallback"
), $this->wikified);
$autoindex--;
}

$event->data = $this->wikified;

$this->original = explode("\n", $this->original);
$this->wikified = explode("\n", $this->wikified);

// fill offset array to deal with section editing issues
for ($l = 0; $l < count($this->wikified); $l++) {
// record offsets at the start of this line
$this->offsets[] = array(
'pos' => $char_pos,
'offset' => $text_offset
);
// calculate position / offset for next line
$char_pos += strlen($this->wikified[$l]) + 1;
$text_offset += strlen($this->wikified[$l]) - strlen($this->original[$l]);
//echo '(' . $char_pos . '/' . $text_offset . ')' . ' ';
}
}

unset($this->original);
unset($this->wikified);

//save invalidation info to metadata
p_set_metadata($ID, array(
'plugin_const' => array(
'invalidate' => $this->invalidate
)
), FALSE, TRUE);
}

/**
* force cache invalidation for certain constants
*/
function _cache_control(&$event, $param) {
global $conf;

$cache =& $event->data;

if ((isset($cache->page) == TRUE) && ($cache->mode == "i")) {
//cache purge requested?
$const = p_get_metadata($cache->page, 'plugin_const');

//force initial purge
if (!isset($const['invalidate'])) {
$const['invalidate'] = TRUE;
}

$cache->depends["purge"] = $const["invalidate"];
}
}

/**
* modifying the raw data has as side effect that the sectioning is based on the
* modified data, not the original. This means that after processing, we need to
* adjust the section start/end markers so that they point to start/end positions
* in the original data, not the modified data.
*/
function _fixsecedit(&$event, $param) {
global $ID;
if($ID != $this->page) return;

$calls =& $event->data->calls;
$count = count($calls);

// iterate through the instruction list and set the file offset values
// back to the values they would be if no const syntax has been added by this plugin
for ($i = 0; $i < $count; $i++) {
if ($calls[$i][0] == 'section_open' || $calls[$i][0] == 'section_close' || $calls[$i][0] == 'header' || $calls[$i][0] == 'p_open') {
$calls[$i][2] = $this->_convert($calls[$i][2]);
}
if ($calls[$i][0] == 'header') {
$calls[$i][1][2] = $this->_convert($calls[$i][1][2]);
}
// be aware of headernofloat plugin
if ($calls[$i][0] == 'plugin' && $calls[$i][1][0] == 'headernofloat') {
$calls[$i][1][1]['pos'] = $this->_convert($calls[$i][1][1]['pos']);
$calls[$i][2] = $this->_convert($calls[$i][2]);
}
}
}

/**
* Convert modified raw wiki offset value pos back to the unmodified value
*/
function _convert($pos) {
// find the offset that applies to this character position
$offset = 0;
foreach ($this->offsets as $tuple) {
if ($pos >= $tuple['pos']) {
$offset = $tuple['offset'];
} else {
break;
}
}

// return corrected position
return $pos - $offset;
}
}
Loading

0 comments on commit d590888

Please sign in to comment.