[php-blog-cvs] serendipity/bundled-libs/Text Wiki.php,1.1,1.2
A reliable, secure & extensible PHP blog | Not mainstream since 2002
Brought to you by:
garvinhicking,
jhermanns
Menu
▾
▴
[php-blog-cvs] serendipity/bundled-libs/Text Wiki.php,1.1,1.2
|
From: Garvin H. <gar...@us...> - 2004-05-25 09:58:41
|
Update of /cvsroot/php-blog/serendipity/bundled-libs/Text In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27598/bundled-libs/Text Modified Files: Wiki.php Log Message: PEAR::Text_Wiki Upgade from Tobias Schlitt Index: Wiki.php =================================================================== RCS file: /cvsroot/php-blog/serendipity/bundled-libs/Text/Wiki.php,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- Wiki.php 26 Feb 2004 11:27:53 -0000 1.1 +++ Wiki.php 25 May 2004 09:57:52 -0000 1.2 @@ -28,468 +28,530 @@ * * @author Paul M. Jones <pm...@ci...> * -* @version 0.8.1 alpha +* @version 0.15 alpha * */ class Text_Wiki { - - - /** - * - * The array of rules to apply to the source text, in order. - * - * This is an associative array where the key is the token-name - * to be used for the rule, and the value is the path to the - * rule class file. - * - * @access public - * - * @var array - * - */ - - var $rules = array( - - // pre-filters - 'prefilter' => 'Text/Wiki/Rule/prefilter.php', - 'delimiter' => 'Text/Wiki/Rule/delimiter.php', - - // capturing block elements - 'code' => 'Text/Wiki/Rule/code.php', - 'phpcode' => 'Text/Wiki/Rule/phpcode.php', - 'html' => 'Text/Wiki/Rule/html.php', - - // non-capturing block elements - 'heading' => 'Text/Wiki/Rule/heading.php', - 'horiz' => 'Text/Wiki/Rule/horiz.php', - 'blockquote' => 'Text/Wiki/Rule/blockquote.php', - 'deflist' => 'Text/Wiki/Rule/deflist.php', - 'table' => 'Text/Wiki/Rule/table.php', - 'list' => 'Text/Wiki/Rule/list.php', - 'toc' => 'Text/Wiki/Rule/toc.php', - - // mark paragraph blocks - 'paragraph' => 'Text/Wiki/Rule/paragraph.php', - - // inline elements - 'raw' => 'Text/Wiki/Rule/raw.php', - 'phplookup' => 'Text/Wiki/Rule/phplookup.php', - 'url' => 'Text/Wiki/Rule/url.php', - 'interwiki' => 'Text/Wiki/Rule/interwiki.php', - 'freelink' => 'Text/Wiki/Rule/freelink.php', - 'wikilink' => 'Text/Wiki/Rule/wikilink.php', - 'strong' => 'Text/Wiki/Rule/strong.php', - 'bold' => 'Text/Wiki/Rule/bold.php', - 'emphasis' => 'Text/Wiki/Rule/emphasis.php', - 'italic' => 'Text/Wiki/Rule/italic.php', - 'tt' => 'Text/Wiki/Rule/tt.php', - 'superscript' => 'Text/Wiki/Rule/superscript.php', - 'revise' => 'Text/Wiki/Rule/revise.php', - - // post-filters - 'entities' => 'Text/Wiki/Rule/entities.php', - 'tighten' => 'Text/Wiki/Rule/tighten.php' - ); - - - /** - * - * An associative array of Interwiki mappings where the key is the - * Interwiki name as entered on a wiki page, and the value is the - * replacement URL for the target wiki web. - * - * @access public - * - * @var array - * - */ - - var $interwiki = array( - 'MeatBall' => 'http://www.usemod.com/cgi-bin/mb.pl?', - 'Advogato' => 'http://advogato.org/', - 'Wiki' => 'http://c2.com/cgi/wiki?' - ); - - - /** - * - * An array of all pages that currently exist in the wiki. The source - * of the pages does not matter (database, file system, whatever). All - * that Text_Wiki needs to know is what pages are already in the system - * so that it can decide what kind of link to show when that page name - * appears in the source text. - * - * @access public - * - * @var array - * - */ - - var $pages = array(); - - - /** - * - * The URL used to view an existing page in the wiki; the page name - * will be appended to this base URL. - * - * @access public - * - * @var string - * - */ - - var $view_url = 'http://example.com/index.php?page='; - - - /** - * - * The URL used to create a page that does not exist in the wiki; the - * page name will be appended to this base URL. - * - * @access public - * - * @var string - * - */ - - var $new_url = 'http://example.com/new.php?page='; - - - /** - * - * When a page does not exist in the wiki, this is the text for the - * link to the "create" URL. (Typically, the page name itself is not - * the linked text; instead, a question mark or an inline image is - * used to indicate the page does not exist.) - * - * @access public - * - * @var string - * - */ - - var $new_text = '?'; - - - /** - * - * The delimiter that surrounds a token number embedded in the source - * wiki text. - * - * @access public - * - * @var string - * - */ - - var $delim = "\xFF"; - - - /** - * - * An array of tokens generated by rules as the source text is - * parsed. - * - * As Text_Wiki applies rule classes to the source text, it will - * replace portions of the text with a delimited token number. This - * is the array of those tokens, representing the replaced text and - * any options set by the parser for that replaced text. - * - * The tokens array is seqential; each element is itself a sequential - * array where element 0 is the name of the rule that generated the - * token, and element 1 is an associative array where the key is an - * option name and the value is an option value. - * - * @access private - * - * @var string - * - */ - - var $_tokens = array(); - - - /** - * - * The source text to which rules will be applied. This text will be - * transformed in-place, which means that it will change as the rules - * are applied. - * - * @access private - * - * @var string - * - */ - - var $_source = ''; - - - /** - * - * Text_Wiki creates one instance of every rule that is applied to - * the source text; this array holds those instances. The array key - * is the rule name, and the array value is an instance of the rule - * class. - * - * @access private - * - * @var string - * - */ - - var $_rule_obj = array(); - - - /** - * - * Constructor. Loads the rule objects. - * - * @access public - * - * @param array $options An associative array of options where the - * key is the option name and the value is the option value. Each - * option key corresponds to a public property of Text_Wiki; e.g., - * 'rules', 'interwiki', 'pages', 'rule_dir', and so on. - * - */ - - function Text_Wiki($options = array()) - { - if (isset($options) && is_array($options)) { - foreach ($options as $key => $val) { - // don't override private properties - if (substr($key, 0, 1) != '_') { - $this->$key = $val; - } - } - } - - // load each rule class file. - foreach ($this->rules as $name => $file) { - $this->_loadRule($name, $file); - } - } - - - /** - * - * Transforms the source text in-place. - * - * First, the method parses the source text, applying rules to the - * text as it goes. These rules will modify the source text - * in-place, replacing some text with delimited tokens (and - * populating the $this->_tokens array as it goes). - * - * Next, the method renders the in-place tokens into the requested - * output format. - * - * Finally, the method returns the transformed text. Note that the - * source text is transformed in place; once it is transformed, it is - * no longer the same as the original source text. - * - * @access public - * - * @param string $text The source text to which wiki rules should be - * applied, both for parsing and for rendering. - * - * @param string $format The target output format, typically 'xhtml'. - * If a rule does not support a given format, the output from that - * rule is rule-specific. - * - * @return string The transformed wiki text. - * - */ - - function transform($text, $format = 'Xhtml') - { - $this->parse($text); - return $this->render($format); - } - - - /** - * - * Sets the $_source text property, then parses it in place and - * retains tokens in the $_tokens array property. - * - * @access public - * - * @param string $text The source text to which wiki rules should be - * applied, both for parsing and for rendering. - * - * @return void - * - */ - - function parse($text) - { - // set the object property for the source text - $this->_source = $text; - - // apply the parse() method of each requested rule to the source - // text. - foreach ($this->rules as $name => $file) { - $this->_rule_obj[$name]->parse(); - } - } - - - /** - * - * Renders tokens back into the source text, based on the requested format. - * - * @access public - * - * @param string $format The target output format, typically 'xhtml'. - * If a rule does not support a given format, the output from that - * rule is rule-specific. - * - * @return string The transformed wiki text. - * - */ - - function render($format = 'Xhtml') - { - // the rendering method we're going to use from each rule - $method = "render$format"; - - // the eventual output text - $output = ''; - - // when passing through the parsed source text, keep track of when - // we are in a delimited section - $in_delim = false; - - // when in a delimited section, capture the token key number - $key = ''; - - // pass through the parsed source text character by character - $k = strlen($this->_source); - for ($i = 0; $i < $k; $i++) { - - // the current character - $char = $this->_source{$i}; - - // are alredy in a delimited section? - if ($in_delim) { - - // yes; are we ending the section? - if ($char == $this->delim) { - - // yes, get the replacement text for the delimited - // token number and unset the flag. - $key = (int)$key; - $rule = $this->_tokens[$key][0]; - $opts = $this->_tokens[$key][1]; - $output .= $this->_rule_obj[$rule]->$method($opts); - $in_delim = false; - - } else { - - // no, add to the dlimited token key number - $key .= $char; - - } - - } else { - - // not currently in a delimited section. - // are we starting into a delimited section? - if ($char == $this->delim) { - // yes, reset the previous key and - // set the flag. - $key = ''; - $in_delim = true; - } else { - // no, add to the output as-is - $output .= $char; - } - } - } - - // return the rendered source text - return $output; - } - - - /** - * - * Returns the parsed source text with delimited token placeholders. - * - * @access public - * - * @return string The parsed source text. - * - */ - - function getSource() - { - return $this->_source; - } - - - /** - * - * Returns tokens that have been parsed out of the source text. - * - * @access public - * - * @param array $rules If an array of rule names is passed, only return - * tokens matching these rule names. If no array is passed, return all - * tokens. - * - * @return array An array of tokens. - * - */ - - function getTokens($rules = null) - { - if (! is_array($rules)) { - return $this->_tokens; - } else { - $result = array(); - foreach ($this->_tokens as $key => $val) { - if (in_array($val[0], $rules)) { - $result[] = $val; - } - } - return $result; - } - } - - - /** - * - * Loads a rule class file and creates an instance of the rule - * object. - * - * @access private - * - * @param string $name The token name to use for the rule. - * - * @param string $file The file name of the rule class. - * - * @return void - * - */ - - function _loadRule($name, $file) - { - // load the class definition. - include_once($file); - - // dynamically determine the name of the class - // we just loaded - $tmp = get_declared_classes(); - $k = count($tmp) - 1; - $class = $tmp[$k]; - unset($tmp); - - // instantiate the rule object and add to the set - $this->_rule_obj[$name] =& new $class($this, $name); - } + + + /** + * + * The array of rules to apply to the source text, in order. + * + * @access public + * + * @var array + * + */ + + var $rules = array(); + + + /** + * + * The delimiter that surrounds a token number embedded in the source + * wiki text. + * + * @access public + * + * @var string + * + */ + + var $delim = "\xFF"; + + + /** + * + * An array of tokens generated by rules as the source text is + * parsed. + * + * As Text_Wiki applies rule classes to the source text, it will + * replace portions of the text with a delimited token number. This + * is the array of those tokens, representing the replaced text and + * any options set by the parser for that replaced text. + * + * The tokens array is seqential; each element is itself a sequential + * array where element 0 is the name of the rule that generated the + * token, and element 1 is an associative array where the key is an + * option name and the value is an option value. + * + * @access private + * + * @var string + * + */ + + var $_tokens = array(); + + + /** + * + * The source text to which rules will be applied. This text will be + * transformed in-place, which means that it will change as the rules + * are applied. + * + * @access private + * + * @var string + * + */ + + var $_source = ''; + + + /** + * + * Text_Wiki creates one instance of every rule that is applied to + * the source text; this array holds those instances. The array key + * is the rule name, and the array value is an instance of the rule + * class. + * + * @access private + * + * @var string + * + */ + + var $_rule_obj = array(); + + + /** + * + * Constructor. Loads the rule objects. + * + * @access public + * + * @param array $rules The set of rules to load for this object. + * + */ + + function Text_Wiki($rules = null) + { + // set up the list of rules + if (is_array($rules)) { + $this->rules = $rules; + } + } + + + /** + * + * Inserts a rule into to the rule set. + * + * @access public + * + * @param string $key The key name for the rule. Should be different from + * all other keys in the rule set. + * + * @param string $val The rule values; should be an associative array with + * the keys 'file', 'name', 'flag', and 'conf'. + * + * @param string $tgt The rule after which to insert this new rule. By + * default (null) the rule is inserted at the end; if set to '', inserts + * at the beginning. + * + * @return void + * + */ + + function insertRule($key, $val, $tgt = null) + { + // does the rule key to be inserted already exist? + if (isset($this->rules[$key])) { + // yes, return + return false; + } + + // the target name is not null, not '', but does not exist. this + // means we're trying to insert after a target key, but the + // target key isn't there. + if (! is_null($tgt) && $tgt != '' && ! isset($this->rules[$tgt])) { + return false; + } + + // if $tgt is null, insert at the end. We know this is at the + // end (instead of resetting an existing rule) becuase we exited + // at the top of this method if the rule was already in place. + if (is_null($tgt)) { + $this->rules[$key] = $val; + return true; + } + + // save a copy of the current rules, then reset the rule set + // so we can insert in the proper place later. + $tmp = $this->rules; + $this->rules = array(); + + // where to insert the rule? + if ($tgt == '') { + // insert at the beginning + $this->rules[$key] = $val; + foreach ($tmp as $k => $v) { + $this->rules[$k] = $v; + } + return true; + } else { + // insert after the named rule + foreach ($tmp as $k => $v) { + $this->rules[$k] = $v; + if ($k == $tgt) { + $this->rules[$key] = $val; + } + } + } + return true; + } + + + /** + * + * Delete (remove or unset) a rule from the $rules property. + * + * @access public + * + * @param string $rule The name of the rule to remove. + * + * @return void + * + */ + + function deleteRule($key) + { + unset($this->rules[$key]); + } + + + /** + * + * Sets the value of a rule's configuration keys. + * + * @access public + * + * @param string $rule The name of the rule for which to set + * configuration keys. + * + * @param array|string $arg1 If an array, sets the entire 'conf' key + * for the rule; if a string, specifies which 'conf' subkey to set. + * + * @param mixed $arg2 If $arg1 is a string, the 'conf' subkey + * specified by $arg1 is set to this value. + * + * @return void + * + */ + + function setRuleConf($rule, $arg1, $arg2 = null) + { + if (! isset($this->rules[$rule])) { + return; + } + + if (! isset($this->rules[$rule]['conf'])) { + $this->rules[$rule]['conf'] = array(); + } + + if (is_array($arg1)) { + $this->rules[$rule]['conf'] = $arg1; + } else { + $this->rules[$rule]['conf'][$arg1] = $arg2; + } + } + + + /** + * + * Sets the value of a rule's configuration keys. + * + * @access public + * + * @param string $rule The name of the rule from which to get + * configuration keys. + * + * @param string $key Which 'conf' subkey to retrieve. If null, + * gets the entire 'conf' key for the rule. + * + * @return void + * + */ + + function getRuleConf($rule, $key = null) + { + if (! isset($this->rules[$rule])) { + return null; + } + + if (! isset($this->rules[$rule]['conf'])) { + $this->rules[$rule]['conf'] = array(); + } + + if (is_null($key)) { + return $this->rules[$rule]['conf']; + } + + if (! isset($this->rules[$rule]['conf'][$key])) { + return null; + } else { + return $this->rules[$rule]['conf'][$key]; + } + + } + + + /** + * + * Enables a rule so that it is applied when parsing. + * + * @access public + * + * @param string $rule The name of the rule to enable. + * + * @return void + * + */ + + function enableRule($rule) + { + if (isset($this->rules[$rule])) { + $this->rules[$rule]['flag'] = true; + } + } + + + /** + * + * Disables a rule so that it is not applied when parsing. + * + * @access public + * + * @param string $rule The name of the rule to disable. + * + * @return void + * + */ + + function disableRule($rule) + { + if (isset($this->rules[$rule])) { + $this->rules[$rule]['flag'] = false; + } + } + + + /** + * + * Parses and renders the text passed to it, and returns the results. + * + * First, the method parses the source text, applying rules to the + * text as it goes. These rules will modify the source text + * in-place, replacing some text with delimited tokens (and + * populating the $this->_tokens array as it goes). + * + * Next, the method renders the in-place tokens into the requested + * output format. + * + * Finally, the method returns the transformed text. Note that the + * source text is transformed in place; once it is transformed, it is + * no longer the same as the original source text. + * + * @access public + * + * @param string $text The source text to which wiki rules should be + * applied, both for parsing and for rendering. + * + * @param string $format The target output format, typically 'xhtml'. + * If a rule does not support a given format, the output from that + * rule is rule-specific. + * + * @return string The transformed wiki text. + * + */ + + function transform($text, $format = 'Xhtml') + { + $this->parse($text); + return $this->render($format); + } + + + /** + * + * Sets the $_source text property, then parses it in place and + * retains tokens in the $_tokens array property. + * + * @access public + * + * @param string $text The source text to which wiki rules should be + * applied, both for parsing and for rendering. + * + * @return void + * + */ + + function parse($text) + { + // set the object property for the source text + $this->_source = $text; + + // apply the parse() method of each requested rule to the source + // text. + foreach ($this->rules as $key => $val) { + // if flag is not set to 'true' (active), + // do not parse under this rule. assume + // that if a rule exists, but has no flag, + // that it wants to be parsed with. + if (! isset($val['flag']) || $val['flag'] == true) { + $this->_loadRuleObject($key); + $this->_rule_obj[$key]->parse(); + } + } + } + + + /** + * + * Renders tokens back into the source text, based on the requested format. + * + * @access public + * + * @param string $format The target output format, typically 'xhtml'. + * If a rule does not support a given format, the output from that + * rule is rule-specific. + * + * @return string The transformed wiki text. + * + */ + + function render($format = 'Xhtml') + { + // the rendering method we're going to use from each rule + $method = "render$format"; + + // the eventual output text + $output = ''; + + // when passing through the parsed source text, keep track of when + // we are in a delimited section + $in_delim = false; + + // when in a delimited section, capture the token key number + $key = ''; + + // pass through the parsed source text character by character + $k = strlen($this->_source); + for ($i = 0; $i < $k; $i++) { + + // the current character + $char = $this->_source{$i}; + + // are alredy in a delimited section? + if ($in_delim) { + + // yes; are we ending the section? + if ($char == $this->delim) { + + // yes, get the replacement text for the delimited + // token number and unset the flag. + $key = (int)$key; + $rule = $this->_tokens[$key][0]; + $opts = $this->_tokens[$key][1]; + $output .= $this->_rule_obj[$rule]->$method($opts); + $in_delim = false; + + } else { + + // no, add to the dlimited token key number + $key .= $char; + + } + + } else { + + // not currently in a delimited section. + // are we starting into a delimited section? + if ($char == $this->delim) { + // yes, reset the previous key and + // set the flag. + $key = ''; + $in_delim = true; + } else { + // no, add to the output as-is + $output .= $char; + } + } + } + + // return the rendered source text + return $output; + } + + + /** + * + * Returns the parsed source text with delimited token placeholders. + * + * @access public + * + * @return string The parsed source text. + * + */ + + function getSource() + { + return $this->_source; + } + + + /** + * + * Returns tokens that have been parsed out of the source text. + * + * @access public + * + * @param array $rules If an array of rule names is passed, only return + * tokens matching these rule names. If no array is passed, return all + * tokens. + * + * @return array An array of tokens. + * + */ + + function getTokens($rules = null) + { + if (is_null($rules)) { + return $this->_tokens; + } else { + settype($rules, 'array'); + $result = array(); + foreach ($this->_tokens as $key => $val) { + if (in_array($val[0], $rules)) { + $result[] = $val; + } + } + return $result; + } + } + + + /** + * + * Loads a rule class file and creates an instance of it. + * + * @access public + * + * @return void + * + */ + + function _loadRuleObject($key) + { + $name = $this->rules[$key]['name']; + if (! class_exists($name)) { + include_once $this->rules[$key]['file']; + } + $this->_rule_obj[$key] =& new $name($this, $key); + } } ?> \ No newline at end of file |