Rewrote some parts:
[mailer.git] / inc / extensions / ext-debug.php
index 9b2ce2e6c8fc65f8f6d642c2b8ff7b17cb96f623..9a3296b7ef1aa6498d167e20d8d6eef59ee3cd52 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /************************************************************************
- * MXChange v0.2.1                                    Start: 10/12/2008 *
- * ================                             Last change: 10/12/2008 *
+ * Mailer v0.2.1-FINAL                                Start: 10/12/2008 *
+ * ===================                          Last change: 10/12/2008 *
  *                                                                      *
  * -------------------------------------------------------------------- *
  * File              : ext-debug.php                                    *
  * $Date::                                                            $ *
  * $Tag:: 0.2.1-FINAL                                                 $ *
  * $Author::                                                          $ *
- * Needs to be in all Files and every File needs "svn propset           *
- * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
- * Copyright (c) 2003 - 2008 by Roland Haeder                           *
- * For more information visit: http://www.mxchange.org                  *
+ * Copyright (c) 2003 - 2009 by Roland Haeder                           *
+ * Copyright (c) 2009 - 2013 by Mailer Developer Team                   *
+ * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
  * it under the terms of the GNU General Public License as published by *
 
 // Some security stuff...
 if (!defined('__SECURITY')) {
-       $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
-       require($INC);
-}
+       die();
+} // END - if
 
 // Version number
-EXT_SET_VERSION('0.0');
+setThisExtensionVersion('0.0.0');
 
-// Version history array (add more with , '0.1.0' and so on)
-EXT_SET_VER_HISTORY(array('0.0'));
+// Version history array (add more with , '0.0.1' and so on)
+setExtensionVersionHistory(array('0.0.0'));
 
-switch ($EXT_LOAD_MODE)
-{
-       case 'register': // Do stuff when installation is running (modules.php?module=admin is called)
+// Keep this extension always active!
+setExtensionAlwaysActive('Y');
+
+// This extension is in development (non-productive)
+enableExtensionProductive(FALSE);
+
+switch (getExtensionMode()) {
+       case 'setup': // Do stuff when installation is running
                // Table for debug log entries
-               ADD_EXT_SQL("DROP TABLE IF EXISTS `{!_MYSQL_PREFIX!}_debug_log`");
-               ADD_EXT_SQL("CREATE TABLE `{!_MYSQL_PREFIX!}_debug_log` (
+               addDropTableSql('debug_log');
+               addCreateTableSql('debug_log', "
 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
 `sender_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 `timestamp` TIMESTAMP NOT NULL DEFAULT '0000-00-00 00:00',
 `file` VARCHAR(255) NOT NULL DEFAULT '',
-`line` MEDIUMINT NOT NOT NULL DEFAULT 0,
-`message` LONGTEXT,
-`comment` TINYTEXT,
+`line` MEDIUMINT NOT NULL DEFAULT 0,
+`message` LONGTEXT NOT NULL,
+`comment` TINYTEXT NOT NULL,
 `status` ENUM('NEW','PENDING','ACCEPTED','FIXED','INVALID','DUBLICATE','SPAM') NOT NULL DEFAULT 'NEW',
 `inserted` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
-INDEX (`sender_id`),
-PRIMARY KEY (`id`)
-) TYPE={!_TABLE_TYPE!} COMMENT='Debug log data'");
+PRIMARY KEY (`id`),
+INDEX (`sender_id`)",
+                       'Debug log data');
 
                // Table against debug log abuse
-               ADD_EXT_SQL("DROP TABLE IF EXISTS `{!_MYSQL_PREFIX!}_debug_log_abuse`");
-               ADD_EXT_SQL("CREATE TABLE `{!_MYSQL_PREFIX!}_debug_log_abuse` (
+               addDropTableSql('debug_log_abuse');
+               addCreateTableSql('debug_log_abuse', "
 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
 `client_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 `timestamp` TIMESTAMP NOT NULL DEFAULT '0000-00-00 00:00',
-`raw_data` LONGTEXT,
+`raw_data` LONGTEXT NOT NULL,
 `inserted` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
-INDEX (`client_id`),
-PRIMARY KEY (`id`)
-) TYPE={!_TABLE_TYPE!} COMMENT='Debug log abuse'");
+PRIMARY KEY (`id`),
+INDEX (`client_id`)",
+                       'Debug log abuse');
 
                // Table on relay/server for client exchanges
-               ADD_EXT_SQL("DROP TABLE IF EXISTS `{!_MYSQL_PREFIX!}_debug_client`");
-               ADD_EXT_SQL("CREATE TABLE `{!_MYSQL_PREFIX!}_debug_client` (
+               addDropTableSql('debug_client');
+               addCreateTableSql('debug_client', "
 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
 `key` VARCHAR(255) NOT NULL DEFAULT 'SELF',
 `url` VARCHAR(255) NOT NULL DEFAULT '',
@@ -90,95 +93,95 @@ PRIMARY KEY (`id`)
 `status` ENUM('ACTIVE','NEW','PENDING','LOCKED','DELETED','SPAM') NOT NULL DEFAULT 'PENDING',
 `type` ENUM ('CLIENT','RELAY','SERVER') NOT NULL DEFAULT 'CLIENT',
 `inserted` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
-`lock_spam_reason` TINYTEXT,
-UNIQUE (`key`),
-UNIQUE (`url`),
-PRIMARY KEY (`id`)
-) TYPE={!_TABLE_TYPE!} COMMENT='Debug clients'");
+`lock_spam_reason` TINYTEXT NOT NULL,
+PRIMARY KEY (`id`),
+UNIQUE INDEX (`key`),
+UNIQUE INDEX (`url`)",
+                       'Debug clients');
 
                // Add this exchange as first client
-               ADD_EXT_SQL("INSERT INTO `{!_MYSQL_PREFIX!}_debug_client` (`url`,`title`,`webmaster`,`status`) VALUES ('{!URL!}','{!MAIN_TITLE!}','{!WEBMASTER!}','ACTIVE')");
+               addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_debug_client` (`url`, `title`, `webmaster`, `status`) VALUES ('{?URL?}','{?MAIN_TITLE?}','{?WEBMASTER?}','ACTIVE')");
 
                // Table for debug log <-> client connection
-               ADD_EXT_SQL("DROP TABLE IF EXISTS `{!_MYSQL_PREFIX!}_debug_client_log`");
-               ADD_EXT_SQL("CREATE TABLE `{!_MYSQL_PREFIX!}_debug_client_log` (
+               addDropTableSql('debug_client_log');
+               addCreateTableSql('debug_client_log', "
 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
-`client_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 1,
+`client_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
 `log_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
-INDEX `client_log` (`client_id`,`log_id`),
-UNIQUE (`log_id`),
-PRIMARY KEY (`id`)
-) TYPE={!_TABLE_TYPE!} COMMENT='Debug client <-> log connection'");
+PRIMARY KEY (`id`),
+UNIQUE INDEX (`log_id`),
+INDEX `client_log` (`client_id`, `log_id`)",
+                       'Debug client <-> log connection');
 
                // Guest menus
-               ADD_EXT_SQL("INSERT INTO `{!_MYSQL_PREFIX!}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('debug',NULL,'Debug-System','Y','Y',2)");
-               ADD_EXT_SQL("INSERT INTO `{!_MYSQL_PREFIX!}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('debug','debug_info','Informationen','Y','Y',1)");
-               ADD_EXT_SQL("INSERT INTO `{!_MYSQL_PREFIX!}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('debug','debug_reg','Anmeldung','Y','Y',2)");
-               ADD_EXT_SQL("INSERT INTO `{!_MYSQL_PREFIX!}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('debug','debug_unreg','Abmeldung','Y','Y',3)");
-               ADD_EXT_SQL("INSERT INTO `{!_MYSQL_PREFIX!}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('debug','debug_pilory','Spam-Pranger','Y','Y',4)");
+               addGuestMenuSql('debug', NULL, 'Debug-System', 2);
+               addGuestMenuSql('debug', 'debug_info', 'Informationen', 1);
+               addGuestMenuSql('debug', 'debug_reg', 'Anmeldung', 2);
+               addGuestMenuSql('debug', 'debug_unreg', 'Abmeldung', 3);
+               addGuestMenuSql('debug', 'debug_pilory', 'Spam-Pranger', 4);
 
                // Admin menu
-               ADD_EXT_SQL("INSERT INTO `{!_MYSQL_PREFIX!}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES ('debug',NULL,'Debug-System','Verwalten Sie hier komfortabel das debug.log, welches sich im Verzeichnis <strong>inc/cache/</strong> befindet.',10)");
-               ADD_EXT_SQL("INSERT INTO `{!_MYSQL_PREFIX!}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES ('debug','import_debug','debug.log importieren','Importieren Sie hier manuell die debug.log, damit neue Eintr&auml;ge mit bestehenden abgeglichen werden k&ouml;nnen und dann evtl. hinzugef&uuml;gt werden. Die <em>debug.log</em> wird nach dem Import automatisch vom Server entfernt. Dieser Vorgang wird f&uuml;r Sie nachts automatisch erledigt!',1)");
-               ADD_EXT_SQL("INSERT INTO `{!_MYSQL_PREFIX!}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES ('debug','list_debug','Eintr&auml;ge anzeigen','Listet alle bereits importierten Eintr&auml;ge auf. Von hier aus versenden Sie noch nicht gemeldete Fehler an das Relay-Netzwerk, damt diese vom MXChange-Team gepr&uuml;ft werden k&ouml;nnen.',2)");
-               ADD_EXT_SQL("INSERT INTO `{!_MYSQL_PREFIX!}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES ('debug','reg_debug','Am Server anmelden','Sie m&uuml;ssen zuerst Ihren Debug-Client (Ihr {!MT_WORD!} ist dies) oder Relay am Server von MXChange.org anmelden. Dies geschieht f&uuml;r Sie nicht automatisch, da Sie Ihre Daten zuvor &uuml;berpr&uuml;fen m&uuml;ssen, wie z.B. URL, eMail-Adresse und {!MT_WORD!}-Titel.',3)");
-               ADD_EXT_SQL("INSERT INTO `{!_MYSQL_PREFIX!}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES ('debug','unreg_debug','Vom Server abmelden','Melden Sie bitte Ihren {!MT_WORD!} wieder vom MXChange-Server ab, damit das Team von MXChange.org weiss, welche Keys nicht mehr genutzt werden.',4)");
-               ADD_EXT_SQL("INSERT INTO `{!_MYSQL_PREFIX!}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES ('debug','config_debug','Einstellungen','&Auml;ndern Sie hier alle Einstellungen, wie auch den Debug-Modus - ob Client, Hub oder selber Server sein. Lesen Sie dazu die Anleitung unter DOCs/de/debug/README.txt durch! Oder kommen Sie in&#39;s Forum. Das Team von MXChange.org hilft Ihnen gerne weiter.',5)");
+               addAdminMenuSql('debug', NULL, 'Debug-System', 'Verwalten Sie hier komfortabel das debug.log, welches sich im Verzeichnis <strong>{?CACHE_PATH?}</strong> befindet.', 10);
+               addAdminMenuSql('debug', 'import_debug', 'debug.log importieren', 'Importieren Sie hier manuell die debug.log, damit neue Eintr&auml;ge mit bestehenden abgeglichen werden k&ouml;nnen und dann evtl. hinzugef&uuml;gt werden. Die <span class="notice">debug.log</span> wird nach dem Import automatisch vom Server entfernt. Dieser Vorgang wird f&uuml;r Sie nachts automatisch erledigt!', 1);
+               addAdminMenuSql('debug', 'list_debug', 'Eintr&auml;ge anzeigen', 'Listet alle bereits importierten Eintr&auml;ge auf. Von hier aus versenden Sie noch nicht gemeldete Fehler an das Relay-Netzwerk, damt diese vom {?TITLE?}-Entwicklerteam gepr&uuml;ft werden k&ouml;nnen.', 2);
+               addAdminMenuSql('debug', 'reg_debug', 'Am Server anmelden', 'Sie m&uuml;ssen zuerst Ihren Debug-Client (Ihr {?mt_word?} ist dies) oder Relay am Server von mxchange.org anmelden. Dies geschieht f&uuml;r Sie nicht automatisch, da Sie Ihre Daten zuvor &uuml;berpr&uuml;fen m&uuml;ssen, wie z.B. URL, eMail-Adresse und {?mt_word?}-Titel.', 3);
+               addAdminMenuSql('debug', 'unreg_debug', 'Vom Server abmelden', 'Melden Sie bitte Ihren {?mt_word?} wieder vom Projekt-Server ab, damit mein {?TITLE?}-Entwicklerteam weiss, welche Keys nicht mehr genutzt werden.', 4);
+               addAdminMenuSql('debug', 'config_debug', 'Einstellungen', '&Auml;ndern Sie hier alle Einstellungen, wie auch den Debug-Modus - ob Client, Hub oder selber Server sein. Lesen Sie dazu die Anleitung unter DOCs/de/debug/README.txt durch! Oder kommen Sie in&#39;s Forum. Das Team von mxchange.org hilft Ihnen gerne weiter.', 5);
 
                // Config entries
-               ADD_EXT_SQL("ALTER TABLE `{!_MYSQL_PREFIX!}_config` ADD `debug_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0");
-               ADD_EXT_SQL("ALTER TABLE `{!_MYSQL_PREFIX!}_config` ADD `debug_key` VARCHAR(255) NOT NULL DEFAULT ''");
-               ADD_EXT_SQL("ALTER TABLE `{!_MYSQL_PREFIX!}_config` ADD `debug_mode` ENUM('CLIENT','RELAY','SERVER') NOT NULL DEFAULT 'CLIENT'");
-               ADD_EXT_SQL("ALTER TABLE `{!_MYSQL_PREFIX!}_config` ADD `debug_new_log` ENUM('ACCEPT','FIRST','REG') NOT NULL DEFAULT 'FIRST'");
-               ADD_EXT_SQL("ALTER TABLE `{!_MYSQL_PREFIX!}_config` ADD `debug_new_client` ENUM('ACTIVE','NEW','REG') NOT NULL DEFAULT 'NEW'");
-               ADD_EXT_SQL("ALTER TABLE `{!_MYSQL_PREFIX!}_config` ADD `debug_reject_log` BIGINT(20) UNSIGNED NOT NULL DEFAULT ".(getConfig('one_day') * 30)."");
-               ADD_EXT_SQL("ALTER TABLE `{!_MYSQL_PREFIX!}_config` ADD `debug_master_url` VARCHAR(255) NOT NULL DEFAULT '{!SERVER_URL!}'");
+               addConfigAddSql('debug_id', 'BIGINT(20) UNSIGNED NOT NULL DEFAULT 0');
+               addConfigAddSql('debug_key', "VARCHAR(255) NOT NULL DEFAULT ''");
+               addConfigAddSql('debug_mode', "ENUM('CLIENT','RELAY','SERVER') NOT NULL DEFAULT 'CLIENT'");
+               addConfigAddSql('debug_new_log', "ENUM('ACCEPT','FIRST','REG') NOT NULL DEFAULT 'FIRST'");
+               addConfigAddSql('debug_new_client', "ENUM('ACTIVE','NEW','REG') NOT NULL DEFAULT 'NEW'");
+               addConfigAddSql('debug_reject_log', 'BIGINT(20) UNSIGNED NOT NULL DEFAULT ' . (getOneDay() * 30));
+               addConfigAddSql('debug_master_url', "VARCHAR(255) NOT NULL DEFAULT '{?SERVER_URL?}'");
                break;
 
        case 'remove': // Do stuff when removing extension
                // SQL commands to run
-               ADD_EXT_SQL("DROP TABLE IF EXISTS `{!_MYSQL_PREFIX!}_debug_client_log`");
-               ADD_EXT_SQL("DROP TABLE IF EXISTS `{!_MYSQL_PREFIX!}_debug_client`");
-               ADD_EXT_SQL("DROP TABLE IF EXISTS `{!_MYSQL_PREFIX!}_debug_log`");
-               ADD_EXT_SQL("DROP TABLE IF EXISTS `{!_MYSQL_PREFIX!}_debug_log_abuse`");
-               ADD_EXT_SQL("DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_guest_menu` WHERE `action`='debug'");
-               ADD_EXT_SQL("DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_admin_menu` WHERE `action`='debug'");
+               addDropTableSql('debug_client_log');
+               addDropTableSql('debug_client');
+               addDropTableSql('debug_log');
+               addDropTableSql('debug_log_abuse');
+               addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_guest_menu` WHERE `action`='debug'");
+               addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `action`='debug'");
                break;
 
        case 'activate': // Do stuff when admin activates this extension
                // SQL commands to run
-               ADD_EXT_SQL("UPDATE `{!_MYSQL_PREFIX!}_guest_menu` SET `visible`='Y',`locked`='N' WHERE `action`='debug' LIMIT 5");
+               addExtensionSql("UPDATE `{?_MYSQL_PREFIX?}_guest_menu` SET `visible`='Y',`locked`='N' WHERE `action`='debug' LIMIT 5");
                break;
 
        case 'deactivate': // Do stuff when admin deactivates this extension
                // SQL commands to run
-               ADD_EXT_SQL("UPDATE `{!_MYSQL_PREFIX!}_guest_menu` SET `locked`='Y' WHERE `action`='debug' LIMIT 5");
+               addExtensionSql("UPDATE `{?_MYSQL_PREFIX?}_guest_menu` SET `locked`='Y' WHERE `action`='debug' LIMIT 5");
                break;
 
        case 'update': // Update an extension
-               switch ($EXT_VER)
-               {
+               switch (getCurrentExtensionVersion()) {
                        case '0.0.1': // SQL queries for v0.0.1
-                               ADD_EXT_SQL('');
+                               addExtensionSql('');
 
                                // Update notes (these will be set as task text!)
-                               EXT_SET_UPDATE_NOTES('');
+                               setExtensionUpdateNotes('');
                                break;
-               }
+               } // END - switch
                break;
 
-                       case 'modify': // When the extension got modified
-                               break;
+       case 'modify': // When the extension got modified
+               break;
 
-                       case 'test': // For testing purposes. For details see file inc/modules/admin/what-extensions.php, arround line 305.
-                               break;
+       case 'test': // For testing purposes
+               break;
 
-                       default: // Do stuff when extension is loaded
-                               break;
-}
+       case 'init': // Do stuff when extension is initialized
+               break;
 
-// Keep this extension always active!
-EXT_SET_ALWAYS_ACTIVE('Y');
+       default: // Unknown extension mode
+               reportBug(__FILE__, __LINE__, sprintf('Unknown extension mode %s in extension %s detected.', getExtensionMode(), getCurrentExtensionName()));
+               break;
+} // END - switch
 
-//
+// [EOF]
 ?>