doc.php 4.49 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 8

/**
 * Documentation action.
 *
 * PHP version 5
 *
 * @category Action
9
 * @package  StatusNet
10 11
 * @author   Evan Prodromou <evan@status.net>
 * @author   Robin Millette <millette@status.net>
Robin Millette's avatar
Robin Millette committed
12
 * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
13
 * @link     http://status.net/
Robin Millette's avatar
Robin Millette committed
14
 *
15
 * StatusNet - the distributed open-source microblogging tool
16
 * Copyright (C) 2008, 2009, StatusNet, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 *
 * 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/>.
 */

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

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

    function prepare($args)
    {
        $this->title  = $this->trimmed('title');
        $this->output = null;

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

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

Evan Prodromou's avatar
Evan Prodromou committed
74 75 76 77 78 79 80 81 82 83
    /**
     * Page title
     *
     * Gives the page title of the document. Override default for hAtom entry.
     *
     * @return void
     */

    function showPageTitle()
    {
84 85
        $this->element('h1', array('class' => 'entry-title'), $this->title());
    }
Evan Prodromou's avatar
Evan Prodromou committed
86

Evan Prodromou's avatar
Evan Prodromou committed
87 88 89 90 91 92 93 94
    /**
     * Block for content.
     *
     * Overrides default from Action to wrap everything in an hAtom entry.
     *
     * @return void.
     */

95
    function showContentBlock()
Evan Prodromou's avatar
Evan Prodromou committed
96 97 98 99 100 101 102 103 104 105 106
    {
        $this->elementStart('div', array('id' => 'content', 'class' => 'hentry'));
        $this->showPageTitle();
        $this->showPageNoticeBlock();
        $this->elementStart('div', array('id' => 'content_inner',
                                         'class' => 'entry-content'));
        // show the actual content (forms, lists, whatever)
        $this->showContent();
        $this->elementEnd('div');
        $this->elementEnd('div');
    }
107

Robin Millette's avatar
Robin Millette committed
108 109
    /**
     * Display content.
Evan Prodromou's avatar
Evan Prodromou committed
110
     *
Evan Prodromou's avatar
Evan Prodromou committed
111 112 113
     * Shows the content of the document.
     *
     * @return void
Robin Millette's avatar
Robin Millette committed
114
     */
Evan Prodromou's avatar
Evan Prodromou committed
115

Robin Millette's avatar
Robin Millette committed
116 117
    function showContent()
    {
118
        $this->raw($this->output);
Robin Millette's avatar
Robin Millette committed
119 120 121 122
    }

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

Evan Prodromou's avatar
Evan Prodromou committed
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 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

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

            $this->filename = $this->getFilename();

            if (empty($this->filename)) {
                throw new ClientException(sprintf(_('No such document "%s"'), $this->title), 404);
            }

            $c = file_get_contents($this->filename);

            $this->output = common_markup_to_html($c);

            Event::handle('EndLoadDoc', array($this->title, &$this->output));
        }
    }

    function getFilename()
    {
        $local = array_merge(glob(INSTALLDIR.'/local/doc-src/'.$this->title),
                             glob(INSTALLDIR.'/local/doc-src/'.$this->title.'.*'));

        if (count($local)) {
            return $this->negotiateLanguage($local);
        }

        $dist = array_merge(glob(INSTALLDIR.'/doc-src/'.$this->title),
                            glob(INSTALLDIR.'/doc-src/'.$this->title.'.*'));

        if (count($dist)) {
            return $this->negotiateLanguage($dist);
        }

        return null;
    }

    function negotiateLanguage($files)
    {
        // FIXME: write this
    }
187
}