Rewrote 'we' word a little, rewrote mail order to use SQL_INSERTID() instead of anoth...
[mailer.git] / inc / extensions-functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 10/25/2009 *
4  * ===================                          Last change: 10/25/2009 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : extensions-functions.php                         *
8  * -------------------------------------------------------------------- *
9  * Short description : Extension management                             *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Erweiterungen-Management                         *
12  * -------------------------------------------------------------------- *
13  * $Revision::                                                        $ *
14  * $Date::                                                            $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author::                                                          $ *
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                      *
21  *                                                                      *
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.                                  *
26  *                                                                      *
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.                         *
31  *                                                                      *
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,               *
35  * MA  02110-1301  USA                                                  *
36  ************************************************************************/
37
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
40         die();
41 } // END - if
42
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));
51         } // END - if
52
53         // Make sure this situation can only happen once
54         $GLOBALS['loaded_extension'][$ext_name][$ext_mode] = true;
55
56         // Remember previous extension here
57         $GLOBALS['previous_extension'][$ext_name] = $previousExtension;
58
59         // Set extension mode
60         setExtensionMode($ext_mode);
61
62         // Set current extension name
63         setCurrentExtensionName($ext_name);
64
65         // By default all extensions are in productive phase
66         enableExtensionProductive();
67
68         if (!empty($ext_ver)) {
69                 // Set current extension version
70                 setCurrentExtensionVersion($ext_ver);
71         } else {
72                 // Set it to 0.0 by default
73                 setCurrentExtensionVersion('0.0.0');
74
75                 // Is the extension installed?
76                 if ((isExtensionInstalled($ext_name)) && ($ext_mode != 'register')) {
77                         // Get extension's version
78                         setCurrentExtensionVersion(getExtensionVersion($ext_name));
79                 } // END - if
80
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));
85                 } // END - if
86         }
87
88         // Set dry-run
89         enableExtensionDryRun($isDryRun);
90
91         // Init array
92         initIncludePool('extension');
93
94         // Init EXT_UPDATE_DEPENDS if not yet done
95         if (!isExtensionUpdateDependenciesInitialized()) {
96                 // Init here...
97                 initExtensionUpdateDependencies();
98         } // END - if
99
100         // Init current extension name list
101         initExtensionSqls();
102
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')) {
106                 // Debug message
107                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name));
108
109                 // Abort here
110                 return false;
111         } // END - if
112
113         // Is the extension file NOT there?
114         if (!isExtensionNameValid($ext_name)) {
115                 // Debug message
116                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension %s not found or not readable or the PHP script is deprecated.", $ext_name));
117
118                 // Abort here
119                 return false;
120         } // END - if
121
122         // Load extension's own language file if not in test mode
123         if ((getExtensionMode() != 'test') && (ifExtensionHasLanguageFile($ext_name))) {
124                 // Load it
125                 loadLanguageFile($ext_name);
126         } // END - if
127
128         // Is there cache?
129         if (isExtensionFunctionFileReadable($ext_name)) {
130                 // Not yet loaded?
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);
134
135                         // Mark it as loaded
136                         markExtensionLibraryAsLoaded($ext_name);
137
138                         // Download functions file
139                         loadIncludeOnce($funcsInclude);
140                 } // END - if
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",
144                         $ext_name,
145                         getExtensionMode()
146                 ));
147         }
148
149         // Load extension's filter library if present
150         loadExtensionFilters($ext_name);
151
152         // Extensions are not deprecated by default
153         setExtensionDeprecated('N');
154
155         // Extensions are not always active by default
156         setExtensionAlwaysActive('N');
157
158         // Include the extension file
159         loadCurrentExtensionInclude();
160
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);
165
166                 // Abort here
167                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension load aborted, ext_name=' . $ext_name . ' - Extension is deprecated.');
168                 return false;
169         } // END - if
170
171         // Mark it as loaded in normal mode
172         if (getExtensionMode() == '') {
173                 // Mark it now...
174                 markExtensionAsLoaded($ext_name);
175         } // END - if
176
177         // All fine!
178         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension successfully loaded, ext_name=' . $ext_name);
179         return true;
180 }
181
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);
187
188         // Enable dry-run
189         enableExtensionDryRun($isDryRun);
190
191         // By default all extensions are in productive phase
192         enableExtensionProductive();
193
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)));
198                 return false;
199         } // END - if
200
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!');
206                 return true;
207         } // END - if
208
209         // This registration is running
210         addExtensionRunningRegistration($ext_name);
211
212         // Init EXT_UPDATE_DEPENDS if not yet done
213         if (!isExtensionUpdateDependenciesInitialized()) {
214                 // Init here...
215                 initExtensionUpdateDependencies();
216         } // END - if
217
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());
222
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());
227
228                         // Is it still zero?
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)",
232                                         __FUNCTION__,
233                                         getCurrentExtensionName()
234                                 ));
235                         } // END - if
236                 } // END - if
237         } // END - if
238
239         // Init queries and notes
240         initExtensionSqls();
241         initExtensionNotes();
242
243         // Init variables
244         $ret = false;
245         $processResult = false;
246         initIncludePool('extension');
247
248         // By default we have no failures
249         enableExtensionReportingFailure();
250
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);
256
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);
264
265                         // Add update notes to our output
266                         addExtensionNotes($ext_ver);
267                 } // END - foreach
268
269                 // Does this extension depends on an outstanding update of another update?
270                 for ($dmy = getExtensionUpdateIterator(); getExtensionUpdateIterator() < countExtensionUpdateDependencies();) {
271                         // Get next update
272                         $ext_update = getExtensionUpdateDependenciesIterator();
273
274                         // Increment here to avoid endless loop
275                         incrementExtensionUpdateIterator();
276
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);
282
283                                 // If versions mismatch update extension first
284                                 $ext_ver = '';
285                                 if (isExtensionInstalled($ext_update)) {
286                                         // Get version only if installed
287                                         $ext_ver = getExtensionVersion($ext_update);
288                                 } // END - if
289
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);
295
296                                         // Entry found?
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);
302
303                                                 // Reset extension name
304                                                 setCurrentExtensionName($ext_name);
305                                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ',processResult=' . intval($processResult));
306                                         } // END - if
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());
318
319                                         // All okay!
320                                         $processResult = true;
321                                 } else {
322                                         // Nothing to register / update before...
323                                         $processResult = true;
324                                 }
325                         } else {
326                                 // Required file for update does not exists!
327                                 $processResult = true;
328                                 // But this is fine for the first time...
329                         }
330
331                         // Restore the current extension name
332                         setCurrentExtensionName($ext_name);
333                 } // END - for
334
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;
340                 } // END - if
341
342                 // Switch back to register mode
343                 setExtensionMode('register');
344
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));
349
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());
356                                 initSqls();
357                                 setSqlsArray(getExtensionSqls());
358
359                                 // Run installation pre-installation filters
360                                 runFilterChain('pre_extension_installed', array('dry_run' => isExtensionDryRun(), 'enable_codes' => false));
361
362                                 // Register extension
363                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'insert=' . getCurrentExtensionName() . '/' . getCurrentExtensionVersion() . ' - INSERT!');
364                                 if (isExtensionInstalledAndNewer('sql_patches', '0.0.6')) {
365                                         // New way, with CSS
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')",
368                                                 array(
369                                                         getCurrentExtensionName(),
370                                                         getThisExtensionAlwaysActive(),
371                                                         getCurrentExtensionVersion(),
372                                                         getExtensionHasCss()
373                                                 ), __FUNCTION__, __LINE__);
374                                 } else {
375                                         // Old way, no CSS
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')",
378                                                 array(
379                                                         getCurrentExtensionName(),
380                                                         getThisExtensionAlwaysActive(),
381                                                         getCurrentExtensionVersion()
382                                                 ), __FUNCTION__, __LINE__);
383                                 }
384
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();
388
389                                 // Mark it as installed
390                                 $GLOBALS['ext_is_installed'][getCurrentExtensionName()] = true;
391
392                                 // Remove cache file(s) if extension is active
393                                 runFilterChain('post_extension_installed', array(
394                                         'pool'     => 'extension',
395                                         'ext_name' => getCurrentExtensionName(),
396                                         'task_id'  => $taskId
397                                 ));
398
399                                 // Re-init queries and notes
400                                 initExtensionSqls(true);
401                                 initExtensionNotes(true);
402
403                                 // In normal mode return a true on success
404                                 $ret = true;
405                         } elseif (isExtensionDryRun() === true) {
406                                 // In  "dry-run" mode do always return a true
407                                 $ret = true;
408                         } else {
409                                 // Extension has been removed for updates, so all is fine!
410                                 $ret = true;
411                         }
412                 } else {
413                         // No, an error occurs while registering extension :-(
414                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName());
415                         $ret = false;
416                 }
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__);
422         }
423
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())) {
426                 /*
427                  * This is a really dirty hack to prevent an error about a missing
428                  * configuration entry which should be there after registration of
429                  * ext-sql_patches.
430                  */
431                 redirectToRequestUri();
432         } // END - if
433
434         // Return status code
435         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',currName=' . getCurrentExtensionName() . ',processResult=' . intval($processResult) . ',ret=' . intval($ret) . ' - EXIT!');
436         return $ret;
437 }
438
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!');
445                 return false;
446         } // END - if
447
448         // Get extension's name
449         $ext_name = getExtensionName($ext_id);
450
451         // Set current SQL name
452         setCurrentExtensionName($ext_name);
453
454         // Init EXT_UPDATE_DEPENDS
455         if (!isExtensionUpdateDependenciesInitialized()) {
456                 // Init here...
457                 initExtensionUpdateDependencies();
458         } // END - if
459
460         // Init array
461         initExtensionSqls(true);
462
463         // By default no SQL has been executed
464         $sqlRan = false;
465
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);
469
470         // Init these SQLs
471         initSqls();
472         setSqlsArray(getExtensionSqls());
473
474         // Debug message
475         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQLs::count=' . countSqls());
476
477         // Are there entries?
478         if (isSqlsValid()) {
479                 // Run SQL commands...
480                 runFilterChain('run_sqls');
481         } // END - if
482
483         // Run any filters depending on the action here
484         runFilterChain('extension_' . $load_mode);
485
486         // Remove cache file(s) if extension is active
487         if (((isExtensionActive('cache')) && ((!SQL_HASZEROAFFECTED()) || ($sqlRan === true) || ($load_mode == 'activate') || ($load_mode == 'deactivate')))) {
488                 // Run filters
489                 runFilterChain('post_extension_run_sql', getCurrentExtensionName());
490         } // END - if
491
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&amp;logout=1&amp;' . $load_mode . '=sql_patches');
498         } // END - if
499 }
500
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.');
508         } // END - if
509
510         // By default non is installed
511         $isInstalled = false;
512
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])) {
519                 // Found!
520                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - FOUND!');
521                 $isInstalled = true;
522
523                 // Count cache hits
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.');
528         } else {
529                 // Look in database
530                 $ext_id = getExtensionId($ext_name);
531
532                 // Is there a record?
533                 $isInstalled = ($ext_id > 0);
534
535                 // Log debug message
536                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_id=' . $ext_id . ',isInstalled=' . intval($isInstalled));
537
538                 // Is it installed, then cache the entry
539                 if ($isInstalled === true) {
540                         // Dummy call (get is okay here)
541                         getExtensionId($ext_name, true);
542                 } // END - if
543
544                 // Remember the status
545                 $GLOBALS['ext_is_installed'][$ext_name] = $isInstalled;
546         }
547
548         // Return status
549         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',isInstalled=' . intval($isInstalled) . ' - EXIT!');
550         return $isInstalled;
551 }
552
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);
558                 return false;
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);
565                 return false;
566         }
567
568         // Not active is the default
569         $data['ext_active'] = 'N';
570
571         // Check cache
572         if (isset($GLOBALS['cache_array']['extension']['ext_active'][$ext_name])) {
573                 // Load from cache
574                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE! ext_name=' . $ext_name);
575                 $data['ext_active'] = $GLOBALS['cache_array']['extension']['ext_active'][$ext_name];
576
577                 // Count cache hits
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__);
587
588                 // Entry found?
589                 if (SQL_NUMROWS($result) == 1) {
590                         // Load entry
591                         $data = SQL_FETCHARRAY($result);
592                 } // END - if
593
594                 // Free result
595                 SQL_FREERESULT($result);
596
597                 // Write cache array
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'];
600         } else {
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';
604         }
605
606         // Debug message
607         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',active=' . $data['ext_active']);
608
609         // Is this extension activated? (For admins we always have active extensions...)
610         return ($data['ext_active'] == 'Y');
611 }
612
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';
618
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.');
623         } // END - if
624
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.');
628                 return '';
629         } // END - if
630
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];
637
638                 // Count cache hits
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).'');
645
646                 // Is the extension there?
647                 if (SQL_NUMROWS($result) == 1) {
648                         // Load entry
649                         $data = SQL_FETCHARRAY($result);
650
651                         // Set cache
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));
656                 }
657
658                 // Free result
659                 SQL_FREERESULT($result);
660         }
661
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));
666         } // END - if
667
668         // Return result
669         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_version=' . $data['ext_version']);
670         return $data['ext_version'];
671 }
672
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);
680         } // END - if
681
682         // Set current SQL name
683         setCurrentExtensionName($ext_name);
684
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!');
690                 return true;
691         } // END - if
692
693         // Init arrays
694         initExtensionSqls();
695         initExtensionNotes();
696         initIncludePool('extension');
697
698         // Load extension in test mode
699         loadExtension($ext_name, 'test', $ext_ver, isExtensionDryRun());
700
701         // Save version history
702         $history = getExtensionVersionHistory();
703
704         // Remove old SQLs array to prevent possible bugs
705         initExtensionSqls();
706
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)
711                 $start = -1;
712                 if ($ext_ver != '0.0') {
713                         $start = array_search($ext_ver, $history);
714                 } // END - if
715
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];
720
721                         // Load again...
722                         loadExtension(getCurrentExtensionName(), 'update', $GLOBALS['update_ver'][getCurrentExtensionName()], isExtensionDryRun());
723
724                         // Get all depencies
725                         $depencies = getExtensionUpdateDependencies();
726
727                         // Nothing to apply?
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])) {
733                                                 // Set it as current
734                                                 setCurrentExtensionName($ext_depend);
735
736                                                 // Mark it as already updated before we update it
737                                                 $GLOBALS['ext_updated'][$ext_depend] = true;
738
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);
743                                                 } else {
744                                                         // Register new extension
745                                                         $processResult = registerExtension($ext_depend, NULL, isExtensionDryRun());
746                                                 }
747                                         } // END - if
748                                 } // END - foreach
749
750                                 // Set name back
751                                 setCurrentExtensionName($ext_name);
752
753                                 // Set extension version here
754                                 setCurrentExtensionVersion($ext_ver);
755                         } // END - if
756
757                         // Add notes
758                         addExtensionNotes($history[$idx]);
759                 } // END - for
760
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()]);
767                 } // END - if
768
769                 // Init these SQLs
770                 initSqls();
771                 setSqlsArray(getExtensionSqls());
772
773                 // Run SQLs
774                 runFilterChain('run_sqls', array('dry_run' => isExtensionDryRun(), 'enable_codes' => false));
775
776                 if (isExtensionDryRun() === false) {
777                         // Run filters on success extension update
778                         runFilterChain('extension_update', getCurrentExtensionName());
779                 } // END - if
780         } // END - if
781
782         //* DEBUG: */logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',isDryRun=' . intval($isDryRun) . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - EXIT!');
783 }
784
785 // Output verbose SQL table for extension
786 function addExtensionVerboseSqlTable ($title = '{--ADMIN_SQLS_EXECUTED_ON_REMOVAL--}') {
787         // Empty title?
788         if (empty($title)) {
789                 // Then abort here
790                 reportBug(__FUNCTION__, __LINE__, 'title is empty.');
791         } // END - if
792
793         // Init variables
794         $OUT = '';
795
796         // Is there queries?
797         if (isVerboseSqlEnabled()) {
798                 // Are there entries?
799                 if (countExtensionSqls() > 0) {
800                         // Init counter
801                         $idx = 0;
802                         // Get all SQLs
803                         foreach (getExtensionSqls() as $sqls) {
804                                 // New array format is recursive
805                                 foreach ($sqls as $sql) {
806                                         // Trim out spaces
807                                         $sql = trim($sql);
808
809                                         // Output command if set
810                                         if (!empty($sql)) {
811                                                 // Prepare output for template
812                                                 $content = array(
813                                                         'i'   => ($idx + 1),
814                                                         'sql' => str_replace(array('{', '}'), array('&#123;', '&#125;'), encodeEntities($sql))
815                                                 );
816
817                                                 // Load row template
818                                                 $OUT .= loadTemplate('admin_extension_sql_row', true, $content);
819
820                                                 // Count up
821                                                 $idx++;
822                                         } // END - if
823                                 } // END - foreach
824                         } // END - foreach
825
826                         // Prepare content for template
827                         $content = array(
828                                 'title'  => $title,
829                                 'rows'   => $OUT
830                         );
831
832                         // Load main template
833                         $OUT = loadTemplate('admin_extension_sql_table', true, $content);
834                 } else {
835                         // No addional SQL commands to run
836                         $OUT = displayMessage('{--ADMIN_EXTENSION_VERBOSE_SQLS_404--}', true);
837                 }
838         } // END - if
839
840         // Return output
841         return $OUT;
842 }
843
844 // Get extension name from id
845 function getExtensionName ($ext_id) {
846         // Init extension name
847         $data['ext_name'] = '';
848
849         // Is cache there?
850         if (isset($GLOBALS['cache_array']['extension']['ext_name'][$ext_id])) {
851                 // Load from cache
852                 $data['ext_name'] = $GLOBALS['cache_array']['extension']['ext_name'][$ext_id];
853
854                 // Count cache hits
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__);
860
861                 // Is the entry there?
862                 if (SQL_NUMROWS($result) == 1) {
863                         // Get the extension's name from database
864                         $data = SQL_FETCHARRAY($result);
865                 } // END - if
866
867                 // Free result
868                 SQL_FREERESULT($result);
869         }
870
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);
875         } // END - if
876
877         // Return the extension name
878         return $data['ext_name'];
879 }
880
881 // Get extension id from name
882 function getExtensionId ($ext_name) {
883         // Init id number
884         $data['ext_id'] = '0';
885
886         // Is there cache?
887         if (isset($GLOBALS['cache_array']['extension']['ext_id'][$ext_name])) {
888                 // Load from cache
889                 $data['ext_id'] = $GLOBALS['cache_array']['extension']['ext_id'][$ext_name];
890
891                 // Count cache hits
892                 incrementStatsEntry('cache_hits');
893         } else {
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__);
897
898                 // Is the entry there?
899                 if (SQL_NUMROWS($result) == 1) {
900                         // Get the extension's id from database
901                         $data = SQL_FETCHARRAY($result);
902                 } // END - if
903
904                 // Free result
905                 SQL_FREERESULT($result);
906
907                 // Cache it
908                 $GLOBALS['cache_array']['extension']['ext_id'][$ext_name] = $data['ext_id'];
909         }
910
911         // Return value
912         return $data['ext_id'];
913 }
914
915 // Determines whether the given extension name is valid
916 function isExtensionNameValid ($ext_name) {
917         // Is there cache?
918         if (!isset($GLOBALS['ext_name_valid'][$ext_name])) {
919                 // Generate include file name
920                 $INC = sprintf("inc/extensions/ext-%s.php", $ext_name);
921
922                 // Is there a file in inc/extensions/ ?
923                 $GLOBALS['ext_name_valid'][$ext_name] = isIncludeReadable($INC);
924         } // END - if
925
926         // Return result
927         return $GLOBALS['ext_name_valid'][$ext_name];
928 }
929
930 // Determines whether the given extension id is valid
931 function isExtensionIdValid ($ext_id) {
932         // Default is nothing valid
933         $isValid = false;
934
935         // Check in cache then in database
936         if (isset($GLOBALS['cache_array']['extension']['ext_name'][$ext_id])) {
937                 // Valid!
938                 $isValid = true;
939
940                 // Count cache hits
941                 incrementStatsEntry('cache_hits');
942         } else {
943                 // Query database
944                 $isValid = (countSumTotalData($ext_id, 'extensions', 'id', 'id', true) == 1);
945         }
946
947         // Return result
948         return $isValid;
949 }
950
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);
957         } // END - if
958
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__);
962
963         // Then run all queries
964         doExtensionSqls(getExtensionId($ext_name), 'activate');
965 }
966
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());
973         } // END - if
974
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__);
978
979         // Then run all queries
980         doExtensionSqls(getExtensionId($ext_name), 'deactivate');
981
982         // Create new task (we ignore the task id here)
983         createExtensionDeactivationTask($ext_name);
984
985         // Do not rebuild cache if it is already been rebuild
986         if ($inRebuild === false) {
987                 // Rebuild cache
988                 rebuildCache('extension', 'extension');
989         } // END - if
990
991         // Notify the admin
992         sendAdminNotification(
993                 '{--ADMIN_EXTENSION_DEACTIVATED_SUBJECT--}',
994                 'admin_extension_deactivated',
995                 array('ext_name' => $ext_name)
996         );
997 }
998
999 // Checks whether the extension is older than given
1000 function isExtensionOlder ($ext_name, $ext_ver) {
1001         // Get current extension version
1002         $currVersion = getExtensionVersion($ext_name);
1003
1004         // Remove all dots from both versions
1005         $currVersion = str_replace('.', '', $currVersion);
1006         $ext_ver = str_replace('.', '', $ext_ver);
1007
1008         // Now compare both and return the result
1009         return ($currVersion < $ext_ver);
1010 }
1011
1012 // Creates a new task for updated extension
1013 function createExtensionUpdateTask ($adminId, $ext_name, $ext_ver, $notes) {
1014         // Create subject line
1015         $subject = '[UPDATE-' . $ext_name . '-' . $ext_ver . ':] {--ADMIN_UPDATE_EXTENSION_SUBJECT--}';
1016
1017         // Get task id
1018         $taskId = determineTaskIdBySubject($subject);
1019
1020         // Is the extension there?
1021         if (isExtensionInstalled($ext_name)) {
1022                 // Check if task is not there
1023                 if ($taskId == '0') {
1024                         // Create extension update-task
1025                         $taskId = createNewTask($subject, $notes, 'EXTENSION_UPDATE', 0, $adminId);
1026                 } // END - if
1027         } else {
1028                 // Extension not there! :-(
1029                 reportBug(__FUNCTION__, __LINE__, sprintf("Extension <span class=\"data\">%s</span> not found but should be updated?", $ext_name));
1030         }
1031
1032         // Return task id
1033         return $taskId;
1034 }
1035
1036 // Creates a new task for newly installed extension
1037 function createNewExtensionTask ($ext_name) {
1038         // Generate subject line
1039         $subject = sprintf("[%s:]", $ext_name);
1040
1041         // Get task id
1042         $taskId = determineTaskIdBySubject($subject);
1043
1044         // Not installed and do we have created a task for the admin?
1045         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId[' . gettype($taskId) . ']=' . $taskId);
1046         if (((is_null($taskId)) || ($taskId == '0')) && (!isExtensionInstalled($ext_name))) {
1047                 // Set default message if ext-foo is missing
1048                 $message = '{%message,ADMIN_EXTENSION_TEXT_FILE_MISSING=' . $ext_name . '%}';
1049
1050                 // Template file
1051                 $FQFN = sprintf("%stemplates/%s/html/ext/ext_%s.tpl",
1052                         getPath(),
1053                         getLanguage(),
1054                         $ext_name
1055                 );
1056
1057                 // Load text for task if found
1058                 if (isFileReadable($FQFN)) {
1059                         // Load extension's description template (but do not compile the code)
1060                         $message = loadTemplate('ext_' . $ext_name, true, array(), false);
1061                 } else {
1062                         // Write this in debug.log as well
1063                         logDebugMessage(__FUNCTION__, __LINE__, $message);
1064                 }
1065
1066                 // Task not created so it's a brand-new extension which we need to register and create a task for!
1067                 $taskId = createNewTask($subject, $message, 'EXTENSION', 0, getCurrentAdminId(), false);
1068         } // END - if
1069
1070         // Return task id
1071         return $taskId;
1072 }
1073
1074 // Creates a task for automatically deactivated (deprecated) extension
1075 function createExtensionDeactivationTask ($ext_name) {
1076         // Create subject line
1077         $subject = sprintf("[%s:] %s", $ext_name, '{--ADMIN_TASK_EXTENSION_DEACTIVATED_SUBJECT--}');
1078
1079         // Get task id
1080         $taskId = determineTaskIdBySubject($subject);
1081
1082         // Not installed and do we have created a task for the admin?
1083         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId[' . gettype($taskId) . ']=' . $taskId);
1084         if (((is_null($taskId)) || ($taskId == '0')) && (isExtensionInstalled($ext_name))) {
1085                 // Task not created so add it
1086                 $taskId = createNewTask($subject, SQL_ESCAPE(loadTemplate('task_EXTENSION_deactivated', true, $ext_name)), 'EXTENSION_DEACTIVATION');
1087         } // END - if
1088
1089         // Return task id
1090         return $taskId;
1091 }
1092
1093 // Determines the task id for given extension
1094 function determineExtensionTaskId ($ext_name) {
1095         // Is it installation phase and table task_system is not found?
1096         if ((isInstallationPhase()) && (!ifSqlTableExists('task_system'))) {
1097                 // Then return NULL (not found)
1098                 return NULL;
1099         } // END - if
1100
1101         // Default is not found
1102         $data['task_id'] = NULL;
1103
1104         // Search for extension task's id
1105         $result = SQL_QUERY_ESC("SELECT `id` AS task_id FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `task_type`='EXTENSION' AND `subject`='[%s:]' LIMIT 1",
1106                 array($ext_name), __FUNCTION__, __LINE__);
1107
1108         // Entry found?
1109         if (SQL_NUMROWS($result) == 1) {
1110                 // Task found so load task's id and register extension...
1111                 $data = SQL_FETCHARRAY($result);
1112         } // END - if
1113
1114         // Free result
1115         SQL_FREERESULT($result);
1116
1117         // Return it
1118         return $data['task_id'];
1119 }
1120
1121 // Determines the task id for given subject
1122 function determineTaskIdBySubject ($subject) {
1123         // Default is not found
1124         $data['task_id'] = '0';
1125
1126         // Search for task id
1127         $result = SQL_QUERY_ESC("SELECT `id` AS task_id FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `subject` LIKE '%s%%' LIMIT 1",
1128                 array($subject), __FUNCTION__, __LINE__);
1129
1130         // Entry found?
1131         if (SQL_NUMROWS($result) == 1) {
1132                 // Task found so load task's id and register extension...
1133                 $data = SQL_FETCHARRAY($result);
1134         } // END - if
1135
1136         // Free result
1137         SQL_FREERESULT($result);
1138
1139         // Return it
1140         return $data['task_id'];
1141 }
1142
1143 // Add updates notes for given version
1144 function addExtensionNotes ($ext_ver) {
1145         // Init notes/content
1146         $out = '';
1147         $content = array();
1148
1149         // Is do we have verbose output enabled?
1150         if ((!isExtensionActive('sql_patches')) || (isVerboseSqlEnabled())) {
1151                 // Update notes found?
1152                 if ((isExtensionUpdateNoteSet($ext_ver)) && ($ext_ver != '0.0.0')) {
1153                         // Update notes found
1154                         $content = array(
1155                                 'ver'   => $ext_ver,
1156                                 'notes' => getExtensionUpdateNotes($ext_ver)
1157                         );
1158
1159                         // Reset them
1160                         setExtensionUpdateNotes('', $ext_ver);
1161                 } elseif ($ext_ver == '0.0.0') {
1162                         // Is the extension productive?
1163                         if (isExtensionProductive(getCurrentExtensionName())) {
1164                                 // Initial release
1165                                 $content = array(
1166                                         'ver'   => $ext_ver,
1167                                         'notes' => '{--INITIAL_RELEASE--}'
1168                                 );
1169                         } else {
1170                                 // Not productive
1171                                 $content = array(
1172                                         'ver'   => $ext_ver,
1173                                         'notes' => '{--DEVELOPER_RELEASE--}'
1174                                 );
1175                         }
1176                 } else {
1177                         // No update notes found
1178                         $content = array(
1179                                 'ver'   => $ext_ver,
1180                                 'notes' => '{--NO_UPDATE_NOTICES--}'
1181                         );
1182                 }
1183
1184                 // Load template
1185                 $out = loadTemplate('admin_extension_notes', true, $content);
1186         } // END - if
1187
1188         // Add the notes
1189         appendExtensionNotes($out);
1190 }
1191
1192 // Getter for CSS files array
1193 function getExtensionCssFiles () {
1194         // By default no additional CSS files are found
1195         $cssFiles = array();
1196
1197         // Is the array there?
1198         if (isset($GLOBALS['css_files'])) {
1199                 // Then use it
1200                 $cssFiles = $GLOBALS['css_files'];
1201         } // END - if
1202
1203         // Return array
1204         return $cssFiles;
1205 }
1206
1207 // Init CSS files array
1208 function initExtensionCssFiles () {
1209         // Simply init it
1210         $GLOBALS['css_files'] = array();
1211 }
1212
1213 // Add new entry
1214 function addExtensionCssFile ($file) {
1215         // Is the array there?
1216         if (!isset($GLOBALS['css_files'])) {
1217                 // Then auto-init them
1218                 initExtensionCssFiles();
1219         } // END - if
1220
1221         // Add the entry
1222         array_push($GLOBALS['css_files'], $file);
1223 }
1224
1225 // Setter for EXT_ALWAYS_ACTIVE flag
1226 function setExtensionAlwaysActive ($active) {
1227         $GLOBALS['ext_always_active'][getCurrentExtensionName()] = (string) $active;
1228 }
1229
1230 // Getter for EXT_ALWAYS_ACTIVE flag
1231 function getThisExtensionAlwaysActive () {
1232         return $GLOBALS['ext_always_active'][getCurrentExtensionName()];
1233 }
1234
1235 // Checks whether the current extension is always active
1236 function isThisExtensionAlwaysActive () {
1237         return (getThisExtensionAlwaysActive() == 'Y');
1238 }
1239
1240 // Setter for EXT_VERSION flag
1241 function setThisExtensionVersion ($ext_version) {
1242         $GLOBALS['ext_version'][getCurrentExtensionName()] = (string) $ext_version;
1243 }
1244
1245 // Getter for EXT_VERSION flag
1246 function getThisExtensionVersion () {
1247         return $GLOBALS['ext_version'][getCurrentExtensionName()];
1248 }
1249
1250 // Setter for EXT_DEPRECATED flag
1251 function setExtensionDeprecated ($deprecated) {
1252         $GLOBALS['ext_deprecated'][getCurrentExtensionName()] = (string) $deprecated;
1253 }
1254
1255 // Getter for EXT_DEPRECATED flag
1256 function isExtensionDeprecated ($ext_name = NULL) {
1257         // Default is from current (NULL) extension
1258         $isDeprecated = ($GLOBALS['ext_deprecated'][getCurrentExtensionName()] == 'Y');
1259
1260         // Is ext_name set?
1261         if (!is_null($ext_name)) {
1262                 // Then use it instead
1263                 $isDeprecated = ((isset($GLOBALS['ext_deprecated'][$ext_name])) && ($GLOBALS['ext_deprecated'][$ext_name] == 'Y'));
1264         } // END - if
1265
1266         // Return it
1267         return $isDeprecated;
1268 }
1269
1270 // Setter for EXT_UPDATE_DEPENDS flag
1271 function addExtensionDependency ($updateDepends) {
1272         // Is the update depency empty? (NEED TO BE FIXED!)
1273         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ',extensionMode=' . getExtensionMode() . ' - ENTERED!');
1274         if (empty($updateDepends)) {
1275                 // Please report this bug!
1276                 reportBug(__FUNCTION__, __LINE__, 'updateDepends is empty: currentExtension=' . getCurrentExtensionName());
1277         } // END - if
1278
1279         // Is it not yet added?
1280         if ((isset($updateDepends, $GLOBALS['ext_running_updates'][getCurrentExtensionName()])) && (in_array($updateDepends, getExtensionUpdatesRunning()))) {
1281                 /*
1282                  * Double-adding happens when the extension and an update of the same
1283                  * extension requires the same other extension again.
1284                  */
1285                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'updateDepends=' . $updateDepends . ',extensionMode=' . getExtensionMode() . ',currentExtension=' . getCurrentExtensionName() . ' - called twice.');
1286                 return;
1287         } // END - if
1288
1289         // Add it to the list of extension update depencies map
1290         array_push($GLOBALS['ext_update_depends'][getCurrentExtensionName()], $updateDepends);
1291
1292         // Init array
1293         if ((!isset($GLOBALS['ext_running_updates'][getCurrentExtensionName()])) || (!is_array($GLOBALS['ext_running_updates'][getCurrentExtensionName()]))) {
1294                 $GLOBALS['ext_running_updates'][getCurrentExtensionName()] = array();
1295         } // END - if
1296
1297         // Remember it in the list of running updates
1298         array_push($GLOBALS['ext_running_updates'][getCurrentExtensionName()], $updateDepends);
1299         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ',extensionMode=' . getExtensionMode() . ' - EXIT!');
1300 }
1301
1302 // Getter for running updates
1303 function getExtensionUpdatesRunning () {
1304         return $GLOBALS['ext_running_updates'][getCurrentExtensionName()];
1305 }
1306
1307 // Checks whether the given extension registration is in progress
1308 function isExtensionRegistrationRunning ($ext_name) {
1309         // Simply check it
1310         $isRunning = ((isset($GLOBALS['ext_register_running'])) && (in_array($ext_name, $GLOBALS['ext_register_running'])));
1311
1312         // Return it
1313         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ', isRunning=' . intval($isRunning));
1314         return $isRunning;
1315 }
1316
1317 // Init EXT_UPDATE_DEPENDS flag
1318 function initExtensionUpdateDependencies () {
1319         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ' - ENTERED!');
1320
1321         // Init update depency map automatically if not found
1322         if (isExtensionUpdateDependenciesInitialized()) {
1323                 // We need these bug reports as well...
1324                 reportBug(__FUNCTION__, __LINE__, '() is called twice: currName=' . getCurrentExtensionName());
1325         } // END - if
1326
1327         $GLOBALS['ext_update_depends'][getCurrentExtensionName()] = array();
1328
1329         // Init running updates array
1330         initExtensionRuningUpdates();
1331
1332         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ' - EXIT!');
1333 }
1334
1335 // Adds an extension as "registration in progress"
1336 function addExtensionRunningRegistration ($ext_name) {
1337         // Is it running?
1338         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Registration in progress: ext_name=' . $ext_name . ' - ENTERED!');
1339         if (isExtensionRegistrationRunning($ext_name)) {
1340                 // This is really bad and should not be quietly ignored
1341                 reportBug(__FUNCTION__, __LINE__, '() already called! ext_name=' . $ext_name);
1342         } // END - if
1343
1344         // Then add it!
1345         array_push($GLOBALS['ext_register_running'], $ext_name);
1346         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Registration in progress: ext_name=' . $ext_name . ' - EXIT!');
1347 }
1348
1349 // Checks whether EXT_UPDATE_DEPENDS is initialized
1350 function isExtensionUpdateDependenciesInitialized () {
1351         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
1352         return (isset($GLOBALS['ext_update_depends'][getCurrentExtensionName()]));
1353 }
1354
1355 // Checks whether an update is already running for given extension
1356 function isExtensionUpdateRunning ($ext_name, $ignoreDependencies = false) {
1357         // Current and given extensions means whole array
1358         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - ENTERED!');
1359         if ($ext_name == getCurrentExtensionName()) {
1360                 // Default is not found
1361                 $isRunning = false;
1362
1363                 // Walk through whole array
1364                 foreach ($GLOBALS['ext_running_updates'] as $ext1 => $depends) {
1365                         // Is it found?
1366                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',depends=' . print_r($depends, true));
1367                         if (($ext1 == $ext_name) || ((in_array($ext_name, $depends)) && ($ignoreDependencies === false))) {
1368                                 // Found
1369                                 $isRunning = true;
1370                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',isRunning=true - FOUND!');
1371                                 break;
1372                         } // END - if
1373                 } // END - foreach
1374
1375                 // Return result
1376                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ',ignoreDependencies=' . intval($ignoreDependencies) . ', isRunning=' . intval($isRunning) . ' - ALT-EXIT!');
1377                 return $isRunning;
1378         } // END - if
1379
1380         // Simply check it
1381         $isRunning = ((isExtensionUpdateDependenciesInitialized()) && (in_array($ext_name, getExtensionRunningUpdates())));
1382
1383         // Return it
1384         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ',ignoreDependencies=' . intval($ignoreDependencies) . ', isRunning=' . intval($isRunning) . ' - EXIT!');
1385         return $isRunning;
1386 }
1387
1388 // Initializes the list of running updates
1389 function initExtensionRuningUpdates () {
1390         // Auto-init ext_running_updates
1391         if (!isset($GLOBALS['ext_running_updates'])) {
1392                 $GLOBALS['ext_running_updates'] = array();
1393                 $GLOBALS['ext_register_running'] = array();
1394         } // END - if
1395 }
1396
1397 // Getter for EXT_UPDATE_DEPENDS flag
1398 function getExtensionUpdateDependencies () {
1399         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
1400         return $GLOBALS['ext_update_depends'][getCurrentExtensionName()];
1401 }
1402
1403 // Getter for next iterator depency
1404 function getExtensionUpdateDependenciesIterator () {
1405         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
1406         return ($GLOBALS['ext_update_depends'][getCurrentExtensionName()][getExtensionUpdateIterator()]);
1407 }
1408
1409 // Counter for extension update depencies
1410 function countExtensionUpdateDependencies () {
1411         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '=' . count($GLOBALS['ext_update_depends'][getCurrentExtensionName()]));
1412         return count($GLOBALS['ext_update_depends'][getCurrentExtensionName()]);
1413 }
1414
1415 // Removes given extension from update denpency list
1416 function removeExtensionDependency ($ext_name) {
1417         // Look it up
1418         $key = array_search($ext_name, getExtensionUpdateDependencies());
1419
1420         // Debug message
1421         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',key[' . gettype($key) . ']=' . $key);
1422
1423         // Is it valid?
1424         if ($key !== false) {
1425                 // Then remove it
1426                 unset($GLOBALS['ext_update_depends'][getCurrentExtensionName()][$key]);
1427
1428                 // And sort the array
1429                 ksort($GLOBALS['ext_update_depends'][getCurrentExtensionName()]);
1430         } // END - if
1431 }
1432
1433 // Init iterator for update depencies
1434 function initExtensionUpdateIterator () {
1435         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
1436         $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()] = '0';
1437 }
1438
1439 // Getter for depency iterator
1440 function getExtensionUpdateIterator () {
1441         // Auto-init iterator
1442         if (!isset($GLOBALS['ext_depend_iterator'][getCurrentExtensionName()])) {
1443                 // Initialize update iterator
1444                 initExtensionUpdateIterator();
1445         } // END - if
1446
1447         // Return it
1448         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '=' . $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()]);
1449         return $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()];
1450 }
1451
1452 // Increments the update iterator
1453 function incrementExtensionUpdateIterator () {
1454         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
1455         $GLOBALS['ext_depend_iterator'][getCurrentExtensionName()]++;
1456 }
1457
1458 // Setter for EXT_REPORTS_FAILURE flag
1459 function enableExtensionReportingFailure ($reportsFailure = false) {
1460         $GLOBALS['ext_reports_failure'] = (bool) $reportsFailure;
1461 }
1462
1463 // Getter for EXT_REPORTS_FAILURE flag
1464 function isExtensionReportingFailure () {
1465         return $GLOBALS['ext_reports_failure'];
1466 }
1467
1468 // Setter for EXT_VER_HISTORY flag
1469 function setExtensionVersionHistory ($versionHistory) {
1470         $GLOBALS['ext_ver_history'][getCurrentExtensionName()] = (array) $versionHistory;
1471 }
1472
1473 // Getter for EXT_VER_HISTORY array
1474 function getExtensionVersionHistory () {
1475         // Is it set?
1476         if (!isset($GLOBALS['ext_ver_history'][getCurrentExtensionName()])) {
1477                 // Then abort here to a avoid an ugly "Undefined index" error
1478                 reportBug(__FUNCTION__, __LINE__, 'Extension ext-' . getCurrentExtensionName() . ' has no history set! Is this extension empty?');
1479         } // END - if
1480
1481         // Return the history
1482         return $GLOBALS['ext_ver_history'][getCurrentExtensionName()];
1483 }
1484
1485 // Setter for EXT_UPDATE_NOTICES
1486 function setExtensionUpdateNotes ($updateNotes, $ext_ver = '') {
1487         //
1488         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()=' . getCurrentExtensionName() . ',getExtensionMode()=' . getExtensionMode() . ',ext_ver=' . $ext_ver . '/' . getCurrentExtensionVersion() . ',updateNotes(length)=' . strlen($updateNotes));
1489         if (empty($ext_ver)) {
1490                 $GLOBALS['ext_update_notes'][getCurrentExtensionName()][getCurrentExtensionVersion()] = (string) $updateNotes;
1491         } else {
1492                 $GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ext_ver] = (string) $updateNotes;
1493         }
1494 }
1495
1496 // Getter for EXT_UPDATE_NOTICES
1497 function getExtensionUpdateNotes ($ext_ver) {
1498         return $GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ext_ver];
1499 }
1500
1501 // Checks if ext_update_notes is set
1502 function isExtensionUpdateNoteSet ($ext_ver) {
1503         return isset($GLOBALS['ext_update_notes'][getCurrentExtensionName()][$ext_ver]);
1504 }
1505
1506 // Init extension notice
1507 function initExtensionNotes ($force = false) {
1508         // Is it already initialized?
1509         if (($force === false) && (isset($GLOBALS['ext_notes'][getCurrentExtensionName()]))) {
1510                 // This is mostly not wanted, so please report it
1511                 reportBug(__FUNCTION__, __LINE__, 'ext_notes already set for extension ' . getCurrentExtensionName());
1512         } // END - if
1513
1514         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()=' . getCurrentExtensionName());
1515         $GLOBALS['ext_notes'][getCurrentExtensionName()] = '';
1516 }
1517
1518 // Append extension notice
1519 function appendExtensionNotes ($notes) {
1520         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()=' . getCurrentExtensionName() . ', notes(length)=' . strlen($notes));
1521         $GLOBALS['ext_notes'][getCurrentExtensionName()] .= (string) trim($notes);
1522 }
1523
1524 // Getter for extension notes
1525 function getExtensionNotes () {
1526         return $GLOBALS['ext_notes'][getCurrentExtensionName()];
1527 }
1528
1529 // Setter for current extension name
1530 function setCurrentExtensionName ($ext_name) {
1531         $GLOBALS['curr_extension_name'] = (string) trim($ext_name);
1532 }
1533
1534 // Getter for current extension name
1535 function getCurrentExtensionName () {
1536         if (!isset($GLOBALS['curr_extension_name'])) {
1537                 // Not set!
1538                 reportBug(__FUNCTION__, __LINE__, 'curr_extension_name not initialized. Please execute initExtensionSqls() before calling this function.');
1539         } // END - if
1540
1541         // Return it
1542         return $GLOBALS['curr_extension_name'];
1543 }
1544
1545 // Init SQLs array for current extension
1546 function initExtensionSqls ($force = false) {
1547         // Auto-init the array or if forced
1548         if (($force === true) || (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()]))) {
1549                 // Set the array
1550                 $GLOBALS['ext_sqls'][getCurrentExtensionName()] = array();
1551
1552                 // Initialize the generic array
1553                 initSqls();
1554         } // END - if
1555 }
1556
1557 // Adds SQLs to the SQLs array but "assigns" it with current extension name
1558 function addExtensionSql ($sql) {
1559         // Is is the array there?
1560         if ((!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()])) || (!is_array($GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()]))) {
1561                 // Init array
1562                 $GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()] = array();
1563         } // END - if
1564
1565         // Is the SQL statement empty?
1566         if (empty($sql)) {
1567                 /*
1568                  * Abort here as this may happen if getExtensionMode() is 'activate' or
1569                  * 'deactivate'. This means that for 'mode' are no SQL statements
1570                  * specified.
1571                  */
1572                 return;
1573         } // END - if
1574
1575         // Add it
1576         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',ext_version=' . getCurrentExtensionVersion() . ',sql=' . $sql);
1577         array_push($GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()], $sql);
1578 }
1579
1580 // Getter for SQLs array for current extension
1581 function getExtensionSqls () {
1582         // Output debug backtrace if not found (SHOULD NOT HAPPEN!)
1583         if (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()])) {
1584                 // Not found, should not happen
1585                 reportBug(__FUNCTION__, __LINE__, sprintf("ext_sqls is empty, current extension: %s",
1586                         getCurrentExtensionName()
1587                 ));
1588         } // END - if
1589
1590         // Return the array
1591         return $GLOBALS['ext_sqls'][getCurrentExtensionName()];
1592 }
1593
1594 // Count SQLs for current extension
1595 function countExtensionSqls () {
1596         // Output debug backtrace if not found (SHOULD NOT HAPPEN!)
1597         if (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()])) {
1598                 // Not found, should not happen
1599                 reportBug(__FUNCTION__, __LINE__, sprintf("ext_sqls is empty, current extension: %s",
1600                         getCurrentExtensionName()
1601                 ));
1602         } // END - if
1603
1604         // Count them all
1605         return count($GLOBALS['ext_sqls'][getCurrentExtensionName()]);
1606 }
1607
1608 // Removes SQLs for current extension
1609 function unsetExtensionSqls () {
1610         unset($GLOBALS['ext_sqls'][getCurrentExtensionName()]);
1611 }
1612
1613 // Auto-initializes the removal list
1614 function initExtensionRemovalList () {
1615         // Is the remove list there?
1616         if (!isset($GLOBALS['ext_update_remove'])) {
1617                 // Then create it
1618                 $GLOBALS['ext_update_remove'] = array();
1619         } // END - if
1620 }
1621
1622 // Checks whether the current extension is on the removal list
1623 function isExtensionOnRemovalList () {
1624         // Init removal list
1625         initExtensionRemovalList();
1626
1627         // Is it there?
1628         return (in_array(getCurrentExtensionName(), $GLOBALS['ext_update_remove']));
1629 }
1630
1631 // Adds the current extension to the removal list
1632 function addCurrentExtensionToRemovalList () {
1633         // Simply add it
1634         array_push($GLOBALS['ext_update_remove'], getCurrentExtensionName());
1635 }
1636
1637 // Getter for removal list
1638 function getExtensionRemovalList () {
1639         // Return the removal list
1640         return $GLOBALS['ext_update_remove'];
1641 }
1642
1643 // Redirects if the provided extension is not installed
1644 function redirectOnUninstalledExtension ($ext_name) {
1645         // So is the extension there?
1646         if ((!isExtensionInstalled($ext_name)) || (!isExtensionActive($ext_name))) {
1647                 // Redirect to index
1648                 redirectToUrl('modules.php?module=index&amp;code=' . getCode('EXTENSION_PROBLEM') . '&amp;ext=' . $ext_name);
1649         } // END - if
1650 }
1651
1652 // Filter for initialization of all extensions by loading them in 'init' mode
1653 function FILTER_INIT_EXTENSIONS () {
1654         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTERED!');
1655         // Init notification pool
1656         initIncludePool('notify');
1657
1658         // Are there some entries?
1659         if (isset($GLOBALS['cache_array']['extension']['ext_name'])) {
1660                 // Load all found extensions if found
1661                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - START!');
1662                 foreach ($GLOBALS['cache_array']['extension']['ext_name'] as $key => $ext_name) {
1663                         // Load it
1664                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - START');
1665                         loadExtension($ext_name, 'init', getExtensionVersion($ext_name));
1666                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - END');
1667                 } // END - foreach
1668                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - END!');
1669         } // END - if
1670
1671         // Run any notifications
1672         runFilterChain('load_includes', 'notify');
1673
1674         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'EXIT!');
1675 }
1676
1677 // Setter for extension mode
1678 function setExtensionMode ($ext_mode) {
1679         $GLOBALS['ext_mode'] = (string) $ext_mode;
1680 }
1681
1682 // Getter for extension mode
1683 function getExtensionMode () {
1684         return $GLOBALS['ext_mode'];
1685 }
1686
1687 // Setter for dry-run
1688 function enableExtensionDryRun ($isDryRun = true) {
1689         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()='.getCurrentExtensionName().',isDryRun='.intval($isDryRun));
1690         $GLOBALS['ext_isDryRun'] = (bool) $isDryRun;
1691 }
1692
1693 // Getter for dry-run
1694 function isExtensionDryRun () {
1695         return $GLOBALS['ext_isDryRun'];
1696 }
1697
1698 // Setter for current extension version
1699 function setCurrentExtensionVersion ($ext_ver) {
1700         // ext_ver should never be empty in other modes than 'test'
1701         if ((empty($ext_ver)) && (getExtensionMode() != 'test')) {
1702                 // Please report all these messages
1703                 reportBug(__FUNCTION__, __LINE__, 'ext_ver is empty. Current extension name: ' . getCurrentExtensionName() . ', mode=' . getExtensionMode());
1704         } // END - if
1705
1706         // Add version
1707         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver[' . gettype($ext_ver) . ']=' . $ext_ver);
1708         $GLOBALS['ext_current_version'][getCurrentExtensionName()] = (string) $ext_ver;
1709 }
1710
1711 // Getter for current extension version
1712 function getCurrentExtensionVersion () {
1713         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver=' . $GLOBALS['ext_current_version'][getCurrentExtensionName()]);
1714         return $GLOBALS['ext_current_version'][getCurrentExtensionName()];
1715 }
1716
1717 // Remove the extension from cache array
1718 function removeExtensionFromArray () {
1719         // "Cache" this name
1720         $ext_name = getCurrentExtensionName();
1721
1722         // Now loop through the whole cache
1723         foreach ($GLOBALS['cache_array']['extension'] as $cacheName => $cacheArray) {
1724                 // Is it an element?
1725                 if (isset($cacheArray[$ext_name])) {
1726                         // Array element
1727                         unset($cacheArray[$ext_name]);
1728                         $GLOBALS['cache_array']['extension'][$cacheName] = $cacheArray;
1729                 } else {
1730                         // Maybe in array?
1731                         $key = array_search($ext_name, $cacheArray);
1732
1733                         // Is it there?
1734                         if ($key !== false) {
1735                                 // Found, so remove it
1736                                 unset($cacheArray[$key]);
1737                                 $GLOBALS['cache_array']['extension'][$cacheName] = $cacheArray;
1738                         } // END - if
1739                 }
1740         } // END - foreach
1741
1742         // Remove from other caches as well
1743         unset($GLOBALS['ext_is_installed'][$ext_name]);
1744         unset($GLOBALS['loaded_extension'][$ext_name]);
1745 }
1746
1747 // "Getter" for 'extension has a CSS file' (with same name, of course)
1748 function getExtensionHasCss () {
1749         // Is there cache?
1750         if (!isset($GLOBALS[__FUNCTION__][getCurrentExtensionName()][getCurrentTheme()])) {
1751                 // Construct FQFN for check
1752                 $FQFN = sprintf("%stheme/%s/css/%s.css",
1753                         getPath(),
1754                         getCurrentTheme(),
1755                         getCurrentExtensionName()
1756                 );
1757
1758                 // Is it there?
1759                 $GLOBALS[__FUNCTION__][getCurrentExtensionName()][getCurrentTheme()] = convertBooleanToYesNo(isFileReadable($FQFN));
1760         } // END - if
1761
1762         // Return it
1763         return $GLOBALS[__FUNCTION__][getCurrentExtensionName()][getCurrentTheme()];
1764 }
1765
1766 // Checks whether the given extension has a language file
1767 function ifExtensionHasLanguageFile ($ext_name) {
1768         // Is there cache?
1769         if (isset($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name])) {
1770                 // Count cache hits
1771                 incrementStatsEntry('cache_hits');
1772         } else {
1773                 // Determine it and put it in cache
1774                 $GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] = convertBooleanToYesNo(isLanguageIncludeReadable($ext_name));
1775         }
1776
1777         // Return result
1778         return ($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] == 'Y');
1779 }
1780
1781 // Load current extension's include file
1782 function loadCurrentExtensionInclude () {
1783         // Is it readable?
1784         if (!isExtensionIncludeReadable()) {
1785                 // Not readable
1786                 reportBug(__FUNCTION__, __LINE__, 'Extension ' . getCurrentExtensionName() . ' should be loaded, but is not readable.');
1787         } // END - if
1788
1789         // Generate INC name
1790         $INC = sprintf("inc/extensions/ext-%s.php", getCurrentExtensionName());
1791
1792         // Load it
1793         loadInclude($INC);
1794 }
1795
1796 // Checks whether an extension is readable
1797 function isExtensionIncludeReadable ($ext_name = '') {
1798         // If empty, use current
1799         if (empty($ext_name)) {
1800                 $ext_name = getCurrentExtensionName();
1801         } // END - if
1802
1803         // Array found?
1804         if (!isset($GLOBALS['ext_inc_readable'][$ext_name])) {
1805                 // Generate INC name
1806                 $INC = sprintf("inc/extensions/ext-%s.php", getCurrentExtensionName());
1807
1808                 // Is it readable?
1809                 $GLOBALS['ext_inc_readable'][$ext_name] = isIncludeReadable($INC);
1810         } // END - if
1811
1812         // Return result
1813         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',realable='.intval($GLOBALS['ext_inc_readable'][$ext_name]));
1814         return $GLOBALS['ext_inc_readable'][$ext_name];
1815 }
1816
1817 // Checks if an extension's function file is readable
1818 function isExtensionFunctionFileReadable ($ext_name) {
1819         // Is cache there?
1820         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name);
1821         if (isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name])) {
1822                 // Just count cache hits
1823                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_func=' . $GLOBALS['cache_array']['extension']['ext_func'][$ext_name] .' - CACHE!');
1824                 incrementStatsEntry('cache_hits');
1825         } else {
1826                 // Construct IFN for functions file
1827                 $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
1828
1829                 // Is this include there?
1830                 $isIncludeFound = ((isFileReadable($funcsInclude)) && (!isExtensionLibraryLoaded($ext_name)) && (getExtensionMode() == 'test'));
1831
1832                 // And put in cache, converted
1833                 $GLOBALS['cache_array']['extension']['ext_func'][$ext_name] = convertBooleanToYesNo($isIncludeFound);
1834         }
1835
1836         // Return result
1837         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_func=' . $GLOBALS['cache_array']['extension']['ext_func'][$ext_name]);
1838         return ($GLOBALS['cache_array']['extension']['ext_func'][$ext_name] == 'Y');
1839 }
1840
1841 // Adds a CREATE TABLE statement if the requested table is not there
1842 function addCreateTableSql ($tableName, $sql, $comment) {
1843         // Is the table not there?
1844         if (!ifSqlTableExists($tableName)) {
1845                 // Is not found, so add it
1846                 addExtensionSql('CREATE TABLE
1847         `{?_MYSQL_PREFIX?}_' . $tableName . '` (' . $sql . ')
1848 ENGINE = {?_TABLE_TYPE?}
1849 CHARACTER SET utf8
1850 COLLATE utf8_general_ci
1851 COMMENT ' . chr(39) . $comment . chr(39));
1852         } else {
1853                 // Is already there, which should not happen
1854                 reportBug(__FUNCTION__, __LINE__, 'The table ' . $tableName . ' is already created which should not happen.');
1855         }
1856 }
1857
1858 // Adds a DROP TABLE statement if the requested tabled is there
1859 function addDropTableSql ($tableName) {
1860         // Is the table there?
1861         if (ifSqlTableExists($tableName)) {
1862                 // Then add it, non-existing tables can be ignored because it will
1863                 // happen with every newly installed extension.
1864                 addExtensionSql('DROP TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '`');
1865
1866                 // Mark it as gone
1867                 $GLOBALS['ifSqlTableExists'][$tableName] = false;
1868         } // END - if
1869 }
1870
1871 // Adds a RENAME TABLE stament if 'from' table exist and 'to' table not
1872 function addRenameTableSql ($fromTable, $toTable) {
1873         // Is renaming required?
1874         if ((ifSqlTableExists($fromTable)) && (!ifSqlTableExists($toTable))) {
1875                 // Add it
1876                 addExtensionSql('RENAME TABLE `{?_MYSQL_PREFIX?}_' . $fromTable . '` TO `{?_MYSQL_PREFIX?}_' . $toTable . '`');
1877
1878                 // Mark both tables
1879                 $GLOBALS['ifSqlTableExists'][$fromTable] = false;
1880                 $GLOBALS['ifSqlTableExists'][$toTable]   = true;
1881         } // END - if
1882 }
1883
1884 // Adds an admin menu to the SQL queue of the menu entry is not found
1885 function addAdminMenuSql ($action, $what, $title, $descr, $sort) {
1886         // Now check if this menu is there
1887         if (!isMenuActionValid('admin', $action, $what)) {
1888                 // Is what null?
1889                 if (is_null($what)) {
1890                         // Add main menu
1891                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES ('%s',NULL,'%s','%s',%s)",
1892                                 $action,
1893                                 $title,
1894                                 $descr,
1895                                 bigintval($sort)
1896                         );
1897                 } else {
1898                         // Add sub menu
1899                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES ('%s','%s','%s','%s',%s)",
1900                                 $action,
1901                                 $what,
1902                                 $title,
1903                                 $descr,
1904                                 bigintval($sort)
1905                         );
1906                 }
1907
1908                 // Add it to the queue
1909                 addExtensionSql($sql);
1910         } elseif (isDebugModeEnabled()) {
1911                 // Double menus should be located and fixed!
1912                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double admin menu action=%s,what=%s,title=%s detected.", $action, $what, $title));
1913         }
1914 }
1915
1916 // Adds a guest menu to the SQL queue if the menu entry is not found
1917 function addGuestMenuSql ($action, $what, $title, $sort) {
1918         // Now check if this menu is there
1919         if (!isMenuActionValid('guest', $action, $what)) {
1920                 // Is what null?
1921                 if (is_null($what)) {
1922                         // Add main menu
1923                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('%s',NULL,'%s','N','Y',%s)",
1924                                 $action,
1925                                 $title,
1926                                 bigintval($sort)
1927                         );
1928                 } else {
1929                         // Add sub menu
1930                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('%s','%s','%s','N','Y',%s)",
1931                                 $action,
1932                                 $what,
1933                                 $title,
1934                                 bigintval($sort)
1935                         );
1936                 }
1937
1938                 // Add it to the queue
1939                 addExtensionSql($sql);
1940         } elseif (isDebugModeEnabled()) {
1941                 // Double menus should be located and fixed!
1942                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double guest menu action=%s,what=%s,title=%s detected.", $action, $what, $title));
1943         }
1944 }
1945
1946 // Adds a member menu to the SQL queue if the menu entry is not found
1947 function addMemberMenuSql ($action, $what, $title, $sort) {
1948         // Now check if this menu is there
1949         if (!isMenuActionValid('member', $action, $what)) {
1950                 // Is what null?
1951                 if (is_null($what)) {
1952                         // Add main menu
1953                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_member_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('%s',NULL,'%s','N','Y',%s)",
1954                                 $action,
1955                                 $title,
1956                                 bigintval($sort)
1957                         );
1958                 } else {
1959                         // Add sub menu
1960                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_member_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('%s','%s','%s','N','Y',%s)",
1961                                 $action,
1962                                 $what,
1963                                 $title,
1964                                 bigintval($sort)
1965                         );
1966                 }
1967
1968                 // Add it to the queue
1969                 addExtensionSql($sql);
1970         } elseif (isDebugModeEnabled()) {
1971                 // Double menus should be located and fixed!
1972                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double member menu action=%s,what=%s,title=%s detected.", $action, $what, $title));
1973         }
1974 }
1975
1976 // Adds a sponsor menu to the SQL queue if the menu entry is not found
1977 function addSponsorMenuSql ($action, $what, $title, $active, $sort) {
1978         // Now check if this menu is there, if no ext-sponsor is installed all is not yet added
1979         if ((!isExtensionInstalled('sponsor')) || (!isMenuActionValid('sponsor', $action, $what))) {
1980                 // Is what null?
1981                 if (is_null($what)) {
1982                         // Add main menu
1983                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_menu` (`action`,`what`,`title`,`active`,`sort`) VALUES ('%s',NULL,'%s','%s',%s)",
1984                                 $action,
1985                                 $title,
1986                                 $active,
1987                                 bigintval($sort)
1988                         );
1989                 } else {
1990                         // Add sub menu
1991                         $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_menu` (`action`,`what`,`title`,`active`,`sort`) VALUES ('%s','%s','%s','%s',%s)",
1992                                 $action,
1993                                 $what,
1994                                 $title,
1995                                 $active,
1996                                 bigintval($sort)
1997                         );
1998                 }
1999
2000                 // Add it to the queue
2001                 addExtensionSql($sql);
2002         } elseif (isDebugModeEnabled()) {
2003                 // Double menus should be located and fixed!
2004                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double sponsor menu action=%s,what=%s,title=%s,active=%s detected.", $action, $what, $title, $active));
2005         }
2006 }
2007
2008 // Add configuration entry if not found for actual extension
2009 function addConfigAddSql ($columnName, $columnSql) {
2010         // Is the column there?
2011         if (!ifSqlColumnExists('{?_MYSQL_PREFIX?}_config', $columnName)) {
2012                 // Not found, so add it
2013                 addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `' . $columnName . '` ' . $columnSql);
2014         } elseif (isDebugModeEnabled()) {
2015                 // Add debug line
2016                 logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' already created. columnSql=' . $columnSql);
2017         }
2018 }
2019
2020 // Drop configuration entry if found for actual extension
2021 function addConfigDropSql ($columnName) {
2022         // Is the column there?
2023         if (ifSqlColumnExists('{?_MYSQL_PREFIX?}_config', $columnName)) {
2024                 // Found, so add it
2025                 addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` DROP `' . $columnName . '`');
2026         } elseif (isDebugModeEnabled()) {
2027                 // Add debug line, reportBug() would cause some extenion updates fail
2028                 logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' not found.');
2029         }
2030 }
2031
2032 // Change configuration entry for actual extension
2033 function addConfigChangeSql ($oldColumnName, $newColumnName, $columnSql) {
2034         // Add the SQL statement
2035         addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` CHANGE `' . $oldColumnName . '` `' . $newColumnName . '` ' . $columnSql);
2036 }
2037
2038 /**
2039  * Checks if given subject is found and if not, adds an SQL query to the
2040  * extension registration queue.
2041  */
2042 function registerExtensionPointsData ($subject, $columnName, $lockedMode, $paymentMethod) {
2043         // Default is old extension version
2044         $add = '';
2045
2046         // Is the extension equal or newer 0.8.9?
2047         if (((isInstallationPhase()) && ((getExtensionMode() == 'register') || (getExtensionMode() == 'update'))) || (isExtensionInstalledAndNewer('sql_patches', '0.8.9'))) {
2048                 // Then add provider
2049                 $add = " AND `account_provider`='EXTENSION'";
2050         } // END - if
2051
2052         // Is the 'subject' there?
2053         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ifSqlTableExists(points_data)=' . ifSqlTableExists('points_data') . ',getExtensionMode()=' . getExtensionMode() . ',add=' . $add);
2054         if (((!ifSqlTableExists('points_data')) && ((getExtensionMode() == 'register') || (getExtensionMode() == 'update'))) || (countSumTotalData($subject, 'points_data', 'id', 'subject', true, $add) == 0)) {
2055                 // Not found so:
2056                 if ((isset($GLOBALS['previous_extension'][getCurrentExtensionName()])) && (!ifSqlTableExists('points_data'))) {
2057                         $dummy = $GLOBALS['previous_extension'][getCurrentExtensionName()];
2058                         reportBug(__FUNCTION__, __LINE__, 'previous_extension[' . gettype($dummy) . ']=' . $dummy . ',getCurrentExtensionName()=' . getCurrentExtensionName() . ' - Under development, please report this!');
2059                 } // END - if
2060
2061                 // ... add an SQL query
2062                 addExtensionSql(sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_points_data` (`subject`,`column_name`,`locked_mode`,`payment_method`) VALUES ('%s','%s','%s','%s')",
2063                         $subject,
2064                         $columnName,
2065                         $lockedMode,
2066                         $paymentMethod
2067                 ));
2068         } // END - if
2069 }
2070
2071 /**
2072  * Checks if given subject is found and if so, adds an SQL query to the
2073  * extension unregistration queue.
2074  */
2075 function unregisterExtensionPointsData ($subject) {
2076         // Default is old extension version
2077         $add = '';
2078
2079         // Is the extension equal or newer 0.8.9?
2080         if (isExtensionInstalledAndNewer('sql_patches', '0.8.9')) {
2081                 // Then add provider
2082                 $add = " AND `account_provider`='EXTENSION'";
2083         } // END - if
2084
2085         // Is the 'subject' there?
2086         if (countSumTotalData($subject, 'points_data', 'id', 'subject', true, $add) == 1) {
2087                 // Found one or more, so add an SQL query
2088                 addExtensionSql(sprintf("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_points_data` WHERE `subject`='%s'" . $add . " LIMIT 1",
2089                         $subject
2090                 ));
2091         } // END - if
2092 }
2093
2094 // Enables/disables productive mode for current extension (used only while
2095 // registration).
2096 // @TODO This should be rewrittten to allow, more development states, e.g. 'planing','alpha','beta','beta2','stable'
2097 function enableExtensionProductive ($isProductive = true) {
2098         // Log debug message
2099         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',isProductive=', intval($isProductive));
2100
2101         // Set it
2102         $GLOBALS['ext_productive'][getCurrentExtensionName()] = (bool) $isProductive;
2103 }
2104
2105 // Checks whether the extension is in productive phase. If not set, development
2106 // phase (=false) is assumed.
2107 function isExtensionProductive ($ext_name = '') {
2108         // Is the extension name empty? Then use current
2109         if (empty($ext_name)) {
2110                 // Get current extension name
2111                 $ext_name = getCurrentExtensionName();
2112         } // END - if
2113         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
2114
2115         // Is there cache?
2116         if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
2117                 // Load extension only if not yet loaded
2118                 if (!isset($GLOBALS['ext_productive'][$ext_name])) {
2119                         // Load extension in test mode
2120                         loadExtension($ext_name, 'test');
2121                 } // END - if
2122
2123                 // Determine it
2124                 $GLOBALS[__FUNCTION__][$ext_name] = ((isset($GLOBALS['ext_productive'][$ext_name])) && ($GLOBALS['ext_productive'][$ext_name] === true));
2125         } // END - if
2126
2127         // Return result
2128         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',isProductive=', intval($GLOBALS[__FUNCTION__][$ext_name]) . ' - EXIT!');
2129         return $GLOBALS[__FUNCTION__][$ext_name];
2130 }
2131
2132 // Mark extension file as loaded
2133 function markExtensionAsLoaded ($ext_name) {
2134         // Is it already loaded?
2135         if (isExtensionLoaded($ext_name)) {
2136                 // Then abort here
2137                 reportBug(__FUNCTION__, __LINE__, 'Extension ' . $ext_name . ' is already marked as loaded!');
2138         } // END - if
2139
2140         // Mark it
2141         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_loaded=true');
2142         $GLOBALS['ext_loaded']['ext_name'][$ext_name] = true;
2143 }
2144
2145 // Determine whether the given extension is already loaded
2146 function isExtensionLoaded ($ext_name) {
2147         // Is it there?
2148         return ((isset($GLOBALS['ext_loaded']['ext_name'][$ext_name])) && ($GLOBALS['ext_loaded']['ext_name'][$ext_name] === true));
2149 }
2150
2151 // Mark extension's library file as loaded
2152 function markExtensionLibraryAsLoaded ($ext_name) {
2153         // Is it already loaded?
2154         if (isExtensionLibraryLoaded($ext_name)) {
2155                 // Then abort here
2156                 reportBug(__FUNCTION__, __LINE__, 'Extension library ' . $ext_name . ' is already marked as loaded!');
2157         } // END - if
2158
2159         // Mark it
2160         $GLOBALS['ext_loaded']['library'][$ext_name] = true;
2161 }
2162
2163 // Determine whether the given extension's library is already loaded
2164 function isExtensionLibraryLoaded ($ext_name) {
2165         // Is it there?
2166         return ((isset($GLOBALS['ext_loaded']['library'][$ext_name])) && ($GLOBALS['ext_loaded']['library'][$ext_name] === true));
2167 }
2168
2169 // [EOF]
2170 ?>