1: <?php
  2: /**
  3:  * Initial functions
  4:  *
  5:  * @copyright       XOOPS Project (http://xoops.org)
  6:  * @license         GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
  7:  * @author          Taiwen Jiang <phppp@users.sourceforge.net>
  8:  * @since           1.00
  9:  * @version         $Id$
 10:  * @package         Frameworks
 11:  * @subpackage      art
 12:  */
 13: 
 14: if (substr(\XoopsBaseConfig('version'), 0, 9) < "XOOPS 2.3") {
 15:     trigger_error("The package only works for XOOPS 2.3+", E_USER_ERROR);
 16: }
 17: 
 18: if (!defined("FRAMEWORKS_ART_FUNCTIONS_INI")):
 19:     define("FRAMEWORKS_ART_FUNCTIONS_INI", true);
 20: 
 21:     define("FRAMEWORKS_ROOT_PATH", \XoopsBaseConfig::get('root-path') . "/Frameworks");
 22: 
 23:     /**
 24:      * Load declaration of an object handler
 25:      *
 26:      * @param string $handler
 27:      * @param string $dirname
 28:      * @return bool
 29:      */
 30:     function load_objectHandler($handler = "", $dirname = "art")
 31:     {
 32:         if (empty($handler)) {
 33:             $handlerClass = "ArtObject";
 34:             $fileName = "object.php";
 35:         } else {
 36:             $handlerClass = "ArtObject" . ucfirst($handler) . "Handler";
 37:             $fileName = "object.{$handler}.php";
 38:         }
 39: 
 40:         class_exists($handlerClass) || require_once FRAMEWORKS_ROOT_PATH . "/{$dirname}/{$fileName}";
 41:         return class_exists($handlerClass);
 42:     }
 43: 
 44:     /**
 45:      * @return bool
 46:      */
 47:     function load_object()
 48:     {
 49:         return load_objectHandler();
 50:     }
 51: 
 52:     /**
 53:      * Load a collective functions of Frameworks
 54:      *
 55:      * @param string $group name of  the collective functions, empty for functions.php
 56:      * @param string $dirname
 57:      * @return bool|mixed
 58:      */
 59:     function load_functions($group = "", $dirname = "art")
 60:     {
 61:         $dirname = ("" == $dirname) ? "art" : $dirname;
 62:         $constant = strtoupper("frameworks_{$dirname}_functions" . (($group) ? "_{$group}" : ""));
 63:         if (defined($constant)) {
 64:             return true;
 65:         }
 66:         return include_once FRAMEWORKS_ROOT_PATH . "/{$dirname}/functions.{$group}" . (empty($group) ? "" : ".") . "php";
 67:     }
 68: 
 69: 
 70:     /**
 71:      * Load a collective functions of a module
 72:      *
 73:      * The function file should be located in /modules/MODULE/functions.{$group}.php
 74:      * To avoid slowdown caused by include_once, a constant is suggested in the corresponding file: capitalized {$dirname}_{functions}[_{$group}]
 75:      *
 76:      * The function is going to be formulated to use Xoops::loadService() in XOOPS 2.3+
 77:      *
 78:      * @param    string    $group        name of  the collective functions, empty for functions.php
 79:      * @param    string    $dirname    module dirname, optional
 80:      * @return    bool
 81:      */
 82:     function mod_loadFunctions($group = "", $dirname = "")
 83:     {
 84:         $xoops = Xoops::getInstance();
 85: 
 86:         $dirname = !empty($dirname) ? $dirname : $xoops->moduleDirname;
 87:         $constant = strtoupper("{$dirname}_functions" . (($group) ? "_{$group}" : "") . "_loaded");
 88:         if (defined($constant)) {
 89:             return true;
 90:         }
 91:         $filename = \XoopsBaseConfig::get('root-path') . "/modules/{$dirname}/include/functions.{$group}" . (empty($group) ? "" : ".") . "php";
 92:         return include_once $filename;
 93:     }
 94: 
 95:     /**
 96:      * Load renderer for a class
 97:      *
 98:      * The class file should be located in /modules/MODULE/{$class}.renderer.php
 99:      * The classf name should be defined as Capitalized(module_dirname)Capitalized(class_name)Renderer
100:      *
101:      * @param    string    $class        name of  the classname
102:      * @param    string    $dirname    module dirname, optional
103:      * @return    bool
104:      */
105:     function mod_loadRenderer($class, $dirname = "")
106:     {
107:         $xoops = Xoops::getInstance();
108:         $dirname = !empty($dirname) ? $dirname : $xoops->moduleDirname;
109:         $renderer = ucfirst($dirname) . ucfirst($class) . "Renderer";
110:         if (!class_exists($renderer)) {
111:             require_once \XoopsBaseConfig::get('root-path') . "/modules/{$dirname}/class/{$class}.renderer.php";
112:         }
113:         $instance = eval("{$renderer}::instance()");
114:         return $instance;
115:     }
116: 
117: 
118:     if (!function_exists("mod_constant")) {
119:         /**
120:          * Get localized string if it is defined
121:          *
122:          * @param string $name string to be localized
123:          * @return mixed
124:          */
125:         function mod_constant($name)
126:         {
127:             $xoops = Xoops::getInstance();
128:             if (!empty($GLOBALS["VAR_PREFIXU"]) && @defined($GLOBALS["VAR_PREFIXU"] . "_" . strtoupper($name))) {
129:                 return constant($GLOBALS["VAR_PREFIXU"] . "_" . strtoupper($name));
130:             } elseif (!empty($xoops->module) && @defined(strtoupper($xoops->module->getVar("dirname", "n") . "_" . $name))) {
131:                 return constant(strtoupper($xoops->module->getVar("dirname", "n") . "_" . $name));
132:             } elseif (defined(strtoupper($name))) {
133:                 return constant(strtoupper($name));
134:             } else {
135:                 return str_replace("_", " ", strtolower($name));
136:             }
137:         }
138:     }
139: 
140:     if (!function_exists("mod_DB_prefix")) {
141:         /**
142:          * Get completed DB prefix if it is defined
143:          *
144:          * @param    string    $name    string to be completed
145:          * @param    boolean    $isRel    relative - do not add XOOPS->DB prefix
146:          * @return string
147:          */
148:         function mod_DB_prefix($name, $isRel = false)
149:         {
150:             $xoops = Xoops::getInstance();
151:             $relative_name = $GLOBALS["MOD_DB_PREFIX"] . "_" . $name;
152:             if ($isRel) {
153:                 return $relative_name;
154:             }
155:             return $xoopsDB->prefix($relative_name);
156:         }
157:     }
158: 
159:     if (!function_exists("xoops_message")):
160:         /**
161:          * Display contents of a variable, an array or an object or an array of objects
162:          *
163:          * @param mixed $message
164:          * @param int $userlevel
165:          * @return
166:          */
167:         function xoops_message($message, $userlevel = 0)
168:         {
169:             $xoops = Xoops::getInstance();
170:             if (!$xoops->isUser()) {
171:                 $level = 0;
172:             } elseif ($xoops->user->isAdmin()) {
173:                 $level = 99;
174:             } else {
175:                 $level = 1;
176:             }
177:             if ($userlevel > $level) {
178:                 return;
179:             }
180: 
181:             echo "<div style=\"clear:both\"> </div>";
182:             if (is_array($message) || is_object($message)) {
183:                 echo "<div><pre>";
184:                 print_r($message);
185:                 echo "</pre></div>";
186:             } else {
187:                 echo "<div>{$message}</div>";
188:             }
189:             echo "<div style=\"clear:both\"> </div>";
190:         }
191:     endif;
192: 
193:     /**
194:      * @param $message
195:      * @return bool
196:      */
197:     function mod_message($message)
198:     {
199:         $xoops = Xoops::getInstance();
200:         if (!empty($xoops->moduleConfig["do_debug"])) {
201:             if (is_array($message) || is_object($message)) {
202:                 echo "<div><pre>";
203:                 print_r($message);
204:                 echo "</pre></div>";
205:             } else {
206:                 echo "<div>$message</div>";
207:             }
208:         }
209:         return true;
210:     }
211: 
212:     /**
213:      * Get dirname of a module according to current path
214:      *
215:      * @param    string    $current_path    path to where the function is called
216:      * @return    string    $dirname
217:      */
218:     function mod_getDirname($current_path = null)
219:     {
220:         if (DIRECTORY_SEPARATOR !== '/') {
221:             $current_path = str_replace(strpos($current_path, '\\\\', 2) ? '\\\\'
222:                     : DIRECTORY_SEPARATOR, '/', $current_path);
223:         }
224:         $url_arr = explode('/', strstr($current_path, '/modules/'));
225:         return $url_arr[2];
226:     }
227: 
228:     /**
229:      * Is a module being installed, updated or uninstalled
230:      * Used for setting module configuration default values or options
231:      *
232:      * The function should be in functions.admin.php, however it requires extra inclusion in xoops_version.php if so
233:      *
234:      * @param    string    $dirname    dirname of current module
235:      * @return    bool
236:      */
237:     function mod_isModuleAction($dirname = "system")
238:     {
239:         $xoops = Xoops::getInstance();
240:         $ret = @( // action module "system"
241:             $xoops->isModule() && "system" === $xoops->module->getVar("dirname", "n") && // current dirname
242:             ($dirname == $_POST["dirname"] || $dirname == $_POST["module"]) && // current op
243:             ("update_ok" === $_POST["op"] || "install_ok" === $_POST["op"] || "uninstall_ok" === $_POST["op"]) && // current action
244:             "modulesadmin" === $_POST["fct"]);
245:         return $ret;
246:     }
247: 
248: endif;
249: