WEB-INF/lib/common.lib.php

   1 <?php
   2 // +----------------------------------------------------------------------+
   3 // | Anuko Time Tracker
   4 // +----------------------------------------------------------------------+
   5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
   6 // +----------------------------------------------------------------------+
   7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
   8 // | by anyone for any purpose, and freely redistributed alone or in
   9 // | combination with other software, provided that the license is obeyed.
  10 // |
  11 // | There are only two ways to violate the license:
  12 // |
  13 // | 1. To redistribute this code in source form, with the copyright
  14 // |    notice or license removed or altered. (Distributing in compiled
  15 // |    forms without embedded copyright notices is permitted).
  16 // |
  17 // | 2. To redistribute modified versions of this code in *any* form
  18 // |    that bears insufficient indications that the modifications are
  19 // |    not the work of the original author(s).
  20 // |
  21 // | This license applies to this document only, not any other software
  22 // | that it may be combined with.
  23 // |
  24 // +----------------------------------------------------------------------+
  25 // | Contributors:
  26 // | https://www.anuko.com/time_tracker/credits.htm
  27 // +----------------------------------------------------------------------+
  28
  29 // import() function loads a class.
  30 function import($class_name) {
  31   $libs = array(
  32     dirname($_SERVER["SCRIPT_FILENAME"]),
  33     LIBRARY_DIR
  34   );
  35
  36             $pos = strpos($class_name, ".");
  37         if (!($pos === false)) {
  38             $peaces = explode(".", $class_name);
  39             $p = "";
  40             for ($i=0; $i<count($peaces)-1; $i++) {
  41                 $p = $p . "/" . $peaces[$i];
  42             }
  43                         $libs = array_merge(array(LIBRARY_DIR . $p),$libs);
  44             $class_name = $peaces[count($peaces)-1];
  45         }
  46
  47                 $filename = $class_name . '.class.php';
  48
  49                 foreach($libs as $lib) {
  50                         $inc_filename = $lib . '/' . $filename;
  51                         if (file_exists($inc_filename)) {
  52                                         require_once($inc_filename);
  53                                         return $class_name;
  54                         }
  55                 }
  56
  57                 print '<br><b>load_class: error loading file "'.$filename.'"</b>';
  58                 die();
  59 }
  60
  61         // The mu_sort function is used to sort a multi-dimensional array.
  62         // It looks like the code example is taken from the PHP manual http://ca2.php.net/manual/en/function.sort.php
  63         function mu_sort($array, $key_sort) {
  64                 $n = 0;
  65                 if (!is_array($array) || count($array)==0)
  66                         return array();
  67
  68                 $key_sorta = explode(",", $key_sort);
  69                 $keys = array_keys($array[0]);
  70
  71                 for($m=0; $m < count($key_sorta); $m++) {
  72                         $nkeys[$m] = trim($key_sorta[$m]);
  73                 }
  74                 $n += count($key_sorta);
  75
  76                 for($i=0; $i < count($keys); $i++) {
  77                         if(!in_array($keys[$i], $key_sorta)) {
  78                                 $nkeys[$n] = $keys[$i];
  79                                 $n += "1";
  80                         }
  81                 }
  82
  83                 for($u=0;$u<count($array); $u++) {
  84                         $arr = $array[$u];
  85                         for($s=0; $s<count($nkeys); $s++) {
  86                                 $k = $nkeys[$s];
  87                                 $output[$u][$k] = $array[$u][$k];
  88                         }
  89                 }
  90                 sort($output);
  91                 return $output;
  92         }
  93
  94         /**
  95          * return float type
  96          *
  97          * @param unknown $value
  98          * @return unknown
  99          */
 100         function toFloat($value) {
 101                 if (isset($value) && (strlen($value) > 0)) {
 102                         $value = str_replace(",",".",$value);
 103                         return floatval($value);
 104                 }
 105                 return null;
 106         }
 107
 108         function stripslashes_deep($value) {
 109             $value = is_array($value) ?
 110                 array_map('stripslashes_deep', $value) :
 111                 stripslashes($value);
 112         return $value;
 113         }
 114
 115         function &getConnection() {
 116         if (!isset($GLOBALS["_MDB2_CONNECTION"])) {
 117
 118                 require_once('MDB2.php');
 119
 120                 $mdb2 = MDB2::connect(DSN);
 121                         if (is_a($mdb2, 'PEAR_Error')) {
 122                         die($mdb2->getMessage());
 123                         }
 124
 125                         $mdb2->setFetchMode(MDB2_FETCHMODE_ASSOC);
 126
 127                         $GLOBALS["_MDB2_CONNECTION"] = $mdb2;
 128         }
 129         return $GLOBALS["_MDB2_CONNECTION"];
 130         }
 131
 132
 133         function closeConnection() {
 134                 if (isset($GLOBALS["_DB_CONNECTION"])) {
 135                         $GLOBALS["_DB_CONNECTION"]->close();
 136                         unset($GLOBALS["_DB_CONNECTION"]);
 137                 }
 138         }
 139
 140 // time_to_decimal converts a time string such as 1:15 to its decimal representation such as 1.25 or 1,25.
 141 function time_to_decimal($val) {
 142   global $user;
 143   $parts = explode(':', $val); // parts[0] is hours, parts[1] is minutes.
 144
 145   $minutePercent = round($parts[1]*100/60); // Integer value (0-98) of percent of minutes portion in the hour.
 146   if($minutePercent < 10) $minutePercent = '0'.$minutePercent; // Pad small values with a 0 to always have 2 digits.
 147
 148   $decimalTime = $parts[0].$user->decimal_mark.$minutePercent; // Construct decimal representation of time value.
 149
 150   return $decimalTime;
 151 }
 152
 153 function sec_to_time_fmt_hm($sec)
 154 {
 155   return sprintf("%d:%02d", $sec / 3600, $sec % 3600 / 60);
 156 }
 157
 158 function magic_quotes_off()
 159 {
 160   $_POST = array_map('stripslashes_deep', $_POST);
 161   $_GET = array_map('stripslashes_deep', $_GET);
 162   $_COOKIE = array_map('stripslashes_deep', $_COOKIE);
 163 }
 164
 165 // check_extension checks whether a required PHP extension is loaded and dies if not so.
 166 function check_extension($ext)
 167 {
 168   if (!extension_loaded($ext))
 169     die("PHP extension '{$ext}' is required but is not loaded. Read Time Tracker Install Guide for help.");
 170 }
 171
 172 // isTrue is a helper function to return correct false for older config.php values defined as a string 'false'.
 173 function isTrue($val)
 174 {
 175   return ($val == false || $val === 'false') ? false : true;
 176 }
 177
 178 // ttValidString is used to check user input to validate a string.
 179 function ttValidString($val, $emptyValid = false)
 180 {
 181   $val = trim($val);
 182   if (strlen($val) == 0 && !$emptyValid)
 183     return false;
 184
 185   // String must not be XSS evil (to insert JavaScript).
 186   if (stristr($val, '<script>') || stristr($val, '<script '))
 187     return false;
 188
 189   return true;
 190 }
 191
 192 // ttValidEmail is used to check user input to validate an email string.
 193 function ttValidEmail($val, $emptyValid = false)
 194 {
 195   $val = trim($val);
 196   if (strlen($val) == 0)
 197     return ($emptyValid ? true : false);
 198
 199   // String must not be XSS evil (to insert JavaScript).
 200   if (stristr($val, '<script>') || stristr($val, '<script '))
 201     return false;
 202
 203   // Validate a single email address. TODO: improve for compliancy with RFC.
 204   if (!preg_match("/^[_a-zA-Z\d\'-\.]+@([_a-zA-Z\d\-]+(\.[_a-zA-Z\d\-]+)+)$/", $val))
 205     return false;
 206
 207   return true;
 208 }
 209
 210 // ttValidEmailList is used to check user input to validate an email string.
 211 function ttValidEmailList($val, $emptyValid = false)
 212 {
 213   $val = trim($val);
 214   if (strlen($val) == 0)
 215     return ($emptyValid ? true : false);
 216
 217   // String must not be XSS evil (to insert JavaScript).
 218   if (stristr($val, '<script>') || stristr($val, '<script '))
 219     return false;
 220
 221   // Validates a list of email addresses separated by a comma with optional spaces.
 222   if (!preg_match("/^[_a-zA-Z\d\'-\.]+@([_a-zA-Z\d\-]+(\.[_a-zA-Z\d\-]+)+)(,\s*[_a-zA-Z\d\'-\.]+@([_a-zA-Z\d\-]+(\.[_a-zA-Z\d\-]+)+))*$/", $val))
 223     return false;
 224
 225   return true;
 226 }
 227
 228 // ttValidFloat is used to check user input to validate a float value.
 229 function ttValidFloat($val, $emptyValid = false)
 230 {
 231   $val = trim($val);
 232   if (strlen($val) == 0)
 233     return ($emptyValid ? true : false);
 234
 235   global $user;
 236   $decimal = $user->decimal_mark;
 237
 238   if (!preg_match('/^-?[0-9'.$decimal.']+$/', $val))
 239     return false;
 240
 241   return true;
 242 }
 243
 244 // ttValidDate is used to check user input to validate a date.
 245 function ttValidDate($val)
 246 {
 247   $val = trim($val);
 248   if (strlen($val) == 0)
 249     return false;
 250
 251   // This should accept a string in format 'YYYY-MM-DD', 'MM/DD/YYYY', 'DD.MM.YYYY', or 'DD.MM.YYYY whatever'.
 252   if (!preg_match('/^\d\d\d\d-\d\d-\d\d$/', $val) &&
 253     !preg_match('/^\d\d\/\d\d\/\d\d\d\d$/', $val) &&
 254     !preg_match('/^\d\d\.\d\d\.\d\d\d\d$/', $val) &&
 255     !preg_match('/^\d\d\.\d\d\.\d\d\d\d .+$/', $val))
 256     return false;
 257
 258   return true;
 259 }
 260
 261 // ttValidInteger is used to check user input to validate an integer.
 262 function ttValidInteger($val, $emptyValid = false)
 263 {
 264   $val = trim($val);
 265   if (strlen($val) == 0)
 266     return ($emptyValid ? true : false);
 267
 268   if (!preg_match('/^[0-9]+$/', $val))
 269     return false;
 270
 271   return true;
 272 }
 273
 274 // ttValidCronSpec is used to check user input to validate cron specification.
 275 function ttValidCronSpec($val)
 276 {
 277   // This code is adapted from http://stackoverflow.com/questions/235504/validating-crontab-entries-w-php
 278   $numbers= array(
 279      'min'=>'[0-5]?\d',
 280      'hour'=>'[01]?\d|2[0-3]',
 281      'day'=>'0?[1-9]|[12]\d|3[01]',
 282      'month'=>'[1-9]|1[012]',
 283      'dow'=>'[0-7]'
 284   );
 285
 286   foreach($numbers as $field=>$number) {
 287     $range= "($number)(-($number)(\/\d+)?)?";
 288     $field_re[$field]= "\*(\/\d+)?|$range(,$range)*";
 289   }
 290
 291   $field_re['month'].='|jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec';
 292   $field_re['dow'].='|mon|tue|wed|thu|fri|sat|sun';
 293
 294   $fields_re= '('.join(')\s+(', $field_re).')';
 295
 296   /*
 297   $replacements= '@reboot|@yearly|@annually|@monthly|@weekly|@daily|@midnight|@hourly';
 298
 299   $regexp = '^\s*('.
 300                 '$'.
 301                 '|#'.
 302                 '|\w+\s*='.
 303                 "|$fields_re\s+\S".
 304                 "|($replacements)\s+\S".
 305             ')';
 306    */
 307   // The above block from the link did not work for me.
 308
 309   // But this works.
 310   $regexp = '/^'.$fields_re.'$/';
 311
 312   if (!preg_match($regexp, $val))
 313     return false;
 314
 315   return true;
 316 }
 317
 318 // ttAccessCheck is used to check whether user is allowed to proceed. This function is used
 319 // as an initial check on all publicly available pages.
 320 function ttAccessCheck($required_rights)
 321 {
 322   global $auth;
 323   global $user;
 324
 325   // Redirect to login page if user is not authenticated.
 326   if (!$auth->isAuthenticated()) {
 327     header('Location: login.php');
 328     exit();
 329   }
 330
 331   // Check rights.
 332   if (!($required_rights & $user->rights))
 333     return false;
 334
 335   return true;
 336 }