This repository has been archived by the owner on Aug 24, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 10
/
atktools.inc
2036 lines (1839 loc) · 62 KB
/
atktools.inc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* This file is part of the ATK distribution on GitHub.
* Detailed copyright and licensing information can be found
* in the doc/COPYRIGHT and doc/LICENSE files which should be
* included in the distribution.
*
* @package atk
*
* This file contains a set of general-purpose utility functions.
* @todo Move all these functions to relevant classes.
* @todo Document all of the functions
*
* @copyright (c)2000-2007 Ibuildings.nl BV
* @copyright (c)2000-2007 Ivo Jansch
* @license http://www.achievo.org/atk/licensing ATK Open Source License
*
* @version $Revision$
* $Id$
*/
/**
* Converts applicable characters to html entities so they aren't
* interpreted by the browser.
*/
define("DEBUG_HTML", 1);
/**
* Wraps the text into html bold tags in order to make warnings more
* clearly visible.
*/
define("DEBUG_WARNING", 2);
/**
* Hides the debug unless in level 2.
* This should be used for debug you only really want to see if you
* are developing (like deprecation warnings).
*/
define("DEBUG_NOTICE", 4);
/**
* Error message.
*/
define("DEBUG_ERROR", 8);
/**
* Function atkErrorHandler
* This function catches PHP parse errors etc, and passes
* them to atkerror(), so errors can be mailed and output
* can be regulated.
* This funtion must be registered with set_error_handler("atkErrorHandler");
*
* @param $errtype: One of the PHP errortypes (E_PARSE, E_USER_ERROR, etc)
(See http://www.php.net/manual/en/function.error-reporting.php)
* @param $errstr: Error text
* @param $errfile: The php file in which the error occured.
* @param $errline: The line in the file on which the error occured.
*/
function atkErrorHandler($errtype, $errstr, $errfile, $errline)
{
// probably suppressed error using the @ operator, simply ignore
if (error_reporting() == 0) {
return;
}
$errortype = array(
E_ERROR => "Error",
E_WARNING => "Warning",
E_PARSE => "Parsing Error",
E_NOTICE => "Notice",
E_CORE_ERROR => "Core Error",
E_CORE_WARNING => "Core Warning",
E_COMPILE_ERROR => "Compile Error",
E_COMPILE_WARNING => "Compile Warning",
E_USER_ERROR => "User Error",
E_USER_WARNING => "User Warning",
E_USER_NOTICE => "User Notice",
E_STRICT => "Strict Notice"
);
// E_RECOVERABLE_ERROR is available since 5.2.0
if (defined('E_RECOVERABLE_ERROR')) {
$errortype[E_RECOVERABLE_ERROR] = "Recoverable Error";
}
// E_DEPRECATED / E_USER_DEPRECATED are available since 5.3.0
if (defined('E_DEPRECATED')) {
$errortype[E_DEPRECATED] = "Deprecated";
$errortype[E_USER_DEPRECATED] = "User Deprecated";
}
// Translate the given errortype into a string
$errortypestring = $errortype[$errtype];
if ($errtype == E_STRICT) {
// ignore strict notices for now, there is too much stuff that needs to be fixed
return;
} else if ($errtype == E_NOTICE) {
// Just show notices
atkdebug("[$errortypestring] $errstr in $errfile (line $errline)", DEBUG_NOTICE);
return;
} else if (defined('E_DEPRECATED') && ($errtype & (E_DEPRECATED | E_USER_DEPRECATED)) > 0) {
// Just show deprecation warnings in the debug log, but don't influence the program flow
atkdebug("[$errortypestring] $errstr in $errfile (line $errline)", DEBUG_NOTICE);
return;
} else if (($errtype & (E_WARNING | E_USER_WARNING)) > 0) {
// This is something we should pay attention to, but we don't need to die.
atkerror("[$errortypestring] $errstr in $errfile (line $errline)");
return;
} else {
atkerror("[$errortypestring] $errstr in $errfile (line $errline)");
// we must die. we can't even output anything anymore..
// we can do something with the info though.
handleError();
atkOutput::getInstance()->outputFlush();
die;
}
}
/**
* Default ATK exception handler, handles uncaught exceptions and calls atkHalt.
*
* @param Exception $exception uncaught exception
*/
function atkExceptionHandler(Exception $exception)
{
atkdebug($exception->getMessage(), DEBUG_ERROR);
atkdebug("Trace:<br/>" . nl2br($exception->getTraceAsString()), DEBUG_ERROR);
atkhalt("Uncaught exception: " . $exception->getMessage(), 'critical');
}
/**
* @deprecated Use atkhalt instead.
*/
function halt($msg, $level = "warning")
{
return atkhalt($msg, $level);
}
/**
* Function atkhalt
* Halts on critical errors and also on warnings if specified in the config file.
* @param string $msg The message to be displayed
* @param string $level The level of the error,
* ("critical"|"warning" (default))
* @return bool false if something goes horribly wrong
*/
function atkhalt($msg, $level = "warning")
{
if ($level == $GLOBALS['config_halt_on_error'] || $level == "critical") {
if ($level == "warning") {
$level_color = "#0000ff";
} else {
// critical
$level_color = "#ff0000";
}
if (php_sapi_name() == 'cli') {
$res = atktext($level, "atk") . ': ' . $msg . "\n";
} else {
$res = "<html>";
$res .='<body bgcolor="#ffffff" color="#000000">';
$res .="<font color=\"$level_color\"><b>" . atktext($level, "atk") . "</b></font>: $msg.<br />\n";
}
atkOutput::getInstance()->output($res);
atkOutput::getInstance()->outputFlush();
exit("Halted...\n");
} else {
atkerror("$msg");
}
return false;
}
/**
* @deprecated Use atkDebugger::getMicroTime()
* @return int the microtime
*/
function getmicrotime()
{
atkimport("atk.utils.atkdebugger");
return atkDebugger::getMicroTime();
}
/**
* @deprecated Use atkDebugger::elapsed();
*
* @return string elapsed time in microseconds
*/
function elapsed()
{
atkimport("atk.utils.atkdebugger");
return atkDebugger::elapsed();
}
/**
* Function atkdebug
*
* Adds debug text to the debug log
* @param String $txt The text that will be added to the log
* @param Integer $flags An optional combination of DEBUG_ flags
*/
function atkdebug($txt, $flags = 0)
{
global $g_debug_msg;
$level = atkconfig("debug");
if ($level >= 0) {
if (hasFlag($flags, DEBUG_HTML))
$txt = atk_htmlentities($txt);
if (hasFlag($flags, DEBUG_WARNING))
$txt = "<b>" . $txt . "</b>";
$line = atkGetTimingInfo() . $txt;
atkWriteLog($line);
if (hasFlag($flags, DEBUG_ERROR)) {
$line = '<span class="atkDebugError">' . $line . '</span>';
}
if ($level > 2) {
atkimport("atk.utils.atkdebugger");
if (!atkDebugger::addStatement($line)) {
$g_debug_msg[] = $line;
}
} else if (!hasFlag($flags, DEBUG_NOTICE)) {
$g_debug_msg[] = $line;
}
} else if ($level > -1) { // at 0 we still collect the info so we
// have it in error reports. At -1, we don't collect
$g_debug_msg[] = $txt;
}
}
/**
* Send a notice to the debug log.
* A notice doesn't get show unless your debug level is 3 or higher.
*
* @param String $txt The text that will be added to the log
*/
function atknotice($txt)
{
atkdebug($txt, DEBUG_NOTICE);
}
/**
* Send a warning to the debug log.
* A warning gets shown more prominently than a normal debug line.
* However it does not trigger a mailreport
* or anything else that an atkerror triggers.
*
* @param string $txt
*/
function atkwarning($txt)
{
atkdebug($txt, DEBUG_WARNING);
}
function atkGetTimingInfo()
{
return "[" . elapsed() . (atkconfig('debug') > 0 && function_exists("memory_get_usage")
? " / " . sprintf("%02.02f", (memory_get_usage() / 1024 / 1024)) . "MB"
: "") . "] ";
}
/**
* Like atkdebug, this displays a message at the bottom of the screen.
* The difference is, that this is also displayed when debugging is turned
* off.
*
* If error reporting by email is turned on, the error messages are also
* send by e-mail.
*
* @param string|Exception $error the error text or exception to display
*/
function atkerror($error)
{
global $g_error_msg;
if ($error instanceof Exception) {
$g_error_msg[] = "[" . elapsed() . "] " . $error->getMessage();
atkdebug(nl2br($error->getMessage() . "\n" . $error->getTraceAsString()), DEBUG_ERROR);
} else {
$g_error_msg[] = "[" . elapsed() . "] " . $error;
atkdebug($error, DEBUG_ERROR);
}
if (function_exists('debug_backtrace')) {
atkdebug("Trace:" . atk_get_trace(), DEBUG_ERROR);
}
if (atkconfig('throw_exception_on_error') && $error instanceof Exception) {
throw $error;
} else if (atkconfig('throw_exception_on_error')) {
throw new Exception($error);
}
}
/**
* Returns a trace-route from all functions where-through the code has been executed
*
* @param string $format (html|plaintext)
* @return string Backtrace in html or plaintext format
*/
function atkGetTrace($format = "html")
{
// Return if the debug_backtrace function doesn't exist
if (!function_exists("debug_backtrace"))
return "Incorrect php-version for atk_get_trace()";
// Get the debug backtrace
$traceArr = debug_backtrace();
// Remove the call of atk_get_trace
array_shift($traceArr);
// Start with an empty result;
$ret = "";
$theSpacer = "";
// Loop through all items found in the backtrace
for ($i = 0, $_i = count($traceArr); $i < $_i; $i++) {
//for($i=count($traceArr)-1; $i >= 0; $i--)
// Skip this item in the backtrace if empty
if (empty($traceArr[$i]))
continue;
// Don't display an atkerror statement itself.
if ($traceArr[$i]["function"] == "atkerror")
continue;
// Read the source location
if (isset($traceArr[$i]["file"]))
$location = $traceArr[$i]["file"] . (isset($traceArr[$i]["line"]) ? sprintf(", line %d", $traceArr[$i]["line"])
: "[Unknown line]");
else
$location = "[PHP KERNEL]";
// Read the statement
if (isset($traceArr[$i]["class"])) {
$statement = $traceArr[$i]["class"];
if (isset($traceArr[$i]["type"]))
$statement .= $traceArr[$i]["type"];
}
else {
$statement = "";
}
$statement .= $traceArr[$i]["function"];
// Initialize the functionParamArr array
$functionParamArr = array();
// Parse any arguments into the array
if (isset($traceArr[$i]["args"])) {
foreach ($traceArr[$i]["args"] as $val) {
if (is_array($val)) {
$valArr = array();
foreach ($val as $name => $value) {
if (is_numeric($name))
$valArr[] = $name;
else {
/* AGX: manage non object situations */
if (is_object($value)) {
$valArr[] = sprintf("%s=Object(%s)", $name, get_class($value));
} elseif (is_array($value)) {
$valArr[] = sprintf("%s=Array(%s)", $name, count($value));
} else {
$valArr[] = $name . "=" . $value;
}
/* END */
}
}
$stringval = "array(" . implode(", ", $valArr) . ")";
}
else if (is_null($val))
$stringval = 'null';
else if (is_object($val))
$stringval = sprintf("Object(%s)", get_class($val));
else if (is_bool($val))
$stringval = $val ? 'true' : 'false';
else {
if (strlen($val . $theSpacer) > 103)
$stringval = '"' . substr($val, 0, 100 - strlen($theSpacer)) . '"...';
else
$stringval = '"' . $val . '"';
}
$functionParamArr[] = $theSpacer . " " . $stringval;
}
}
$functionParams = implode(",\n", $functionParamArr);
$ret .= $theSpacer . "@" . $location . "\n";
$ret .= $theSpacer . $statement;
$ret .= (strlen($functionParams) ? "\n" . $theSpacer . "(\n" . $functionParams . "\n" . $theSpacer . ")"
: "()") . "\n";
// Add indentation
$theSpacer .= " ";
}
// If html format should be used, replace the html special chars with html entities and put the backtrace within preformat tags.
if ($format == "html")
$ret = "<pre>" . htmlspecialchars($ret) . "</pre>";
// Return the generated trace
return $ret;
}
/**
* @deprecated Use atkGetTrace instead
*/
function atk_get_trace($format = "html")
{
return atkGetTrace($format);
}
/**
* Writes info to a given file.
* Useful for writing to any log files.
* @param String $text text to write to the logfile
* @param String $file the file name
*/
function atkWriteToFile($text, $file = "")
{
$fp = @fopen($file, "a");
if ($fp) {
fwrite($fp, $text . "\n");
fclose($fp);
}
}
/**
* Writes info to the optional debug logfile.
* Please notice this feature will heavily decrease the performance
* and should therefore only be used for debugging and development
* purposes.
* @param String $text text to write to the logfile
*/
function atkWriteLog($text)
{
if (atkconfig("debug") > 0 && atkconfig("debuglog")) {
atkWriteToFile($text, atkconfig("debuglog"));
}
}
/**
* Replaces the [vars] with the values from the language files
* Please note that it is important, for performance reasons,
* that you pass along the module where the language files can be found
* @param mixed $string string or array of strings containing the name(s) of the string to return
* when an array of strings is passed, the second will be the fallback if
* the first one isn't found, and so forth
* @param String $module module in which the language file should be looked for,
* defaults to core module with fallback to ATK
* @param String $node the node to which the string belongs
* @param String $lng ISO 639-1 language code, defaults to config variable
* @param String $firstfallback the first module to check as part of the fallback
* @param boolean $nodefaulttext if true, then it doesn't return a default text
* when it can't find a translation
* @return String the string from the languagefile
* @deprecated Use atktext instead
*/
function text($string, $node = "", $module = "", $lng = "", $firstfallback = "", $nodefaulttext = false)
{
atkdebug("Call to deprecated text() function", DEBUG_WARNING);
atkimport("atk.atklanguage");
return atkLanguage::text($string, $module, $node, $lng, $firstfallback, $nodefaulttext);
}
/**
* Replaces the [vars] with the values from the language files
* Please note that it is important, for performance reasons,
* that you pass along the module where the language files can be found
* @param mixed $string string or array of strings containing the name(s) of the string to return
* when an array of strings is passed, the second will be the fallback if
* the first one isn't found, and so forth
* @param String $module module in which the language file should be looked for,
* defaults to core module with fallback to ATK
* @param String $node the node to which the string belongs
* @param String $lng ISO 639-1 language code, defaults to config variable
* @param String $firstfallback the first module to check as part of the fallback
* @param boolean $nodefaulttext if true, then it doesn't return a default text
* when it can't find a translation
* @param boolean $modulefallback Wether or not to use all the modules of the application in the fallback,
* when looking for strings
* @return String the string from the languagefile
*/
function atktext($string, $module = "", $node = "", $lng = "", $firstfallback = "", $nodefaulttext = false, $modulefallback = false)
{
atkimport("atk.atklanguage");
return atkLanguage::text($string, $module, $node, $lng, $firstfallback, $nodefaulttext, $modulefallback);
}
/**
* @deprecated Use atkSession::newLevel() instead
*/
function session_level($sessionstatus = SESSION_DEFAULT, $levelskip = null)
{
return atkSessionManager::newLevel($sessionstatus, $levelskip);
}
/**
* @deprecated Use atkSessionManager::formState instead.
*/
function session_form($sessionstatus = SESSION_DEFAULT, $returnbehaviour = null, $fieldprefix = '')
{
return atkSessionManager::formState($sessionstatus, $returnbehaviour, $fieldprefix);
}
/**
* @deprecated Use atkSessionManager::sessionVars() instead.
*/
function session_vars($sessionstatus = SESSION_DEFAULT, $levelskip = null, $url = "")
{
return atkSessionManager::sessionVars($sessionstatus, $levelskip, $url);
}
/**
* @deprecated use atkSessionManager::sessionUrl() instead.
*/
function session_url($url, $sessionstatus = SESSION_DEFAULT, $levelskip = null)
{
return atkSessionManager::sessionUrl($url, $sessionstatus, $levelskip);
}
/**
* @deprecated use atkHref or atkSessionManager::href instead.
*/
function href($url, $name = "", $sessionstatus = SESSION_DEFAULT, $saveform = false, $extraprops = "")
{
return atkSessionManager::href($url, $name, $sessionstatus, $saveform, $extraprops);
}
/**
* Convenience wrapper for atkSessionManager::href().
* @see atkSessionManager::href
*/
function atkHref($url, $name = "", $sessionstatus = SESSION_DEFAULT, $saveform = false, $extraprops = "")
{
return atkSessionManager::href($url, $name, $sessionstatus, $saveform, $extraprops);
}
/**
* Same as array_merge from php, but without duplicates..
* Supports unlimited number of arrays as arguments.
*
* @param Array $array1 the first array
* @param Array $array2 the second array
* @return Array The result of the merge between $array1 and $array2
*/
function atk_array_merge($array1, $array2)
{
$res = Array();
$arrays = func_get_args();
for ($i = 0, $_i = count($arrays); $i < $_i; $i++) {
for ($j = 0, $_j = count($arrays[$i]); $j < $_j; $j++) {
if (!in_array($arrays[$i][$j], $res)) {
$res[] = $arrays[$i][$j];
}
}
}
return $res;
}
/**
* Same as array_merge_recursive from PHP but without duplicates.
* Supports unlimited number of arrays as arguments.
*
* @param array $array1 first array
* @param array $array2 second array
*
* @return array merged arrays
*/
function atk_array_merge_recursive($array1, $array2)
{
$arrays = func_get_args();
$result = array();
foreach ($arrays as $array) {
foreach ($array as $key => $value) {
if (isset($result[$key]) && is_array($result[$key]) && is_array($value)) {
$result[$key] = atk_array_merge_recursive($result[$key], $value);
} else {
$result[$key] = $value;
}
}
}
return $result;
}
/**
* Same as array_merge from php, but this function preserves key=>index
* association in case of numerical indexes. Supports unlimited number
* of arrays as arguments.
*
* @param Array $array unlimited number of arrays
* @return Array The result of the merge between the given arrays
*/
function atk_array_merge_keys()
{
$args = func_get_args();
$result = array();
foreach ($args as $array) {
foreach ($array as $key => $value) {
$result[$key] = $value;
}
}
return $result;
}
/**
* Since php triggers an error if you perform an in_array on an
* uninitialised array, we provide a small wrapper that performs
* an is_array on the haystack first, just to make sure the user
* doesn't get an error message.
*
* @param mixed $needle The value to search for.
* @param Array $haystack The array to search.
* @param boolean $strict If true, type must match.
* @return bool wether or not the value is in the array
*/
function atk_in_array($needle, $haystack, $strict = false)
{
return (is_array($haystack) && in_array($needle, $haystack, $strict));
}
/**
* Function dataSetContains
*
* Checks if a value is in a Array
* @param array $set the array
* @param var $key the key in the array as in $array[$key]
* @param var $value the value we are looking for
* @return bool wether or not the value is in the array
*/
function dataSetContains($set, $key, $value)
{
for ($i = 0; $i < count($set); $i++) {
if ($set[$i][$key] == $value)
return true;
}
return false;
}
/**
* Strips ' or " from the begin and end of a string (only if they are
* on both sides, e.g. foo' remains foo' but 'bar' becomes bar.
* @param string $string the string we need to strip
* @return string the stripped string
*/
function stripQuotes($string)
{
$temp = trim($string);
if (substr($temp, 0, 1) == "'" && substr($temp, -1) == "'")
return substr($temp, 1, -1);
if (substr($temp, 0, 1) == '"' && substr($temp, -1) == '"')
return substr($temp, 1, -1);
return $string;
}
/**
* Translates a string like id='3' into Array("id"=>3)
* @param string $pair the string which is to be decoded
* @return array the decoded array
*/
function decodeKeyValuePair($pair)
{
$operators = array("==", "!=", "<>", ">=", "<=", "=", "<", ">");
static $s_regex = null;
if ($s_regex === null) {
$s_regex = '/' . implode('|', array_map('preg_quote', $operators)) . '/';
}
list($key, $value) = preg_split($s_regex, $pair);
return array($key => stripQuotes($value));
}
/**
* Translates a string like id='3 AND name='joe'' into Array("id"=>3,"name"=>"joe")
* @todo we should also support <=>, >=, >, <=, <, <>
* @param string $set the string to decode
* @return array the decoded array
*/
function decodeKeyValueSet($set)
{
$result = array();
$items = explode(" AND ", $set);
for ($i = 0; $i < count($items); $i++) {
if (strstr($items[$i], '!=') !== false) {
list($key, $value) = explode("!=", $items[$i]);
$result[trim($key)] = stripQuotes($value);
} elseif (strstr($items[$i], '=') !== false) {
list($key, $value) = explode("=", $items[$i]);
$result[trim($key)] = stripQuotes($value);
} elseif (stristr($items[$i], 'IS NULL') !== false) {
list($key) = preg_split('/IS NULL/i', $items[$i]);
$result[trim($key)] = NULL;
}
}
return $result;
}
/**
* Translates Array("id"=>3,"name"=>"joe") into a string like id='3 AND name='joe''
* @param array $set the array to be encoded
* @return string the encoded string
*/
function encodeKeyValueSet($set)
{
reset($set);
$items = Array();
while (list($key, $value) = each($set)) {
$items[] = $key . "=" . $value;
}
return implode(" AND ", $items);
}
/**
* Same as strip_slashes from php, but if the passed value is an array,
* all elements of the array are stripped. Recursive function.
* @param var &$var the value/array to strip the slashes of
*/
function atk_stripslashes(&$var)
{
if (is_array($var)) {
foreach (array_keys($var) as $key) {
atk_stripslashes($var[$key]);
}
} else {
$var = stripslashes($var);
}
}
/**
* Performs stripslashes on all vars and translates:
* something_AMDAE_other[] into something[][other]
* something_AE_other into something[other]
* (and a_AE_b_AE_c into a[b][c] and so on...
* @param array &$vars the array to be stripped and translated
*/
function atkDataDecode(&$vars)
{
$magicQuotes = get_magic_quotes_gpc();
foreach (array_keys($vars) as $varname) {
$value = &$vars[$varname];
// We must strip all slashes from the input, since php puts slashes
// in front of quotes that are passed by the url. (magic_quotes_gpc)
if ($value !== NULL && $magicQuotes)
atk_stripslashes($value);
AE_decode($vars, $varname);
if (strpos(strtoupper($varname), '_AMDAE_') > 0) { // Now I *know* that strpos could return 0 if _AMDAE_ *is* found
// at the beginning of the string.. but since that's not a valid
// encoded var, we do nothing with it.
// This string is encoded.
list($dimension1, $dimension2) = explode("_AMDAE_", strtoupper($varname));
if (is_array($value)) {
// Multidimensional thing
for ($i = 0; $i < count($value); $i++) {
$vars[strtolower($dimension1)][$i][strtolower($dimension2)] = $value[$i];
}
} else {
$vars[strtolower($dimension1)][strtolower($dimension2)] = $value;
}
}
}
}
/**
* Weird function. $dest is an associative array, that may contain
* stuff like $dest["a_AE_c_AE_b"] = 3.
* Now if you run this function like this:
* AE_decode($dest, "a_AE_c_AE_b");
* then $dest will contain a decoded array:
* echo $dest["a"]["b"]["c"]; <- this will display 3
* @param array &$dest the array to put the decoded var in
* @param string $var the var to decode
*/
function AE_decode(&$dest, $var)
{
$items = explode("_AE_", $var);
if (count($items) <= 1)
return;
$current = &$dest;
foreach ($items as $key) {
$current = &$current[$key];
}
if (is_array($dest[$var])) {
$current = atk_array_merge_recursive((array) $current, $dest[$var]);
} else {
$current = $dest[$var];
}
unset($dest[$var]);
}
/**
* Get the [ ] Fields out of a String
* @deprecated please use the atkStringParser class
*/
function stringfields($string)
{
atkdebug("Warning: deprecated use of stringfields(). Use atkStringParser class instead");
$tmp = "";
$adding = false;
$fields = array();
for ($i = 0; $i < strlen($string); $i++) {
if ($string[$i] == "]") {
$adding = false;
$fields[] = $tmp;
$tmp = "";
} else if ($string[$i] == "[") {
$adding = true;
} else {
if ($adding)
$tmp.=$string[$i];
}
}
return $fields;
}
/**
* Parse strings
* @deprecated please use the atkStringParser class
*/
function stringparse($string, $data, $encode = false)
{
atkdebug("Warning: deprecated use of stringparse(). Use atkStringParser class instead");
$fields = stringfields($string);
for ($i = 0; $i < count($fields); $i++) {
$elements = explode(".", $fields[$i]);
$databin = $data;
for ($j = 0; $j < count($elements); $j++) {
if (array_key_exists($elements[$j], $databin)) {
$value = $databin[$elements[$j]];
$databin = $databin[$elements[$j]];
}
}
if ($encode) {
$string = str_replace("[" . $fields[$i] . "]", rawurlencode($value), $string);
} else {
$string = str_replace("[" . $fields[$i] . "]", $value, $string);
}
}
return $string;
}
/**
* Safe urlencode function. Note, you can reencode already encoded strings, but
* not more than 9 times!
* If you encode a string more than 9 times, you won't be able to decode it
* anymore
*
* An atkurlencoded string is normaly prefixed with '__', so atkurldecode can
* determine whether the string was encoded or not. Sometimes however, if you
* need to reencode part of a string (used in recordlist), you don't want the
* prefix. Pass false as second parameter, and you won't get a prefix. (Note
* that you can't atkurldecode that string anymore, so only use this on
* substrings of already encoded strings)
*
* @todo Fix a problem where a string containing "_9" will be altered after encoding + decoding it.
*
* @param string $string the url to encode
* @param bool $pref wether or not to use a prefix, default true
* @return string the encoded url
*/
function atkurlencode($string, $pref = true)
{
$string = rawurlencode($string);
for ($i = 8; $i >= 1; $i--) {
$string = str_replace("_" . $i, "_" . ($i + 1), $string);
}
return ($pref ? "__" : "") . str_replace("%", "_1", $string);
}
function atkurldecode($string)
{
if (substr($string, 0, 2) != "__")
return $string;
else {
$string = str_replace("_1", "%", substr($string, 2));
for ($i = 1; $i <= 8; $i++) {
$string = str_replace("_" . ($i + 1), "_" . $i, $string);
}
return rawurldecode($string);
}
}
/**
* Wrap lines, add a newline after 100 characters
* @param string $line the line to add new lines in
* @return string the line with newlines
*/
function _wordwrap($line)
{
return wordwrap($line, 100, "\n", 1);
}
/**
* Send a detailed error report to the maintainer.
*
*/
function mailreport()
{
global $g_error_msg, $g_debug_msg;
include_once(atkconfig('atkroot') . 'atk/errors/class.atkerrorhandlerbase.inc');
$errorHandlerObject = atkErrorHandlerBase::get('mail', array('mailto' => atkconfig('mailreport')));
$errorHandlerObject->handle($g_error_msg, $g_debug_msg);
}
/**
* Handle errors that occurred in ATK, available handlers from /atk/errors/ can be added to
* the error_handlers config.
*
*/
function handleError()
{
global $g_error_msg, $g_debug_msg;
include_once(atkconfig('atkroot') . 'atk/errors/class.atkerrorhandlerbase.inc');
$errorHandlers = atkconfig('error_handlers', array('mail' => array('mailto' => atkconfig('mailreport'))));
foreach ($errorHandlers as $key => $value) {
if (is_numeric($key))
$key = $value;
$errorHandlerObject = atkErrorHandlerBase::get($key, $value);
$errorHandlerObject->handle($g_error_msg, $g_debug_msg);
}
}
/**
* Wrapper for escapeSQL function
* @param String $string The string to escape.
* @param boolean $wildcard Set to true to convert wildcard chars ('%').
* False (default) will leave them unescaped.
* @return String A SQL compatible version of the input string.
*/
function escapeSQL($string, $wildcard = false)
{
$db = &atkGetDb();
return $db->escapeSQL($string, $wildcard);
}
/**
* Return the atk version number.
* @return string the version number of ATK
*/
function atkversion()
{
include(atkconfig("atkroot") . "atk/version.inc");
return $atk_version;
}
/**
* Convenience wrapper for atkDb::getInstance()
* @param String $conn The name of the connection to retrieve
* @return atkDb Database connection instance
*/
function &atkGetDb($conn = 'default', $reset = false, $mode = "r")
{
atkimport("atk.db.atkdb");
$db = &atkDb::getInstance($conn, $reset, $mode);
return $db;
}
/**
* Returns a url to open a popup window
* @param string $target the target of the popup
* @param string $params extra params to pass along
* @param string $winName the name of the window
* @param int $width the width of the popup
* @param int $height the height of the popup
* @param string $scroll allow scrolling? (no (default)|yes)
* @param string $resize allow resizing? (no (default)|yes)
* return string the url for the popup window
*/
function atkPopup($target, $params, $winName, $width, $height, $scroll = 'no', $resize = 'no')
{
$url = session_url("include.php?file=" . $target . "&" . $params, SESSION_NESTED);
$popupurl = "javascript:NewWindow('" . $url . "','" . $winName . "'," . $height . "," . $width . ",'" . $scroll . "','" . $resize . "')";
return $popupurl;
}
/**
* Adds new element to error array en $record. When
* $msg is empty the multilange error string is used.
* @param array &$rec var in which to add element to error array
* @param var$attrib attributename or an array with attribute names
* @param string $err multilanguage error string
* @param string $msg optinal error string
*/