functions.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Iris Studios Shared Object Framework [#]version[#]
   5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
   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 [#]gpl[#] 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 * Globalized Functions
  24 * functions.php
  25 *
  26 * @package      ISSO
  27 */
  28
  29 /**
  30 * Globalized Functions
  31 *
  32 * This framework is a set of functions that are commonly used in most
  33 * applications.
  34 *
  35 * @author               Iris Studios, Inc.
  36 * @copyright    Copyright ©2002 - [#]year[#], Iris Studios, Inc.
  37 * @version              $Revision$
  38 * @package              ISSO
  39 *
  40 */
  41 class Functions
  42 {
  43         /**
  44         * Framework registry object
  45         * @var  object
  46         * @access       private
  47         */
  48         var $registry = null;
  49
  50         /**
  51         * The path that is used to set cookies
  52         * @var  string
  53         * @access       pprivateublic
  54         */
  55         var $cookiepath = '/';
  56
  57         /**
  58         * The domain used for cookie setting
  59         * @var  string
  60         * @access       private
  61         */
  62         var $cookiedom = '';
  63
  64         /**
  65         * The time it takes for a cookie to expire
  66         * @var  integer
  67         * @access       private
  68         */
  69         var $cookieexp = 900;
  70
  71         /**
  72         * State of the current background colour during alternation
  73         * @var  string
  74         * @access       public
  75         */
  76         var $bgcolour = '';
  77
  78         /**
  79         * Fields array that is used in this module
  80         * @var  array
  81         * @access       private
  82         */
  83         var $fields = array(
  84                 'cookiepath'    => array(REQ_YES,       null,   true),
  85                 'cookiedom'             => array(REQ_YES,       null,   true),
  86                 'cookieexp'             => array(REQ_YES,       null,   true)
  87         );
  88
  89         // ###################################################################
  90         /**
  91         * Constructor
  92         */
  93         function __construct(&$registry)
  94         {
  95                 $this->registry =& $registry;
  96         }
  97
  98         // ###################################################################
  99         /**
 100         * (PHP 4) Constructor
 101         */
 102         function Functions(&$registry)
 103         {
 104                 $this->__construct($registry);
 105         }
 106
 107         // ###################################################################
 108         /**
 109         * Sets an ISSO field
 110         *
 111         * @access       public
 112         *
 113         * @param        string  Field name
 114         * @param        mixed   Value of the field
 115         */
 116         function set($name, $value)
 117         {
 118                 $this->registry->do_set($name, $value, 'functions');
 119         }
 120
 121         // ###################################################################
 122         /**
 123         * Sets a cookie with a friendly interface
 124         *
 125         * @access       public
 126         *
 127         * @param        string  The name of the cookie
 128         * @param        string  Value of the cookie
 129         * @param        bool    Is the cookie permanent?
 130         */
 131         function cookie($name, $value = '', $sticky = true)
 132         {
 133                 // expire the cookie
 134                 if (!$value)
 135                 {
 136                         setcookie($name, $value, time() - (2 * $this->cookieexp), $this->cookiepath, $this->cookiedom);
 137                 }
 138                 // set the cookie
 139                 else
 140                 {
 141                         if ($sticky)
 142                         {
 143                                 $expire = time() + 60 * 60 * 24 * 365;
 144                         }
 145                         else
 146                         {
 147                                 $expire = time() + $this->cookieexp;
 148                         }
 149
 150                         setcookie($name, $value, $expire, $this->cookiepath, $this->cookiedom);
 151                 }
 152         }
 153
 154         // ###################################################################
 155         /**
 156         * Alternate between two background colours
 157         *
 158         * @access       public
 159         *
 160         * @param        string  First CSS class name
 161         * @param        string  Second CSS class name
 162         */
 163         function exec_swap_bg($class1 = 'alt1', $class2 = 'alt2')
 164         {
 165                 static $count;
 166
 167                 $this->bgcolour = ($count % 2) ? $class1 : $class2;
 168                 $count++;
 169         }
 170
 171         // ###################################################################
 172         /**
 173         * Force-download a file by sending application/octetstream
 174         *
 175         * @access       public
 176         *
 177         * @param        string  The text of the file to be streamed
 178         * @param        string  File name of the new file
 179         * @param        bool    Whether or not to die after stringeaming the file
 180         */
 181         function download_file($file, $name, $exit = true)
 182         {
 183                 if ($this->is_browser('ie') OR $this->is_browser('opera') OR $this->is_browser('safari'))
 184                 {
 185                         $mime = 'application/octetstream';
 186                 }
 187                 else
 188                 {
 189                         $mime = 'application/octet-stream';
 190                 }
 191
 192                 header("Content-Type: $mime");
 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         /**
 209         * Verify that an email address is valid via regex
 210         *
 211         * @access       public
 212         *
 213         * @param        string  An email address
 214         *
 215         * @return       bool    Validity of the email address
 216         */
 217         function is_valid_email($email)
 218         {
 219                 if (preg_match('#^[a-z0-9\.\-\+_]+?@(.*?\.)*?[a-z0-9\-_]+?\.[a-z]{2,4}$#i', $email))
 220                 {
 221                         return true;
 222                 }
 223                 else
 224                 {
 225                         return false;
 226                 }
 227         }
 228
 229         // ###################################################################
 230         /**
 231         * Check a browser's user agent against a pre-determined list
 232         *
 233         * @access       public
 234         *
 235         * @param        string  Browser name
 236         * @param        string  The browser's version
 237         *
 238         * @param        mixed   False if there is no match, the version if there is
 239         */
 240         function is_browser($check, $version = '')
 241         {
 242                 $useragent = strtolower($_SERVER['HTTP_USER_AGENT']);
 243                 $browser = array();
 244                 $matches = array();
 245
 246                 // -------------------------------------------------------------------
 247                 // -- Opera
 248                 // -------------------------------------------------------------------
 249                 # Opera/6.05 (Windows 98; U) [en]
 250                 # Mozilla/4.0 (compatible; MSIE 5.0; Windows 98) Opera 6.0 [en]
 251                 # Mozilla/5.0 (Windows 98; U) Opera 6.0 [en]
 252                 # Mozilla/4.0 (compatible; MSIE, 6.0; Windows 98) Opera 7.0 [en]
 253                 if (preg_match('#opera ([0-9\.]+)#', $useragent, $matches) !== false)
 254                 {
 255                         if (isset($matches[1]))
 256                         {
 257                                 $browser['opera'] = $matches[1];
 258                         }
 259                 }
 260
 261                 // -------------------------------------------------------------------
 262                 // -- Mac browser
 263                 // -------------------------------------------------------------------
 264                 if (strpos($useragent, 'mac') !== false)
 265                 {
 266                         $browser['mac'] = true;
 267                 }
 268
 269                 // -------------------------------------------------------------------
 270                 // -- Internet explorer
 271                 // -------------------------------------------------------------------
 272                 # Mozilla/4.0 (compatible; MSIE 6.0b; Windows NT 5.1; .NET CLR 1.0.2914)
 273                 # Mozilla/4.0 (compatible; MSIE 5.5; Windows NT 5.0)
 274                 if (preg_match('#msie ([0-9\.]+)#', $useragent, $matches) !== false AND !isset($browser['opera']))
 275                 {
 276                         if (isset($matches[1]))
 277                         {
 278                                 $browser['ie'] = $matches[1];
 279                         }
 280                 }
 281
 282                 // -------------------------------------------------------------------
 283                 // -- Safari
 284                 // -------------------------------------------------------------------
 285                 # Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en) AppleWebKit/125.4 (KHTML, like Gecko) Safari/125.9
 286                 if (preg_match('#safari/([0-9\.]+)#', $useragent, $matches) !== false)
 287                 {
 288                         if (isset($matches[1]))
 289                         {
 290                                 $browser['safari'] = $matches[1];
 291                         }
 292                 }
 293
 294                 // -------------------------------------------------------------------
 295                 // -- Konqueror
 296                 // -------------------------------------------------------------------
 297                 # Mozilla/5.0 (compatible; Konqueror/3)
 298                 # Mozilla/5.0 (compatible; Konqueror/3.1; i686 Linux; 20020628)
 299                 if (preg_match('#konqueror/([0-9\.]+)#', $useragent, $matches) !== false)
 300                 {
 301                         if (isset($matches[1]))
 302                         {
 303                                 $browser['konqueror'] = $matches[1];
 304                         }
 305                 }
 306
 307                 // -------------------------------------------------------------------
 308                 // -- Mozilla
 309                 // -------------------------------------------------------------------
 310                 # Mozilla/5.001 (windows; U; NT4.0; en-us) Gecko/25250101
 311                 # Mozilla/5.001 (Macintosh; N; PPC; ja) Gecko/25250101 MegaCorpBrowser/1.0 (MegaCorp, Inc.)
 312                 if (preg_match('#gecko/([0-9]+)#', $useragent, $matches) !== false AND !isset($browser['safari']))
 313                 {
 314                         if (isset($matches[1]))
 315                         {
 316                                 $browser['mozilla'] = $matches[1];
 317                         }
 318
 319                         // -------------------------------------------------------------------
 320                         // -- Firefox
 321                         // -------------------------------------------------------------------
 322                         # Mozilla/5.0 (Macintosh; U; PPC Mac OS X Mach-O; en-US; rv:1.7) Gecko/20040628 Firefox/0.9.1
 323                         # Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.4a) Gecko/20030423 Firebird Browser/0.6
 324                         if (preg_match('#(firebird|firefox)( browser)?/([0-9\.]+)#', $useragent, $matches) !== false)
 325                         {
 326                                 if (isset($matches[3]))
 327                                 {
 328                                         $browser['firefox'] = $matches[3];
 329                                 }
 330                         }
 331
 332                         // -------------------------------------------------------------------
 333                         // -- Netscape
 334                         // -------------------------------------------------------------------
 335                         # Mozilla/5.0 (Macintosh; U; PPC; en-US; rv:0.9.4.1) Gecko/20020318 Netscape6/6.2.2
 336                         if (preg_match('#netscape([0-9].*?)?/([0-9\.]+)#', $useragent, $matches) !== false)
 337                         {
 338                                 if (isset($matches[2]))
 339                                 {
 340                                         $browser['netscape'] = $matches[2];
 341                                 }
 342                         }
 343
 344                         // -------------------------------------------------------------------
 345                         // -- Camino
 346                         // -------------------------------------------------------------------
 347                         # Mozilla/5.0 (Macintosh; U; PPC Mac OS X Mach-O; en-US; rv:1.7) Gecko/20040623 Camino/0.8
 348                         if (preg_match('#camino/([0-9\.]+)#', $useragent, $matches) !== false)
 349                         {
 350                                 if (isset($matches[1]))
 351                                 {
 352                                         $browser['camino'] = $matches[1];
 353                                 }
 354                         }
 355                 }
 356
 357                 if (isset($browser["$check"]))
 358                 {
 359                         if ($version)
 360                         {
 361                                 if ($browser["$check"] >= $version)
 362                                 {
 363                                         return $browser["$check"];
 364                                 }
 365                                 else
 366                                 {
 367                                         return false;
 368                                 }
 369                         }
 370                         else
 371                         {
 372                                 return $browser["$check"];
 373                         }
 374                 }
 375                 else
 376                 {
 377                         return false;
 378                 }
 379         }
 380
 381         // ###################################################################
 382         /**
 383         * Generates a random string of random length (unless otherwise
 384         * specified)
 385         *
 386         * @access       public
 387         *
 388         * @param        integer Optional length
 389         *
 390         * @return       string  A random string
 391         */
 392         function rand($length = 0)
 393         {
 394                 // custom high and lows
 395                 if (is_array($length))
 396                 {
 397                         $length = rand($length[0], $length[1]);
 398                 }
 399                 else if (!$length)
 400                 {
 401                         // Gimme a length!
 402                         $length = rand(20, 65);
 403                 }
 404
 405                 // Number of ints in our salt
 406                 $intcount = rand(0, intval($length / 2));
 407
 408                 // Number of chars
 409                 $charcount = $length - $intcount;
 410
 411                 // Upper-case chars
 412                 $upperchars = rand(1, intval($charcount / 2));
 413
 414                 // Lower-case chars
 415                 $lowerchars = $charcount - $upperchars;
 416
 417                 // Generate ints
 418                 for ($i = 0; $i < $intcount; $i++)
 419                 {
 420                         $string[] = rand(0, 9);
 421                 }
 422
 423                 // Generate upper chars
 424                 for ($i = 0; $i < $upperchars; $i++)
 425                 {
 426                         $string[] = chr(rand(65, 90));
 427                 }
 428
 429                 // Generate lower chars
 430                 for ($i = 0; $i < $lowerchars; $i++)
 431                 {
 432                         $string[] = chr(rand(97, 122));
 433                 }
 434
 435                 // Randomly key the chars
 436                 foreach ($string AS $char)
 437                 {
 438                         $rand = mt_rand();
 439                         $newstr["$rand"] = $char;
 440                 }
 441
 442                 // Sort the chars by thier random assignment
 443                 ksort($newstr);
 444
 445                 // Flatten the array
 446                 $string = '';
 447                 foreach ($newstr AS $char)
 448                 {
 449                         $string .= $char;
 450                 }
 451
 452                 return $string;
 453         }
 454
 455         // ###################################################################
 456         /**
 457         * Sets the current array position to be the specified key. This
 458         * function should be avoided on large arrays.
 459         *
 460         * @access       public
 461         *
 462         * @param        array   The array whose counter is to be updated
 463         * @param        mixed   The key of the element of the array that the counter is to be set to
 464         *
 465         * @return       mixed   Return the elelment of the array that we just put the counter to
 466         */
 467         function array_set_current(&$array, $key)
 468         {
 469                 reset($array);
 470                 while (current($array) !== false)
 471                 {
 472                         if (key($array) == $key)
 473                         {
 474                                 break;
 475                         }
 476                         next($array);
 477                 }
 478                 return current($array);
 479         }
 480
 481         // ###################################################################
 482         /**
 483         * Calculates the microtime difference by taking a given microtime and
 484         * subtracting it from the current one
 485         *
 486         * @access       public
 487         *
 488         * @param        string  The start microtime
 489         *
 490         * @return       float   Microtime difference
 491         */
 492         function fetch_microtime_diff($mtstart)
 493         {
 494                 $mtend = microtime();
 495                 list ($starttime['micro'], $starttime['sec']) = explode(' ', $mtstart);
 496                 list ($endtime['micro'], $endtime['sec']) = explode(' ', $mtend);
 497                 return ($endtime['micro'] + $endtime['sec']) - ($starttime['micro'] + $starttime['sec']);
 498         }
 499
 500         // ###################################################################
 501         /**
 502         * Fetches the extension of a file by extracting everything after the
 503         * last period
 504         *
 505         * @access       public
 506         *
 507         * @param        string  Filename
 508         *
 509         * @return       string  The extension for the specifid file name
 510         */
 511         function fetch_extension($filename)
 512         {
 513                 return strval(end(explode('.', $filename)));
 514         }
 515
 516         // ###################################################################
 517         /**
 518         * Gets the maximum file size for attachment uploading, as specified by
 519         * PHP. If no value is present, 10 MB (represented in bytes) is
 520         * returned.
 521         *
 522         * @access       public
 523         *
 524         * @return       integer The maximum file upload size in bytes
 525         */
 526         function fetch_max_attachment_size()
 527         {
 528                 if ($size = @ini_get('upload_max_filesize'))
 529                 {
 530                         if (preg_match('#[^0-9].#', $size))
 531                         {
 532                                 return $size;
 533                         }
 534                         else
 535                         {
 536                                 return intval($size) * 1048576;
 537                         }
 538                 }
 539                 else
 540                 {
 541                         return 10 * 1048576;
 542                 }
 543         }
 544
 545         // ###################################################################
 546         /**
 547         * Scans a specified directory path and returns an array of all the
 548         * items in that directory. Directories found by this are end in a "/"
 549         *
 550         * @access       public
 551         *
 552         * @param        string  Path to scan
 553         * @param        bool    Whether or not to recursively scan the directories encountered
 554         * @param        bool    Ignore files beginning with a dot
 555         * @param        bool    Ignore 'CVS' dirctories
 556         *
 557         * @return       array   A list of all the files in the specified path
 558         */
 559         function scandir($path, $recurse = true, $ignoredot = true, $ignorecvs = true, $basepath = '', $unset = 1)
 560         {
 561                 static $filelist;
 562
 563                 if ($unset)
 564                 {
 565                         $filelist = array();
 566                 }
 567
 568                 if (substr($path, (strlen($path) - 1), 1) != '/')
 569                 {
 570                         $path .= '/';
 571                 }
 572
 573                 if ($handle = opendir($path))
 574                 {
 575                         while (($file = readdir($handle)) !== false)
 576                         {
 577                                 $isdot = ((substr($file, 0, 1) == '.') ? true : false);
 578                                 $isdot = (($ignoredot) ? $isdot : true);
 579                                 $iscvs = (($file == 'CVS') ? true : false);
 580                                 $iscvs = (($ignorecvs) ? $iscvs : true);
 581                                 if (!$isdot AND !$iscvs)
 582                                 {
 583                                         if (is_dir($path . $file))
 584                                         {
 585                                                 $filelist["$basepath"][] = "$file/";
 586                                                 if ($recurse)
 587                                                 {
 588                                                         $this->scandir("$path$file", true, $ignoredot, $ignorecvs, "$basepath$file/", 0);
 589                                                 }
 590                                         }
 591                                         else
 592                                         {
 593                                                 $filelist["$basepath"][] = $file;
 594                                         }
 595                                 }
 596                         }
 597                         closedir($handle);
 598                 }
 599                 return $filelist;
 600         }
 601 }
 602
 603 /*=====================================================================*\
 604 || ###################################################################
 605 || # $HeadURL$
 606 || # $Id$
 607 || ###################################################################
 608 \*=====================================================================*/
 609 ?>