inc/extensions/ext-network.php

   1 <?php
   2 /************************************************************************
   3  * MXChange v0.2.1                                    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 Sponsorennetzwerk-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 switch (getExtensionMode()) {
  51         case 'register': // Do stuff when installation is running (modules.php?module=admin is called)
  52                 // Main table which hold
  53                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_data`");
  54                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_data` (
  55 `network_id` BIGINT(20) NOT NULL AUTO_INCREMENT,
  56 `network_short_name` VARCHAR(50) NOT NULL DEFAULT '',
  57 `network_title` VARCHAR(255) NOT NULL DEFAULT '',
  58 `network_reflink` VARCHAR(255) NOT NULL DEFAULT '',
  59 `network_data_seperator CHAR(4) NOT NULL DEFAULT '|',
  60 `network_row_seperator CHAR(4) NOT NULL DEFAULT '|',
  61 `network_request_type` ENUM('GET','POST') NOT NULL DEFAULT 'GET',
  62 `network_charset` VARCHAR(20) NOT NULL DEFAULT 'ISO-8859-1',
  63 UNIQUE (`network_short_name`),
  64 PRIMARY KEY (`network_id`)
  65 ) TYPE={?_TABLE_TYPE?} COMMENT='Network data'");
  66
  67                 // Types the network provider is supporting (e.g. Forced-Banner and so on)
  68                 // @TODO network_type_name is an internal name and needs documentation
  69                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_types`");
  70                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_types` (
  71 `network_type_id` BIGINT(20) NOT NULL AUTO_INCREMENT,
  72 `network_id` BIGINT(20) NOT NULL DEFAULT 0,
  73 `network_type_name` VARCHAR(255) NOT NULL DEFAULT '',
  74 `network_type_title` VARCHAR(255) NOT NULL DEFAULT '',
  75 `network_type_request_url` VARCHAR(255) NOT NULL DEFAULT '',
  76 `network_type_click_url` VARCHAR(255) NOT NULL DEFAULT '',
  77 `network_type_banner_url` VARCHAR(255) NOT NULL DEFAULT '',
  78 UNIQUE `provider_type` (`network_id`,`network_type_name`),
  79 PRIMARY KEY (`network_type_id`)
  80 ) TYPE={?_TABLE_TYPE?} COMMENT='Types provideable by networks. ONLY FILL OUT WITH PROPER IDEA!'");
  81
  82                 // HTTP parameters (names) for URLs
  83                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_request_params`");
  84                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_request_params` (
  85 `network_type_id` BIGINT(20) NOT NULL DEFAULT 0,
  86 `request_param_max_reload_time` VARCHAR(10) NOT NULL DEFAULT 'reload',
  87 `request_param_min_waiting_time` VARCHAR(10) NOT NULL DEFAULT 'ma',
  88 `request_param_min_remain_clicks` VARCHAR(10) NOT NULL DEFAULT 'uebrig',
  89 `request_param_min_payment` VARCHAR(10) NOT NULL DEFAULT 'verguetung',
  90 `request_param_allow_erotic` VARCHAR(10) NOT NULL DEFAULT 'erotik',
  91 PRIMARY KEY (`network_type_id`)
  92 ) TYPE={?_TABLE_TYPE?} COMMENT='Request parameters for GET/POST request ONLY FILL OUT WITH PROPER IDEA!'");
  93
  94                 // Error status codes
  95                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_type_errors`");
  96                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_type_codes` (
  97 `network_type_code_id` BIGINT(20) NOT NULL AUTO_INCREMENT,
  98 `network_type_id` BIGINT(20) NOT NULL DEFAULT 0,
  99 `network_type_code_value` VARCHAR(50) NOT NULL DEFAULT '',
 100 `network_type_code_type` VARCHAR(100) NOT NULL DEFAULT 'INVALID_TYPE',
 101 UNIQUE `code_type` (`network_type_code_value`,`network_type_id`),
 102 INDEX (`network_type_id`),
 103 PRIMARY KEY (`network_type_code_id`)
 104 ) TYPE={?_TABLE_TYPE?} COMMENT='Error codes for all types'");
 105
 106                 // Code types (internal table)
 107                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_codes`");
 108                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_codes` (
 109 `network_code_id` BIGINT(20) NOT NULL AUTO_INCREMENT,
 110 `network_code` VARCHAR(100) NOT NULL DEFAULT 'INVALID_CODE',
 111 UNIQUE (`network_code`),
 112 PRIMARY KEY (`network_code_id`)
 113 ) TYPE={?_TABLE_TYPE?} COMMENT='Error types, generic data, DO NOT ALTER!'");
 114
 115                 // Data from the webmaster (you!)
 116                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_config_data`");
 117                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_config_data` (
 118 `network_id` BIGINT(20) NOT NULL DEFAULT 0,
 119 `network_affiliate_id` BIGINT(20) NOT NULL DEFAULT 0,
 120 `network_api_password` VARCHAR(255) NOT NULL DEFAULT '',
 121 `network_site_id` BIGINT(20) NOT NULL DEFAULT 0,
 122 UNIQUE `network_affiliate` (`network_id`,`network_affiliate_id`),
 123 UNIQUE `affiliate_site` (`network_affiliate_id`,`network_site_id`),
 124 PRIMARY KEY (`network_id`)
 125 ) TYPE={?_TABLE_TYPE?} COMMENT='Configuration data from the webmaster (you!)'");
 126
 127                 // Configuration data for e.g. reload-time
 128                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_types_data`");
 129                 addExtensionSql("CREATE TABLE `{?_MYSQL_PREFIX?}_network_types_data` (
 130 `network_data_id` BIGINT(20) NOT NULL AUTO_INCREMENT,
 131 `network_id` BIGINT(20) NOT NULL DEFAULT 0,
 132 `network_type_id` BIGINT(20) NOT NULL DEFAULT 0,
 133 `max_reload_time` BIGINT(20) NOT NULL DEFAULT 0,
 134 `min_waiting_time` BIGINT(20) NOT NULL DEFAULT 0,
 135 `min_remain_clicks` BIGINT(20) NOT NULL DEFAULT 0,
 136 `min_payment` BIGINT(20) NOT NULL DEFAULT 0,
 137 `allow_erotic` VARCHAR(10) NOT NULL DEFAULT '',
 138 INDEX `network_affiliate` (`network_id`,`network_affiliate_id`),
 139 PRIMARY KEY (`network_data_id`)
 140 ) TYPE={?_TABLE_TYPE?} COMMENT='Configuration data for every type (e.g. reload-time)'");
 141
 142                 // Insert error code types
 143                 // - Affiliate id or interface password wrong
 144                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('AFF_ID_PASS_WRONG')");
 145                 // - Webmaster's site id is not assigned (invalid, different affiliate id)
 146                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('SITE_ID_NOT_ASSIGNED')");
 147                 // - Webmaster's site id is locked
 148                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('SITE_ID_LOCKED')");
 149                 // - General error in interface data
 150                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('INTERFACE_DATA_ERROR')");
 151                 // - Request amount depleted
 152                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('REQUESTS_DEPLETED')");
 153                 // - No campaigns found for given criteria (but maybe there are with more widen criteria)
 154                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('NO_CAMPAIGNS_FOUND')");
 155                 // - No campaigns found with allowed interface output (but there are maybe non-interface campaigns)
 156                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('NO_CAMPAIGNS_FOUND_INTERFACE')");
 157                 // - Webmaster's site id is not unlocked for choosen type
 158                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('SITE_ID_NOT_ALLOWED_TYPE')");
 159                 // - Request parameters incomplete
 160                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_network_codes` (`network_code`) VALUES ('REQUEST_PARAMS_INCOMPLETE')");
 161
 162                 // Admin menu entries
 163                 addAdminMenuSql('network',NULL,'Sponsorennetzwerke','Verwalten Sie hier Sponsorennetzwerke (API-Anbindung), versenden Sie deren Mails, oder &uuml;bernehmen Sie deren Textlinks und vieles mehr. <strong>VORSICHT:</strong> Das Einrichten von weiteren Sponsorennetzwerken 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);
 164                 addAdminMenuSql('network','config_network','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);
 165                 addAdminMenuSql('network','config_network_types','Werbearten','Stellen Sie hier Reload-Zeiten, Mindestauffenthalt und so weiter pro Werbeart und Sponsorennetzwerk ein. Es werden sonst Standart-Werte (Mimimumwerte: 0, Maximumwerte: sehr gross, Erotik: aus) angenommen, die Sie meistens nicht wollen.',2);
 166                 addAdminMenuSql('network','list_networks','Auflisten/Verwalten','<strong>Experten-Einstellungen!</strong> Hier &auml;ndern Sie die Einstellungen an den Grunddaten (Stammdaten) des jeweiligen Sponsorennetzwerks 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 Sponsorennetzwerk einrichten m&ouml;chten.',3);
 167                 addAdminMenuSql('network','list_network_types','Werbearten verwalten','<strong>Experten-Einstellungen!</strong> Hier &auml;ndern Sie die Einstellungen zu den Werbearten pro Sponsorennetzwerken. 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 Sponsorennetzwerk einrichten m&ouml;chten.',4);
 168                 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 Sponsorennetzwerk. 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 Sponsorennetzwerk einrichten m&ouml;chten.',5);
 169                 addAdminMenuSql('network','list_network_code_types','','<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 Sponsorennetzwerk einrichten m&ouml;chten.',7);
 170                 addAdminMenuSql('network','list_network_codes','Fehlercodes einstellen','<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 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 Sponsorennetzwerk einrichten m&ouml;chten.',7);
 171                 break;
 172
 173         case 'remove': // Do stuff when removing extension
 174                 // SQL commands to run
 175                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_data`");
 176                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_types`");
 177                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_request_params`");
 178                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_type_errors`");
 179                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_config_data`");
 180                 addExtensionSql("DROP TABLE IF EXISTS `{?_MYSQL_PREFIX?}_network_types_data`");
 181
 182                 // Admin menu
 183                 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `action`='network'");
 184                 break;
 185
 186         case 'activate': // Do stuff when admin activates this extension
 187                 // SQL commands to run
 188                 break;
 189
 190         case 'deactivate': // Do stuff when admin deactivates this extension
 191                 // SQL commands to run
 192                 break;
 193
 194         case 'update': // Update an extension
 195                 switch (getCurrentExtensionVersion()) {
 196                         case '0.0.1': // SQL queries for v0.0.1
 197                                 addExtensionSql('');
 198
 199                                 // Update notes (these will be set as task text!)
 200                                 setExtensionUpdateNotes('');
 201                                 break;
 202                 } // END - switch
 203                 break;
 204
 205         case 'modify': // When the extension got modified
 206                 break;
 207
 208         case 'test': // For testing purposes. For details see file inc/modules/admin/what-extensions.php, arround line 305.
 209                 break;
 210
 211         case 'init': // Do stuff when extension is initialized
 212                 break;
 213
 214         default: // Unknown extension mode
 215                 DEBUG_LOG(__FILE__, __LINE__, sprintf("Unknown extension mode %s detected.", getExtensionMode()));
 216                 break;
 217 } // END - switch
 218
 219 // [EOF]
 220 ?>