2 /************************************************************************
3 * MXChange v0.2.1 Start: 12/18/2008 *
4 * ================ Last change: 11/01/2009 *
6 * -------------------------------------------------------------------- *
7 * File : ext-network.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Generic (sponsor) network connection extension *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Allgemeine Werbenetzwerk-Erweiterung *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
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 *
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. *
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. *
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, *
37 ************************************************************************/
39 // Some security stuff...
40 if (!defined('__SECURITY')) {
45 setThisExtensionVersion('0.0');
47 // Version history array (add more with , '0.1.0' and so on)
48 setExtensionVersionHistory(array('0.0'));
50 // This extension is in development (non-productive)
51 enableExtensionProductive(false);
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'");
70 // Types the network provider is supporting (e.g. Forced-Banner and so on)
71 // @TODO network_type_name 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_name` VARCHAR(255) NOT NULL DEFAULT '',
77 `network_type_title` VARCHAR(255) NOT NULL DEFAULT '',
78 `network_type_request_url` VARCHAR(255) NOT NULL DEFAULT '',
79 `network_type_click_url` VARCHAR(255) NOT NULL DEFAULT '',
80 `network_type_banner_url` VARCHAR(255) NOT NULL DEFAULT '',
81 UNIQUE `provider_type` (`network_id`,`network_type_name`),
82 PRIMARY KEY (`network_type_id`)
83 ) TYPE={?_TABLE_TYPE?} COMMENT='Types provideable by networks. ONLY FILL OUT WITH PROPER idEA!'");
85 // HTTP parameters (names) for URLs
86 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_request_params`');
87 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_request_params` (
88 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
89 `request_param_max_reload_time` VARCHAR(10) NOT NULL DEFAULT 'reload',
90 `request_param_min_waiting_time` VARCHAR(10) NOT NULL DEFAULT 'ma',
91 `request_param_min_remain_clicks` VARCHAR(10) NOT NULL DEFAULT 'uebrig',
92 `request_param_min_payment` VARCHAR(10) NOT NULL DEFAULT 'verguetung',
93 `request_param_allow_erotic` VARCHAR(10) NOT NULL DEFAULT 'erotik',
94 PRIMARY KEY (`network_type_id`)
95 ) TYPE={?_TABLE_TYPE?} COMMENT='Request parameters for GET/POST request ONLY FILL OUT WITH PROPER idEA!'");
98 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_type_codes`');
99 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_type_codes` (
100 `network_type_code_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
101 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
102 `network_type_code_value` VARCHAR(50) NOT NULL DEFAULT '',
103 `network_type_code_type` VARCHAR(100) NOT NULL DEFAULT 'INVALID_TYPE',
104 UNIQUE `code_type` (`network_type_code_value`,`network_type_id`),
105 INDEX (`network_type_id`),
106 PRIMARY KEY (`network_type_code_id`)
107 ) TYPE={?_TABLE_TYPE?} COMMENT='Error codes for all types'");
109 // Code types (internal table)
110 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_codes`');
111 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_codes` (
112 `network_code_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
113 `network_code` VARCHAR(100) NOT NULL DEFAULT 'INVALID_CODE',
114 UNIQUE (`network_code`),
115 PRIMARY KEY (`network_code_id`)
116 ) TYPE={?_TABLE_TYPE?} COMMENT='Error types, generic data, DO NOT ALTER!'");
118 // Valid translation keys (we hate hard-coded arrays, you see?)
119 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_translations`');
120 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_translations` (
121 `network_translate_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
122 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
123 `network_translation` VARCHAR(100) NOT NULL DEFAULT '',
124 UNIQUE `type_trans` (`network_type_id`,`network_translation`),
125 PRIMARY KEY (`network_translate_id`)
126 ) TYPE={?_TABLE_TYPE?} COMMENT='Translations for array keys, generic data, DO NOT ALTER!'");
128 // Array-Element translation tables per type/provider
129 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_array_translation`');
130 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_array_translation` (
131 `network_translate_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
132 `network_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
133 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
134 `network_array_key` SMALLINT(5) UNSIGNED NOT NULL DEFAULT 0,
135 `network_translation` VARCHAR(100) NOT NULL DEFAULT '',
136 UNIQUE `provider_type_key` (`network_id`,`network_type_id`,`network_array_key`),
137 UNIQUE `provider_type_trans` (`network_id`,`network_type_id`,`network_translation`),
138 PRIMARY KEY (`network_translate_id`)
139 ) TYPE={?_TABLE_TYPE?} COMMENT='Cache for all queried APIs'");
141 // Data from the webmaster (you!)
142 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_config`');
143 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_config` (
144 `network_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
145 `network_affiliate_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
146 `network_api_password` VARCHAR(255) NOT NULL DEFAULT '',
147 `network_site_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
148 `network_query_amount` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
149 UNIQUE `network_affiliate` (`network_id`,`network_affiliate_id`),
150 UNIQUE `affiliate_site` (`network_affiliate_id`,`network_site_id`),
151 PRIMARY KEY (`network_id`)
152 ) TYPE={?_TABLE_TYPE?} COMMENT='Configuration data from the webmaster (you!)'");
154 // Configuration data for e.g. reload-time
155 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_types_config`');
156 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_types_config` (
157 `network_data_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
158 `network_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
159 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
160 `max_reload_time` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
161 `min_waiting_time` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
162 `min_remain_clicks` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
163 `min_payment` FLOAT(20,5) UNSIGNED NOT NULL DEFAULT 0.00000,
164 `allow_erotic` VARCHAR(10) NOT NULL DEFAULT '',
165 UNIQUE `provider_type` (`network_id`,`network_type_id`),
166 PRIMARY KEY (`network_data_id`)
167 ) TYPE={?_TABLE_TYPE?} COMMENT='Configuration data for every type (e.g. reload-time)'");
169 // Cache for queried APIs. Re-check depends on config
170 // `network_cache_refresh` in seconds or if set to zero, full day
171 // divided by query amount.
172 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_cache`');
173 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_cache` (
174 `network_cache_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
175 `network_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
176 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
177 `network_cache_data` MEDIUMBLOB,
178 `network_cache_timestamp` TIMESTAMP NOT NULL DEFAULT '0000-00-00 00:00',
179 UNIQUE `provider_type` (`network_id`,`network_type_id`),
180 PRIMARY KEY (`network_cache_id`)
181 ) TYPE={?_TABLE_TYPE?} COMMENT='Cache for all queried APIs'");
183 // Reload locks for several types
184 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_reloads`');
185 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_reloads` (
186 `network_reload_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
187 `network_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
188 `network_type_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
189 `network_reload_lock` SMALLINT(5) UNSIGNED NOT NULL DEFAULT 0,
190 `network_inserted` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP(),
191 UNIQUE `provider_type` (`network_id`,`network_type_id`),
192 PRIMARY KEY (`network_reload_id`)
193 ) TYPE={?_TABLE_TYPE?} COMMENT='Reload locks'");
195 // Insert error code types
196 // - Affiliate id or interface password wrong
197 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('AFF_ID_PASS_WRONG')");
198 // - Webmaster's site id is not assigned (invalid, different affiliate id)
199 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('SITE_ID_NOT_ASSIGNED')");
200 // - Webmaster's site id is locked
201 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('SITE_ID_LOCKED')");
202 // - General error in interface data
203 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('INTERFACE_DATA_ERROR')");
204 // - Request amount depleted
205 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('REQUESTS_DEPLETED')");
206 // - No campaigns found for given criteria (but maybe there are with more widen criteria)
207 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('NO_CAMPAIGNS_FOUND')");
208 // - No campaigns found with allowed interface output (but there are maybe non-interface campaigns)
209 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('NO_CAMPAIGNS_FOUND_INTERFACE')");
210 // - Webmaster's site id is not unlocked for choosen type
211 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('SITE_ID_NOT_ALLOWED_TYPE')");
212 // - Request parameters incomplete
213 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('REQUEST_PARAMS_INCOMPLETE')");
215 // Admin menu entries
216 addAdminMenuSql('network',NULL,'Werbenetzwerke','Verwalten Sie hier Werbenetzwerke (API-Anbindung), versenden Sie deren Mails, oder übernehmen Sie deren Textlinks und vieles mehr. <strong>VORSICHT:</strong> Das Einrichten von weiteren Werbenetzwerken ist nicht leicht, dafü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);
217 addAdminMenuSql('network','config_networks','API-Daten','Stellen Sie Ihre Affiliate- Webseiten-Id und API-Passwort ein. Diese erhalten Sie zu über 99% aus dem jeweiligen Zugangsbereich des Anbieters. Sollten Sie bei einem Netzwerk noch nicht angemeldet sein, verwenden Sie bitte meinen Referal-Link.',1);
218 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);
219 addAdminMenuSql('network','query_networks','APIs abfragen','Fragt alle eingestellten APIs ab. Die Ergebnisse werden dann für einen einstellbaren Zeitraum gecacht und nicht erneut angefordert.',3);
220 addAdminMenuSql('network','config_network','Einstellungen','Stellen Sie generelle Einstellungen ein, die fü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);
221 addAdminMenuSql('network','list_network_reloads','Reload-Sperren','Listen oder löschen Sie hier Reload-Sperren. <strong>Vorsicht:</strong> Die hier gespeicherten Reload-Sperren sind vom jeweiligen Werbenetzwerk übernommen. Eventuell verdienen Sie nichts, wenn Sie z.B. eine Mail innerhalb der Reload-Sperre erneut versenden.',5);
222 addAdminMenuSql('network','list_networks','Auflisten/Verwalten','<strong>Experten-Einstellungen!</strong> Hier ä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öchten.',6);
223 addAdminMenuSql('network','list_network_types','Werbearten verwalten','<strong>Experten-Einstellungen!</strong> Hier ä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öchten.',7);
224 addAdminMenuSql('network','list_network_params','Abfrageparameter','<strong>Experten-Einstellungen!</strong> Hier stellen Sie die Abfrageparameter (wie sie genannt werden müssen, um das API-Script korrekt aufrufen zu kö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öchten.',8);
225 addAdminMenuSql('network','list_network_code_types','Rückgabewerte','<strong>Experten-Einstellungen!</strong> Hier stellen Sie die Rückgabewerte ein, die im Falle eines Fehlers pro API-Script kommen kö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öchten.',9);
226 addAdminMenuSql('network','list_network_codes','Fehlercodes einstellen','<strong>Experten-Einstellungen!</strong> Hier stellen Sie die Namen von Fehlercodes ein, die Scripte zurückliefern können. <strong>Dies sind INTERNE Daten und sollten nur vom MXChange-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öchten.',10);
228 // Configuration entries
229 addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `network_cache_refresh` BIGINT(20) UNSIGNED NOT NULL DEFAULT ' . (60 * 15) . '');
232 case 'remove': // Do stuff when removing extension
233 // SQL commands to run
234 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_data`');
235 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_types`');
236 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_request_params`');
237 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_type_codes`');
238 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_translations`');
239 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_array_translation`');
240 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_config`');
241 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_types_config`');
242 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_cache`');
243 addExtensionSql('DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_reloads`');
246 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `action`='network'");
249 case 'activate': // Do stuff when admin activates this extension
250 // SQL commands to run
253 case 'deactivate': // Do stuff when admin deactivates this extension
254 // SQL commands to run
257 case 'update': // Update an extension
258 switch (getCurrentExtensionVersion()) {
259 case '0.0.1': // SQL queries for v0.0.1
262 // Update notes (these will be set as task text!)
263 setExtensionUpdateNotes('');
268 case 'modify': // When the extension got modified
271 case 'test': // For testing purposes. For details see file inc/modules/admin/what-extensions.php, arround line 305.
274 case 'init': // Do stuff when extension is initialized
277 default: // Unknown extension mode
278 DEBUG_LOG(__FILE__, __LINE__, sprintf("Unknown extension mode %s detected.", getExtensionMode()));