ae47871fa8b25d058b8dfc3603d721258facfe6f
[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  * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
22  * For more information visit: http://www.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 // Private setter for current network id
46 function setCurrentNetworkId ($id) {
47         $GLOBALS['current_network_id'] = bigintval($id);
48 }
49
50 // Private getter for current network id
51 function getCurrentNetworkId () {
52         return $GLOBALS['current_network_id'];
53 }
54
55 // Handle a (maybe) sent form here
56 function doNetworkHandleForm () {
57         // Was the form sent?
58         if ((isFormSent()) || (isFormSent('edit')) || (isFormSent('del')) || (isFormSent('change')) || (isFormSent('remove'))) {
59                 // Do we have a 'do'?
60                 if (isGetRequestParameterSet('do')) {
61                         // Process the request
62                         doAdminNetworkProcessForm();
63                 } else {
64                         // No 'do' found
65                         loadTemplate('admin_settings_unsaved', false, '{--ADMIN_NETWORK_DO_404--}');
66                 }
67         } // END - if
68 }
69
70 // Processes an admin form
71 function doAdminNetworkProcessForm () {
72         // Form really sent?
73         if ((!isFormSent()) && (!isFormSent('edit')) && (!isFormSent('del')) && (!isFormSent('change')) && (!isFormSent('remove'))) {
74                 // Abort here
75                 loadTemplate('admin_settings_unsaved', false, '{--ADMIN_NETWORK_FORM_NOT_SENT--}');
76                 return;
77         } elseif (!isGetRequestParameterSet('do')) {
78                 // No 'do' found
79                 loadTemplate('admin_settings_unsaved', false, '{--ADMIN_NETWORK_DO_404--}');
80                 return;
81         }
82
83         // Create function name
84         $functionName = sprintf("doAdminNetworkProcess%s", capitalizeUnderscoreString(getRequestParameter('do')));
85
86         // Is the function valid?
87         if (!function_exists($functionName)) {
88                 // Invalid function name
89                 debug_report_bug(__FUNCTION__, __LINE__, 'Invalid do ' . getRequestParameter('do') . ', function ' . $functionName .' does not exist.', false);
90         } // END - if
91
92         // Call-back the method handling our request
93         call_user_func($functionName);
94 }
95
96 // Checks wether the (short) network name is already used (valid)
97 function isNetworkNameValid ($name) {
98         // Query for it
99         $result = SQL_QUERY_ESC("SELECT `network_id` FROM `{?_MYSQL_PREFIX?}_network_data` WHERE `network_short_name`='%s' LIMIT 1",
100                 array($name), __FUNCTION__, __LINE__);
101
102         // Does it exist?
103         $isValid = (SQL_NUMROWS($result) == 1);
104
105         // Free result
106         SQL_FREERESULT($result);
107
108         // Return result
109         return $isValid;
110 }
111
112 // Checks wether the given network type is already used (valid)
113 function isNetworkTypeHandleValid ($type, $networkId) {
114         // Query for it
115         $result = SQL_QUERY_ESC("SELECT `network_type_id` FROM `{?_MYSQL_PREFIX?}_network_types` WHERE `network_id`=%s AND `network_type_handle`='%s' LIMIT 1",
116                 array($networkId, $type), __FUNCTION__, __LINE__);
117
118         // Does it exist?
119         $isValid = (SQL_NUMROWS($result) == 1);
120
121         // Free result
122         SQL_FREERESULT($result);
123
124         // Return result
125         return $isValid;
126 }
127
128 // Checks wether the given network request parameter is already used (valid)
129 function isNetworkRequestParameterValid ($key, $type, $networkId) {
130         // Query for it
131         $result = SQL_QUERY_ESC("SELECT `network_param_id` FROM `{?_MYSQL_PREFIX?}_network_request_params` WHERE `network_id`=%s AND `network_type_id`=%s AND `request_param_key`='%s' LIMIT 1",
132                 array($networkId, $type, $key), __FUNCTION__, __LINE__);
133
134         // Does it exist?
135         $isValid = (SQL_NUMROWS($result) == 1);
136
137         // Free result
138         SQL_FREERESULT($result);
139
140         // Return result
141         return $isValid;
142 }
143
144 // Checks wether the given network API array translation
145 function isNetworkApiTranslationValid ($key, $type, $networkId) {
146         // Query for it
147         $result = SQL_QUERY_ESC("SELECT `network_api_id` FROM `{?_MYSQL_PREFIX?}_network_api_translation` WHERE `network_id`=%s AND `network_type_id`=%s AND `network_api_index`='%s' LIMIT 1",
148                 array($networkId, $type, $key), __FUNCTION__, __LINE__);
149
150         // Does it exist?
151         $isValid = (SQL_NUMROWS($result) == 1);
152
153         // Free result
154         SQL_FREERESULT($result);
155
156         // Return result
157         return $isValid;
158 }
159
160 // "Getter" for a network's data by provided id number
161 function getNetworkDataById ($id, $column = '') {
162         // Ids lower one are not accepted
163         if ($id < 1) {
164                 // Not good, should be fixed
165                 debug_report_bug(__FUNCTION__, __LINE__, 'Network id ' . $id . ' is smaller than 1.');
166         } // END - if
167
168         // Set current network id
169         setCurrentNetworkId($id);
170
171         // Is it cached?
172         if (!isset($GLOBALS['network_data'][$id])) {
173                 // By default we have no data
174                 $GLOBALS['network_data'][$id] = array();
175
176                 // Query for the network data
177                 $result = SQL_QUERY_ESC("SELECT
178         `network_id`, `network_short_name`, `network_title`, `network_reflink`, `network_data_seperator`, `network_row_seperator`, `network_request_type`, `network_charset`
179 FROM
180         `{?_MYSQL_PREFIX?}_network_data`
181 WHERE
182         `network_id`=%s
183 LIMIT 1",
184                         array(bigintval($id)), __FUNCTION__, __LINE__);
185
186                 // Do we have an entry?
187                 if (SQL_NUMROWS($result) == 1) {
188                         // Then get it
189                         $GLOBALS['network_data'][$id] = SQL_FETCHARRAY($result);
190                 } // END - if
191
192                 // Free result
193                 SQL_FREERESULT($result);
194         } // END - if
195
196         // Return result
197         if (empty($column)) {
198                 // Return array
199                 return $GLOBALS['network_data'][$id];
200         } else {
201                 // Return column
202                 return $GLOBALS['network_data'][$id][$column];
203         }
204 }
205
206 // "Getter" for a network's data by provided type id number
207 function getNetworkDataByTypeId ($id, $column = '') {
208         // Ids lower one are not accepted
209         if ($id < 1) {
210                 // Not good, should be fixed
211                 debug_report_bug(__FUNCTION__, __LINE__, 'Network type id ' . $id . ' is smaller than 1.');
212         } // END - if
213
214         // Set current network id
215         setCurrentNetworkId($id);
216
217         // Is it cached?
218         if (!isset($GLOBALS['network_data'][$id])) {
219                 // By default we have no data
220                 $GLOBALS['network_data'][$id] = array();
221
222                 // Query for the network data
223                 $result = SQL_QUERY_ESC("SELECT
224         d.`network_id`, d.`network_short_name`, d.`network_title`, d.`network_reflink`, d.`network_data_seperator`, d.`network_row_seperator`, d.`network_request_type`, d.`network_charset`,
225         t.`network_type_handle`, t.`network_type_api_url`, t.`network_type_click_url`, t.`network_type_banner_url`
226 FROM
227         `{?_MYSQL_PREFIX?}_network_data` AS d
228 LEFT JOIN
229         `{?_MYSQL_PREFIX?}_network_types` AS t
230 ON
231         d.`network_id`=t.`network_id`
232 WHERE
233         t.`network_type_id`=%s
234 LIMIT 1",
235                         array(bigintval($id)), __FUNCTION__, __LINE__);
236
237                 // Do we have an entry?
238                 if (SQL_NUMROWS($result) == 1) {
239                         // Then get it
240                         $GLOBALS['network_data'][$id] = SQL_FETCHARRAY($result);
241                 } // END - if
242
243                 // Free result
244                 SQL_FREERESULT($result);
245         } // END - if
246
247         // Return result
248         if (empty($column)) {
249                 // Return array
250                 return $GLOBALS['network_data'][$id];
251         } else {
252                 // Return column
253                 return $GLOBALS['network_data'][$id][$column];
254         }
255 }
256
257 // "Getter" for a network type data by provided id number
258 function getNetworkTypeDataById ($id) {
259         // Ids lower one are not accepted
260         if ($id < 1) {
261                 // Not good, should be fixed
262                 debug_report_bug(__FUNCTION__, __LINE__, 'Network type id ' . $id . ' is smaller than 1.');
263         } // END - if
264
265         // By default we have no data
266         $GLOBALS['network_type_data'][$id] = array();
267
268         // Query for the network data
269         $result = SQL_QUERY_ESC("SELECT
270         `network_type_id`, `network_id`, `network_type_handle`, `network_type_api_url`, `network_type_click_url`, `network_type_banner_url`
271 FROM
272         `{?_MYSQL_PREFIX?}_network_types`
273 WHERE
274         `network_type_id`=%s
275 LIMIT 1",
276                 array(bigintval($id)), __FUNCTION__, __LINE__);
277
278         // Do we have an entry?
279         if (SQL_NUMROWS($result) == 1) {
280                 // Then get it
281                 $GLOBALS['network_type_data'][$id] = SQL_FETCHARRAY($result);
282         } // END - if
283
284         // Free result
285         SQL_FREERESULT($result);
286
287         // Return result
288         return $GLOBALS['network_type_data'][$id];
289 }
290
291 // "Getter" for a network request parameter data by provided id number
292 function getNetworkRequestParamsDataById ($id) {
293         // Ids lower one are not accepted
294         if ($id < 1) {
295                 // Not good, should be fixed
296                 debug_report_bug(__FUNCTION__, __LINE__, 'Network request parameter id ' . $id . ' is smaller than 1.');
297         } // END - if
298
299         // By default we have no data
300         $networkRequestData = array();
301
302         // Query for the network data
303         $result = SQL_QUERY_ESC("SELECT
304         `network_param_id`, `network_id`, `network_type_id`, `request_param_key`, `request_param_value`, `request_param_default`
305 FROM
306         `{?_MYSQL_PREFIX?}_network_request_params`
307 WHERE
308         `network_param_id`=%s
309 LIMIT 1",
310                 array(bigintval($id)), __FUNCTION__, __LINE__);
311
312         // Do we have an entry?
313         if (SQL_NUMROWS($result) == 1) {
314                 // Then get it
315                 $networkRequestData = SQL_FETCHARRAY($result);
316         } // END - if
317
318         // Free result
319         SQL_FREERESULT($result);
320
321         // Return result
322         return $networkRequestData;
323 }
324
325 // Updates given network (id) with data from array
326 function doNetworkUpdateDataByArray ($id, $networkData) {
327         // Ids lower one are not accepted
328         if ($id < 1) {
329                 // Not good, should be fixed
330                 debug_report_bug(__FUNCTION__, __LINE__, 'Network id ' . $id . ' is smaller than 1.');
331         } // END - if
332
333         // Just call our inner method
334         return adminSaveSettings($networkData, '_network_data', sprintf("`network_id`=%s", bigintval($id)), array(), false, false);
335 }
336
337 // Updates given network type handler (id) with data from array
338 function doNetworkUpdateTypeByArray ($id, $networkTypeData) {
339         // Ids lower one are not accepted
340         if ($id < 1) {
341                 // Not good, should be fixed
342                 debug_report_bug(__FUNCTION__, __LINE__, 'Network type handler id ' . $id . ' is smaller than 1.');
343         } // END - if
344
345         // Just call our inner method
346         return adminSaveSettings($networkTypeData, '_network_types', sprintf("`network_type_id`=%s", bigintval($id)), array(), false, false);
347 }
348
349 // Updates given network request parameters (id) with data from array
350 function doNetworkUpdateParamsByArray ($id, $networkParamData) {
351         // Ids lower one are not accepted
352         if ($id < 1) {
353                 // Not good, should be fixed
354                 debug_report_bug(__FUNCTION__, __LINE__, 'Network request parameter id ' . $id . ' is smaller than 1.');
355         } // END - if
356
357         // Just call our inner method
358         return adminSaveSettings($networkParamData, '_network_request_params', sprintf("`network_param_id`=%s", bigintval($id)), array(), false, false);
359 }
360
361 // Removes given network entry
362 function doAdminRemoveNetworkEntry ($table, $column, $id, $limit = 1) {
363         // Remove the entry
364         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_network_%s` WHERE `%s`=%s LIMIT %s",
365                 array($table, $column, $id, $limit), __FUNCTION__, __LINE__);
366
367         // Return affected rows
368         return SQL_AFFECTEDROWS();
369 }
370
371 // Generates a list of networks for given script and returns it
372 function generateAdminNetworkList () {
373         // Init output
374         $content = '';
375
376         // Query for all networks
377         $result = SQL_QUERY('SELECT
378         `network_id`, `network_short_name`, `network_title`
379 FROM
380         `{?_MYSQL_PREFIX?}_network_data`
381 ORDER BY
382         `network_short_name` ASC', __FUNCTION__, __LINE__);
383
384         // Do we have entries?
385         if (!SQL_HASZERONUMS($result)) {
386                 // List all entries
387                 $rows = array();
388                 while ($row = SQL_FETCHARRAY($result)) {
389                         // Is this valid, then add it
390                         if ((is_array($row)) && (isset($row['network_id']))) {
391                                 // Add entry
392                                 $rows[$row['network_id']] = $row;
393                         } // END - if
394                 } // END - while
395
396                 // Generate the selection box
397                 $content = generateSelectionBoxFromArray($rows, 'network', 'network_id');
398         } else {
399                 // Nothing selected
400                 $content = loadTemplate('admin_settings_unsaved', false, '{--ADMIN_ENTRIES_404--}');
401         }
402
403         // Free the result
404         SQL_FREERESULT($result);
405
406         // Return the list
407         return $content;
408 }
409
410 // Generator (somewhat getter) for a list of network types for given network id
411 function generateAdminNetworkTypeList ($networkId) {
412         // Init content
413         $content = '';
414
415         // Query all types of this network
416         $result = SQL_QUERY_ESC("SELECT
417         `network_type_id`, `network_type_handle`
418 FROM
419         `{?_MYSQL_PREFIX?}_network_types`
420 WHERE
421         `network_id`=%s
422 ORDER BY
423         `network_type_handle` ASC",
424                 array(
425                         bigintval($networkId)
426                 ), __FUNCTION__, __LINE__);
427
428         // Do we have entries?
429         if (!SQL_HASZERONUMS($result)) {
430                 // List all entries
431                 $rows = array();
432                 while ($row = SQL_FETCHARRAY($result)) {
433                         // Is this valid, then add it
434                         if ((is_array($row)) && (isset($row['network_type_id']))) {
435                                 // Add entry
436                                 $rows[$row['network_type_id']] = $row;
437                         } // END - if
438                 } // END - while
439
440                 // Generate the selection box
441                 $content = generateSelectionBoxFromArray($rows, 'network_type', 'network_type_id');
442         } else {
443                 // Nothing selected
444                 $content = loadTemplate('admin_settings_unsaved', false, '{--ADMIN_ENTRIES_404--}');
445         }
446
447         // Free the result
448         SQL_FREERESULT($result);
449
450         // Return content
451         return $content;
452 }
453
454 // Generator (somewhat getter) for a list of network types for all types
455 function generateAdminDistinctNetworkTypeList () {
456         // Init content
457         $content = '';
458
459         // Query all types of this network
460         $result = SQL_QUERY('SELECT
461         t.`network_type_id`, t.`network_type_handle`, d.`network_title`
462 FROM
463         `{?_MYSQL_PREFIX?}_network_types` AS t
464 LEFT JOIN
465         `{?_MYSQL_PREFIX?}_network_data` AS d
466 ON
467         t.`network_id`=d.`network_id`
468 ORDER BY
469         d.`network_short_name` ASC,
470         t.`network_type_handle` ASC', __FUNCTION__, __LINE__);
471
472         // Do we have entries?
473         if (!SQL_HASZERONUMS($result)) {
474                 // List all entries
475                 $rows = array();
476                 while ($row = SQL_FETCHARRAY($result)) {
477                         // Is this valid, then add it
478                         if ((is_array($row)) && (isset($row['network_type_id']))) {
479                                 // Add entry
480                                 $rows[$row['network_type_id']] = $row;
481                         } // END - if
482                 } // END - while
483
484                 // Generate the selection box
485                 $content = generateSelectionBoxFromArray($rows, 'network_type', 'network_type_id', '', '_title');
486         } else {
487                 // Nothing selected
488                 $content = loadTemplate('admin_settings_unsaved', false, '{--ADMIN_ENTRIES_404--}');
489         }
490
491         // Free the result
492         SQL_FREERESULT($result);
493         //* DEBUG: */ die('<pre>'.encodeEntities($content).'</pre>');
494
495         // Return content
496         return $content;
497 }
498
499 // Generator (somewhat getter) for network type options
500 function generateNetworkTypeOptions ($id) {
501         // Is this an array, then we just came back from edit/delete actions
502         if (is_array($id)) $id = '';
503
504         // Is this cached?
505         if (!isset($GLOBALS[__FUNCTION__][$id])) {
506                 // Generate output and cache it
507                 $GLOBALS[__FUNCTION__][$id] = generateOptionList(
508                         'network_types',
509                         'network_type_id',
510                         'network_type_handle',
511                         $id,
512                         '',
513                         sprintf(
514                                 "WHERE `network_id`=%s",
515                                 bigintval(getRequestParameter('network'))
516                         ),
517                         '',
518                         'translateNetworkTypeHandler'
519                 );
520         } // END - if
521
522         // Return content
523         return $GLOBALS[__FUNCTION__][$id];
524 }
525
526 // Generates an options list of all available (hard-coded) handlers
527 function generateNetworkTypesAvailableOptions () {
528         // Is it cached?
529         if (!isset($GLOBALS[__FUNCTION__])) {
530                 // Generate list
531                 $GLOBALS[__FUNCTION__] = generateOptionList(
532                         '/ARRAY/',
533                         array(
534                                 'banner',
535                                 'banner_click',
536                                 'banner_view',
537                                 'button',
538                                 'button_click',
539                                 'button_view',
540                                 'surfbar',
541                                 'surfbar_click',
542                                 'surfbar_view',
543                                 'forcedbanner',
544                                 'forcedtextlink',
545                                 'textlink',
546                                 'textlink_click',
547                                 'textlink_view',
548                                 'skybanner',
549                                 'skybanner_click',
550                                 'skybanner_view',
551                                 'layer',
552                                 'layer_click',
553                                 'layer_view',
554                                 'popup',
555                                 'popdown',
556                                 'textmail',
557                                 'htmlmail',
558                                 'lead',
559                                 'sale',
560                                 'payperactive',
561                                 'pagepeel',
562                                 'traffic'
563                         ),
564                         array(),
565                         '',
566                         '', '',
567                         $GLOBALS['network_types_disabled'],
568                         'translateNetworkTypeHandler'
569                 );
570         } // END - if
571
572         // Return content
573         return $GLOBALS[__FUNCTION__];
574 }
575
576 // Generates an options list (somewhat getter) ofr request keys
577 function generateNetworkRequestKeyOptions () {
578         // Is it cached?
579         if (!isset($GLOBALS[__FUNCTION__])) {
580                 // Generate and cache it
581                 $GLOBALS[__FUNCTION__] = generateOptionList(
582                         '/ARRAY/',
583                         array(
584                                 'id',
585                                 'sid',
586                                 'hash',
587                                 'password',
588                                 'reload',
589                                 'maximum_stay',
590                                 'minimum_stay',
591                                 'currency',
592                                 'type',
593                                 'remain',
594                                 'reward',
595                                 'size',
596                                 'erotic',
597                                 'extra',
598                                 'country'
599                         ),
600                         array(),
601                         '',
602                         '', '',
603                         $GLOBALS['network_params_disabled'],
604                         'translateNetworkRequestParameter'
605                 );
606         } // END - if
607
608         // Return content
609         return $GLOBALS[__FUNCTION__];
610 }
611
612 // Generator (somewhat getter) for (return) array translation
613 function generateNetworkTranslationOptions ($default = '') {
614         // Is it cached?
615         if (!isset($GLOBALS[__FUNCTION__][$default])) {
616                 // Generate and cache it
617                 $GLOBALS[__FUNCTION__][$default] = generateOptionList(
618                         'network_translations',
619                         'network_translation_id',
620                         'network_translation_name',
621                         $default,
622                         '',
623                         '',
624                         $GLOBALS['network_translation_disabled'],
625                         'translateNetworkTranslationName'
626                 );
627         } // END - if
628
629         // Return content
630         return $GLOBALS[__FUNCTION__][$default];
631 }
632
633 // Generates an option list of request types
634 function generateNetworkRequestTypeOptions ($default = '') {
635         // Do we have cache?
636         if (!isset($GLOBALS[__FUNCTION__][$default])) {
637                 // Generate the list
638                 $GLOBALS[__FUNCTION__][$default] = generateOptionList(
639                         '/ARRAY/',
640                         array(
641                                 'GET',
642                                 'POST'
643                         ),
644                         array(
645                                 '{--ADMIN_NETWORK_REQUEST_TYPE_GET--}',
646                                 '{--ADMIN_NETWORK_REQUEST_TYPE_POST--}'
647                         ),
648                         $default
649                 );
650         } // END - if
651
652         // Return cache
653         return $GLOBALS[__FUNCTION__][$default];
654 }
655
656 // Translates 'translate_name' for e.g. templates
657 function translateNetworkTranslationName ($name) {
658         // Get the message id
659         return getMessage('ADMIN_NETWORK_TRANSLATE_' . strtoupper($name) . '_NAME');
660 }
661
662 // Translates the network type handler (e.g. banner, paidmail) for templates
663 function translateNetworkTypeHandler ($type) {
664         // Get the message id
665         return getMessage('ADMIN_NETWORK_TYPES_' . strtoupper($type) . '');
666 }
667
668 // Translates request type
669 function translateNetworkRequestType ($type) {
670         // Get the message id
671         return getMessage('ADMIN_NETWORK_REQUEST_TYPE_' . strtoupper($type) . '');
672 }
673
674 // Translates request parameter
675 function translateNetworkRequestParameter ($param) {
676         // Get the message id
677         return getMessage('ADMIN_NETWORK_REQUEST_PARAMETER_' . strtoupper($param) . '');
678 }
679
680 // Translates API index
681 function translateNetworkApiIndex ($index) {
682         // Do we have cache?
683         if (!isset($GLOBALS['network_api_index'])) {
684                 // Get an array of all API array indexes
685                 $GLOBALS['network_api_index'] = array();
686
687                 // Get all entries
688                 $result = SQL_QUERY('SELECT
689         `network_api_id`, `network_api_index`, `network_translation_name`
690 FROM
691         `{?_MYSQL_PREFIX?}_network_api_translation`
692 INNER JOIN
693         `{?_MYSQL_PREFIX?}_network_translations`
694 ON
695         `network_api_index`=`network_translation_id`
696 ORDER BY
697         `sort` ASC', __FUNCTION__, __LINE__);
698
699                 // Do we have entries?
700                 if (SQL_NUMROWS($result) > 0) {
701                         // Get all entries
702                         while ($row = SQL_FETCHARRAY($result)) {
703                                 // Add it to our global array
704                                 $GLOBALS['network_api_index'][$row['network_api_index']] = $row;
705                         } // END - while
706                 } // END - if
707
708                 // Free result
709                 SQL_FREERESULT($result);
710         } // END - if
711
712         // Default name is unknown
713         $name = 'unknown';
714
715         // Is the entry there?
716         if (isset($GLOBALS['network_api_index'][$index])) {
717                 // Then get the name
718                 $name = $GLOBALS['network_api_index'][$index]['network_translation_name'];
719         } // END - if
720
721         // Return translation
722         return translateNetworkTranslationName($name);
723 }
724
725 //------------------------------------------------------------------------------
726 //                             Call-back functions
727 //------------------------------------------------------------------------------
728
729 // Callback function to add new network
730 function doAdminNetworkProcessAddNetwork () {
731         // We can say here, the form is sent, so check if the network is already added
732         if (isNetworkNameValid(postRequestParameter('network_short_name'))) {
733                 // Already there
734                 loadTemplate('admin_settings_unsaved', false, getMaskedMessage('ADMIN_NETWORK_ALREADY_ADDED', postRequestParameter('network_short_name')));
735                 return false;
736         } // END - if
737
738         // Remove the 'ok' part
739         unsetPostRequestParameter('ok');
740
741         // Add the whole request to database
742         SQL_QUERY('INSERT INTO
743         `{?_MYSQL_PREFIX?}_network_data`
744 (
745         `' . implode('`,`', array_keys(postRequestArray())) . "`
746 ) VALUES (
747         '" . implode("','", array_values(postRequestArray())) . "'
748 )", __FUNCTION__, __LINE__);
749
750         // Add the id for output only
751         setPostRequestParameter('network_id', SQL_INSERTID());
752
753         // Output message
754         if (SQL_AFFECTEDROWS() == 1) {
755                 // Successfully added
756                 loadTemplate('admin_network_added', false, postRequestArray());
757         } else {
758                 // Not added
759                 loadTemplate('admin_settings_unsaved', false, getMaskedMessage('ADMIN_NETWORK_DATA_NOT_ADDED', postRequestParameter('network_short_name')));
760         }
761 }
762
763 // Displays selected networks for editing
764 function doAdminNetworkProcessHandleNetwork () {
765         // Do we have selections?
766         if (ifPostContainsSelections()) {
767                 // Something has been selected, so start displaying one by one
768                 $OUT = '';
769                 foreach (postRequestParameter('sel') as $id => $sel) {
770                         // Is this selected?
771                         if ($sel == 1) {
772                                 // Load this network's data
773                                 $networkData = getNetworkDataById($id);
774
775                                 // Do we have found the network?
776                                 if (count($networkData) > 0) {
777                                         if (isFormSent('edit')) {
778                                                 // Add row template for editing
779                                                 $OUT .= loadTemplate('admin_edit_networks_row', true, $networkData);
780                                         } elseif (isFormSent('del')) {
781                                                 // Add row template for deleting
782                                                 $OUT .= loadTemplate('admin_del_networks_row', true, $networkData);
783                                         } else {
784                                                 // Problem!
785                                                 debug_report_bug(__FUNCTION__, __LINE__, 'Cannot detect edit/del.');
786                                         }
787                                 } // END - if
788                         } // END - if
789                 } // END - foreach
790
791                 // If we have no rows, we don't need to display the edit form
792                 if (!empty($OUT)) {
793                         // Output main template
794                         if (isFormSent('edit')) {
795                                 loadTemplate('admin_edit_networks', false, $OUT);
796                         } elseif (isFormSent('del')) {
797                                 loadTemplate('admin_del_networks', false, $OUT);
798                         } else {
799                                 // Problem!
800                                 debug_report_bug(__FUNCTION__, __LINE__, 'Cannot detect edit/del.');
801                         }
802
803                         // Don't display the list/add new form
804                         $GLOBALS['network_display'] = false;
805                 } else {
806                         // Nothing selected/found
807                         loadTemplate('admin_settings_unsaved', false, '{--ADMIN_NETWORK_NOTHING_FOUND--}');
808                 }
809         } // END - if
810 }
811
812 // Handle network type form
813 function doAdminNetworkProcessHandleNetworkType () {
814         // Do we have selections?
815         if (ifPostContainsSelections()) {
816                 // Load network data
817                 $networkData = getNetworkDataById(getRequestParameter('network'));
818
819                 // Something has been selected, so start displaying one by one
820                 $OUT = '';
821                 foreach (postRequestParameter('sel') as $id => $sel) {
822                         // Is this selected?
823                         if ($sel == 1) {
824                                 // Load this network's data
825                                 $networkTypeData = getNetworkTypeDataById($id);
826
827                                 // Do we have found the network?
828                                 if (count($networkTypeData) > 0) {
829                                         if (isFormSent('edit')) {
830                                                 // Add row template for deleting
831                                                 $OUT .= loadTemplate('admin_edit_network_types_row', true, $networkTypeData);
832                                         } elseif (isFormSent('del')) {
833                                                 // Add row template for deleting
834                                                 $OUT .= loadTemplate('admin_del_network_types_row', true, $networkTypeData);
835                                         } else {
836                                                 // Problem!
837                                                 debug_report_bug(__FUNCTION__, __LINE__, 'Cannot detect edit/del.');
838                                         }
839                                 } // END - if
840                         } // END - if
841                 } // END - foreach
842
843                 // If we have no rows, we don't need to display the edit form
844                 if (!empty($OUT)) {
845                         // Output main template
846                         if (isFormSent('edit')) {
847                                 loadTemplate('admin_edit_network_types', false, $OUT);
848                         } elseif (isFormSent('del')) {
849                                 loadTemplate('admin_del_network_types', false, $OUT);
850                         } else {
851                                 // Problem!
852                                 debug_report_bug(__FUNCTION__, __LINE__, 'Cannot detect edit/del.');
853                         }
854
855                         // Don't display the list/add new form
856                         $GLOBALS['network_display'] = false;
857                 } else {
858                         // Nothing selected/found
859                         loadTemplate('admin_settings_unsaved', false, '{--ADMIN_NETWORK_TYPES_NOTHING_FOUND--}');
860                 }
861         } // END - if
862 }
863
864 // Handle network request parameter form
865 function doAdminNetworkProcessHandleRequestParams () {
866         // Do we have selections?
867         if (ifPostContainsSelections()) {
868                 // Init cache array
869                 $GLOBALS['network_params_disabled'] = array();
870
871                 // Load network data
872                 $networkData = getNetworkDataById(getRequestParameter('network'));
873
874                 // Something has been selected, so start displaying one by one
875                 $OUT = '';
876                 foreach (postRequestParameter('sel') as $id => $sel) {
877                         // Is this selected?
878                         if ($sel == 1) {
879                                 // Load this network's data
880                                 $networkRequestData = getNetworkRequestParamsDataById($id);
881
882                                 // Do we have found the network?
883                                 if (count($networkRequestData) > 0) {
884                                         if (isFormSent('edit')) {
885                                                 // Add row template for deleting
886                                                 $OUT .= loadTemplate('admin_edit_network_params_row', true, $networkRequestData);
887                                         } elseif (isFormSent('del')) {
888                                                 // Get type data
889                                                 $networkRequestData['network_type_data'] = getNetworkTypeDataById($networkRequestData['network_type_id']);
890
891                                                 // Add row template for deleting
892                                                 $OUT .= loadTemplate('admin_del_network_params_row', true, $networkRequestData);
893                                         } else {
894                                                 // Problem!
895                                                 debug_report_bug(__FUNCTION__, __LINE__, 'Cannot detect edit/del.');
896                                         }
897                                 } // END - if
898                         } // END - if
899                 } // END - foreach
900
901                 // If we have no rows, we don't need to display the edit form
902                 if (!empty($OUT)) {
903                         // Output main template
904                         if (isFormSent('edit')) {
905                                 loadTemplate('admin_edit_network_params', false, $OUT);
906                         } elseif (isFormSent('del')) {
907                                 loadTemplate('admin_del_network_params', false, $OUT);
908                         } else {
909                                 // Problem!
910                                 debug_report_bug(__FUNCTION__, __LINE__, 'Cannot detect edit/del.');
911                         }
912
913                         // Don't display the list/add new form
914                         $GLOBALS['network_display'] = false;
915                 } else {
916                         // Nothing selected/found
917                         loadTemplate('admin_settings_unsaved', false, '{--ADMIN_NETWORK_REQUEST_PARAMETER_NOTHING_FOUND--}');
918                 }
919         } // END - if
920 }
921
922 // Changes given networks
923 function doAdminNetworkProcessChangeNetwork () {
924         // Do we have selections?
925         if (ifPostContainsSelections()) {
926                 // By default nothing is updated
927                 $updated = 0;
928
929                 // Something has been selected, so start updating them
930                 foreach (postRequestParameter('sel') as $id => $sel) {
931                         // Update this entry?
932                         if ($sel == 1) {
933                                 // Init data array
934                                 $networkData = array();
935
936                                 // Transfer whole array, except 'sel'
937                                 foreach (postRequestArray() as $key => $entry) {
938                                         // Skip 'sel' and submit button
939                                         if (in_array($key, array('sel', 'change'))) continue;
940
941                                         // Do we have this enty?
942                                         if (!isset($entry[$id])) {
943                                                 // Not found, needs fixing
944                                                 debug_report_bug(__FUNCTION__, __LINE__, 'No entry in key=' . $key . ', id=' . $id . ' found.');
945                                         } // END - if
946
947                                         // Add this entry
948                                         $networkData[$key] = $entry[$id];
949                                 } // END - foreach
950
951                                 // Update the network data
952                                 $updated += doNetworkUpdateDataByArray($id, $networkData);
953                         } // END - if
954                 } // END - foreach
955
956                 // Do we have updates?
957                 if ($updated > 0) {
958                         // Updates done
959                         loadTemplate('admin_settings_saved', false, getMaskedMessage('ADMIN_NETWORK_UPDATED', $updated));
960                 } else {
961                         // Nothing changed
962                         loadTemplate('admin_settings_unsaved', false, '{--ADMIN_NETWORK_NOTHING_CHANGED--}');
963                 }
964         } // END - if
965 }
966
967 // Removes given networks
968 function doAdminNetworkProcessRemoveNetwork () {
969         // Do we have selections?
970         if (ifPostContainsSelections()) {
971                 // By default nothing is removed
972                 $removed = 0;
973
974                 // Something has been selected, so start updating them
975                 foreach (postRequestParameter('sel') as $id => $sel) {
976                         // Update this entry?
977                         if ($sel == 1) {
978                                 // Remove this entry
979                                 $removed += doAdminRemoveNetworkEntry('data', 'network_id', $id);
980                         } // END - if
981                 } // END - foreach
982
983                 // Do we have removes?
984                 if ($removed > 0) {
985                         // Removals done
986                         loadTemplate('admin_settings_saved', false, getMaskedMessage('ADMIN_NETWORK_REMOVED', $removed));
987                 } else {
988                         // Nothing removed
989                         loadTemplate('admin_settings_unsaved', false, '{--ADMIN_NETWORK_NOTHING_REMOVED--}');
990                 }
991         } // END - if
992 }
993
994 // Add a network type handler if not yet found
995 function doAdminNetworkProcessAddNetworkType () {
996         // Is the network type handle already used with given network?
997         if (isNetworkTypeHandleValid(postRequestParameter('network_type_handle'), getRequestParameter('network'))) {
998                 // Already added
999                 loadTemplate('admin_settings_unsaved', false, getMaskedMessage('ADMIN_NETWORK_TYPES_HANDLE_ALREADY_ADDED', postRequestParameter('network_type_handle')));
1000
1001                 // ... so abort here
1002                 return false;
1003         } // END - if
1004
1005         // Remove the 'ok' part
1006         unsetPostRequestParameter('ok');
1007
1008         // Add id
1009         setPostRequestParameter('network_id', bigintval(getRequestParameter('network')));
1010
1011         // Is network_type_banner_url set?
1012         if (postRequestParameter('network_type_banner_url') == '') {
1013                 // Remove empty value to get a NULL for an optional entry
1014                 unsetPostRequestParameter('network_type_banner_url');
1015         } // END - if
1016
1017         // Add the whole request to database
1018         SQL_QUERY('INSERT INTO
1019         `{?_MYSQL_PREFIX?}_network_types`
1020 (
1021         `' . implode('`,`', array_keys(postRequestArray())) . "`
1022 ) VALUES (
1023         '" . implode("','", array_values(postRequestArray())) . "'
1024 )", __FUNCTION__, __LINE__);
1025
1026         // Output message
1027         if (SQL_AFFECTEDROWS() == 1) {
1028                 // Successfully added
1029                 loadTemplate('admin_network_type_added', false, postRequestArray());
1030         } else {
1031                 // Not added
1032                 loadTemplate('admin_settings_unsaved', false, getMaskedMessage('ADMIN_NETWORK_TYPES_NOT_ADDED', postRequestParameter('network_type_handle')));
1033         }
1034 }
1035
1036 // Changes given network type handlers
1037 function doAdminNetworkProcessChangeNetworkType () {
1038         // Do we have selections?
1039         if (ifPostContainsSelections()) {
1040                 // By default nothing is updated
1041                 $updated = 0;
1042
1043                 // Something has been selected, so start updating them
1044                 foreach (postRequestParameter('sel') as $id => $sel) {
1045                         // Update this entry?
1046                         if ($sel == 1) {
1047                                 // Init data array
1048                                 $networkTypeData = array();
1049
1050                                 // Transfer whole array, except 'sel'
1051                                 foreach (postRequestArray() as $key => $entry) {
1052                                         // Skip 'sel' and submit button
1053                                         if (in_array($key, array('sel', 'change'))) continue;
1054
1055                                         // Do we have this enty?
1056                                         if (!isset($entry[$id])) {
1057                                                 // Not found, needs fixing
1058                                                 debug_report_bug(__FUNCTION__, __LINE__, 'No entry in key=' . $key . ', id=' . $id . ' found.');
1059                                         } // END - if
1060
1061                                         // Fix empty network_type_banner_url to NULL
1062                                         if (($key == 'network_type_banner_url') && (trim($entry[$id]) == '')) {
1063                                                 // Set it to NULL
1064                                                 $entry[$id] = null;
1065                                         } // END - if
1066
1067                                         // Add this entry
1068                                         $networkTypeData[$key] = $entry[$id];
1069                                 } // END - foreach
1070
1071                                 // Update the network data
1072                                 $updated += doNetworkUpdateTypeByArray($id, $networkTypeData);
1073                         } // END - if
1074                 } // END - foreach
1075
1076                 // Do we have updates?
1077                 if ($updated > 0) {
1078                         // Updates done
1079                         loadTemplate('admin_settings_saved', false, getMaskedMessage('ADMIN_NETWORK_TYPES_UPDATED', $updated));
1080                 } else {
1081                         // Nothing changed
1082                         loadTemplate('admin_settings_unsaved', false, '{--ADMIN_NETWORK_TYPES_NOTHING_CHANGED--}');
1083                 }
1084         } // END - if
1085 }
1086
1087 // Changes given network request parameters
1088 function doAdminNetworkProcessChangeNetworkParam () {
1089         // Do we have selections?
1090         if (ifPostContainsSelections()) {
1091                 // By default nothing is updated
1092                 $updated = 0;
1093
1094                 // Something has been selected, so start updating them
1095                 foreach (postRequestParameter('sel') as $id => $sel) {
1096                         // Update this entry?
1097                         if ($sel == 1) {
1098                                 // Init data array
1099                                 $networkParamsData = array();
1100
1101                                 // Transfer whole array, except 'sel'
1102                                 foreach (postRequestArray() as $key => $entry) {
1103                                         // Skip 'sel' and submit button
1104                                         if (in_array($key, array('sel', 'change'))) continue;
1105
1106                                         // Do we have this enty?
1107                                         if (!isset($entry[$id])) {
1108                                                 // Not found, needs fixing
1109                                                 debug_report_bug(__FUNCTION__, __LINE__, 'No entry in key=' . $key . ', id=' . $id . ' found.');
1110                                         } // END - if
1111
1112                                         // Fix empty request_param_default to NULL
1113                                         if (($key == 'request_param_default') && (trim($entry[$id]) == '')) {
1114                                                 // Set it to NULL
1115                                                 $entry[$id] = null;
1116                                         } // END - if
1117
1118                                         // Add this entry
1119                                         $networkParamsData[$key] = $entry[$id];
1120                                 } // END - foreach
1121
1122                                 // Update the network data
1123                                 $updated += doNetworkUpdateParamsByArray($id, $networkParamsData);
1124                         } // END - if
1125                 } // END - foreach
1126
1127                 // Do we have updates?
1128                 if ($updated > 0) {
1129                         // Updates done
1130                         loadTemplate('admin_settings_saved', false, getMaskedMessage('ADMIN_NETWORK_REQUEST_PARAMETER_UPDATED', $updated));
1131                 } else {
1132                         // Nothing changed
1133                         loadTemplate('admin_settings_unsaved', false, '{--ADMIN_NETWORK_REQUEST_PARAMETER_NOTHING_CHANGED--}');
1134                 }
1135         } // END - if
1136 }
1137
1138 // Removes given network type handlers
1139 function doAdminNetworkProcessRemoveNetworkType () {
1140         // Do we have selections?
1141         if (ifPostContainsSelections()) {
1142                 // By default nothing is removed
1143                 $removed = 0;
1144
1145                 // Something has been selected, so start updating them
1146                 foreach (postRequestParameter('sel') as $id => $sel) {
1147                         // Update this entry?
1148                         if ($sel == 1) {
1149                                 // Remove this entry
1150                                 $removed += doAdminRemoveNetworkEntry('types', 'network_type_id', $id);
1151                         } // END - if
1152                 } // END - foreach
1153
1154                 // Do we have removes?
1155                 if ($removed > 0) {
1156                         // Removals done
1157                         loadTemplate('admin_settings_saved', false, getMaskedMessage('ADMIN_NETWORK_TYPES_REMOVED', $removed));
1158                 } else {
1159                         // Nothing removed
1160                         loadTemplate('admin_settings_unsaved', false, '{--ADMIN_NETWORK_TYPES_NOTHING_REMOVED--}');
1161                 }
1162         } // END - if
1163 }
1164
1165 // Removes given network request parameters
1166 function doAdminNetworkProcessRemoveNetworkParam () {
1167         // Do we have selections?
1168         if (ifPostContainsSelections()) {
1169                 // By default nothing is removed
1170                 $removed = 0;
1171
1172                 // Something has been selected, so start updating them
1173                 foreach (postRequestParameter('sel') as $id => $sel) {
1174                         // Update this entry?
1175                         if ($sel == 1) {
1176                                 // Remove this entry
1177                                 $removed += doAdminRemoveNetworkEntry('request_params', 'network_param_id', $id);
1178                         } // END - if
1179                 } // END - foreach
1180
1181                 // Do we have removes?
1182                 if ($removed > 0) {
1183                         // Removals done
1184                         loadTemplate('admin_settings_saved', false, getMaskedMessage('ADMIN_NETWORK_REQUEST_PARAMETER_REMOVED', $removed));
1185                 } else {
1186                         // Nothing removed
1187                         loadTemplate('admin_settings_unsaved', false, '{--ADMIN_NETWORK_REQUEST_PARAMETER_NOTHING_REMOVED--}');
1188                 }
1189         } // END - if
1190 }
1191
1192 // Adds a request parameter to given network and type
1193 function doAdminNetworkProcessAddNetworkParam () {
1194         // Is the request parameter already used with given network?
1195         if (isNetworkRequestParameterValid(postRequestParameter('request_param_key'), postRequestParameter('network_type_id'), getRequestParameter('network'))) {
1196                 // Already added
1197                 loadTemplate('admin_settings_unsaved', false, getMaskedMessage('ADMIN_NETWORK_REQUEST_PARAMETER_ALREADY_ADDED', postRequestParameter('request_param_key')));
1198
1199                 // ... so abort here
1200                 return false;
1201         } // END - if
1202
1203         // Remove the 'ok' part
1204         unsetPostRequestParameter('ok');
1205
1206         // Add id
1207         setPostRequestParameter('network_id', bigintval(getRequestParameter('network')));
1208
1209         // Is request_param_default set?
1210         if (postRequestParameter('request_param_default') == '') {
1211                 // Remove empty value to get a NULL for an optional entry
1212                 unsetPostRequestParameter('request_param_default');
1213         } // END - if
1214
1215         // Add the whole request to database
1216         SQL_QUERY('INSERT INTO
1217         `{?_MYSQL_PREFIX?}_network_request_params`
1218 (
1219         `' . implode('`,`', array_keys(postRequestArray())) . "`
1220 ) VALUES (
1221         '" . implode("','", array_values(postRequestArray())) . "'
1222 )", __FUNCTION__, __LINE__);
1223
1224         // Output message
1225         if (SQL_AFFECTEDROWS() == 1) {
1226                 // Successfully added
1227                 loadTemplate('admin_network_request_param_added', false, postRequestArray());
1228         } else {
1229                 // Not added
1230                 loadTemplate('admin_settings_unsaved', false, getMaskedMessage('ADMIN_NETWORK_REQUEST_PARAMETER_NOT_ADDED', postRequestParameter('request_param_key')));
1231         }
1232 }
1233
1234 // Adds a API response array entry
1235 function doAdminNetworkProcessAddNetworkApiTranslation () {
1236         // Is the request parameter already used with given network?
1237         if (isNetworkApiTranslationValid(postRequestParameter('network_api_index'), postRequestParameter('network_type_id'), getRequestParameter('network'))) {
1238                 // Already added
1239                 loadTemplate('admin_settings_unsaved', false, getMaskedMessage('ADMIN_NETWORK_API_TRANSLATION_ALREADY_ADDED', postRequestParameter('network_api_index')));
1240
1241                 // ... so abort here
1242                 return false;
1243         } // END - if
1244
1245         // Remove the 'ok' part
1246         unsetPostRequestParameter('ok');
1247
1248         // Add id
1249         setPostRequestParameter('network_id', bigintval(getRequestParameter('network')));
1250
1251         // Add sorting
1252         setPostRequestParameter('sort', (countSumTotalData(
1253                 postRequestParameter('network_id'),
1254                 'network_api_translation',
1255                 'network_api_id',
1256                 'network_id',
1257                 true,
1258                 sprintf(" AND `network_type_id`=%s", bigintval(postRequestParameter('network_type_id')))
1259         ) + 1));
1260
1261         // Add the whole request to database
1262         SQL_QUERY('INSERT INTO
1263         `{?_MYSQL_PREFIX?}_network_api_translation`
1264 (
1265         `' . implode('`,`', array_keys(postRequestArray())) . "`
1266 ) VALUES (
1267         '" . implode("','", array_values(postRequestArray())) . "'
1268 )", __FUNCTION__, __LINE__);
1269
1270         // Output message
1271         if (SQL_AFFECTEDROWS() == 1) {
1272                 // Successfully added
1273                 loadTemplate('admin_network_api_translation_added', false, postRequestArray());
1274         } else {
1275                 // Not added
1276                 loadTemplate('admin_settings_unsaved', false, getMaskedMessage('ADMIN_NETWORK_API_TRANSLATION_NOT_ADDED', postRequestParameter('network_api_index')));
1277         }
1278 }
1279
1280 // Do expression code for this extension
1281 function doExpressionNetwork ($data) {
1282         // Construct replacer
1283         $replacer = sprintf(
1284                 "{DQUOTE} . %s(%s, '%s') . {DQUOTE}",
1285                 $data['callback'],
1286                 $data['matches'][4][$data['key']],
1287                 $data['extra_func']
1288         );
1289
1290         // Replace %network% with the current network id
1291         $replacer = str_replace('%network%', getCurrentNetworkId(), $replacer);
1292
1293         // Replace the code
1294         $code = replaceExpressionCode($data, $replacer);
1295
1296         // Return it
1297         return $code;
1298 }
1299
1300 // [EOF]
1301 ?>