PEAR2_Text_Markdown-0.1.0PEAR2_Text_Markdown-0.1.0/php/PEAR2/Text/Markdown/Main.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
<?php
/**
 * 
 * Plugin-aware text-to-XHTML converter based on Markdown.
 * 
 * This package is ported from John Gruber's [Markdown][] script in Perl,
 * with many thanks to Michel Fortin for his [PHP Markdown][] port to
 * PHP 4.  Be sure to read up on [Markdown syntax][] as well.
 * 
 * Unlike Markdown and PHP Markdown, Markdown is plugin-aware.
 * Every processing rule is a separate class, and classes can be strung
 * together in a manner largely independent of each other (although the
 * order of processing still matters a great deal). The plugin
 * architecture is based on Paul's work from [Text_Wiki][].
 * 
 * While the Text_Wiki package is capable of converting to any rendering
 * format, Markdown only converts to XHTML. If you need to render
 * to something other than XHTML, you may wish to try a two-step output
 * process: from Markdown to XHTML, then from XHTML to your preferred
 * format.
 * 
 * [Markdown]:        http://daringfireball.net/projects/markdown/
 * [Markdown syntax]: http://daringfireball.net/projects/markdown/syntax/
 * [PHP Markdown]:    http://www.michelf.com/projects/php-markdown/
 * [Text_Wiki]:       http://pear.php.net/Text_Wiki
 * 
 * @category Solar
 * 
 * @package Markdown Plugin-based system to implement standard Markdown
 * syntax.
 * 
 * @author John Gruber <http://daringfireball.net/projects/markdown/>
 * 
 * @author Michel Fortin <http://www.michelf.com/projects/php-markdown/>
 * 
 * @author Paul M. Jones <pmjones@solarphp.com>
 * 
 * @license http://opensource.org/licenses/bsd-license.php BSD
 * 
 * @version $Id: Markdown.php 4416 2010-02-23 19:52:43Z pmjones $
 * 
 * @todo How to configure plugins at the start?
 * 
 * @todo How to send a plugin object in the config?
 * 
 */
namespace PEAR2\Text;

class Markdown_Main
{
    /**
     * 
     * Default configuration values.
     * 
     * @config int tab_width Number of spaces per tab.  Default 4.
     * 
     * @config bool|array tidy If empty/false/null, do not use Tidy to post-process
     * the transformed output.  If true or a non-empty array, is a set of
     * config options to pass to Tidy when rendering output.
     * See also <http://php.net/tidy>.  Default false.
     * 
     * @config array plugins An array of plugins for the parser to use, in order.
     * 
     * @var array
     * 
     */
    protected $_Markdown = array(
        
        'tab_width' => 4,
        
        'tidy' => false,
        
        'plugins' => array(
            // pre-processing on the source as a whole
            'Markdown_Plugin_Prefilter',
            'Markdown_Plugin_StripLinkDefs',
            
            // blocks
            'Markdown_Plugin_Header',
            'Markdown_Plugin_HorizRule',
            'Markdown_Plugin_List',
            'Markdown_Plugin_CodeBlock',
            'Markdown_Plugin_BlockQuote',
            'Markdown_Plugin_Html',
            'Markdown_Plugin_Paragraph',
            
            // spans
            'Markdown_Plugin_CodeSpan',
            'Markdown_Plugin_Image',
            'Markdown_Plugin_Link',
            'Markdown_Plugin_Uri',
            'Markdown_Plugin_Encode',
            'Markdown_Plugin_AmpsAngles',
            'Markdown_Plugin_EmStrong',
            'Markdown_Plugin_Break',
        ),
    );
    
    /**
     * 
     * Left-delimiter for HTML tokens.
     * 
     * @var string
     * 
     */
    protected $_html_ldelim = "\x0E";
    
    /**
     * 
     * Right-delimiter for HTML tokens.
     * 
     * @var string
     * 
     */
    protected $_html_rdelim = "\x0F";
    
    /**
     * 
     * Left-delimiter for encoded Markdown characters.
     * 
     * @var string
     * 
     */
    protected $_char_ldelim = "\x02";
    
    /**
     * 
     * Right-delimiter for encoded Markdown characters.
     * 
     * @var string
     * 
     */
    protected $_char_rdelim = "\x03";
    
    /**
     * 
     * Array of HTML blocks represented by delimited token numbers.
     * 
     * Format is token => html.
     * 
     * @var array
     * 
     */
    protected $_html = array();
    
    /**
     * 
     * Running count of $this->_html elements so we don't have to 
     * count($this->_html) each time we add an HTML token.
     * 
     * @var int
     * 
     */
    protected $_count = 0;
    
    /**
     * 
     * List of defined link references keyed on the link name.
     * 
     * Format is "link-name" => array('href' => ..., 'title' => ...).
     * 
     * Generally populated via the StripLinkDefs plugin.
     * 
     * @var array
     * 
     */
    protected $_link = array();
    
    /**
     * 
     * Escape table for special Markdown characters.
     * 
     * Format is "$char" => "\x1B$char\x1B".
     * 
     * @var array
     * 
     */
    protected $_esc = array();
    
    /**
     * 
     * Escape table for backslashed special Markdown characters.
     * 
     * Format is "\\$char" => "\x1B$char\x1B".
     * 
     * Note that the backslash escape table and the normal escape table
     * map to identical escape sequences.
     * 
     * @var array
     * 
     */
    protected $_bs_esc = array();
    
    /**
     * 
     * Array of all plugin objects.
     * 
     * Format is class name => object instance.
     * 
     * @var array
     * 
     */
    protected $_plugin = array();
    
    /**
     * 
     * Array of all block-type plugin class names.
     * 
     * Each plugin reports if it is a span or a block.
     * 
     * @var array
     * 
     */
    protected $_block_class = array();
    
    /**
     * 
     * Array of all span-type plugin class names.
     * 
     * Each plugin reports if it is a span or a block.
     * 
     * @var array
     * 
     */
    protected $_span_class = array();
    
    /**
     * 
     * Array of all plugin classes that need to prepare the text before
     * processing.
     * 
     * @var array
     * 
     */
    protected $_prepare_class = array();
    
    /**
     * 
     * Array of all plugin classes that need to clean up the text after
     * processing.
     * 
     * @var array
     * 
     */
    protected $_cleanup_class = array();
    
    /**
     * 
     * Special characters that should be encoded by Markdown.
     * 
     * This list will grow as plugins are added; they each report their
     * own list of special characters to be encoded.
     * 
     * @var array
     * 
     */
    protected $_chars = '.{}\\';

    /**
     * 
     * Collection point for configuration values.
     * 
     * @var array
     * 
     */
    protected $_config = array();
    
    /**
     * 
     * Constructor.
     * 
     * @param array $config Configuration value overrides, if any.
     * 
     */
    public function __construct($config = null)
    {
        
        // build configuration
        $this->_config = (array) $config + $this->_Markdown;
        
        // post-construction tasks
        $this->_postConstruct();
    }

    /**
     * 
     * Post-construction tasks to complete object construction.
     * 
     * Loads the plugins, builds a list of characters to encode, and
     * builds the list of block-type and span-type plugin classes.
     * 
     * @return void
     * 
     */
    protected function _postConstruct()
    {
        
        // use tidy?
        if ($this->_config['tidy'] && ! extension_loaded('tidy')) {
            // tidy requested but not loaded
            throw $this->_exception('ERR_EXTENSION_NOT_LOADED', array(
                'extension' => 'tidy',
            ));
        }
        
        // load each plugin object
        foreach ($this->_config['plugins'] as $spec) {
            
            if (is_object($spec)) {
                $class = get_class($spec);
                $plugin = $spec;
            } else {
                $class = __NAMESPACE__ . '\\' . $spec;
                $plugin = new $class;
            }
            
            // save the plugin
            $this->_plugin[$class] = $plugin;
            $plugin->setMarkdown($this);
            
            // does it need to prepare the text?
            if ($plugin->isPrepare()) {
                $this->_prepare_class[] = $class;
            }
            
            // is it a block plugin?
            if ($plugin->isBlock()) {
                $this->_block_class[] = $class;
            }
            
            // is it a span plugin?
            if ($plugin->isSpan()) {
                $this->_span_class[] = $class;
            }
            
            // does it need to clean up the text?
            if ($plugin->isCleanup()) {
                $this->_cleanup_class[] = $class;
            }
            
            // find out what characters this plugin thinks should be
            // encoded as "special" Markdown characters.
            $this->_chars .= $plugin->getChars();
        }
        
        // build the character escape tables
        $k = strlen($this->_chars);
        for ($i = 0; $i < $k; ++ $i) {
            $char = $this->_chars[$i];
            $delim = $this->_char_ldelim . $i. $this->_char_rdelim;
            $this->_esc[$char] = $delim;
            $this->_bs_esc["\\$char"] = $delim;
            
        }
    }
    
    /**
     * 
     * Returns an internal Markdown plugin object for direct manipulation
     * and inspection.
     * 
     * @param string $class The plugin class name.
     * 
     * @return object The requested Markdown plugins.
     * 
     */
    public function getPlugin($class)
    {
        return $this->_plugin[$class];
    }
    
    /**
     * 
     * One-step transformation of source text using plugins.
     * 
     * Calls reset(), prepare(), processBlocks(), cleanup(), and
     * render() using the source text.
     * 
     * @param string $text The source text.
     * 
     * @return string The transformed text after all processing and
     * rendering.
     * 
     */
    public function transform($text)
    {
        $this->reset();
        $text = $this->prepare($text);
        $text = $this->processBlocks($text);
        $text = $this->cleanup($text);
        return $this->render($text);
    }
    
    /**
     * 
     * Resets Markdown and all its plugins for a new transformation.
     * 
     * @return void
     * 
     */
    public function reset()
    {
        // reset from previous transformations
        $this->_count = 0;
        $this->_html = array();
        $this->_link = array();
        
        // reset the plugins
        foreach ($this->_plugin as $plugin) {
            $plugin->reset();
        }
    }
    
    /**
     * 
     * Prepares the text for processing by running the prepare() 
     * method of each plugin, in order, on the source text.
     * 
     * Also calls the plugin's reset() method, and resets internal
     * counters and arrays.  This is to support work with multiple
     * separate text sources.
     * 
     * @param string $text The source text.
     * 
     * @return string The source text after processing.
     * 
     */
    public function prepare($text)
    {
        // let each plugin prepare the source text for parsing
        foreach ($this->_prepare_class as $class) {
            $text = $this->_plugin[$class]->prepare($text);
        }
        return $text;
    }
    
    /**
     * 
     * Runs the source text through all block-type plugins.
     * 
     * @param string $text The source text.
     * 
     * @return string The source text after processing.
     * 
     */
    public function processBlocks($text)
    {
        foreach ($this->_block_class as $class) {
            $text = $this->_plugin[$class]->parse($text);
        }
        return $text;
    }
    
    /**
     * 
     * Runs the processed text through each plugin's cleanup() method.
     * 
     * This is so that the plugins can "clean up" after all main
     * has been completed.
     * 
     * @param string $text The processed text.
     * 
     * @return string The processed text after cleanup.
     * 
     */
    public function cleanup($text)
    {
        // let each plugin clean up the rendered source
        foreach ($this->_cleanup_class as $class) {
            $text = $this->_plugin[$class]->cleanup($text);
        }
        return $text;
    }
    
    /**
     * 
     * Returns a final rendering of the processed text.
     * 
     * This replaces any remaining HTML tokens, un-encodes special
     * Markdown characters, and optionally runs the text through
     * [Tidy][].
     * 
     * [Tidy]: http://php.net/tidy
     * 
     * @param string $text The processed and cleaned text.
     * 
     * @return string The final rendering of the text.
     * 
     */
    public function render($text)
    {
        // replace any remaining HTML tokens
        $text = $this->unHtmlToken($text);
        
        // replace all special chars in the text.
        $text = $this->unEncode($text);
        
        if (! $this->_config['tidy']) {
            // tidy explicitly disabled
            return $text;
        }
        
        // tidy up the text
        $tidy = new tidy;
        $opts = (array) $this->_config['tidy'];
        $tidy->parseString($text, $opts, 'utf8');
        $tidy->cleanRepair();
        
        // get only the body portion
        $body = trim(tidy_get_body($tidy)->value);
        
        // remove <body> and </body>
        return substr($body, 6, -7);
    }
    
    // -----------------------------------------------------------------
    // 
    // General support methods for plugins.
    // 
    // -----------------------------------------------------------------
    
    /**
     * 
     * Runs the source text through all span-type plugins.
     * 
     * Generally this is called by block-type plugins, not by the
     * Markdown engine directly.
     * 
     * @param string $text The source text.
     * 
     * @return string The source text after processing.
     * 
     */
    public function processSpans($text)
    {
        foreach ($this->_span_class as $class) {
            $text = $this->_plugin[$class]->parse($text);
        }
        return $text;
    }
    
    /**
     * 
     * Returns the number of spaces per tab.
     * 
     * @return int
     * 
     */
    public function getTabWidth()
    {
        return (int) $this->_config['tab_width'];
    }
    
    // -----------------------------------------------------------------
    // 
    // HTML token processing support methods for plugins.
    // 
    // -----------------------------------------------------------------
    
    /**
     * 
     * Saves a pieces of text as HTML and returns a delimited token.
     * 
     * @param string $text The text to retain as HTML.
     * 
     * @return An HTML token.
     * 
     */
    public function toHtmlToken($text)
    {
        $key = $this->_html_ldelim
             . $this->_count
             . $this->_html_rdelim;
        
        $this->_html[$this->_count ++] = $text;
        return $key;
    }
    
    /**
     * 
     * Is a piece of text a delimited HTML token?
     * 
     * @param string $text The text to check.
     * 
     * @return bool True if a token, false if not.
     * 
     */
    public function isHtmlToken($text)
    {
        return preg_match(
            "/^{$this->_html_ldelim}.*?{$this->_html_rdelim}$/",
            $text
        );
    }
    
    /**
     * 
     * Replaces all HTML tokens in source text with saved HTML.
     * 
     * @param string $text The text to do replacements in.
     * 
     * @return string The source text with HTML in place of tokens.
     * 
     */
    public function unHtmlToken($text)
    {
        $regex = "/{$this->_html_ldelim}(.*?){$this->_html_rdelim}/";
        
        while (preg_match_all($regex, $text, $matches, PREG_SET_ORDER)) {
            foreach ($matches as $val) {
                $text = str_replace(
                    $val[0],
                    $this->_html[$val[1]],
                    $text
                );
            }
        }
        
        return $text;
    }
    
    // -----------------------------------------------------------------
    // 
    // Escaping for HTML and encoding for special Markdown characters.
    // 
    // -----------------------------------------------------------------
    
    /**
     * 
     * Escapes HTML in source text.
     * 
     * Uses htmlspecialchars() with UTF-8.
     * 
     * @param string $text Source text.
     * 
     * @param int $quotes How to escape quotes; default ENT_COMPAT.
     * 
     * @return string The escaped text.
     * 
     */
    public function escape($text, $quotes = ENT_COMPAT)
    {
        return htmlspecialchars($text, $quotes, 'UTF-8');
    }
    
    /**
     * 
     * Encodes special Markdown characters so they are not recognized
     * when parsing.
     * 
     * @param string $text The source text.
     * 
     * @param bool $only_backslash Only encode backslashed characters.
     * 
     * @return string The encoded text.
     * 
     */
    public function encode($text, $only_backslash = false)
    {
        $list = $this->_explodeTags($text);
        
        // reset text and rebuild from the list
        $text = '';
        
        if ($only_backslash) {
            foreach ($list as $item) {
                $text .= $this->_encode($item[1]);
            }
        } else {
            foreach ($list as $item) {
                if ($item[0] == 'tag') {
                    $text .= $this->_encode($item[1], true);
                } else {
                    $text .= $this->_encode($item[1]);
                }
            }
        }
        
        return $text;
    }
    
    /**
     * 
     * Un-encodes special Markdown characters.
     * 
     * @param string $text The text with encocded characters.
     * 
     * @return string The un-encoded text.
     * 
     */
    public function unEncode($text)
    {
        // because the bs_esc table uses the same values (just
        // different keys), this will catch both regular and
        // backslashes chars.
        $chars = array_flip($this->_esc);
        $text = str_replace(
            array_keys($chars),
            array_values($chars),
            $text
        );
        
        return $text;
    }
    
    /**
     * 
     * Support method for encode().
     * 
     * @param string $text The source text.
     * 
     * @param bool $in_tag Escaping inside a tag?
     * 
     * @return string The encoded text.
     * 
     */
    protected function _encode($text, $in_tag = false)
    {
        if ($in_tag) {
            // inside a tag
            $chars = $this->_esc;
        } else {
            // outside a tag, or between tags
            $chars = $this->_bs_esc;
        }
        
        return str_replace(
            array_keys($chars),
            array_values($chars),
            $text
        );
    }
    
    /**
     * 
     * Explodes source text into tags and text
     * 
     * Regular expression derived from the _tokenize() subroutine in 
     * Brad Choate's [MTRegex][] plugin.
     * 
     * [MTRegex]: http://www.bradchoate.com/past/mtregex.php
     * 
     * From the original notes ...
     * 
     * > Returns an array of the tokens comprising the input string.
     * > Each token is either a tag (possibly with nested, tags
     * > contained therein, such as <a href="<MTFoo>">, or a run of
     * > text between tags. Each element of the array is a
     * > two-element array; the first is either 'tag' or 'text'; the
     * > second is the actual value.
     * 
     * @param string $str A string of HTML.
     * 
     * @return array The string exploded into tag and non-tag portions.
     * 
     */
    protected function _explodeTags($str)
    {
        $index = 0;
        $list = array();
        
        $match = '(?s:<!(?:--.*?--\s*)+>)|'.    # comment
                 '(?s:<\?.*?\?>)|'.             # processing instruction
                                                # regular tags
                 '(?:<[/!$]?[-a-zA-Z0-9:]+\b(?>[^"\'>]+|"[^"]*"|\'[^\']*\')*>)'; 
                 
        $parts = preg_split("{($match)}", $str, -1, PREG_SPLIT_DELIM_CAPTURE);
        
        foreach ($parts as $part) {
            if (++$index % 2 && $part != '') {
                $list[] = array('text', $part);
            } else {
                $list[] = array('tag', $part);
            }
        }
        
        return $list;
    }
    
    // -----------------------------------------------------------------
    // 
    // Support methods for plugins, related to named link references.
    // 
    // -----------------------------------------------------------------
    
    /**
     * 
     * Sets the value of a named link reference.
     * 
     * @param string $name The link reference name.
     * 
     * @param string $href The URI this link points to.
     * 
     * @param string $title Alternate title for the link.
     * 
     * @return void
     * 
     */
    public function setLink($name, $href, $title = null)
    {
        $this->_link[$name] = array(
            'href'  => $href,
            'title' => $title,
        );
    }
    
    /**
     * 
     * Returns the href and title of a named link reference.
     * 
     * @param string $name The link reference name.
     * 
     * @return bool|array If the link reference exists, returns an 
     * array with keys 'href' and 'title'.  If not, returns false.
     * 
     */
    public function getLink($name)
    {
        if (! empty($this->_link[$name])) {
            return $this->_link[$name];
        } else {
            return false;
        }
    }
    
    /**
     * 
     * Returns an array of all defined link references.
     * 
     * @return array All links keyed by name, where each element is an
     * array with keys 'href' and 'title'.
     * 
     */
    public function getLinks()
    {
        return $this->_link;
    }
}
EOF