current code from svn, revision 62608

1 files changed, 183 insertions, 0 deletions

diff --git a/lib/classes/WikiFormat.php b/lib/classes/WikiFormat.php
new file mode 100644
index 0000000..a669740
--- /dev/null
+++ b/lib/classes/WikiFormat.php
@@ -0,0 +1,183 @@
+<?php
+/**
+ * StudipFormat.php - simple Stud.IP text markup parser
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of
+ * the License, or (at your option) any later version.
+ *
+ * @author      Elmar Ludwig
+ * @license     http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
+ * @category    Stud.IP
+ */
+
+class WikiFormat extends StudipFormat
+{
+    private static $wiki_rules = [
+        'wiki-comments' => [
+            'start'    => '\[comment(=.*?)\](.*?)\[\/comment\]',
+            'callback' => 'WikiFormat::markupWikiComments'
+        ],
+        'wiki-links' => [
+            'start'    => '\[\[(.*?)(?:\|(.*?))?\]\]',
+            'callback' => 'WikiFormat::markupWikiLinks',
+            'before'   => 'links'
+        ],
+    ];
+
+    /**
+     * Adds a new markup rule to the wiki markup set. This can
+     * also be used to replace an existing markup rule. The end regular
+     * expression is optional (i.e. may be NULL) to indicate that this
+     * rule has an empty content model. The callback is called whenever
+     * the rule matches and is passed the following arguments:
+     *
+     * - $markup    the markup parser object
+     * - $matches   match results of preg_match for $start
+     * - $contents  (parsed) contents of this markup rule
+     *
+     * Sometimes you may want your rule to apply before another specific rule
+     * will apply. For this case the parameter $before defines a rulename of
+     * existing markup, before which your rule should apply.
+     *
+     * @param string $name      name of this rule
+     * @param string $start     start regular expression
+     * @param string $end       end regular expression (optional)
+     * @param callback $callback function generating output of this rule
+     * @param string $before mark before which rule this rule should be appended
+     */
+    public static function addWikiMarkup($name, $start, $end, $callback, $before = null)
+    {
+        $inserted = false;
+        foreach (self::$wiki_rules as $rule_name => $rule) {
+            if ($rule_name === $before) {
+                self::$wiki_rules[$name] = compact('start', 'end', 'callback');
+                $inserted = true;
+            }
+            if ($inserted) {
+                unset(self::$wiki_rules[$rule_name]);
+                self::$wiki_rules[$rule_name] = $rule;
+            }
+        }
+        if (!$inserted) {
+            self::$wiki_rules[$name] = compact('start', 'end', 'callback');
+        }
+    }
+
+    /**
+     * Returns a single markup-rule if it exists.
+     * @return array: array('start' => "...", 'end' => "...", 'callback' => "...")
+     */
+    public static function getWikiMarkup($name)
+    {
+        return self::$wiki_rules[$name];
+    }
+
+    /**
+     * Removes a markup rule from the wiki markup set.
+     *
+     * @param string $name Name of the rule
+     */
+    public static function removeWikiMarkup($name)
+    {
+        unset(self::$wiki_rules[$name]);
+    }
+
+    /**
+     * Initializes a new WikiFormat instance.
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        foreach (self::$wiki_rules as $name => $rule) {
+            $this->addMarkup(
+                $name,
+                $rule['start'],
+                $rule['end'],
+                $rule['callback'],
+                $rule['before'] ?: null
+            );
+        }
+    }
+
+    /**
+     * Stud.IP markup for wiki-comments
+     *
+     * @param  StudipFormat $markup  Markup object
+     * @param  array        $matches Found matches
+     * @return string
+     */
+    protected static function markupWikiComments($markup, $matches)
+    {
+        $from = mb_substr($matches[1], 1);
+        $comment = $matches[2];
+
+        if (Request::get('wiki_comments') === 'none') {
+            return '';
+        } else if ($GLOBALS['user']->cfg->WIKI_COMMENTS_ENABLE) {
+            $commenttmpl = "<table style=\"border:thin solid;margin: 5px;\" bgcolor=\"#ffff88\"><tr><td><font size=-1><b>"._("Kommentar von")." %1\$s:</b>&nbsp;</font></td></tr><tr class=steelgrau><td class=steelgrau><font size=-1>%2\$s</font></td></tr></table>";
+            return sprintf(
+                $commenttmpl,
+                $from,
+                $comment
+            );
+        } else {
+            $from = decodeHTML($from);
+            $comment = decodeHTML($comment); //because tooltip already escapes
+            return sprintf(
+                '<a href="javascript:void(0);" %s>%s</a>',
+                tooltip(sprintf("%s %s: %s", _("Kommentar von"), $from, $comment), true, true),
+                Icon::create('chat2', Icon::ROLE_STATUS_YELLOW)
+            );
+        }
+    }
+
+    /**
+     * Stud.IP markup for wiki links
+     *
+     * @param  StudipFormat $markup  Markup object
+     * @param  array        $matches Found matches
+     * @return string
+     */
+    protected static function markupWikiLinks($markup, $matches)
+    {
+        $keyword = decodeHTML($matches[1]);
+        $display_page = $matches[2] ? $markup->format($matches[2]) : htmlReady($keyword);
+
+        $page = WikiPage::findLatestPage(Context::getId(), $keyword);
+
+        // Page does not exist
+        if (!$page) {
+            return sprintf('<a href="%s">%s(?)</a>',
+                URLHelper::getLink('wiki.php', [
+                    'keyword' => $keyword,
+                    'origin' => Request::get('keyword') ?: 'WikiWikiWeb',
+                    'view' => 'editnew'
+                ]),
+                $display_page
+            );
+        }
+
+        // Page is visible to current user
+        if ($page->isVisibleTo($GLOBALS['user'])) {
+            return sprintf(
+                '<a href="%s">%s</a>',
+                URLHelper::getLink('wiki.php', compact('keyword')),
+                $display_page
+            );
+        }
+
+        // Page is not visible to current user and show be displayed accordingly
+        return sprintf(
+            '<a href="%s" class="wiki-restricted" title="%s">%s</a>',
+            URLHelper::getLink('wiki.php', compact('keyword')),
+            sprintf(
+                _('Sie haben keine Berechtigung, die Seite %s zu lesen!'),
+                htmlReady($keyword)
+            ),
+            $display_page
+        );
+    }
+
+}