simplewiki.php

Go to the documentation of this file.

<?php
// Muster Software Copyright (c) Henrik Bechmann, Toronto, Canada 2009-2012. All rights reserved.
// See "musterlicence.txt" for licencing information.
// mustersoftware.net

namespace Muster;

use StdClass;
use 
        Muster\Simplewiki\DocNode,
        Muster\Simplewiki\Parser,
        Muster\Simplewiki\Emitter;

#==========================================================================
#-----------------------------[ SIMPLE WIKI ]------------------------------
#==========================================================================

class SimpleWiki
{
        protected $_parser;
        protected $_allow_html = TRUE;
        protected $_emitter;
        protected $_footnotes;
        protected $_footnotereferences;
        protected $_working_parser;
        
        public function __construct($text = NULL)
        {
                $this->_parser = new Parser($text);
                $this->_emitter = new Emitter();
                $this->register_class_callbacks(
                        array(
                                'span' => array(
                                        'subscript'=> array($this,'callback_span_subscript'),
                                        'superscript'=> array($this,'callback_span_superscript'),
                                        'footnote'=> array($this,'callback_span_footnote'),
                                        'comment'=> array($this,'callback_span_comment')),
                                'link' => array(
                                        'newwin' => array($this,'callback_link_newwin')),
                                'image' => array(
                                        'lframe'=> array($this,'callback_image_frame'),
                                        'rframe'=> array($this,'callback_image_frame')),
                                'paragraph' => array(
                                        'nop'=> array($this,'callback_paragraph_nop'),
                                        'div'=> array($this,'callback_paragraph_div')),
                                'blockdef' => array(
                                        'lframe'=> array($this,'callback_blockdef_frame'),
                                        'rframe'=> array($this,'callback_blockdef_frame')),
                                'preformatted' => array(
                                        'html'=> array($this,'callback_pre_html')),
                                'code' => array(
                                        'html'=> array($this,'callback_code_html'))
                        )
                );
                $this->register_macro_callbacks(
                        array(
                                'quicktoc' => array($this,'macro_quicktoc')
                        )
                );
                $this->register_symlinks(array('Anchor'=>'','Local'=>''));
        }
        public function __clone()
        {
                $this->_parser = clone $this->_parser;
                $this->_emitter = clone $this->_emitter;
                $this->_working_parser = NULL;
        }
        public function allow_html($bool = NULL)
        {
                if (!is_null($bool))
                        $this->_allow_html = $bool;
                return $this->_allow_html;
        }
        public function register_class_callbacks($callbacks)
        {
                $emitter = $this->_emitter;
                $emitter->register_class_callouts($callbacks);
        }
        public function register_property_callbacks($callbacks)
        {
                $emitter = $this->_emitter;
                $emitter->register_property_callouts($callbacks);
        }
        public function register_symlinks($symlinks)
        {
                $emitter = $this->_emitter;
                $emitter->register_symlinks($symlinks);
        }
        public function register_symlink_handler($handler)
        {
                $emitter = $this->_emitter;
                $emitter->register_symlink_handler($handler);
        }
        public function register_rawlink_handler($handler)
        {
                $emitter = $this->_emitter;
                $emitter->register_rawlink_handler($handler);
        }
        public function register_charfilter_handler($handler)
        {
                $emitter = $this->_emitter;
                $emitter->register_charfilter_handler($handler);
        }
        public function register_blockdef_handler($handler)
        {
                $emitter = $this->_emitter;
                $emitter->register_blockdef_handler($handler);
        }
        public function register_macro_callbacks($callbacks) 
        {
                $emitter = $this->_emitter;
                $emitter->register_macro_callouts($callbacks);
        }
        public function register_events($callbacks)
        {
                $emitter = $this->_emitter;
                $emitter->register_events($callbacks);
        }

        public function prepare($raw)
        {
                $this->_parser->prepare($raw);
                return $this;
        }
        public function get_html($markup = NULL)
        {
                if ($markup) $this->prepare($markup);
                global $profiles;
                $profile = array();
                $profile['parse']['start'] = microtime(true);
                $dom = $this->_parser->parse();
                $profile['parse']['end'] = microtime(true);
                $profiles[] = $profile;
                $profile = array();
                $profile['emit']['start'] = microtime(true);
                $retval = $this->_emitter->emit($dom);
                $profile['emit']['end'] = microtime(true);
                $profiles[] = $profile;
                return $retval;
        }
        public function parser($parser = NULL)
        {
                if (!is_null($parser))
                        $this->_parser = $parser;
                return $this->_parser;
        }
        public function emitter($emitter = NULL )
        {
                if (!is_null($emitter))
                        $this->_emitter = $parser;
                return $this->_emitter;
        }
        public function get_metadata()
        {
                return $this->_parser->metadata();
        }
        public function get_markerdata()
        {
                return $this->_parser->markerdata();
        }
        public function get_preprocessed_markup()
        {
                return $this->_parser->preprocessed_markup();
        }
        #-----------------------------[ STANDARD CLASS CALLBACKS ]-----------------------------#
        
        public function callback_paragraph_nop($node)
        {
                $node->opentag_head = '';
                $node->opentag_tail = '';
                $node->closetag = '';
                $node->decoration = new StdClass;
                return $node;
        }
        public function callback_paragraph_div($node)
        {
                $node->opentag_head = '<div';
                $node->opentag_tail = '>';
                $node->closetag = '</div>';
                unset($node->decoration->classes[array_search('div',$node->decoration->classes)]);
                return $node;
        }
        public function callback_code_html($node)
        {
                if ($this->_allow_html)
                {
                        $node->opentag_head = '';
                        $node->opentag_tail = '';
                        $node->closetag = '';
                        $node->escapecontent = FALSE;
                        $node->decoration = new StdClass;
                }
                return $node;
        }
        public function callback_blockdef_frame($node)
        {
                if ($node->blocktag != 'div') return $node;
                $node->decoration->classes[] = 'frame';
                return $node;
        }
        public function callback_image_frame($node)
        {
                $lframeindex = array_search('lframe',$node->decoration->classes);
                $rframeindex = array_search('rframe',$node->decoration->classes);
                if ($lframeindex === FALSE) // must be rframe
                {
                        unset($node->decoration->classes[$rframeindex]);
                        $orientation = 'rframe';
                }
                else // must be lframe;
                {
                        unset($node->decoration->classes[$lframeindex]);
                        $orientation = 'lframe';
                }
                $opentag_head = $node->opentag_head;
                $opentag_tail = $node->opentag_tail;
                $opentag_head = "<div class='frame $orientation'>" . $opentag_head;
                $opentag_tail .= "<br>{$node->caption}</div>";
                $node->opentag_head = $opentag_head;
                $node->opentag_tail = $opentag_tail;
                return $node;
        }
        public function callback_pre_html($node)
        {
                if ($this->_allow_html)
                {
                        $node->opentag_head = '';
                        $node->opentag_tail = '';
                        $node->closetag = '';
                        $node->escapecontent = FALSE;
                        $node->decoration = new StdClass;
                }
                return $node;
        }
        public function callback_span_comment($node)
        {
                $node->opentag_head = '';
                $node->opentag_tail = '';
                $node->closetag = '';
                $node->decoration = new StdClass;
                $node->elementcontent = '';
                return $node;
        }
        public function callback_span_footnote($node)
        {
                $footnotes = $this->_footnotes;
                if (empty($footnotes)) // inititalize footnote system
                {
                        $footnotes = new StdClass;
                        $footnotes->count = 0;
                        $footnotes->list = array();
                        if (empty($this->_working_parser))
                                $this->_working_parser = new Parser('');
                        $this->register_events(
                                array('onafteremit' =>
                                        array($this,'render_footnotes')));
                }
                // set aside footnote
                $footnote = $footnotes->list[] = $node;
                $count = $footnote->id = ++$footnotes->count;
                // generate markup for link
                $parser = $this->_working_parser;
                $markup = 
                        '%s superscript%[[#footnotemarker'
                        . $count
                        . ']][[#footnote'
                        . $count
                        . '|['
                        . $count.']]]%%';
                $dom = $parser->prepare($markup)->parse();
                // replace footnote body with reference in body of text
                $span = $dom->children[0]->children[0]; // document/paragraph
                $span->parent = $footnote->parent;
                $footnote->parent = NULL;
                $this->_footnotes = $footnotes;
                // create lookups for referenced footnotes
                $footnote->rendered = FALSE;
                $footnotereference = @$footnote->decoration->attributes['footnotereference'];
                if (!empty($footnotereference))
                {
                        $this->_footnotereferences[$footnotereference][] = $footnote;
                }
                // fix and return footnote link span
                $span->elementcontent = $this->_emitter->emit_children($span);
                $span = $this->callback_span_superscript($span); // set html elements
                return $span;
        }
        public function callback_span_superscript($node)
        {
                $node->opentag_head = '<sup';
                $node->opentag_tail = '>';
                $node->closetag = '</sup>';
                unset($node->decoration->classes[array_search('superscript',$node->decoration->classes)]);
                return $node;
        }
        public function callback_span_subscript($node)
        {
                $node->opentag_head = '<sub';
                $node->opentag_tail = '>';
                $node->closetag = '</sub>';
                unset($node->decoration->classes[array_search('subscript',$node->decoration->classes)]);
                return $node;
        }
        public function callback_link_newwin($node)
        {
                $node->decoration->attributes['target'] = '_blank';
                $node->decoration->attributedelimiters['target'] = '"';
                unset($node->decoration->classes[array_search('newwin',$node->decoration->classes)]);
                return $node;
        }
        #-----------------------------[ DEFAULT MACROS ]----------------------------------#

        public function macro_quicktoc($node)
        {
                $caption = $node->caption;
                if (!$caption) $caption = 'Table of Contents';
                # move to root of document
                $document = $this->_parser->get_selected_ancestor($node,array('document'));
                # collect all headings
                $contents = array();
                $contents = $this->macro_quicktoc_assemble_headings($document,$contents);
                # set data for content line items
                $contentheadings = array();
                $count = 0;
                foreach ($contents as $heading)
                {
                        // assign id
                        $count++;
                        $sessionid = 'heading' . $count;
                        $headingid = @$heading->decoration->attributes['id'];
                        if (is_null($headingid))
                        {
                                $headingid = $heading->decoration->attributes['id'] = $sessionid;
                                $heading->decoration->attributedelimiters['id'] = '"';
                        }
                        $heading->decoration->attributes['contentsid'] = $sessionid;
                        $heading->decoration->attributedelimiters['contentsid'] = '"';
                        $contentheading = new StdClass;
                        $contentheading->id = $headingid;
                        // assign text
                        $contentheading->text = $this->_emitter->emit_node_text($heading);
                        // assign level
                        $contentheading->level = $heading->level;
                        $contentheading->nesting = $heading->nesting;
                        $contentheadings[] = $contentheading;
                }
                # generate markup for table of contents
                if (!empty($contentheadings))
                {
                        $markup = '';
                        // calculate relative depth, beginning with 1
                        $contentdepth = 1;
                        $previouscontentdepth = $contentdepth;
                        $contentdepthstack = array();
                        $flooroffset = 0; // lowest depth, controlled by nesting
                        $flooroffsetstack = array();
                        // make sure there is no change for first item 
                        //      - markup requires starting depth of 1
                        $previouslevel = $contentheadings[0]->level;
                        $previouslevelstack = array();
                        $previousnestinglevel = $contentheadings[0]->nesting; 
                        // process collected elements
                        foreach ($contentheadings as $contentheading)
                        {
                                // calculate depth
                                $level = $contentheading->level;
                                $nestinglevel = $contentheading->nesting;
                                if ($nestinglevel > $previousnestinglevel)
                                { // save state
                                        array_push($flooroffsetstack,$flooroffset);
                                        array_push($contentdepthstack,$contentdepth);
                                        array_push($previouslevelstack,$previouslevel);
                                        // set floor
                                        $flooroffset = $contentdepth;
                                }
                                elseif ($nestinglevel < $previousnestinglevel)
                                { // restore state
                                        if (!empty($flooroffsetstack))
                                        {
                                                $flooroffset = array_pop($flooroffsetstack);
                                                $contentdepth = array_pop($contentdepthstack);
                                                $previouslevel = array_pop($previouslevelstack);
                                        }
                                }
                                if ($level > $previouslevel) 
                                        $contentdepth++;
                                elseif ($level < $previouslevel) 
                                        $contentdepth--;
                                $contentdepth = min($level,$contentdepth);
                                $contentdepth = max($contentdepth,1);
                                $previouslevel = $level;
                                $previousnestinglevel = $nestinglevel;
                                $previouscontentdepth = $contentdepth;
                                // generate markup
                                $markup .= 
                                        str_repeat('*',$contentdepth + $flooroffset) 
                                        . '[[#'
                                        . $contentheading->id 
                                        . '|' 
                                        . $contentheading->text
                                        . "]]\n";
                        }
                        // enclose markup
                        $caption = preg_replace('/\\n/','',$caption); // to allow \\ (newline) markup in caption
                        $markup = 
"(:div id=quicktoc-platform:)\n
        (:div id=quicktoc-header:)\n
                |:p div id=quicktoc-caption quicktoc-closed:|%c html%{{{" . $caption . "}}}\n
        (:divend:)\n
        (:div id=quicktoc-body:)\n" 
                . $markup . "\n
        (:divend:)\n
(:divend:)\n";
                        # generate html for table of contents
                        // allow html
                        $allowhtml = $this->allow_html();
                        $this->allow_html(TRUE);
                        $wiki = new SimpleWiki($markup);
                        $wiki->register_symlinks($this->emitter()->symlinks());
                        $wiki->register_symlink_handler($this->emitter()->symlink_handler());
                        $node->output = $wiki->get_html();
                        $this->allow_html($allowhtml);
                }
                return $node;
        }
        protected function macro_quicktoc_assemble_headings($node,$contents)
        {
                static $nesting = -1;
                $nesting++;
                $isheading = false;
                if ($node->type == DocNode::HEADING)
                {
                        $notoc = @$node->decoration->attributes['toc'] == 'no';
                        if ($notoc)
                        {
                                unset($node->decoration->attributes['toc']);
                        }
                        else
                        {
                                $isheading = TRUE;
                                $node->nesting = $nesting;
                                $contents[] = $node;
                        }
                }
                if (!$isheading)
                {
                        $children = $node->children;
                        if (!empty($children))
                        {
                                foreach ($children as $child)
                                {
                                        $contents = $this->macro_quicktoc_assemble_headings($child,$contents);
                                }
                        }
                }
                $nesting--;
                return $contents;
        }
        #----------------------[ NATIVE EVENT CALLBACKS ]--------------------------#

        # triggered at onafteremit event...
        public function render_footnotes($document)
        {
                $footnotes = $this->_footnotes->list;
                $markup = '';
                foreach ($footnotes as $footnote)
                {
                        if ($footnote->rendered) continue; // has been rendered as reference to other
                        // render base footnote
                        $id = $footnote->id;
                        $markup .=
                                '* [[#footnotemarker' . $id . '|^]][' . $id .'][[#footnote' . $id . ']]';
                        $footnotename = @$footnote->decoration->attributes['footnotename'];
                        if (!empty($footnotename)) // possibly referenced by others
                        {
                                $references = @$this->_footnotereferences[$footnotename];
                                if (!empty($references)) // add references
                                {
                                        foreach ($references as $reference)
                                        {
                                                $ref = $reference->id;
                                                $markup .= 
                                                        ' [[#footnotemarker' 
                                                        . $ref 
                                                        . '|^]][' 
                                                        . $ref 
                                                        .'][[#footnote' 
                                                        . $ref 
                                                        . ']]';
                                                $reference->rendered=true;
                                        }
                                }
                        }
                        $elementcontent = $footnote->elementcontent;
                        $elementcontent = preg_replace('/\\n/','',$elementcontent); // to allow \\ (newline) markup in footnotes
                        $markup .=
                                ' %c html%{{{'
                                . $elementcontent
                                . "}}}\n";
                }
                // wrap footnote block
                $markup = 
                        "\n|:b divider:|\n----\n"
                        . "(:div footnoteblock:)\n======Footnotes:======\n"
                        . $markup
                        . "(:divend:)\n";
                // allow html
                $allowhtml = $this->allow_html();
                $this->allow_html(TRUE);
                $wiki = new SimpleWiki($markup);
                $wiki->register_symlinks($this->emitter()->symlinks());
                $wiki->register_symlink_handler($this->emitter()->symlink_handler());
                $document->closetag .= $wiki->get_html();
                $this->allow_html($allowhtml);
                return $document;
        }
        // $wiki->register_events(array('onemit' =>array($wiki,'auto_quicktoc')));
        public function auto_quicktoc($document)
        {
                $markup = '<<quicktoc>>';
                if (empty($this->_working_parser))
                        $this->_working_parser = new Parser('');
                $parser = $this->_working_parser;
                $dom = $parser->prepare($markup)->parse();
                $tocnode = $dom->children[0];
                $tocnode->parent = $document;
                array_unshift($document->children,$tocnode);
                return $document;
        }
}