]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - common.php
62cf5640d6aa2c5263aee6457d546df73b7fd446
[quix0rs-gnu-social.git] / common.php
1 <?php
2 /*
3  * Laconica - a distributed open-source microblogging tool
4  * Copyright (C) 2008, 2009, Control Yourself, 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 if (!defined('LACONICA')) { exit(1); }
21
22 define('LACONICA_VERSION', '0.9.0dev');
23
24 // XXX: move these to class variables
25
26 define('AVATAR_PROFILE_SIZE', 96);
27 define('AVATAR_STREAM_SIZE', 48);
28 define('AVATAR_MINI_SIZE', 24);
29
30 define('NOTICES_PER_PAGE', 20);
31 define('PROFILES_PER_PAGE', 20);
32
33 define('FOREIGN_NOTICE_SEND', 1);
34 define('FOREIGN_NOTICE_RECV', 2);
35 define('FOREIGN_NOTICE_SEND_REPLY', 4);
36
37 define('FOREIGN_FRIEND_SEND', 1);
38 define('FOREIGN_FRIEND_RECV', 2);
39
40 define_syslog_variables();
41
42 # append our extlib dir as the last-resort place to find libs
43
44 set_include_path(get_include_path() . PATH_SEPARATOR . INSTALLDIR . '/extlib/');
45
46 # global configuration object
47
48 require_once('PEAR.php');
49 require_once('DB/DataObject.php');
50 require_once('DB/DataObject/Cast.php'); # for dates
51
52 require_once(INSTALLDIR.'/lib/language.php');
53
54 // This gets included before the config file, so that admin code and plugins
55 // can use it
56
57 require_once(INSTALLDIR.'/lib/event.php');
58 require_once(INSTALLDIR.'/lib/plugin.php');
59
60 function _sn_to_path($sn)
61 {
62     $past_root = substr($sn, 1);
63     $last_slash = strrpos($past_root, '/');
64     if ($last_slash > 0) {
65         $p = substr($past_root, 0, $last_slash);
66     } else {
67         $p = '';
68     }
69     return $p;
70 }
71
72 // try to figure out where we are. $server and $path
73 // can be set by including module, else we guess based
74 // on HTTP info.
75
76 if (isset($server)) {
77     $_server = $server;
78 } else {
79     $_server = array_key_exists('SERVER_NAME', $_SERVER) ?
80       strtolower($_SERVER['SERVER_NAME']) :
81     null;
82 }
83
84 if (isset($path)) {
85     $_path = $path;
86 } else {
87     $_path = (array_key_exists('SERVER_NAME', $_SERVER) && array_key_exists('SCRIPT_NAME', $_SERVER)) ?
88       _sn_to_path($_SERVER['SCRIPT_NAME']) :
89     null;
90 }
91
92 // default configuration, overwritten in config.php
93
94 $config =
95   array('site' =>
96         array('name' => 'Just another Laconica microblog',
97               'server' => $_server,
98               'theme' => 'default',
99               'path' => $_path,
100               'logfile' => null,
101               'logo' => null,
102               'logdebug' => false,
103               'fancy' => false,
104               'locale_path' => INSTALLDIR.'/locale',
105               'language' => 'en_US',
106               'languages' => get_all_languages(),
107               'email' =>
108               array_key_exists('SERVER_ADMIN', $_SERVER) ? $_SERVER['SERVER_ADMIN'] : null,
109               'broughtby' => null,
110               'timezone' => 'UTC',
111               'broughtbyurl' => null,
112               'closed' => false,
113               'inviteonly' => false,
114               'private' => false,
115               'ssl' => 'never',
116               'sslserver' => null,
117               'shorturllength' => 30,
118               'dupelimit' => 60, # default for same person saying the same thing
119               'textlimit' => 140,
120               ),
121         'syslog' =>
122         array('appname' => 'laconica', # for syslog
123               'priority' => 'debug', # XXX: currently ignored
124               'facility' => LOG_USER),
125         'queue' =>
126         array('enabled' => false,
127               'subsystem' => 'db', # default to database, or 'stomp'
128               'stomp_server' => null,
129               'queue_basename' => 'laconica',
130               'stomp_username' => null,
131               'stomp_password' => null,
132               ),
133         'license' =>
134         array('url' => 'http://creativecommons.org/licenses/by/3.0/',
135               'title' => 'Creative Commons Attribution 3.0',
136               'image' => 'http://i.creativecommons.org/l/by/3.0/80x15.png'),
137         'mail' =>
138         array('backend' => 'mail',
139               'params' => null),
140         'nickname' =>
141         array('blacklist' => array(),
142               'featured' => array()),
143         'profile' =>
144         array('banned' => array(),
145               'biolimit' => null),
146         'avatar' =>
147         array('server' => null,
148               'dir' => INSTALLDIR . '/avatar/',
149               'path' => $_path . '/avatar/'),
150         'background' =>
151         array('server' => null,
152               'dir' => INSTALLDIR . '/background/',
153               'path' => $_path . '/background/'),
154         'public' =>
155         array('localonly' => true,
156               'blacklist' => array(),
157               'autosource' => array()),
158         'theme' =>
159         array('server' => null,
160               'dir' => null,
161               'path'=> null),
162         'throttle' =>
163         array('enabled' => false, // whether to throttle edits; false by default
164               'count' => 20, // number of allowed messages in timespan
165               'timespan' => 600), // timespan for throttling
166         'xmpp' =>
167         array('enabled' => false,
168               'server' => 'INVALID SERVER',
169               'port' => 5222,
170               'user' => 'update',
171               'encryption' => true,
172               'resource' => 'uniquename',
173               'password' => 'blahblahblah',
174               'host' => null, # only set if != server
175               'debug' => false, # print extra debug info
176               'public' => array()), # JIDs of users who want to receive the public stream
177         'invite' =>
178         array('enabled' => true),
179         'sphinx' =>
180         array('enabled' => false,
181               'server' => 'localhost',
182               'port' => 3312),
183         'tag' =>
184         array('dropoff' => 864000.0),
185         'popular' =>
186         array('dropoff' => 864000.0),
187         'daemon' =>
188         array('piddir' => '/var/run',
189               'user' => false,
190               'group' => false),
191         'emailpost' =>
192         array('enabled' => true),
193         'sms' =>
194         array('enabled' => true),
195         'twitter' =>
196         array('enabled' => true),
197         'twitterbridge' =>
198         array('enabled' => false),
199         'integration' =>
200         array('source' => 'Laconica', # source attribute for Twitter
201               'taguri' => $_server.',2009'), # base for tag URIs
202         'twitter' =>
203         array('consumer_key'    => null,
204               'consumer_secret' => null),
205         'memcached' =>
206         array('enabled' => false,
207               'server' => 'localhost',
208               'base' => null,
209               'port' => 11211),
210                 'ping' =>
211         array('notify' => array()),
212         'inboxes' =>
213         array('enabled' => true), # on by default for new sites
214         'newuser' =>
215         array('default' => null,
216               'welcome' => null),
217         'snapshot' =>
218         array('run' => 'web',
219               'frequency' => 10000,
220               'reporturl' => 'http://laconi.ca/stats/report'),
221         'attachments' =>
222         array('server' => null,
223               'dir' => INSTALLDIR . '/file/',
224               'path' => $_path . '/file/',
225               'supported' => array('image/png',
226                                    'image/jpeg',
227                                    'image/gif',
228                                    'image/svg+xml',
229                                    'audio/mpeg',
230                                    'audio/x-speex',
231                                    'application/ogg',
232                                    'application/pdf',
233                                    'application/vnd.oasis.opendocument.text',
234                                    'application/vnd.oasis.opendocument.text-template',
235                                    'application/vnd.oasis.opendocument.graphics',
236                                    'application/vnd.oasis.opendocument.graphics-template',
237                                    'application/vnd.oasis.opendocument.presentation',
238                                    'application/vnd.oasis.opendocument.presentation-template',
239                                    'application/vnd.oasis.opendocument.spreadsheet',
240                                    'application/vnd.oasis.opendocument.spreadsheet-template',
241                                    'application/vnd.oasis.opendocument.chart',
242                                    'application/vnd.oasis.opendocument.chart-template',
243                                    'application/vnd.oasis.opendocument.image',
244                                    'application/vnd.oasis.opendocument.image-template',
245                                    'application/vnd.oasis.opendocument.formula',
246                                    'application/vnd.oasis.opendocument.formula-template',
247                                    'application/vnd.oasis.opendocument.text-master',
248                                    'application/vnd.oasis.opendocument.text-web',
249                                    'application/x-zip',
250                                    'application/zip',
251                                    'text/plain',
252                                    'video/mpeg',
253                                    'video/mp4',
254                                    'video/quicktime',
255                                    'video/mpeg'),
256         'file_quota' => 5000000,
257         'user_quota' => 50000000,
258         'monthly_quota' => 15000000,
259         'uploads' => true,
260         'filecommand' => '/usr/bin/file',
261         ),
262         'group' =>
263         array('maxaliases' => 3,
264               'desclimit' => null),
265         'oohembed' => array('endpoint' => 'http://oohembed.com/oohembed/'),
266         'search' =>
267         array('type' => 'fulltext'),
268         'sessions' =>
269         array('handle' => false, // whether to handle sessions ourselves
270               'debug' => false), // debugging output for sessions
271         'design' =>
272         array('backgroundcolor' => null, // null -> 'use theme default'
273               'contentcolor' => null,
274               'sidebarcolor' => null,
275               'textcolor' => null,
276               'linkcolor' => null,
277               'backgroundimage' => null,
278               'disposition' => null),
279         'notice' =>
280         array('contentlimit' => null),
281         'message' =>
282         array('contentlimit' => null),
283         );
284
285 $config['db'] = &PEAR::getStaticProperty('DB_DataObject','options');
286
287 $config['db'] =
288   array('database' => 'YOU HAVE TO SET THIS IN config.php',
289         'schema_location' => INSTALLDIR . '/classes',
290         'class_location' => INSTALLDIR . '/classes',
291         'require_prefix' => 'classes/',
292         'class_prefix' => '',
293         'mirror' => null,
294         'utf8' => true,
295         'db_driver' => 'DB', # XXX: JanRain libs only work with DB
296         'quote_identifiers' => false,
297         'type' => 'mysql' );
298
299 // Backward compatibility
300
301 $config['site']['design'] =& $config['design'];
302
303 if (function_exists('date_default_timezone_set')) {
304     /* Work internally in UTC */
305     date_default_timezone_set('UTC');
306 }
307
308 function addPlugin($name, $attrs = null)
309 {
310     $name = ucfirst($name);
311     $pluginclass = "{$name}Plugin";
312
313     if (!class_exists($pluginclass)) {
314
315         $files = array("local/plugins/{$pluginclass}.php",
316                        "local/plugins/{$name}/{$pluginclass}.php",
317                        "local/{$pluginclass}.php",
318                        "local/{$name}/{$pluginclass}.php",
319                        "plugins/{$pluginclass}.php",
320                        "plugins/{$name}/{$pluginclass}.php");
321
322         foreach ($files as $file) {
323             $fullpath = INSTALLDIR.'/'.$file;
324             if (@file_exists($fullpath)) {
325                 include_once($fullpath);
326                 break;
327             }
328         }
329     }
330
331     $inst = new $pluginclass();
332
333     if (!empty($attrs)) {
334         foreach ($attrs as $aname => $avalue) {
335             $inst->$aname = $avalue;
336         }
337     }
338     return $inst;
339 }
340
341 // From most general to most specific:
342 // server-wide, then vhost-wide, then for a path,
343 // finally for a dir (usually only need one of the last two).
344
345 if (isset($conffile)) {
346     $_config_files = array($conffile);
347 } else {
348     $_config_files = array('/etc/laconica/laconica.php',
349                            '/etc/laconica/'.$_server.'.php');
350
351     if (strlen($_path) > 0) {
352         $_config_files[] = '/etc/laconica/'.$_server.'_'.$_path.'.php';
353     }
354
355     $_config_files[] = INSTALLDIR.'/config.php';
356 }
357
358 $_have_a_config = false;
359
360 foreach ($_config_files as $_config_file) {
361     if (@file_exists($_config_file)) {
362         include_once($_config_file);
363         $_have_a_config = true;
364     }
365 }
366
367 function _have_config()
368 {
369     global $_have_a_config;
370     return $_have_a_config;
371 }
372
373 // XXX: Throw a conniption if database not installed
374
375 // Fixup for laconica.ini
376
377 $_db_name = substr($config['db']['database'], strrpos($config['db']['database'], '/') + 1);
378
379 if ($_db_name != 'laconica' && !array_key_exists('ini_'.$_db_name, $config['db'])) {
380     $config['db']['ini_'.$_db_name] = INSTALLDIR.'/classes/laconica.ini';
381 }
382
383 function __autoload($cls)
384 {
385     if (file_exists(INSTALLDIR.'/classes/' . $cls . '.php')) {
386         require_once(INSTALLDIR.'/classes/' . $cls . '.php');
387     } else if (file_exists(INSTALLDIR.'/lib/' . strtolower($cls) . '.php')) {
388         require_once(INSTALLDIR.'/lib/' . strtolower($cls) . '.php');
389     } else if (mb_substr($cls, -6) == 'Action' &&
390                file_exists(INSTALLDIR.'/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php')) {
391         require_once(INSTALLDIR.'/actions/' . strtolower(mb_substr($cls, 0, -6)) . '.php');
392     } else if ($cls == 'OAuthRequest') {
393         require_once('OAuth.php');
394     } else {
395         Event::handle('Autoload', array(&$cls));
396     }
397 }
398
399 // XXX: how many of these could be auto-loaded on use?
400 // XXX: note that these files should not use config options
401 // at compile time since DB config options are not yet loaded.
402
403 require_once 'Validate.php';
404 require_once 'markdown.php';
405
406 require_once INSTALLDIR.'/lib/util.php';
407 require_once INSTALLDIR.'/lib/action.php';
408 require_once INSTALLDIR.'/lib/theme.php';
409 require_once INSTALLDIR.'/lib/mail.php';
410 require_once INSTALLDIR.'/lib/subs.php';
411 require_once INSTALLDIR.'/lib/Shorturl_api.php';
412 require_once INSTALLDIR.'/lib/twitter.php';
413
414 require_once INSTALLDIR.'/lib/clientexception.php';
415 require_once INSTALLDIR.'/lib/serverexception.php';
416
417 // Load settings from database; note we need autoload for this
418
419 Config::loadSettings();
420
421 // XXX: other formats here
422
423 define('NICKNAME_FMT', VALIDATE_NUM.VALIDATE_ALPHA_LOWER);
424
425 // Give plugins a chance to initialize in a fully-prepared environment
426
427 Event::handle('InitializePlugin');