2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 10/25/2009 *
4 * =================== Last change: 10/25/2009 *
6 * -------------------------------------------------------------------- *
7 * File : extensions-functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Extension management *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Erweiterungen-Management *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * -------------------------------------------------------------------- *
18 * Copyright (c) 2003 - 2009 by Roland Haeder *
19 * Copyright (c) 2009 - 2012 by Mailer Developer Team *
20 * For more information visit: http://mxchange.org *
22 * This program is free software; you can redistribute it and/or modify *
23 * it under the terms of the GNU General Public License as published by *
24 * the Free Software Foundation; either version 2 of the License, or *
25 * (at your option) any later version. *
27 * This program is distributed in the hope that it will be useful, *
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
30 * GNU General Public License for more details. *
32 * You should have received a copy of the GNU General Public License *
33 * along with this program; if not, write to the Free Software *
34 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
36 ************************************************************************/
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
43 // Load the extension and maybe found language and function files.
44 function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $isDryRun = FALSE, $previousExtension = NULL) {
45 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_mode=' . $ext_mode . ',ext_ver=' . $ext_ver . ',isDryRun=' . intval($isDryRun) . ' - ENTERED!');
46 // Loading an extension in same mode, but not test/update, twice is not
47 // good, so is the extension $ext_name already loaded in mode $ext_mode?
48 if ((isset($GLOBALS['loaded_extension'][$ext_name][$ext_mode])) && (!in_array($ext_mode, array('update', 'test')))) {
49 // If this happens twice, we need the bug report from you, except for updates/tests
50 reportBug(__FUNCTION__, __LINE__, __FUNCTION__ . '() is called twice: ext_name=' . $ext_name . ', ext_mode='. $ext_mode . ',ext_sqls=' . print_r(getExtensionSqls(), TRUE) . ', ext_register_running=' . print_r($GLOBALS['ext_register_running'], TRUE) . ', ext_running_updates=' . print_r($GLOBALS['ext_running_updates'], TRUE));
53 // Make sure this situation can only happen once
54 $GLOBALS['loaded_extension'][$ext_name][$ext_mode] = TRUE;
56 // Remember previous extension here
57 $GLOBALS['previous_extension'][$ext_name] = $previousExtension;
60 setExtensionMode($ext_mode);
62 // Set current extension name
63 setCurrentExtensionName($ext_name);
65 // By default all extensions are in productive phase
66 enableExtensionProductive();
68 if (!empty($ext_ver)) {
69 // Set current extension version
70 setCurrentExtensionVersion($ext_ver);
72 // Set it to 0.0 by default
73 setCurrentExtensionVersion('0.0.0');
75 // Is the extension installed?
76 if ((isExtensionInstalled($ext_name)) && ($ext_mode != 'register')) {
77 // Get extension's version
78 setCurrentExtensionVersion(getExtensionVersion($ext_name));
81 // In all but test-mode we need these messages to debug! Please report all (together, e.g.)
82 if (($ext_mode != 'test') && (getCurrentExtensionVersion() == '0.0.0')) {
83 // Abort here, this must now always be set!
84 reportBug(__FUNCTION__, __LINE__, 'Extension version is empty, setting to 0.0.0 ext_name=' . $ext_name . ', ext_mode=' . $ext_mode . ', isDryRun=' . intval($isDryRun));
89 enableExtensionDryRun($isDryRun);
92 initIncludePool('extension');
94 // Init EXT_UPDATE_DEPENDS if not yet done
95 if (!isExtensionUpdateDependenciesInitialized()) {
97 initExtensionUpdateDependencies();
100 // Init current extension name list
103 // Is the extension already loaded?
104 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Loading extension ' . $ext_name . ', getExtensionMode()=' . getExtensionMode() . ', getCurrentExtensionVersion()=' . getCurrentExtensionVersion());
105 if ((isExtensionLoaded($ext_name)) && (getExtensionMode() == 'init')) {
107 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name));
113 // Is the extension file NOT there?
114 if (!isExtensionNameValid($ext_name)) {
116 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension %s not found or not readable or the PHP script is deprecated.", $ext_name));
122 // Load extension's own language file if not in test mode
123 if ((getExtensionMode() != 'test') && (ifExtensionHasLanguageFile($ext_name))) {
125 loadLanguageFile($ext_name);
129 if (isExtensionFunctionFileReadable($ext_name)) {
131 if ((($GLOBALS['cache_array']['extension']['ext_func'][$ext_name] == 'Y') || (!isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name]))) && (!isExtensionLibraryLoaded($ext_name))) {
132 // Construct IFN for functions file
133 $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
136 markExtensionLibraryAsLoaded($ext_name);
138 // Download functions file
139 loadIncludeOnce($funcsInclude);
141 } elseif ((!isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name])) && (isDebugModeEnabled()) && (isHtmlOutputMode()) && ($ext_name != 'sql_patches') && (substr($ext_name, 0, 10) != 'admintheme') && (getExtensionMode() == 'test')) {
142 // No functions file is not so good...
143 logDebugMessage(__FUNCTION__, __LINE__, sprintf("NOTICE: Extension %s has no own functions file or we cannot read from it. mode=%s",
149 // Load extension's filter library if present
150 loadExtensionFilters($ext_name);
152 // Extensions are not deprecated by default
153 setExtensionDeprecated('N');
155 // Extensions are not always active by default
156 setExtensionAlwaysActive('N');
158 // Include the extension file
159 loadCurrentExtensionInclude();
161 // Is this extension deprecated?
162 if ((isExtensionDeprecated()) && (!in_array(getExtensionMode(), array('test', 'update', 'deactivate'))) && (isExtensionActive($ext_name))) {
163 // Deactivate the extension
164 doDeactivateExtension($ext_name);
167 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension load aborted, ext_name=' . $ext_name . ' - Extension is deprecated.');
171 // Mark it as loaded in normal mode
172 if (getExtensionMode() == '') {
174 markExtensionAsLoaded($ext_name);
178 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension successfully loaded, ext_name=' . $ext_name);
182 // Registers an extension and possible update dependencies
183 function registerExtension ($ext_name, $taskId, $isDryRun = FALSE, $ignoreUpdates = FALSE, $previousExtension = NULL) {
184 // Set current extension name
185 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId=' . intval($taskId) . ',isDryRun=' . intval($isDryRun) . ',ignoreUpdates=' . intval($ignoreUpdates) . ' - ENTERED!');
186 setCurrentExtensionName($ext_name);
189 enableExtensionDryRun($isDryRun);
191 // By default all extensions are in productive phase
192 enableExtensionProductive();
194 // This shall never do a non-admin user or if the extension is active (already installed)
195 if (((!isAdmin()) && (!isInstallationPhase())) || (isExtensionInstalled($ext_name))) {
196 // Abort here with 'false'
197 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ABORTED: isAdmin()=' . intval(isAdmin()) . ',isInstallationPhase()=' . intval(isInstallationPhase()) . ',isExtensionInstalled()=' . intval(isExtensionInstalled($ext_name)));
201 // When this extension is already in registration/update phase, all is fine
202 if ((isExtensionRegistrationRunning($ext_name)) || ((isExtensionUpdateRunning($ext_name)) && ($ignoreUpdates === FALSE))) {
203 // Then abort here with 'true' becaus it is fine
204 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in registration/update phase, all fine,taskId=' . $taskId . ',isDryRun=' . intval($isDryRun) . ',ignoreUpdates=' . intval($ignoreUpdates));
205 //* BUG: */ reportBug(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId=' . $taskId . ',isDryRun=' . intval($isDryRun) . ',ignoreUpdates=' . intval($ignoreUpdates) . ' - Please investigate!');
209 // This registration is running
210 addExtensionRunningRegistration($ext_name);
212 // Init EXT_UPDATE_DEPENDS if not yet done
213 if (!isExtensionUpdateDependenciesInitialized()) {
215 initExtensionUpdateDependencies();
218 // Is the task id zero? Then we need to auto-fix it here
219 if (((is_null($taskId)) || ($taskId == '0')) && (!isInstallationPhase())) {
220 // Try to find the task
221 $taskId = determineExtensionTaskId(getCurrentExtensionName());
223 // Still zero and not in dry-run?
224 if (((is_null($taskId)) || ($taskId == '0')) && (!isExtensionDryRun())) {
225 // Now try to create a new task
226 $taskId = createNewExtensionTask(getCurrentExtensionName());
229 if ((is_null($taskId)) || ($taskId == '0')) {
230 // Then request a bug report
231 reportBug(__FUNCTION__, __LINE__, sprintf("%s: task_id is still zero after determineExtensionTaskId/createNewExtensionTask(%s)",
233 getCurrentExtensionName()
239 // Init queries and notes
241 initExtensionNotes();
245 $processResult = FALSE;
246 initIncludePool('extension');
248 // By default we have no failures
249 enableExtensionReportingFailure();
251 // Does this extension exists?
252 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ' - CALLING loadExtension() ...');
253 if (loadExtension(getCurrentExtensionName(), 'register', '0.0.0', isExtensionDryRun(), $previousExtension)) {
254 // Set current extension name again
255 setCurrentExtensionName($ext_name);
257 // And run possible updates
258 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName());
259 $history = getExtensionVersionHistory();
260 foreach ($history as $ext_ver) {
261 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver=' . $ext_ver);
262 // Load extension in update mode
263 loadExtension(getCurrentExtensionName(), 'update', $ext_ver, isExtensionDryRun(), $previousExtension);
265 // Add update notes to our output
266 addExtensionNotes($ext_ver);
269 // Does this extension depends on an outstanding update of another update?
270 for ($dmy = getExtensionUpdateIterator(); getExtensionUpdateIterator() < countExtensionUpdateDependencies();) {
272 $ext_update = getExtensionUpdateDependenciesIterator();
274 // Increment here to avoid endless loop
275 incrementExtensionUpdateIterator();
277 // Check if extension is not installed and not already in registration procedure and if loading it wents finally fine...
278 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',isExtensionRegistrationRunning(' . $ext_update . ')=' . intval(isExtensionRegistrationRunning($ext_update)));
279 if ((!isExtensionInstalled($ext_update)) && (!isExtensionRegistrationRunning($ext_update)) && (loadExtension($ext_update, 'test', '', isExtensionDryRun(), $previousExtension))) {
280 // Set current extension name again
281 setCurrentExtensionName($ext_name);
283 // If versions mismatch update extension first
285 if (isExtensionInstalled($ext_update)) {
286 // Get version only if installed
287 $ext_ver = getExtensionVersion($ext_update);
290 // Extension version set? If empty the extension is not registered
291 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_ver[' . gettype($ext_ver) . ']=' . $ext_ver . ',isInstallationPhase()=' . intval(isInstallationPhase()) . ',currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ' - EMPTY?');
292 if (empty($ext_ver)) {
293 // Extension not registered so far so first load task's id...
294 $updateTaskId = determineExtensionTaskId($ext_update);
297 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'updateTaskId=' . $updateTaskId . ',isInstallationPhase()=' . intval(isInstallationPhase()) . ',currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ' - CHECKING!');
298 if (($updateTaskId > 0) || (isInstallationPhase())) {
299 // Try to register the extension
300 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ',updateTaskId=' . $updateTaskId . ',isExtensionDryRun()=' . intval(isExtensionDryRun()));
301 $processResult = registerExtension($ext_update, $updateTaskId, isExtensionDryRun(), TRUE, $ext_name);
303 // Reset extension name
304 setCurrentExtensionName($ext_name);
305 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ',processResult=' . intval($processResult));
307 } elseif ($ext_ver != getCurrentExtensionVersion()) {
308 // Ok, update this extension now
309 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',currVer=' . getCurrentExtensionVersion());
310 $GLOBALS['ext_backup_name'][$ext_update][$ext_ver] = getCurrentExtensionName();
311 $GLOBALS['ext_backup_ver'][$ext_update][$ext_ver] = getCurrentExtensionVersion();
312 updateExtension($ext_update, $ext_ver, isExtensionDryRun());
313 setCurrentExtensionName($GLOBALS['ext_backup_name'][$ext_update][$ext_ver]);
314 setCurrentExtensionVersion($GLOBALS['ext_backup_ver'][$ext_update][$ext_ver]);
315 unset($GLOBALS['ext_backup_name'][$ext_update][$ext_ver]);
316 unset($GLOBALS['ext_backup_ver'][$ext_update][$ext_ver]);
317 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',currVer=' . getCurrentExtensionVersion());
320 $processResult = TRUE;
322 // Nothing to register / update before...
323 $processResult = TRUE;
326 // Required file for update does not exists!
327 $processResult = TRUE;
328 // But this is fine for the first time...
331 // Restore the current extension name
332 setCurrentExtensionName($ext_name);
335 // Is there no update?
336 if (countExtensionUpdateDependencies(getCurrentExtensionName()) == 0) {
337 // Then test is passed!
338 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',processResult=true,countExtensionUpdateDependencies()=0 - Test passed!');
339 $processResult = TRUE;
342 // Switch back to register mode
343 setExtensionMode('register');
345 // Remains true if extension registration reports no failures
346 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',processResult=' . intval($processResult));
347 $processResult = (($processResult === TRUE) && (isExtensionReportingFailure() === FALSE));
348 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',processResult=' . intval($processResult));
350 // Does everthing before wents ok?
351 if ($processResult === TRUE) {
352 // "Dry-run-mode" activated?
353 if ((isExtensionDryRun() === FALSE) && (!isExtensionOnRemovalList())) {
354 // Init SQLs and transfer ext->generic
355 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName());
357 setSqlsArray(getExtensionSqls());
359 // Run installation pre-installation filters
360 runFilterChain('pre_extension_installed', array('dry_run' => isExtensionDryRun(), 'enable_codes' => FALSE));
362 // Register extension
363 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'insert=' . getCurrentExtensionName() . '/' . getCurrentExtensionVersion() . ' - INSERT!');
364 if (isExtensionInstalledAndNewer('sql_patches', '0.0.6')) {
366 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getThisExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion() . 'ext_css=' . getExtensionHasCss());
367 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_extensions` (`ext_name`, `ext_active`, `ext_version`, `ext_has_css`) VALUES ('%s','%s','%s','%s')",
369 getCurrentExtensionName(),
370 getThisExtensionAlwaysActive(),
371 getCurrentExtensionVersion(),
373 ), __FUNCTION__, __LINE__);
376 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getThisExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion());
377 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_extensions` (`ext_name`, `ext_active`, `ext_version`) VALUES ('%s','%s','%s')",
379 getCurrentExtensionName(),
380 getThisExtensionAlwaysActive(),
381 getCurrentExtensionVersion()
382 ), __FUNCTION__, __LINE__);
385 // Use the insert id as extension id and cache it for early usage
386 $GLOBALS['cache_array']['extension']['ext_id'][getCurrentExtensionName()] = SQL_INSERTID();
387 $GLOBALS['cache_array']['extension']['ext_name'][SQL_INSERTID()] = getCurrentExtensionName();
389 // Mark it as installed
390 $GLOBALS['ext_is_installed'][getCurrentExtensionName()] = TRUE;
392 // Remove cache file(s) if extension is active
393 runFilterChain('post_extension_installed', array(
394 'pool' => 'extension',
395 'ext_name' => getCurrentExtensionName(),
399 // Re-init queries and notes
400 initExtensionSqls(TRUE);
401 initExtensionNotes(TRUE);
403 // In normal mode return a true on success
405 } elseif (isExtensionDryRun() === TRUE) {
406 // In "dry-run" mode do always return a true
409 // Extension has been removed for updates, so all is fine!
413 // No, an error occurs while registering extension :-(
414 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName());
417 } elseif (($taskId > 0) && (getCurrentExtensionName() != '')) {
418 // Remove task from system when id and extension's name is valid
419 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
420 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `id`=%s AND `status`='NEW' LIMIT 1",
421 array(bigintval($taskId)), __FUNCTION__, __LINE__);
424 // @TODO This redirect is still needed to register sql_patches! Please try to avoid it
425 if (($ret === TRUE) && ($isDryRun === FALSE) && ($ext_name == 'sql_patches') && (!isInstallationPhase())) {
427 * This is a really dirty hack to prevent an error about a missing
428 * configuration entry which should be there after registration of
431 redirectToRequestUri();
434 // Return status code
435 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',currName=' . getCurrentExtensionName() . ',processResult=' . intval($processResult) . ',ret=' . intval($ret) . ' - EXIT!');
439 // Run SQL queries for given extension id
440 // @TODO Change from ext_id to ext_name (not just even the variable! ;-) )
441 function doExtensionSqls ($ext_id, $load_mode) {
442 // This shall never do a non-admin user but installation phase is okay
443 if ((!isAdmin()) && (!isInstallationPhase())) {
444 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_id=' . $ext_id. ',load_mode=' . $load_mode . ',isAdmin()=' . intval(isAdmin()) . ',isInstallationPhase()=' . intval(isInstallationPhase()) . ' - ABORT!');
448 // Get extension's name
449 $ext_name = getExtensionName($ext_id);
451 // Set current SQL name
452 setCurrentExtensionName($ext_name);
454 // Init EXT_UPDATE_DEPENDS
455 if (!isExtensionUpdateDependenciesInitialized()) {
457 initExtensionUpdateDependencies();
461 initExtensionSqls(TRUE);
463 // By default no SQL has been executed
466 // Load extension in detected mode
467 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name[' . $ext_id . ']=' . getCurrentExtensionName() . ',load_mode=' . $load_mode);
468 loadExtension(getCurrentExtensionName(), $load_mode, '0.0.0', FALSE);
472 setSqlsArray(getExtensionSqls());
475 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQLs::count=' . countSqls());
477 // Are there entries?
479 // Run SQL commands...
480 runFilterChain('run_sqls');
483 // Run any filters depending on the action here
484 runFilterChain('extension_' . $load_mode);
486 // Remove cache file(s) if extension is active
487 if (((isExtensionActive('cache')) && ((!SQL_HASZEROAFFECTED()) || ($sqlRan === TRUE) || ($load_mode == 'activate') || ($load_mode == 'deactivate')))) {
489 runFilterChain('post_extension_run_sql', getCurrentExtensionName());
492 // Is this the sql_patches?
493 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $ext_id . ',currName=' . getCurrentExtensionName() . ',loadMode=' . $load_mode);
494 if ((getCurrentExtensionName() == 'sql_patches') && (($load_mode == 'register') || ($load_mode == 'remove'))) {
495 // Then redirect to logout
496 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ': LOAD!');
497 redirectToUrl('modules.php?module=admin&logout=1&' . $load_mode . '=sql_patches');
501 // Check whether the given extension is installed
502 function isExtensionInstalled ($ext_name) {
503 // We don't like empty extension names here
504 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
505 if (empty($ext_name)) {
506 // Please fix them all
507 reportBug(__FUNCTION__, __LINE__, 'ext_name is empty.');
510 // By default non is installed
511 $isInstalled = FALSE;
513 // Check if there is a cache entry
514 if (isset($GLOBALS['ext_is_installed'][$ext_name])) {
515 // Use cache built from below queries
516 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - CACHE!');
517 $isInstalled = $GLOBALS['ext_is_installed'][$ext_name];
518 } elseif (isset($GLOBALS['cache_array']['extension']['ext_id'][$ext_name])) {
520 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - FOUND!');
524 incrementStatsEntry('cache_hits');
525 } elseif (isInstallationPhase()) {
526 // Extensions are all inactive/not installed during installation
527 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - installation phase detected.');
530 $ext_id = getExtensionId($ext_name);
532 // Is there a record?
533 $isInstalled = ($ext_id > 0);
536 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_id=' . $ext_id . ',isInstalled=' . intval($isInstalled));
538 // Is it installed, then cache the entry
539 if ($isInstalled === TRUE) {
540 // Dummy call (get is okay here)
541 getExtensionId($ext_name, TRUE);
544 // Remember the status
545 $GLOBALS['ext_is_installed'][$ext_name] = $isInstalled;
549 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',isInstalled=' . intval($isInstalled) . ' - EXIT!');
553 // Check if given extension is active
554 function isExtensionActive ($ext_name) {
555 if (isInstallationPhase()) {
556 // Extensions are all inactive during installation
557 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extensions are always inactive while installation phase. ext_name=' . $ext_name);
559 } elseif (empty($ext_name)) {
560 // Empty extension names must befixed
561 reportBug(__FUNCTION__, __LINE__, 'Empty extension name provided.');
562 } elseif (!isExtensionInstalled($ext_name)) {
563 // Not installed extensions are always inactive
564 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Not installed extensions are always inactive. ext_name=' . $ext_name);
568 // Not active is the default
569 $data['ext_active'] = 'N';
572 if (isset($GLOBALS['cache_array']['extension']['ext_active'][$ext_name])) {
574 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE! ext_name=' . $ext_name);
575 $data['ext_active'] = $GLOBALS['cache_array']['extension']['ext_active'][$ext_name];
578 incrementStatsEntry('cache_hits');
579 } elseif (isExtensionLoaded($ext_name)) {
580 // @TODO Extension is loaded, what next?
581 reportBug(__FUNCTION__, __LINE__, 'LOADED:' . $ext_name);
582 } elseif (($ext_name == 'cache') || (!isExtensionInstalled('cache'))) {
583 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DB! ext_name=' . $ext_name);
584 // Load from database
585 $result = SQL_QUERY_ESC("SELECT `ext_active` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
586 array($ext_name), __FUNCTION__, __LINE__);
589 if (SQL_NUMROWS($result) == 1) {
591 $data = SQL_FETCHARRAY($result);
595 SQL_FREERESULT($result);
598 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . '[DB]: ' . $data['ext_active']);
599 $GLOBALS['cache_array']['extension']['ext_active'][$ext_name] = $data['ext_active'];
601 // Extension not active!
602 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ': Not active!');
603 $GLOBALS['cache_array']['extension']['ext_active'][$ext_name] = 'N';
607 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',active=' . $data['ext_active']);
609 // Is this extension activated? (For admins we always have active extensions...)
610 return ($data['ext_active'] == 'Y');
613 // Get version from extensions
614 function getExtensionVersion ($ext_name, $force = FALSE) {
615 // By default no extension is found
616 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
617 $data['ext_version'] = 'false';
619 // Empty extension name should be fixed!
620 if (empty($ext_name)) {
621 // Please report this bug!
622 reportBug(__FUNCTION__, __LINE__, 'ext_name is empty which is not allowed here.');
625 // Extensions are all inactive during installation
626 if (isInstallationPhase()) {
627 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',force=' . intval($force) . ' - Installation phase detected, returning empty version.');
631 // Is the cache written?
632 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - Checking cache ...');
633 if (isset($GLOBALS['cache_array']['extension']['ext_version'][$ext_name])) {
634 // Load data from cache
635 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - CACHE!');
636 $data['ext_version'] = $GLOBALS['cache_array']['extension']['ext_version'][$ext_name];
639 incrementStatsEntry('cache_hits');
640 } elseif ((!isCacheInstanceValid()) || (isset($GLOBALS['cache_array']['extension'])) || (!isHtmlOutputMode())) {
641 // Load from database
642 $result = SQL_QUERY_ESC("SELECT `ext_version` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
643 array($ext_name), __FUNCTION__, __LINE__);
644 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ': DB - '.SQL_NUMROWS($result).'');
646 // Is the extension there?
647 if (SQL_NUMROWS($result) == 1) {
649 $data = SQL_FETCHARRAY($result);
652 $GLOBALS['cache_array']['extension']['ext_version'][$ext_name] = $data['ext_version'];
653 } elseif (isDebugModeEnabled()) {
654 // Not found, may happen while an extension is uninstalled
655 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot find extension %s in database!", $ext_name));
659 SQL_FREERESULT($result);
662 // Extension version should not be invalid
663 if (($data['ext_version'] == 'false') && ($force === FALSE)) {
664 // Please report this trouble
665 reportBug(__FUNCTION__, __LINE__, sprintf("Extension <span class=\"data\">%s</span> has empty version!", $ext_name));
669 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_version=' . $data['ext_version']);
670 return $data['ext_version'];
673 // Updates a given extension with current extension version to latest version
674 function updateExtension ($ext_name, $ext_ver, $isDryRun = FALSE, $ignoreDependencies = FALSE) {
675 // Only admins are allowed to update extensions
676 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',isDryRun=' . intval($isDryRun) . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - ENTERED!');
677 if ((!isAdmin()) || (empty($ext_name))) {
678 // Called as non-admin or empty extension
679 reportBug(__FUNCTION__, __LINE__, 'Called as non-admin (isAdmin()=' . intval(isAdmin()) . '), or empty extension name. ext_name=' . $ext_name);
682 // Set current SQL name
683 setCurrentExtensionName($ext_name);
685 // Is this extension update already running?
686 if ((isExtensionUpdateRunning($ext_name, $ignoreDependencies)) && ($isDryRun === FALSE)) {
687 // This is fine but needs logging ATM
688 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in update phase, all fine.');
689 //* BUG: */ reportBug(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in update phase, please investigate!');
695 initExtensionNotes();
696 initIncludePool('extension');
698 // Load extension in test mode
699 loadExtension($ext_name, 'test', $ext_ver, isExtensionDryRun());
701 // Save version history
702 $history = getExtensionVersionHistory();
704 // Remove old SQLs array to prevent possible bugs
707 // Check if version is updated
708 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, getCurrentExtensionName() . '/' . $ext_name . ':' . getThisExtensionVersion() . '/' . $ext_ver . '/' . intval(is_array($history)));
709 if (((getThisExtensionVersion() != $ext_ver) || (isExtensionDryRun())) && (is_array($history))) {
710 // Search for starting point (-1 for making 0.0 -> 0.0.0 switch work)
712 if ($ext_ver != '0.0') {
713 $start = array_search($ext_ver, $history);
716 // And load SQL queries in order of version history
717 for ($idx = ($start + 1); $idx < count($history); $idx++) {
718 // Set extension version
719 $GLOBALS['update_ver'][getCurrentExtensionName()] = $history[$idx];
722 loadExtension(getCurrentExtensionName(), 'update', $GLOBALS['update_ver'][getCurrentExtensionName()], isExtensionDryRun());
725 $depencies = getExtensionUpdateDependencies();
728 if (count($depencies) > 0) {
729 // Apply all extension depencies
730 foreach ($depencies as $ext_depend) {
731 // Did we already update/register this?
732 if (!isset($GLOBALS['ext_updated'][$ext_depend])) {
734 setCurrentExtensionName($ext_depend);
736 // Mark it as already updated before we update it
737 $GLOBALS['ext_updated'][$ext_depend] = TRUE;
739 // Is the extension there?
740 if (isExtensionInstalled($ext_depend)) {
741 // Update another extension first!
742 $processResult = updateExtension($ext_depend, getExtensionVersion($ext_depend), isExtensionDryRun(), TRUE);
744 // Register new extension
745 $processResult = registerExtension($ext_depend, NULL, isExtensionDryRun());
751 setCurrentExtensionName($ext_name);
753 // Set extension version here
754 setCurrentExtensionVersion($ext_ver);
758 addExtensionNotes($history[$idx]);
761 // In real-mode execute any existing includes
762 if (isExtensionDryRun() === FALSE) {
763 $GLOBALS['ext_inc_pool'][getCurrentExtensionName()] = getIncludePool('extension');
764 runFilterChain('load_includes', 'extension');
765 setIncludePool('extension', $GLOBALS['ext_inc_pool'][getCurrentExtensionName()]);
766 unset($GLOBALS['ext_inc_pool'][getCurrentExtensionName()]);
771 setSqlsArray(getExtensionSqls());
774 runFilterChain('run_sqls', array('dry_run' => isExtensionDryRun(), 'enable_codes' => FALSE));
776 if (isExtensionDryRun() === FALSE) {
777 // Run filters on success extension update
778 runFilterChain('extension_update', getCurrentExtensionName());
782 //* DEBUG: */logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',isDryRun=' . intval($isDryRun) . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - EXIT!');
785 // Output verbose SQL table for extension
786 function addExtensionVerboseSqlTable ($title = '{--ADMIN_SQLS_EXECUTED_ON_REMOVAL--}') {
790 reportBug(__FUNCTION__, __LINE__, 'title is empty.');
797 if (isVerboseSqlEnabled()) {
798 // Are there entries?
799 if (countExtensionSqls() > 0) {
803 foreach (getExtensionSqls() as $sqls) {
804 // New array format is recursive
805 foreach ($sqls as $sql) {
809 // Output command if set
811 // Prepare output for template
814 'sql' => str_replace(array('{', '}'), array('{', '}'), encodeEntities($sql))
818 $OUT .= loadTemplate('admin_extension_sql_row', TRUE, $content);
826 // Prepare content for template
832 // Load main template
833 $OUT = loadTemplate('admin_extension_sql_table', TRUE, $content);
835 // No addional SQL commands to run
836 $OUT = displayMessage('{--ADMIN_EXTENSION_VERBOSE_SQLS_404--}', TRUE);
844 // Get extension name from id
845 function getExtensionName ($ext_id) {
846 // Init extension name
847 $data['ext_name'] = '';
850 if (isset($GLOBALS['cache_array']['extension']['ext_name'][$ext_id])) {
852 $data['ext_name'] = $GLOBALS['cache_array']['extension']['ext_name'][$ext_id];
855 incrementStatsEntry('cache_hits');
856 } elseif (!isExtensionActive('cache')) {
857 // Load from database
858 $result = SQL_QUERY_ESC("SELECT `ext_name` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `id`=%s LIMIT 1",
859 array(bigintval($ext_id)), __FUNCTION__, __LINE__);
861 // Is the entry there?
862 if (SQL_NUMROWS($result) == 1) {
863 // Get the extension's name from database
864 $data = SQL_FETCHARRAY($result);
868 SQL_FREERESULT($result);
871 // Did we find some extension?
872 if (empty($data['ext_name'])) {
873 // We should fix these all!
874 reportBug(__FUNCTION__, __LINE__, 'ext_name is empty. ext_id=' . $ext_id);
877 // Return the extension name
878 return $data['ext_name'];
881 // Get extension id from name
882 function getExtensionId ($ext_name) {
884 $data['ext_id'] = '0';
887 if (isset($GLOBALS['cache_array']['extension']['ext_id'][$ext_name])) {
889 $data['ext_id'] = $GLOBALS['cache_array']['extension']['ext_id'][$ext_name];
892 incrementStatsEntry('cache_hits');
894 // Load from database
895 $result = SQL_QUERY_ESC("SELECT `id` AS `ext_id` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
896 array($ext_name), __FUNCTION__, __LINE__);
898 // Is the entry there?
899 if (SQL_NUMROWS($result) == 1) {
900 // Get the extension's id from database
901 $data = SQL_FETCHARRAY($result);
905 SQL_FREERESULT($result);
908 $GLOBALS['cache_array']['extension']['ext_id'][$ext_name] = $data['ext_id'];
912 return $data['ext_id'];
915 // Determines whether the given extension name is valid
916 function isExtensionNameValid ($ext_name) {
918 if (!isset($GLOBALS['ext_name_valid'][$ext_name])) {
919 // Generate include file name
920 $INC = sprintf("inc/extensions/ext-%s.php", $ext_name);
922 // Is there a file in inc/extensions/ ?
923 $GLOBALS['ext_name_valid'][$ext_name] = isIncludeReadable($INC);
927 return $GLOBALS['ext_name_valid'][$ext_name];
930 // Determines whether the given extension id is valid
931 function isExtensionIdValid ($ext_id) {
932 // Default is nothing valid
935 // Check in cache then in database
936 if (isset($GLOBALS['cache_array']['extension']['ext_name'][$ext_id])) {
941 incrementStatsEntry('cache_hits');
944 $isValid = (countSumTotalData($ext_id, 'extensions', 'id', 'id', TRUE) == 1);
951 // Activate given extension
952 function doActivateExtension ($ext_name) {
953 // Is the extension installed?
954 if (!isExtensionInstalled($ext_name)) {
955 // Non-installed extensions cannot be activated
956 reportBug(__FUNCTION__, __LINE__, 'Tried to activate non-installed extension ' . $ext_name);
959 // Activate the extension
960 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_active`='Y' WHERE `ext_name`='%s' LIMIT 1",
961 array($ext_name), __FUNCTION__, __LINE__);
963 // Then run all queries
964 doExtensionSqls(getExtensionId($ext_name), 'activate');
967 // Deactivate given extension
968 function doDeactivateExtension ($ext_name, $inRebuild = FALSE) {
969 // Is the extension installed?
970 if (!isExtensionInstalled($ext_name)) {
971 // Non-installed extensions cannot be activated
972 reportBug(__FUNCTION__, __LINE__, 'Tried to deactivate non-installed extension ' . $ext_name . ',getExtensionMode()=' . getExtensionMode());
975 // Activate the extension
976 SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_active`='N' WHERE `ext_name`='%s' LIMIT 1",
977 array($ext_name), __FUNCTION__, __LINE__);
979 // Then run all queries
980 doExtensionSqls(getExtensionId($ext_name), 'deactivate');
982 // Create new task (we ignore the task id here)
983 createExtensionDeactivationTask($ext_name);
985 // Do not rebuild cache if it is already been rebuild
986 if ($inRebuild === FALSE) {
988 rebuildCache('extension', 'extension');
992 sendAdminNotification(
993 '{--ADMIN_EXTENSION_DEACTIVATED_SUBJECT--}',
994 'admin_extension_deactivated',
995 array('ext_name' => $ext_name)
999 // Creates a new task for updated extension
1000 function createExtensionUpdateTask ($adminId, $ext_name, $ext_ver, $notes) {
1001 // Create subject line
1002 $subject = '[UPDATE-' . $ext_name . '-' . $ext_ver . ':] {--ADMIN_UPDATE_EXTENSION_SUBJECT--}';
1005 $taskId = determineTaskIdBySubject($subject);
1007 // Is the extension there?
1008 if (isExtensionInstalled($ext_name)) {
1009 // Check if task is not there
1010 if ($taskId == '0') {
1011 // Create extension update-task
1012 $taskId = createNewTask($subject, $notes, 'EXTENSION_UPDATE', 0, $adminId);
1015 // Extension not there! :-(
1016 reportBug(__FUNCTION__, __LINE__, sprintf("Extension <span class=\"data\">%s</span> not found but should be updated?", $ext_name));
1023 // Creates a new task for newly installed extension
1024 function createNewExtensionTask ($ext_name) {
1025 // Generate subject line
1026 $subject = sprintf("[%s:]", $ext_name);
1029 $taskId = determineTaskIdBySubject($subject);
1031 // Not installed and do we have created a task for the admin?
1032 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId[' . gettype($taskId) . ']=' . $taskId);
1033 if (((is_null($taskId)) || ($taskId == '0')) && (!isExtensionInstalled($ext_name))) {
1034 // Set default message if ext-foo is missing
1035 $message = '{%message,ADMIN_EXTENSION_TEXT_FILE_MISSING=' . $ext_name . '%}';
1038 $FQFN = sprintf("%stemplates/%s/html/ext/ext_%s.tpl",
1044 // Load text for task if found
1045 if (isFileReadable($FQFN)) {
1046 // Load extension's description template (but do not compile the code)
1047 $message = loadTemplate('ext_' . $ext_name, TRUE, array(), FALSE);
1049 // Write this in debug.log as well
1050 logDebugMessage(__FUNCTION__, __LINE__, $message);
1053 // Task not created so it's a brand-new extension which we need to register and create a task for!
1054 $taskId = createNewTask($subject, $message, 'EXTENSION', 0, getCurrentAdminId(), FALSE);
1061 // Creates a task for automatically deactivated (deprecated) extension
1062 function createExtensionDeactivationTask ($ext_name) {
1063 // Create subject line
1064 $subject = sprintf("[%s:] %s", $ext_name, '{--ADMIN_TASK_EXTENSION_DEACTIVATED_SUBJECT--}');
1067 $taskId = determineTaskIdBySubject($subject);
1069 // Not installed and do we have created a task for the admin?
1070 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId[' . gettype($taskId) . ']=' . $taskId);
1071 if (((is_null($taskId)) || ($taskId == '0')) && (isExtensionInstalled($ext_name))) {
1072 // Task not created so add it
1073 $taskId = createNewTask($subject, SQL_ESCAPE(loadTemplate('task_EXTENSION_deactivated', TRUE, $ext_name)), 'EXTENSION_DEACTIVATION');
1080 // Determines the task id for given extension
1081 function determineExtensionTaskId ($ext_name) {
1082 // Is it installation phase and table task_system is not found?
1083 if ((isInstallationPhase()) && (!ifSqlTableExists('task_system'))) {
1084 // Then return NULL (not found)
1088 // Default is not found
1089 $data['task_id'] = NULL;
1091 // Search for extension task's id
1092 $result = SQL_QUERY_ESC("SELECT `id` AS task_id FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `task_type`='EXTENSION' AND `subject`='[%s:]' LIMIT 1",
1093 array($ext_name), __FUNCTION__, __LINE__);
1096 if (SQL_NUMROWS($result) == 1) {
1097 // Task found so load task's id and register extension...
1098 $data = SQL_FETCHARRAY($result);
1102 SQL_FREERESULT($result);
1105 return $data['task_id'];
1108 // Determines the task id for given subject
1109 function determineTaskIdBySubject ($subject) {
1110 // Default is not found
1111 $data['task_id'] = '0';
1113 // Search for task id
1114 $result = SQL_QUERY_ESC("SELECT `id` AS task_id FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `subject` LIKE '%s%%' LIMIT 1",
1115 array($subject), __FUNCTION__, __LINE__);
1118 if (SQL_NUMROWS($result) == 1) {
1119 // Task found so load task's id and register extension...
1120 $data = SQL_FETCHARRAY($result);
1124 SQL_FREERESULT($result);
1127 return $data['task_id'];
1130 // Add updates notes for given version
1131 function addExtensionNotes ($ext_ver) {
1132 // Init notes/content
1136 // Is do we have verbose output enabled?
1137 if ((!isExtensionActive('sql_patches')) || (isVerboseSqlEnabled())) {
1138 // Update notes found?
1139 if ((isExtensionUpdateNoteSet($ext_ver)) && ($ext_ver != '0.0.0')) {
1140 // Update notes found
1143 'notes' => getExtensionUpdateNotes($ext_ver)
1147 setExtensionUpdateNotes('', $ext_ver);
1148 } elseif ($ext_ver == '0.0.0') {
1149 // Is the extension productive?
1150 if (isExtensionProductive(getCurrentExtensionName())) {
1154 'notes' => '{--ADMIN_EXTENSION_INITIAL_RELEASE--}'
1160 'notes' => '{--ADMIN_EXTENSION_DEVELOPER_RELEASE--}'
1164 // No update notes found
1167 'notes' => '{--ADMIN_EXTENSION_UPDATE_NOTICES_404--}'
1172 $out = loadTemplate('admin_extension_notes', TRUE, $content);
1176 appendExtensionNotes($out);
1179 // Getter for CSS files array
1180 function getExtensionCssFiles () {
1181 // By default no additional CSS files are found
1182 $cssFiles = array();
1184 // Is the array there?
1185 if (isset($GLOBALS['css_files'])) {
1187 $cssFiles = $GLOBALS['css_files'];
1194 // Init CSS files array
1195 function initExtensionCssFiles () {
1197 $GLOBALS['css_files'] = array();
1201 function addExtensionCssFile ($file) {
1202 // Is the array there?
1203 if (!isset($GLOBALS['css_files'])) {
1204 // Then auto-init them
1205 initExtensionCssFiles();
1209 array_push($GLOBALS['css_files'], $file);
1212 // Setter for EXT_ALWAYS_ACTIVE flag
1213 function setExtensionAlwaysActive ($active) {
1214 $GLOBALS['ext_always_active'][getCurrentExtensionName()] = (string) $active;
1217 // Getter for EXT_ALWAYS_ACTIVE flag
1218 function getThisExtensionAlwaysActive () {
1219 return $GLOBALS['ext_always_active'][getCurrentExtensionName()];
1222 // Checks whether the current extension is always active
1223 function isThisExtensionAlwaysActive () {
1224 return (getThisExtensionAlwaysActive() == 'Y');
1227 // Setter for EXT_VERSION flag
1228 function setThisExtensionVersion ($ext_version) {
1229 $GLOBALS['ext_version'][getCurrentExtensionName()] = (string) $ext_version;
1232 // Getter for EXT_VERSION flag
1233 function getThisExtensionVersion () {
1234 return $GLOBALS['ext_version'][getCurrentExtensionName()];
1237 // Setter for EXT_DEPRECATED flag
1238 function setExtensionDeprecated ($deprecated) {
1239 $GLOBALS['ext_deprecated'][getCurrentExtensionName()] = (string) $deprecated;
1242 // Getter for EXT_DEPRECATED flag
1243 function isExtensionDeprecated ($ext_name = NULL) {
1244 // Default is from current (NULL) extension
1245 $isDeprecated = ($GLOBALS['ext_deprecated'][getCurrentExtensionName()] == 'Y');
1248 if (!is_null($ext_name)) {
1249 // Then use it instead
1250 $isDeprecated = ((isset($GLOBALS['ext_deprecated'][$ext_name])) && ($GLOBALS['ext_deprecated'][$ext_name] == 'Y'));
1254 return $isDeprecated;
1257 // Setter for EXT_UPDATE_DEPENDS flag
1258 function addExtensionDependency ($updateDepends) {
1259 // Is the update depency empty? (NEED TO BE FIXED!)
1260 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ',extensionMode=' . getExtensionMode() . ' - ENTERED!');
1261 if (empty($updateDepends)) {
1262 // Please report this bug!
1263 reportBug(__FUNCTION__, __LINE__, 'updateDepends is empty: currentExtension=' . getCurrentExtensionName());
1266 // Is it not yet added?
1267 if ((isset($updateDepends, $GLOBALS['ext_running_updates'][getCurrentExtensionName()])) && (in_array($updateDepends, getExtensionUpdatesRunning()))) {
1269 * Double-adding happens when the extension and an update of the same
1270 * extension requires the same other extension again.
1272 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'updateDepends=' . $updateDepends . ',extensionMode=' . getExtensionMode() . ',currentExtension=' . getCurrentExtensionName() . ' - called twice.');
1276 // Add it to the list of extension update depencies map
1277 array_push($GLOBALS['ext_update_depends'][getCurrentExtensionName()], $updateDepends);
1280 if ((!isset($GLOBALS['ext_running_updates'][getCurrentExtensionName()])) || (!is_array($GLOBALS['ext_running_updates'][getCurrentExtensionName()]))) {
1281 $GLOBALS['ext_running_updates'][getCurrentExtensionName()] = array();
1284 // Remember it in the list of running updates
1285 array_push($GLOBALS['ext_running_updates'][getCurrentExtensionName()], $updateDepends);
1286 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ',extensionMode=' . getExtensionMode() . ' - EXIT!');
1289 // Getter for running updates
1290 function getExtensionUpdatesRunning () {
1291 return $GLOBALS['ext_running_updates'][getCurrentExtensionName()];
1294 // Checks whether the given extension registration is in progress
1295 function isExtensionRegistrationRunning ($ext_name) {
1297 $isRunning = ((isset($GLOBALS['ext_register_running'])) && (in_array($ext_name, $GLOBALS['ext_register_running'])));
1300 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ', isRunning=' . intval($isRunning));
1304 // Init EXT_UPDATE_DEPENDS flag
1305 function initExtensionUpdateDependencies () {
1306 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ' - ENTERED!');
1308 // Init update depency map automatically if not found
1309 if (isExtensionUpdateDependenciesInitialized()) {
1310 // We need these bug reports as well...
1311 reportBug(__FUNCTION__, __LINE__, '() is called twice: currName=' . getCurrentExtensionName());
1314 $GLOBALS['ext_update_depends'][getCurrentExtensionName()] = array();
1316 // Init running updates array
1317 initExtensionRuningUpdates();
1319 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ' - EXIT!');
1322 // Adds an extension as "registration in progress"
1323 function addExtensionRunningRegistration ($ext_name) {
1325 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Registration in progress: ext_name=' . $ext_name . ' - ENTERED!');
1326 if (isExtensionRegistrationRunning($ext_name)) {
1327 // This is really bad and should not be quietly ignored
1328 reportBug(__FUNCTION__, __LINE__, '() already called! ext_name=' . $ext_name);
1332 array_push($GLOBALS['ext_register_running'], $ext_name);
1333 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Registration in progress: ext_name=' . $ext_name . ' - EXIT!');
1336 // Checks whether EXT_UPDATE_DEPENDS is initialized
1337 function isExtensionUpdateDependenciesInitialized () {
1338 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
1339 return (isset($GLOBALS['ext_update_depends'][getCurrentExtensionName()]));
1342 // Checks whether an update is already running for given extension
1343 function isExtensionUpdateRunning ($ext_name, $ignoreDependencies = FALSE) {
1344 // Current and given extensions means whole array
1345 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - ENTERED!');
1346 if ($ext_name == getCurrentExtensionName()) {
1347 // Default is not found
1350 // Walk through whole array
1351 foreach ($GLOBALS['ext_running_updates'] as $ext1 => $depends) {
1353 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',depends=' . print_r($depends, TRUE));
1354 if (($ext1 == $ext_name) || ((in_array($ext_name, $depends)) && ($ignoreDependencies === FALSE))) {
1357 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',isRunning=true - FOUND!');
1363 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ',ignoreDependencies=' . intval($ignoreDependencies) . ', isRunning=' . intval($isRunning) . ' - ALT-EXIT!');
1368 $isRunning = ((isExtensionUpdateDependenciesInitialized()) && (in_array($ext_name, getExtensionRunningUpdates())));
1371 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ',ignoreDependencies=' . intval($ignoreDependencies) . ', isRunning=' . intval($isRunning) . ' - EXIT!');
1375 // Initializes the list of running updates
1376 function initExtensionRuningUpdates () {
1377 // Auto-init ext_running_updates
1378 if (!isset($GLOBALS['ext_running_updates'])) {
1379 $GLOBALS['ext_running_updates'] = array();
1380 $GLOBALS['ext_register_running'] = array();
1384 // Getter for EXT_UPDATE_DEPENDS flag
1385 function getExtensionUpdateDependencies () {
1386 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
1387 return $GLOBALS['ext_update_depends'][getCurrentExtensionName()];
1390 // Getter for next iterator depency
1391 function getExtensionUpdateDependenciesIterator () {
1392 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
1393 return ($GLOBALS['ext_update_depends'][getCurrentExtensionName()][getExtensionUpdateIterator()]);
1396 // Counter for extension update depencies
1397 function countExtensionUpdateDependencies () {
1398 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '=' . count($GLOBALS['ext_update_depends'][getCurrentExtensionName()]));
1399 return count($GLOBALS['ext_update_depends'][getCurrentExtensionName()]);
1402 // Removes given extension from update denpency list
1403 function removeExtensionDependency ($ext_name) {
1405 $key = array_search($ext_name, getExtensionUpdateDependencies());
1408 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',key[' . gettype($key) . ']=' . $key);
1411 if ($key !== FALSE) {
1413 unset($GLOBALS['ext_update_depends'][getCurrentExtensionName()][$key]);
1415 // And sort the array
1416 ksort($GLOBALS['ext_update_depends'][getCurrentExtensionName()]);
1420 // Init iterator for update depencies
1421 function initExtensionUpdateIterator () {
1422 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
1423 $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()] = '0';
1426 // Getter for depency iterator
1427 function getExtensionUpdateIterator () {
1428 // Auto-init iterator
1429 if (!isset($GLOBALS['ext_depend_iterator'][getCurrentExtensionName()])) {
1430 // Initialize update iterator
1431 initExtensionUpdateIterator();
1435 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '=' . $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()]);
1436 return $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()];
1439 // Increments the update iterator
1440 function incrementExtensionUpdateIterator () {
1441 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
1442 $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()]++;
1445 // Setter for EXT_REPORTS_FAILURE flag
1446 function enableExtensionReportingFailure ($reportsFailure = FALSE) {
1447 $GLOBALS['ext_reports_failure'] = (bool) $reportsFailure;
1450 // Getter for EXT_REPORTS_FAILURE flag
1451 function isExtensionReportingFailure () {
1452 return $GLOBALS['ext_reports_failure'];
1455 // Setter for EXT_VER_HISTORY flag
1456 function setExtensionVersionHistory ($versionHistory) {
1457 $GLOBALS['ext_ver_history'][getCurrentExtensionName()] = (array) $versionHistory;
1460 // Getter for EXT_VER_HISTORY array
1461 function getExtensionVersionHistory () {
1463 if (!isset($GLOBALS['ext_ver_history'][getCurrentExtensionName()])) {
1464 // Then abort here to a avoid an ugly "Undefined index" error
1465 reportBug(__FUNCTION__, __LINE__, 'Extension ext-' . getCurrentExtensionName() . ' has no history set! Is this extension empty?');
1468 // Return the history
1469 return $GLOBALS['ext_ver_history'][getCurrentExtensionName()];
1472 // Setter for EXT_UPDATE_NOTICES
1473 function setExtensionUpdateNotes ($updateNotes, $ext_ver = '') {
1475 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()=' . getCurrentExtensionName() . ',getExtensionMode()=' . getExtensionMode() . ',ext_ver=' . $ext_ver . '/' . getCurrentExtensionVersion() . ',updateNotes(length)=' . strlen($updateNotes));
1476 if (empty($ext_ver)) {
1477 $GLOBALS['ext_update_notes'][getCurrentExtensionName()][getCurrentExtensionVersion()] = (string) $updateNotes;
1479 $GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ext_ver] = (string) $updateNotes;
1483 // Getter for EXT_UPDATE_NOTICES
1484 function getExtensionUpdateNotes ($ext_ver) {
1485 return $GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ext_ver];
1488 // Checks if ext_update_notes is set
1489 function isExtensionUpdateNoteSet ($ext_ver) {
1490 return isset($GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ext_ver]);
1493 // Init extension notice
1494 function initExtensionNotes ($force = FALSE) {
1495 // Is it already initialized?
1496 if (($force === FALSE) && (isset($GLOBALS['ext_notes'][getCurrentExtensionName()]))) {
1497 // This is mostly not wanted, so please report it
1498 reportBug(__FUNCTION__, __LINE__, 'ext_notes already set for extension ' . getCurrentExtensionName());
1501 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()=' . getCurrentExtensionName());
1502 $GLOBALS['ext_notes'][getCurrentExtensionName()] = '';
1505 // Append extension notice
1506 function appendExtensionNotes ($notes) {
1507 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()=' . getCurrentExtensionName() . ', notes(length)=' . strlen($notes));
1508 $GLOBALS['ext_notes'][getCurrentExtensionName()] .= (string) trim($notes);
1511 // Getter for extension notes
1512 function getExtensionNotes () {
1513 return $GLOBALS['ext_notes'][getCurrentExtensionName()];
1516 // Setter for current extension name
1517 function setCurrentExtensionName ($ext_name) {
1518 $GLOBALS['curr_extension_name'] = (string) trim($ext_name);
1521 // Getter for current extension name
1522 function getCurrentExtensionName () {
1523 if (!isset($GLOBALS['curr_extension_name'])) {
1525 reportBug(__FUNCTION__, __LINE__, 'curr_extension_name not initialized. Please execute initExtensionSqls() before calling this function.');
1529 return $GLOBALS['curr_extension_name'];
1532 // Init SQLs array for current extension
1533 function initExtensionSqls ($force = FALSE) {
1534 // Auto-init the array or if forced
1535 if (($force === TRUE) || (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()]))) {
1537 $GLOBALS['ext_sqls'][getCurrentExtensionName()] = array();
1539 // Initialize the generic array
1544 // Adds SQLs to the SQLs array but "assigns" it with current extension name
1545 function addExtensionSql ($sql) {
1546 // Is is the array there?
1547 if ((!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()])) || (!is_array($GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()]))) {
1549 $GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()] = array();
1552 // Is the SQL statement empty?
1555 * Abort here as this may happen if getExtensionMode() is 'activate' or
1556 * 'deactivate'. This means that for 'mode' are no SQL statements
1563 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',ext_version=' . getCurrentExtensionVersion() . ',sql=' . $sql);
1564 array_push($GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()], $sql);
1567 // Getter for SQLs array for current extension
1568 function getExtensionSqls () {
1569 // Output debug backtrace if not found (SHOULD NOT HAPPEN!)
1570 if (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()])) {
1571 // Not found, should not happen
1572 reportBug(__FUNCTION__, __LINE__, sprintf("ext_sqls is empty, current extension: %s",
1573 getCurrentExtensionName()
1578 return $GLOBALS['ext_sqls'][getCurrentExtensionName()];
1581 // Count SQLs for current extension
1582 function countExtensionSqls () {
1583 // Output debug backtrace if not found (SHOULD NOT HAPPEN!)
1584 if (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()])) {
1585 // Not found, should not happen
1586 reportBug(__FUNCTION__, __LINE__, sprintf("ext_sqls is empty, current extension: %s",
1587 getCurrentExtensionName()
1592 return count($GLOBALS['ext_sqls'][getCurrentExtensionName()]);
1595 // Removes SQLs for current extension
1596 function unsetExtensionSqls () {
1597 unset($GLOBALS['ext_sqls'][getCurrentExtensionName()]);
1600 // Auto-initializes the removal list
1601 function initExtensionRemovalList () {
1602 // Is the remove list there?
1603 if (!isset($GLOBALS['ext_update_remove'])) {
1605 $GLOBALS['ext_update_remove'] = array();
1609 // Checks whether the current extension is on the removal list
1610 function isExtensionOnRemovalList () {
1611 // Init removal list
1612 initExtensionRemovalList();
1615 return (in_array(getCurrentExtensionName(), $GLOBALS['ext_update_remove']));
1618 // Adds the current extension to the removal list
1619 function addCurrentExtensionToRemovalList () {
1621 array_push($GLOBALS['ext_update_remove'], getCurrentExtensionName());
1624 // Getter for removal list
1625 function getExtensionRemovalList () {
1626 // Return the removal list
1627 return $GLOBALS['ext_update_remove'];
1630 // Redirects if the provided extension is not installed
1631 function redirectOnUninstalledExtension ($ext_name) {
1632 // So is the extension there?
1633 if ((!isExtensionInstalled($ext_name)) || (!isExtensionActive($ext_name))) {
1634 // Redirect to index
1635 redirectToUrl('modules.php?module=index&code=' . getCode('EXTENSION_PROBLEM') . '&ext=' . $ext_name);
1639 // Filter for initialization of all extensions by loading them in 'init' mode
1640 function FILTER_INIT_EXTENSIONS () {
1641 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTERED!');
1642 // Init notification pool
1643 initIncludePool('notify');
1645 // Are there some entries?
1646 if (isset($GLOBALS['cache_array']['extension']['ext_name'])) {
1647 // Load all found extensions if found
1648 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - START!');
1649 foreach ($GLOBALS['cache_array']['extension']['ext_name'] as $key => $ext_name) {
1651 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - START');
1652 loadExtension($ext_name, 'init', getExtensionVersion($ext_name));
1653 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - END');
1655 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - END!');
1658 // Run any notifications
1659 runFilterChain('load_includes', 'notify');
1661 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'EXIT!');
1664 // Setter for extension mode
1665 function setExtensionMode ($ext_mode) {
1666 $GLOBALS['ext_mode'] = (string) $ext_mode;
1669 // Getter for extension mode
1670 function getExtensionMode () {
1671 return $GLOBALS['ext_mode'];
1674 // Setter for dry-run
1675 function enableExtensionDryRun ($isDryRun = TRUE) {
1676 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()='.getCurrentExtensionName().',isDryRun='.intval($isDryRun));
1677 $GLOBALS['ext_isDryRun'] = (bool) $isDryRun;
1680 // Getter for dry-run
1681 function isExtensionDryRun () {
1682 return $GLOBALS['ext_isDryRun'];
1685 // Setter for current extension version
1686 function setCurrentExtensionVersion ($ext_ver) {
1687 // ext_ver should never be empty in other modes than 'test'
1688 if ((empty($ext_ver)) && (getExtensionMode() != 'test')) {
1689 // Please report all these messages
1690 reportBug(__FUNCTION__, __LINE__, 'ext_ver is empty. Current extension name: ' . getCurrentExtensionName() . ', mode=' . getExtensionMode());
1694 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver[' . gettype($ext_ver) . ']=' . $ext_ver);
1695 $GLOBALS['ext_current_version'][getCurrentExtensionName()] = (string) $ext_ver;
1698 // Getter for current extension version
1699 function getCurrentExtensionVersion () {
1700 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver=' . $GLOBALS['ext_current_version'][getCurrentExtensionName()]);
1701 return $GLOBALS['ext_current_version'][getCurrentExtensionName()];
1704 // Remove the extension from cache array
1705 function removeExtensionFromArray () {
1706 // "Cache" this name
1707 $ext_name = getCurrentExtensionName();
1709 // Now loop through the whole cache
1710 foreach ($GLOBALS['cache_array']['extension'] as $cacheName => $cacheArray) {
1711 // Is it an element?
1712 if (isset($cacheArray[$ext_name])) {
1714 unset($cacheArray[$ext_name]);
1715 $GLOBALS['cache_array']['extension'][$cacheName] = $cacheArray;
1718 $key = array_search($ext_name, $cacheArray);
1721 if ($key !== FALSE) {
1722 // Found, so remove it
1723 unset($cacheArray[$key]);
1724 $GLOBALS['cache_array']['extension'][$cacheName] = $cacheArray;
1729 // Remove from other caches as well
1730 unset($GLOBALS['ext_is_installed'][$ext_name]);
1731 unset($GLOBALS['loaded_extension'][$ext_name]);
1734 // "Getter" for 'extension has a CSS file' (with same name, of course)
1735 function getExtensionHasCss () {
1737 if (!isset($GLOBALS[__FUNCTION__][getCurrentExtensionName()][getCurrentTheme()])) {
1738 // Construct FQFN for check
1739 $FQFN = sprintf("%stheme/%s/css/%s.css",
1742 getCurrentExtensionName()
1746 $GLOBALS[__FUNCTION__][getCurrentExtensionName()][getCurrentTheme()] = convertBooleanToYesNo(isFileReadable($FQFN));
1750 return $GLOBALS[__FUNCTION__][getCurrentExtensionName()][getCurrentTheme()];
1753 // Checks whether the given extension has a language file
1754 function ifExtensionHasLanguageFile ($ext_name) {
1756 if (isset($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name])) {
1758 incrementStatsEntry('cache_hits');
1760 // Determine it and put it in cache
1761 $GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] = convertBooleanToYesNo(isLanguageIncludeReadable($ext_name));
1765 return ($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] == 'Y');
1768 // Load current extension's include file
1769 function loadCurrentExtensionInclude () {
1771 if (!isExtensionIncludeReadable()) {
1773 reportBug(__FUNCTION__, __LINE__, 'Extension ' . getCurrentExtensionName() . ' should be loaded, but is not readable.');
1776 // Generate INC name
1777 $INC = sprintf("inc/extensions/ext-%s.php", getCurrentExtensionName());
1783 // Checks whether an extension is readable
1784 function isExtensionIncludeReadable ($ext_name = '') {
1785 // If empty, use current
1786 if (empty($ext_name)) {
1787 $ext_name = getCurrentExtensionName();
1791 if (!isset($GLOBALS['ext_inc_readable'][$ext_name])) {
1792 // Generate INC name
1793 $INC = sprintf("inc/extensions/ext-%s.php", getCurrentExtensionName());
1796 $GLOBALS['ext_inc_readable'][$ext_name] = isIncludeReadable($INC);
1800 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',realable='.intval($GLOBALS['ext_inc_readable'][$ext_name]));
1801 return $GLOBALS['ext_inc_readable'][$ext_name];
1804 // Checks if an extension's function file is readable
1805 function isExtensionFunctionFileReadable ($ext_name) {
1807 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name);
1808 if (isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name])) {
1809 // Just count cache hits
1810 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_func=' . $GLOBALS['cache_array']['extension']['ext_func'][$ext_name] .' - CACHE!');
1811 incrementStatsEntry('cache_hits');
1813 // Construct IFN for functions file
1814 $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
1816 // Is this include there?
1817 $isIncludeFound = ((isFileReadable($funcsInclude)) && (!isExtensionLibraryLoaded($ext_name)) && (getExtensionMode() == 'test'));
1819 // And put in cache, converted
1820 $GLOBALS['cache_array']['extension']['ext_func'][$ext_name] = convertBooleanToYesNo($isIncludeFound);
1824 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_func=' . $GLOBALS['cache_array']['extension']['ext_func'][$ext_name]);
1825 return ($GLOBALS['cache_array']['extension']['ext_func'][$ext_name] == 'Y');
1828 // Adds a CREATE TABLE statement if the requested table is not there
1829 function addCreateTableSql ($tableName, $sql, $comment) {
1830 // Is the table not there?
1831 if (!ifSqlTableExists($tableName)) {
1832 // Is not found, so add it
1833 addExtensionSql('CREATE TABLE
1834 `{?_MYSQL_PREFIX?}_' . $tableName . '` (' . $sql . ')
1835 ENGINE = {?_TABLE_TYPE?}
1837 COLLATE utf8_general_ci
1838 COMMENT ' . chr(39) . $comment . chr(39));
1840 // Is already there, which should not happen
1841 reportBug(__FUNCTION__, __LINE__, 'The table ' . $tableName . ' is already created which should not happen.');
1845 // Adds a DROP TABLE statement if the requested tabled is there
1846 function addDropTableSql ($tableName) {
1847 // Is the table there?
1848 if (ifSqlTableExists($tableName)) {
1849 // Then add it, non-existing tables can be ignored because it will
1850 // happen with every newly installed extension.
1851 addExtensionSql('DROP TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '`');
1854 $GLOBALS['ifSqlTableExists'][$tableName] = FALSE;
1858 // Adds a RENAME TABLE stament if 'from' table exist and 'to' table not
1859 function addRenameTableSql ($fromTable, $toTable) {
1860 // Is renaming required?
1861 if ((ifSqlTableExists($fromTable)) && (!ifSqlTableExists($toTable))) {
1863 addExtensionSql('RENAME TABLE `{?_MYSQL_PREFIX?}_' . $fromTable . '` TO `{?_MYSQL_PREFIX?}_' . $toTable . '`');
1866 $GLOBALS['ifSqlTableExists'][$fromTable] = FALSE;
1867 $GLOBALS['ifSqlTableExists'][$toTable] = TRUE;
1871 // Adds an admin menu to the SQL queue of the menu entry is not found
1872 function addAdminMenuSql ($action, $what, $title, $descr, $sort) {
1873 // Now check if this menu is there
1874 if (!isMenuActionValid('admin', $action, $what)) {
1876 if (is_null($what)) {
1878 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_admin_menu` (`action`, `what`, `title`, `descr`, `sort`) VALUES ('%s',NULL,'%s','%s',%s)",
1886 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_admin_menu` (`action`, `what`, `title`, `descr`, `sort`) VALUES ('%s','%s','%s','%s',%s)",
1895 // Add it to the queue
1896 addExtensionSql($sql);
1897 } elseif (isDebugModeEnabled()) {
1898 // Double menus should be located and fixed!
1899 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double admin menu action=%s,what=%s,title=%s detected.", $action, $what, $title));
1903 // Adds a guest menu to the SQL queue if the menu entry is not found
1904 function addGuestMenuSql ($action, $what, $title, $sort) {
1905 // Now check if this menu is there
1906 if (!isMenuActionValid('guest', $action, $what)) {
1908 if (is_null($what)) {
1910 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_guest_menu` (`action`, `what`, `title`, `visible`, `locked`, `sort`) VALUES ('%s',NULL,'%s','N','Y',%s)",
1917 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_guest_menu` (`action`, `what`, `title`, `visible`, `locked`, `sort`) VALUES ('%s','%s','%s','N','Y',%s)",
1925 // Add it to the queue
1926 addExtensionSql($sql);
1927 } elseif (isDebugModeEnabled()) {
1928 // Double menus should be located and fixed!
1929 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double guest menu action=%s,what=%s,title=%s detected.", $action, $what, $title));
1933 // Adds a member menu to the SQL queue if the menu entry is not found
1934 function addMemberMenuSql ($action, $what, $title, $sort) {
1935 // Now check if this menu is there
1936 if (!isMenuActionValid('member', $action, $what)) {
1938 if (is_null($what)) {
1940 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_member_menu` (`action`, `what`, `title`, `visible`, `locked`, `sort`) VALUES ('%s',NULL,'%s','N','Y',%s)",
1947 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_member_menu` (`action`, `what`, `title`, `visible`, `locked`, `sort`) VALUES ('%s','%s','%s','N','Y',%s)",
1955 // Add it to the queue
1956 addExtensionSql($sql);
1957 } elseif (isDebugModeEnabled()) {
1958 // Double menus should be located and fixed!
1959 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double member menu action=%s,what=%s,title=%s detected.", $action, $what, $title));
1963 // Adds a sponsor menu to the SQL queue if the menu entry is not found
1964 function addSponsorMenuSql ($action, $what, $title, $active, $sort) {
1965 // Now check if this menu is there, if no ext-sponsor is installed all is not yet added
1966 if ((!isExtensionInstalled('sponsor')) || (!isMenuActionValid('sponsor', $action, $what))) {
1968 if (is_null($what)) {
1970 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_menu` (`action`, `what`, `title`, `active`, `sort`) VALUES ('%s',NULL,'%s','%s',%s)",
1978 $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_menu` (`action`, `what`, `title`, `active`, `sort`) VALUES ('%s','%s','%s','%s',%s)",
1987 // Add it to the queue
1988 addExtensionSql($sql);
1989 } elseif (isDebugModeEnabled()) {
1990 // Double menus should be located and fixed!
1991 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double sponsor menu action=%s,what=%s,title=%s,active=%s detected.", $action, $what, $title, $active));
1995 // Add ALTER TABLE `foo` ADD sql if not found
1996 function addExtensionAddTableColumnSql ($tableName, $columnName, $columnSql) {
1997 // Is the column there?
1998 if (!ifSqlColumnExists('{?_MYSQL_PREFIX?}_' . $tableName, $columnName)) {
2000 addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '` ADD `' . $columnName . '` ' . $columnSql);
2001 } elseif (isDebugModeEnabled()) {
2003 logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',columnName=' . $columnName . ',columnSql=' . $columnSql . ': does already exist.');
2007 // Add ALTER TABLE `foo` CHANGE sql if not found
2008 function addExtensionChangeTableColumnSql ($tableName, $fromColumnName, $toColumnName, $columnSql) {
2009 // Is the column there?
2010 if ((ifSqlColumnExists('{?_MYSQL_PREFIX?}_' . $tableName, $fromColumnName)) && (($fromColumnName == $toColumnName) || (!ifSqlColumnExists('{?_MYSQL_PREFIX?}_' . $tableName, $toColumnName)))) {
2012 addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '` CHANGE `' . $fromColumnName . '` `' . $toColumnName . '` ' . $columnSql);
2013 } elseif (isDebugModeEnabled()) {
2015 logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',fromColumnName=' . $fromColumnName . ',toColumnName=' . $toColumnName . ',columnSql=' . $columnSql . ': Cannot be changed.');
2019 // Add ALTER TABLE `foo` DROP sql if not found
2020 function addExtensionDropTableColumnSql ($tableName, $columnName) {
2021 // Is the column there?
2022 if (ifSqlColumnExists('{?_MYSQL_PREFIX?}_' . $tableName, $columnName)) {
2024 addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '` DROP `' . $columnName . '`');
2025 } elseif (isDebugModeEnabled()) {
2027 logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',columnName=' . $columnName . ': does not exist.');
2031 // Add configuration entry if not found for actual extension
2032 function addConfigAddSql ($columnName, $columnSql) {
2033 // Is the column there?
2034 if (!ifSqlColumnExists('{?_MYSQL_PREFIX?}_config', $columnName)) {
2035 // Not found, so add it
2036 addExtensionAddTableColumnSql('config', $columnName, $columnSql);
2037 } elseif (isDebugModeEnabled()) {
2039 logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' already created. columnSql=' . $columnSql);
2043 // Drop configuration entry if found for actual extension
2044 function addConfigDropSql ($columnName) {
2045 // Is the column there?
2046 if (ifSqlColumnExists('{?_MYSQL_PREFIX?}_config', $columnName)) {
2048 addExtensionDropTableColumnSql('config', $columnName);
2049 } elseif (isDebugModeEnabled()) {
2050 // Add debug line, reportBug() would cause some extenion updates fail
2051 logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' not found.');
2055 // Change configuration entry for actual extension
2056 function addConfigChangeSql ($oldColumnName, $newColumnName, $columnSql) {
2057 // Add the SQL statement
2058 addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` CHANGE `' . $oldColumnName . '` `' . $newColumnName . '` ' . $columnSql);
2062 * Checks if given subject is found and if not, adds an SQL query to the
2063 * extension registration queue.
2065 function registerExtensionPointsData ($subject, $columnName, $lockedMode, $paymentMethod) {
2066 // Default is old extension version
2069 // Is the extension equal or newer 0.8.9?
2070 if (((isInstallationPhase()) && ((getExtensionMode() == 'register') || (getExtensionMode() == 'update'))) || (isExtensionInstalledAndNewer('sql_patches', '0.8.9'))) {
2071 // Then add provider
2072 $add = " AND `account_provider`='EXTENSION'";
2075 // Is the 'subject' there?
2076 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ifSqlTableExists(points_data)=' . ifSqlTableExists('points_data') . ',getExtensionMode()=' . getExtensionMode() . ',add=' . $add);
2077 if (((!ifSqlTableExists('points_data')) && ((getExtensionMode() == 'register') || (getExtensionMode() == 'update'))) || (countSumTotalData($subject, 'points_data', 'id', 'subject', TRUE, $add) == 0)) {
2079 if ((isset($GLOBALS['previous_extension'][getCurrentExtensionName()])) && (!ifSqlTableExists('points_data'))) {
2080 $dummy = $GLOBALS['previous_extension'][getCurrentExtensionName()];
2081 reportBug(__FUNCTION__, __LINE__, 'previous_extension[' . gettype($dummy) . ']=' . $dummy . ',getCurrentExtensionName()=' . getCurrentExtensionName() . ' - Under development, please report this!');
2084 // ... add an SQL query
2085 addExtensionSql(sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_points_data` (`subject`, `column_name`, `locked_mode`, `payment_method`) VALUES ('%s','%s','%s','%s')",
2095 * Checks if given subject is found and if so, adds an SQL query to the
2096 * extension unregistration queue.
2098 function unregisterExtensionPointsData ($subject) {
2099 // Default is old extension version
2102 // Is the extension equal or newer 0.8.9?
2103 if (isExtensionInstalledAndNewer('sql_patches', '0.8.9')) {
2104 // Then add provider
2105 $add = " AND `account_provider`='EXTENSION'";
2108 // Is the 'subject' there?
2109 if (countSumTotalData($subject, 'points_data', 'id', 'subject', TRUE, $add) == 1) {
2110 // Found one or more, so add an SQL query
2111 addExtensionSql(sprintf("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_points_data` WHERE `subject`='%s'" . $add . " LIMIT 1",
2117 // Enables/disables productive mode for current extension (used only while
2119 // @TODO This should be rewrittten to allow, more development states, e.g. 'planing','alpha','beta','beta2','stable'
2120 function enableExtensionProductive ($isProductive = TRUE) {
2121 // Log debug message
2122 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',isProductive=', intval($isProductive));
2125 $GLOBALS['ext_productive'][getCurrentExtensionName()] = (bool) $isProductive;
2128 // Checks whether the extension is in productive phase. If not set, development
2129 // phase (=false) is assumed.
2130 function isExtensionProductive ($ext_name = '') {
2131 // Is the extension name empty? Then use current
2132 if (empty($ext_name)) {
2133 // Get current extension name
2134 $ext_name = getCurrentExtensionName();
2136 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
2139 if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
2140 // Load extension only if not yet loaded
2141 if (!isset($GLOBALS['ext_productive'][$ext_name])) {
2142 // Load extension in test mode
2143 loadExtension($ext_name, 'test');
2147 $GLOBALS[__FUNCTION__][$ext_name] = ((isset($GLOBALS['ext_productive'][$ext_name])) && ($GLOBALS['ext_productive'][$ext_name] === TRUE));
2151 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',isProductive=', intval($GLOBALS[__FUNCTION__][$ext_name]) . ' - EXIT!');
2152 return $GLOBALS[__FUNCTION__][$ext_name];
2155 // Mark extension file as loaded
2156 function markExtensionAsLoaded ($ext_name) {
2157 // Is it already loaded?
2158 if (isExtensionLoaded($ext_name)) {
2160 reportBug(__FUNCTION__, __LINE__, 'Extension ' . $ext_name . ' is already marked as loaded!');
2164 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_loaded=true');
2165 $GLOBALS['ext_loaded']['ext_name'][$ext_name] = TRUE;
2168 // Determine whether the given extension is already loaded
2169 function isExtensionLoaded ($ext_name) {
2171 return ((isset($GLOBALS['ext_loaded']['ext_name'][$ext_name])) && ($GLOBALS['ext_loaded']['ext_name'][$ext_name] === TRUE));
2174 // Mark extension's library file as loaded
2175 function markExtensionLibraryAsLoaded ($ext_name) {
2176 // Is it already loaded?
2177 if (isExtensionLibraryLoaded($ext_name)) {
2179 reportBug(__FUNCTION__, __LINE__, 'Extension library ' . $ext_name . ' is already marked as loaded!');
2183 $GLOBALS['ext_loaded']['library'][$ext_name] = TRUE;
2186 // Determine whether the given extension's library is already loaded
2187 function isExtensionLibraryLoaded ($ext_name) {
2189 return ((isset($GLOBALS['ext_loaded']['library'][$ext_name])) && ($GLOBALS['ext_loaded']['library'][$ext_name] === TRUE));