0.2.1/inc/extensions.php

   1 <?php
   2 /************************************************************************
   3  * MXChange v0.2.1                                    Start: 03/25/2004 *
   4  * ===============                              Last change: 09/29/2004 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : extensions.php                                   *
   8  * -------------------------------------------------------------------- *
   9  * Short description : Extension management                             *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Erweiterungen-Management                         *
  12  * -------------------------------------------------------------------- *
  13  *                                                                      *
  14  * -------------------------------------------------------------------- *
  15  * Copyright (c) 2003 - 2008 by Roland Haeder                           *
  16  * For more information visit: http://www.mxchange.org                  *
  17  *                                                                      *
  18  * This program is free software; you can redistribute it and/or modify *
  19  * it under the terms of the GNU General Public License as published by *
  20  * the Free Software Foundation; either version 2 of the License, or    *
  21  * (at your option) any later version.                                  *
  22  *                                                                      *
  23  * This program is distributed in the hope that it will be useful,      *
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  26  * GNU General Public License for more details.                         *
  27  *                                                                      *
  28  * You should have received a copy of the GNU General Public License    *
  29  * along with this program; if not, write to the Free Software          *
  30  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  31  * MA  02110-1301  USA                                                  *
  32  ************************************************************************/
  33
  34 // Some security stuff...
  35 if (ereg(basename(__FILE__), $_SERVER['PHP_SELF']))
  36 {
  37         $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
  38         require($INC);
  39 }
  40 //
  41 function EXTENSION_REGISTER($ext_name, $id, $dry_run=false)
  42 {
  43         global $NOTES, $CONFIG, $INC_POOL;
  44         // We want to register an extension and registration status is by default "failed" (= false)
  45         $EXT_LOAD_MODE = "register"; $ret = false; $SQLs = array();
  46         $INC_POOL = array();
  47
  48         // This shall never do a non-admin user!
  49         if (!IS_ADMIN()) return false;
  50
  51         // Is this extension already installed?
  52         if (EXT_IS_ACTIVE($ext_name)) return false;
  53
  54         // Generate file name
  55         $file = sprintf(PATH."inc/extensions/ext-%s.php", $ext_name);
  56
  57         // Does this extension exists?
  58         if (file_exists($file) && is_readable($file))
  59         {
  60                 // Extension was found so we can load it in registration mode
  61                 require($file);
  62
  63                 // And run possible updates
  64                 $EXT_LOAD_MODE = "update"; $EXT_UPDATE_DEPENDS = "";
  65                 foreach ($EXT_VER_HISTORY as $EXT_VER)
  66                 {
  67                         require($file);
  68                         if (((GET_EXT_VERSION("sql_patches") != "") && ($CONFIG['verbose_sql'] == "Y")) || (!EXT_IS_ACTIVE("sql_patches")))
  69                         {
  70                                 if (!empty($UPDATE_NOTES))
  71                                 {
  72                                         // Update notes found
  73                                         $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><BR>".$UPDATE_NOTES."<BR><BR>\n";
  74                                         $UPDATE_NOTES = "";
  75                                 }
  76                                  elseif (($EXT_VER == "0.0") || ($EXT_VER == "0.0.0"))
  77                                 {
  78                                         // Initial release
  79                                         $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><BR>".INITIAL_RELEASE."<BR><BR>\n";
  80                                 }
  81                                  else
  82                                 {
  83                                         $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><BR><I>".NO_UPDATE_NOTES."</I><BR><BR>\n";
  84                                 }
  85                         }
  86                 }
  87
  88                 // Does this extension depends on an outstanding update of another update?
  89                 if (!empty($EXT_UPDATE_DEPENDS))
  90                 {
  91                         // Backup SQL commands and clear current
  92                         $SQLs2 = $SQLs;  $SQLs = array(); $test = false;
  93
  94                         // Backup language as well
  95                         $LANG_BCK = $EXT_LANG_PREFIX;
  96
  97                         // Load required extension also in update mode
  98                         $file = sprintf(PATH."inc/extensions/ext-%s.php", $EXT_UPDATE_DEPENDS);
  99
 100                         // Check for required file
 101                         if (file_exists($file) && is_readable($file))
 102                         {
 103                                 // File exists so let's load it
 104                                 $VER_BACKUP = $EXT_VERSION;
 105                                 require($file);
 106                                 $EXT_VERSION = $VER_BACKUP;
 107
 108                                 // If versions mismatch update extension first
 109                                 $ext_ver = GET_EXT_VERSION($EXT_UPDATE_DEPENDS);
 110                                 if (empty($ext_ver))
 111                                 {
 112                                         // Extension not registered so far so first load task's ID...
 113                                         $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_task_system WHERE task_type='EXTENSION' AND subject LIKE '[%s:]%%' LIMIT 1",
 114                                          array($EXT_UPDATE_DEPENDS), __FILE__, __LINE__);
 115                                         if (SQL_NUMROWS($result) == 1)
 116                                         {
 117                                                 // Task found so load task's ID and register extension...
 118                                                 list($task) = SQL_FETCHROW($result);
 119                                                 SQL_FREERESULT($result);
 120                                                 $test = EXTENSION_REGISTER($EXT_UPDATE_DEPENDS, $task, $dry_run);
 121                                         }
 122                                 }
 123                                  elseif ($ext_ver != $EXT_VERSION)
 124                                 {
 125                                         // Ok, update this extension now
 126                                         EXTENSION_UPDATE(basename($file), $EXT_UPDATE_DEPENDS, $ext_ver, $dry_run);
 127                                         $test = true;
 128                                 }
 129                                  else
 130                                 {
 131                                         // Nothing to register / update before...
 132                                         $test = true;
 133                                 }
 134                         }
 135                          else
 136                         {
 137                                 // Required file for update does not exists!
 138                                 $test = true;
 139                                 // But this is fine for the first time...
 140                         }
 141
 142                         // Finally restore previous SQLs
 143                         $SQLs = $SQLs2; unset($SQLs2);
 144                         $EXT_LANG_PREFIX = $LANG_BCK;
 145                 }
 146                  else
 147                 {
 148                         // Does not depend on an other extension
 149                         $test = true;
 150                 }
 151
 152                 // Does everthing before wents ok?
 153                 if ($test)
 154                 {
 155                         // "Dry-run-mode" activated?
 156                         if (!$dry_run)
 157                         {
 158                                 // Are there any SQL commands to run?
 159                                 if (count($SQLs) > 0)
 160                                 {
 161                                         foreach ($SQLs as $sql)
 162                                         {
 163                                                 $sql = trim($sql);
 164                                                 // Run SQL command
 165                                                 if (!empty($sql))
 166                                                 {
 167                                                         // Run SQLs without compiling them...
 168                                                         $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
 169                                                 }
 170                                         }
 171                                 }
 172
 173                                 // Check for added include files
 174                                 if (count($INC_POOL > 0))
 175                                 {
 176                                         // Loads every include file
 177                                         foreach ($INC_POOL as $inc)
 178                                         {
 179                                                 require_once($inc);
 180                                         }
 181                                 }
 182
 183                                 // Register extension
 184                                 $result = SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_extensions (ext_name, ext_lang_file, ext_active, ext_version) VALUES ('%s', '%s', 'N', '%s')",
 185                                  array($ext_name, $EXT_LANG_PREFIX, $EXT_VERSION), __FILE__, __LINE__);
 186
 187                                 // Update task management
 188                                 $result = SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_task_system SET status='SOLVED' WHERE id=%d LIMIT 1",
 189                                  array(bigintval($id)), __FILE__, __LINE__);
 190
 191                                 // In normal mode return a true on success
 192                                 $ret = true; unset($SQLs);
 193                         }
 194                          else
 195                         {
 196                                 // Rewrite SQL command to keep { and } inside
 197                                 foreach ($SQLs as $key=>$sql)
 198                                 {
 199                                         $sql = str_replace('{', "&#123;", str_replace('}', "&#125;", $sql));
 200                                         $SQLs[$key] = $sql;
 201                                 }
 202
 203                                 // In  "dry-run" mode return array with all SQL commands
 204                                 $ret = $SQLs;
 205
 206                                 // Remove all SQL commands
 207                                 unset($SQLs);
 208                         }
 209                 }
 210                  else
 211                 {
 212                         // No, an error occurs while registering extension :-(
 213                         $ret = false;
 214                 }
 215         }
 216          elseif (($id > 0) && (!empty($ext_name)))
 217         {
 218                 // Remove task from system when id and extension's name is valid
 219                 $result = SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_task_system WHERE id=%d AND status='NEW' LIMIT 1",
 220                  array(bigintval($id)), __FILE__, __LINE__);
 221         }
 222         // Return status code
 223         return $ret;
 224 }
 225 //
 226 function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE)
 227 {
 228         global $CACHE;
 229         // This shall never do a non-admin user!
 230         if (!IS_ADMIN()) return false;
 231
 232         // Get extension's name
 233         $result = SQL_QUERY_ESC("SELECT ext_name FROM "._MYSQL_PREFIX."_extensions WHERE id=%d LIMIT 1",
 234          array(bigintval($id)), __FILE__, __LINE__);
 235         list($ext_name) = SQL_FETCHROW($result);
 236         SQL_FREERESULT($result);
 237         if (empty($ext_name)) return false;
 238
 239         // Load extension in detected mode
 240         $file = sprintf(PATH."inc/extensions/ext-%s.php", $ext_name); $SQLs = array();
 241         if (file_exists($file) && is_readable($file)) require($file);
 242         if ((is_array($SQLs) && (sizeof($SQLs) > 0)))
 243         {
 244                 // Run SQL commands...
 245                 foreach ($SQLs as $sql)
 246                 {
 247                         $sql = trim($sql);
 248                         if (!empty($sql))
 249                         {
 250                                 // Run SQL command
 251                                 $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
 252                         }
 253                 }
 254
 255                 // Remove cache file(s) if extension is active
 256                 if (EXT_IS_ACTIVE("cache"))
 257                 {
 258                         // Remove cache filer
 259                         if ($CACHE->cache_file("extensions", true)) $CACHE->cache_destroy();
 260                         if ($CACHE->cache_file("mod_reg", true))    $CACHE->cache_destroy();
 261                         if ($CACHE->cache_file("config", true))     $CACHE->cache_destroy();
 262                 }
 263         }
 264 }
 265 //
 266 function EXT_IS_ACTIVE ($ext_name, $ignore_admin=false, $ignore_cache=false)
 267 {
 268         global $EXTENSIONS, $CONFIG;
 269
 270         // Extensions are all inactive during installation
 271         if ((!mxchange_installed) || (mxchange_installing) || (empty($ext_name))) return false;
 272
 273         // Extension's file name will also be checked
 274         $FILE = PATH."inc/extensions/ext-".$ext_name.".php";
 275         if ((!file_exists($FILE)) && (!is_readable($FILE))) return false;
 276         //* DEBUG: */ echo "*".$ext_name."*<BR>";
 277
 278         // Failed is the default
 279         $ret = false;
 280         if ((!empty($EXTENSIONS['ext_active'][$ext_name])) && (!$ignore_cache))
 281         {
 282                 // Load from cache
 283                 $active = $EXTENSIONS['ext_active'][$ext_name];
 284
 285                 // Count cache hits
 286                 if (isset($CONFIG['cache_hits'])) $CONFIG['cache_hits']++;
 287         }
 288          else
 289         {
 290                 // Load from database
 291                 $result = SQL_QUERY_ESC("SELECT ext_active FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
 292                  array($ext_name), __FILE__, __LINE__);
 293                 if (SQL_NUMROWS($result) == 0)
 294                 {
 295                         // Extension was not found!
 296                         return false;
 297                 }
 298                 list($active) = SQL_FETCHROW($result);
 299                 SQL_FREERESULT($result);
 300
 301                 // Write cache array
 302                 $EXTENSIONS['ext_active'][$ext_name] = $active;
 303         }
 304
 305         // Is this extension activated? (For admins we always have active extensions...)
 306         $inc = sprintf(PATH."inc/extensions/ext-%s.php", $ext_name);
 307         // Shorter way
 308         return (
 309                 (
 310                         ($active == "Y") || (
 311                                 (IS_ADMIN()) &&
 312                                 (!$ignore_admin) &&
 313                                 (!empty($active))
 314                         )
 315                 ) && (
 316                         file_exists($inc)
 317                 ) && (
 318                         is_readable($inc)
 319                 )
 320         );
 321 }
 322 //
 323 function GET_EXT_VERSION ($ext_name)
 324 {
 325         global $EXTENSIONS, $CONFIG;
 326         // Extensions are all inactive during installation
 327         if ((!mxchange_installed) || (mxchange_installing)) return "";
 328
 329         // Is the cache written?
 330         if (!empty($EXTENSIONS['ext_version'][$ext_name]))
 331         {
 332                 // Load data from cache
 333                 $ret = $EXTENSIONS['ext_version'][$ext_name];
 334
 335                 // Count cache hits
 336                 if (isset($CONFIG['cache_hits'])) $CONFIG['cache_hits']++;
 337         }
 338          else
 339         {
 340                 // Load from database
 341                 $result = SQL_QUERY_ESC("SELECT ext_version FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
 342                  array($ext_name), __FILE__, __LINE__);
 343                 list($ret) = SQL_FETCHROW($result);
 344                 SQL_FREERESULT($result);
 345
 346                 // Set cache
 347                 $EXTENSIONS['ext_version'][$ext_name] = $ret;
 348         }
 349         return $ret;
 350 }
 351 //
 352 function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false)
 353 {
 354         // This shall never do a non-admin user!
 355         global $CACHE, $CONFIG, $NOTES; $SQLs = array();
 356         if ((!IS_ADMIN()) || (empty($ext))) return false;
 357
 358         // Load extension in update mode
 359         $EXT_LOAD_MODE = "update"; $EXT_UPDATE_DEPENDS = ""; $NOTES = "";
 360         include(PATH."inc/extensions/".$file);
 361         if (!empty($EXT_UPDATE_DEPENDS))
 362         {
 363                 // Update another extension first!
 364                 $test = EXTENSION_UPDATE(("ext-".$EXT_UPDATE_DEPENDS.".php"), $EXT_UPDATE_DEPENDS, GET_EXT_VERSION($EXT_UPDATE_DEPENDS), $dry_run);
 365         }
 366
 367         // Check if version is updated
 368         if ((($EXT_VERSION != $EXT_VER) || ($dry_run)) && (is_array($EXT_VER_HISTORY)))
 369         {
 370                 // Search for starting point
 371                 $start = array_search($EXT_VER, $EXT_VER_HISTORY);
 372                 $NOTES = "";
 373
 374                 // And load SQL queries in order of version history
 375                 for ($idx = ($start + 1); $idx < sizeof($EXT_VER_HISTORY); $idx++)
 376                 {
 377                         // Remove old SQLs array to prevent possible bugs
 378                         if (!$dry_run) { unset($SQLs); $SQLs = array(); }
 379
 380                         // Set version
 381                         $EXT_VER = $EXT_VER_HISTORY[$idx];
 382
 383                         // Include again...
 384                         include(PATH."inc/extensions/".$file);
 385
 386                         // Add notes
 387                         if ($CONFIG['verbose_sql'] == "Y")
 388                         {
 389                                 $EXT_VER = $EXT_VER_HISTORY[$idx];
 390                                 if (!empty($UPDATE_NOTES))
 391                                 {
 392                                         // Update notes found
 393                                         $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><BR>".$UPDATE_NOTES."<BR><BR>\n";
 394                                         $UPDATE_NOTES = "";
 395                                 }
 396                                  elseif ($EXT_VER == "0.0")
 397                                 {
 398                                         // Initial release
 399                                         $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><BR>".INITIAL_RELEASE."<BR><BR>\n";
 400                                 }
 401                                  else
 402                                 {
 403                                         $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><BR><I>".NO_UPDATE_NOTES."</I><BR><BR>\n";
 404                                 }
 405                         }
 406
 407                         // Run SQLs
 408                         if ((is_array($SQLs)) && (!$dry_run))
 409                         {
 410                                 // Run SQL commands
 411                                 foreach ($SQLs as $sql)
 412                                 {
 413                                         $sql = trim($sql);
 414                                         if (!empty($sql))
 415                                         {
 416                                                 // Run SQL command...
 417                                                 $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
 418                                         }
 419                                 }
 420                         } elseif (GET_EXT_VERSION("sql_patches") == "") {
 421                                 // Remove SQLs if extension is not installed
 422                                 $SQLs = array();
 423                         }
 424                 }
 425
 426                 if (!$dry_run)
 427                 {
 428                         // In normal mode insert task and update extension's version...
 429                         $ext_subj = "[UPDATE-".$ext."-".$EXT_VERSION.":] ".ADMIN_UPDATE_EXT_SUBJ;
 430
 431                         // Create task
 432                         $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_task_system WHERE subject='%s' LIMIT 1",
 433                          array($ext_subj), __FILE__, __LINE__);
 434                         if (SQL_NUMROWS($result) == 0)
 435                         {
 436                                 // Task not created so it's a brand-new extension which we need to register and create a task for!
 437                                 $result = SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_task_system (assigned_admin, userid, status, task_type, subject, text, task_created) VALUES ('%s', '0', 'NEW', 'EXTENSION_UPDATE', '%s', '%s', UNIX_TIMESTAMP())",
 438                                  array(GET_ADMIN_ID(SQL_ESCAPE($_COOKIE['admin_login'])), $ext_subj, addslashes($NOTES)), __FILE__, __LINE__);
 439                         }
 440
 441                         // Free memory
 442                         SQL_FREERESULT($result);
 443
 444                         // Update extension's version
 445                         $result = SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_extensions SET ext_version='%s' WHERE ext_name='%s' LIMIT 1",
 446                          array($EXT_VERSION, $ext), __FILE__, __LINE__);
 447
 448                         // Update cache
 449                         if (EXT_IS_ACTIVE("cache"))
 450                         {
 451                                 if ($CACHE->cache_file("extensions", true) == true) $CACHE->cache_destroy();
 452                                 if ($CACHE->cache_file("config", true) == true)     $CACHE->cache_destroy();
 453                                 if ($CACHE->cache_file("mod_reg", true) == true)    $CACHE->cache_destroy();
 454                         }
 455
 456                         // Remove array
 457                         unset($SQLs);
 458                 }
 459                  else
 460                 {
 461                         // In "dry-run" mode return array with SQL commands
 462                         return $SQLs;
 463                 }
 464         }
 465 }
 466 //
 467 function EXTENSION_VERBOSE_TABLE($SQLs, $title=ADMIN_SQLS_EXECUTED_ON_REMOVAL, $dashed="", $switch=false, $WIDTH="480")
 468 {
 469         global $CONFIG;
 470
 471         $S = false; $SW = 2; $i = 1;
 472         $OUT = "";
 473         if ((is_array($SQLs)) && (GET_EXT_VERSION("sql_patches")) && ($CONFIG['verbose_sql'] == "Y"))
 474         {
 475                 $OUT  = "<DIV align=\"center\">
 476 <TABLE border=\"0\" cellspacing=\"0\" cellpadding=\"0\" width=\"".$WIDTH."\" align=\"center\"".$dashed.">
 477 <TR>
 478   <TD colspan=\"2\" align=\"center\" class=\"admin_title bottom2\" height=\"24\">
 479     <STRONG>".$title.":</STRONG>
 480   </TD>
 481 </TR>\n";
 482                 foreach ($SQLs as $idx=>$sql)
 483                 {
 484                         $sql = trim($sql);
 485                         if (!empty($sql))
 486                         {
 487                                 $S = true;
 488                                 $OUT .= "<TR>
 489   <TD class=\"switch_sw".(3 - $SW)." bottom2\" style=\"padding-left: 2px\" width=\"30\">".$i.".</TD>
 490   <TD class=\"switch_sw".(3 - $SW)." bottom2\" style=\"padding-left: 5px; padding-right: 5px\">
 491     ".$sql."
 492   </TD>
 493 </TR>\n";
 494                                 if ($switch) $SW = 3 - $SW;
 495                                 $i++;
 496                         }
 497                 }
 498         }
 499
 500         if ((!$S) && (GET_EXT_VERSION("sql_patches")) && ($CONFIG['verbose_sql'] == "Y"))
 501         {
 502                 // No addional SQL commands to run
 503                 $OUT .= "<TR>
 504   <TD colspan=\"2\" align=\"center\" class=\"switch_sw2 bottom2\" height=\"24\">
 505     <FONT class=\"admin_note\">".ADMIN_NO_ADDIONAL_SQLS."</FONT>
 506   </TD>
 507 </TR>\n";
 508         }
 509
 510         if (!empty($OUT)) {
 511                 // Add missing close-table tag
 512                 $OUT .= "</TABLE>
 513 </DIV>\n";
 514         }
 515         return $OUT;
 516 }
 517 //
 518 function GET_EXT_NAME($id)
 519 {
 520         $ret = "";
 521         global $EXTENSIONS, $CONFIG;
 522         if (!empty($EXTENSIONS['ext_id'][$id]))
 523         {
 524                 // Load from cache
 525                 $ret = $EXTENSIONS['ext_id'][$id];
 526
 527                 // Count cache hits
 528                 $CONFIG['cache_hits']++;
 529         }
 530          else
 531         {
 532                 // Load from database
 533                 $result = SQL_QUERY_ESC("SELECT ext_name FROM "._MYSQL_PREFIX."_extensions WHERE id=%d LIMIT 1",
 534                  array(bigintval($id)), __FILE__, __LINE__);
 535                 list($ret) = SQL_FETCHROW($result);
 536                 SQL_FREERESULT($result);
 537         }
 538         return $ret;
 539 }
 540 //
 541 function GET_EXT_ID($name)
 542 {
 543         $ret = "0";
 544         global $EXTENSIONS, $CONFIG;
 545         if ((isset($EXTENSIONS['ext_id'])) && (is_array($EXTENSIONS['ext_id'])))
 546         {
 547                 // Load from cache
 548                 $ret = array_search($name, $EXTENSIONS['ext_id']);
 549
 550                 // Count cache hits
 551                 $CONFIG['cache_hits']++;
 552         }
 553          else
 554         {
 555                 // Load from database
 556                 $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
 557                  array($name), __FILE__, __LINE__);
 558                 list($ret) = SQL_FETCHROW($result);
 559                 SQL_FREERESULT($result);
 560         }
 561         return $ret;
 562 }
 563 //
 564 ?>