2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 03/09/2010 *
4 * =================== Last change: 03/09/2010 *
6 * -------------------------------------------------------------------- *
7 * File : ext-forced.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Clickable forced banner or text links *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Klickbare Forced-Banner oder -Textlinks *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * -------------------------------------------------------------------- *
18 * Copyright (c) 2003 - 2009 by Roland Haeder *
19 * Copyright (c) 2009 - 2011 by Mailer Developer Team *
20 * For more information visit: http://www.mxchange.org *
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. *
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. *
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, *
36 ************************************************************************/
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
44 setThisExtensionVersion('0.0.0');
46 // Version history array (add more with , '0.0.1' and so on)
47 setExtensionVersionHistory(array('0.0.0'));
49 // This extension is in development (non-productive)
50 enableExtensionProductive(false);
52 switch (getExtensionMode()) {
53 case 'register': // Do stuff when installation is running
54 // All required tables for this extension:
56 addDropTableSql('forced_ads');
57 addCreateTableSql('forced_ads', "
58 `forced_ads_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
59 `forced_ads_ad_url` VARCHAR(255) NULL DEFAULT NULL,
60 `forced_ads_click_url` VARCHAR(255) NOT NULL,
61 `forced_ads_width` SMALLINT(3) UNSIGNED NULL DEFAULT NULL,
62 `forced_ads_height` SMALLINT(3) UNSIGNED NULL DEFAULT NULL,
63 `forced_ads_alt_text` VARCHAR(255) NULL DEFAULT NULL,
64 `forced_ads_framebreaker` ENUM('Y','N') NOT NULL DEFAULT 'Y',
65 `forced_ads_type` VARCHAR(255) NOT NULL DEFAULT 'INVALID',
66 `forced_ads_views_counter` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
67 `forced_ads_clicks_counter` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
68 `forced_ads_reload_lock` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
69 `forced_ads_min_stay` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
70 `forced_ads_added` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
71 `forced_ads_last_locked` TIMESTAMP NULL DEFAULT NULL,
72 `forced_ads_lock_reason` TINYTEXT,
73 PRIMARY KEY (`forced_ads_id`)",
77 addDropTableSql('forced_campaigns');
78 addCreateTableSql('forced_campaigns', "
79 `forced_campaign_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
80 `forced_campaign_created` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
81 `forced_campaign_status` ENUM('ACTIVE','PENDING','EXPIRED','LOCKED') NOT NULL DEFAULT 'PENDING',
82 `forced_campaign_lock_reason` VARCHAR(255) NULL DEFAULT NULL,
83 `forced_campaign_lock_timetstamp` TIMESTAMP NULL DEFAULT NULL,
84 `forced_campaign_expired` TIMESTAMP NULL DEFAULT NULL,
85 `forced_campaign_ordered_clicks` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
86 `forced_campaign_costs_api` FLOAT(20,5) UNSIGNED NULL DEFAULT NULL,
87 `forced_campaign_price_api` FLOAT(20,5) UNSIGNED NULL DEFAULT NULL,
88 `forced_costs_id` BIGINT(20) UNSIGNED NULL DEFAULT NULL,
89 PRIMARY KEY (`forced_campaign_id`),
90 INDEX (`forced_costs_id`)",
91 'Forced Campaign Data');
93 // - Campaigns <-> Ads
94 addDropTableSql('forced_campaigns_ads');
95 addCreateTableSql('forced_campaigns_ads', "
96 `forced_campaign_ads_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
97 `forced_campaign_id` BIGINT(20) UNSIGNED NULL DEFAULT NULL,
98 `forced_ads_id` BIGINT(20) UNSIGNED NULL DEFAULT NULL,
99 PRIMARY KEY (`forced_campaign_ads_id`),
100 UNIQUE `ads_campaign`(`forced_campaign_id`,`forced_ads_id`)",
101 'Forced Campaigns<->Ads');
103 // - Campaigns <-> "User" (could be a member, sponsor, admin or "API")
104 addDropTableSql('forced_campaigns_user');
105 addCreateTableSql('forced_campaigns_user', "
106 `forced_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
107 `forced_campaign_id` BIGINT(20) UNSIGNED NULL DEFAULT NULL,
108 `forced_user_id` BIGINT(20) UNSIGNED NULL DEFAULT NULL,
109 `forced_user_type` ENUM('MEMBER','SPONSOR','ADMIN','API') NOT NULL DEFAULT 'ADMIN',
110 PRIMARY KEY (`forced_id`),
111 UNIQUE `forced_campaign_user` (`forced_campaign_id`,`forced_user_id`,`forced_user_type`),
112 INDEX (`forced_user_id`)",
113 'Forced Campaigns<->User');
116 addDropTableSql('forced_costs');
117 addCreateTableSql('forced_costs', "
118 `forced_costs_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
119 `forced_costs_price_click` FLOAT(20,5) UNSIGNED NULL DEFAULT NULL,
120 `forced_costs_payment_click` FLOAT(20,5) UNSIGNED NULL DEFAULT NULL,
121 `forced_costs_visibility` ENUM('MEMBER','SPONSOR','ALL','NONE') NOT NULL DEFAULT 'NONE',
122 PRIMARY KEY (`forced_costs_id`)",
123 'Forced Campaign Costs');
125 // - Campaign Statistics
126 addDropTableSql('forced_stats');
127 addCreateTableSql('forced_stats', "
128 `forced_stats_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
129 `forced_stats_campaign_id` BIGINT(20) UNSIGNED NULL DEFAULT NULL,
130 `forced_stats_user_id` BIGINT(20) UNSIGNED NULL DEFAULT NULL,
131 `forced_stats_viewed` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
132 `forced_stats_clicked` TIMESTAMP NULL DEFAULT NULL,
133 `forced_stats_real_ip` VARCHAR(15) NOT NULL DEFAULT '0.0.0.0',
134 `forced_stats_remote_addr` VARCHAR(15) NOT NULL DEFAULT '0.0.0.0',
135 `forced_stats_ua` VARCHAR(255) NULL DEFAULT NULL,
136 `forced_stats_is_proxy` ENUM('Y','N') NOT NULL DEFAULT 'N',
137 `forced_stats_session_id` VARCHAR(100) NULL DEFAULT NULL,
138 PRIMARY KEY (`forced_stats_id`),
139 INDEX (`forced_stats_campaign_id`),
140 INDEX (`forced_stats_user_id`)",
141 'Forced Campaign Statistics');
145 addAdminMenuSql('forced', NULL, 'Forced-Ads', 'Verwalten Sie hier bequem alle laufenden Forced-Banner und -Textlinks und deren Kampgnen. Sie können hier auch neue Werbmittel (Ads) hinzufügen oder laufende Forced-Kampagnen bei z.B. Regelverstössen sperren oder löschen. Auch das naträgliche Editieren von Ads und Kampagnen ist jederzeit möglich. Kampagnen dienen der einfacheren Verwaltung und der Trennung von dem Werbemittel selbst dienen. Sie brauchen also z.B. einen Forced-Banner nur einmal einfügen und können dann bei Bedarf weitere Kampagnen starten.', 5);
146 addAdminMenuSql('forced', 'list_forced_ads', 'Werbemittel verwalten', 'Listet alle eingetragenen Werbmittel (Ads) auf und fügt neue hinzu. Sie können hier diese nachträglich editieren falls Sie mal eine falsche URL eingegeben haben oder den Text ändern wollen. Löschen Sie hier auch Forced-Banner, die nicht mehr gültig sind (z.B. abgelaufen sind). Sollten doch mit dem Werbmittel verknüpfte Kampagnen vorhanden sein, erhalten Sie einen Warnhinweis. Neue Werbmittel können Sie hier ebenfalls hinzufügen. Denken Sie aber daran, dass ohne Kampagne dieses nicht angezeigt wird. Achten Sie hier auch die Reload-Sperre.', 2);
147 addAdminMenuSql('forced', 'list_forced_campaigns', 'Kampagnen verwalten', 'Listet alle Kampagnen auf und zeigt deren Status an. Jederzeit können Sie Kampagnen stoppen, falls Sie dies wünschen oder ein Regelverstoss vorliegt. Haben Sie ein Werbemittel hinzugefügt, so fügen Sie bitte unbedingt eine Kampagne hinzu, da es sonst nicht angezeigt wird.', 3);
148 addAdminMenuSql('forced', 'list_forced_costs', 'Kosten verwalten', 'Legen Sie die Preise pro Klick zum Buchen Forced-Werbemittel fest und wie viele {OPEN_CONFIG}POINTS{CLOSE_CONFIG} Ihre Mitglieder erhalten sollen. Generell sollten Sie bei Mitgliederbuchungen höhere Kosten pro Klick als was Ihre Mitglieder pro Klick erhalten einstellen, da so die {OPEN_CONFIG}POINTS{CLOSE_CONFIG} abgebaut werden (Sie können an Accountaufladungen z.B. verdienen).', 4);
149 addAdminMenuSql('forced', 'stats_forced', 'Statistiken', 'Zeigt Gesamtstatistiken und zu den einzelnen Kampagnen und Werbmitteln an. Die hier angezeigte Statistik kann jedoch nicht manuell gelöscht werden (bitte auch nicht selber tun) da sie auch gleichzeitigt als Reload-Sperre dient.', 5);
152 addMemberMenuSql('earn', 'forced_banner', 'Forced-Banner', 2);
153 addMemberMenuSql('earn', 'forced_textlink', 'Forced-Textlinks', 3);
154 addMemberMenuSql('extras','book_forced_banner','Forced-Banner buchen', 3);
155 addMemberMenuSql('extras','book_forced_textlink','Forced-Textlink buchen', 4);
157 // Register filter for default forced ad types
158 registerFilter('add_forced_ads_types', 'FORCED_AD_TYPE_DEFAULTS', false, true, isExtensionDryRun());
161 case 'remove': // Do stuff when removing extension
162 // SQL commands to run
163 addDropTableSql('forced_ads');
164 addDropTableSql('forced_campaigns');
165 addDropTableSql('forced_campaigns_ads');
166 addDropTableSql('forced_campaigns_user');
167 addDropTableSql('forced_costs');
168 addDropTableSql('forced_stats');
171 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `action`='forced' LIMIT 5");
172 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_member_menu` WHERE `what` IN ('forced_banner','forced_textlink') LIMIT 2");
175 unregisterFilter(__FUNCTION__, __LINE__, 'add_forced_ads_types', 'FORCED_AD_TYPE_DEFAULTS', true, isExtensionDryRun());
178 case 'activate': // Do stuff when admin activates this extension
179 // SQL commands to run
182 case 'deactivate': // Do stuff when admin deactivates this extension
183 // SQL commands to run
186 case 'update': // Update an extension
187 switch (getCurrentExtensionVersion()) {
188 case '0.0.1': // SQL queries for v0.0.1
191 // Update notes (these will be set as task text!)
192 setExtensionUpdateNotes('');
197 case 'modify': // When the extension got modified
200 case 'test': // For testing purposes
203 case 'init': // Do stuff when extension is initialized
206 default: // Unknown extension mode
207 logDebugMessage(__FILE__, __LINE__, sprintf("Unknown extension mode %s in extension %s detected.", getExtensionMode(), getCurrentExtensionName()));