doc.php 4.95 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 57 58 59 60 61
        $this->title  = $this->trimmed('title');
        $this->output = null;

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

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

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

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

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 99 100 101 102 103 104 105 106 107 108
    {
        $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');
    }
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
     */
117

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

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

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

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

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

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

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

178 179
        if (file_exists(INSTALLDIR.'/doc-src/'.$this->title)) {
            $distDef = INSTALLDIR.'/doc-src/'.$this->title;
180 181
        }

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

184 185
        if (count($dist) || isset($distDef)) {
            return $this->negotiateLanguage($dist, $distDef);
186 187 188 189 190
        }

        return null;
    }

191
    function negotiateLanguage($filenames, $defaultFilename=null)
192
    {
193 194 195 196 197 198 199 200 201 202 203
        // XXX: do this better

        $langcode = common_language();

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

        return $defaultFilename;
204
    }
205
}