1635a7c6c7ad1b74f76d18aca9c0ccbdad5316db
[mailer.git] / inc / extensions / ext-network.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 12/18/2008 *
4  * ===================                          Last change: 11/01/2009 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : ext-network.php                                  *
8  * -------------------------------------------------------------------- *
9  * Short description : Generic (sponsor) network connection extension   *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Allgemeine Werbenetzwerk-Erweiterung             *
12  * -------------------------------------------------------------------- *
13  * $Revision::                                                        $ *
14  * $Date::                                                            $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author::                                                          $ *
17  * Needs to be in all Files and every File needs "svn propset           *
18  * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
19  * -------------------------------------------------------------------- *
20  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
21  * For more information visit: http://www.mxchange.org                  *
22  *                                                                      *
23  * This program is free software; you can redistribute it and/or modify *
24  * it under the terms of the GNU General Public License as published by *
25  * the Free Software Foundation; either version 2 of the License, or    *
26  * (at your option) any later version.                                  *
27  *                                                                      *
28  * This program is distributed in the hope that it will be useful,      *
29  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
31  * GNU General Public License for more details.                         *
32  *                                                                      *
33  * You should have received a copy of the GNU General Public License    *
34  * along with this program; if not, write to the Free Software          *
35  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
36  * MA  02110-1301  USA                                                  *
37  ************************************************************************/
38
39 // Some security stuff...
40 if (!defined('__SECURITY')) {
41         die();
42 } // END - if
43
44 // Version number
45 setThisExtensionVersion('0.0');
46
47 // Version history array (add more with , '0.1.0' and so on)
48 setExtensionVersionHistory(array('0.0'));
49
50 // This extension is in development (non-productive)
51 enableExtensionProductive(false);
52
53 switch (getExtensionMode()) {
54         case 'register': // Do stuff when installation is running (modules.php?module=admin is called)
55                 // Main table which hold
56                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_data`');
57                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_data` (
58 `network_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
59 `network_short_name` VARCHAR(50) NOT NULL DEFAULT '',
60 `network_title` VARCHAR(255) NOT NULL DEFAULT '',
61 `network_reflink` VARCHAR(255) NOT NULL DEFAULT '',
62 `network_data_seperator` CHAR(4) NOT NULL DEFAULT '|',
63 `network_row_seperator` CHAR(4) NOT NULL DEFAULT '|',
64 `network_request_type` ENUM('GET','POST') NOT NULL DEFAULT 'GET',
65 `network_charset` VARCHAR(20) NOT NULL DEFAULT 'UTF-8',
66 UNIQUE (`network_short_name`),
67 PRIMARY KEY (`network_id`)
68 ) TYPE={?_TABLE_TYPE?} COMMENT='Network data'");
69
70                 // Types the network provider is supporting (e.g. Forced-Banner and so on)
71                 // @TODO network_type_handle is an internal name and needs documentation
72                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_types`');
73                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_types` (
74 `network_type_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
75 `network_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
76 `network_type_handle` VARCHAR(255) NOT NULL DEFAULT '',
77 `network_type_api_url` VARCHAR(255) NOT NULL DEFAULT '',
78 `network_type_click_url` VARCHAR(255) NOT NULL DEFAULT '',
79 `network_type_banner_url` VARCHAR(255) NOT NULL DEFAULT '',
80 UNIQUE `provider_type` (`network_id`,`network_type_handle`),
81 PRIMARY KEY (`network_type_id`)
82 ) TYPE={?_TABLE_TYPE?} COMMENT='Types provideable by networks'");
83
84                 // HTTP parameters (names) for URLs
85                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_request_params`');
86                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_request_params` (
87 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
88 `request_param_max_reload_time` VARCHAR(10) NOT NULL DEFAULT 'reload',
89 `request_param_min_waiting_time` VARCHAR(10) NOT NULL DEFAULT 'ma',
90 `request_param_min_remain_clicks` VARCHAR(10) NOT NULL DEFAULT 'uebrig',
91 `request_param_min_payment` VARCHAR(10) NOT NULL DEFAULT 'verguetung',
92 `request_param_allow_erotic` VARCHAR(10) NOT NULL DEFAULT 'erotik',
93 PRIMARY KEY (`network_type_id`)
94 ) TYPE={?_TABLE_TYPE?} COMMENT='Request parameters for GET/POST request'");
95
96                 // Error status codes
97                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_type_codes`');
98                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_type_codes` (
99 `network_type_code_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
100 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
101 `network_type_code_value` VARCHAR(50) NOT NULL DEFAULT '',
102 `network_type_code_type` VARCHAR(100) NOT NULL DEFAULT 'INVALID_TYPE',
103 UNIQUE `code_type` (`network_type_code_value`,`network_type_id`),
104 INDEX (`network_type_id`),
105 PRIMARY KEY (`network_type_code_id`)
106 ) TYPE={?_TABLE_TYPE?} COMMENT='Error codes for all types'");
107
108                 // Code types (internal table)
109                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_codes`');
110                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_codes` (
111 `network_code_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
112 `network_code` VARCHAR(100) NOT NULL DEFAULT 'INVALID_CODE',
113 UNIQUE (`network_code`),
114 PRIMARY KEY (`network_code_id`)
115 ) TYPE={?_TABLE_TYPE?} COMMENT='Error types, generic data, DO NOT ALTER!'");
116
117                 // Valid translation keys (we hate hard-coded arrays, you see?)
118                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_translations`');
119                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_translations` (
120 `network_translate_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
121 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
122 `network_translation` VARCHAR(100) NOT NULL DEFAULT '',
123 UNIQUE `type_trans` (`network_type_id`,`network_translation`),
124 PRIMARY KEY (`network_translate_id`)
125 ) TYPE={?_TABLE_TYPE?} COMMENT='Translations for array keys, generic data, DO NOT ALTER!'");
126
127                 // Array-Element translation tables per type/provider
128                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_array_translation`');
129                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_array_translation` (
130 `network_translate_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
131 `network_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
132 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
133 `network_array_key` SMALLINT(5) UNSIGNED NOT NULL DEFAULT 0,
134 `network_translation` VARCHAR(100) NOT NULL DEFAULT '',
135 UNIQUE `provider_type_key` (`network_id`,`network_type_id`,`network_array_key`),
136 UNIQUE `provider_type_trans` (`network_id`,`network_type_id`,`network_translation`),
137 PRIMARY KEY (`network_translate_id`)
138 ) TYPE={?_TABLE_TYPE?} COMMENT='Cache for all queried APIs'");
139
140                 // Data from the webmaster (you!)
141                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_config`');
142                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_config` (
143 `network_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
144 `network_affiliate_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
145 `network_api_password` VARCHAR(255) NOT NULL DEFAULT '',
146 `network_site_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
147 `network_query_amount` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
148 UNIQUE `network_affiliate` (`network_id`,`network_affiliate_id`),
149 UNIQUE `affiliate_site` (`network_affiliate_id`,`network_site_id`),
150 PRIMARY KEY (`network_id`)
151 ) TYPE={?_TABLE_TYPE?} COMMENT='Configuration data from the webmaster (you!)'");
152
153                 // Configuration data for e.g. reload-time
154                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_types_config`');
155                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_types_config` (
156 `network_data_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
157 `network_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
158 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
159 `max_reload_time` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
160 `min_waiting_time` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
161 `min_remain_clicks` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
162 `min_payment` FLOAT(20,5) UNSIGNED NOT NULL DEFAULT 0.00000,
163 `allow_erotic` VARCHAR(10) NOT NULL DEFAULT '',
164 UNIQUE `provider_type` (`network_id`,`network_type_id`),
165 PRIMARY KEY (`network_data_id`)
166 ) TYPE={?_TABLE_TYPE?} COMMENT='Configuration data for every type (e.g. reload-time)'");
167
168                 // Cache for queried APIs. Re-check depends on config
169                 // `network_cache_refresh` in seconds or if set to zero, full day
170                 // divided by query amount.
171                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_cache`');
172                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_cache` (
173 `network_cache_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
174 `network_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
175 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
176 `network_cache_data` MEDIUMBLOB,
177 `network_cache_timestamp` TIMESTAMP NOT NULL DEFAULT '0000-00-00 00:00',
178 UNIQUE `provider_type` (`network_id`,`network_type_id`),
179 PRIMARY KEY (`network_cache_id`)
180 ) TYPE={?_TABLE_TYPE?} COMMENT='Cache for all queried APIs'");
181
182                 // Reload locks for several types
183                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_reloads`');
184                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_reloads` (
185 `network_reload_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
186 `network_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
187 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
188 `network_reload_lock` SMALLINT(5) UNSIGNED NOT NULL DEFAULT 0,
189 `network_inserted` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP(),
190 UNIQUE `provider_type` (`network_id`,`network_type_id`),
191 PRIMARY KEY (`network_reload_id`)
192 ) TYPE={?_TABLE_TYPE?} COMMENT='Reload locks'");
193
194                 // Insert error code types
195                 // - Affiliate id or interface password wrong
196                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('AFF_ID_PASS_WRONG')");
197                 // - Webmaster's site id is not assigned (invalid, different affiliate id)
198                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('SITE_ID_NOT_ASSIGNED')");
199                 // - Webmaster's site id is locked
200                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('SITE_ID_LOCKED')");
201                 // - General error in interface data
202                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('INTERFACE_DATA_ERROR')");
203                 // - Request amount depleted
204                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('REQUESTS_DEPLETED')");
205                 // - No campaigns found for given criteria (but maybe there are with more widen criteria)
206                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('NO_CAMPAIGNS_FOUND')");
207                 // - No campaigns found with allowed interface output (but there are maybe non-interface campaigns)
208                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('NO_CAMPAIGNS_FOUND_INTERFACE')");
209                 // - Webmaster's site id is not unlocked for choosen type
210                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('SITE_ID_NOT_ALLOWED_TYPE')");
211                 // - Request parameters incomplete
212                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('REQUEST_PARAMS_INCOMPLETE')");
213
214                 // Sponsor networks
215                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_data` (`network_short_name`, `network_title`, `network_reflink`, `network_data_seperator`, `network_row_seperator`, `network_request_type`, `network_charset`) VALUES ('yoomedia', 'Yoo!Media Solutions', 'http://www.yoomedia.de?ref=1715', '|', '|', 'GET', 'WINDOWS-1252')");
216                 
217                 // Admin menu entries
218                 addAdminMenuSql('network',NULL,'Werbenetzwerke','Verwalten Sie hier Werbenetzwerke (API-Anbindung), versenden Sie deren Mails, oder &uuml;bernehmen Sie deren Textlinks und vieles mehr. <strong>VORSICHT:</strong> Das Einrichten von weiteren Werbenetzwerken ist nicht leicht, daf&uuml;r aber sehr flexibel! Sollte ein Netzwerk fehlen, so melden Sie dies bitte <a href="http://forum.mxchange.org/topic-462.html" target="_blank" title="Direktlink zum Forum">im Forum</a>!',4);
219                 addAdminMenuSql('network','config_networks','API-Daten','Stellen Sie Ihre Affiliate- Webseiten-Id und API-Passwort ein. Diese erhalten Sie zu &uuml;ber 99% aus dem jeweiligen Zugangsbereich des Anbieters. Sollten Sie bei einem Netzwerk noch nicht angemeldet sein, verwenden Sie bitte meinen Referal-Link.',1);
220                 addAdminMenuSql('network','config_network_types','Werbearten','Stellen Sie hier Reload-Zeiten, Mindestauffenthalt und so weiter pro Werbeart und Werbenetzwerk ein. Es werden sonst Standart-Werte (Mimimumwerte: 0, Maximumwerte: sehr gross, Erotik: aus) angenommen, die Sie meistens nicht wollen.',2);
221                 addAdminMenuSql('network','query_networks','APIs abfragen','Fragt alle eingestellten APIs ab. Die Ergebnisse werden dann f&uuml;r einen einstellbaren Zeitraum gecacht und nicht erneut angefordert.',3);
222                 addAdminMenuSql('network','config_network','Einstellungen','Stellen Sie generelle Einstellungen ein, die f&uuml;r alle Werbenetzwerke gelten, wie z.B. Cache-Erneuerungsinterval. Generell sind aber die Einstellungen in Ordnung, da z.B. sonst Ihre freien Abfragen beim Werbenetzwerk sich zu schnell abbauen.',4);
223                 addAdminMenuSql('network','list_network_reloads','Reload-Sperren','Listen oder l&ouml;schen Sie hier Reload-Sperren. <strong>Vorsicht:</strong> Die hier gespeicherten Reload-Sperren sind vom jeweiligen Werbenetzwerk &uuml;bernommen. Eventuell verdienen Sie nichts, wenn Sie z.B. eine Mail innerhalb der Reload-Sperre erneut versenden.',5);
224                 addAdminMenuSql('network','list_networks','Auflisten/Verwalten','<strong>Experten-Einstellungen!</strong> Hier &auml;ndern Sie die Einstellungen an den Grunddaten (Stammdaten) des jeweiligen Werbenetzwerks ab. Sie sollten hier generell nichts einstellen und <a href="http://forum.mxchange.org/forum-43.html" target="_blank" title="Direktlink zum Forum">im Forum</a> um Hilfe fragen, wenn Sie selber ein Werbenetzwerk einrichten m&ouml;chten.',6);
225                 addAdminMenuSql('network','list_network_types','Werbearten','<strong>Experten-Einstellungen!</strong> Hier &auml;ndern Sie die Einstellungen zu den Werbearten pro Werbenetzwerken. Sie sollten hier generell nichts einstellen und <a href="http://forum.mxchange.org/forum-43.html" target="_blank" title="Direktlink zum Forum">im Forum</a> um Hilfe fragen, wenn Sie selber ein Werbenetzwerk einrichten m&ouml;chten.',7);
226                 addAdminMenuSql('network','list_network_params','Abfrageparameter','<strong>Experten-Einstellungen!</strong> Hier stellen Sie die Abfrageparameter (wie sie genannt werden m&uuml;ssen, um das API-Script korrekt aufrufen zu k&ouml;nnen) ein, pro Werbenetzwerk. Sie sollten hier generell nichts einstellen und <a href="http://forum.mxchange.org/forum-43.html" target="_blank" title="Direktlink zum Forum">im Forum</a> um Hilfe fragen, wenn Sie selber ein Werbenetzwerk einrichten m&ouml;chten.',8);
227                 addAdminMenuSql('network','list_network_code_types','R&uuml;ckgabewerte','<strong>Experten-Einstellungen!</strong> Hier stellen Sie die R&uuml;ckgabewerte ein, die im Falle eines Fehlers pro API-Script kommen k&ouml;nnen. Sie sollten hier generell nichts einstellen und <a href="http://forum.mxchange.org/forum-43.html" target="_blank" title="Direktlink zum Forum">im Forum</a> um Hilfe fragen, wenn Sie selber ein Werbenetzwerk einrichten m&ouml;chten.',9);
228                 addAdminMenuSql('network','list_network_codes','Fehlercodes','<strong>Experten-Einstellungen!</strong> Hier stellen Sie die Namen von Fehlercodes ein, die Scripte zur&uuml;ckliefern k&ouml;nnen. <strong>Dies sind INTERNE Daten und sollten nur vom Entwicklerteam angepasst werden.</strong> Stellen Sie an diesen Einstellungen bitte nichts um. Sie sollten hier generell nichts einstellen und <a href="http://forum.mxchange.org/forum-43.html" target="_blank" title="Direktlink zum Forum">im Forum</a> um Hilfe fragen, wenn Sie selber ein Werbenetzwerk einrichten m&ouml;chten.',10);
229
230                 // Configuration entries
231                 addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `network_cache_refresh` BIGINT(20) UNSIGNED NOT NULL DEFAULT ' . (60 * 15) . '');
232                 break;
233
234         case 'remove': // Do stuff when removing extension
235                 // SQL commands to run
236                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_data`');
237                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_types`');
238                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_request_params`');
239                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_type_codes`');
240                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_translations`');
241                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_array_translation`');
242                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_config`');
243                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_types_config`');
244                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_cache`');
245                 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_reloads`');
246
247                 // Admin menu
248                 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `action`='network'");
249                 break;
250
251         case 'activate': // Do stuff when admin activates this extension
252                 // SQL commands to run
253                 break;
254
255         case 'deactivate': // Do stuff when admin deactivates this extension
256                 // SQL commands to run
257                 break;
258
259         case 'update': // Update an extension
260                 switch (getCurrentExtensionVersion()) {
261                         case '0.0.1': // SQL queries for v0.0.1
262                                 addExtensionSql('');
263
264                                 // Update notes (these will be set as task text!)
265                                 setExtensionUpdateNotes('');
266                                 break;
267                 } // END - switch
268                 break;
269
270         case 'modify': // When the extension got modified
271                 break;
272
273         case 'test': // For testing purposes. For details see file inc/modules/admin/what-extensions.php, arround line 305.
274                 break;
275
276         case 'init': // Do stuff when extension is initialized
277                 break;
278
279         default: // Unknown extension mode
280                 logDebugMessage(__FILE__, __LINE__, sprintf("Unknown extension mode %s detected.", getExtensionMode()));
281                 break;
282 } // END - switch
283
284 // [EOF]
285 ?>