doc.php 5.27 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
    var $output   = null;
    var $filename = null;
    var $title    = null;

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

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

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

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

79 80 81 82 83 84 85 86 87 88
    /**
     * Page title
     *
     * Gives the page title of the document. Override default for hAtom entry.
     *
     * @return void
     */

    function showPageTitle()
    {
89 90
        $this->element('h1', array('class' => 'entry-title'), $this->title());
    }
91

92 93 94 95 96 97 98 99
    /**
     * Block for content.
     *
     * Overrides default from Action to wrap everything in an hAtom entry.
     *
     * @return void.
     */

100
    function showContentBlock()
101 102 103 104 105 106 107 108 109 110 111
    {
        $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');
    }
112

Robin Millette's avatar
Robin Millette committed
113 114
    /**
     * Display content.
115
     *
116 117 118
     * Shows the content of the document.
     *
     * @return void
Robin Millette's avatar
Robin Millette committed
119
     */
120

Robin Millette's avatar
Robin Millette committed
121 122
    function showContent()
    {
123
        $this->raw($this->output);
Robin Millette's avatar
Robin Millette committed
124 125 126 127
    }

    /**
     * Page title.
128
     *
129 130
     * Uses the title of the document.
     *
Robin Millette's avatar
Robin Millette committed
131
     * @return page title
Robin Millette's avatar
Robin Millette committed
132
     */
Robin Millette's avatar
Robin Millette committed
133 134 135
    function title()
    {
        return ucfirst($this->title);
136
    }
137

138 139 140 141 142 143 144 145
    /**
     * These pages are read-only.
     *
     * @param array $args unused.
     *
     * @return boolean read-only flag (false)
     */

146
    function isReadOnly($args)
147 148 149
    {
        return true;
    }
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170

    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()
    {
171 172 173 174 175
        if (file_exists(INSTALLDIR.'/local/doc-src/'.$this->title)) {
            $localDef = INSTALLDIR.'/local/doc-src/'.$this->title;
        }

        $local = glob(INSTALLDIR.'/local/doc-src/'.$this->title.'.*');
176 177 178 179
        if ($local === false) {
            // Some systems return false, others array(), if dir didn't exist.
            $local = array();
        }
180 181 182 183

        if (count($local) || isset($localDef)) {
            return $this->negotiateLanguage($local, $localDef);
        }
184

185 186
        if (file_exists(INSTALLDIR.'/doc-src/'.$this->title)) {
            $distDef = INSTALLDIR.'/doc-src/'.$this->title;
187 188
        }

189
        $dist = glob(INSTALLDIR.'/doc-src/'.$this->title.'.*');
190 191 192
        if ($dist === false) {
            $dist = array();
        }
193

194 195
        if (count($dist) || isset($distDef)) {
            return $this->negotiateLanguage($dist, $distDef);
196 197 198 199 200
        }

        return null;
    }

201
    function negotiateLanguage($filenames, $defaultFilename=null)
202
    {
203 204 205 206 207 208 209 210 211 212 213
        // XXX: do this better

        $langcode = common_language();

        foreach ($filenames as $filename) {
            if (preg_match('/\.'.$langcode.'$/', $filename)) {
                return $filename;
            }
        }

        return $defaultFilename;
214
    }
215
}