/
testproject.class.php
4103 lines (3435 loc) · 118 KB
/
testproject.class.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.
*
* @filesource testproject.class.php
* @package TestLink
* @copyright 2005-2018, TestLink community
* @link http://testlink.sourceforge.net/
*
**/
/** related functions */
require_once('attachments.inc.php');
require_once('event_api.php');
/**
* class is responsible to get project related data and CRUD test project
* @package TestLink
*/
class testproject extends tlObjectWithAttachments {
const RECURSIVE_MODE = true;
const EXCLUDE_TESTCASES = true;
const INCLUDE_TESTCASES = false;
const TESTCASE_PREFIX_MAXLEN = 16; // must be changed if field dimension changes
const GET_NOT_EMPTY_REQSPEC = 1;
const GET_EMPTY_REQSPEC = 0;
/** @var database handler */
var $db;
var $tree_manager;
var $cfield_mgr;
// Node Types (NT)
var $nt2exclude=array('testplan' => 'exclude_me','requirement_spec'=> 'exclude_me','requirement'=> 'exclude_me');
var $nt2exclude_children=array('testcase' => 'exclude_my_children','requirement_spec'=> 'exclude_my_children');
var $debugMsg;
var $tmp_dir;
var $node_types_descr_id;
var $my_node_type;
var $cfg;
/**
* Class constructor
*
* @param resource &$db reference to database handler
*/
function __construct(&$db) {
$this->tmp_dir = config_get('temp_dir');
$this->db = &$db;
$this->tree_manager = new tree($this->db);
$this->cfield_mgr=new cfield_mgr($this->db);
$this->debugMsg = 'Class:' . __CLASS__ . ' - Method: ';
tlObjectWithAttachments::__construct($this->db,'nodes_hierarchy');
$this->object_table = $this->tables['testprojects'];
$this->node_types_descr_id = &$this->tree_manager->node_descr_id;
$this->my_node_type = $this->tree_manager->node_descr_id['testproject'];
$this->cfg = new stdClass();
$this->cfg->keywords = config_get('keywords');
}
/**
* Create a new Test project
*
* @param string $name Name of project
* @param string $color value according to CSS color definition
* @param string $notes project description (HTML text)
* @param array $options project features/options
* bolean keys: inventoryEnabled, automationEnabled,
* testPriorityEnabled, requirementsEnabled
* @param boolean $active [1,0] optional
* @param string $tcasePrefix ['']
* @param boolean $is_public [1,0] optional
*
* @return integer test project id or 0 (if fails)
*
* @internal revisions
*
*/
function create($item,$opt=null) {
$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;
$my['opt'] = array('doChecks' => false, 'setSessionProject' => true);
$my['opt'] = array_merge($my['opt'],(array)$opt);
$serOptions = serialize($item->options);
try {
$tcPrefix = $this->formatTcPrefix($item->prefix); // will truncate prefix is len() > limit
// mandatory checks
if(strlen($item->name)==0) {
throw new Exception('Empty name is not allowed');
}
if($my['opt']['doChecks']) {
$check = $this->checkNameSintax($item->name);
if($check['status_ok']) {
$check = $this->checkNameExistence($item->name);
}
if($check['status_ok']) {
$check = $this->checkTestCasePrefixExistence($tcPrefix);
}
if(!$check['status_ok']) {
throw new Exception($check['msg']);
}
}
}
catch (Exception $e) {
throw $e; // rethrow
}
// Create API KEY 64 bit long
$api_key = md5(rand()) . md5(rand());
// Create Node and get the id
$id = $this->tree_manager->new_root_node($item->name);
$sql = " INSERT INTO {$this->object_table} (id,color," .
" options,notes,active,is_public,prefix,api_key) " .
" VALUES (" . $id . ", '" .
$this->db->prepare_string($item->color) . "','" .
$serOptions . "','" .
$this->db->prepare_string($item->notes) . "'," .
$item->active . "," . $item->is_public . ",'" .
$this->db->prepare_string($tcPrefix) . "','" .
$this->db->prepare_string($api_key) . "')";
$result = $this->db->exec_query($sql);
$evt = new stdClass();
$evt->message = TLS("audit_testproject_created", $item->name);
$evt->code = "CREATE";
$evt->source = $this->auditCfg->eventSource;
$evt->objectType = 'testprojects';
if ($result) {
// set project to session if not defined (the first project) or update the current
if (!isset($_SESSION['testprojectID']) && $my['opt']['setSessionProject']) {
$this->setSessionProject($id);
}
$evt->logLevel = 'AUDIT';
// Send Event
$ctx = array('id' => $id, 'name' => $item->name, 'prefix' => $tcPrefix);
event_signal('EVENT_TEST_PROJECT_CREATE', $ctx);
}
else {
$id = 0;
$evt->logLevel = 'ERROR';
}
$evt->objectID = $id;
logEvent($evt);
return $id;
}
/**
* Update Test project data in DB and (if applicable) current session data
*
* @param integer $id project Identifier
* @param string $name Name of project
* @param string $color value according to CSS color definition
* @param string $notes project description (HTML text)
* @param array $options project features/options
* bolean keys: inventoryEnabled, automationEnabled,
* testPriorityEnabled, requirementsEnabled
*
* @return boolean result of DB update
*
* @internal
*
**/
function update($id, $name, $color, $notes,$options,$active=null,
$tcasePrefix=null,$is_public=null)
{
$status_ok=1;
$status_msg = 'ok';
$log_msg = 'Test project ' . $name . ' update: Ok.';
$log_level = 'INFO';
$safeID = intval($id);
$add_upd='';
if( !is_null($active) )
{
$add_upd .=',active=' . (intval($active) > 0 ? 1:0);
}
if( !is_null($is_public) )
{
$add_upd .=',is_public=' . (intval($is_public) > 0 ? 1:0);
}
if( !is_null($tcasePrefix) )
{
$tcprefix=$this->formatTcPrefix($tcasePrefix);
$add_upd .=",prefix='" . $this->db->prepare_string($tcprefix) . "'" ;
}
$serOptions = serialize($options);
$sql = " UPDATE {$this->object_table} SET color='" . $this->db->prepare_string($color) . "', ".
" options='" . $serOptions . "', " .
" notes='" . $this->db->prepare_string($notes) . "' {$add_upd} " .
" WHERE id=" . $safeID;
$result = $this->db->exec_query($sql);
if ($result)
{
// update related node
$sql = "UPDATE {$this->tables['nodes_hierarchy']} SET name='" .
$this->db->prepare_string($name) . "' WHERE id= {$safeID}";
$result = $this->db->exec_query($sql);
}
if ($result)
{
// update session data
$this->setSessionProject($safeID);
// Send Event
$ctx = array('id' => $id, 'name' => $name, 'prefix' => $tcprefix);
event_signal('EVENT_TEST_PROJECT_UPDATE', $ctx);
}
else
{
$status_msg = 'Update FAILED!';
$status_ok = 0;
$log_level ='ERROR';
$log_msg = $status_msg;
}
tLog($log_msg,$log_level);
return ($status_ok);
}
/**
* Set session data related to a Test project
*
* @param integer $projectId Project ID; zero causes unset data
*/
public function setSessionProject($projectId)
{
$tproject_info = null;
if ($projectId)
{
$tproject_info = $this->get_by_id($projectId);
}
if ($tproject_info)
{
$_SESSION['testprojectID'] = $tproject_info['id'];
$_SESSION['testprojectName'] = $tproject_info['name'];
$_SESSION['testprojectColor'] = $tproject_info['color'];
$_SESSION['testprojectPrefix'] = $tproject_info['prefix'];
if(!isset($_SESSION['testprojectOptions']) )
{
$_SESSION['testprojectOptions'] = new stdClass();
}
$_SESSION['testprojectOptions']->requirementsEnabled =
isset($tproject_info['opt']->requirementsEnabled)
? $tproject_info['opt']->requirementsEnabled : 0;
$_SESSION['testprojectOptions']->testPriorityEnabled =
isset($tproject_info['opt']->testPriorityEnabled)
? $tproject_info['opt']->testPriorityEnabled : 0;
$_SESSION['testprojectOptions']->automationEnabled =
isset($tproject_info['opt']->automationEnabled)
? $tproject_info['opt']->automationEnabled : 0;
$_SESSION['testprojectOptions']->inventoryEnabled =
isset($tproject_info['opt']->inventoryEnabled)
? $tproject_info['opt']->inventoryEnabled : 0;
tLog("Test Project was activated: [" . $tproject_info['id'] . "]" .
$tproject_info['name'], 'INFO');
}
else
{
if (isset($_SESSION['testprojectID']))
{
tLog("Test Project deactivated: [" . $_SESSION['testprojectID'] . "] " .
$_SESSION['testprojectName'], 'INFO');
}
unset($_SESSION['testprojectID']);
unset($_SESSION['testprojectName']);
unset($_SESSION['testprojectColor']);
unset($_SESSION['testprojectOptions']);
unset($_SESSION['testprojectPrefix']);
}
}
/**
* Unserialize project options
*
* @param array $recorset produced by getTestProject()
*/
protected function parseTestProjectRecordset(&$recordset) {
if (null != $recordset && count($recordset) > 0) {
foreach ($recordset as $number => $row) {
$recordset[$number]['opt'] = unserialize($row['options']);
}
} else {
$recordset = null;
tLog('parseTestProjectRecordset: No project on query', 'DEBUG');
}
}
/**
* Get Test project data according to parameter with unique value
*
* @param string $condition (optional) additional SQL condition(s)
* @return array map with test project info; null if query fails
*/
protected function getTestProject($condition = null, $opt=null)
{
$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;
$my = array('options' => array('output' => 'full'));
$my['options'] = array_merge($my['options'],(array)$opt);
$doParse = true;
$tprojCols = ' testprojects.* ';
switch($my['options']['output'])
{
case 'existsByID':
$doParse = false;
$sql = "/* debugMsg */ SELECT testprojects.id ".
" FROM {$this->object_table} testprojects " .
" WHERE 1=1 ";
break;
case 'existsByName':
$doParse = false;
$sql = "/* debugMsg */ SELECT testprojects.id ".
" FROM {$this->object_table} testprojects, " .
" {$this->tables['nodes_hierarchy']} nodes_hierarchy".
" WHERE testprojects.id = nodes_hierarchy.id " .
" AND nodes_hierarchy.node_type_id = " .
$this->tree_manager->node_descr_id['testproject'];
break;
case 'name':
$doParse = false;
$tprojCols = 'testprojects.id';
case 'full':
default:
$sql = "/* debugMsg */ SELECT {$tprojCols}, nodes_hierarchy.name ".
" FROM {$this->object_table} testprojects, " .
" {$this->tables['nodes_hierarchy']} nodes_hierarchy".
" WHERE testprojects.id = nodes_hierarchy.id ";
" AND nodes_hierarchy.node_type_id = " .
$this->tree_manager->node_descr_id['testproject'];
break;
}
if (!is_null($condition) )
{
$sql .= " AND " . $condition;
}
$rs = $this->db->get_recordset($sql);
if($doParse)
{
$this->parseTestProjectRecordset($rs);
}
return $rs;
}
/**
* Get Test project data according to name
*
* @param string $name
* @param string $addClause (optional) additional SQL condition(s)
*
* @return array map with test project info; null if query fails
*/
public function get_by_name($name, $addClause = null, $opt=null)
{
$condition = "nodes_hierarchy.name='" . $this->db->prepare_string($name) . "'";
$condition .= is_null($addClause) ? '' : " AND {$addClause} ";
return $this->getTestProject($condition);
}
/**
* Get Test project data according to ID
*
* @param integer $id test project
* @return array map with test project info; null if query fails
*/
public function get_by_id($id, $opt=null)
{
$condition = "testprojects.id=". intval($id);
$result = $this->getTestProject($condition,$opt);
return $result[0];
}
/**
* Get Test project data according to prefix
*
* @param string $prefix
* @param string $addClause optional additional SQL 'AND filter' clause
*
* @return array map with test project info; null if query fails
*/
public function get_by_prefix($prefix, $addClause = null)
{
$safe_prefix = $this->db->prepare_string($prefix);
$condition = "testprojects.prefix='{$safe_prefix}'";
$condition .= is_null($addClause) ? '' : " AND {$addClause} ";
$result = $this->getTestProject($condition);
return $result[0];
}
/**
* Get Test project data according to APIKEY
*
* @param string 64 chars
* @return array map with test project info; null if query fails
*/
public function getByAPIKey($apiKey, $opt=null)
{
$condition = "testprojects.api_key='{$apiKey}'";
$result = $this->getTestProject($condition,$opt);
return $result[0];
}
/*
function: get_all
get array of info for every test project
without any kind of filter.
Every array element contains an assoc array with test project info
args:[order_by]: default " ORDER BY nodes_hierarchy.name " -> testproject name
*/
function get_all($filters=null,$options=null)
{
$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;
$my = array ('filters' => '', 'options' => '');
$my['filters'] = array('active' => null);
$my['options'] = array('order_by' => " ORDER BY nodes_hierarchy.name ",
'access_key' => null, 'output' => 'std');
$my['filters'] = array_merge($my['filters'], (array)$filters);
$my['options'] = array_merge($my['options'], (array)$options);
if($my['options']['output'] == 'count')
{
$sql = "/* $debugMsg */ SELECT COUNT(testprojects.id) AS qty ".
" FROM {$this->object_table} testprojects";
$rs = $this->db->get_recordset($sql);
return $rs[0]['qty'];
}
//
$sql = "/* $debugMsg */ SELECT testprojects.*, nodes_hierarchy.name ".
" FROM {$this->object_table} testprojects, " .
" {$this->tables['nodes_hierarchy']} nodes_hierarchy ".
" WHERE testprojects.id = nodes_hierarchy.id ";
if (!is_null($my['filters']['active']) )
{
$sql .= " AND active=" . intval($my['filters']['active']) . " ";
}
if( !is_null($my['options']['order_by']) )
{
$sql .= $my['options']['order_by'];
}
if( is_null($my['options']['access_key'])) {
$recordset = $this->db->get_recordset($sql);
$this->parseTestProjectRecordset($recordset);
} else {
$recordset = $this->db->fetchRowsIntoMap($sql,$my['options']['access_key']);
if (null != $recordset && count($recordset) > 0) {
foreach ($recordset as $number => $row) {
$recordset[$number]['opt'] = unserialize($row['options']);
}
}
}
return $recordset;
}
/*
function: get_accessible_for_user
get list of testprojects, considering user roles.
Remember that user has:
1. one default role, assigned when user was created
2. a different role can be assigned for every testproject.
For users roles that has not rigth to modify testprojects
only active testprojects are returned.
args:
user_id
[output_type]: choose the output data structure.
possible values: map, map_of_map
map: key -> test project id
value -> test project name
map_of_map: key -> test project id
value -> array ('name' => test project name,
'active' => active status)
array_of_map: value -> array with all testproject table fields plus name.
default: map
[order_by]: default: ORDER BY name
*/
function get_accessible_for_user($user_id,$opt = null,$filters = null)
{
$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;
$my = array();
$my['opt'] = array('output' => 'map', 'order_by' => ' ORDER BY name ', 'field_set' => 'full',
'format' => 'std', 'add_issuetracker' => false, 'add_codetracker' => false,
'add_reqmgrsystem' => false);
$my['opt'] = array_merge($my['opt'],(array)$opt);
// key = field name
// value = array('op' => Domain ('=','like'), 'value' => the value)
$my['filters'] = array('name' => null, 'id' => null, 'prefix' => null);
$my['filters'] = array_merge($my['filters'],(array)$filters);
$items = array();
$safe_user_id = intval($user_id);
// Get default/global role
$sql = "/* $debugMsg */ SELECT id,role_id FROM {$this->tables['users']} where id=" . $safe_user_id;
$user_info = $this->db->get_recordset($sql);
$globalRoleID = intval($user_info[0]['role_id']);
$itsql = '';
$itf = '';
if($my['opt']['add_issuetracker']) {
$itsql = " LEFT OUTER JOIN {$this->tables['testproject_issuetracker']} AS TIT " .
" ON TIT.testproject_id = TPROJ.id " .
" LEFT OUTER JOIN {$this->tables['issuetrackers']} AS ITMD " .
" ON ITMD.id = TIT.issuetracker_id ";
$itf = ",ITMD.name AS itname,ITMD.type AS ittype";
}
$ctsql = '';
$ctf = '';
if($my['opt']['add_codetracker']) {
$ctsql = " LEFT OUTER JOIN {$this->tables['testproject_codetracker']} AS TCT " .
" ON TCT.testproject_id = TPROJ.id " .
" LEFT OUTER JOIN {$this->tables['codetrackers']} AS CTMD " .
" ON CTMD.id = TCT.codetracker_id ";
$ctf = ",CTMD.name AS ctname,CTMD.type AS cttype";
}
$rmssql = '';
$rmsf = '';
if($my['opt']['add_reqmgrsystem']) {
$rmssql = " LEFT OUTER JOIN {$this->tables['testproject_reqmgrsystem']} AS TRMS " .
" ON TRMS.testproject_id = TPROJ.id " .
" LEFT OUTER JOIN {$this->tables['reqmgrsystems']} AS RMSMD " .
" ON RMSMD.id = TRMS.reqmgrsystem_id ";
$rmsf = ",RMSMD.name AS rmsname,RMSMD.type AS rmstype";
}
switch($my['opt']['field_set']) {
case 'id':
$cols = ' TPROJ.id,NHTPROJ.name ';
$my['opt']['format'] = 'do not parse';
break;
case 'prefix':
$cols = ' TPROJ.id,TPROJ.prefix,TPROJ.active,NHTPROJ.name ';
$my['opt']['format'] = 'do not parse';
break;
case 'full':
default:
$cols = ' TPROJ.*,NHTPROJ.name,COALESCE(UTR.role_id,U.role_id) AS effective_role ';
break;
}
$sql = " /* $debugMsg */ SELECT {$cols} {$itf} {$ctf} {$rmsf} " .
" FROM {$this->tables['nodes_hierarchy']} NHTPROJ " .
" JOIN {$this->object_table} TPROJ ON NHTPROJ.id=TPROJ.id " .
" JOIN {$this->tables['users']} U ON U.id = {$safe_user_id} " .
" LEFT OUTER JOIN {$this->tables['user_testproject_roles']} UTR " .
" ON TPROJ.id = UTR.testproject_id " .
" AND UTR.user_id =" . $safe_user_id . $itsql . $ctsql . $rmssql .
" WHERE 1=1 ";
// Private test project feature
if( $globalRoleID != TL_ROLES_ADMIN ) {
if ($globalRoleID != TL_ROLES_NO_RIGHTS) {
$sql .= " AND ";
$sql_public = " ( TPROJ.is_public = 1 AND (UTR.role_id IS NULL OR UTR.role_id != " . TL_ROLES_NO_RIGHTS. ") )";
$sql_private = " ( TPROJ.is_public = 0 AND UTR.role_id != " . TL_ROLES_NO_RIGHTS. ") ";
$sql .= " ( {$sql_public} OR {$sql_private} ) ";
} else {
// User needs specific role
$sql .= " AND (UTR.role_id IS NOT NULL AND UTR.role_id != ".TL_ROLES_NO_RIGHTS.")";
}
}
$userObj = tlUser::getByID($this->db,$safe_user_id,tlUser::TLOBJ_O_GET_DETAIL_MINIMUM);
if ($userObj->hasRight($this->db,'mgt_modify_product') != 'yes') {
$sql .= " AND TPROJ.active=1 ";
}
unset($userObj);
foreach($my['filters'] as $fname => $fspec) {
if(!is_null($fspec)) {
switch($fname) {
case 'prefix':
$sql .= " AND TPROJ.$fname";
$sm = 'prepare_string';
break;
case 'name':
$sql .= " AND NHTPROJ.$fname";
$sm = 'prepare_string';
break;
case 'id':
$sql .= " AND NHTPROJ.$fname";
$sm = 'prepare_int';
break;
}
$safe = $this->db->$sm($fspec['value']);
switch($fspec['op']) {
case '=':
if($sm == 'prepare_string') {
$sql .= "='" . $safe . "'";
} else {
$sql .= "=" . $safe;
}
break;
case 'like':
$sql .= " LIKE '%" . $safe ."%'";
break;
}
}
}
$sql .= str_replace('nodes_hierarchy','NHTPROJ',$my['opt']['order_by']);
$parseOpt = false;
$do_post_process = 0;
$arrTemp = array();
switch($my['opt']['output']) {
case 'array_of_map':
$items = $this->db->get_recordset($sql); //,null,3,1);
$parseOpt = true;
break;
case 'map_of_map_full':
$items = $this->db->fetchRowsIntoMap($sql,'id');
$parseOpt = true;
break;
case 'map':
$items = $this->db->fetchRowsIntoMap($sql,'id');
break;
case 'map_with_inactive_mark':
default:
$arrTemp = (array)$this->db->fetchRowsIntoMap($sql,'id');
$do_post_process = (count($arrTemp) > 0);
break;
}
if($my['opt']['format'] == 'std' && $parseOpt) {
$this->parseTestProjectRecordset($items);
}
if ($do_post_process) {
switch ($my['opt']['output']) {
case 'map_name_with_inactive_mark':
foreach($arrTemp as $id => $row) {
$noteActive = '';
if (!$row['active']) {
$noteActive = TL_INACTIVE_MARKUP;
}
$items[$id] = $noteActive .
( ($my['opt']['field_set'] =='prefix') ? ($row['prefix'] . ':') : '' ) . $row['name'];
}
break;
case 'map_of_map':
foreach($arrTemp as $id => $row) {
$items[$id] = array('name' => $row['name'],'active' => $row['active']);
}
break;
}
unset($arrTemp);
}
return $items;
}
/*
function: get_subtree
Get subtree that has choosen testproject as root.
Only nodes of type:
testsuite and testcase are explored and retrieved.
args: id: testsuite id
[recursive_mode]: default false
[exclude_testcases]: default: false
[exclude_branches]
[additionalWhereClause]:
returns: map
see tree->get_subtree() for details.
*/
function get_subtree($id,$filters=null,$opt=null)
{
$my = array();
$my['options'] = array('recursive' => false, 'exclude_testcases' => false, 'output' => 'full');
$my['filters'] = array('exclude_node_types' => $this->nt2exclude,
'exclude_children_of' => $this->nt2exclude_children,
'exclude_branches' => null,
'additionalWhereClause' => '');
$my['options'] = array_merge($my['options'],(array)$opt);
$my['filters'] = array_merge($my['filters'],(array)$filters);
if($my['options']['exclude_testcases'])
{
$my['filters']['exclude_node_types']['testcase']='exclude me';
}
$subtree = $this->tree_manager->get_subtree(intval($id),$my['filters'],$my['options']);
return $subtree;
}
/**
* Displays smarty template to show test project info to users.
*
* @param type $smarty [ref] smarty object
* @param type $id test project
* @param type $sqlResult [default = '']
* @param type $action [default = 'update']
* @param type $modded_item_id [default = 0]
*
* @internal revisions
*
**/
function show(&$smarty,$guiObj,$template_dir,$id,$sqlResult='', $action = 'update',$modded_item_id = 0)
{
$gui = $guiObj;
$gui->modify_tc_rights = has_rights($this->db,"mgt_modify_tc");
$gui->mgt_modify_product = has_rights($this->db,"mgt_modify_product");
$gui->sqlResult = '';
$gui->sqlAction = '';
if($sqlResult)
{
$gui->sqlResult = $sqlResult;
}
$p2ow = array('refreshTree' => false, 'user_feedback' => '');
foreach($p2ow as $prop => $value)
{
if( !property_exists($gui,$prop) )
{
$gui->$prop = $value;
}
}
$safeID = intval($id);
$gui->tproject_id = $safeID;
$gui->container_data = $this->get_by_id($safeID);
$gui->moddedItem = $gui->container_data;
$gui->level = 'testproject';
$gui->page_title = lang_get('testproject');
$gui->refreshTree = property_exists($gui,'refreshTree') ? $gui->refreshTree : false;
$gui->attachmentInfos = getAttachmentInfosFrom($this,$safeID);
// attachments management on page
$gui->fileUploadURL = $_SESSION['basehref'] . $this->getFileUploadRelativeURL($safeID);
$gui->delAttachmentURL = $_SESSION['basehref'] . $this->getDeleteAttachmentRelativeURL($safeID);
$gui->import_limit = TL_REPOSITORY_MAXFILESIZE;
$gui->fileUploadMsg = '';
$exclusion = array( 'testcase', 'me', 'testplan' => 'me', 'requirement_spec' => 'me');
$gui->canDoExport = count((array)$this->tree_manager->get_children($safeID,$exclusion)) > 0;
if ($modded_item_id) {
$gui->moddedItem = $this->get_by_id(intval($modded_item_id));
}
$cfg = getWebEditorCfg('testproject');
$gui->testProjectEditorType = $cfg['type'];
$smarty->assign('gui', $gui);
$smarty->display($template_dir . 'containerView.tpl');
}
/**
* Count testcases without considering active/inactive status.
*
* @param integer $id: test project identifier
* @return integer count of test cases presents on test project.
*/
function count_testcases($id)
{
$tcIDs = array();
$this->get_all_testcases_id($id,$tcIDs);
$qty = sizeof($tcIDs);
return $qty;
}
/*
function: gen_combo_test_suites
create array with test suite names
test suites are ordered in parent-child way, means
order on array is creating traversing tree branches, reaching end
of branch, and starting again. (recursive algorithim).
args : $id: test project id
[$exclude_branches]: array with testsuite id to exclude
useful to exclude myself ($id)
[$mode]: dotted -> $level number of dot characters are appended to
the left of test suite name to create an indent effect.
Level indicates on what tree layer testsuite is positioned.
Example:
null
\
id=1 <--- Tree Root = Level 0
|
+ ------+
/ \ \
id=9 id=2 id=8 <----- Level 1
\
id=3 <----- Level 2
\
id=4 <----- Level 3
key: testsuite id (= node id on tree).
value: every array element is an string, containing testsuite name.
Result example:
2 .TS1
3 ..TS2
9 .20071014-16:22:07 TS1
10 ..TS2
array -> key: testsuite id (= node id on tree).
value: every array element is a map with the following keys
'name', 'level'
2 array(name => 'TS1',level => 1)
3 array(name => 'TS2',level => 2)
9 array(name => '20071014-16:22:07 TS1',level =>1)
10 array(name => 'TS2', level => 2)
returns: map , structure depens on $mode argument.
*/
function gen_combo_test_suites($id,$exclude_branches=null,$mode='dotted')
{
$ret = array();
$test_spec = $this->get_subtree($id, array('exclude_branches' => $exclude_branches),
array('recursive' => !self::RECURSIVE_MODE,
'exclude_testcases' => self::EXCLUDE_TESTCASES));
if(count($test_spec))
{
$ret = $this->_createHierarchyMap($test_spec,$mode);
}
return $ret;
}
/**
* Checks a test project name for correctness
*
* @param string $name the name to check
* @return map with keys: status_ok, msg
**/
function checkName($name)
{
$forbidden_pattern = config_get('ereg_forbidden');
$ret['status_ok'] = 1;
$ret['msg'] = 'ok';
if ($name == "")
{
$ret['msg'] = lang_get('info_product_name_empty');
$ret['status_ok'] = 0;
}
if ($ret['status_ok'] && !check_string($name,$forbidden_pattern))
{
$ret['msg'] = lang_get('string_contains_bad_chars');
$ret['status_ok'] = 0;
}
return $ret;
}
/**
* Checks a test project name for sintax correctness
*
* @param string $name the name to check
* @return map with keys: status_ok, msg
**/
function checkNameSintax($name)
{
$forbidden_pattern = config_get('ereg_forbidden');
$ret['status_ok'] = 1;
$ret['msg'] = 'ok';
if ($name == "")
{
$ret['msg'] = lang_get('info_product_name_empty');
$ret['status_ok'] = 0;
}
if ($ret['status_ok'] && !check_string($name,$forbidden_pattern))
{
$ret['msg'] = lang_get('string_contains_bad_chars');
$ret['status_ok'] = 0;
}
return $ret;
}
/**
* Checks is there is another testproject with different id but same name
*
**/
function checkNameExistence($name,$id=0)
{
$check_op['msg'] = '';
$check_op['status_ok'] = 1;
if($this->get_by_name($name,"testprojects.id <> {$id}") )
{
$check_op['msg'] = sprintf(lang_get('error_product_name_duplicate'),$name);
$check_op['status_ok'] = 0;
}
return $check_op;
}
/**
* Checks is there is another testproject with different id but same prefix
*
**/
function checkTestCasePrefixExistence($prefix,$id=0)
{
$check_op = array('msg' => '', 'status_ok' => 1);
$sql = " SELECT id FROM {$this->object_table} " .
" WHERE prefix='" . $this->db->prepare_string($prefix) . "'";
" AND id <> {$id}";
$rs = $this->db->get_recordset($sql);
if(!is_null($rs))
{
$check_op['msg'] = sprintf(lang_get('error_tcase_prefix_exists'),$prefix);
$check_op['status_ok'] = 0;
}
return $check_op;
}