doc.php 6.67 KB
Newer Older
Evan Prodromou's avatar
Evan Prodromou committed
1
<?php
Robin Millette's avatar
Robin Millette committed
2 3 4 5 6 7
/**
 * Documentation action.
 *
 * PHP version 5
 *
 * @category Action
8
 * @package  StatusNet
9 10
 * @author   Evan Prodromou <evan@status.net>
 * @author   Robin Millette <millette@status.net>
Robin Millette's avatar
Robin Millette committed
11
 * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
12
 * @link     http://status.net/
Robin Millette's avatar
Robin Millette committed
13
 *
14
 * StatusNet - the distributed open-source microblogging tool
Zach Copley's avatar
Zach Copley committed
15
 * Copyright (C) 2008-2010, StatusNet, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

31
if (!defined('STATUSNET') && !defined('LACONICA')) {
Robin Millette's avatar
Robin Millette committed
32 33 34 35 36 37 38
    exit(1);
}

/**
 * Documentation class.
 *
 * @category Action
39
 * @package  StatusNet
40 41
 * @author   Evan Prodromou <evan@status.net>
 * @author   Robin Millette <millette@status.net>
Robin Millette's avatar
Robin Millette committed
42
 * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
43
 * @link     http://status.net/
Robin Millette's avatar
Robin Millette committed
44
 */
45 46
class DocAction extends Action
{
47 48 49 50 51 52
    var $output   = null;
    var $filename = null;
    var $title    = null;

    function prepare($args)
    {
53 54
        parent::prepare($args);

55
        $this->title  = $this->trimmed('title');
56 57 58
        if (!preg_match('/^[a-zA-Z0-9_-]*$/', $this->title)) {
            $this->title = 'help';
        }
59 60 61 62 63
        $this->output = null;

        $this->loadDoc();
        return true;
    }
Evan Prodromou's avatar
Evan Prodromou committed
64

Robin Millette's avatar
Robin Millette committed
65
    /**
66
     * Handle a request
Evan Prodromou's avatar
Evan Prodromou committed
67
     *
Robin Millette's avatar
Robin Millette committed
68 69 70
     * @param array $args array of arguments
     *
     * @return nothing
Robin Millette's avatar
Robin Millette committed
71
     */
72 73
    function handle($args)
    {
74
        parent::handle($args);
Robin Millette's avatar
Robin Millette committed
75 76 77
        $this->showPage();
    }

78 79 80 81 82 83 84 85 86
    /**
     * Page title
     *
     * Gives the page title of the document. Override default for hAtom entry.
     *
     * @return void
     */
    function showPageTitle()
    {
87 88
        $this->element('h1', array('class' => 'entry-title'), $this->title());
    }
Evan Prodromou's avatar
Evan Prodromou committed
89

90 91 92 93 94 95 96
    /**
     * Block for content.
     *
     * Overrides default from Action to wrap everything in an hAtom entry.
     *
     * @return void.
     */
97
    function showContentBlock()
98
    {
mmn's avatar
mmn committed
99
        $this->elementStart('div', array('id' => 'content', 'class' => 'h-entry'));
100 101 102
        $this->showPageTitle();
        $this->showPageNoticeBlock();
        $this->elementStart('div', array('id' => 'content_inner',
mmn's avatar
mmn committed
103
                                         'class' => 'e-content'));
104 105 106 107 108
        // show the actual content (forms, lists, whatever)
        $this->showContent();
        $this->elementEnd('div');
        $this->elementEnd('div');
    }
109

Robin Millette's avatar
Robin Millette committed
110 111
    /**
     * Display content.
Evan Prodromou's avatar
Evan Prodromou committed
112
     *
113 114 115
     * Shows the content of the document.
     *
     * @return void
Robin Millette's avatar
Robin Millette committed
116
     */
Robin Millette's avatar
Robin Millette committed
117 118
    function showContent()
    {
119
        $this->raw($this->output);
Robin Millette's avatar
Robin Millette committed
120 121 122 123
    }

    /**
     * Page title.
Evan Prodromou's avatar
Evan Prodromou committed
124
     *
125 126
     * Uses the title of the document.
     *
Robin Millette's avatar
Robin Millette committed
127
     * @return page title
Robin Millette's avatar
Robin Millette committed
128
     */
Robin Millette's avatar
Robin Millette committed
129 130 131
    function title()
    {
        return ucfirst($this->title);
132
    }
133

134 135 136 137 138 139 140
    /**
     * These pages are read-only.
     *
     * @param array $args unused.
     *
     * @return boolean read-only flag (false)
     */
141
    function isReadOnly($args)
142 143 144
    {
        return true;
    }
145 146 147 148 149

    function loadDoc()
    {
        if (Event::handle('StartLoadDoc', array(&$this->title, &$this->output))) {

150
            $paths = DocFile::defaultPaths();
151

152 153 154
            $docfile = DocFile::forTitle($this->title, $paths);

            if (empty($docfile)) {
155 156 157
                // TRANS: Client exception thrown when requesting a document from the documentation that does not exist.
                // TRANS: %s is the non-existing document.
                throw new ClientException(sprintf(_('No such document "%s".'), $this->title), 404);
158 159
            }

160
            $this->output = $docfile->toHTML();
161 162 163 164

            Event::handle('EndLoadDoc', array($this->title, &$this->output));
        }
    }
165 166 167 168 169 170 171 172 173 174 175 176

    function showLocalNav()
    {
        $menu = new DocNav($this);
        $menu->show();
    }
}

class DocNav extends Menu
{
    function show()
    {
buttle's avatar
buttle committed
177 178 179 180 181 182 183 184 185
        if (Event::handle('StartDocNav', array($this))) {
            $stub = new HomeStubNav($this->action);
            $this->submenu(_m('MENU','Home'), $stub);

            $docs = new DocListNav($this->action);
            $this->submenu(_m('MENU','Docs'), $docs);
            
            Event::handle('EndDocNav', array($this));
        }
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
    }
}

class DocListNav extends Menu
{
    function getItems()
    {
        $items = array();

        if (Event::handle('StartDocsMenu', array(&$items))) {

            $items = array(array('doc',
                                 array('title' => 'help'),
                                 _m('MENU', 'Help'),
                                 _('Getting started'),
                                 'nav_doc_help'),
                           array('doc',
                                 array('title' => 'about'),
                                 _m('MENU', 'About'),
                                 _('About this site'),
                                 'nav_doc_about'),
                           array('doc',
                                 array('title' => 'faq'),
                                 _m('MENU', 'FAQ'),
                                 _('Frequently asked questions'),
                                 'nav_doc_faq'),
                           array('doc',
                                 array('title' => 'contact'),
                                 _m('MENU', 'Contact'),
                                 _('Contact info'),
                                 'nav_doc_contact'),
                           array('doc',
                                 array('title' => 'tags'),
                                 _m('MENU', 'Tags'),
                                 _('Using tags'),
                                 'nav_doc_tags'),
                           array('doc',
                                 array('title' => 'groups'),
                                 _m('MENU', 'Groups'),
                                 _('Using groups'),
                                 'nav_doc_groups'),
                           array('doc',
                                 array('title' => 'api'),
                                 _m('MENU', 'API'),
                                 _('RESTful API'),
                                 'nav_doc_api'));

            Event::handle('EndDocsMenu', array(&$items));
        }
        return $items;
    }
237
}