entry.php

<?php

use dokuwiki\Extension\SyntaxPlugin;

/**
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Andreas Gohr <andi@splitbrain.org>
 * @author     Hakan Sandell <sandell.hakan@gmail.com>
 */
/**
 * Class syntax_plugin_pluginrepo_entry
 */
class syntax_plugin_pluginrepo_entry extends SyntaxPlugin
{
    /**
     * will hold the repository helper plugin
     * @var helper_plugin_pluginrepo_repository $hlp
     */
    public $hlp;

    /**
     * Constructor. Load helper plugin
     */
    public function __construct()
    {
        $this->hlp = plugin_load('helper', 'pluginrepo_repository');
        if (!$this->hlp instanceof helper_plugin_pluginrepo_repository) {
            msg('Loading the pluginrepo repository helper failed. Make sure the pluginrepo plugin is installed.', -1);
        }
    }

    /**
     * What kind of syntax are we?
     */
    public function getType()
    {
        return 'substition';
    }

    /**
     * What about paragraphs?
     */
    public function getPType()
    {
        return 'block';
    }

    /**
     * Where to sort in?
     */
    public function getSort()
    {
        return 155;
    }

    /**
     * Connect pattern to lexer (actual pattern used doesn't matter, namespace controls plugin type)
     *
     * @param string $mode
     */
    public function connectTo($mode)
    {
        $this->Lexer->addSpecialPattern('----+ *plugin *-+\n.*?\n----+', $mode, 'plugin_pluginrepo_entry');
        $this->Lexer->addSpecialPattern('----+ *template *-+\n.*?\n----+', $mode, 'plugin_pluginrepo_entry');
    }

    /**
     * Handler to prepare matched data for the rendering process
     *
     * @param   string       $match   The text matched by the patterns
     * @param   int          $state   The lexer state for the match
     * @param   int          $pos     The character position of the matched text
     * @param   Doku_Handler $handler The Doku_Handler object
     * @return  bool|array Return an array with all data you want to use in render, false don't add an instruction
     */
    public function handle($match, $state, $pos, Doku_Handler $handler)
    {
        global $ID;

        $initialData = [
            'description' => '',
            'author' => '', //author_mail
            'email' => '', //author_mail
            'compatible' => '',
            'lastupdate' => '', //string; lastupdate_dt
            'securityissue' => '',
            'securitywarning' => '',
            'updatemessage' => '',
            'downloadurl' => '',
            'bugtracker' => '',
            'sourcerepo' => '',
            'donationurl' => '',
            'screenshot_img' => '',
            'tags' => '', //string, csv; template_tags
            'type' => '', //string, text is later converted to type numbers
            'depends' => '',
            'conflicts' => '',
            'similar' => '',
        ];

        $data = $this->hlp->parseData($match, $initialData);
        if (curNS($ID) == 'template') {
            $data['type'] = 'template';
        }
        $this->hlp->harmonizeExtensionIDs($data);
        return $data;
    }

    /**
     * Create output or save the data
     *
     * @param string          $format   output format being rendered
     * @param Doku_Renderer   $renderer the current renderer object
     * @param array           $data     data created by handler()
     * @return  boolean                 rendered correctly? (however, returned value is not used at the moment)
     */
    public function render($format, Doku_Renderer $renderer, $data)
    {
        global $ID;

        if (curNS($ID) == 'plugin') {
            $id = noNS($ID);
        } else {
            $id = curNS($ID) . ':' . noNS($ID);
        }

        switch ($format) {
            case 'xhtml':
                /** @var Doku_Renderer_xhtml $renderer */
                $this->showData($data, $id, $renderer);
                return true;
            case 'metadata':
                /** @var Doku_Renderer_metadata $renderer */
                // only save if in first level namespace to ignore translated namespaces, and only plugins or templates
                if (substr_count($ID, ':') == 1 && (curNS($ID) == 'plugin' || curNS($ID) == 'template')) {
                    $this->saveData($data, $id, $renderer->meta['title']);
                }
                return true;
            default:
                return false;
        }
    }

    /**
     * Output the data in a table
     *
     * @param array               $data instructions from handle()
     * @param string              $id   plugin/template id
     * @param Doku_Renderer_xhtml $R
     */
    protected function showData($data, $id, $R)
    {
        $rel = $this->hlp->getPluginRelations($id);
        $type = $this->hlp->parsetype($data['type']);
        $extensionType = ($type == 32) ? 'template' : 'plugin';
        $hasUnderscoreIssue = (strpos($id, '_') !== false);
        $age = 0;
        $isBundled = in_array($id, $this->hlp->bundled);
        $isObsoleted = in_array($this->hlp->obsoleteTag, $this->hlp->parsetags($data['tags']));
        $lastUpdate = $data['lastupdate'];
        if ($lastUpdate) {
            $lastupdateDateTime = DateTime::createFromFormat('Y-m-d', $lastUpdate);
            if ($lastupdateDateTime) {
                $age = $lastupdateDateTime->diff(new DateTime('now'))->y;
            }
        }

        $obsClass = $isObsoleted ? ' obsoleted' : '';
        $R->doc .= "<div class=\"pluginrepo_entry$obsClass\">";

        $R->doc .= '<div class="usageInfo">';
        $uptodate = $this->showCompatibility($R, $data);
        $this->showActionLinks($R, $data);
        $R->doc .= '</div>';

        $this->showMainInfo($R, $data, $extensionType);
        $this->showMetaInfo($R, $data, $type, $rel);

        $isOld = ($age >= 2) && !$uptodate && !$isBundled;

        if (
            $rel['similar'] || $data['tags'] || $data['securitywarning'] || $data['securityissue']
            || $hasUnderscoreIssue || $isOld || $isObsoleted || $data['updatemessage']
        ) {
            $R->doc .= '<div class="moreInfo">';
            $this->showWarnings($R, $data, $hasUnderscoreIssue, $isOld, $isObsoleted, $isBundled);
            $this->showTaxonomy($R, $data, $rel);
            $R->doc .= '</div>';
        }

        $this->showAuthorInfo($R, $data, $rel);

        $R->doc .= '</div>'; // pluginrepo_entry
    }

    /**
     * @param Doku_Renderer_xhtml $R
     * @param array               $data instructions from handle()
     * @param string              $extensionType
     */
    protected function showMainInfo($R, $data, $extensionType)
    {
        global $ID;

        $R->doc .= '<div class="mainInfo">';

        /* plugin/template name omitted because each page usually already has an h1 with the same information
        $R->doc .= '<h4>'.noNS($id).' '.$extensionType.'</h4>';
        */

        // icon and description
        $extensionIcon = '<a class="media" href="' . wl($extensionType . 's') . '">' .
            '<img alt="' . $extensionType . '" class="medialeft" src="' .
            DOKU_BASE . 'lib/plugins/pluginrepo/images/dwplugin.png" width="60" height="60" />'
            . '</a> ';
        $R->doc .= '<p class="description">' . $extensionIcon . hsc($data['description']) . '</p>';

        // screenshot
        if ($data['screenshot_img']) {
            $url = $data['screenshot_img'];
            $title = sprintf($this->getLang('screenshot_title'), noNS($ID));
            $R->doc .= '<a href="' . ml($url) . '" class="media screenshot" title="' . $title . '" rel="lightbox">';
            $R->doc .= '<img src="' . ml($url, "w=220") . '" alt="" width="220" /></a>';
        }

        $R->doc .= '</div>';
    }

    /**
     * @param Doku_Renderer_xhtml $R
     * @param array               $data instructions from handle()
     * @param int                 $type
     * @param array               $rel relations with other extensions
     */
    protected function showMetaInfo($R, $data, $type, $rel)
    {
        global $ID;
        $target = getNS($ID);
        if ($target == 'plugin') {
            $target .= 's';
        }

        $R->doc .= '<div class="metaInfo"><dl>';

        // last updated
        if (preg_match('/^\d\d\d\d-\d\d-\d\d$/', $data['lastupdate'])) {
            $R->doc .= '<dt>' . $this->getLang('last_updated_on') . '</dt>';
            $R->doc .= '<dd>' . $data['lastupdate'] . '</dd>';
        }

        // plugin type
        if ($type && $type != 32) {
            $R->doc .= '<dt>' . $this->getLang('provides') . '</dt>';
            $R->doc .= '<dd>' . $this->hlp->listtype($type, $target) . '</dd>';
        }

        // repository
        if ($data['sourcerepo']) {
            $R->doc .= '<dt>' . $this->getLang('sourcerepo') . '</dt>';
            $R->doc .= '<dd>'
                . '<a class="urlextern" href="' . hsc($data['sourcerepo']) . '">' . $this->getLang('source') . '</a>'
                . '</dd>';
        }

        // conflicts
        if ($rel['conflicts']) {
            $data['conflicts'] .= ',' . implode(',', $rel['conflicts']);
        }
        if ($data['conflicts']) {
            $R->doc .= '<dt>' . $this->getLang('conflicts_with') . '</dt>';
            $R->doc .= '<dd>' . $this->hlp->listplugins($data['conflicts'], $R) . '</dd>';
        }

        // dependencies
        if ($data['depends']) {
            $R->doc .= '<dt>' . $this->getLang('requires') . '</dt>';
            $R->doc .= '<dd>' . $this->hlp->listplugins($data['depends'], $R) . '</dd>';
        }

        $R->doc .= '</dl></div>';
    }

    /**
     * @param Doku_Renderer_xhtml $R
     * @param array $data instructions from handle()
     * @return bool
     */
    protected function showCompatibility($R, $data)
    {
        $R->doc .= '<div class="compatibility">';
        $R->doc .= '<p class="label">' . $this->hlp->renderCompatibilityHelp() . '</p>';
        $uptodate = false;

        // no compatibility data
        if (!$data['compatible']) {
            $R->doc .= '<p class="nothing">';
            $R->doc .= $this->getLang('no_compatibility');
            $R->doc .= '</p>';
        // compatibility data given
        } else {
            // get recent compatible releases
            $compatibility = $this->hlp->cleanCompat($data['compatible'], false);
            $cols = 0;
            $compatrow = '';
            foreach ($this->hlp->getDokuReleases() as $release) {
                if (++$cols > 4) {
                    break;
                }
                $value = $this->getLang('compatible_unknown');
                $compaticon = "";
                if (array_key_exists($release['date'], $compatibility)) {
                    $text = ($compatibility[$release['date']]['isCompatible'] ? "yes" : "no");
                    $value = $this->getLang('compatible_' . $text);
                    $compaticon = $text;
                    if ($compatibility[$release['date']]['implicit']) {
                        $value = $this->getLang('compatible_probably');
                        $compaticon = "probably";
                    }
                    $uptodate = true;
                }
                $compatrow .= '<li class="' . $compaticon . '">' . $release['date'] . ' ' . $release['label'];
                $compatrow .= '&nbsp;<strong><span>' . $value . '</span></strong></li>';
            }

            // compatible to devel
            if (strpos($data['compatible'], 'devel') !== false) {
                $R->doc .= '<p>';
                $R->internallink('devel:develonly', $this->getLang('develonly'));
                $R->doc .= '</p>';
                $uptodate = true;
            // compatible to older releases
            } elseif (!$uptodate) {
                $R->doc .= '<p>';
                $R->doc .= $data['compatible'];
                $R->doc .= '</p>';
            // compatible to recent releases
            } else {
                $R->doc .= '<div class="versions"><ul>' . $compatrow . '</ul></div>';
            }
        }

        $R->doc .= '</div>';
        return $uptodate;
    }

    /**
     * @param Doku_Renderer_xhtml $R
     * @param array               $data instructions from handle()
     */
    protected function showActionLinks($R, $data)
    {
        if ($data['downloadurl'] || $data['bugtracker'] || $data['donationurl']) {
            $R->doc .= '<ul class="actions">';
            if ($data['downloadurl']) {
                $R->doc .= '<li><a class="download" href="' . hsc($data['downloadurl']) . '">' .
                    $this->getLang('downloadurl') . '</a></li>';
            }
            if ($data['bugtracker']) {
                $R->doc .= '<li><a class="bugs" href="' . hsc($data['bugtracker']) . '">' .
                    $this->getLang('bugtracker') . '</a></li>';
            }
            if ($data['donationurl']) {
                $R->doc .= '<li><a class="donate" href="' . hsc($data['donationurl']) . '">' .
                    $this->getLang('donationurl') . '</a></li>';
            }
            $R->doc .= '</ul><div class="clearer"></div>';
        }
    }

    /**
     * @param Doku_Renderer_xhtml $R
     * @param array $data instructions from handle()
     * @param bool $hasUnderscoreIssue
     * @param bool $isOld
     * @param bool $isObsoleted
     * @param bool $isBundled
     */
    protected function showWarnings($R, $data, $hasUnderscoreIssue, $isOld, $isObsoleted, $isBundled)
    {
        global $ID;

        if ($data['updatemessage']) {
            $R->doc .= '<div class="notify">';
            $R->doc .= '<p>' . hsc($data['updatemessage']) . '</p>';
            $R->doc .= '</div>';
        }
        if ($isObsoleted) {
            $R->doc .= '<div class="notify">';
            $R->doc .= '<p>' . $this->getLang('extension_obsoleted') . '</p>';
            $R->doc .= '</div>';
        }
        if (!$data['downloadurl'] && !$isBundled) {
            $R->doc .= '<div class="notify">';
            $R->doc .= '<p>' . $this->getLang('missing_downloadurl') . '</p>';
            $R->doc .= '</div>';
        }
        if ($isOld) {
            $R->doc .= '<div class="notify">';
            $R->doc .= '<p>' . $this->getLang('name_oldage') . '</p>';
            $R->doc .= '</div>';
        }

        if ($data['securitywarning']) {
            $R->doc .= '<div class="notify">';
            $securitylink = $R->internallink('devel:security', $this->getLang('securitylink'), null, true);
            $R->doc .= '<p><strong>' . sprintf($this->getLang('securitywarning'), $securitylink) . '</strong> ';
            $R->doc .= $this->hlp->replaceSecurityWarningShortcut($data['securitywarning']);
            $R->doc .= '</p>' . '</div>';
        }

        if ($data['securityissue']) {
            $R->doc .= '<div class="error">';
            $R->doc .= '<p><strong>' . $this->getLang('securityissue') . '</strong> ';
            $R->doc .= hsc($data['securityissue']);
            $securitylink = $R->internallink('devel:security', $this->getLang('securitylink'), null, true);
            $R->doc .= '</p>' . '<p>' . sprintf($this->getLang('securityrecommendation'), $securitylink) . '</p>';
            $R->doc .= '</div>';
        }

        if ($hasUnderscoreIssue) {
            $R->doc .= '<div class="info">';
            $R->doc .= '<p>' . $this->getLang('name_underscore') . '</p>';
            $R->doc .= '</div>';
        }

        //notify if outside [plugin|template]:[lang:] namespace
        $firstns = '';
        $pos = stripos($ID, ':');
        if ($pos !== false) {
            $firstns = substr($ID, 0, $pos);
        }
        if ($firstns !== 'plugin' && $firstns !== 'template') {
            $R->doc .= '<div class="notify">';
            $R->doc .= '<p>' . $this->getLang('wrongnamespace') . '</p>';
            $R->doc .= '</div>';
        }
    }

    /**
     * @param Doku_Renderer_xhtml $R
     * @param array               $data instructions from handle()
     * @param array               $rel
     */
    protected function showTaxonomy($R, $data, $rel)
    {
        global $ID;
        $target = getNS($ID);
        if ($target == 'plugin') {
            $target .= 's';
        }

        // similar extensions
        if ($rel['similar']) {
            $data['similar'] .= ',' . implode(',', $rel['similar']);
        }
        if ($data['similar']) {
            $R->doc .= '<p class="similar">' . $this->getLang('similar_to') . ' ';
            $R->doc .= $this->hlp->listplugins($data['similar'], $R) . '</p>';
        }
        // tags
        if ($data['tags']) {
            $R->doc .= '<p class="tags">' . $this->getLang('tagged_with') . ' ';
            $R->doc .= $this->hlp->listtags($data['tags'], $target) . '</p>';
        }
        // Needed for
        if ($rel['needed']) {
            $R->doc .= '<p class="needed">' . $this->getLang('needed_for') . ' ';
            $R->doc .= $this->hlp->listplugins($rel['needed'], $R) . '</p>';
        }
    }

    /**
     * @param Doku_Renderer_xhtml $R
     * @param array               $data instructions from handle()
     * @param array               $rel
     */
    protected function showAuthorInfo($R, $data, $rel)
    {
        $R->doc .= '<div class="authorInfo">';

        // author
        $R->doc .= '<strong>' . ucfirst($this->getLang('by')) . ' ';
        if ($data['email']) {
            $R->emaillink($data['email'], $data['author']);
        } else {
            $R->doc .= $data['author'];
        }
        $R->doc .= '</strong>';

        // other extensions by the same author (10 max)
        if (isset($rel['sameauthor']) && count($rel['sameauthor']) > 0) {
            $maxShow = 10;
            $itr = 0;
            $R->doc .= '<ul>';
            while ($itr < count($rel['sameauthor']) && $itr < $maxShow) {
                $R->doc .= '<li>' . $this->hlp->pluginlink($R, $rel['sameauthor'][$itr++]) . '</li> ';
            }
            if (count($rel['sameauthor']) > $maxShow) {
                $remainingExtensions = count($rel['sameauthor']) - $maxShow;
                $R->doc .= '<li>' . sprintf($this->getLang('more_extensions'), $remainingExtensions) . '</li>';
            }
            $R->doc .= '</ul>';
        }

        $R->doc .= '</div>';
    }

    /**
     * Save date to the database
     *
     * @param array  $data instructions from handle()
     * @param string $id   plugin/template id
     * @param string $name page title
     */
    protected function saveData($data, $id, $name)
    {
        $db = $this->hlp->getPluginsDB();
        if (!$db) {
            return;
        }

        if (!$name) {
            $name = $id;
        }
        if (!preg_match('/^\d\d\d\d-\d\d-\d\d$/', $data['lastupdate'])) {
            $data['lastupdate'] = null;
        }

        if (in_array($id, $this->hlp->bundled)) {
            $bestcompatible = 'xx9999-99-99';
        } else {
            $array = array_keys($this->hlp->cleanCompat($data['compatible']));
            $bestcompatible = array_shift($array);
        }

        $type = $this->hlp->parsetype($data['type']);

        // handle securityissue, tags field NOT NULL otherwise WHERE clauses will fail
        if (empty($data['securityissue'])) {
            $data['securityissue'] = "";
        }
        if (empty($data['tags'])) {
            $data['tags'] = "";
        }

        if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
            $insert = 'INSERT';
            $duplicate = 'ON DUPLICATE KEY UPDATE
                                name            = :name,
                                description     = :description,
                                author          = :author,
                                email           = LOWER(:email),
                                compatible      = :compatible,
                                bestcompatible  = :bestcompatible,
                                lastupdate      = :lastupdate,
                                securityissue   = :securityissue,
                                securitywarning = :securitywarning,
                                updatemessage   = :updatemessage,
                                downloadurl     = :downloadurl,
                                bugtracker      = :bugtracker,
                                sourcerepo      = :sourcerepo,
                                donationurl     = :donationurl,
                                screenshot      = :screenshot,
                                tags            = :tags,
                                type            = :type

                            ';
        } else {
            $insert = 'INSERT OR REPLACE';
            $duplicate = '';
        }

        $stmt = $db->prepare(
            $insert . ' INTO plugins
                (plugin, name, description,
                author, email,
                compatible, bestcompatible, lastupdate, securityissue, securitywarning, updatemessage,
                downloadurl, bugtracker, sourcerepo, donationurl,
                screenshot, tags, type)
            VALUES
                (:plugin, :name, :description,
                :author, LOWER(:email),
                :compatible, :bestcompatible, :lastupdate, :securityissue, :securitywarning, :updatemessage,
                :downloadurl, :bugtracker, :sourcerepo, :donationurl,
                :screenshot, :tags, :type)
            ' . $duplicate
        );
        $stmt->execute([
            ':plugin' => $id,
            ':name' => $name,
            ':description' => $data['description'],
            ':author' => $data['author'],
            ':email' => $data['email'],
            ':compatible' => $data['compatible'],
            ':bestcompatible' => $bestcompatible,
            ':lastupdate' => $data['lastupdate'],
            ':securityissue' => $data['securityissue'],
            ':securitywarning' => $data['securitywarning'],
            ':updatemessage' => $data['updatemessage'],
            ':downloadurl' => $data['downloadurl'],
            ':bugtracker' => $data['bugtracker'],
            ':sourcerepo' => $data['sourcerepo'],
            ':donationurl' => $data['donationurl'],
            ':screenshot' => $data['screenshot_img'],
            ':tags' => $data['tags'],
            ':type' => $type
        ]);

        if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
            $insert = 'INSERT IGNORE';
        } else {
            $insert = 'INSERT OR IGNORE';
        }

        $tags = $this->hlp->parsetags($data['tags']);
        $stmt = $db->prepare('DELETE FROM plugin_tags WHERE plugin = ?');
        $stmt->execute([$id]);
        foreach ($tags as $tag) {
            $stmt = $db->prepare($insert . ' INTO plugin_tags (plugin, tag) VALUES (?,LOWER(?))');
            $stmt->execute([$id, $tag]);
        }

        $deps = explode(',', $data['depends']);
        $deps = array_map('trim', $deps);
        $deps = array_filter($deps);

        $stmt = $db->prepare('DELETE FROM plugin_depends WHERE plugin = ?');
        $stmt->execute([$id]);
        foreach ($deps as $dep) {
            $stmt = $db->prepare($insert . ' INTO plugin_depends (plugin, other) VALUES (?,LOWER(?))');
            $stmt->execute([$id, $dep]);
        }

        $deps = explode(',', $data['conflicts']);
        $deps = array_map('trim', $deps);
        $deps = array_filter($deps);

        $stmt = $db->prepare('DELETE FROM plugin_conflicts WHERE plugin = ?');
        $stmt->execute([$id]);
        foreach ($deps as $dep) {
            $stmt = $db->prepare($insert . ' INTO plugin_conflicts (plugin, other) VALUES (?,LOWER(?))');
            $stmt->execute([$id, $dep]);
        }

        $deps = explode(',', $data['similar']);
        $deps = array_map('trim', $deps);
        $deps = array_filter($deps);

        $stmt = $db->prepare('DELETE FROM plugin_similar WHERE plugin = ?');
        $stmt->execute([$id]);
        foreach ($deps as $dep) {
            $stmt = $db->prepare($insert . ' INTO plugin_similar (plugin, other) VALUES (?,LOWER(?))');
            $stmt->execute([$id, $dep]);
        }
    }
}