inc/inc-functions.php

   1 <?php
   2 /************************************************************************
   3  * MXChange v0.2.1                                    Start: 03/10/2009 *
   4  * ===============                              Last change: 03/10/2009 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : inc-functions.php                                *
   8  * -------------------------------------------------------------------- *
   9  * Short description : Special functions for handling include files     *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Spezielle Funktionen fuer Include-Dateien        *
  12  * -------------------------------------------------------------------- *
  13  * $Revision:: 999                                                    $ *
  14  * $Date:: 2009-03-10 17:24:54 +0100 (Tue, 10 Mar 2009)               $ *
  15  * $Tag:: 0.2.1-FINAL                                                 $ *
  16  * $Author:: quix0r                                                   $ *
  17  * Needs to be in all Files and every File needs "svn propset           *
  18  * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  19  * -------------------------------------------------------------------- *
  20  * Copyright (c) 2003 - 2008 by Roland Haeder                           *
  21  * For more information visit: http://www.mxchange.org                  *
  22  *                                                                      *
  23  * This program is free software; you can redistribute it and/or modify *
  24  * it under the terms of the GNU General Public License as published by *
  25  * the Free Software Foundation; either version 2 of the License, or    *
  26  * (at your option) any later version.                                  *
  27  *                                                                      *
  28  * This program is distributed in the hope that it will be useful,      *
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  31  * GNU General Public License for more details.                         *
  32  *                                                                      *
  33  * You should have received a copy of the GNU General Public License    *
  34  * along with this program; if not, write to the Free Software          *
  35  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  36  * MA  02110-1301  USA                                                  *
  37  ************************************************************************/
  38 // Some security stuff...
  39 if (!defined('__SECURITY')) {
  40         $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4)."/security.php";
  41         require($INC);
  42 }
  43
  44 // Check if our config file is writeable or not
  45 function IS_INC_WRITEABLE ($inc) {
  46         // Generate FQFN
  47         $FQFN = sprintf("%sinc/%s.php", constant('PATH'), $inc);
  48
  49         // Abort by simple test
  50         if ((FILE_READABLE($FQFN)) && (!is_writeable($FQFN))) {
  51                 return false;
  52         } // END - if
  53
  54         // Test write-access on directory
  55         return is_writeable(dirname($FQFN));
  56 }
  57
  58 // Reads a directory with PHP files in and gets only files back
  59 function GET_DIR_AS_ARRAY ($baseDir, $prefix, $includeDirs = false, $addBaseDir = true, $excludePattern = '@(\.|\.\.)$@') {
  60         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix} - Entered!");
  61         // Init includes
  62         $INCs = array();
  63
  64         // Open directory
  65         $dirPointer = opendir(constant('PATH') . $baseDir) or app_die(__FUNCTION__, __LINE__, "Cannot read ".basename($baseDir)." path!");
  66
  67         // Read all entries
  68         while ($baseFile = readdir($dirPointer)) {
  69                 // Steps over this returned $baseFile-Name, when it matches the $excludePattern
  70                 if (preg_match($excludePattern, $baseFile, $match)) {
  71                         // These Lines are only for debugging!!
  72                     //$INC = $baseDir . "/" . $baseFile;
  73                         //$FQFN = constant('PATH') . $INC;
  74                         //echo '<pre>$baseDir:'.print_r($baseDir, true).'</pre>';
  75                         //echo '<pre>$baseDir:'.print_r(constant('PATH') . $baseDir, true).'</pre>';
  76                         //echo '<pre>constant(\'PATH\'):'.print_r(constant('PATH'), true).'</pre>';
  77                         //echo '<pre>$FQFN:'.print_r($FQFN, true).'</pre>';
  78                         break;
  79                 } // END - if
  80
  81                 // Construct include filename and FQFN
  82                 $INC = $baseDir . "/" . $baseFile;
  83                 $FQFN = constant('PATH') . $INC;
  84
  85                 // repalecment of // to / is needed, whenn $baseDir is an emty String
  86                 $FQFN = str_replace('//', '/', $FQFN);
  87
  88                 // Is this a valid reset file?
  89                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "baseDir={$baseDir},prefix={$prefix},baseFile={$baseFile}");
  90                 if (((FILE_READABLE($FQFN)) && (substr($baseFile, 0, strlen($prefix)) == $prefix) && (substr($baseFile, -4, 4) == ".php")) || (($includeDirs) && (isDirectory($FQFN)))) {
  91                         // Remove both for extension name
  92                         $extName = substr($baseFile, strlen($prefix), -4);
  93
  94                         // Try to find it
  95                         $extId = GET_EXT_ID($extName);
  96
  97                         // Is the extension valid and active?
  98                         if (($extId > 0) && (EXT_IS_ACTIVE($extName))) {
  99                                 // Then add this file
 100                                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " Extension entry ".$baseFile." added.");
 101                                 $INCs[] = $INC;
 102                         } elseif ($extId == 0) {
 103                                 // Add non-extension files as well
 104                                 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " Regular entry ".$baseFile." added.");
 105                                 if ($addBaseDir) {
 106                                         $INCs[] = $INC;
 107                                 } else {
 108                                         $INCs[] = $baseFile;
 109                                 }
 110                         }
 111                 } // END - if
 112         } // END - while
 113
 114         // Close directory
 115         closedir($dirPointer);
 116
 117         // Sort array
 118         asort($INCs);
 119
 120         // Return array with include files
 121         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " - Left!");
 122         return $INCs;
 123 }
 124
 125 // Init INC_POOL
 126 function INIT_INC_POOL () {
 127         $GLOBALS['inc_pool'] = array();
 128 }
 129
 130 // Setter for INC_POOL
 131 function SET_INC_POOL ($includePool) {
 132         $GLOBALS['inc_pool'] = (array) $includePool;
 133 }
 134
 135 // Getter for INC_POOL
 136 function GET_INC_POOL () {
 137         return $GLOBALS['inc_pool'];
 138 }
 139
 140 // Count INC_POOL
 141 function COUNT_INC_POOL () {
 142         return count($GLOBALS['inc_pool']);
 143 }
 144
 145 // Merge INC_POOL into given
 146 function MERGE_INC_POOL ($includePool) {
 147         SET_INC_POOL(merge_array(GET_INC_POOL(), $includePool));
 148 }
 149
 150 // Add single include file to INC_POOL
 151 function ADD_INC_TO_POOL ($INC) {
 152         $GLOBALS['inc_pool'][] = (string) $INC;
 153 }
 154
 155 // Remove an include file from INC_POOL
 156 function REMOVE_INC_FROM_POOL ($INC) {
 157         // First look it up
 158         $key = array_search($INC, GET_INC_POOL());
 159
 160         // Is it valid?
 161         if ($key !== false) {
 162                 // Then remove it
 163                 unset($GLOBALS['inc_pool'][$key]);
 164
 165                 // And sort the list
 166                 asort($GLOBALS['inc_pool']);
 167         } // END - if
 168 }
 169
 170 // [EOF]
 171 ?>