Extension ext-earning introduced (unfinished), renamings:
[mailer.git] / inc / extensions / ext-forced.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 03/09/2010 *
4  * ===================                          Last change: 03/09/2010 *
5  *                                                                      *
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  * -------------------------------------------------------------------- *
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 - 2011 by Mailer Developer Team                   *
20  * For more information visit: http://www.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 'register': // Do stuff when installation is running
54                 // Add dependency for ext-earning
55                 addExtensionDependency('earning');
56
57                 // All required tables for this extension:
58                 // - Ads
59                 addDropTableSql('forced_ads');
60                 addCreateTableSql('forced_ads', "
61 `forced_ads_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
62 `forced_ads_ad_url` VARCHAR(255) NULL DEFAULT NULL,
63 `forced_ads_click_url` VARCHAR(255) NOT NULL,
64 `forced_ads_width` SMALLINT(3) UNSIGNED NULL DEFAULT NULL,
65 `forced_ads_height` SMALLINT(3) UNSIGNED NULL DEFAULT NULL,
66 `forced_ads_alt_text` VARCHAR(255) NULL DEFAULT NULL,
67 `forced_ads_framebreaker` ENUM('Y','N') NOT NULL DEFAULT 'Y',
68 `forced_ads_type` VARCHAR(255) NOT NULL DEFAULT 'INVALID',
69 `forced_ads_views_counter` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
70 `forced_ads_clicks_counter` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
71 `forced_ads_added` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
72 PRIMARY KEY (`forced_ads_id`)",
73                         'Forced Ads Data');
74
75                 // - Campaigns
76                 addDropTableSql('forced_campaigns');
77                 addCreateTableSql('forced_campaigns', "
78 `forced_campaign_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
79 `forced_campaign_created` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
80 `forced_campaign_status` ENUM('ACTIVE','PENDING','EXPIRED','LOCKED') NOT NULL DEFAULT 'PENDING',
81 `forced_campaign_lock_reason` VARCHAR(255) NULL DEFAULT NULL,
82 `forced_campaign_lock_timetstamp` TIMESTAMP NULL DEFAULT NULL,
83 `forced_campaign_expired` TIMESTAMP NULL DEFAULT NULL,
84 `forced_campaign_ordered_clicks` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
85 `forced_campaign_payment_api` FLOAT(20,5) UNSIGNED NULL DEFAULT NULL,
86 `forced_campaign_reload_lock` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
87 `forced_campaign_min_stay` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
88 `forced_ads_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
89 `forced_campaign_userid` BIGINT(20) UNSIGNED NULL DEFAULT NULL,
90 `forced_costs_id` BIGINT(20) UNSIGNED NULL DEFAULT NULL,
91 PRIMARY KEY (`forced_campaign_id`),
92 INDEX (`forced_costs_id`)",
93                         'Forced Campaign Data');
94
95                 // - Campaign costs
96                 addDropTableSql('forced_costs');
97                 addCreateTableSql('forced_costs', "
98 `forced_costs_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
99 `forced_costs_price_click` FLOAT(20,5) UNSIGNED NULL DEFAULT NULL,
100 `forced_costs_payment_click` FLOAT(20,5) UNSIGNED NULL DEFAULT NULL,
101 `forced_costs_visibility` ENUM('MEMBER','SPONSOR','ALL','NONE') NOT NULL DEFAULT 'NONE',
102 PRIMARY KEY (`forced_costs_id`)",
103                         'Forced Campaign Costs');
104
105                 // - Campaign Statistics
106                 addDropTableSql('forced_stats');
107                 addCreateTableSql('forced_stats', "
108 `forced_stats_id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
109 `forced_stats_campaign_id` BIGINT(20) UNSIGNED NULL DEFAULT NULL,
110 `forced_stats_userid` BIGINT(20) UNSIGNED NULL DEFAULT NULL,
111 `forced_stats_viewed` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
112 `forced_stats_clicked` TIMESTAMP NULL DEFAULT NULL,
113 `forced_stats_real_ip` VARCHAR(15) NOT NULL DEFAULT '0.0.0.0',
114 `forced_stats_remote_addr` VARCHAR(15) NOT NULL DEFAULT '0.0.0.0',
115 `forced_stats_ua` VARCHAR(255) NULL DEFAULT NULL,
116 `forced_stats_is_proxy` ENUM('Y','N') NOT NULL DEFAULT 'N',
117 `forced_stats_session_id` VARCHAR(100) NULL DEFAULT NULL,
118 PRIMARY KEY (`forced_stats_id`),
119 INDEX (`forced_stats_campaign_id`),
120 INDEX (`forced_stats_userid`)",
121                         'Forced Campaign Statistics');
122
123                 // Menu system
124                 // - Administrator
125                 addAdminMenuSql('forced', NULL, 'Forced-Ads', 'Verwalten Sie hier bequem alle laufenden Forced-Banner, -Textlinks, -PopUps und deren Kampgnen. Sie k&ouml;nnen hier auch neue Werbmittel (Ads) hinzuf&uuml;gen oder laufende Forced-Kampagnen bei z.B. Regelverst&ouml;ssen sperren oder l&ouml;schen. Auch das natr&auml;gliche Editieren von Ads und Kampagnen ist jederzeit m&ouml;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&uuml;gen und k&ouml;nnen dann bei Bedarf weitere Kampagnen starten.', 5);
126                 addAdminMenuSql('forced', 'list_forced_ads', 'Werbemittel verwalten', 'Listet alle eingetragenen Werbmittel (Ads) auf und f&uuml;gt neue hinzu. Sie k&ouml;nnen hier diese nachtr&auml;glich editieren falls Sie mal eine falsche URL eingegeben haben oder den Text &auml;ndern wollen. L&ouml;schen Sie hier auch Forced-Banner, die nicht mehr g&uuml;ltig sind (z.B. abgelaufen sind). Sollten doch mit dem Werbmittel verkn&uuml;pfte Kampagnen vorhanden sein, erhalten Sie einen Warnhinweis. Neue Werbmittel k&ouml;nnen Sie hier ebenfalls hinzuf&uuml;gen. Denken Sie aber daran, dass ohne Kampagne dieses nicht angezeigt wird. Achten Sie hier auch die Reload-Sperre.', 2);
127                 addAdminMenuSql('forced', 'list_forced_campaigns', 'Kampagnen verwalten', 'Listet alle Kampagnen auf und zeigt deren Status an. Jederzeit k&ouml;nnen Sie Kampagnen stoppen, falls Sie dies w&uuml;nschen oder ein Regelverstoss vorliegt. Haben Sie ein Werbemittel hinzugef&uuml;gt, so f&uuml;gen Sie bitte unbedingt eine Kampagne hinzu, da es sonst nicht angezeigt wird.', 3);
128                 addAdminMenuSql('forced', 'list_forced_costs', 'Kosten verwalten', 'Legen Sie die Preise pro Klick f&uuml;r Forced-Werbemittelbuchungen fest und wie viele {OPEN_CONFIG}POINTS{CLOSE_CONFIG} Ihre Mitglieder erhalten sollen. Generell sollten Sie bei Mitgliederbuchungen h&ouml;here Kosten pro Klick als was Ihre Mitglieder pro Klick erhalten einstellen, da so die {OPEN_CONFIG}POINTS{CLOSE_CONFIG} abgebaut werden (Sie k&ouml;nnen an Accountaufladungen z.B. verdienen).', 4);
129                 addAdminMenuSql('forced', 'stats_forced', 'Statistiken', 'Zeigt Gesamtstatistiken und zu den einzelnen Kampagnen und Werbmitteln an. Die hier angezeigte Statistik kann jedoch nicht manuell gel&ouml;scht werden (bitte auch nicht selber tun) da sie auch gleichzeitigt als Reload-Sperre dient.', 5);
130
131                 // - Members
132                 addMemberMenuSql('earn', 'forced_banner', 'Forced-Banner', 3);
133                 addMemberMenuSql('earn', 'forced_textlink', 'Forced-Textlinks', 4);
134                 addMemberMenuSql('extras', 'book_forced', 'Forced-Kampagne buchen', 3);
135
136                 // Register Forced-PopUps with earning_data table
137                 addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_earning_data` (`earning_group`,`earning_name`,`earning_sorting`) VALUES ('POPUP','FORCED_POPUP',1)");
138
139                 // Register filters
140                 registerFilter('add_forced_ads_types', 'FORCED_AD_TYPE_DEFAULTS', false, true, isExtensionDryRun());
141                 registerFilter('member_earning_table_data', 'FORCED_POPUP_TABLE_DATA', false, true, isExtensionDryRun());
142                 break;
143
144         case 'remove': // Do stuff when removing extension
145                 // SQL commands to run
146                 addDropTableSql('forced_ads');
147                 addDropTableSql('forced_campaigns');
148                 addDropTableSql('forced_costs');
149                 addDropTableSql('forced_stats');
150
151                 // Menu systems
152                 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `action`='forced'");
153                 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_member_menu` WHERE `what` IN ('forced_banner','forced_textlink','book_forced') LIMIT 3");
154
155                 // Unregister Forced-PopUps from earning_data
156                 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_earning_data` WHERE `earning_name`='FORCED_POPUP' LIMIT 1");
157
158                 // Remove filter
159                 unregisterFilter(__FUNCTION__, __LINE__, 'add_forced_ads_types', 'FORCED_AD_TYPE_DEFAULTS', true, isExtensionDryRun());
160                 unregisterFilter(__FUNCTION__, __LINE__, 'member_earning_table_data', 'FORCED_POPUP_TABLE_DATA', true, isExtensionDryRun());
161                 break;
162
163         case 'activate': // Do stuff when admin activates this extension
164                 // SQL commands to run
165                 break;
166
167         case 'deactivate': // Do stuff when admin deactivates this extension
168                 // SQL commands to run
169                 break;
170
171         case 'update': // Update an extension
172                 switch (getCurrentExtensionVersion()) {
173                         case '0.0.1': // SQL queries for v0.0.1
174                                 addExtensionSql('');
175
176                                 // Update notes (these will be set as task text!)
177                                 setExtensionUpdateNotes('');
178                                 break;
179                 } // END - switch
180                 break;
181
182         case 'modify': // When the extension got modified
183                 break;
184
185         case 'test': // For testing purposes
186                 break;
187
188         case 'init': // Do stuff when extension is initialized
189                 break;
190
191         default: // Unknown extension mode
192                 logDebugMessage(__FILE__, __LINE__, sprintf("Unknown extension mode %s in extension %s detected.", getExtensionMode(), getCurrentExtensionName()));
193                 break;
194 } // END - switch
195
196 // [EOF]
197 ?>