/
common.php
1523 lines (1293 loc) · 39 KB
/
common.php
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
/**
* TestLink Open Source Project - http://testlink.sourceforge.net/
* This script is distributed under the GNU General Public License 2 or later.
*
* Load core functions for TestLink GUI
* Common functions: database connection, session and data initialization,
* maintain $_SESSION data, redirect page, log, etc.
*
* Note: this file must uses only globally used functionality and cannot include
* a feature specific code because of performance and readability reasons
*
* @filesource common.php
* @package TestLink
* @author TestLink community
* @Copyright 2005,2018 TestLink community
* @link http://www.testlink.org
*
*/
/** core and parenthal classes */
require_once('object.class.php');
require_once('metastring.class.php');
/** Testlink Plugin API helper methods, must be included before lang_api.php */
require_once('plugin_api.php');
/** library for localization */
require_once('lang_api.php');
/** logging functions */
require_once('logging.inc.php');
require_once('logger.class.php');
require_once('pagestatistics.class.php');
/** library of database wrapper */
require_once('database.class.php');
/** user right checking */
require_once('roles.inc.php');
/** Testlink Smarty class wrapper sets up the default smarty settings for testlink */
require_once('tlsmarty.inc.php');
/** Initialize the Event System */
require_once('event_api.php' );
// Needed to avoid problems with Smarty 3
spl_autoload_register('tlAutoload');
/** CSRF security functions. */
/** TL_APICALL => TICKET 0007190 */
if( !defined('TL_APICALL') )
{
require_once("csrf.php");
}
/** Input data validation */
require_once("inputparameter.inc.php");
/** @TODO use the next include only if it is used -> must be removed */
// require_once("testproject.class.php");
require_once("treeMenu.inc.php");
// 20130526 checks need to be done in order to understand if this class is really needed
require_once("exec_cfield_mgr.class.php");
/**
* Automatic loader for PHP classes
* See PHP Manual for details
*/
function tlAutoload($class_name) {
// exceptions
// 1. remove prefix and convert lower case
$tlClasses = null;
$tlClassPrefixLen = 2;
$classFileName = $class_name;
// 2. add a lower case directory
$addDirToInclude = array('Kint' => true);
// this way Zend_Loader_Autoloader will take care of these classes.
// Needed in order to make work bugzillaxmlrpc interface
if( strstr($class_name,'Zend_') !== FALSE ) {
return false;
}
// Workaround
// https://github.com/smarty-php/smarty/issues/344
// https://github.com/smarty-php/smarty/pull/345
if( strpos($class_name,'Smarty_Internal_Compile_') !== FALSE ) {
return false;
}
if (isset($tlClasses[$classFileName])) {
$len = tlStringLen($classFileName) - $tlClassPrefixLen;
$classFileName = strtolower(tlSubstr($classFileName,$tlClassPrefixLen,$len));
}
if (isset($addDirToInclude[$class_name])) {
$classFileName = strtolower($class_name) . "/" . $class_name;
}
// Plugin special processing, class name ends with Plugin (see plugin_register())
// Does not use autoload
if( preg_match('/Plugin$/', $class_name) == 1 ) {
return;
}
// fix provided by BitNami for:
// Reason: We had a problem integrating TestLink with other apps.
// You can reproduce it installing ThinkUp and TestLink applications in the same stack.
try {
include_once $classFileName . '.class.php';
}
catch (Exception $e) {
}
}
// ----- End of loading and begin functions ---------------------------------------------
/** @var integer global main DB connection identifier */
$db = 0;
/**
* TestLink connects to the database
*
* @param &$db reference to resource, here resource pointer will be returned.
* @param $onErrorExit default false, true standard page will be displayed
*
* @return array
* aa['status'] = 1 -> OK , 0 -> KO
* aa['dbms_msg''] = 'ok', or $db->error_msg().
*/
function doDBConnect(&$db,$onErrorExit=false) {
global $g_tlLogger;
$charSet = config_get('charset');
$result = array('status' => 1, 'dbms_msg' => 'ok');
switch(DB_TYPE) {
case 'mssql':
$dbDriverName = 'mssqlnative';
break;
default:
$dbDriverName = DB_TYPE;
break;
}
$db = new database($dbDriverName);
$result = $db->connect(DSN, DB_HOST, DB_USER, DB_PASS, DB_NAME);
if (!$result['status']) {
echo $result['dbms_msg'];
$result['status'] = 0;
$search = array('<b>','</b>','<br>');
$replace = array('',''," :: ");
$logtext = ' Connect to database <b>' . DB_NAME . '</b> on Host <b>' . DB_HOST . '</b> fails <br>';
$logtext .= 'DBMS Error Message: ' . $result['dbms_msg'];
$logmsg = $logtext . ($onErrorExit ? '<br>Redirection to connection fail screen.' : '');
tLog(str_replace($search,$replace,$logmsg), 'ERROR');
if( $onErrorExit ) {
$smarty = new TLSmarty();
$smarty->assign('title', lang_get('fatal_page_title'));
$smarty->assign('content', $logtext);
$smarty->assign('link_to_op', null);
$smarty->display('workAreaSimple.tpl');
exit();
}
}
else {
if((DB_TYPE == 'mysql') && ($charSet == 'UTF-8')) {
$db->exec_query("SET CHARACTER SET utf8");
$db->exec_query("SET collation_connection = 'utf8_general_ci'");
}
}
// if we establish a DB connection, we reopen the session,
// to attach the db connection
$g_tlLogger->endTransaction();
$g_tlLogger->startTransaction();
return $result;
}
/**
* Set session data related to the current test plan
* and saves a cookie with current testplan id
*
* @param array $tplan_info result of DB query
*/
function setSessionTestPlan($tplan_info) {
if ($tplan_info) {
$_SESSION['testplanID'] = $tplan_info['id'];
$_SESSION['testplanName'] = $tplan_info['name'];
// Save testplan id for next session
$ckObj = new stdClass();
$ckCfg = config_get('cookie');
$ckObj->name = $ckCfg->prefix . 'TL_lastTestPlanForUserID_' . $_SESSION['userID'];
$ckObj->value = $tplan_info['id'];
tlSetCookie($ckObj);
tLog("Test Plan was adjusted to '" . $tplan_info['name'] . "' ID(" . $tplan_info['id'] . ')', 'INFO');
}
else {
unset($_SESSION['testplanID']);
unset($_SESSION['testplanName']);
}
}
/**
* Set home URL path
* @internal revisions
*/
function setPaths()
{
if (!isset($_SESSION['basehref']))
{
$_SESSION['basehref'] = get_home_url(array('force_https' => config_get('force_https')));
}
}
/**
* Verify if user is log in. Redirect to login page if not.
*
* @param integer $db DB identifier
* @param boolean $redirect if true (default) redirects user to login page, otherwise returns true/false as login status
**/
function checkSessionValid(&$db, $redirect=true)
{
$isValidSession = false;
if (isset($_SESSION['userID']) && $_SESSION['userID'] > 0)
{
$now = time();
if (($now - $_SESSION['lastActivity']) <= (config_get("sessionInactivityTimeout") * 60))
{
$_SESSION['lastActivity'] = $now;
$user = new tlUser($_SESSION['userID']);
$user->readFromDB($db);
$_SESSION['currentUser'] = $user;
$isValidSession = true;
}
}
if (!$isValidSession && $redirect)
{
tLog('Invalid session from ' . $_SERVER["REMOTE_ADDR"] . '. Redirected to login page.', 'INFO');
$fName = "login.php";
$baseDir = dirname($_SERVER['SCRIPT_FILENAME']);
while(!file_exists($baseDir . DIRECTORY_SEPARATOR . $fName))
{
$fName = "../" . $fName;
}
$destination = "&destination=" . urlencode($_SERVER['REQUEST_URI']);
redirect($fName . "?note=expired" . $destination,"top.location");
exit();
}
return $isValidSession;
}
/**
* Start session
*/
function doSessionStart($setPaths=false) {
if( PHP_SESSION_NONE == session_status() ) {
session_set_cookie_params(99999);
}
if(!isset($_SESSION)) {
session_start();
if(defined('KINT_ON') && KINT_ON) {
Kint::enabled(true);
} else {
Kint::enabled(false);
}
}
if($setPaths) {
unset($_SESSION['basehref']);
setPaths();
}
}
/**
* Initialize structure of top menu for the user and the project.
*
* @param integer $db DB connection identifier
* @uses $_SESSION Requires initialized project, test plan and user data.
* @since 1.9
*
* @internal revisions
*/
function initTopMenu(&$db)
{
$_SESSION['testprojectTopMenu'] = '';
$guiTopMenu = config_get('guiTopMenu');
$imageSet = TLSmarty::getImageSet();
// check if Project is available
if (isset($_SESSION['testprojectID']) && $_SESSION['testprojectID'] > 0)
{
$idx = 1;
foreach ($guiTopMenu as $element)
{
// check if Test Plan is available
if ((!isset($element['condition'])) || ($element['condition'] == '') ||
(($element['condition'] == 'TestPlanAvailable') &&
isset($_SESSION['testplanID']) && $_SESSION['testplanID'] > 0) ||
(($element['condition'] == 'ReqMgmtEnabled') &&
isset($_SESSION['testprojectOptions']->requirementsEnabled) &&
$_SESSION['testprojectOptions']->requirementsEnabled))
{
// (is_null($element['right']) => no right needed => display always
$addItem = is_null($element['right']);
if(!$addItem)
{
if( is_array($element['right']))
{
foreach($element['right'] as $rg)
{
if( $addItem = (has_rights($db,$rg) == "yes") )
{
break;
}
}
}
else
{
$addItem = (has_rights($db,$element['right']) == "yes");
}
}
if( $addItem )
{
$_SESSION['testprojectTopMenu'] .= "<a href='{$element['url']}' " .
"target='{$element['target']}' accesskey='{$element['shortcut']}'" .
"tabindex=''" . $idx++ . "''>";
if( isset($element['imgKey']) )
{
$_SESSION['testprojectTopMenu'] .= '<img src="' . $imageSet[$element['imgKey']] . '"' .
' title="' . lang_get($element['label']) . '">';
}
else
{
$_SESSION['testprojectTopMenu'] .= lang_get($element['label']);
}
$_SESSION['testprojectTopMenu'] .= "</a> ";
}
}
}
$_SESSION['testprojectTopMenu'] .= " ";
}
}
/**
* Update Project and Test Plan data on Project change or startup
* Data are stored in $_SESSION array
*
* If we receive TestPlan ID in the _SESSION then do some checks and if everything OK
* Update this value at Session Level, to set it available in other pieces of the application
*
* @param integer $db DB connection identifier
* @param array $hash_user_sel input data for the page ($_REQUEST)
*
* @uses initMenu()
* @internal revisions
**/
function initProject(&$db,$hash_user_sel) {
$ckObj = new stdClass();
$ckCfg = config_get('cookie');
$tproject = new testproject($db);
$user_sel = array("tplan_id" => 0, "tproject_id" => 0 );
$user_sel["tproject_id"] = isset($hash_user_sel['testproject']) ? intval($hash_user_sel['testproject']) : 0;
$user_sel["tplan_id"] = isset($hash_user_sel['testplan']) ? intval($hash_user_sel['testplan']) : 0;
$tproject_id = isset($_SESSION['testprojectID']) ? $_SESSION['testprojectID'] : 0;
// test project is Test Plan container, then we start checking the container
if( $user_sel["tproject_id"] != 0 ) {
$tproject_id = $user_sel["tproject_id"];
}
// We need to do checks before updating the SESSION to cover the case that not defined but exists
if (!$tproject_id) {
$all_tprojects = $tproject->get_all();
if ($all_tprojects) {
$tproject_data = $all_tprojects[0];
$tproject_id = $tproject_data['id'];
}
}
$tproject->setSessionProject($tproject_id);
// set a Test Plan
// Refresh test project id after call to setSessionProject
$tproject_id = isset($_SESSION['testprojectID']) ? $_SESSION['testprojectID'] : 0;
$tplan_id = isset($_SESSION['testplanID']) ? $_SESSION['testplanID'] : null;
// Now we need to validate the TestPlan
$ckObj->name = $ckCfg->prefix . "TL_user${_SESSION['userID']}_proj${tproject_id}_testPlanId";
if($user_sel["tplan_id"] != 0)
{
$ckObj->value = $user_sel["tplan_id"];
$ckObj->expire = time()+60*60*24*90;
tlSetCookie($ckObj);
}
elseif (isset($_COOKIE[$ckObj->name]))
{
$tplan_id = intval($_COOKIE[$ckObj->name]);
}
// check if the specific combination of testprojectid and testplanid is valid
$tplan_data = $_SESSION['currentUser']->getAccessibleTestPlans($db,$tproject_id,$tplan_id);
if(is_null($tplan_data))
{
// Need to get first accessible test plan for user, if any exists.
$tplan_data = $_SESSION['currentUser']->getAccessibleTestPlans($db,$tproject_id);
}
if(!is_null($tplan_data) && is_array($tplan_data))
{
$tplan_data = $tplan_data[0];
setSessionTestPlan($tplan_data);
}
// initialize structure of top menu for the user and the project
initTopMenu($db);
}
/**
* General GUI page initialization procedure
* - init session
* - init database
* - check rights
* - initialize project data (if requested)
*
* @param integer $db DB connection identifier
* @param boolean $initProject (optional) Set true if adjustment of Test Project or
* Test Plan is required; default is FALSE
* @param boolean $dontCheckSession (optional) Set to true if no session should be started
* @param string $userRightsCheckFunction (optional) name of function used to check user right needed
* to execute the page
*/
function testlinkInitPage(&$db, $initProject = FALSE, $dontCheckSession = false,
$userRightsCheckFunction = null, $onFailureGoToLogin = false)
{
static $pageStatistics = null;
doSessionStart();
setPaths();
if( isset($_SESSION['locale']) && !is_null($_SESSION['locale']) ) {
setDateTimeFormats($_SESSION['locale']);
}
doDBConnect($db);
if (!$pageStatistics && (config_get('log_level') == 'EXTENDED')) {
$pageStatistics = new tlPageStatistics($db);
}
if (!$dontCheckSession) {
checkSessionValid($db);
}
if ($userRightsCheckFunction) {
checkUserRightsFor($db,$userRightsCheckFunction,$onFailureGoToLogin);
}
// Init plugins
plugin_init_installed();
// adjust Product and Test Plan to $_SESSION
if ($initProject) {
initProject($db,$_REQUEST);
}
// used to disable the attachment feature if there are problems with repository path
/** @TODO this check should not be done anytime but on login and using */
global $g_repositoryPath;
global $g_repositoryType;
global $tlCfg;
$tlCfg->attachments->disabled_msg = "";
if($g_repositoryType == TL_REPOSITORY_TYPE_FS) {
$ret = checkForRepositoryDir($g_repositoryPath);
if(!$ret['status_ok']) {
$tlCfg->attachments->enabled = FALSE;
$tlCfg->attachments->disabled_msg = $ret['msg'];
}
}
}
/**
* Redirect page to another one
*
* @param string URL of required page
* @param string Browser location - use for redirection or refresh of another frame
* Default: 'location'
*/
function redirect($url, $level = 'location')
{
// XSS Attack - 06486: Cross-Site Scripting on login page
$safeUrl = addslashes($url);
echo "<html><head></head><body>";
echo "<script type='text/javascript'>";
echo "$level.href='$safeUrl';";
echo "</script></body></html>";
exit;
}
/**
* Security parser for input strings
*
* @param string $parameter
* @return string cleaned parameter
*/
function strings_stripSlashes($parameter,$bGPC = true)
{
if ($bGPC && !ini_get('magic_quotes_gpc'))
{
return $parameter;
}
if (is_array($parameter))
{
$retParameter = null;
if (sizeof($parameter))
{
foreach($parameter as $key=>$value)
{
if (is_array($value))
{
$retParameter[$key] = strings_stripSlashes($value,$bGPC);
}
else
{
$retParameter[$key] = stripslashes($value);
}
}
}
return $retParameter;
}
else
{
return stripslashes($parameter);
}
}
function to_boolean($alt_boolean)
{
$the_val = 1;
if (is_numeric($alt_boolean) && !intval($alt_boolean))
{
$the_val = 0;
}
else
{
$a_bool = array ("on" => 1, "y" => 1, "off" => 0, "n" => 0);
$alt_boolean = strtolower($alt_boolean);
if(isset($a_bool[$alt_boolean]))
{
$the_val = $a_bool[$alt_boolean];
}
}
return $the_val;
}
/**
* Validate string by relular expression
*
* @param string $str2check
* @param string $regexp_forbidden_chars Regular expression (perl format)
*
* @return boolean 1: check ok, 0:check KO
*
* @todo havlatm: remove as obsolete or move to inputparam.inc.php
*/
function check_string($str2check, $regexp_forbidden_chars)
{
$status_ok = 1;
if( $regexp_forbidden_chars != '' && !is_null($regexp_forbidden_chars))
{
if (preg_match($regexp_forbidden_chars, $str2check))
{
$status_ok=0;
}
}
return $status_ok;
}
/**
* Load global configuration to function
*
* @param string $config_id key for identification of configuration parameter
* @return mixed the configuration parameter(s)
*
* @internal Revisions
*/
function config_get($config_id, $default=null) {
$t_value = (null == $default) ? '' : $default;
$t_found = false;
$logInfo = array('msg' => "config option not available: {$config_id}", 'level' => 'WARNING');
if(!$t_found) {
$my = "g_" . $config_id;
if( ($t_found = isset($GLOBALS[$my])) )
{
$t_value = $GLOBALS[$my];
}
else
{
$cfg = $GLOBALS['tlCfg'];
if( ($t_found = property_exists($cfg,$config_id)) )
{
$t_value = $cfg->$config_id;
}
}
if( $t_found )
{
$logInfo['msg'] = "config option: {$config_id} is " .
((is_object($t_value) || is_array($t_value)) ? serialize($t_value) : $t_value);
$logInfo['level'] = 'INFO';
}
}
tLog($logInfo['msg'],$logInfo['level']);
return $t_value;
}
/**
* @return boolean Return true if the parameter is an empty string or a string
* containing only whitespace, false otherwise
* @author Copyright (C) 2000 - 2004 Mantis Team, Kenzaburo Ito
*/
function is_blank( $p_var )
{
$p_var = trim( $p_var );
$str_len = strlen( $p_var );
if ( 0 == $str_len ) {
return true;
}
return false;
}
/**
* Builds the header needed to make the content available for downloading
*
* @param string $content the content which should be downloaded
* @param string $fileName the filename
**/
function downloadContentsToFile($content,$fileName,$opt=null)
{
$my = array();
$my['opt'] = array('Content-Type' => 'text/plain');
$my['opt'] = array_merge($my['opt'], (array)$opt);
$charSet = config_get('charset');
ob_get_clean();
header('Pragma: public' );
header('Content-Type: ' . $my['opt']['Content-Type'] . "; charset={$charSet}; name={$fileName}" );
header('Content-Transfer-Encoding: BASE64;' );
header('Content-Disposition: attachment; filename="' . $fileName .'"');
echo $content;
}
/**
* helper function for performance timing
*
* @TODO havlatm: Andreas, move to logger?
* returns: ?
*/
function microtime_float()
{
list($usec, $sec) = explode(" ", microtime());
return ((float)$usec + (float)$sec);
}
/**
* Converts a priority weight (urgency * importance) to HIGH, MEDUIM or LOW
*
* @return integer HIGH, MEDUIM or LOW
*/
function priority_to_level($priority) {
$urgencyImportance = config_get('urgencyImportance');
if ($priority >= $urgencyImportance->threshold['high']) {
return HIGH;
} else if ($priority < $urgencyImportance->threshold['low']) {
return LOW;
} else {
return MEDIUM;
}
}
/**
* Get the named php ini variable but return it as a bool
*
* @author Copyright (C) 2000 - 2004 Mantis Team, Kenzaburo Ito
*/
function ini_get_bool( $p_name ) {
$result = ini_get( $p_name );
if ( is_string( $result ) ) {
switch ( $result ) {
case 'off':
case 'false':
case 'no':
case 'none':
case '':
case '0':
return false;
break;
case 'on':
case 'true':
case 'yes':
case '1':
return true;
break;
}
} else {
return (bool)$result;
}
}
/**
* Trim string and limit to N chars
*
* @param string
* @param int [len]: how many chars return
*
* @return string trimmed string
*
* @author Francisco Mancardi - 20050905 - refactoring
*/
function trim_and_limit($s, $len = 100)
{
$s = trim($s);
if (tlStringLen($s) > $len) {
$s = tlSubStr($s, 0, $len);
}
return $s;
}
/** @todo havlatm - 20100207 - what's that? and why here. Remove' */
// nodes_order format: NODE_ID-?,NODE_ID-?
// 2-0,10-0,3-0
function transform_nodes_order($nodes_order,$node_to_exclude=null)
{
$fa = explode(',',$nodes_order);
foreach($fa as $key => $value)
{
// $value= X-Y
$fb = explode('-',$value);
if( is_null($node_to_exclude) || $fb[0] != $node_to_exclude)
{
$nodes_id[]=$fb[0];
}
}
return $nodes_id;
}
/**
* Checks $_FILES for errors while uploading
*
* @param array $fInfo an array used by uploading files ($_FILES)
* @return string containing an error message (if any)
*/
function getFileUploadErrorMessage($fInfo)
{
$msg = null;
if (isset($fInfo['error']))
{
switch($fInfo['error'])
{
case UPLOAD_ERR_INI_SIZE:
$msg = lang_get('error_file_size_larger_than_maximum_size_check_php_ini');
break;
case UPLOAD_ERR_FORM_SIZE:
$msg = lang_get('error_file_size_larger_than_maximum_size');
break;
case UPLOAD_ERR_PARTIAL:
case UPLOAD_ERR_NO_FILE:
$msg = lang_get('error_file_upload');
break;
}
}
return $msg;
}
/**
* Redirect to a page with static html defined in locale/en_GB/texts.php
*
* @param string $key keyword for finding exact html text in definition array
*/
function show_instructions($key, $refreshTree=0)
{
$myURL = $_SESSION['basehref'] . "lib/general/staticPage.php?key={$key}";
if( $refreshTree )
{
$myURL .= "&refreshTree=1";
}
redirect($myURL);
}
/**
* @TODO: franciscom - 20091003 - document return value
*/
function templateConfiguration($template2get=null)
{
$custom_templates = config_get('tpl');
$access_key = $template2get;
if( is_null($access_key) )
{
$access_key = str_replace('.php','',basename($_SERVER['SCRIPT_NAME']));
}
$path_parts=explode("/",dirname($_SERVER['SCRIPT_NAME']));
$last_part=array_pop($path_parts);
$tcfg = new stdClass();
$tcfg->template_dir = "{$last_part}/";
$tcfg->default_template = isset($custom_templates[$access_key]) ? $custom_templates[$access_key] : ($access_key . '.tpl');
$tcfg->template = null;
$tcfg->tpl = $tcfg->template_dir . $tcfg->default_template;
return $tcfg;
}
/**
* Check if an string is a valid ISO date/time
* accepted format: YYYY-MM-DD HH:MM:SS
*
* @param string $ISODateTime datetime to check
* @return boolean True if string has correct format
*
* @internal
* rev: 20080907 - franciscom - Code taked form PHP manual
*/
function isValidISODateTime($ISODateTime)
{
$dateParts=array('YEAR' => 1, 'MONTH' => 2 , 'DAY' => 3);
$matches=null;
$status_ok=false;
if (preg_match("/^(\d{4})-(\d{2})-(\d{2}) ([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/", $ISODateTime, $matches))
{
$status_ok=checkdate($matches[$dateParts['MONTH']],$matches[$dateParts['DAY']],$matches[$dateParts['YEAR']]);
}
return $status_ok;
}
/**
* Check if a localized timestamp is valid
* uses split_localized_date()
*
*/
function is_valid_date($timestamp, $dateFormat) {
$date_array = split_localized_date($timestamp,$dateFormat);
$status_ok = false;
if ($date_array != null) {
$status_ok = checkdate($date_array['month'],$date_array['day'],$date_array['year']);
}
return $status_ok;
}
/**
* Returns array containing date pieces for a given timestamp according to dateFormat
*/
function split_localized_date($timestamp,$dateFormat)
{
if(strlen(trim($timestamp)) == 0)
{
return null;
}
$splitChar = null;
$needle = array(".","-","/","%");
foreach($needle as $target)
{
if (strpos($timestamp,$target) !== false)
{
$splitChar = $target;
break;
}
}
// put each char of strippedDateFormat into an Array Element
$strippedDateFormat = str_replace($needle,"",$dateFormat);
$format = preg_split('//', $strippedDateFormat, -1, PREG_SPLIT_NO_EMPTY);
$pieces = explode($splitChar,$timestamp);
$result = array();
if( count($pieces) == 3 ) // MAGIC ALLOWED
{
$k2t = array('Y' => 'year', 'm' => 'month', 'd' => 'day');
foreach ($format as $idx => $access)
{
$result[$k2t[$access]] = $pieces[$idx];
}
}
return $result;
}
/**
*
*
*/
function checkUserRightsFor(&$db,$pfn,$onFailureGoToLogin=false)
{
$script = basename($_SERVER['PHP_SELF']);
$currentUser = $_SESSION['currentUser'];
$doExit = false;
$action = null;
$m2call = $pfn;
$arguments = null;
if( is_object($pfn) )
{
$m2call = $pfn->method;
$arguments = $pfn->args;
}
if (!$m2call($db,$currentUser,$arguments,$action))
{
if (!$action)
{
$action = "any";
}
logAuditEvent(TLS("audit_security_user_right_missing",$currentUser->login,$script,$action),
$action,$currentUser->dbID,"users");
$doExit = true;
}
if($doExit)
{
$myURL = $_SESSION['basehref'];
if($onFailureGoToLogin)
{
unset($_SESSION['currentUser']);
redirect($myURL ."login.php");
}
else
{
redirect($myURL,"top.location");
}
exit();