inc/AWLUtilities.php.in

   1 <?php
   2 /**
   3 * Utility functions of a general nature which are used by
   4 * most AWL library classes.
   5 *
   6 * @package   awl
   7 * @subpackage   Utilities
   8 * @author    Andrew McMillan <andrew@mcmillan.net.nz>
   9 * @copyright Catalyst IT Ltd, Morphoss Ltd <http://www.morphoss.com/>
  10 * @license   http://www.gnu.org/licenses/lgpl-3.0.txt  GNU LGPL version 3 or later
  11 */
  12
  13 if ( !function_exists('dbg_error_log') ) {
  14   /**
  15   * Writes a debug message into the error log using printf syntax.  If the first
  16   * parameter is "ERROR" then the message will _always_ be logged.
  17   * Otherwise, the first parameter is a "component" name, and will only be logged
  18   * if $c->dbg["component"] is set to some non-null value.
  19   *
  20   * If you want to see every log message then $c->dbg["ALL"] can be set, to
  21   * override the debugging status of the individual components.
  22   *
  23   * @var string $component The component to identify itself, or "ERROR", or "LOG:component"
  24   * @var string $format A format string for the log message
  25   * @var [string $parameter ...] Parameters for the format string.
  26   */
  27   function dbg_error_log() {
  28     global $c;
  29     $args = func_get_args();
  30     $type = "DBG";
  31     $component = array_shift($args);
  32     if ( substr( $component, 0, 3) == "LOG" ) {
  33       // Special escape case for stuff that always gets logged.
  34       $type = 'LOG';
  35       $component = substr($component,4);
  36     }
  37     else if ( $component == "ERROR" ) {
  38       $type = "***";
  39     }
  40     else if ( isset($c->dbg["ALL"]) ) {
  41       $type = "ALL";
  42     }
  43     else if ( !isset($c->dbg[strtolower($component)]) ) return;
  44
  45     $argc = func_num_args();
  46     if ( 2 <= $argc ) {
  47       $format = array_shift($args);
  48     }
  49     else {
  50       $format = "%s";
  51     }
  52     @error_log( $c->sysabbr.": $type: $component:". vsprintf( $format, $args ) );
  53   }
  54 }
  55
  56
  57 if ( !function_exists('fatal') ) {
  58   function fatal() {
  59     global $c;
  60     $args = func_get_args();
  61     $argc = func_num_args();
  62     if ( 2 <= $argc ) {
  63       $format = array_shift($args);
  64     }
  65     else {
  66       $format = "%s";
  67     }
  68     @error_log( $c->sysabbr.": FATAL: $component:". vsprintf( $format, $args ) );
  69
  70     @error_log( "================= Stack Trace ===================" );
  71
  72         $trace = array_reverse(debug_backtrace());
  73     array_pop($trace);
  74     foreach( $trace AS $k => $v ) {
  75           @error_log( sprintf(" ===>  %s[%d] calls %s%s%s()",
  76                        $v['file'],
  77                        $v['line'],
  78                        (isset($v['class'])?$v['class']:''),
  79                        (isset($v['type'])?$v['type']:''),
  80                        (isset($v['function'])?$v['function']:'')
  81               ));
  82     }
  83     echo "Fatal Error";
  84     exit();
  85   }
  86 }
  87
  88
  89 if ( !function_exists('apache_request_headers') ) {
  90   /**
  91   * Compatibility so we can use the apache function name and still work with CGI
  92   * @package awl
  93   */
  94   eval('
  95     function apache_request_headers() {
  96         foreach($_SERVER as $key=>$value) {
  97             if (substr($key,0,5)=="HTTP_") {
  98                 $key=str_replace(" ","-",ucwords(strtolower(str_replace("_"," ",substr($key,5)))));
  99                 $out[$key]=$value;
 100             }
 101         }
 102         return $out;
 103     }
 104   ');
 105 }
 106
 107
 108
 109 if ( !function_exists('dbg_log_array') ) {
 110   /**
 111   * Function to dump an array to the error log, possibly recursively
 112   *
 113   * @var string $component Which component should this log message identify itself from
 114   * @var string $name What name should this array dump identify itself as
 115   * @var array $arr The array to be dumped.
 116   * @var boolean $recursive Should the dump recurse into arrays/objects in the array
 117   */
 118   function dbg_log_array( $component, $name, $arr, $recursive = false ) {
 119     if ( !isset($arr) || (gettype($arr) != 'array' && gettype($arr) != 'object') ) {
 120       dbg_error_log( $component, "%s: array is not set, or is not an array!", $name);
 121       return;
 122     }
 123     foreach ($arr as $key => $value) {
 124       dbg_error_log( $component, "%s: >>%s<< = >>%s<<", $name, $key,
 125                       (gettype($value) == 'array' || gettype($value) == 'object' ? gettype($value) : $value) );
 126       if ( $recursive && (gettype($value) == 'array' || (gettype($value) == 'object' && "$key" != 'self' && "$key" != 'parent') ) ) {
 127         dbg_log_array( $component, "$name"."[$key]", $value, $recursive );
 128       }
 129     }
 130   }
 131 }
 132
 133
 134
 135 if ( !function_exists("session_simple_md5") ) {
 136   /**
 137   * Make a plain MD5 hash of a string, identifying the type of hash it is
 138   *
 139   * @param string $instr The string to be salted and MD5'd
 140   * @return string The *MD5* and the MD5 of the string
 141   */
 142   function session_simple_md5( $instr ) {
 143     global $c;
 144     if ( isset($c->dbg['password']) ) dbg_error_log( "Login", "Making plain MD5: instr=$instr, md5($instr)=".md5($instr) );
 145     return ( '*MD5*'. md5($instr) );
 146   }
 147 }
 148
 149
 150
 151 if ( !function_exists("session_salted_md5") ) {
 152   /**
 153   * Make a salted MD5 string, given a string and (possibly) a salt.
 154   *
 155   * If no salt is supplied we will generate a random one.
 156   *
 157   * @param string $instr The string to be salted and MD5'd
 158   * @param string $salt Some salt to sprinkle into the string to be MD5'd so we don't get the same PW always hashing to the same value.
 159   * @return string The salt, a * and the MD5 of the salted string, as in SALT*SALTEDHASH
 160   */
 161   function session_salted_md5( $instr, $salt = "" ) {
 162     if ( $salt == "" ) $salt = substr( md5(rand(100000,999999)), 2, 8);
 163     global $c;
 164     if ( isset($c->dbg['password']) ) dbg_error_log( "Login", "Making salted MD5: salt=$salt, instr=$instr, md5($salt$instr)=".md5($salt . $instr) );
 165     return ( sprintf("*%s*%s", $salt, md5($salt . $instr) ) );
 166   }
 167 }
 168
 169
 170
 171 if ( !function_exists("session_salted_sha1") ) {
 172   /**
 173   * Make a salted SHA1 string, given a string and (possibly) a salt.  PHP5 only (although it
 174   * could be made to work on PHP4 (@see http://www.openldap.org/faq/data/cache/347.html). The
 175   * algorithm used here is compatible with OpenLDAP so passwords generated through this function
 176   * should be able to be migrated to OpenLDAP by using the part following the second '*', i.e.
 177   * the '{SSHA}....' part.
 178   *
 179   * If no salt is supplied we will generate a random one.
 180   *
 181   * @param string $instr The string to be salted and SHA1'd
 182   * @param string $salt Some salt to sprinkle into the string to be SHA1'd so we don't get the same PW always hashing to the same value.
 183   * @return string A *, the salt, a * and the SHA1 of the salted string, as in *SALT*SALTEDHASH
 184   */
 185   function session_salted_sha1( $instr, $salt = "" ) {
 186     if ( $salt == "" ) $salt = substr( str_replace('*','',base64_encode(sha1(rand(100000,9999999),true))), 2, 9);
 187     global $c;
 188     if ( isset($c->dbg['password']) ) dbg_error_log( "Login", "Making salted SHA1: salt=$salt, instr=$instr, encoded($instr$salt)=".base64_encode(sha1($instr . $salt, true).$salt) );
 189     return ( sprintf("*%s*{SSHA}%s", $salt, base64_encode(sha1($instr.$salt, true) . $salt ) ) );
 190   }
 191 }
 192
 193
 194 if ( !function_exists("session_validate_password") ) {
 195   /**
 196   * Checks what a user entered against the actual password on their account.
 197   * @param string $they_sent What the user entered.
 198   * @param string $we_have What we have in the database as their password.  Which may (or may not) be a salted MD5.
 199   * @return boolean Whether or not the users attempt matches what is already on file.
 200   */
 201   function session_validate_password( $they_sent, $we_have ) {
 202     if ( preg_match('/^\*\*.+$/', $we_have ) ) {
 203       //  The "forced" style of "**plaintext" to allow easier admin setting
 204       return ( "**$they_sent" == $we_have );
 205     }
 206
 207     if ( preg_match('/^\*(.+)\*{[A-Z]+}.+$/', $we_have, $regs ) ) {
 208       if ( function_exists("session_salted_sha1") ) {
 209         // A nicely salted sha1sum like "*<salt>*{SSHA}<salted_sha1>"
 210         $salt = $regs[1];
 211         $sha1_sent = session_salted_sha1( $they_sent, $salt ) ;
 212         return ( $sha1_sent == $we_have );
 213       }
 214       else {
 215         dbg_error_log( "ERROR", "Password is salted SHA-1 but you are using PHP4!" );
 216         echo <<<EOERRMSG
 217 <html>
 218 <head>
 219 <title>Salted SHA1 Password format not supported with PHP4</title>
 220 </head>
 221 <body>
 222 <h1>Salted SHA1 Password format not supported with PHP4</h1>
 223 <p>At some point you have used PHP5 to set the password for this user and now you are
 224    using PHP4.  You will need to assign a new password to this user using PHP4, or ensure
 225    you use PHP5 everywhere (recommended).</p>
 226 <p>AWL has now switched to using salted SHA-1 passwords by preference in a format
 227    compatible with OpenLDAP.</p>
 228 </body>
 229 </html>
 230 EOERRMSG;
 231         exit;
 232       }
 233     }
 234
 235     if ( preg_match('/^\*MD5\*.+$/', $we_have, $regs ) ) {
 236       // A crappy unsalted md5sum like "*MD5*<md5>"
 237       $md5_sent = session_simple_md5( $they_sent ) ;
 238       return ( $md5_sent == $we_have );
 239     }
 240     else if ( preg_match('/^\*(.+)\*.+$/', $we_have, $regs ) ) {
 241       // A nicely salted md5sum like "*<salt>*<salted_md5>"
 242       $salt = $regs[1];
 243       $md5_sent = session_salted_md5( $they_sent, $salt ) ;
 244       return ( $md5_sent == $we_have );
 245     }
 246
 247     // Anything else is bad
 248     return false;
 249
 250   }
 251 }
 252
 253
 254
 255 if ( !function_exists("replace_uri_params") ) {
 256   /**
 257   * Given a URL (presumably the current one) and a parameter, replace the value of parameter,
 258   * extending the URL as necessary if the parameter is not already there.
 259   * @param string $uri The URI we will be replacing parameters in.
 260   * @param array $replacements An array of replacement pairs array( "replace_this" => "with this" )
 261   * @return string The URI with the replacements done.
 262   */
 263   function replace_uri_params( $uri, $replacements ) {
 264     $replaced = $uri;
 265     foreach( $replacements AS $param => $new_value ) {
 266       $rxp = preg_replace( '/([\[\]])/', '\\\\$1', $param );  // Some parameters may be arrays.
 267       $regex = "/([&?])($rxp)=([^&]+)/";
 268       dbg_error_log("core", "Looking for [%s] to replace with [%s] regex is %s and searching [%s]", $param, $new_value, $regex, $replaced );
 269       if ( preg_match( $regex, $replaced ) )
 270         $replaced = preg_replace( $regex, "\$1$param=$new_value", $replaced);
 271       else
 272         $replaced .= "&$param=$new_value";
 273     }
 274     if ( ! preg_match( '/\?/', $replaced  ) ) {
 275       $replaced = preg_replace("/&(.+)$/", "?\$1", $replaced);
 276     }
 277     $replaced = str_replace("&amp;", "--AmPeRsAnD--", $replaced);
 278     $replaced = str_replace("&", "&amp;", $replaced);
 279     $replaced = str_replace("--AmPeRsAnD--", "&amp;", $replaced);
 280     dbg_error_log("core", "URI <<$uri>> morphed to <<$replaced>>");
 281     return $replaced;
 282   }
 283 }
 284
 285
 286 if ( !function_exists("uuid") ) {
 287 /**
 288  * Generates a Universally Unique IDentifier, version 4.
 289  *
 290  * RFC 4122 (http://www.ietf.org/rfc/rfc4122.txt) defines a special type of Globally
 291  * Unique IDentifiers (GUID), as well as several methods for producing them. One
 292  * such method, described in section 4.4, is based on truly random or pseudo-random
 293  * number generators, and is therefore implementable in a language like PHP.
 294  *
 295  * We choose to produce pseudo-random numbers with the Mersenne Twister, and to always
 296  * limit single generated numbers to 16 bits (ie. the decimal value 65535). That is
 297  * because, even on 32-bit systems, PHP's RAND_MAX will often be the maximum *signed*
 298  * value, with only the equivalent of 31 significant bits. Producing two 16-bit random
 299  * numbers to make up a 32-bit one is less efficient, but guarantees that all 32 bits
 300  * are random.
 301  *
 302  * The algorithm for version 4 UUIDs (ie. those based on random number generators)
 303  * states that all 128 bits separated into the various fields (32 bits, 16 bits, 16 bits,
 304  * 8 bits and 8 bits, 48 bits) should be random, except : (a) the version number should
 305  * be the last 4 bits in the 3rd field, and (b) bits 6 and 7 of the 4th field should
 306  * be 01. We try to conform to that definition as efficiently as possible, generating
 307  * smaller values where possible, and minimizing the number of base conversions.
 308  *
 309  * @copyright  Copyright (c) CFD Labs, 2006. This function may be used freely for
 310  *              any purpose ; it is distributed without any form of warranty whatsoever.
 311  * @author      David Holmes <dholmes@cfdsoftware.net>
 312  *
 313  * @return  string  A UUID, made up of 32 hex digits and 4 hyphens.
 314  */
 315
 316   function uuid() {
 317
 318     // The field names refer to RFC 4122 section 4.1.2
 319
 320     return sprintf('%04x%04x-%04x-%03x4-%04x-%04x%04x%04x',
 321         mt_rand(0, 65535), mt_rand(0, 65535), // 32 bits for "time_low"
 322         mt_rand(0, 65535), // 16 bits for "time_mid"
 323         mt_rand(0, 4095),  // 12 bits before the 0100 of (version) 4 for "time_hi_and_version"
 324         bindec(substr_replace(sprintf('%016b', mt_rand(0, 65535)), '01', 6, 2)),
 325             // 8 bits, the last two of which (positions 6 and 7) are 01, for "clk_seq_hi_res"
 326             // (hence, the 2nd hex digit after the 3rd hyphen can only be 1, 5, 9 or d)
 327             // 8 bits for "clk_seq_low"
 328         mt_rand(0, 65535), mt_rand(0, 65535), mt_rand(0, 65535) // 48 bits for "node"
 329     );
 330   }
 331 }
 332
 333 if ( !function_exists("translate") ) {
 334   require("Translation.php");
 335 }
 336
 337  if ( !function_exists("clone") && version_compare(phpversion(), '5.0') < 0) {
 338   /**
 339   * PHP5 screws with the assignment operator changing so that $a = $b means that
 340   * $a becomes a reference to $b.  There is a clone() that we can use in PHP5, so
 341   * we have to emulate that for PHP4.  Bleargh.
 342   */
 343   eval( 'function clone($object) { return $object; }' );
 344 }
 345
 346 if ( !function_exists("quoted_printable_encode") ) {
 347   /**
 348   * Process a string to fit the requirements of RFC2045 section 6.7.  Note that
 349   * this works, but replaces more characters than the minimum set. For readability
 350   * the spaces aren't encoded as =20 though.
 351   */
 352   function quoted_printable_encode($string) {
 353     return preg_replace('/[^\r\n]{73}[^=\r\n]{2}/', "$0=\r\n", str_replace("%","=",str_replace("%20"," ",rawurlencode($string))));
 354   }
 355 }
 356
 357
 358 if ( !function_exists("check_by_regex") ) {
 359   /**
 360   * Verify a value is OK by testing a regex against it.  If it is an array apply it to
 361   * each element in the array recursively.  If it is an object we don't mess
 362   * with it.
 363   */
 364   function check_by_regex( $val, $regex ) {
 365     if ( is_null($val) ) return null;
 366     switch( $regex ) {
 367       case 'int':     $regex = '#^\d+$#';     break;
 368     }
 369     if ( is_array($val) ) {
 370       foreach( $val AS $k => $v ) {
 371         $val[$k] = check_by_regex($v,$regex);
 372       }
 373     }
 374     else if ( ! is_object($val) ) {
 375       if ( preg_match( $regex, $val, $matches) ) {
 376         $val = $matches[0];
 377       }
 378       else {
 379         $val = '';
 380       }
 381     }
 382     return $val;
 383   }
 384 }
 385
 386
 387 if ( !function_exists("param_to_global") ) {
 388   /**
 389   * Convert a parameter to a global.  We first look in _POST and then in _GET,
 390   * and if they passed in a bunch of valid characters, we will make sure the
 391   * incoming is cleaned to only match that set.
 392   *
 393   * @param string $varname The name of the global variable to put the answer in
 394   * @param string $match_regex The part of the parameter matching this regex will be returned
 395   * @param string $alias1  An alias for the name that we should look for first.
 396   * @param    "    ...     More aliases, in the order which they should be examined.  $varname will be appended to the end.
 397   */
 398   function param_to_global( ) {
 399     $args = func_get_args();
 400
 401     $varname = array_shift($args);
 402     $GLOBALS[$varname] = null;
 403
 404     $match_regex = null;
 405     $argc = func_num_args();
 406     if ( $argc > 1 ) {
 407       $match_regex = array_shift($args);
 408     }
 409
 410     $args[] = $varname;
 411     foreach( $args AS $k => $name ) {
 412       if ( isset($_POST[$name]) ) {
 413         $result = $_POST[$name];
 414         break;
 415       }
 416       else if ( isset($_GET[$name]) ) {
 417         $result = $_GET[$name];
 418         break;
 419       }
 420     }
 421     if ( !isset($result) ) return null;
 422
 423     if ( isset($match_regex) ) {
 424       $result = check_by_regex( $result, $match_regex );
 425     }
 426
 427     $GLOBALS[$varname] = $result;
 428     return $result;
 429   }
 430 }
 431
 432
 433 if ( !function_exists("get_fields") ) {
 434   /**
 435   * @var array $_AWL_field_cache is a cache of the field names for a table
 436   */
 437   $_AWL_field_cache = array();
 438
 439   /**
 440   * Get the names of the fields for a particular table
 441   * @param string $tablename The name of the table.
 442   * @return array of string The public fields in the table.
 443   */
 444   function get_fields( $tablename ) {
 445     global $_AWL_field_cache;
 446
 447     if ( !isset($_AWL_field_cache[$tablename]) ) {
 448       dbg_error_log( "core", ":get_fields: Loading fields for table '$tablename'" );
 449       $qry = new AwlQuery();
 450       $db = $qry->GetConnection();
 451       $qry->SetSQL($db->GetFields($tablename));
 452       $qry->Exec("core");
 453       $fields = array();
 454       while( $row = $qry->Fetch() ) {
 455         $fields[$row->fieldname] = $row->typename . ($row->precision >= 0 ? sprintf('(%d)',$row->precision) : '');
 456       }
 457       $_AWL_field_cache[$tablename] = $fields;
 458     }
 459     return $_AWL_field_cache[$tablename];
 460   }
 461 }
 462
 463
 464 if ( !function_exists("force_utf8") ) {
 465   function define_byte_mappings() {
 466     global $byte_map, $nibble_good_chars;
 467
 468     # Needed for using Grant McLean's byte mappings code
 469     $ascii_char = '[\x00-\x7F]';
 470     $cont_byte  = '[\x80-\xBF]';
 471
 472     $utf8_2     = '[\xC0-\xDF]' . $cont_byte;
 473     $utf8_3     = '[\xE0-\xEF]' . $cont_byte . '{2}';
 474     $utf8_4     = '[\xF0-\xF7]' . $cont_byte . '{3}';
 475     $utf8_5     = '[\xF8-\xFB]' . $cont_byte . '{4}';
 476
 477     $nibble_good_chars = "/^($ascii_char+|$utf8_2|$utf8_3|$utf8_4|$utf8_5)(.*)$/s";
 478
 479     # From http://unicode.org/Public/MAPPINGS/VENDORS/MICSFT/WINDOWS/CP1252.TXT
 480     $byte_map = array(
 481         "\x80" => "\xE2\x82\xAC",  # EURO SIGN
 482         "\x82" => "\xE2\x80\x9A",  # SINGLE LOW-9 QUOTATION MARK
 483         "\x83" => "\xC6\x92",      # LATIN SMALL LETTER F WITH HOOK
 484         "\x84" => "\xE2\x80\x9E",  # DOUBLE LOW-9 QUOTATION MARK
 485         "\x85" => "\xE2\x80\xA6",  # HORIZONTAL ELLIPSIS
 486         "\x86" => "\xE2\x80\xA0",  # DAGGER
 487         "\x87" => "\xE2\x80\xA1",  # DOUBLE DAGGER
 488         "\x88" => "\xCB\x86",      # MODIFIER LETTER CIRCUMFLEX ACCENT
 489         "\x89" => "\xE2\x80\xB0",  # PER MILLE SIGN
 490         "\x8A" => "\xC5\xA0",      # LATIN CAPITAL LETTER S WITH CARON
 491         "\x8B" => "\xE2\x80\xB9",  # SINGLE LEFT-POINTING ANGLE QUOTATION MARK
 492         "\x8C" => "\xC5\x92",      # LATIN CAPITAL LIGATURE OE
 493         "\x8E" => "\xC5\xBD",      # LATIN CAPITAL LETTER Z WITH CARON
 494         "\x91" => "\xE2\x80\x98",  # LEFT SINGLE QUOTATION MARK
 495         "\x92" => "\xE2\x80\x99",  # RIGHT SINGLE QUOTATION MARK
 496         "\x93" => "\xE2\x80\x9C",  # LEFT DOUBLE QUOTATION MARK
 497         "\x94" => "\xE2\x80\x9D",  # RIGHT DOUBLE QUOTATION MARK
 498         "\x95" => "\xE2\x80\xA2",  # BULLET
 499         "\x96" => "\xE2\x80\x93",  # EN DASH
 500         "\x97" => "\xE2\x80\x94",  # EM DASH
 501         "\x98" => "\xCB\x9C",      # SMALL TILDE
 502         "\x99" => "\xE2\x84\xA2",  # TRADE MARK SIGN
 503         "\x9A" => "\xC5\xA1",      # LATIN SMALL LETTER S WITH CARON
 504         "\x9B" => "\xE2\x80\xBA",  # SINGLE RIGHT-POINTING ANGLE QUOTATION MARK
 505         "\x9C" => "\xC5\x93",      # LATIN SMALL LIGATURE OE
 506         "\x9E" => "\xC5\xBE",      # LATIN SMALL LETTER Z WITH CARON
 507         "\x9F" => "\xC5\xB8",      # LATIN CAPITAL LETTER Y WITH DIAERESIS
 508     );
 509
 510     for( $i=160; $i < 256; $i++ ) {
 511       $ch = chr($i);
 512       $byte_map[$ch] = iconv('ISO-8859-1', 'UTF-8', $ch);
 513     }
 514   }
 515   define_byte_mappings();
 516
 517   function force_utf8( $input ) {
 518     global $byte_map, $nibble_good_chars;
 519
 520     $output = '';
 521     $char   = '';
 522     $rest   = '';
 523     while( $input != '' ) {
 524       if ( preg_match( $nibble_good_chars, $input, $matches ) ) {
 525         $output .= $matches[1];
 526         $rest = $matches[2];
 527       }
 528       else {
 529         preg_match( '/^(.)(.*)$/s', $input, $matches );
 530         $char = $matches[1];
 531         $rest = $matches[2];
 532         if ( isset($byte_map[$char]) ) {
 533           $output .= $byte_map[$char];
 534         }
 535         else {
 536           # Must be valid UTF8 already
 537           $output .= $char;
 538         }
 539       }
 540       $input = $rest;
 541     }
 542     return $output;
 543   }
 544
 545 }
 546
 547
 548 /**
 549 * Try and extract something like "Pacific/Auckland" or "America/Indiana/Indianapolis" if possible.
 550 */
 551 function olson_from_tzstring( $tzstring ) {
 552   global $c;
 553
 554   if ( function_exists('timezone_identifiers_list') && in_array($tzstring,timezone_identifiers_list()) ) return $tzstring;
 555   if ( preg_match( '{((Antarctica|America|Africa|Atlantic|Asia|Australia|Indian|Europe|Pacific)/(([^/]+)/)?[^/]+)$}', $tzstring, $matches ) ) {
 556 //    dbg_error_log( 'INFO', 'Found timezone "%s" from string "%s"', $matches[1], $tzstring );
 557     return $matches[1];
 558   }
 559   switch( $tzstring ) {
 560     case 'New Zealand Standard Time': case 'New Zealand Daylight Time':
 561          return 'Pacific/Auckland';
 562          break;
 563     case 'Central Standard Time':     case 'Central Daylight Time':     case 'US/Central':
 564          return 'America/Chicago';
 565          break;
 566     case 'Eastern Standard Time':     case 'Eastern Daylight Time':     case 'US/Eastern':
 567     case '(UTC-05:00) Eastern Time (US & Canada)':
 568          return 'America/New_York';
 569          break;
 570     case 'Pacific Standard Time':     case 'Pacific Daylight Time':     case 'US/Pacific':
 571          return 'America/Los_Angeles';
 572          break;
 573     case 'Mountain Standard Time':    case 'Mountain Daylight Time':    case 'US/Mountain':    case 'Mountain Time':
 574          return 'America/Denver';
 575          // The US 'Mountain Time' can in fact be America/(Denver|Boise|Phoenix|Shiprock) which
 576          // all vary to some extent due to differing DST rules.
 577          break;
 578     case '(GMT-07.00) Arizona':
 579          return 'America/Phoenix';
 580          break;
 581     default:
 582          if ( isset($c->timezone_translations) && is_array($c->timezone_translations)
 583                       && !empty($c->timezone_translations[$tzstring]) )
 584            return $c->timezone_translations[$tzstring];
 585   }
 586   return null;
 587 }
 588
 589 if ( !function_exists("deprecated") ) {
 590   function deprecated( $method ) {
 591     global $c;
 592     if ( isset($c->dbg['ALL']) || isset($c->dbg['deprecated']) ) {
 593       $stack = debug_backtrace();
 594       array_shift($stack);
 595       if ( preg_match( '{/inc/iCalendar.php$}', $stack[0]['file'] ) && $stack[0]['line'] > __LINE__ ) return;
 596       @error_log( sprintf( $c->sysabbr.':DEPRECATED: Call to deprecated method "%s"', $method));
 597       foreach( $stack AS $k => $v ) {
 598         @error_log( sprintf( $c->sysabbr.':  ==>  called from line %4d of %s', $v['line'], $v['file']));
 599       }
 600     }
 601   }
 602 }
 603
 604
 605 if ( !function_exists("gzdecode") ) {
 606   function gzdecode( $instring ) {
 607     global $c;
 608     if ( !isset($c->use_pipe_gunzip) || $c->use_pipe_gunzip ) {
 609       $descriptorspec = array(
 610          0 => array("pipe", "r"),  // stdin is a pipe that the child will read from
 611          1 => array("pipe", "w"),  // stdout is a pipe that the child will write to
 612          2 => array("file", "/dev/null", "a") // stderr is discarded
 613       );
 614       $process = proc_open('gunzip',$descriptorspec, $pipes);
 615       if ( is_resource($process) ) {
 616         fwrite($pipes[0],$instring);
 617         fclose($pipes[0]);
 618
 619         $outstring = stream_get_contents($pipes[1]);
 620         fclose($pipes[1]);
 621
 622         proc_close($process);
 623         return $outstring;
 624       }
 625       return '';
 626     }
 627     else {
 628       $g=tempnam('./','gz');
 629       file_put_contents($g,$instring);
 630       ob_start();
 631       readgzfile($g);
 632       $d=ob_get_clean();
 633       unlink($g);
 634       return $d;
 635     }
 636   }
 637 }
 638
 639 /**
 640  * Return the AWL version
 641  */
 642 function awl_version() {
 643   global $c;
 644 $c->awl_library_version = 0.46;
 645   return $c->awl_library_version;
 646 }