Extension manager: Implement extension table

This uses a lot of code and the whole design from the previous extension
manager implementation.

1 files changed, 477 insertions, 0 deletions

diff --git a/lib/plugins/extension/helper/list.php b/lib/plugins/extension/helper/list.php
new file mode 100644
index 000000000..ffb88114d
--- /dev/null
+++ b/lib/plugins/extension/helper/list.php
@@ -0,0 +1,477 @@
+<?php
+/**
+ * DokuWiki Plugin extension (Helper Component)
+ *
+ * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
+ * @author  Michael Hamann <michael@content-space.de>
+ */
+
+// must be run within Dokuwiki
+if(!defined('DOKU_INC')) die();
+
+/**
+ * Class helper_plugin_extension_extension represents a single extension (plugin or template)
+ */
+class helper_plugin_extension_list extends DokuWiki_Plugin {
+    protected $form = '';
+
+    function start_form() {
+        $this->form .= '<form id="extension__list" accept-charset="utf-8" method="post" action="">';
+        $hidden = array(
+            'do'=>'admin',
+            'page'=>'extension',
+            'sectok'=>getSecurityToken()
+        );
+        $this->add_hidden($hidden);
+        $this->form .= '<ul class="extensionList">';
+    }
+    /**
+     * Build single row of extension table
+     * @param helper_plugin_extension_extension  $extension The extension that shall be added
+     * @param bool                               $showinfo  Show the info area
+     */
+    function add_row(helper_plugin_extension_extension $extension, $showinfo = false) {
+        $this->start_row($extension);
+        $this->populate_column('legend', $this->make_legend($extension, $showinfo));
+        $this->populate_column('actions', $this->make_actions($extension));
+        $this->end_row();
+    }
+
+    /**
+     * Adds a header to the form
+     *
+     * @param string $id     The id of the header
+     * @param string $header The content of the header
+     * @param int    $level  The level of the header
+     */
+    function add_header($id, $header, $level = 2) {
+        $this->form .='<h'.$level.' id="'.$id.'">'.hsc($header).'</h'.$level.'>';
+    }
+
+    /**
+     * Adds a paragraph to the form
+     *
+     * @param string $data The content
+     */
+    function add_p($data) {
+        $this->form .= '<p>'.hsc($data).'</p>';
+    }
+
+    /**
+     * Add hidden fields to the form with the given data
+     * @param array $array
+     */
+    function add_hidden(array $array) {
+        $this->form .= '<div class="no">';
+        foreach ($array as $key => $value) {
+            $this->form .= '<input type="hidden" name="'.hsc($key).'" value="'.hsc($value).'" />';
+        }
+        $this->form .= '</div>';
+    }
+
+    /**
+     * Add closing tags
+     */
+    function end_form() {
+        $this->form .= '</ul>';
+        $this->form .= '</form>';
+    }
+
+    /**
+     * Print the form
+     */
+    function render() {
+        echo $this->form;
+    }
+
+    /**
+     * Start the HTML for the row for the extension
+     *
+     * @param helper_plugin_extension_extension $extension The extension
+     */
+    private function start_row(helper_plugin_extension_extension $extension) {
+        $this->form .= '<li id="extensionplugin__'.hsc($extension->getInstallName()).'" class="'.$this->make_class($extension).'">';
+    }
+
+    /**
+     * Add a column with the given class and content
+     * @param string $class The class name
+     * @param string $html  The content
+     */
+    private function populate_column($class, $html) {
+        $this->form .= '<div class="'.$class.' col">'.$html.'</div>';
+    }
+
+    /**
+     * End the row
+     */
+    private function end_row() {
+        $this->form .= '</li>'.DOKU_LF;
+    }
+
+    /**
+     * Generate the link to the plugin homepage
+     *
+     * @param helper_plugin_extension_extension $extension The extension
+     * @return string The HTML code
+     */
+    function make_homepagelink(helper_plugin_extension_extension $extension) {
+        $text = $this->getLang('homepage_link');
+        $url = hsc($extension->getURL());
+        return '<a href="'.$url.'" title="'.$url.'" class ="urlextern">'.$text.'</a> ';
+    }
+
+    /**
+     * Generate the class name for the row of the extensio
+     *
+     * @param helper_plugin_extension_extension $extension The extension object
+     * @return string The class name
+     */
+    function make_class(helper_plugin_extension_extension $extension) {
+        $class = ($extension->isTemplate()) ? 'template' : 'plugin';
+        if($extension->isInstalled()) {
+            $class.=' installed';
+            $class.= ($extension->isEnabled()) ? ' enabled':' disabled';
+        }
+        if(!$extension->canModify()) $class.= ' notselect';
+        if($extension->isProtected()) $class.=  ' protected';
+        //if($this->showinfo) $class.= ' showinfo';
+        return $class;
+    }
+
+    /**
+     * Generate a link to the author of the extension
+     *
+     * @param helper_plugin_extension_extension $extension The extension object
+     * @return string The HTML code of the link
+     */
+    function make_author(helper_plugin_extension_extension $extension) {
+        global $ID;
+
+        if($extension->getAuthor()) {
+
+            $params = array(
+                'do'=>'admin',
+                'page'=>'extension',
+                'tab'=>'search',
+                'q'=>'author:'.$extension->getAuthor()
+            );
+            $url = wl($ID, $params);
+            return '<a href="'.$url.'" title="'.$this->getLang('author_hint').'" >'.hsc($extension->getAuthor()).'</a>';
+        }
+        return "<em>".$this->getLang('unknown_author')."</em>";
+    }
+
+    /**
+     * Get the link and image tag for the screenshot/thumbnail
+     *
+     * @param helper_plugin_extension_extension $extension The extension object
+     * @return string The HTML code
+     */
+    function make_screenshot(helper_plugin_extension_extension $extension) {
+        if($extension->getScreenshotURL()) {
+            $img = '<a title="'.hsc($extension->getName()).'" href="'.hsc($extension->getScreenshotURL()).'" target="_blank">'.
+                '<img alt="'.hsc($extension->getName()).'" width="120" height="70" src="'.hsc($extension->getThumbnailURL()).'" />'.
+                '</a>';
+        } elseif($extension->isTemplate()) {
+            $img = '<img alt="template" width="120" height="70" src="'.DOKU_BASE.'lib/plugins/extension/images/template.png" />';
+
+        } else {
+            $img = '<img alt="plugin" width="120" height="70" src="'.DOKU_BASE.'lib/plugins/extension/images/plugin.png" />';
+        }
+        return '<div class="screenshot" >'.$img.'<span></span></div>';
+    }
+
+    /**
+     * Extension main description
+     *
+     * @param helper_plugin_extension_extension $extension The extension object
+     * @param bool                              $showinfo  Show the info section
+     * @return string The HTML code
+     */
+    function make_legend(helper_plugin_extension_extension $extension, $showinfo = false) {
+        $return  = '<div>';
+        $return .= '<h2>';
+        $return .= sprintf($this->getLang('extensionby'), hsc($extension->getName()), $this->make_author($extension));
+        $return .= '</h2>';
+
+        $return .= $this->make_screenshot($extension);
+
+        $popularity = $extension->getPopularity();
+        if ($popularity !== false && !$extension->isBundled()) {
+            $popularityText = sprintf($this->getLang('popularity'), $popularity);
+            $return .= '<div class="popularity" title="'.$popularityText.'"><div style="width: '.($popularity * 100).'%;"><span></span></div></div>';
+        }
+
+        $return .= '<p>';
+        if($extension->getDescription()) {
+            $return .=  hsc($extension->getDescription()).' ';
+        }
+        $return .= '</p>';
+
+        $return .= $this->make_linkbar($extension);
+        $return .= $this->make_action('info', $extension, $showinfo);
+        if ($showinfo) {
+            $return .= $this->make_info($extension);
+        }
+        $return .= $this->make_noticearea($extension);
+        $return .= '</div>';
+        return $return;
+    }
+
+    /**
+     * Generate the link bar HTML code
+     *
+     * @param helper_plugin_extension_extension $extension The extension instance
+     * @return string The HTML code
+     */
+    function make_linkbar(helper_plugin_extension_extension $extension) {
+        $return  = '<span class="linkbar">';
+        $return .= $this->make_homepagelink($extension);
+        if ($extension->getBugtrackerURL()) {
+            $return .= ' <a href="'.hsc($extension->getBugtrackerURL()).'" title="'.hsc($extension->getBugtrackerURL()).'" class ="interwiki iw_dokubug">'.$this->getLang('bugs_features').'</a> ';
+        }
+        foreach ($extension->getTags() as $tag) {
+            $return .= hsc($tag).' '; //$this->manager->handler->html_taglink($tag);
+        }
+        $return .= '</span>';
+        return $return;
+    }
+
+    /**
+     * Notice area
+     *
+     * @param helper_plugin_extension_extension $extension The extension
+     * @return string The HTML code
+     */
+    function make_noticearea(helper_plugin_extension_extension $extension) {
+        $return = '';
+        $missing_dependencies = $extension->getMissingDependencies();
+        if(!empty($missing_dependencies)) {
+            $return .= '<div class="msg error">'.
+                sprintf($this->getLang('missing_dependency'), implode(', ', /*array_map(array($this->helper, 'make_extensionsearchlink'),*/ $missing_dependencies)).
+                '</div>';
+        }
+        if($extension->isInWrongFolder()) {
+            $return .= '<div class="msg error">'.
+                sprintf($this->getLang('wrong_folder'), hsc($extension->getInstallName()), hsc($extension->getBase())).
+                '</div>';
+        }
+        if(($securityissue = $extension->getSecurityIssue()) !== false) {
+            $return .= '<div class="msg error">'.
+                sprintf($this->getLang('security_issue'), hsc($securityissue )).
+                '</div>';
+        }
+        if(($securitywarning = $extension->getSecurityWarning()) !== false) {
+            $return .= '<div class="msg notify">'.
+                sprintf($this->getLang('security_warning'), hsc($securitywarning)).
+                '</div>';
+        }
+        if($extension->updateAvailable()) {
+            $return .=  '<div class="msg notify">'.
+                sprintf($this->getLang('update_available'), hsc($extension->getLastUpdate())).
+                '</div>';
+        }
+        if($extension->hasDownloadURLChanged()) {
+            $return .=  '<div class="msg notify">'.
+                sprintf($this->getLang('url_change'), hsc($extension->getDownloadURL()), hsc($extension->getLastDownloadURL())).
+                '</div>';
+        }
+        return $return;
+    }
+
+    /**
+     * Create a link from the given URL
+     *
+     * Shortens the URL for display
+     *
+     * @param string $url
+     *
+     * @return string  HTML link
+     */
+    function shortlink($url){
+        $link = parse_url($url);
+
+        $base = $link['host'];
+        if($link['port']) $base .= $base.':'.$link['port'];
+        $long = $link['path'];
+        if($link['query']) $long .= $link['query'];
+
+        $name = shorten($base, $long, 55);
+
+        return '<a href="'.hsc($url).'" class="urlextern">'.hsc($name).'</a>';
+    }
+
+    /**
+     * Plugin/template details
+     *
+     * @param helper_plugin_extension_extension $extension The extension
+     * @return string The HTML code
+     */
+    function make_info(helper_plugin_extension_extension $extension) {
+        $default = $this->getLang('unknown');
+        $return = '<dl class="details">';
+
+        if (!$extension->isBundled()) {
+            $return .= '<dt>'.$this->getLang('downloadurl').'</dt>';
+            $return .= '<dd>';
+            $return .= ($extension->getDownloadURL() ? $this->shortlink($extension->getDownloadURL()) : $default);
+            $return .= '</dd>';
+
+            $return .= '<dt>'.$this->getLang('repository').'</dt>';
+            $return .= '<dd>';
+            $return .= ($extension->getSourcerepoURL() ? $this->shortlink($extension->getSourcerepoURL()) : $default);
+            $return .= '</dd>';
+        }
+
+        if ($extension->isInstalled()) {
+            if ($extension->getInstalledVersion()) {
+                $return .= '<dt>'.$this->getLang('installed_version').'</dt>';
+                $return .= '<dd>';
+                $return .= hsc($extension->getInstalledVersion());
+                $return .= '</dd>';
+            } else {
+                $return .= '<dt>'.$this->getLang('install_date').'</dt>';
+                $return .= '<dd>';
+                $return .= ($extension->getUpdateDate() ? hsc($extension->getUpdateDate()) : $this->getLang('unknown'));
+                $return .= '</dd>';
+            }
+        }
+        if (!$extension->isInstalled() || $extension->updateAvailable()) {
+            $return .= '<dt>'.$this->getLang('available_version').'</dt>';
+            $return .= '<dd>';
+            $return .= ($extension->getLastUpdate() ? hsc($extension->getLastUpdate()) : $this->getLang('unknown'));
+            $return .= '</dd>';
+        }
+
+        if($extension->getInstallDate()) {
+            $return .= '<dt>'.$this->getLang('installed').'</dt>';
+            $return .= '<dd>';
+            $return .= hsc($extension->getInstallDate());
+            $return .= '</dd>';
+        }
+
+        $return .= '<dt>'.$this->getLang('provides').'</dt>';
+        $return .= '<dd>';
+        $return .= ($extension->getTypes() ? hsc(implode(', ', $extension->getTypes())) : $default);
+        $return .= '</dd>';
+
+        if($extension->getCompatibleVersions()) {
+            $return .= '<dt>'.$this->getLang('compatible').'</dt>';
+            $return .= '<dd>';
+            foreach ($extension->getCompatibleVersions() as $date => $version) {
+                $return .= $version['label'].' ('.$date.'), ';
+            }
+            $return .= '</dd>';
+        }
+        if($extension->getDependencies()) {
+            $return .= '<dt>'.$this->getLang('depends').'</dt>';
+            $return .= '<dd>';
+            $return .= $this->make_linklist($extension->getDependencies());
+            $return .= '</dd>';
+        }
+
+        if($extension->getSimilarExtensions()) {
+            $return .= '<dt>'.$this->getLang('similar').'</dt>';
+            $return .= '<dd>';
+            $return .= $this->make_linklist($extension->getSimilarExtensions());
+            $return .= '</dd>';
+        }
+
+        if($extension->getConflicts()) {
+            $return .= '<dt>'.$this->getLang('conflicts').'</dt>';
+            $return .= '<dd>';
+            $return .= $this->make_linklist($extension->getConflicts());
+            $return .= '</dd>';
+        }
+        if ($extension->getDonationURL()) {
+            $return .= '<a href="'.hsc($extension->getDonationURL()).'" class="donate" title="'.$this->getLang('donate').'"></a>';
+        }
+        $return .= '</dl>';
+        return $return;
+    }
+
+    /**
+     * Generate a list of links for extensions
+     * @param array $links The links
+     * @return string The HTML code
+     */
+    function make_linklist($links) {
+        $return = '';
+        foreach ($links as $link) {
+            $dokulink = hsc($link);
+            if (strpos($link, 'template:') !== 0) $dokulink = 'plugin:'.$dokulink;
+            $return .= '<a href="http://www.dokuwiki.org/'.$dokulink.'" title="'.$dokulink.'" class="interwiki iw_doku">'.$link.'</a> ';
+        }
+        return $return;
+    }
+
+    /**
+     * Display the action buttons if they are possible
+     *
+     * @param helper_plugin_extension_extension $extension The extension
+     * @return string The HTML code
+     */
+    function make_actions(helper_plugin_extension_extension $extension) {
+        $return = '';
+        if (!$extension->isInstalled() && $extension->canModify() === true) {
+            $return .= $this->make_action('install', $extension);
+        } elseif ($extension->canModify()) {
+            if (!$extension->isBundled()) {
+                $return .= $this->make_action('uninstall', $extension);
+                if ($extension->getDownloadURL()) {
+                    if ($extension->updateAvailable()) {
+                        $return .= $this->make_action('update', $extension);
+                    } else {
+                        $return .= $this->make_action('reinstall', $extension);
+                    }
+                }
+            }
+            if (!$extension->isProtected()) {
+                if ($extension->isEnabled()) {
+                    $return .= $this->make_action('disable', $extension);
+                } else {
+                    $return .= $this->make_action('enable', $extension);
+                }
+            }
+        }
+
+        if (!$extension->isInstalled()) {
+            $return .= ' <span class="version">'.$this->getLang('available_version').' ';
+            $return .= ($extension->getLastUpdate() ? hsc($extension->getLastUpdate()) : $this->getLang('unknown')).'</span>';
+        }
+
+        return $return;
+    }
+
+    /**
+     * Display an action button for an extension
+     *
+     * @param string                            $action    The action
+     * @param helper_plugin_extension_extension $extension The extension
+     * @param bool                              $showinfo  If the info block is shown
+     * @return string The HTML code
+     */
+    function make_action($action, $extension, $showinfo = false) {
+        $title = $revertAction = $extraClass = '';
+
+        switch ($action) {
+            case 'info':
+                $title = 'title="'.$this->getLang('btn_info').'"';
+                if ($showinfo) {
+                    $revertAction = '-';
+                    $extraClass   = 'close';
+                }
+                break;
+            case 'install':
+            case 'reinstall':
+                $title = 'title="'.$extension->getDownloadURL().'"';
+                break;
+        }
+
+        $classes = 'button '.$action.' '.$extraClass;
+        $name    = 'fn['.$action.']['.$revertAction.hsc($extension->getInstallName()).']';
+
+        return '<input class="'.$classes.'" name="'.$name.'" type="submit" value="'.$this->getLang('btn_'.$action).'" '.$title.' />';
+    }
+}