Functions.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Blue Static ISSO Framework
   5 || # Copyright (c)2005-2008 Blue Static
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version 2 of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23  * Static functions (Functions.php)
  24  *
  25  * @package     ISSO
  26  */
  27
  28 /**
  29  * Functions
  30  *
  31  * This is a bunch of static functions. This class is singleton so it
  32  * can store data while remaining static.
  33  *
  34  * @author              Blue Static
  35  * @copyright   Copyright (c)2005 - 2008, Blue Static
  36  * @package             ISSO
  37  *
  38  */
  39 class BSFunctions
  40 {
  41         /**
  42          * Singleton instance
  43          * @var object
  44          */
  45         private static $instance;
  46
  47         /**
  48          * Cookie path
  49          * @var string
  50          */
  51         private $cookiePath = '/';
  52
  53         /**
  54          * Cookie domain setting
  55          * @var string
  56          */
  57         private $cookieDomain = '';
  58
  59         /**
  60          * Cookie expiration time
  61          * @var integer
  62          */
  63         private $cookieTimeout = 900;
  64
  65         /**
  66          * Current swapped CSS class
  67          * @var string
  68          */
  69         public static $cssClass = '';
  70
  71         /**
  72          * Constructor
  73          */
  74         private function __construct() {}
  75
  76         /**
  77          * Returns the shared instance for singleton
  78          *
  79          * @return      object  Shared instance
  80          */
  81         private function _instance()
  82         {
  83                 if (!self::$instance)
  84                 {
  85                         self::$instance = new BSFunctions();
  86                 }
  87                 return self::$instance;
  88         }
  89
  90         /**
  91          * Sets the cookie path
  92          *
  93          * @param       string  New path
  94          */
  95         public static function set_cookie_path($path)
  96         {
  97                 self::_instance()->cookiePath = $path;
  98         }
  99
 100         /**
 101          * Sets the cookie domain setting
 102          *
 103          * @param       string  Cookie domain
 104          */
 105         public static function set_cookie_domain($domain)
 106         {
 107                 self::_instance()->cookieDomain = $domain;
 108         }
 109
 110         /**
 111          * Sets the cookie timeout
 112          *
 113          * @param       integer Cookie timeout
 114          */
 115         public static function set_cookie_timeout($timeout)
 116         {
 117                 self::_instance()->cookieTimeout = intval($timeout);
 118         }
 119
 120         /**
 121          * Sets a cookie in the user's computer/browing session
 122          *
 123          * @param       string  Name of the cookie
 124          * @param       string  Value of the cookie, FALSE to clear
 125          * @param       bool    Is the cookie permanent?
 126          */
 127         public static function cookie($name, $value, $sticky = true)
 128         {
 129                 // expire the cookie
 130                 if ($value === false)
 131                 {
 132                         setcookie($name, $value, time() - (2 * self::_instance()->cookieTimeout), self::_instance()->cookiePath, self::_instance()->cookieDomain);
 133                 }
 134                 // set the cookie
 135                 else
 136                 {
 137                         if ($sticky)
 138                         {
 139                                 $expire = time() + 60 * 60 * 24 * 365;
 140                         }
 141                         else
 142                         {
 143                                 $expire = time() + self::_instance()->cookieTimeout;
 144                         }
 145
 146                         setcookie($name, $value, $expire, self::_instance()->cookiePath, self::_instance()->cookieDomain);
 147                 }
 148         }
 149
 150         /**
 151          * Alternate between two CSS classes
 152          *
 153          * @param       string  First CSS class name
 154          * @param       string  Second CSS class name
 155          */
 156         public static function swap_css_classes($class1 = 'alt1', $class2 = 'alt2')
 157         {
 158                 static $count;
 159
 160                 self::$cssClass = ($count % 2) ? $class1 : $class2;
 161                 $count++;
 162         }
 163
 164         /**
 165          * Returns the 'source path' version of a file path. It adds a
 166          * directory separator to the end of a string if it does not already
 167          * exist.
 168          *
 169          * @param       string  Path
 170          *
 171          * @return      string  Path with directory separator ending
 172          */
 173         public static function fetch_source_path($source)
 174         {
 175                 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR)
 176                 {
 177                         $source .= DIRECTORY_SEPARATOR;
 178                 }
 179                 return $source;
 180         }
 181
 182         /**
 183          * Force-download a file by sending application/octetstream
 184          *
 185          * @param       string  The text of the file to be streamed
 186          * @param       string  File name of the new file
 187          * @param       bool    Whether or not to die after stringeaming the file
 188          */
 189         public static function download_file($file, $name, $exit = true)
 190         {
 191                 header("Content-Type: application/octetstream");
 192                 header("Content-Type: application/octet-stream");
 193                 header('Expires: ' . gmdate('D, d M Y H:i:s') . ' GMT');
 194                 header('Content-Disposition: attachment; filename="' . $name . '"');
 195                 header('Content-length: ' . strlen($file));
 196                 header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
 197                 header('Pragma: public');
 198
 199                 print($file);
 200
 201                 if ($exit)
 202                 {
 203                         exit;
 204                 }
 205         }
 206
 207         /**
 208          * Verify that an email address is valid via regex
 209          *
 210          * @param       string  An email address
 211          *
 212          * @return      bool    Validity of the email address
 213          */
 214         public static function is_valid_email($email)
 215         {
 216                 if (preg_match('#^[a-z0-9\.\-\+_]+?@(.*?\.)*?[a-z0-9\-_]+?\.[a-z]{2,4}$#i', $email))
 217                 {
 218                         return true;
 219                 }
 220                 else
 221                 {
 222                         return false;
 223                 }
 224         }
 225
 226         /**
 227          * Generates a random string of random length (unless otherwise
 228          * specified)
 229          *
 230          * @param       integer Optional length
 231          *
 232          * @return      string  A random string
 233          */
 234         public static function random($length = 0)
 235         {
 236                 // length wasn't provided, so create our own
 237                 if ($length < 1)
 238                 {
 239                         $length = rand(20, 65);
 240                 }
 241
 242                 $string = '';
 243                 while (strlen($string) < $length)
 244                 {
 245                         $type = rand(0, 300);
 246                         if ($type < 100)
 247                         {
 248                                 $string .= rand(0, 9);
 249                         }
 250                         else if ($type < 200)
 251                         {
 252                                 $string .= chr(rand(65, 90));
 253                         }
 254                         else
 255                         {
 256                                 $string .= chr(rand(97, 122));
 257                         }
 258                 }
 259
 260                 return $string;
 261         }
 262
 263         /**
 264          * Sets the current array position to be the specified key. This
 265          * function should be avoided on large arrays.
 266          *
 267          * @param       array   The array whose counter is to be updated
 268          * @param       mixed   The key of the element of the array that the counter is to be set to
 269          *
 270          * @return      mixed   Return the elelment of the array that we just put the counter to
 271          */
 272         public static function array_set_current(&$array, $key)
 273         {
 274                 reset($array);
 275                 while (current($array) !== false)
 276                 {
 277                         if (key($array) == $key)
 278                         {
 279                                 break;
 280                         }
 281                         next($array);
 282                 }
 283                 return current($array);
 284         }
 285
 286         /**
 287          * Calculates the microtime difference by taking a given microtime and
 288          * subtracting it from the current one
 289          *
 290          * @param       string  The start microtime
 291          *
 292          * @return      float   Microtime difference
 293          */
 294         public static function fetch_microtime_diff($mtstart)
 295         {
 296                 $mtend = microtime();
 297                 list($startMicro, $startSec) = explode(' ', $mtstart);
 298                 list($endMicro, $endSec) = explode(' ', $mtend);
 299                 return ($endMicro + $endSec) - ($startMicro + $startSec);
 300         }
 301
 302         /**
 303          * Fetches the extension of a file by extracting everything after the
 304          * last period
 305          *
 306          * @param       string  Filename
 307          *
 308          * @return      string  The extension for the specifid file name
 309          */
 310         public static function fetch_extension($filename)
 311         {
 312                 $array = explode('.', $filename);
 313
 314                 if (sizeof($array) == 1)
 315                 {
 316                         return '';
 317                 }
 318
 319                 return strval(end($array));
 320         }
 321
 322         /**
 323          * Gets the maximum file size for attachment uploading, as specified by
 324          * PHP. If no value is present, 10 MB (represented in bytes) is
 325          * returned.
 326          *
 327          * @return      integer The maximum file upload size in bytes
 328          */
 329         public static function fetch_max_php_file_size()
 330         {
 331                 if ($size = @ini_get('upload_max_filesize'))
 332                 {
 333                         if (preg_match('#[^0-9].#', $size))
 334                         {
 335                                 return $size;
 336                         }
 337                         else
 338                         {
 339                                 return intval($size) * 1048576;
 340                         }
 341                 }
 342                 else
 343                 {
 344                         return 10 * 1048576;
 345                 }
 346         }
 347
 348         /**
 349          * Scans a specified directory path and returns an array of all the
 350          * items in that directory. Directories found by this are end in a "/"
 351          *
 352          * @param       string  Path to scan
 353          * @param       bool    Whether or not to recursively scan the directories encountered
 354          * @param       bool    Ignore files beginning with a dot
 355          *
 356          * @return      array   A list of all the files in the specified path
 357          */
 358         public static function scan_directory($path, $recurse = true, $ignoreDot = true)
 359         {
 360                 return self::_help_scan_directory($path, $recurse, $ignoreDot, '');
 361         }
 362
 363         /**
 364          * Scans a specified directory path and returns an array of all the
 365          * items in that directory. Directories found by this are end in a "/"
 366          *
 367          * @param       string  Path to scan
 368          * @param       bool    Whether or not to recursively scan the directories encountered
 369          * @param       bool    Ignore files beginning with a dot
 370          * @param       string  Add to the beginning of the path
 371          *
 372          * @return      array   A list of all the files in the specified path
 373          */
 374         private static function _help_scan_directory($path, $recurse = true, $ignoreDot = true, $pathAdd = '')
 375         {
 376                 $filelist = array();
 377                 $path = self::fetch_source_path($path);
 378
 379                 $dir = new DirectoryIterator($path);
 380                 foreach ($dir as $file)
 381                 {
 382                         $name = $file->getFilename();
 383                         if (($file->isDot() || $name[0] == '.') && $ignoreDot)
 384                         {
 385                                 continue;
 386                         }
 387
 388                         if ($file->isDir() && $recurse)
 389                         {
 390                                 $filelist = array_merge($filelist, self::_help_scan_directory($path . $name, $recurse, $ignoreDot, $pathAdd . BSFunctions::fetch_source_path(str_replace($path, '', $file->getPathname()))));
 391                                 continue;
 392                         }
 393
 394                         $filelist[] = $pathAdd . $name;
 395                 }
 396
 397                 return $filelist;
 398         }
 399
 400         /**
 401          * Changes line breaks into one format
 402          *
 403          * @param       string  Text
 404          * @param       string  New line break (default is UNIX \n format)
 405          *
 406          * @return      string  Text with one type of line break
 407          */
 408         public static function convert_line_breaks($text, $convert_to = "\n")
 409         {
 410                 $text = trim($text);
 411                 $text = str_replace(array("\r\n", "\r", "\n"), "\n", $text);
 412                 $text = str_replace("\n", $convert_to, $text);
 413                 return $text;
 414         }
 415
 416         /**
 417          * Removes all empty() [by PHP's standards] elements in an array. This
 418          * can be used in place of using PREG_SPLIT_NO_EMPTY.
 419          *
 420          * @param       array   An array to strip empties from
 421          *
 422          * @return      array   Full-valued array
 423          */
 424         public static function array_strip_empty($array)
 425         {
 426                 foreach ($array as $key => $value)
 427                 {
 428                         if (is_array($array["$key"]))
 429                         {
 430                                 $array["$key"] = self::array_strip_empty($array["$key"]);
 431                         }
 432                         else if (empty($value) || is_null($value))
 433                         {
 434                                 unset($array["$key"]);
 435                         }
 436                 }
 437                 return $array;
 438         }
 439
 440         /**
 441          * A backtrace formatter.
 442          *
 443          * This is very slightly modified from PEAR/PHP_Compat (PHP license)
 444          *
 445          * @author      Laurent Laville <pear@laurent-laville.org>
 446          * @author      Aidan Lister <aidan@php.net>
 447          *
 448          * @param       array   The backtrace from debug_backtrace() to format
 449          *
 450          * @return      string  Formatted output
 451          */
 452         public static function format_backtrace($backtrace)
 453         {
 454                 // Unset call to debug_print_backtrace
 455                 array_shift($backtrace);
 456                 if (empty($backtrace))
 457                 {
 458                         return '';
 459                 }
 460
 461                 // Iterate backtrace
 462                 $calls = array();
 463                 foreach ($backtrace as $i => $call)
 464                 {
 465                         if (!isset($call['file']))
 466                         {
 467                                 $call['file'] = '(null)';
 468                         }
 469                         if (!isset($call['line']))
 470                         {
 471                                 $call['line'] = '0';
 472                         }
 473                         $location = $call['file'] . ':' . $call['line'];
 474                         $function = (isset($call['class'])) ? $call['class'] . (isset($call['type']) ? $call['type'] : '.') . $call['function'] : $call['function'];
 475
 476                         $params = '';
 477                         if (isset($call['args']))
 478                         {
 479                                 $args = array();
 480                                 foreach ($call['args'] as $arg)
 481                                 {
 482                                         if (is_array($arg))
 483                                         {
 484                                                 $args[] = 'Array';
 485                                         }
 486                                         elseif (is_object($arg))
 487                                         {
 488                                                 $args[] = get_class($arg);
 489                                         }
 490                                         else
 491                                         {
 492                                                 $args[] = $arg;
 493                                         }
 494                                 }
 495                                 $params = implode(', ', $args);
 496                         }
 497
 498                         $calls[] = sprintf('#%d  %s(%s) called at [%s]', $i, $function, $params, $location);
 499                 }
 500
 501                 return implode("\n", $calls);
 502         }
 503
 504         /**
 505          * A variation of PHP's substr() method that takes in the start
 506          * and end position of a string, rather than a start and length. This
 507          * mimics Java's String.substring() method.
 508          *
 509          * @param       string  The string
 510          * @param       integer Start position
 511          * @param       integer End position
 512          *
 513          * @return      string  Part of a string
 514          */
 515         public static function substring($string, $start, $end)
 516         {
 517                 return substr($string, $start, $end - $start);
 518         }
 519 }
 520
 521 ?>