]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/docfile.php
use none instead of unset
[quix0rs-gnu-social.git] / lib / docfile.php
1 <?php
2 /**
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2011, StatusNet, Inc.
5  *
6  * Utility for finding and parsing documentation files
7  * 
8  * PHP version 5
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU Affero General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Affero General Public License for more details.
19  *
20  * You should have received a copy of the GNU Affero General Public License
21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  * @category  Documentation
24  * @package   StatusNet
25  * @author    Evan Prodromou <evan@status.net>
26  * @copyright 2011 StatusNet, Inc.
27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
28  * @link      http://status.net/
29  */
30
31 if (!defined('STATUSNET')) {
32     // This check helps protect against security problems;
33     // your code file can't be executed directly from the web.
34     exit(1);
35 }
36
37 /**
38  * Utility for finding and parsing documentation files
39  *
40  * @category  Documentation
41  * @package   StatusNet
42  * @author    Evan Prodromou <evan@status.net>
43  * @copyright 2011 StatusNet, Inc.
44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
45  * @link      http://status.net/
46  */
47
48 class DocFile
49 {
50     protected $filename;
51     protected $contents;
52
53     function __construct($filename)
54     {
55         $this->filename = $filename;
56     }
57
58     static function forTitle($title, $paths)
59     {
60         if (!is_array($paths)) {
61             $paths = array($paths);
62         }
63
64         $filename = null;
65
66         if (Event::handle('StartDocFileForTitle', array($title, &$paths, &$filename))) {
67
68             foreach ($paths as $path) {
69
70                 $def = $path.'/'.$title;
71
72                 if (!file_exists($def)) {
73                     $def = null;
74                 }
75
76                 $lang = glob($path.'/'.$title.'.*');
77
78                 if ($lang === false) {
79                     $lang = array();
80                 }
81
82                 if (!empty($lang) || !empty($def)) {
83                     $filename = self::negotiateLanguage($lang, $def);
84                     break;
85                 }
86             }
87
88             Event::handle('EndDocFileForTitle', array($title, $paths, &$filename));
89         }
90
91         if (empty($filename)) {
92             return null;
93         } else {
94             return new DocFile($filename);
95         }
96     }
97
98     function toHTML($args=null)
99     {
100         if (is_null($args)) {
101             $args = array();
102         }
103
104         if (empty($this->contents)) {
105             $this->contents = file_get_contents($this->filename);
106         }
107
108         return common_markup_to_html($this->contents, $args);
109     }
110
111     static function defaultPaths()
112     {
113         $paths = array(INSTALLDIR.'/local/doc-src/',
114                        INSTALLDIR.'/doc-src/');
115
116         $site = GNUsocial::currentSite();
117         
118         if (!empty($site)) {
119             array_unshift($paths, INSTALLDIR.'/local/doc-src/'.$site.'/');
120         }
121
122         return $paths;
123     }
124
125     static function mailPaths()
126     {
127         $paths = array(INSTALLDIR.'/local/mail-src/',
128                        INSTALLDIR.'/mail-src/');
129
130         $site = GNUsocial::currentSite();
131         
132         if (!empty($site)) {
133             array_unshift($paths, INSTALLDIR.'/local/mail-src/'.$site.'/');
134         }
135
136         return $paths;
137     }
138
139     static function negotiateLanguage($filenames, $defaultFilename=null)
140     {
141         // XXX: do this better
142
143         $langcode = common_language();
144
145         foreach ($filenames as $filename) {
146             if (preg_match('/\.'.$langcode.'$/', $filename)) {
147                 return $filename;
148             }
149         }
150
151         return $defaultFilename;
152     }
153 }