indent HTML
[statusnet:mainline.git] / lib / util.php
1 <?php
2 /* 
3  * Laconica - a distributed open-source microblogging tool
4  * Copyright (C) 2008, Controlez-Vous, Inc.
5  * 
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU Affero General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  * 
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Affero General Public License for more details.
15  * 
16  * You should have received a copy of the GNU Affero General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 /* XXX: break up into separate modules (HTTP, HTML, user, files) */
21
22 # Show a server error
23
24 function common_server_error($msg) {
25         header('Status: 500 Server Error');
26         header('Content-type: text/plain');
27
28         print $msg;
29         exit();
30 }
31
32 # Show a user error
33 function common_user_error($msg, $code=200) {
34         common_show_header('Error');
35         common_element('div', array('class' => 'error'), $msg);
36         common_show_footer();
37 }
38
39 $xw = null;
40
41 # Start an HTML element
42 function common_element_start($tag, $attrs=NULL) {
43         global $xw;
44         $xw->startElement($tag);
45         if (is_array($attrs)) {
46                 foreach ($attrs as $name => $value) {
47                         $xw->writeAttribute($name, $value);
48                 }
49         } else if (is_string($attrs)) {
50                 $xw->writeAttribute('class', $attrs);
51         }
52 }
53
54 function common_element_end($tag) {
55         global $xw;
56         $xw->endElement();
57 }
58
59 function common_element($tag, $attrs=NULL, $content=NULL) {
60     common_element_start($tag, $attrs);
61         if ($content) {
62                 global $xw;
63                 $xw->text($content);
64         }
65         common_element_end($tag);
66 }
67
68 function common_show_header($pagetitle) {
69         global $config, $xw;
70
71         header('Content-Type: application/xhtml+xml');
72         
73         $xw = new XMLWriter();
74         $xw->setIndent(true);
75         $xw->openURI('php://output');
76         $xw->startDocument('1.0', 'UTF-8');
77         $xw->writeDTD('html', '-//W3C//DTD XHTML 1.0 Strict//EN',
78                                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
79
80         # FIXME: correct language for interface
81         
82         common_element_start('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
83                                                                            'xml:lang' => 'en',
84                                                                            'lang' => 'en'));
85         
86         common_element_start('head');
87         common_element('title', NULL, 
88                                    $pagetitle . " - " . $config['site']['name']);
89         common_element('link', array('rel' => 'stylesheet',
90                                                                  'type' => 'text/css',
91                                                                  'href' => $config['site']['path'] . 'theme/default/style/html.css',
92                                                                  'media' => 'screen, projection, tv'));
93         common_element('link', array('rel' => 'stylesheet',
94                                                                  'type' => 'text/css',
95                                                                  'href' => $config['site']['path'] . 'theme/default/style/layout.css',
96                                                                  'media' => 'screen, projection, tv'));
97         common_element('link', array('rel' => 'stylesheet',
98                                                                  'type' => 'text/css',
99                                                                  'href' => $config['site']['path'] . 'theme/default/style/print.css',
100                                                                  'media' => 'print'));
101         common_element_end('head');
102         common_element_start('body');
103         common_element_start('div', array('id' => 'wrapper'));
104         common_element_start('div', array('id' => 'content'));
105         common_element_start('div', array('id' => 'header'));   
106         common_element('h1', 'title', $pagetitle);
107         common_element('h2', 'subtitle', $config['site']['name']);
108         common_element_end('div');
109         common_head_menu();
110         common_element_start('div', array('id' => 'page'));
111 }
112
113 function common_show_footer() {
114         global $xw, $config;
115         common_element_start('p', 'footer');
116         common_foot_menu();
117         common_license_block();
118         common_element_end('p');
119         common_element_end('div');
120         common_element_end('div');
121         common_element_end('div');
122         common_element_end('body');
123         common_element_end('html');
124         $xw->endDocument();
125         $xw->flush();
126 }
127
128 function common_text($txt) {
129         global $xw;
130         $xw->text($txt);
131 }
132
133 function common_license_block() {
134         global $config, $xw;
135         common_element_start('div', 'license');
136         common_element_start('a', array('class' => 'license',
137                                                                         'rel' => 'license',
138                                                                         href => $config['license']['url']));
139         common_element('img', array('class' => 'license',
140                                                                 'src' => $config['license']['image'],
141                                                                 'alt' => $config['license']['title']));
142         common_element_end('a');
143         common_text(_t('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
144         common_element('a', array('class' => 'license',
145                                                           'rel' => 'license',
146                                                           href => $config['license']['url']),
147                                    $config['license']['title']);
148         common_text(_t('. Contributors should be attributed by full name or nickname.'));
149         common_element_end('div');
150 }
151
152 function common_head_menu() {
153         $user = common_current_user();
154         common_element_start('ul', array('id' => 'menu', 'class' => ($user) ? 'five' : 'three'));
155         common_menu_item(common_local_url('doc', array('title' => 'help')),
156                                          _t('Help'));
157         if ($user) {
158                 common_menu_item(common_local_url('all', array('nickname' => 
159                                                                                                            $user->nickname)),
160                                                  _t('Home'));
161                 common_menu_item(common_local_url('showstream', array('nickname' =>
162                                                                                                                           $user->nickname)),
163                                                  _t('Profile'),  $user->fullname || $user->nickname);
164                 common_menu_item(common_local_url('profilesettings'),
165                                                  _t('Settings'));
166                 common_menu_item(common_local_url('logout'),
167                                                  _t('Logout'));
168         } else {
169                 common_menu_item(common_local_url('login'),
170                                                  _t('Login'));
171                 common_menu_item(common_local_url('register'),
172                                                  _t('Register'));
173         }
174         common_element_end('ul');
175 }
176
177 function common_foot_menu() {
178         common_element_start('ul', 'footmenu');
179         common_menu_item(common_local_url('doc', array('title' => 'about')),
180                                          _t('About'));
181         common_menu_item(common_local_url('doc', array('title' => 'help')),
182                                          _t('Help'));
183         common_menu_item(common_local_url('doc', array('title' => 'privacy')),
184                                          _t('Privacy'));
185 }
186
187 function common_menu_item($url, $text, $title=NULL) {
188         $attrs['href'] = $url;
189         if ($title) {
190                 $attrs['title'] = $title;
191         }
192         common_element_start('li', 'menuitem');
193         common_element('a', $attrs, $text);
194         common_element_end('li');
195 }
196
197 function common_input($id, $label, $value=NULL) {
198         common_element_start('p');
199         common_element('label', array('for' => $id), $label);
200         $attrs = array('name' => $id,
201                                    'type' => 'text',
202                                    'id' => $id);
203         if ($value) {
204                 $attrs['value'] = htmlspecialchars($value);
205         }
206         common_element('input', $attrs);
207         common_element_end('p');
208 }
209
210 function common_password($id, $label) {
211         common_element_start('p');
212         common_element('label', array('for' => $id), $label);
213         $attrs = array('name' => $id,
214                                    'type' => 'password',
215                                    'id' => $id);
216         common_element('input', $attrs);
217         common_element_end('p');
218 }
219
220 function common_submit($id, $label) {
221         global $xw;
222         common_element_start('p');
223         common_element_start('label', array('for' => $id));
224         $xw->writeRaw('&nbsp;');
225         common_element_end('label');
226         common_element('input', array('type' => 'submit',
227                                                                   'id' => $id,
228                                                                   'name' => $id,
229                                                                   'value' => $label,
230                                                                   'class' => 'button'));
231         common_element_end('p');
232 }
233
234 # salted, hashed passwords are stored in the DB
235
236 function common_munge_password($id, $password) {
237         return md5($id . $password);
238 }
239
240 # check if a username exists and has matching password
241 function common_check_user($nickname, $password) {
242         $user = User::staticGet('nickname', $nickname);
243         if (is_null($user)) {
244                 return false;
245         } else {
246                 return (0 == strcmp(common_munge_password($password, $user->id), 
247                                                         $user->password));
248         }
249 }
250
251 # is the current user logged in?
252 function common_logged_in() {
253         return (!is_null(common_current_user()));
254 }
255
256 function common_have_session() {
257         return (0 != strcmp(session_id(), ''));
258 }
259
260 function common_ensure_session() {
261         if (!common_have_session()) {
262                 @session_start();
263         }
264 }
265
266 function common_set_user($nickname) {
267         if (is_null($nickname) && common_have_session()) {
268                 unset($_SESSION['userid']);
269                 return true;
270         } else {
271                 $user = User::staticGet('nickname', $nickname);
272                 if ($user) {
273                         common_ensure_session();
274                         $_SESSION['userid'] = $user->id;
275                         return true;
276                 } else {
277                         return false;
278                 }
279         }
280         return false;
281 }
282
283 # who is the current user?
284 function common_current_user() {
285         static $user = NULL; # FIXME: global memcached
286         if (is_null($user)) {
287                 common_ensure_session();
288                 $id = $_SESSION['userid'];
289                 if ($id) {
290                         $user = User::staticGet($id);
291                 }
292         }
293         return $user;
294 }
295
296 # get canonical version of nickname for comparison
297 function common_canonical_nickname($nickname) {
298         # XXX: UTF-8 canonicalization (like combining chars)
299         return $nickname;
300 }
301
302 # get canonical version of email for comparison
303 function common_canonical_email($email) {
304         # XXX: canonicalize UTF-8
305         # XXX: lcase the domain part
306         return $email;
307 }
308
309 function common_render_content($text) {
310         # XXX: @ messages
311         # XXX: # tags
312         # XXX: machine tags
313         return htmlspecialchars($text);
314 }
315
316 // where should the avatar go for this user?
317
318 function common_avatar_filename($user, $extension, $size=NULL) {
319         global $config;
320
321         if ($size) {
322                 return $user->id . '-' . $size . $extension;
323         } else {
324                 return $user->id . '-original' . $extension;
325         }
326 }
327
328 function common_avatar_path($filename) {
329         global $config;
330         return $config['avatar']['directory'] . '/' . $filename;
331 }
332
333 function common_avatar_url($filename) {
334         global $config;
335         return $config['avatar']['path'] . '/' . $filename;
336 }
337
338 function common_local_url($action, $args=NULL) {
339         global $config;
340         /* XXX: pretty URLs */
341         $extra = '';
342         if ($args) {
343                 foreach ($args as $key => $value) {
344                         $extra .= "&${key}=${value}";
345                 }
346         }
347         $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
348         return "http://".$config['site']['server'].'/'.$pathpart."index.php?action=${action}${extra}";
349 }
350
351 function common_date_string($dt) {
352         // XXX: do some sexy date formatting
353         // return date(DATE_RFC822, $dt);
354         return $dt;
355 }
356
357 function common_redirect($url, $code=307) {
358         static $status = array(301 => "Moved Permanently",
359                                                    302 => "Found",
360                                                    303 => "See Other",
361                                                    307 => "Temporary Redirect");
362         header("Status: ${code} $status[$code]");
363         header("Location: $url");
364         common_element('a', array('href' => $url), $url);
365 }
366
367 function common_broadcast_notices($id) {
368         // XXX: broadcast notices to remote subscribers
369         // XXX: broadcast notices to SMS
370         // XXX: broadcast notices to Jabber
371         // XXX: broadcast notices to other IM
372         // XXX: use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
373         return true;
374 }
375
376 function common_profile_url($nickname) {
377         return common_local_url('showstream', array('nickname' => $nickname));
378 }
379
380 // XXX: set up gettext
381
382 function _t($str) { 
383         return $str;
384 }