2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 10/12/2008 *
4 * =================== Last change: 10/12/2008 *
6 * -------------------------------------------------------------------- *
7 * File : ext-debug.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Extension for sending/receiving debug requests *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Erweiterung zum Versenden/Empfangen von Debug-Q. *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * -------------------------------------------------------------------- *
18 * Copyright (c) 2003 - 2009 by Roland Haeder *
19 * Copyright (c) 2009, 2010 by Mailer Developer Team *
20 * For more information visit: http://www.mxchange.org *
22 * This program is free software; you can redistribute it and/or modify *
23 * it under the terms of the GNU General Public License as published by *
24 * the Free Software Foundation; either version 2 of the License, or *
25 * (at your option) any later version. *
27 * This program is distributed in the hope that it will be useful, *
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
30 * GNU General Public License for more details. *
32 * You should have received a copy of the GNU General Public License *
33 * along with this program; if not, write to the Free Software *
34 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
36 ************************************************************************/
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
44 setThisExtensionVersion('0.0');
46 // Version history array (add more with , '0.1.0' and so on)
47 setExtensionVersionHistory(array('0.0'));
49 // Keep this extension always active!
50 setExtensionAlwaysActive('Y');
52 // This extension is in development (non-productive)
53 enableExtensionProductive(false);
55 switch (getExtensionMode()) {
56 case 'register': // Do stuff when installation is running (modules.php?module=admin is called)
57 // Table for debug log entries
58 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_debug_log`');
59 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_debug_log` (
60 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
61 `sender_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
62 `timestamp` TIMESTAMP NOT NULL DEFAULT '0000-00-00 00:00',
63 `file` VARCHAR(255) NOT NULL DEFAULT '',
64 `line` MEDIUMINT NOT NOT NULL DEFAULT 0,
67 `status` ENUM('NEW','PENDING','ACCEPTED','FIXED','INVALID','DUBLICATE','SPAM') NOT NULL DEFAULT 'NEW',
68 `inserted` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
71 ) TYPE={?_TABLE_TYPE?} COMMENT='Debug log data'");
73 // Table against debug log abuse
74 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_debug_log_abuse`');
75 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_debug_log_abuse` (
76 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
77 `client_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
78 `timestamp` TIMESTAMP NOT NULL DEFAULT '0000-00-00 00:00',
80 `inserted` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
83 ) TYPE={?_TABLE_TYPE?} COMMENT='Debug log abuse'");
85 // Table on relay/server for client exchanges
86 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_debug_client`');
87 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_debug_client` (
88 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
89 `key` VARCHAR(255) NOT NULL DEFAULT 'SELF',
90 `url` VARCHAR(255) NOT NULL DEFAULT '',
91 `webmaster` VARCHAR(255) NOT NULL DEFAULT '',
92 `title` VARCHAR(255) NOT NULL DEFAULT '',
93 `status` ENUM('ACTIVE','NEW','PENDING','LOCKED','DELETED','SPAM') NOT NULL DEFAULT 'PENDING',
94 `type` ENUM ('CLIENT','RELAY','SERVER') NOT NULL DEFAULT 'CLIENT',
95 `inserted` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
96 `lock_spam_reason` TINYTEXT,
100 ) TYPE={?_TABLE_TYPE?} COMMENT='Debug clients'");
102 // Add this exchange as first client
103 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_debug_client` (`url`,`title`,`webmaster`,`status`) VALUES ('{?URL?}','{?MAIN_TITLE?}','{?WEBMASTER?}','ACTIVE')");
105 // Table for debug log <-> client connection
106 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_debug_client_log`');
107 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_debug_client_log` (
108 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
109 `client_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 1,
110 `log_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
111 INDEX `client_log` (`client_id`,`log_id`),
114 ) TYPE={?_TABLE_TYPE?} COMMENT='Debug client <-> log connection'");
117 addGuestMenuSql('debug',NULL,'Debug-System','Y','Y',2);
118 addGuestMenuSql('debug','debug_info','Informationen','Y','Y',1);
119 addGuestMenuSql('debug','debug_reg','Anmeldung','Y','Y',2);
120 addGuestMenuSql('debug','debug_unreg','Abmeldung','Y','Y',3);
121 addGuestMenuSql('debug','debug_pilory','Spam-Pranger','Y','Y',4);
124 addAdminMenuSql('debug',NULL,'Debug-System','Verwalten Sie hier komfortabel das debug.log, welches sich im Verzeichnis <strong>{?CACHE_PATH?}/</strong> befindet.',10);
125 addAdminMenuSql('debug','import_debug','debug.log importieren','Importieren Sie hier manuell die debug.log, damit neue Einträge mit bestehenden abgeglichen werden können und dann evtl. hinzugefügt werden. Die <em>debug.log</em> wird nach dem Import automatisch vom Server entfernt. Dieser Vorgang wird für Sie nachts automatisch erledigt!',1);
126 addAdminMenuSql('debug','list_debug','Einträge anzeigen','Listet alle bereits importierten Einträge auf. Von hier aus versenden Sie noch nicht gemeldete Fehler an das Relay-Netzwerk, damt diese vom Entwicklerteam geprüft werden können.',2);
127 addAdminMenuSql('debug','reg_debug','Am Server anmelden','Sie müssen zuerst Ihren Debug-Client (Ihr {?mt_word?} ist dies) oder Relay am Server von mxchange.org anmelden. Dies geschieht für Sie nicht automatisch, da Sie Ihre Daten zuvor überprüfen müssen, wie z.B. URL, eMail-Adresse und {?mt_word?}-Titel.',3);
128 addAdminMenuSql('debug','unreg_debug','Vom Server abmelden','Melden Sie bitte Ihren {?mt_word?} wieder vom Projekt-Server ab, damit mein Entwicklerteam weiss, welche Keys nicht mehr genutzt werden.',4);
129 addAdminMenuSql('debug','config_debug','Einstellungen','Ä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's Forum. Das Team von mxchange.org hilft Ihnen gerne weiter.',5);
132 addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `debug_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0");
133 addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `debug_key` VARCHAR(255) NOT NULL DEFAULT ''");
134 addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `debug_mode` ENUM('CLIENT','RELAY','SERVER') NOT NULL DEFAULT 'CLIENT'");
135 addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `debug_new_log` ENUM('ACCEPT','FIRST','REG') NOT NULL DEFAULT 'FIRST'");
136 addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `debug_new_client` ENUM('ACTIVE','NEW','REG') NOT NULL DEFAULT 'NEW'");
137 addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `debug_reject_log` BIGINT(20) UNSIGNED NOT NULL DEFAULT " . (getOneDay() * 30));
138 addExtensionSql("ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `debug_master_url` VARCHAR(255) NOT NULL DEFAULT '{?SERVER_URL?}'");
141 case 'remove': // Do stuff when removing extension
142 // SQL commands to run
143 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_debug_client_log`');
144 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_debug_client`');
145 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_debug_log`');
146 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_debug_log_abuse`');
147 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_guest_menu` WHERE `action`='debug'");
148 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `action`='debug'");
151 case 'activate': // Do stuff when admin activates this extension
152 // SQL commands to run
153 addExtensionSql("UPDATE `{?_MYSQL_PREFIX?}_guest_menu` SET `visible`='Y',`locked`='N' WHERE `action`='debug' LIMIT 5");
156 case 'deactivate': // Do stuff when admin deactivates this extension
157 // SQL commands to run
158 addExtensionSql("UPDATE `{?_MYSQL_PREFIX?}_guest_menu` SET `locked`='Y' WHERE `action`='debug' LIMIT 5");
161 case 'update': // Update an extension
162 switch (getCurrentExtensionVersion()) {
163 case '0.0.1': // SQL queries for v0.0.1
166 // Update notes (these will be set as task text!)
167 setExtensionUpdateNotes('');
172 case 'modify': // When the extension got modified
175 case 'test': // For testing purposes. For details see file inc/modules/admin/what-extensions.php, arround line 305.
178 case 'init': // Do stuff when extension is initialized
181 default: // Unknown extension mode
182 logDebugMessage(__FILE__, __LINE__, sprintf("Unknown extension mode %s in extension %s detected.", getExtensionMode(), getCurrentExtensionName()));