Rewrote some parts:
[mailer.git] / inc / extensions / ext-coupon.php
1 <?php
2 /************************************************************************
3  * Mailer-Project 0.2.1-FINAL                         Start: 01/07/2005 *
4  * ==========================                   Last change: 01/07/2005 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : ext-coupon.php                                   *
8  * -------------------------------------------------------------------- *
9  * Short description : Coupon system                                    *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Coupon-System                                    *
12  * -------------------------------------------------------------------- *
13  *                                                                      *
14  * -------------------------------------------------------------------- *
15  * $Revision::                                                        $ *
16  * $Date::                                                            $ *
17  * $Tag:: 0.2.1-FINAL                                                 $ *
18  * $Author::                                                          $ *
19  * -------------------------------------------------------------------- *
20  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
21  * Copyright (c) 2009 - 2013 by Mailer Developer Team                   *
22  * For more information visit: http://mxchange.org                      *
23  *                                                                      *
24  * This program is free software; you can redistribute it and/or modify *
25  * it under the terms of the GNU General Public License as published by *
26  * the Free Software Foundation; either version 2 of the License, or    *
27  * (at your option) any later version.                                  *
28  *                                                                      *
29  * This program is distributed in the hope that it will be useful,      *
30  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
32  * GNU General Public License for more details.                         *
33  *                                                                      *
34  * You should have received a copy of the GNU General Public License    *
35  * along with this program; if not, write to the Free Software          *
36  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
37  * MA  02110-1301  USA                                                  *
38  ************************************************************************/
39
40 // Some security stuff...
41 if (!defined('__SECURITY')) {
42         die();
43 } // END - if
44
45 // Version number
46 setThisExtensionVersion('0.0.3');
47
48 // Version history array (add more with , '0.1' and so on)
49 setExtensionVersionHistory(array('0.0.0', '0.0.1', '0.0.2', '0.0.3'));
50
51 switch (getExtensionMode()) {
52         case 'setup': // Do stuff when installtion is running
53                 // This extension requires an up-to-date ext-user
54                 addExtensionDependency('user');
55                 addExtensionDependency('autopurge');
56
57                 // Coupon data
58                 addDropTableSql('coupon_data');
59                 addCreateTableSql('coupon_data', "
60 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
61 `coupon_created` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
62 `coupon_expired` TIMESTAMP NULL DEFAULT NULL,
63 `coupon_type` ENUM('CODE','API') NOT NULL DEFAULT 'CODE',
64 `total_created` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
65 `total_cashed` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
66 `points` FLOAT(20,5) UNSIGNED NOT NULL DEFAULT 0.00000,
67 `coupon_description` TEXT NOT NULL,
68 PRIMARY KEY (`id`)",
69                 'Created coupons');
70
71                 // Coupon->user connection table
72                 addDropTableSql('user_coupons');
73                 addCreateTableSql('user_coupons', "
74 `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
75 `coupon_id` BIGINT(20) UNSIGNED NOT NULL DEFAULT 0,
76 `userid` BIGINT(2) UNSIGNED NOT NULL DEFAULT 0,
77 `coupon_code` VARCHAR(30) NULL DEFAULT NULL,
78 `cashed_on` TIMESTAMP NULL DEFAULT NULL,
79 PRIMARY KEY (`id`),
80 UNIQUE INDEX `coupon_user` (`coupon_id`, `userid`),
81 UNIQUE INDEX (`coupon_code`)",
82                         'Coupon->user connection');
83
84                 // Configuration entries
85                 addConfigAddSql('coupon_default_time', 'BIGINT(20) NOT NULL DEFAULT ' . (getOneDay() * 7));
86                 addConfigAddSql('coupon_default_points', 'FLOAT(20,5) UNSIGNED NOT NULL DEFAULT 100.00000');
87                 addConfigAddSql('coupon_autopurge_time', 'BIGINT(20) NOT NULL DEFAULT ' . (getOneDay() * 7));
88                 addConfigAddSql('coupon_userid', 'BIGINT(20) UNSIGNED NOT NULL DEFAULT 0');
89
90                 // User data table
91                 addExtensionAddTableColumnSql('user_data', 'receiving_coupons', "ENUM('Y','N') NOT NULL DEFAULT 'Y'");
92
93                 // Menu systems:
94                 //  - Admin entries
95                 addAdminMenuSql('coupon', NULL, 'Gutscheine', 'Einrichten und Versenden von Code-Gutscheinen, sowie per API (noch in Planung). Bei Code-Gutscheinen wird ein Code pro Mitglied erzeugt, der dann an das Mitglied ausgesandt wird. L&ouml;st das Mitglied den Gutschein ein, erh&auml;lt es die Gutschrift auf sein Konto gutgeschrieben. Ausgangseinstellung ist die Gutschrift auf das Werbeguthaben, was f&uuml;r Paidmailer von Wichtigkeit ist, dass Guthaben aus Gutscheinen nicht auszahlungsf&auml;hig ist.', 6);
96                 addAdminMenuSql('coupon', 'list_coupon', 'Auflisten', 'Listet alle Gutscheine und Einl&ouml;sungen durch die Mitglieder auf.', 1);
97                 addAdminMenuSql('coupon', 'send_coupon', 'Versenden/Neuen erstellen', 'Versendet neue Gutscheine an die Mitglieder. Wenn Sie auf &quot;Absenden&quot; klicken, warten Sie bitte die Folgeseite ab, da der Versand der Gutscheine derzeit nicht gepoolt ist.', 2);
98                 addAdminMenuSql('coupon', 'config_coupon', 'Einstellungen', 'Allgemeine Einstellungen zu Code-Gutscheinen und Gutscheinen von Sponsoren (z.B. per API) k&ouml;nnen hier vorgenommen werden.', 3);
99                 //  - Member entries
100                 addMemberMenuSql('coupon', NULL, 'Gutscheine', 3);
101                 addMemberMenuSql('coupon', 'cash_coupon', 'Gutschein einl&ouml;sen', 1);
102                 addMemberMenuSql('coupon', 'list_coupon', 'Eingel&ouml;ste auflisten', 2);
103
104                 // Add filter (for changing user_points column dynamically
105                 registerFilter(__FILE__, __LINE__, 'determine_points_column_name', 'COUPON_CHANGE_POINTS_COLUMN_NAME', FALSE, TRUE, isExtensionDryRun());
106                 break;
107
108         case 'remove': // Do stuff when removing extension
109                 // SQL commands to run
110                 addDropTableSql('coupon_data');
111                 addDropTableSql('user_coupons');
112                 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_admin_menu` WHERE `action`='coupon' LIMIT 4");
113                 addExtensionSql("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_member_menu` WHERE `action`='coupon' LIMIT 3");
114
115                 // Remove points data
116                 unregisterExtensionPointsData('coupon_cashed');
117
118                 // Remove all filters
119                 unregisterFilter(__FILE__, __LINE__, 'determine_points_column_name', 'COUPON_CHANGE_POINTS_COLUMN_NAME', TRUE, isExtensionDryRun());
120                 unregisterFilter(__FILE__, __LINE__, 'post_cash_coupon', 'POST_CASH_COUPON', TRUE, isExtensionDryRun());
121                 break;
122
123         case 'activate': // Do stuff when admin activates this extension
124                 // SQL commands to run
125                 addExtensionSql("UPDATE `{?_MYSQL_PREFIX?}_member_menu` SET `visible`='Y',`locked`='N' WHERE `action`='coupon' LIMIT 3");
126                 break;
127
128         case 'deactivate': // Do stuff when admin deactivates this extension
129                 // SQL commands to run
130                 addExtensionSql("UPDATE `{?_MYSQL_PREFIX?}_member_menu` SET `visible`='N',`locked`='Y' WHERE `action`='coupon' LIMIT 3");
131                 break;
132
133         case 'update': // Update an extension
134                 switch (getCurrentExtensionVersion()) {
135                         case '0.0.1': // SQL queries for v0.0.1
136                                 addConfigDropSql('coupon_points_account');
137                                 addConfigDropSql('coupon_payment_method');
138                                 addConfigDropSql('coupon_locked_points_mode');
139
140                                 // This extension's update requires an up-to-date ext-order
141                                 addExtensionDependency('order');
142
143                                 // Insert data in new table
144                                 registerExtensionPointsData('coupon_cashed', 'order_points', 'LOCKED', 'DIRECT');
145
146                                 // Update notes (these will be set as task text!)
147                                 setExtensionUpdateNotes('');
148                                 break;
149
150                         case '0.0.2': // SQL queries for v0.0.2
151                                 // Update data in points_data table
152                                 addExtensionSql("UPDATE `{?_MYSQL_PREFIX?}_points_data` SET `subject`='coupon_cashed' WHERE `subject`='coupon' LIMIT 1");
153
154                                 // Update notes (these will be set as task text!)
155                                 setExtensionUpdateNotes('Eintrag in <strong>{CONFIG_OPEN}_MYSQL_PREFIX{CONFIG_CLOSE}_points_data</strong> umbenannt.');
156                                 break;
157
158                         case '0.0.3': // SQL queries for v0.0.3
159                                 registerFilter(__FILE__, __LINE__, 'post_cash_coupon', 'POST_CASH_COUPON', FALSE, TRUE, isExtensionDryRun());
160
161                                 // Update notes (these will be set as task text!)
162                                 setExtensionUpdateNotes('Filter zum Post- und Pre-Filter hinzugef&uuml;gt.');
163                                 break;
164                 } // END - switch
165                 break;
166
167         case 'modify': // When the extension got modified
168                 break;
169
170         case 'test': // For testing purposes
171                 break;
172
173         case 'init': // Do stuff when extension is initialized
174                 break;
175
176         default: // Unknown extension mode
177                 reportBug(__FILE__, __LINE__, sprintf('Unknown extension mode %s in extension %s detected.', getExtensionMode(), getCurrentExtensionName()));
178                 break;
179 } // END - switch
180
181 // [EOF]
182 ?>