911ee626a09e5be38ccc645cb5afebfd0eb27f30
[mailer.git] / inc / extensions / ext-blacklist.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 01/21/2013 *
4  * ===================                          Last change: 01/21/2013 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : ext-blacklist.php                                *
8  * -------------------------------------------------------------------- *
9  * Short description : Blacklisting of email/URL addresses              *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  :                                                  *
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 - 2013 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 // Version number
44 setThisExtensionVersion('0.0.0');
45
46 // Version history array (add more with , '0.0.1' and so on)
47 setExtensionVersionHistory(array('0.0.0'));
48
49 // This extension is in development (non-productive)
50 enableExtensionProductive(FALSE);
51
52 switch (getExtensionMode()) {
53         case 'setup': // Do stuff when installation is running
54                 // SQL commands to run
55                 addDropTableSql('blacklist');
56                 addCreateTableSql('blacklist', "
57 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
58 `data` VARCHAR(255) NOT NULL DEFAULT '',
59 `pool_id` BIGINT(20) UNSIGNED NULL DEFAULT NULL,
60 `provider` VARCHAR(255) NOT NULL DEFAULT 'BLACKLIST',
61 `type` VARCHAR(20) NOT NULL DEFAULT 'INVALID',
62 `added` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
63 PRIMARY KEY (`id`),
64 INDEX (`provider`),
65 INDEX (`type`),
66 INDEX (`pool_id`)",
67                         'Generic blacklist');
68
69                 // Add admin menu
70                 addAdminMenuSql('setup', 'config_blacklist', 'Sperrlisten', 'Einstellungen zu den Sperrlisten.', 8);
71                 addAdminMenuSql('misc', 'list_blacklist', 'Sperrlisten...', 'Zeigt gesperrte Email-Adressen, IP-Adressen, URLs und vieles mehr an.', 4);
72
73                 // Add configuration
74                 addConfigAddSql('email_blacklist', "ENUM('Y','N') NOT NULL DEFAULT 'Y'");
75                 addConfigAddSql('ip_blacklist', "ENUM('Y','N') NOT NULL DEFAULT 'Y'");
76                 addConfigAddSql('url_blacklist', "ENUM('Y','N') NOT NULL DEFAULT 'Y'");
77
78                 // Register filters
79                 registerFilter(__FILE__, __LINE__, 'pre_user_registration' , 'CHECK_EMAIL_BLACKLISTED', FALSE, TRUE, isExtensionDryRun());
80                 registerFilter(__FILE__, __LINE__, 'pre_user_registration' , 'CHECK_IP_BLACKLISTED'   , FALSE, TRUE, isExtensionDryRun());
81                 registerFilter(__FILE__, __LINE__, 'pre_update_user_data'  , 'CHECK_EMAIL_BLACKLISTED', FALSE, TRUE, isExtensionDryRun());
82                 registerFilter(__FILE__, __LINE__, 'pre_mail_order'        , 'CHECK_URL_BLACKLISTED'  , FALSE, TRUE, isExtensionDryRun());
83                 registerFilter(__FILE__, __LINE__, 'post_email_blacklisted', 'LOG_EMAIL_BLACKLISTED'  , FALSE, TRUE, isExtensionDryRun());
84                 registerFilter(__FILE__, __LINE__, 'post_ip_blacklisted'   , 'LOG_IP_BLACKLISTED'     , FALSE, TRUE, isExtensionDryRun());
85                 registerFilter(__FILE__, __LINE__, 'post_url_blacklisted'  , 'LOG_URL_BLACKLISTED'    , FALSE, TRUE, isExtensionDryRun());
86                 break;
87
88         case 'remove': // Do stuff when removing extension
89                 // SQL commands to run
90                 addDropTableSql('blacklist');
91
92                 // Remove menu
93                 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `what` IN ('config_blacklist', 'list_blacklist')");
94
95                 // Unregister filters
96                 unregisterFilter(__FILE__, __LINE__, 'pre_user_registration' , 'CHECK_EMAIL_BLACKLISTED', TRUE, isExtensionDryRun());
97                 unregisterFilter(__FILE__, __LINE__, 'pre_user_registration' , 'CHECK_IP_BLACKLISTED'   , TRUE, isExtensionDryRun());
98                 unregisterFilter(__FILE__, __LINE__, 'pre_update_user_data'  , 'CHECK_EMAIL_BLACKLISTED', TRUE, isExtensionDryRun());
99                 unregisterFilter(__FILE__, __LINE__, 'pre_mail_order'        , 'CHECK_URL_BLACKLISTED'  , TRUE, isExtensionDryRun());
100                 unregisterFilter(__FILE__, __LINE__, 'post_email_blacklisted', 'LOG_EMAIL_BLACKLISTED'  , TRUE, isExtensionDryRun());
101                 unregisterFilter(__FILE__, __LINE__, 'post_ip_blacklisted'   , 'LOG_IP_BLACKLISTED'     , TRUE, isExtensionDryRun());
102                 unregisterFilter(__FILE__, __LINE__, 'post_url_blacklisted'  , 'LOG_URL_BLACKLISTED'    , TRUE, isExtensionDryRun());
103                 break;
104
105         case 'activate': // Do stuff when admin activates this extension
106                 // SQL commands to run
107                 break;
108
109         case 'deactivate': // Do stuff when admin deactivates this extension
110                 // SQL commands to run
111                 break;
112
113         case 'update': // Update an extension
114                 switch (getCurrentExtensionVersion()) {
115                         case '0.0.1': // SQL queries for v0.0.1
116                                 addExtensionSql('');
117
118                                 // Update notes (these will be set as task text!)
119                                 setExtensionUpdateNotes('');
120                                 break;
121                 } // END - switch
122                 break;
123
124         case 'modify': // When the extension got modified
125                 break;
126
127         case 'test': // For testing purposes
128                 break;
129
130         case 'init': // Do stuff when extension is initialized
131                 break;
132
133         default: // Unknown extension mode
134                 reportBug(__FILE__, __LINE__, sprintf("Unknown extension mode %s in extension %s detected.", getExtensionMode(), getCurrentExtensionName()));
135                 break;
136 } // END - switch
137
138 // [EOF]
139 ?>