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