Always default the timezone to something, even if the user did not.
[davical.git] / htdocs / always.php
blob5dec0ba1703d93c7f25a170c525a1b7811e2deee
1 <?php
2 /**
3 * @package davical
4 * @author Andrew McMillan <andrew@mcmillan.net.nz>
5 * @copyright Catalyst .Net Ltd, Morphoss Ltd <http://www.morphoss.com/>
6 * @license http://gnu.org/copyleft/gpl.html GNU GPL v2 or later
7 */
9 if ( preg_match('{/always.php$}', $_SERVER['SCRIPT_NAME'] ) ) header('Location: index.php');
11 // Ensure the configuration starts out as an empty object.
12 $c = (object) array();
13 $c->script_start_time = microtime(true);
15 // Ditto for a few other global things
16 unset($session); unset($request); unset($dbconn); unset($_awl_dbconn); unset($include_properties);
18 // An ultra-simple exception handler to catch errors that occur
19 // before we get a more functional exception handler in place...
20 function early_exception_handler($e) {
21 if ( !headers_sent() ) header("Content-type: text/plain"); else echo "<pre>\n";
22 while ( ob_get_level() > 0 ) ob_end_flush();
23 echo "Exception [".$e->getCode()."] ".$e->getmessage()."\n";
24 echo "At line ", $e->getLine(), " of ", $e->getFile(), "\n";
25 echo "================= Stack Trace ===================\n";
27 $trace = array_reverse($e->getTrace());
28 foreach( $trace AS $k => $v ) {
29 printf( "%s[%d] %s%s%s()\n", $v['file'], $v['line'], (isset($v['class'])?$v['class']:''), (isset($v['type'])?$v['type']:''), (isset($v['function'])?$v['function']:'') );
32 set_exception_handler('early_exception_handler');
34 $c->default_timezone = ini_get('date.timezone');
35 if ( empty($c->default_timezone) ) {
36 $c->default_timezone = 'UTC';
37 date_default_timezone_set('UTC');
40 // Default some of the configurable values
41 $c->sysabbr = 'davical';
42 $c->admin_email = 'admin@davical.example.com';
43 $c->system_name = 'DAViCal CalDAV Server';
44 $c->domain_name = (isset($_SERVER['SERVER_NAME'])?$_SERVER['SERVER_NAME']:$_SERVER['SERVER_ADDR']);
45 $c->save_time_zone_defs = true;
46 $c->collections_always_exist = false;
47 $c->allow_get_email_visibility = false;
48 $c->permission_scan_depth = 2;
49 $c->expand_pdo_parameters = true;
50 $c->home_calendar_name = 'calendar';
51 $c->home_addressbook_name = 'addresses';
52 $c->enable_row_linking = true;
53 $c->enable_scheduling = false;
54 $c->http_auth_mode = 'Basic';
55 // $c->default_locale = array('es_MX', 'es_AR', 'es', 'pt'); // An array of locales to try, or just a single locale
56 // $c->local_tzid = 'Pacific/Auckland'; // Perhaps we should read from /etc/timezone - I wonder how standard that is?
57 $c->default_locale = 'en';
58 $c->locale_path = '../locale';
59 $c->base_url = preg_replace('#/[^/]+\.php.*$#', '', $_SERVER['SCRIPT_NAME']);
60 $c->base_directory = preg_replace('#/[^/]*$#', '', $_SERVER['DOCUMENT_ROOT']);
61 $c->default_privileges = array('read-free-busy', 'schedule-deliver');
63 $c->enable_auto_schedule = true;
65 $c->schema_major = $c->schema_minor = $c->schema_patch = 0;
67 $c->stylesheets = array( $c->base_url.'/davical.css' );
68 $c->images = $c->base_url . '/images';
70 // Add a default for newly created users
71 $c->template_usr = array( 'active' => true,
72 'locale' => 'en_GB',
73 'date_format_type' => 'E',
74 'email_ok' => date('Y-m-d')
77 $c->hide_TODO = true; // VTODO only visible to collection owner
78 $c->readonly_webdav_collections = true; // WebDAV access is readonly
80 // Kind of private configuration values
81 $c->total_query_time = 0;
83 $c->dbg = array();
86 // Utilities
87 if ( ! @include_once('AWLUtilities.php') ) {
88 $try_paths = array(
89 '../../awl/inc'
90 , '/usr/share/awl/inc' // Where it ends up on Debian
91 , '/usr/share/php/awl/inc' // Fedora's standard for PHP libraries
92 , '/usr/local/share/awl/inc'
94 foreach( $try_paths AS $awl_include_path ) {
95 if ( @file_exists($awl_include_path.'/AWLUtilities.php') ) {
96 set_include_path( $awl_include_path. PATH_SEPARATOR. get_include_path());
97 break;
100 if ( ! @include_once('AWLUtilities.php') ) {
101 echo "Could not find the AWL libraries. Are they installed? Check your include_path in php.ini!\n";
102 @ob_flush(); exit(0);
106 // Ensure that ../inc is in our included paths as early as possible
107 set_include_path( '../inc'. PATH_SEPARATOR. get_include_path());
110 /** We actually discovered this and worked around it earlier, but we can't log it until the utilties are loaded */
111 if ( !isset($_SERVER['SERVER_NAME']) ) {
112 @dbg_error_log( 'WARN', "Your webserver is not setting the SERVER_NAME parameter. You may need to set \$c->domain_name in your configuration. Using IP address meanhwhile..." );
116 * Calculate the simplest form of reference to this page, excluding the PATH_INFO following the script name.
118 $c->protocol_server_port = sprintf( '%s://%s%s',
119 (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on'? 'https' : 'http'),
120 $_SERVER['SERVER_NAME'],
122 ( (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != 'on')
123 && (!isset($_SERVER['SERVER_PORT']) || $_SERVER['SERVER_PORT'] == 80) )
124 || (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on'
125 && (!isset($_SERVER['SERVER_PORT']) || $_SERVER['SERVER_PORT'] == 443) )
126 ? ''
127 : ':'.$_SERVER['SERVER_PORT']
128 ) );
129 $c->protocol_server_port_script = $c->protocol_server_port . ($_SERVER['SCRIPT_NAME'] == '/index.php' ? '' : $_SERVER['SCRIPT_NAME']);
133 * We use @file_exists because things like open_basedir might noisily deny
134 * access which could break DAViCal completely by causing output to start
135 * too early.
137 ob_start( );
138 if ( @file_exists('/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php') ) {
139 include('/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php');
141 else if ( @file_exists('/etc/davical/config.php') ) {
142 include('/etc/davical/config.php');
144 else if ( @file_exists('/usr/local/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php') ) {
145 include('/usr/local/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php');
147 else if ( @file_exists('/usr/local/etc/davical/config.php') ) {
148 include('/usr/local/etc/davical/config.php');
150 else if ( @file_exists('../config/config.php') ) {
151 include('../config/config.php');
153 else if ( @file_exists('config/config.php') ) {
154 include('config/config.php');
156 else {
157 include('davical_configuration_missing.php');
158 @ob_flush(); exit(0);
160 $config_warnings = trim(ob_get_contents());
161 ob_end_clean();
163 if ( !isset($c->page_title) ) $c->page_title = $c->system_name;
165 if ( isset($_SERVER['HTTP_X_DAVICAL_TESTCASE']) ) {
166 @dbg_error_log( 'LOG', '==========> Test case =%s=', $_SERVER['HTTP_X_DAVICAL_TESTCASE'] );
168 else if ( isset($c->dbg['script_start']) && $c->dbg['script_start'] ) {
169 // Only log this if more than a little debugging of some sort is turned on, somewhere
170 @dbg_error_log( 'LOG', '==========> method =%s= =%s= =%s= =%s= =%s=',
171 $_SERVER['REQUEST_METHOD'], $c->protocol_server_port_script, (isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '$_SERVER[PATH_INFO] undefined'), $c->base_url, $c->base_directory );
175 * Now that we have loaded the configuration file we can switch to a
176 * default site locale. This may be overridden by each user.
178 putenv("LANG=". $c->default_locale);
179 if ( function_exists('awl_set_locale') ) {
180 awl_set_locale($c->default_locale);
181 init_gettext( 'davical', $c->locale_path );
185 * Work out our version
188 $c->code_version = 0;
189 $c->want_awl_version = '0.51';
190 $c->version_string = '1.0.2'; // The actual version # is replaced into that during the build /release process
191 if ( isset($c->version_string) && preg_match( '/(\d+)\.(\d+)\.(\d+)(.*)/', $c->version_string, $matches) ) {
192 $c->code_major = $matches[1];
193 $c->code_minor = $matches[2];
194 $c->code_patch = $matches[3];
195 $c->code_version = (($c->code_major * 1000) + $c->code_minor).'.'.$c->code_patch;
196 dbg_error_log('caldav', 'Version (%d.%d.%d) == %s', $c->code_major, $c->code_minor, $c->code_patch, $c->code_version);
197 @header( sprintf('Server: %d.%d', $c->code_major, $c->code_minor) );
201 * Force the domain name to what was in the configuration file
203 $_SERVER['SERVER_NAME'] = $c->domain_name;
205 require_once('AwlQuery.php');
207 $c->want_dbversion = array(1,2,11);
208 $c->schema_version = 0;
209 $qry = new AwlQuery( 'SELECT schema_major, schema_minor, schema_patch FROM awl_db_revision ORDER BY schema_id DESC LIMIT 1;' );
210 if ( $qry->Exec('always',__LINE__,__FILE__) && $row = $qry->Fetch() ) {
211 $c->schema_version = doubleval( sprintf( '%d%03d.%03d', $row->schema_major, $row->schema_minor, $row->schema_patch) );
212 $c->wanted_version = doubleval( sprintf( '%d%03d.%03d', $c->want_dbversion[0], $c->want_dbversion[1], $c->want_dbversion[2]) );
213 $c->schema_major = $row->schema_major;
214 $c->schema_minor = $row->schema_minor;
215 $c->schema_patch = $row->schema_patch;
216 if ( $c->schema_version < $c->wanted_version ) {
217 $c->messages[] = sprintf( 'Database schema needs upgrading. Current: %d.%d.%d, Desired: %d.%d.%d',
218 $row->schema_major, $row->schema_minor, $row->schema_patch, $c->want_dbversion[0], $c->want_dbversion[1], $c->want_dbversion[2]);
220 if ( isset($_SERVER['HTTP_X_DAVICAL_TESTCASE']) ) $qry->QDo('SET TIMEZONE TO \'Pacific/Auckland\'');
223 require_once('Principal.php');
226 * Return the HTTP status code description for a given code. Hopefully
227 * this is an efficient way to code this.
228 * @return string The text for a give HTTP status code, in english
230 function getStatusMessage($status) {
231 switch( $status ) {
232 case 100: $ans = 'Continue'; break;
233 case 101: $ans = 'Switching Protocols'; break;
234 case 200: $ans = 'OK'; break;
235 case 201: $ans = 'Created'; break;
236 case 202: $ans = 'Accepted'; break;
237 case 203: $ans = 'Non-Authoritative Information'; break;
238 case 204: $ans = 'No Content'; break;
239 case 205: $ans = 'Reset Content'; break;
240 case 206: $ans = 'Partial Content'; break;
241 case 207: $ans = 'Multi-Status'; break;
242 case 300: $ans = 'Multiple Choices'; break;
243 case 301: $ans = 'Moved Permanently'; break;
244 case 302: $ans = 'Found'; break;
245 case 303: $ans = 'See Other'; break;
246 case 304: $ans = 'Not Modified'; break;
247 case 305: $ans = 'Use Proxy'; break;
248 case 307: $ans = 'Temporary Redirect'; break;
249 case 400: $ans = 'Bad Request'; break;
250 case 401: $ans = 'Unauthorized'; break;
251 case 402: $ans = 'Payment Required'; break;
252 case 403: $ans = 'Forbidden'; break;
253 case 404: $ans = 'Not Found'; break;
254 case 405: $ans = 'Method Not Allowed'; break;
255 case 406: $ans = 'Not Acceptable'; break;
256 case 407: $ans = 'Proxy Authentication Required'; break;
257 case 408: $ans = 'Request Timeout'; break;
258 case 409: $ans = 'Conflict'; break;
259 case 410: $ans = 'Gone'; break;
260 case 411: $ans = 'Length Required'; break;
261 case 412: $ans = 'Precondition Failed'; break;
262 case 413: $ans = 'Request Entity Too Large'; break;
263 case 414: $ans = 'Request-URI Too Long'; break;
264 case 415: $ans = 'Unsupported Media Type'; break;
265 case 416: $ans = 'Requested Range Not Satisfiable'; break;
266 case 417: $ans = 'Expectation Failed'; break;
267 case 422: $ans = 'Unprocessable Entity'; break;
268 case 423: $ans = 'Locked'; break;
269 case 424: $ans = 'Failed Dependency'; break;
270 case 500: $ans = 'Internal Server Error'; break;
271 case 501: $ans = 'Not Implemented'; break;
272 case 502: $ans = 'Bad Gateway'; break;
273 case 503: $ans = 'Service Unavailable'; break;
274 case 504: $ans = 'Gateway Timeout'; break;
275 case 505: $ans = 'HTTP Version Not Supported'; break;
276 default: $ans = 'Unknown HTTP Status Code '.$status;
278 return $ans;
283 * Construct a URL from the supplied dav_name. The URL will be urlencoded,
284 * except for any '/' characters in it.
285 * @param string $partial_path The part of the path after the script name
287 function ConstructURL( $partial_path, $force_script = false ) {
288 global $c;
290 $partial_path = rawurlencode($partial_path);
291 $partial_path = str_replace( '%2F', '/', $partial_path);
293 if ( ! isset($c->_url_script_path) ) {
294 $c->protocol_server_port_script = str_replace( 'index.php', 'caldav.php', $c->protocol_server_port_script);
295 $c->_url_script_path = (preg_match('#/$#', $c->protocol_server_port_script) ? 'caldav.php' : '');
296 $c->_url_script_path = $c->protocol_server_port_script . $c->_url_script_path;
299 $url = $c->_url_script_path;
300 if ( $force_script ) {
301 if ( ! preg_match( '#/caldav\.php$#', $url ) ) $url .= '/caldav.php';
303 $url .= $partial_path;
304 $url = preg_replace( '#^(https?://.+)//#', '$1/', $url ); // Ensure we don't double any '/'
305 $url = preg_replace('#^https?://[^/]+#', '', $url ); // Remove any protocol + hostname portion
307 return $url;
312 * Deconstruct a dav_name from the supplied URL. The dav_name will be urldecoded.
314 * @param string $partial_path The part of the path after the script name
316 function DeconstructURL( $url, $force_script = false ) {
317 global $c;
319 $dav_name = rawurldecode($url);
321 /** Allow a path like .../username/calendar.ics to translate into the calendar URL */
322 if ( preg_match( '#^(/[^/]+/[^/]+).ics$#', $dav_name, $matches ) ) {
323 $dav_name = $matches[1]. '/';
326 /** remove any leading protocol/server/port/prefix... */
327 if ( !isset($c->deconstruction_base_path) ) $c->deconstruction_base_path = ConstructURL('/');
328 if ( preg_match( '%^(.*?)'.str_replace('%', '\\%',$c->deconstruction_base_path).'(.*)$%', $dav_name, $matches ) ) {
329 if ( $matches[1] == '' || $matches[1] == $c->protocol_server_port ) {
330 $dav_name = $matches[2];
334 /** strip doubled slashes */
335 if ( strstr($dav_name,'//') ) $dav_name = preg_replace( '#//+#', '/', $dav_name);
337 if ( substr($dav_name,0,1) != '/' ) $dav_name = '/'.$dav_name;
339 return $dav_name;
344 * Convert a date from ISO format into the sad old HTTP format.
345 * @param string $isodate The date to convert
347 function ISODateToHTTPDate( $isodate ) {
348 // It is necessary to use English for this, explicitly. See Debian BTS Bug#661985 for more info.
349 $month = gmstrftime('%m', strtotime($isodate));
350 switch( intval($month) ) {
351 case 1: $month = 'Jan'; break;
352 case 2: $month = 'Feb'; break;
353 case 3: $month = 'Mar'; break;
354 case 4: $month = 'Apr'; break;
355 case 5: $month = 'May'; break;
356 case 6: $month = 'Jun'; break;
357 case 7: $month = 'Jul'; break;
358 case 8: $month = 'Aug'; break;
359 case 9: $month = 'Sep'; break;
360 case 10: $month = 'Oct'; break;
361 case 11: $month = 'Nov'; break;
362 case 12: $month = 'Dec'; break;
363 default:
364 throw new Exception('Invalid month '.$month);
366 // Use strtotime since strptime is not available on Windows platform.
367 return( gmstrftime('%a, %d '.$month.' %Y %H:%M:%S GMT', strtotime($isodate)) );
371 * Convert a date into ISO format into the sparkly new ISO format.
372 * @param string $indate The date to convert
374 function DateToISODate( $indate, $in_utc=false ) {
375 // Use strtotime since strptime is not available on Windows platform.
376 if ( $in_utc ) return( gmdate('Ymd\THis\Z', strtotime($indate)) );
377 return( date('c', strtotime($indate)) );
381 * Given a privilege string, or an array of privilege strings, return a bit mask
382 * of the privileges.
383 * @param mixed $raw_privs The string (or array of strings) of privilege names
384 * @return integer A bit mask of the privileges.
386 define("DAVICAL_MAXPRIV", "65535");
387 define("DAVICAL_ADDRESSBOOK_MAXPRIV", "1023");
388 function privilege_to_bits( $raw_privs ) {
389 $out_priv = 0;
391 if ( gettype($raw_privs) == 'string' ) $raw_privs = array( $raw_privs );
393 if ( ! is_array($raw_privs) ) $raw_privs = array($raw_privs);
395 foreach( $raw_privs AS $priv ) {
396 $trim_priv = trim(strtolower(preg_replace( '/^.*:/', '', $priv)));
397 switch( $trim_priv ) {
398 case 'read' : $out_priv |= 1; break;
399 case 'write-properties' : $out_priv |= 2; break;
400 case 'write-content' : $out_priv |= 4; break;
401 case 'unlock' : $out_priv |= 8; break;
402 case 'read-acl' : $out_priv |= 16; break;
403 case 'read-current-user-privilege-set' : $out_priv |= 32; break;
404 case 'bind' : $out_priv |= 64; break;
405 case 'unbind' : $out_priv |= 128; break;
406 case 'write-acl' : $out_priv |= 256; break;
407 case 'read-free-busy' : $out_priv |= 512; break;
408 case 'schedule-deliver-invite' : $out_priv |= 1024; break;
409 case 'schedule-deliver-reply' : $out_priv |= 2048; break;
410 case 'schedule-query-freebusy' : $out_priv |= 4096; break;
411 case 'schedule-send-invite' : $out_priv |= 8192; break;
412 case 'schedule-send-reply' : $out_priv |= 16384; break;
413 case 'schedule-send-freebusy' : $out_priv |= 32768; break;
415 /** Aggregates of Privileges */
416 case 'write' : $out_priv |= 198; break; // 2 + 4 + 64 + 128
417 case 'schedule-deliver' : $out_priv |= 7168; break; // 1024 + 2048 + 4096
418 case 'schedule-send' : $out_priv |= 57344; break; // 8192 + 16384 + 32768
419 case 'all' : $out_priv = DAVICAL_MAXPRIV; break;
420 case 'fake_privilege_for_input' : break;
421 default:
422 dbg_error_log( 'ERROR', 'Cannot convert privilege of "%s" into bits.', $priv );
427 // 'all' will include future privileges
428 if ( ($out_priv & DAVICAL_MAXPRIV) >= DAVICAL_MAXPRIV ) $out_priv = pow(2,24) - 1;
429 return $out_priv;
434 * Given a bit mask of the privileges, will return an array of the
435 * text values of privileges.
436 * @param integer $raw_bits A bit mask of the privileges.
437 * @return mixed The string (or array of strings) of privilege names
439 function bits_to_privilege( $raw_bits, $resourcetype = 'resource' ) {
440 $out_priv = array();
442 if ( is_string($raw_bits) ) {
443 $raw_bits = bindec($raw_bits);
446 if ( ($raw_bits & DAVICAL_MAXPRIV) == DAVICAL_MAXPRIV ) $out_priv[] = 'all';
448 if ( ($raw_bits & 1) != 0 ) $out_priv[] = 'DAV::read';
449 if ( ($raw_bits & 8) != 0 ) $out_priv[] = 'DAV::unlock';
450 if ( ($raw_bits & 16) != 0 ) $out_priv[] = 'DAV::read-acl';
451 if ( ($raw_bits & 32) != 0 ) $out_priv[] = 'DAV::read-current-user-privilege-set';
452 if ( ($raw_bits & 256) != 0 ) $out_priv[] = 'DAV::write-acl';
453 if ( ($resourcetype == 'calendar' || $resourcetype == 'proxy' || $resourcetype == '*') && ($raw_bits & 512) != 0 ) $out_priv[] = 'urn:ietf:params:xml:ns:caldav:read-free-busy';
455 if ( ($raw_bits & 198) != 0 ) {
456 if ( ($raw_bits & 198) == 198 ) $out_priv[] = 'DAV::write';
457 if ( ($raw_bits & 2) != 0 ) $out_priv[] = 'DAV::write-properties';
458 if ( ($raw_bits & 4) != 0 ) $out_priv[] = 'DAV::write-content';
459 if ( ($raw_bits & 64) != 0 ) $out_priv[] = 'DAV::bind';
460 if ( ($raw_bits & 128) != 0 ) $out_priv[] = 'DAV::unbind';
463 if ( ($resourcetype == 'schedule-inbox' || $resourcetype == '*') && ($raw_bits & 7168) != 0 ) {
464 if ( ($raw_bits & 7168) == 7168 ) $out_priv[] = 'urn:ietf:params:xml:ns:caldav:schedule-deliver';
465 if ( ($raw_bits & 1024) != 0 ) $out_priv[] = 'urn:ietf:params:xml:ns:caldav:schedule-deliver-invite';
466 if ( ($raw_bits & 2048) != 0 ) $out_priv[] = 'urn:ietf:params:xml:ns:caldav:schedule-deliver-reply';
467 if ( ($raw_bits & 4096) != 0 ) $out_priv[] = 'urn:ietf:params:xml:ns:caldav:schedule-query-freebusy';
470 if ( ($resourcetype == 'schedule-outbox' || $resourcetype == '*') && ($raw_bits & 57344) != 0 ) {
471 if ( ($raw_bits & 57344) == 57344 ) $out_priv[] = 'urn:ietf:params:xml:ns:caldav:schedule-send';
472 if ( ($raw_bits & 8192) != 0 ) $out_priv[] = 'urn:ietf:params:xml:ns:caldav:schedule-send-invite';
473 if ( ($raw_bits & 16384) != 0 ) $out_priv[] = 'urn:ietf:params:xml:ns:caldav:schedule-send-reply';
474 if ( ($raw_bits & 32768) != 0 ) $out_priv[] = 'urn:ietf:params:xml:ns:caldav:schedule-send-freebusy';
477 // dbg_error_log( 'DAVResource', ' Privilege bit "%s" is "%s".', $raw_bits, implode(', ', $out_priv) );
479 return $out_priv;
484 * Returns the array of privilege names converted into XMLElements
486 function privileges_to_XML( $privilege_names, &$xmldoc=null ) {
487 if ( !isset($xmldoc) && isset($GLOBALS['reply']) ) $xmldoc = $GLOBALS['reply'];
488 $privileges = array();
489 foreach( $privilege_names AS $k ) {
490 $privilege = new XMLElement('privilege');
491 if ( isset($xmldoc) )
492 $xmldoc->NSElement($privilege,$k);
493 else
494 $privilege->NewElement($k);
495 $privileges[] = $privilege;
497 return $privileges;