General directory structure added for debug extension
[mailer.git] / inc / extensions / ext-debug.php
1 <?php
2 /************************************************************************
3  * MXChange v0.2.1                                    Start: 10/12/2008 *
4  * ================                             Last change: 10/12/2008 *
5  *                                                                      *
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  * -------------------------------------------------------------------- *
13  *                                                                      *
14  * -------------------------------------------------------------------- *
15  * Copyright (c) 2003 - 2008 by Roland Haeder                           *
16  * For more information visit: http://www.mxchange.org                  *
17  *                                                                      *
18  * This program is free software; you can redistribute it and/or modify *
19  * it under the terms of the GNU General Public License as published by *
20  * the Free Software Foundation; either version 2 of the License, or    *
21  * (at your option) any later version.                                  *
22  *                                                                      *
23  * This program is distributed in the hope that it will be useful,      *
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
26  * GNU General Public License for more details.                         *
27  *                                                                      *
28  * You should have received a copy of the GNU General Public License    *
29  * along with this program; if not, write to the Free Software          *
30  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
31  * MA  02110-1301  USA                                                  *
32  ************************************************************************/
33
34 // Some security stuff...
35 if (!defined('__SECURITY')) {
36         $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
37         require($INC);
38 }
39
40 // Version number
41 $EXT_VERSION = "0.0";
42
43 // Auto-set extension version
44 if (empty($EXT_VER)) $EXT_VER = $EXT_VERSION;
45
46 // Version history array (add more with , "0.1" and so on)
47 $EXT_VER_HISTORY = array("0.0");
48
49 switch ($EXT_LOAD_MODE)
50 {
51 case "register": // Do stuff when installation is running (modules.php?module=admin&action=login is called)
52         // Table for debug log entries
53         $SQLs[] = "DROP TABLE IF EXISTS `"._MYSQL_PREFIX."_debug_log`";
54         $SQLs[] = "CREATE TABLE `"._MYSQL_PREFIX."_debug_log` (
55 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
56 `sender_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
57 `timestamp` TIMESTAMP NOT NULL DEFAULT '0000-00-00 00:00',
58 `file` VARCHAR(255) NOT NULL DEFAULT '',
59 `line` MEDIUMINT NOT NOT NULL DEFAULT 0,
60 `message` LONGTEXT,
61 `comment` TINYTEXT,
62 `status` ENUM('NEW','PENDING','ACCEPTED','FIXED','INVALID','DUBLICATE','SPAM') NOT NULL DEFAULT 'NEW',
63 `inserted` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
64 INDEX (`sender_id`),
65 PRIMARY KEY (`id`)
66 ) TYPE=MyISAM COMMENT='Debug log data'";
67
68         // Table against debug log abuse
69         $SQLs[] = "DROP TABLE IF EXISTS `"._MYSQL_PREFIX."_debug_log_abuse`";
70         $SQLs[] = "CREATE TABLE `"._MYSQL_PREFIX."_debug_log_abuse` (
71 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
72 `client_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
73 `timestamp` TIMESTAMP NOT NULL DEFAULT '0000-00-00 00:00',
74 `raw_data` LONGTEXT,
75 `inserted` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
76 INDEX (`client_id`),
77 PRIMARY KEY (`id`)
78 ) TYPE=MyISAM COMMENT='Debug log abuse'";
79
80         // Table on relay/server for client exchanges
81         $SQLs[] = "DROP TABLE IF EXISTS `"._MYSQL_PREFIX."_debug_client`";
82         $SQLs[] = "CREATE TABLE `"._MYSQL_PREFIX."_debug_client` (
83 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
84 `key` VARCHAR(255) NOT NULL DEFAULT 'SELF',
85 `url` VARCHAR(255) NOT NULL DEFAULT '',
86 `webmaster` VARCHAR(255) NOT NULL DEFAULT '',
87 `title` VARCHAR(255) NOT NULL DEFAULT '',
88 `status` ENUM('ACTIVE','NEW','PENDING','LOCKED','DELETED','SPAM') NOT NULL DEFAULT 'PENDING',
89 `type` ENUM ('CLIENT','RELAY','SERVER') NOT NULL DEFAULT 'CLIENT',
90 `inserted` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
91 `lock_spam_reason` TINYTEXT,
92 UNIQUE (`key`),
93 UNIQUE (`url`),
94 PRIMARY KEY (`id`)
95 ) TYPE=MyISAM COMMENT='Debug clients'";
96
97         // Add this exchange as first client
98         $SQLs[] = "INSERT INTO `"._MYSQL_PREFIX."_debug_client` (`url`,`title`,`webmaster`,`status`) VALUES ('{!URL!}','{!MAIN_TITLE!}','{!WEBMASTER!}','ACTIVE')";
99
100         // Table for debug log <-> client connection
101         $SQLs[] = "DROP TABLE IF EXISTS `"._MYSQL_PREFIX."_debug_client_log`";
102         $SQLs[] = "CREATE TABLE `"._MYSQL_PREFIX."_debug_client_log` (
103 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
104 `client_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 1,
105 `log_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
106 INDEX `client_log` (`client_id`,`log_id`),
107 UNIQUE (`log_id`),
108 PRIMARY KEY (`id`)
109 ) TYPE=MyISAM COMMENT='Debug client <-> log connection'";
110
111         // Guest menus
112         $SQLs[] = "INSERT INTO `"._MYSQL_PREFIX."_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('debug',NULL,'Debug-System','Y','Y',2)";
113         $SQLs[] = "INSERT INTO `"._MYSQL_PREFIX."_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('debug','debug_info','Informationen','Y','Y',1)";
114         $SQLs[] = "INSERT INTO `"._MYSQL_PREFIX."_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('debug','debug_reg','Anmeldung','Y','Y',2)";
115         $SQLs[] = "INSERT INTO `"._MYSQL_PREFIX."_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('debug','debug_unreg','Abmeldung','Y','Y',3)";
116         $SQLs[] = "INSERT INTO `"._MYSQL_PREFIX."_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('debug','debug_pilory','Spam-Pranger','Y','Y',4)";
117
118         // Admin menu
119         $SQLs[] = "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)";
120         $SQLs[] = "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)";
121         $SQLs[] = "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)";
122         $SQLs[] = "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)";
123         $SQLs[] = "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)";
124         $SQLs[] = "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)";
125
126         // Config entries
127         $SQLs[] = "ALTER TABLE `"._MYSQL_PREFIX."_config` ADD `debug_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0";
128         $SQLs[] = "ALTER TABLE `"._MYSQL_PREFIX."_config` ADD `debug_key` VARCHAR(255) NOT NULL DEFAULT ''";
129         $SQLs[] = "ALTER TABLE `"._MYSQL_PREFIX."_config` ADD `debug_mode` ENUM('CLIENT','RELAY','SERVER') NOT NULL DEFAULT 'CLIENT'";
130         $SQLs[] = "ALTER TABLE `"._MYSQL_PREFIX."_config` ADD `debug_new_log` ENUM('ACCEPT','FIRST','REG') NOT NULL DEFAULT 'FIRST'";
131         $SQLs[] = "ALTER TABLE `"._MYSQL_PREFIX."_config` ADD `debug_new_client` ENUM('ACTIVE','NEW','REG') NOT NULL DEFAULT 'NEW'";
132         $SQLs[] = "ALTER TABLE `"._MYSQL_PREFIX."_config` ADD `debug_reject_log` BIGINT(20) UNSIGNED NOT NULL DEFAULT ".(getConfig('one_day') * 30)."";
133         $SQLs[] = "ALTER TABLE `"._MYSQL_PREFIX."_config` ADD `debug_master_url` VARCHAR(255) NOT NULL DEFAULT '{!SERVER_URL!}'";
134         break;
135
136 case "remove": // Do stuff when removing extension
137         // SQL commands to run
138         $SQLs[] = "DROP TABLE IF EXISTS `"._MYSQL_PREFIX."_debug_client_log`";
139         $SQLs[] = "DROP TABLE IF EXISTS `"._MYSQL_PREFIX."_debug_client`";
140         $SQLs[] = "DROP TABLE IF EXISTS `"._MYSQL_PREFIX."_debug_log`";
141         $SQLs[] = "DROP TABLE IF EXISTS `"._MYSQL_PREFIX."_debug_log_abuse`";
142         $SQLs[] = "DELETE LOW_PRIORITY FROM `"._MYSQL_PREFIX."_guest_menu` WHERE `action`='debug' LIMIT 5";
143         $SQLs[] = "DELETE LOW_PRIORITY FROM `"._MYSQL_PREFIX."_admin_menu` WHERE `action`='debug' LIMIT 6";
144         break;
145
146 case "activate": // Do stuff when admin activates this extension
147         // SQL commands to run
148         $SQLs[] = "UPDATE `"._MYSQL_PREFIX."_guest_menu` SET `visible`='Y',`locked`='N' WHERE `action`='debug' LIMIT 5";
149         break;
150
151 case "deactivate": // Do stuff when admin deactivates this extension
152         // SQL commands to run
153         $SQLs[] = "UPDATE `"._MYSQL_PREFIX."_guest_menu` SET `locked`='Y' WHERE `action`='debug' LIMIT 5";
154         break;
155
156 case "update": // Update an extension
157         switch ($EXT_VER)
158         {
159         case "0.0.1": // SQL queries for v0.0.1
160                 $SQLs[] = "";
161
162                 // Update notes (these will be set as task text!)
163                 $UPDATE_NOTES = "";
164                 break;
165         }
166         break;
167
168 case "test": // For testing purposes. For details see file inc/modules/admin/what-extensions.php, arround line 305.
169         break;
170
171 default: // Do stuff when extension is loaded
172         break;
173 }
174
175 // Keep this extension always active!
176 $EXT_ALWAYS_ACTIVE = "Y";
177
178 //
179 ?>