a96e34080b94a8cae6e57bf67b8d9dbd3306a48a
[mailer.git] / inc / filter / register_filter.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 06/02/2011 *
4  * ===================                          Last change: 06/02/2011 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : _filter.php                                      *
8  * -------------------------------------------------------------------- *
9  * Short description : Filters for ext-                                 *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Filter fuer ext-                                 *
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 - 2013 by Mailer Developer Team                   *
20  * For more information visit: http://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 // Run a filter for must-fillout fields
44 function FILTER_REGISTER_MUST_FILLOUT ($filterData) {
45         // Get all fields for output
46         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Called!');
47         $result = sqlQuery('SELECT `field_name`, `field_required` FROM `{?_MYSQL_PREFIX?}_must_register` ORDER BY `id` ASC',
48                 __FUNCTION__, __LINE__);
49
50         // Walk through all entries
51         while ($row = sqlFetchArray($result)) {
52                 // Must the user fill out this element?
53                 $value = '';
54                 if ($row['field_required'] == 'Y') {
55                         $value = '<span class="notice">(*)</span>';
56                 } // END - if
57
58                 // Add it
59                 $filterData['must_fillout_' . strtolower($row['field_name']) . ''] = $value;
60         } // END - while
61
62         // Free memory
63         sqlFreeResult($result);
64
65         // Return it
66         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Done!');
67         return $filterData;
68 }
69
70 /**
71  * Run a filter for pre user registration - generic code (e.g. create hash,
72  * init global array elements). WARNING: This filter MUST run filter before all
73  * others, make your extension/-update depending on ext-register to avoid
74  * missing global array elements, etc.
75  *
76  * @param       $filterData             Filter data from previous filter
77  * @return      $filterData             Unchanged filter data
78  */
79 function FILTER_PRE_USER_REGISTRATION_GENERIC ($filterData) {
80         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Called!');
81
82         // Generate hash which will be inserted into confirmation mail
83         $GLOBALS['register_confirm_hash'] = generateHash(sha1(
84                 // Get total confirmed, ...
85                 getTotalConfirmedUser() . getEncryptSeparator() .
86                 // ... unconfirmed ...
87                 getTotalUnconfirmedUser() . getEncryptSeparator() .
88                 // ... and locked users
89                 getTotalLockedUser() . getEncryptSeparator() .
90                 postRequestElement('month') . '-' .
91                 postRequestElement('day') . '-' .
92                 postRequestElement('year') . getEncryptSeparator() .
93                 postRequestElement('password1') . getEncryptSeparator() .
94                 detectServerName() . getEncryptSeparator() .
95                 detectRemoteAddr() . getEncryptSeparator() .
96                 detectUserAgent() . '/' .
97                 getSiteKey() . '/' .
98                 getDateKey() . '/' .
99                 getConfig('CACHE_BUSTER')
100         ));
101
102         // Old way with enterable two-char-code
103         $GLOBALS['register_country_row'] = '`country`';
104         $GLOBALS['register_country_data'] = substr(postRequestElement('cntry'), 0, 2);
105
106         // Init "status" as for many users
107         setPostRequestElement('status', 'UNCONFIRMED');
108
109         // Add ip for later POST pings
110         setPostRequestElement('remote_addr', detectRemoteAddr());
111
112         // Generic initialization is done
113         $filterData['init_done'] = TRUE;
114
115         // Return it
116         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Done!');
117         //* NOISY-DEBUG: */ print __FUNCTION__.':filterData=<pre>'.print_r($filterData,TRUE).'</pre>';
118         return $filterData;
119 }
120
121 // Filter to run generic user registation (default)
122 function FILTER_GENERIC_USER_REGISTRATION ($filterData) {
123         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Called!');
124
125         // Is generic user registration selected?
126         if ((isPostRequestElementSet('registration_provider')) && (postRequestElement('registration_provider') == 'register')) {
127                 // Run it
128                 $filterData['status'] = doGenericUserRegistration();
129         } // END - if
130
131         // Return it
132         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Done!');
133         return $filterData;
134 }
135
136 // Filter to run generic user registation check (default)
137 function FILTER_GENERIC_USER_REGISTRATION_CHECK () {
138         // Default is form is not sent
139         $isFormSent = FALSE;
140         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Called!');
141
142         // Is the registration provider set?
143         if ((isFormSent()) && (isPostRequestElementSet('registration_provider')) && (postRequestElement('registration_provider') == 'register')) {
144                 // Check form
145                 $isFormSent = isRegistrationDataComplete();
146         } // END - if
147
148         // Return it
149         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Done!');
150         return $isFormSent;
151 }
152
153 // Filter to run generic things on registration done
154 function FILTER_GENERIC_USER_REGISTRATION_DONE () {
155         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Called!');
156
157         // Is generic user registration selected?
158         if ((isPostRequestElementSet('registration_provider')) && (postRequestElement('registration_provider') == 'register')) {
159                 // Run it
160                 displayMessage('{--REGISTRATION_DONE--}');
161         } // END - if
162
163         // Return NULL
164         return NULL;
165 }
166
167 // Filter to run generic things on registration failed
168 function FILTER_GENERIC_USER_REGISTRATION_FAILED () {
169         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Called!');
170
171         // Is generic user registration selected?
172         if ((isPostRequestElementSet('registration_provider')) && (postRequestElement('registration_provider') == 'register')) {
173                 // This should not be reached
174                 reportBug(__FUNCTION__, __LINE__, 'This filter should not handle it.');
175         } // END - if
176
177         // Return NULL
178         return NULL;
179 }
180
181 // Filter to run generic things on registration form
182 function FILTER_GENERIC_USER_REGISTRATION_FORM () {
183         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Called!');
184
185         // Is generic user registration selected?
186         if (((isGetRequestElementSet('registration_provider')) && (getRequestElement('registration_provider') == 'register')) || (getDefaultRegistrationProvider() == 'register')) {
187                 // Display generic form
188                 doDisplayGenericUserRegistrationForm();
189         } // END - if
190
191         // Return NULL
192         return NULL;
193 }
194
195 // [EOF]
196 ?>