e90f6340229a7e983c64b1b92569ef7e399003a6
[mailer.git] / inc / libs / network_functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 11/04/2009 *
4  * ===================                          Last change: 11/04/2009 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : network_functions.php                            *
8  * -------------------------------------------------------------------- *
9  * Short description : Functions for ext-network                        *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Funktionen fuer ext-network                      *
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 // Processes an admin form
45 function doAdminNetworkProcessForm () {
46         // Form really sent?
47         if ((!isFormSent()) && (!isPostRequestElementSet('edit')) && (!isPostRequestElementSet('del')) && (!isPostRequestElementSet('change')) && (!isPostRequestElementSet('remove'))) {
48                 // Abort here
49                 loadTemplate('admin_settings_saved', false, getMessage('ADMIN_NETWORK_FORM_NOT_SENT'));
50                 return;
51         } elseif (!isGetRequestElementSet('do')) {
52                 // No 'do' found
53                 loadTemplate('admin_settings_saved', false, getMessage('ADMIN_NETWORK_DO_404'));
54                 return;
55         }
56
57         // Create function name
58         $functionName = sprintf("doAdminNetworkProcess%sForm", ucfirst(strtolower(getRequestElement('do'))));
59
60         // Is the function valid?
61         if (!function_exists($functionName)) {
62                 // Invalid function name
63                 debug_report_bug('Invalid do ' . getRequestElement('do') . ', function ' . $functionName .' does not exist.');
64         } // END - if
65
66         // Call-back the method handling our request
67         call_user_func($functionName);
68 }
69
70 // Checks wether the (short) network name is already used (valid)
71 function isNetworkNameValid ($name) {
72         // Query for it
73         $result = SQL_QUERY_ESC("SELECT `network_id` FROM `{?_MYSQL_PREFIX?}_network_data` WHERE `network_short_name`='%s' LIMIT 1",
74                 array($name), __FUNCTION__, __LINE__);
75
76         // Does it exist?
77         $isValid = (SQL_NUMROWS($result) == 1);
78
79         // Free result
80         SQL_FREERESULT($result);
81
82         // Return result
83         return $isValid;
84 }
85
86 // "Getter" for a network's data by provided id number
87 function getNetworkDataById ($id) {
88         // Ids lower one are not accepted
89         if ($id < 1) {
90                 // Not good, should be fixed
91                 debug_report_bug('Network id ' . $id . ' is smaller than 1.');
92         } // END - if
93
94         // By default we have no data
95         $networkData = array();
96
97         // Query for the network data
98         $result = SQL_QUERY_ESC("SELECT
99         `network_id`, `network_short_name`, `network_title`, `network_reflink`, `network_data_seperator`, `network_row_seperator`, `network_request_type`, `network_charset`
100 FROM
101         `{?_MYSQL_PREFIX?}_network_data`
102 WHERE
103         `network_id`=%s
104 LIMIT 1",
105                 array(bigintval($id)), __FUNCTION__, __LINE__);
106
107         // Do we have an entry?
108         if (SQL_NUMROWS($result) == 1) {
109                 // Then get it
110                 $networkData = SQL_FETCHARRAY($result);
111         } // END - if
112
113         // Free result
114         SQL_FREERESULT($result);
115
116         // Return result
117         return $networkData;
118 }
119
120 // Updates given network (id) with data from array
121 function doNetworkUpdateDataByArray ($id, $networkData) {
122         // Ids lower one are not accepted
123         if ($id < 1) {
124                 // Not good, should be fixed
125                 debug_report_bug('Network id ' . $id . ' is smaller than 1.');
126         } // END - if
127
128         // Just call our inner method
129         return adminSaveSettings($networkData, '_network_data', sprintf("`network_id`=%s", bigintval($id)), array(), false, false);
130 }
131
132 // Removes given network entry
133 function doAdminRemoveNetworkEntry ($table, $column, $id, $limit = 1) {
134         // Remove the entry
135         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_network_%s` WHERE `%s`=%s LIMIT %s",
136                 array($table, $column, $id, $limit), __FILE__, __LINE__);
137
138         // Return affected rows
139         return SQL_AFFECTEDROWS();
140 }
141
142 //------------------------------------------------------------------------------
143 //                             Call-back functions
144 //------------------------------------------------------------------------------
145
146 // Callback function to add new network
147 function doAdminNetworkProcessAddnetworkForm () {
148         // We can say here, the form is sent, so check if the network is already added
149         if (isNetworkNameValid(postRequestElement('network_short_name'))) {
150                 // Already there
151                 loadTemplate('admin_settings_saved', false, sprintf(getMessage('ADMIN_NETWORK_ALREADY_ADDED'), postRequestElement('network_short_name')));
152                 return;
153         } // END - if
154
155         // Remove the 'ok' part
156         unsetPostRequestElement('ok');
157
158         // Add the whole request to database
159         SQL_QUERY("INSERT INTO
160         `{?_MYSQL_PREFIX?}_network_data`
161 (
162         `" . implode('`,`', array_keys(postRequestArray())) . "`
163 ) VALUES (
164         '" . implode("','", array_values(postRequestArray())) . "'
165 )", __FUNCTION__, __LINE__);
166
167         // Add the id for output only
168         setRequestPostElement('network_id', SQL_INSERTID());
169
170         // Output message
171         if (SQL_AFFECTEDROWS() == 1) {
172                 // Successfully added
173                 loadTemplate('admin_network_added', false, postRequestArray());
174         } else {
175                 // Not added
176                 loadTemplate('admin_settings_saved', false, sprintf(getMessage('ADMIN_NETWORK_DATA_NOT_ADDED'), postRequestElement('network_short_name')));
177         }
178 }
179
180 // Displays selected networks for editing
181 function doAdminNetworkProcessHandlenetworkForm () {
182         // Do we have selections?
183         if (countPostSelection() > 0) {
184                 // Something has been selected, so start displaying one by one
185                 $SW = 2; $OUT = '';
186                 foreach (postRequestElement('sel') as $id => $sel) {
187                         // Is this selected?
188                         if ($sel == 1) {
189                                 // Load this network's data
190                                 $networkData = getNetworkDataById($id);
191
192                                 // Do we have found the network?
193                                 if (count($networkData) > 0) {
194                                         // Add color
195                                         $networkData['sw'] = $SW;
196
197                                         if (isPostRequestElementSet('edit')) {
198                                                 // Make selection box for network_request_type
199                                                 $networkData['network_request_type'] = generateOptionList(
200                                                         '/ARRAY/',
201                                                         array('GET','POST'),
202                                                         array(getMessage('ADMIN_NETWORK_REQUEST_TYPE_GET'), getMessage('ADMIN_NETWORK_REQUEST_TYPE_POST')),
203                                                         $networkData['network_request_type']
204                                                 );
205
206                                                 // Add row template for editing
207                                                 $OUT .= loadTemplate('admin_edit_networks_row', true, $networkData);
208                                         } elseif (isPostRequestElementSet('del')) {
209                                                 // Translate the request type
210                                                 $networkData['network_request_type'] = getMessage('ADMIN_NETWORK_REQUEST_TYPE_' . $networkData['network_request_type']);
211
212                                                 // Add row template for deleting
213                                                 $OUT .= loadTemplate('admin_del_networks_row', true, $networkData);
214                                         } else {
215                                                 // Problem!
216                                                 debug_report_bug('Cannot detect edit/del.');
217                                         }
218
219                                         // Switch colors
220                                         $SW = 3 - $SW;
221                                 } // END - if
222                         } // END - if
223                 } // END - foreach
224
225                 // If we have no rows, we don't need to display the edit form
226                 if (!empty($OUT)) {
227                         // Output main template
228                         if (isPostRequestElementSet('edit')) {
229                                 loadTemplate('admin_edit_networks', false, $OUT);
230                         } elseif (isPostRequestElementSet('del')) {
231                                 loadTemplate('admin_del_networks', false, $OUT);
232                         } else {
233                                 // Problem!
234                                 debug_report_bug('Cannot detect edit/del.');
235                         }
236
237                         // Don't display the list/add new form
238                         $GLOBALS['network_display'] = false;
239                 } else {
240                         // Nothing selected/found
241                         loadTemplate('admin_settings_saved', false, getMessage('ADMIN_NETWORK_NOTHING_FOUND'));
242                 }
243         } // END - if
244 }
245
246 // Changes given networks
247 function doAdminNetworkProcessChangenetworkForm () {
248         // Do we have selections?
249         if (countPostSelection() > 0) {
250                 // By default nothing is updated
251                 $updated = 0;
252
253                 // Something has been selected, so start updating them
254                 foreach (postRequestElement('sel') as $id => $sel) {
255                         // Update this entry?
256                         if ($sel == 1) {
257                                 // Init data array
258                                 $networkData = array();
259
260                                 // Transfer whole array, except 'sel'
261                                 foreach (postRequestArray() as $key => $entry) {
262                                         // Skip 'sel' and submit button
263                                         if (in_array($key, array('sel', 'change'))) continue;
264
265                                         // Do we have this enty?
266                                         if (!isset($entry[$id])) {
267                                                 // Not found, needs fixing
268                                                 debug_report_bug('No entry in key=' . $key . ', id=' . $id . ' found.');
269                                         } // END - if
270
271                                         // Add this entry
272                                         $networkData[$key] = $entry[$id];
273                                 } // END - foreach
274
275                                 // Update the network data
276                                 $updated += doNetworkUpdateDataByArray($id, $networkData);
277                         } // END - if
278                 } // END - foreach
279
280                 // Do we have updates?
281                 if ($updated > 0) {
282                         // Updates done
283                         loadTemplate('admin_settings_saved', false, sprintf(getMessage('ADMIN_NETWORK_UPDATED'), $updated));
284                 } else {
285                         // Nothing changed
286                         loadTemplate('admin_settings_saved', false, getMessage('ADMIN_NETWORK_NOTHING_CHANGED'));
287                 }
288         } // END - if
289 }
290
291 // Removes given networks
292 function doAdminNetworkProcessRemovenetworkForm () {
293         // Do we have selections?
294         if (countPostSelection() > 0) {
295                 // By default nothing is removed
296                 $removed = 0;
297
298                 // Something has been selected, so start updating them
299                 foreach (postRequestElement('sel') as $id => $sel) {
300                         // Update this entry?
301                         if ($sel == 1) {
302                                 // Remove this entry
303                                 $removed += doAdminRemoveNetworkEntry('data', 'network_id', $id);
304                         } // END - if
305                 } // END - foreach
306
307                 // Do we have removes?
308                 if ($removed > 0) {
309                         // Removals done
310                         loadTemplate('admin_settings_saved', false, sprintf(getMessage('ADMIN_NETWORK_REMOVED'), $removed));
311                 } else {
312                         // Nothing removed
313                         loadTemplate('admin_settings_saved', false, getMessage('ADMIN_NETWORK_NOTHING_REMOVED'));
314                 }
315         } // END - if
316 }
317
318 // [EOF]
319 ?>