summaryrefslogtreecommitdiff
path: root/actions/doc.php
blob: 25d363472a2cca2feadf3d1292c1d226c64f8bd5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<?php

/**
 * Documentation action.
 *
 * PHP version 5
 *
 * @category Action
 * @package  StatusNet
 * @author   Evan Prodromou <evan@status.net>
 * @author   Robin Millette <millette@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
 * @link     http://status.net/
 *
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2008, 2009, StatusNet, Inc.
 *
 * 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/>.
 */

if (!defined('STATUSNET') && !defined('LACONICA')) {
    exit(1);
}

/**
 * Documentation class.
 *
 * @category Action
 * @package  StatusNet
 * @author   Evan Prodromou <evan@status.net>
 * @author   Robin Millette <millette@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
 * @link     http://status.net/
 */
class DocAction extends Action
{
    var $output   = null;
    var $filename = null;
    var $title    = null;

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

        $this->title  = $this->trimmed('title');
        $this->output = null;

        $this->loadDoc();
        return true;
    }

    /**
     * Handle a request
     *
     * @param array $args array of arguments
     *
     * @return nothing
     */
    function handle($args)
    {
        parent::handle($args);
        $this->showPage();
    }

    /**
     * Page title
     *
     * Gives the page title of the document. Override default for hAtom entry.
     *
     * @return void
     */

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

    /**
     * Block for content.
     *
     * Overrides default from Action to wrap everything in an hAtom entry.
     *
     * @return void.
     */

    function showContentBlock()
    {
        $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');
    }

    /**
     * Display content.
     *
     * Shows the content of the document.
     *
     * @return void
     */

    function showContent()
    {
        $this->raw($this->output);
    }

    /**
     * Page title.
     *
     * Uses the title of the document.
     *
     * @return page title
     */
    function title()
    {
        return ucfirst($this->title);
    }

    /**
     * These pages are read-only.
     *
     * @param array $args unused.
     *
     * @return boolean read-only flag (false)
     */

    function isReadOnly($args)
    {
        return true;
    }

    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()
    {
        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);
        }

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

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

        if (count($dist) || isset($distDef)) {
            return $this->negotiateLanguage($dist, $distDef);
        }

        return null;
    }

    function negotiateLanguage($filenames, $defaultFilename=null)
    {
        // XXX: do this better

        $langcode = common_language();

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

        return $defaultFilename;
    }
}