/lib/functions/testsuite.class.php

<?php

/** 

 * TestLink Open Source Project - http://testlink.sourceforge.net/ 

 * This script is distributed under the GNU General Public License 2 or later.

 * 

 * @package 	TestLink

 * @author 		franciscom

 * @copyright 	2005-2009, TestLink community 

 * @version    	CVS: $Id: testsuite.class.php,v 1.98 2010/07/15 16:45:41 franciscom Exp $

 * @link 		http://www.teamst.org/index.php

 *

 * @internal Revisions:

 *

 * 20100602 - franciscom - BUGID 3498 - get_by_name() - missing JOIN

 * 20100328 - franciscom - get_by_id() interface and return set changes

 *						   get_children() - new method - contribution - BUGID 2645

 * 20100315 - amitkhullar - Added options for CFields for Export.

 * 20100227 - franciscom - BUGID 0003233: After test suite edit, display of Test suite do not 

 *                         have upload button enabled for attachment

 * 20100210	- franciscom - keywords XML export refactored

 * 20100209 - franciscom - changes in delete_subtree_objects() call due to BUGID 3147 

 * 20100204 - franciscom - copy_to() refactoring	

 * 20100201 - franciscom - get_testcases_deep() - added external_id in output

 * 20091122 - franciscom - item template logic refactored - read_file() removed

 * 20090821 - franciscom - BUGID 0002781

 * 20090801 - franciscom - BUGID 2767 Duplicate testsuite name error message issue 

 * 20090514 - franciscom - typo bug on html_table_of_custom_field_inputs()

 * 20090330 - franciscom - changes in calls to get_linked_cfields_at_design()

 * 20090329 - franciscom - html_table_of_custom_field_values()

 * 20090209 - franciscom - new method - get_children_testcases()

 * 20090208 - franciscom - get_testcases_deep() - interface changes

 * 20090207 - franciscom - update() - added duplicated name check

 *                         fixed problem in create() due new argument

 * 20090204 - franciscom - exportTestSuiteDataToXML() - added node_order

 * 20090106 - franciscom - BUGID - exportTestSuiteDataToXML()

 *                         export custom field values

 *  

 * 20080106 - franciscom - viewer_edit_new() changes to use user templates

 *                         to fill details when creating a new test suites.

 *                         new private method related to this feature:

 *                         _initializeWebEditors(), read_file()

 *

 * 20080105 - franciscom - copy_to() changed return type

 *                         minor bug on copy_to. (tcversion nodes were not excluded).

 *

 * 20071111 - franciscom - new method get_subtree();

 * 20071101 - franciscom - import_file_types, export_file_types

 * 

 * 20070826 - franciscom - minor fix html_table_of_custom_field_values()

 * 20070602 - franciscom - added  nt copy on copy_to() method

 *                         using testcase copy_attachment() method.

 *                         added delete attachments. 

 *                         added remove of custom field values 

 *                         (design) when removing test suite.

 *

 * 20070501 - franciscom - added localization of custom field labels

 *                         added use of htmlspecialchars() on labels

 *

 * 20070324 - franciscom - create() interface changes

 *                         get_by_id()changes in result set

 *

 * 20070204 - franciscom - fixed minor GUI bug on html_table_of_custom_field_inputs()

 *

 * 20070116 - franciscom - BUGID 543

 * 20070102 - franciscom - changes to delete_deep() to support custom fields

 * 20061230 - franciscom - custom field management

 */



/** include support for attachments */

require_once( dirname(__FILE__) . '/attachments.inc.php');

require_once( dirname(__FILE__) . '/files.inc.php');



/**

 * Test Suite CRUD functionality

 * @package 	TestLink

 */

class testsuite extends tlObjectWithAttachments

{

    const NODE_TYPE_FILTER_OFF=null;

    const CHECK_DUPLICATE_NAME=1;

    const DONT_CHECK_DUPLICATE_NAME=0;

    const DEFAULT_ORDER=0;

    const USE_RECURSIVE_MODE = 1;

  

	/** @var database handler */

 	var $db;

	var $tree_manager;

	var $node_types_descr_id;

	var $node_types_id_descr;

	var $my_node_type;

    var $cfield_mgr;



	private $object_table;



    var $import_file_types = array("XML" => "XML");

    var $export_file_types = array("XML" => "XML");

 

    // 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');



	/**

	 * testplan class constructor

	 * 

	 * @param resource &$db reference to database handler

	 */

	function testsuite(&$db)

	{

		$this->db = &$db;	

		

		$this->tree_manager =  new tree($this->db);

		$this->node_types_descr_id=$this->tree_manager->get_available_node_types();

		$this->node_types_id_descr=array_flip($this->node_types_descr_id);

		$this->my_node_type=$this->node_types_descr_id['testsuite'];

		

		$this->cfield_mgr=new cfield_mgr($this->db);

		

		// ATTENTION:

		// second argument is used to set $this->attachmentTableName,property that this calls

		// get from his parent

		// tlObjectWithAttachments::__construct($this->db,'nodes_hierarchy');

		parent::__construct($this->db,"nodes_hierarchy");



		// Must be setted AFTER call to parent constructor

		$this->object_table = $this->tables['testsuites'];



	}





  /*

    returns: map  

             key: export file type code

             value: export file type verbose description 

  */

	function get_export_file_types()

	{

		return $this->export_file_types;

	}





  /*

    function: get_impor_file_types

              getter



    args: -

    

    returns: map  

             key: import file type code

             value: import file type verbose description 



  */

	function get_import_file_types()

	{

		return $this->import_file_types;

	}





	/*

	  args :

	        $parent_id

	        $name

	        $details

	        [$check_duplicate_name]

	        [$action_on_duplicate_name]

	        [$order]

	  returns:   hash	

	                  $ret['status_ok'] -> 0/1

	                  $ret['msg']

	                  $ret['id']        -> when status_ok=1, id of the new element

	  rev :

	       20070324 - BUGID 710

	*/

	function create($parent_id,$name,$details,$order=null,

	                $check_duplicate_name=0,

	                $action_on_duplicate_name='allow_repeat')

	{

		$prefix_name_for_copy = config_get('prefix_name_for_copy');

		if( is_null($order) )

		{

		  $node_order = config_get('treemenu_default_testsuite_order');

		}

		else

		{

		  $node_order = $order;

		}

		

		$name = trim($name);

		$ret = array('status_ok' => 1, 'id' => 0, 'msg' => 'ok');

	

		if ($check_duplicate_name)

		{

	        $check = $this->tree_manager->nodeNameExists($name,$this->my_node_type,null,$parent_id);

			if( $check['status'] == 1)

			{

				if ($action_on_duplicate_name == 'block')

				{

					$ret['status_ok'] = 0;

					// BUGID 2767

					$ret['msg'] = sprintf(lang_get('component_name_already_exists'),$name);	

				} 

				else

				{

					$ret['status_ok'] = 1;      

					if ($action_on_duplicate_name == 'generate_new')

					{ 

						$ret['status_ok'] = 1;

						$desired_name=$name;      

						$name = config_get('prefix_name_for_copy') . " " . $desired_name ;      

					    $ret['msg'] = sprintf(lang_get('created_with_new_name'),$name,$desired_name);	

					}

				}

			}       

		}

		

		if ($ret['status_ok'])

		{

			// get a new id

			$tsuite_id = $this->tree_manager->new_node($parent_id,$this->my_node_type,

			                                           $name,$node_order);

			$sql = "INSERT INTO {$this->tables['testsuites']} (id,details) " .

				   " VALUES ({$tsuite_id},'" . $this->db->prepare_string($details) . "')";

			             

			$result = $this->db->exec_query($sql);

			if ($result)

			{

				$ret['id'] = $tsuite_id;

			}

		}

		

		return $ret;

	}



	

	/**

	 * update

	 *

	 */

	function update($id, $name, $details, $parent_id=null)

	{

		$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;

	  	$ret['status_ok']=0;

	  	$ret['msg']='';

	  	$check = $this->tree_manager->nodeNameExists($name,$this->my_node_type,$id,$parent_id);

	  	if($check['status']==0)

	  	{

			$sql = "/* $debugMsg */ UPDATE {$this->tables['testsuites']} " .

			       " SET details = '" . $this->db->prepare_string($details) . "'" .

			       " WHERE id = {$id}";

			$result = $this->db->exec_query($sql);

	  		

			if ($result)

			{

				$sql = "/* $debugMsg */ UPDATE {$this->tables['nodes_hierarchy']}  SET name='" . 

					   $this->db->prepare_string($name) . "' WHERE id= {$id}";

				$result = $this->db->exec_query($sql);

			}

			

	  		$ret['status_ok']=1;

			$ret['msg']='ok';

			if (!$result)

			{

				$ret['msg'] = $this->db->error_msg();

			}

	  	}

	  	else

	  	{

	  		$ret['msg']=$check['msg'];

	  	}

		return $ret;

	}

	

	

	/**

	 * Delete a Test suite, deleting:

	 * - Children Test Cases

	 * - Test Suite Attachments

	 * - Test Suite Custom fields 

	 * - Test Suite Keywords

	 *

	 * IMPORTANT/CRITIC: 

	 * this can used to delete a Test Suite that contains ONLY Test Cases.

	 *

	 * This function is needed by tree class method: delete_subtree_objects()

	 *

	 * To delete a Test Suite that contains other Test Suites delete_deep() 

	 * must be used.

	 *

	 * ATTENTION: may be in future this can be refactored, and written better. 

	 *

	 */

	function delete($id)

	{

	  	$tcase_mgr = New testcase($this->db);

		$tsuite_info = $this->get_by_id($id);

	

	  	$testcases=$this->get_children_testcases($id);

	  	if (!is_null($testcases))

		{

			foreach($testcases as $the_key => $elem)

			{

	  			$tcase_mgr->delete($elem['id']);

			}

		}  

	  	

	  	// What about keywords ???

	  	$this->cfield_mgr->remove_all_design_values_from_node($id);

	  	$this->deleteAttachments($id);  //inherited

	  	$this->deleteKeywords($id);

	  	

	  	$sql = "DELETE FROM {$this->object_table} WHERE id={$id}";

	  	$result = $this->db->exec_query($sql);

	  	

	  	$sql = "DELETE FROM {$this->tables['nodes_hierarchy']} WHERE id={$id}";

	  	$result = $this->db->exec_query($sql);

	

	}

	

	

	                    

	/*

	  function: get_by_name

	

	  args : name: testsuite name

	  

	  returns: array where every element is a map with following keys:

	           

	           id: 	testsuite id (node id)

	           details

	           name: testsuite name

	

	  @internal Revisions

	  20100602 - BUGID 3498	

	*/

	function get_by_name($name)

	{

		$sql = " SELECT TS.*, NH.name, NH.parent_id " .

			   " FROM {$this->tables['testsuites']} TS " .

			   " JOIN {$this->tables['nodes_hierarchy']} NH " .

			   " ON NH.id = TS.id " .

			   " WHERE NH.name = '" . $this->db->prepare_string($name) . "'";

		

		$recordset = $this->db->get_recordset($sql);

		return $recordset;

	}

	

	/*

	  function: get_by_id

	            get info for one (or several) test suite(s)

	

	  args : id: testsuite id

	  

	  returns: map with following keys:

	           

	           id: 	testsuite id (node id) (can be an array)

	           details

	           name: testsuite name

	  

	  

	  rev :

	  		20100328 - BUGID 2645 - contribution - added parent_id

	        20070324 - added node_order in result set

	

	*/

	function get_by_id($id, $order_by = '')

	{

		$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;

		$sql = "/* $debugMsg */ SELECT TS.*, NH.name, NH.node_type_id, NH.node_order, NH.parent_id " .

		       "  FROM {$this->tables['testsuites']} TS, " .

		       " {$this->tables['nodes_hierarchy']} NH   WHERE TS.id = NH.id AND TS.id "; 



		$sql .= is_array($id) ? " IN (" . implode(',',$id) . ")" : " = {$id} ";

		$sql .= $order_by;

		

		

	    $rs = $this->db->fetchRowsIntoMap($sql,'id');

		if( !is_null($rs) )

	    {

	    	$rs = count($rs) == 1 ? current($rs) : $rs;

	    }

	    return $rs;

	}

	

	

	/*

	  function: get_all()

	            get array of info for every test suite without any kind of filter.

	            Every array element contains an assoc array with test suite info

	

	  args : -

	  

	  returns: array 

	

	*/

	function get_all()

	{

		$sql = " SELECT testsuites.*, nodes_hierarchy.name " .

		       " FROM {$this->tables['testsuites']} testsuites, " .

		       " {$this->tables['nodes_hierarchy']} nodes_hierarchy " . 

		       " WHERE testsuites.id = nodes_hierarchy.id";

		       

	  $recordset = $this->db->get_recordset($sql);

	  return($recordset);

	}

	

	

	/**

	 * show()

	 *

	 * args:  smarty [reference]

	 *        id 

	 *        sqlResult [default = '']

	 *        action [default = 'update']

	 *        modded_item_id [default = 0]

	 * 

	 * returns: -

	 *

	 **/

	function show(&$smarty,$guiObj,$template_dir, $id, $options=null,

	              $sqlResult = '', $action = 'update',$modded_item_id = 0)

	{

		$gui = is_null($guiObj) ? new stdClass() : $guiObj;

		$gui->cf = '';

	    $gui->sqlResult = '';

		$gui->sqlAction = '';

		// 20100314 - franciscom 

		$gui->refreshTree = property_exists($gui,'refreshTree') ? $gui->refreshTree : false;



        // BUGID 0003233: After test suite edit, display of Test suite do not 

        //                have upload button enabled for attachment

  	    // $my['options'] = array('show_mode' => 'readonly'); 	

  	    $my['options'] = array('show_mode' => 'readwrite'); 	

	    $my['options'] = array_merge($my['options'], (array)$options);



        $gui->modify_tc_rights = has_rights($this->db,"mgt_modify_tc");

        if($my['options']['show_mode'] == 'readonly')

        {  	    

			$gui->modify_tc_rights = 'no';

	    }

	    

		if($sqlResult)

		{ 

			$gui->sqlResult = $sqlResult;

			$gui->sqlAction = $action;

		}

		

		$gui->container_data = $this->get_by_id($id);

		$gui->moddedItem = $gui->container_data;

		if ($modded_item_id)

		{

			$gui->moddedItem = $this->get_by_id($modded_item_id);

		}



		$gui->cf = $this->html_table_of_custom_field_values($id);

		$gui->keywords_map = $this->get_keywords_map($id,' ORDER BY keyword ASC ');

		$gui->attachmentInfos = getAttachmentInfosFrom($this,$id);

		$gui->id = $id;

	 	$gui->idpage_title = lang_get('testsuite');

		$gui->level = 'testsuite';

		

		$smarty->assign('gui',$gui);

		$smarty->display($template_dir . 'containerView.tpl');

	}

	

	

	/*

	  function: viewer_edit_new

	            Implements user interface (UI) for edit testuite and 

	            new/create testsuite operations.

	            

	

	  args : smarty [reference]

	         webEditorHtmlNames

	         oWebEditor: rich editor object (today is FCK editor)

	         action

	         parent_id: testsuite parent id on tree.

	         [id]

	         [messages]: default null

	                     map with following keys

	                     [result_msg]: default: null used to give information to user

	                     [user_feedback]: default: null used to give information to user

	                     

	         // [$userTemplateCfg]: configurations, Example: testsuite template usage

	         [$userTemplateKey]: main Key to access item template configuration

	         [$userInput]

	                          

	  returns: -

	

	  rev :

	       20090801 - franciscom - added $userInput

	       20080105 - franciscom - added $userTemplateCfg

	       20071202 - franciscom - interface changes -> template_dir

	*/

	function viewer_edit_new(&$smarty,$template_dir,$webEditorHtmlNames, $oWebEditor, $action, $parent_id, 

	                         $id=null, $messages=null, $userTemplateKey=null, $userInput=null)

	{

	

		$internalMsg = array('result_msg' => null,  'user_feedback' => null);

		$the_data = null;

		$name = '';

		

		if( !is_null($messages) )

		{

			$internalMsg = array_merge($internalMsg, $messages);

		}

		$useUserInput = is_null($userInput) ? 0 : 1;

		

	    $cf_smarty=-2; // MAGIC must be explained

	    

	    $pnode_info=$this->tree_manager->get_node_hierarchy_info($parent_id);

	    $parent_info['description']=lang_get($this->node_types_id_descr[$pnode_info['node_type_id']]);

	    $parent_info['name']=$pnode_info['name'];

	  

	

		$a_tpl = array( 'edit_testsuite' => 'containerEdit.tpl',

						'new_testsuite'  => 'containerNew.tpl',

						'add_testsuite'  => 'containerNew.tpl');

		

		$the_tpl = $a_tpl[$action];

		$smarty->assign('sqlResult', $internalMsg['result_msg']);

		$smarty->assign('containerID',$parent_id);	 

		$smarty->assign('user_feedback', $internalMsg['user_feedback'] );

		

		if( $useUserInput )

		{

			$webEditorData = $userInput;

		}

		else

		{

			$the_data = null;

			$name = '';

			if ($action == 'edit_testsuite')

			{

				$the_data = $this->get_by_id($id);

				$name=$the_data['name'];

				$smarty->assign('containerID',$id);	

	    	} 

	    	$webEditorData = $the_data;

		}

		

	    // Custom fields

	    $cf_smarty = $this->html_table_of_custom_field_inputs($id,$parent_id);

		

		// webeditor

		// 20090503 - now templates will be also used after 'add_testsuite', when

		// presenting a new test suite with all other fields empty.

   		if( !$useUserInput )

        {

			if( ($action == 'new_testsuite' || $action == 'add_testsuite') && !is_null($userTemplateKey) )

			{

			   // need to understand if need to use templates

			   $webEditorData=$this->_initializeWebEditors($webEditorHtmlNames,$userTemplateKey);

			   

			} 

		}

		

		foreach ($webEditorHtmlNames as $key)

		{

			// Warning:

			// the data assignment will work while the keys in $the_data are identical

			// to the keys used on $oWebEditor.

			$of = &$oWebEditor[$key];         

			$of->Value = isset($webEditorData[$key]) ? $webEditorData[$key] : null;

			$smarty->assign($key, $of->CreateHTML());

		}

		

	    $smarty->assign('cf',$cf_smarty);	

		$smarty->assign('parent_info', $parent_info);

		$smarty->assign('level', 'testsuite');

		$smarty->assign('name',$name);

		$smarty->assign('container_data',$the_data);

		$smarty->display($template_dir . $the_tpl);

	}

	

	

	/*

	  function: copy_to

	            deep copy one testsuite to another parent (testsuite or testproject).

	            

	

	  args : id: testsuite id (source or copy)

	         parent_id:

	         user_id: who is requesting copy operation

	         [check_duplicate_name]: default: 0 -> do not check

	                                          1 -> check for duplicate when doing copy

	                                               What to do if duplicate exists, is controlled

	                                               by action_on_duplicate_name argument.

	                                               

	         [action_on_duplicate_name argument]: default: 'allow_repeat'.

	                                              Used when check_duplicate_name=1.

	                                              Specifies how to react if duplicate name exists.

	                                              

	                                               

	                                               

	  

	  returns: map with foloowing keys:

	           status_ok: 0 / 1

	           msg: 'ok' if status_ok == 1

	           id: new created if everything OK, -1 if problems.

	

	  rev :

           20090821 - franciscom - BUGID 0002781

	       20070324 - BUGID 710

	*/

	function copy_to($id, $parent_id, $user_id,$options=null,$mappings=null)

	{



  	    $my['options'] = array('check_duplicate_name' => 0,

  	    					   'action_on_duplicate_name' => 'allow_repeat',

  	    					   'copyKeywords' => 0, 'copyRequirements' => 0); 	

	    $my['options'] = array_merge($my['options'], (array)$options);



	    $my['mappings'] = array();

	    $my['mappings'] = array_merge($my['mappings'], (array)$mappings);





		$copyTCaseOpt = array('copy_also' => 

		                      array('keyword_assignments' => $my['options']['copyKeywords'],

		                            'requirement_assignments' => $my['options']['copyRequirements']) ); 

		                            

    	$copyOptions = array('keyword_assignments' => $my['options']['copyKeywords']);

    	

		$tcase_mgr = new testcase($this->db);

		$tsuite_info = $this->get_by_id($id);

		

		$op = $this->create($parent_id,$tsuite_info['name'],$tsuite_info['details'],

		                    $tsuite_info['node_order'],$my['options']['check_duplicate_name'],

		                    $my['options']['action_on_duplicate_name']);

		

		$op['mappings'][$id] = $op['id']; 

		$new_tsuite_id = $op['id'];

		

		// Work on root of these subtree

	  	// Attachments

	  	// Keyword assignment

	  	// Custom Field values

	  	$this->copy_attachments($id,$new_tsuite_id);

		if( $my['options']['copyKeywords'] )

		{

			$kmap = isset($my['mappings']['keywords']) ? $my['mappings']['keywords'] : null;

  			$this->copy_keyword_assignment($id,$new_tsuite_id,$kmap);

		}

  	    $this->copy_cfields_values($id,$new_tsuite_id);

		

		

 		$my['filters'] = array('exclude_children_of' => array('testcase' => 'exclude my children'));

		$subtree = $this->tree_manager->get_subtree($id,$my['filters']);

		if (!is_null($subtree))

		{

		  

			$parent_decode=array();

		  	$parent_decode[$id]=$new_tsuite_id;

			foreach($subtree as $the_key => $elem)

			{

			  $the_parent_id=$parent_decode[$elem['parent_id']];

				switch ($elem['node_type_id'])

				{

					case $this->node_types_descr_id['testcase']:

						

						$tcOp = $tcase_mgr->copy_to($elem['id'],$the_parent_id,$user_id,$copyTCaseOpt);

						$op['mappings'] += $tcOp['mappings'];

						break;

						

					case $this->node_types_descr_id['testsuite']:

						$tsuite_info = $this->get_by_id($elem['id']);

						$ret = $this->create($the_parent_id,$tsuite_info['name'],

						                     $tsuite_info['details'],$tsuite_info['node_order']);      

					  

				    	$parent_decode[$elem['id']] = $ret['id'];

				    	$op['mappings'][$elem['id']] = $ret['id']; 

				    	

			      		$tcase_mgr->copy_attachments($elem['id'],$ret['id']);

						if( $my['options']['copyKeywords'] )

						{

  							$this->copy_keyword_assignment($elem['id'],$ret['id'],$kmap);

						}

  	    				$this->copy_cfields_values($elem['id'],$ret['id']);

  	    				

						break;

				}

			}

		}

		return $op;

	}

	

	

	/*

	  function: get_subtree

	            Get subtree that has choosen testsuite as root.

	            Only nodes of type: 

	            testsuite and testcase are explored and retrieved.

	

	  args: id: testsuite id

	        [recursive_mode]: default false

	        

	  

	  returns: map

	           see tree->get_subtree() for details.

	

	*/

	function get_subtree($id,$recursive_mode=false)

	{

	    $my['options']=array('recursive' => $recursive_mode);

 		$my['filters'] = array('exclude_node_types' => $this->nt2exclude,

 	                           'exclude_children_of' => $this->nt2exclude_children);

	  

		$subtree = $this->tree_manager->get_subtree($id,$my['filters'],$my['options']);

	  	return $subtree;

	}

	

	

	

	/*

	  function: get_testcases_deep

	            get all test cases in the test suite and all children test suites

	            no info about tcversions is returned.

	

	  args : id: testsuite id

	         [details]: default 'simple'

	                    Structure of elements in returned array, changes according to

	                    this argument:

	          

	                    'only_id'

	                    Array that contains ONLY testcase id, no other info.

	                    

	                    'simple'

	                    Array where each element is a map with following keys.

	                    

	                    id: testcase id

	                    parent_id: testcase parent (a test suite id).

	                    node_type_id: type id, for a testcase node

	                    node_order

	                    node_table: node table, for a testcase.

	                    name: testcase name

	                    external_id: 

	                    

	                    'full'

	                    Complete info about testcase for LAST TCVERSION 

	                    TO BE IMPLEMENTED

	  

	  returns: array

	

	*/

	function get_testcases_deep($id, $details = 'simple')

	{

		$tcase_mgr = new testcase($this->db);

		$testcases = null;

		$subtree = $this->get_subtree($id);

		$only_id=($details=='only_id') ? true : false;             				

		$doit=!is_null($subtree);

		$parentSet=null;

	  

		if($doit)

		{

			$testcases = array();

			$tcNodeType = $this->node_types_descr_id['testcase'];

			$prefix = null;

			foreach ($subtree as $the_key => $elem)

			{

				if($elem['node_type_id'] == $tcNodeType)

				{

					if ($only_id)

					{

						$testcases[] = $elem['id'];

					}

					else

					{

						// After first call passing $prefix with right value, avoids a function call

						// inside of getExternalID();

						list($identity,$prefix,$glueChar,$external) = $tcase_mgr->getExternalID($elem['id'],null,$prefix);

						$elem['external_id'] = $identity; 

						$testcases[]= $elem;

						$parentSet[$elem['parent_id']]=$elem['parent_id'];

					}	

				}

			}

			$doit = count($testcases) > 0;

		}

	  

	  	if($doit && $details=='full')

	  	{

	  	    $parentNodes=$this->tree_manager->get_node_hierarchy_info($parentSet);

	  	

	  	    $rs=array();

	  	    foreach($testcases as $idx => $value)

	  	    {

	  	       $item=$tcase_mgr->get_last_version_info($value['id']);

	  	       $item['tcversion_id']=$item['id'];

	  	       $tsuite['tsuite_name']=$parentNodes[$value['parent_id']]['name'];

	  	       unset($item['id']);

	  	       $rs[]=$value+$item+$tsuite;   

	  	    }

	  	    $testcases=$rs;

	  	}

		return $testcases; 

	}

	

	

	/**

	 * get_children_testcases

	 * get only test cases with parent=testsuite without doing a deep search

	 *

	 */

	function get_children_testcases($id, $details = 'simple')

	{

	    $testcases=null;

	    $only_id=($details=='only_id') ? true : false;             				

	    $subtree=$this->tree_manager->get_children($id,array('testsuite' => 'exclude_me'));

		$doit=!is_null($subtree);

		if($doit)

		{

		  $tsuite=$this->get_by_id($id);

		  $tsuiteName=$tsuite['name'];

			$testcases = array();

			foreach ($subtree as $the_key => $elem)

			{

				if ($only_id)

				{

					$testcases[] = $elem['id'];

				}

				else

				{

					$testcases[]= $elem;

				}	

			}

			$doit = count($testcases) > 0;

		}

	    

	    if($doit && $details=='full')

	    {

	        $rs=array();

	        $tcase_mgr = new testcase($this->db);

	        foreach($testcases as $idx => $value)

	        {

	           $item=$tcase_mgr->get_last_version_info($value['id']);

	           $item['tcversion_id']=$item['id'];

	           $parent['tsuite_name']=$tsuiteName;

	           unset($item['id']);

	           $rs[]=$value+$item+$tsuite;   

	        }

	        $testcases=$rs;

	    }

		  return $testcases; 

	}  

	

	

	

	

	/*

	  function: delete_deep

	

	  args : $id

	  

	  returns: 

	

	  rev :

	       20070602 - franciscom

	       added delete attachments

	*/

	function delete_deep($id)

	{

		// BUGID 3147 - Delete test project with requirements defined crashed with memory exhausted

	  	$this->tree_manager->delete_subtree_objects($id,$id,'',array('testcase' => 'exclude_tcversion_nodes'));

	  	$this->delete($id);

	} // end function

	

	



	

	

	/*

	  function: initializeWebEditors

	

	  args:

	  

	  returns: 

	

	*/

	private function _initializeWebEditors($WebEditors,$itemTemplateCfgKey)

	{

	  $wdata=array();

	  foreach ($WebEditors as $key => $html_name)

	  {

	  	$wdata[$html_name] = getItemTemplateContents($itemTemplateCfgKey, $html_name, '');

	  } 

	  return $wdata;

	}

	

	

	/*

	  function: getKeywords

	            Get keyword assigned to a testsuite.

	            Uses table object_keywords.

	            

	            Attention:

	            probably write on obejct_keywords has not been implemented yet,

	            then right now thie method can be useless.

	             

	

		args:	id: testsuite id

	        kw_id: [default = null] the optional keyword id

	  

	  returns: null if nothing found.

	           array, every elemen is map with following structure:

		         id

		         keyword

		         notes

	  

	  rev : 

	        20070116 - franciscom - BUGID 543

	

	*/

	function getKeywords($id,$kw_id = null)

	{

		$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;

		

		$sql = "/* $debugMsg */ SELECT keyword_id,keywords.keyword, notes " .

		       " FROM {$this->tables['object_keywords']}, {$this->tables['keywords']} keywords " .

		       " WHERE keyword_id = keywords.id AND fk_id = {$id}";

		if (!is_null($kw_id))

		{

			$sql .= " AND keyword_id = {$kw_id}";

		}	

		$map_keywords = $this->db->fetchRowsIntoMap($sql,'keyword_id');

		

		return($map_keywords);

	} 

	

	

	/*

	  function: get_keywords_map

	            All keywords for a choosen testsuite

	

	            Attention:

	            probably write on obejct_keywords has not been implemented yet,

	            then right now thie method can be useless.

	

	

	  args :id: testsuite id

	        [order_by_clause]: default: '' -> no order choosen

	                           must be an string with complete clause, i.e.

	                           'ORDER BY keyword'

	

	  

	  

	  returns: map: key: keyword_id

	                value: keyword

	  

	

	*/

	function get_keywords_map($id,$order_by_clause='')

	{

		$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;

		$sql = "/* $debugMsg */ SELECT keyword_id,keywords.keyword " .

		       " FROM {$this->tables['object_keywords']}, {$this->tables['keywords']} keywords " .

		       " WHERE keyword_id = keywords.id ";



		if (is_array($id))

		{

			$sql .= " AND fk_id IN (".implode(",",$id).") ";

		}

		else

		{

			$sql .= " AND fk_id = {$id} ";

		}

			

		$sql .= $order_by_clause;

	

		$map_keywords = $this->db->fetchColumnsIntoMap($sql,'keyword_id','keyword');

		return($map_keywords);

	} 

	

	

	/**

	 * 

 	 *

	 */

	function addKeyword($id,$kw_id)

	{

		$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;

		$status = 1;

		$kw = $this->getKeywords($id,$kw_id);

		if( ($doLink = !sizeof($kw)) )

		{

			$sql = "/* $debugMsg */ INSERT INTO {$this->tables['object_keywords']} " .

			       " (fk_id,fk_table,keyword_id) VALUES ($id,'nodes_hierarchy',$kw_id)";

        	$status = $this->db->exec_query($sql) ? 1 : 0;

		}	

		return $status;

	}

	

	

	/*

	  function: addKeywords

	

	  args :

	  

	  returns: 

	

	*/

	function addKeywords($id,$kw_ids)

	{

		$status = 1;

		$num_kws = sizeof($kw_ids);

		for($idx = 0; $idx < $num_kws; $idx++)

		{

			$status = $status && $this->addKeyword($id,$kw_ids[$idx]);

		}

		return($status);

	}

	

	

	/*

	  function: deleteKeywords

	

	  args :

	  

	  returns: 

	

	*/

	function deleteKeywords($id,$kw_id = null)

	{

		$sql = " DELETE FROM {$this->tables['object_keywords']} WHERE fk_id = {$id} ";

		if (!is_null($kw_id))

		{

			$sql .= " AND keyword_id = {$kw_id}";

		}	

		return($this->db->exec_query($sql));

	}

	

	/*

	  function: exportTestSuiteDataToXML

	

	  args :

	  

	  returns: 

	  

	  rev: 20090204 - franciscom - added node_order

	

	*/

	function exportTestSuiteDataToXML($container_id,$tproject_id,$optExport = array())

	{

		static $keywordMgr;

		if(is_null($keywordMgr))

		{

  	    	$keywordMgr = new tlKeyword();      

		}	

		

		// echo __FUNCTION__ . '<br>';

		$xmlTC = null;

		$doRecursion = isset($optExport['RECURSIVE']) ? $optExport['RECURSIVE'] : 0;

		if($doRecursion)

		{

		    $cfXML = null;

			$kwXML = null;

			$tsuiteData = $this->get_by_id($container_id);

			if (@$optExport['KEYWORDS'])

			{

				$kwMap = $this->getKeywords($container_id);

				if ($kwMap)

				{

					$kwXML = "<keywords>" . $keywordMgr->toXMLString($kwMap,true) . "</keywords>";

				}	

			}

			if ($optExport['CFIELDS'])

		    {

				// 20090106 - franciscom - custom fields

	        	$cfMap=$this->get_linked_cfields_at_design($container_id,null,null,$tproject_id);

				if( !is_null($cfMap) && count($cfMap) > 0 )

		    	{

	        	    $cfRootElem = "<custom_fields>{{XMLCODE}}</custom_fields>";

		    	    $cfElemTemplate = "\t" . '<custom_field><name><![CDATA[' . "\n||NAME||\n]]>" . "</name>" .

		    	  	                         '<value><![CDATA['."\n||VALUE||\n]]>".'</value></custom_field>'."\n";

		    	    $cfDecode = array ("||NAME||" => "name","||VALUE||" => "value");

		    	    $cfXML = exportDataToXML($cfMap,$cfRootElem,$cfElemTemplate,$cfDecode,true);

		    	} 

		    }

	        $xmlTC = "<testsuite name=\"" . htmlspecialchars($tsuiteData['name']). '" >' .

	                 "\n<node_order><![CDATA[{$tsuiteData['node_order']}]]></node_order>\n" .

		             "<details><![CDATA[{$tsuiteData['details']}]]> \n{$kwXML}{$cfXML}</details>";

		}

		else

		{

			$xmlTC = "<testcases>";

	    }

	  

		$test_spec = $this->get_subtree($container_id,self::USE_RECURSIVE_MODE);

	

	 

		$childNodes = isset($test_spec['childNodes']) ? $test_spec['childNodes'] : null ;

		$tcase_mgr=null;

		if( !is_null($childNodes) )

		{

		    $loop_qty=sizeof($childNodes); 

		    for($idx = 0;$idx < $loop_qty;$idx++)

		    {

		    	$cNode = $childNodes[$idx];

		    	$nTable = $cNode['node_table'];

		    	if ($doRecursion && $nTable == 'testsuites')

		    	{

		    		$xmlTC .= $this->exportTestSuiteDataToXML($cNode['id'],$tproject_id,$optExport);

		    	}

		    	else if ($nTable == 'testcases')

		    	{

		    	    if( is_null($tcase_mgr) )

		    	    {

		    		    $tcase_mgr = new testcase($this->db);

		    		}

		    		$xmlTC .= $tcase_mgr->exportTestCaseDataToXML($cNode['id'],testcase::LATEST_VERSION,

		    		                                              $tproject_id,true,$optExport);

		    	}

		    }

		}   

		$xmlTC .= $doRecursion ? "</testsuite>" : "</testcases>"; 

		return $xmlTC;

	}

	

	

	// -------------------------------------------------------------------------------

	// Custom field related methods

	// -------------------------------------------------------------------------------

	/*

	  function: get_linked_cfields_at_design

	            

	            

	  args: $id

	        [$parent_id]:

	        [$show_on_execution]: default: null

	                              1 -> filter on field show_on_execution=1

	                              0 or null -> don't filter

	        

	        

	  returns: hash

	  

	  rev :

	        20061231 - franciscom - added $parent_id

	*/

		function get_linked_cfields_at_design($id,$parent_id=null,$show_on_execution=null,$tproject_id = null) 

		{

			if (!$tproject_id)

			{

				$tproject_id = $this->getTestProjectFromTestSuite($id,$parent_id);

			}

	        $filters=array('show_on_execution' => $show_on_execution);    

			$enabled = 1;

			$cf_map = $this->cfield_mgr->get_linked_cfields_at_design($tproject_id,$enabled,$filters,

			                                                          'testsuite',$id);

			return $cf_map;

		}

		

	  /**

	   * getTestProjectFromTestSuite()

	   *

	   */

		function getTestProjectFromTestSuite($id,$parent_id)

		{

			$tproject_id = $this->tree_manager->getTreeRoot( (!is_null($id) && $id > 0) ? $id : $parent_id);

			return $tproject_id;

		}

	

	/*

	  function: get_linked_cfields_at_execution

	            

	            

	  args: $id

	        [$parent_id]

	        [$show_on_execution]: default: null

	                              1 -> filter on field show_on_execution=1

	                              0 or null -> don't filter

	        

	        

	  returns: hash

	  

	  rev :

	        20061231 - franciscom - added $parent_id

	*/

	function get_linked_cfields_at_execution($id,$parent_id=null,$show_on_execution=null) 

	{

	  $filters=array('show_on_execution' => $show_on_execution);    

	  $enabled=1;

	  $the_path=$this->tree_manager->get_path(!is_null($id) ? $id : $parent_id);

	  $path_len=count($the_path);

	  $tproject_id=($path_len > 0)? $the_path[$path_len-1]['parent_id'] : $parent_id;

	

	  $cf_map=$this->cfield_mgr->get_linked_cfields_at_design($tproject_id,$enabled,$filters,

	                                                          'testsuite',$id);

	  return($cf_map);

	}

	

	

	

	/*

	  function: html_table_of_custom_field_inputs

	            

	            

	  args: $id

	        [$parent_id]: need when you call this method during the creation

	                      of a test suite, because the $id will be 0 or null.

	                      

	        [$scope]: 'design','execution'

	        

	  returns: html string

	  

	*/

	function html_table_of_custom_field_inputs($id,$parent_id=null,$scope='design') 

	{

	  $cf_smarty='';

	  if( $scope=='design' )

	  {

	    $cf_map=$this->get_linked_cfields_at_design($id,$parent_id);

	  }

	  else

	  {

	    $cf_map=$this->get_linked_cfields_at_execution($id,$parent_id);

	  }

	  

	  if( !is_null($cf_map) )

	  {

	    foreach($cf_map as $cf_id => $cf_info)

	    {

	      // true => do not create input in audit log

	      $label=str_replace(TL_LOCALIZE_TAG,'',lang_get($cf_info['label'],null,true));

	      $cf_smarty .= '<tr><td class="labelHolder">' . htmlspecialchars($label) . "</td><td>" .

	                    $this->cfield_mgr->string_custom_field_input($cf_info) .

	                    "</td></tr>\n";

	    } //foreach($cf_map

	  }

	  

	  if(trim($cf_smarty) != "")

	  {

	    $cf_smarty = "<table>" . $cf_smarty . "</table>";

	  }

	  

	  return($cf_smarty);

	}

	

	

	/*

	  function: html_table_of_custom_field_values

	            

	            

	  args: $id

	        [$scope]: 'design','execution'

	        [$show_on_execution]: default: null

	                              1 -> filter on field show_on_execution=1

	                              0 or null -> don't filter

	  

	  returns: html string

	  

	*/

	function html_table_of_custom_field_values($id,$scope='design',$show_on_execution=null,

	                                           $tproject_id = null,$formatOptions=null) 

	{

	    $filters=array('show_on_execution' => $show_on_execution);    

	    $td_style='class="labelHolder"' ;

	    $add_table=true;

	    $table_style='';

	    if( !is_null($formatOptions) )

	    {

	        $td_style=isset($formatOptions['td_css_style']) ? $formatOptions['td_css_style'] : $td_style;

	        $add_table=isset($formatOptions['add_table']) ? $formatOptions['add_table'] : true;

	        $table_style=isset($formatOptions['table_css_style']) ? $formatOptions['table_css_style'] : $table_style;

	    } 

	

	    $cf_smarty='';

	    $parent_id=null;

	    

	    if( $scope=='design' )

	    {

	      $cf_map = $this->get_linked_cfields_at_design($id,$parent_id,$filters,$tproject_id);

	    }

	    else 

	    {

	      // Important: remember that for Test Suite, custom field value CAN NOT BE changed at execution time

	      // just displayed.

	      // @TODO: schlundus, can this be speed up with tprojectID?

	      $cf_map=$this->get_linked_cfields_at_execution($id);

	    }

	      

	    if( !is_null($cf_map) )

	    {

	      foreach($cf_map as $cf_id => $cf_info)

	      {

	        // if user has assigned a value, then node_id is not null

	        if($cf_info['node_id'])

	        {

	          // true => do not create input in audit log

	          $label=str_replace(TL_LOCALIZE_TAG,'',lang_get($cf_info['label'],null,true));

	          $cf_smarty .= "<tr><td {$td_style} >" . htmlspecialchars($label) . "</td><td>" .

	                        $this->cfield_mgr->string_custom_field_value($cf_info,$id) .

	                        "</td></tr>\n";

	        }

	      }

	    }

	    if((trim($cf_smarty) != "") && $add_table)

		{

			 $cf_smarty = "<table {$table_style}>" . $cf_smarty . "</table>";

		}

	    return($cf_smarty);

	} // function end





	/** 

	 * Copy attachments from source test suite to target test suite

	 * 

	 **/

	function copy_attachments($source_id,$target_id)

	{

		$this->attachmentRepository->copyAttachments($source_id,$target_id,$this->attachmentTableName);

	}



	/** 

	 * Copy keyword assignment

	 * mappings is only useful when source_id and target_id do not belong to same Test Project.

	 * Because keywords are defined INSIDE a Test Project, ID will be different for same keyword

	 * in a different Test Project

	 *

	 **/

	function copy_keyword_assignment($source_id,$target_id,$mappings)

	{

		// Get source_id keyword assignment

		$sourceItems = $this->getKeywords($source_id);

		if( !is_null($sourceItems) )

		{

			// build item id list

			$keySet = array_keys($sourceItems);

			foreach($keySet as $itemPos => $itemID)

			{

				if( isset($mappings[$itemID]) )

				{

					$keySet[$itemPos] = $mappings[$itemID];

				}

			}

			$this->addKeywords($target_id,$keySet);		

		}

    }



	/** 

	 * Copy Custom Fields values

	 *

	 **/

	function copy_cfields_values($source_id,$target_id)

	{

		$debugMsg = 'Class:' . __CLASS__ . ' - Method: ' . __FUNCTION__;

		// Get source_id cfields assignment

		$sourceItems = $this->cfield_mgr->getByLinkID($source_id,array('scope' => 'design'));

		if( !is_null($sourceItems) )

		{

		    $sql = "/* $debugMsg */ " . 

	               " INSERT INTO {$this->tables['cfield_design_values']} " . 

	               " (field_id,value,node_id) " .

	         	   " SELECT field_id,value,{$target_id} AS target_id" .

	               " FROM {$this->tables['cfield_design_values']} " .

	         	   " WHERE node_id = {$source_id} ";

			$this->db->exec_query($sql);

		}

    }





	/**

	 * get_children

	 * get test suites with parent = testsuite with given id

	 *

	 */

	function get_children($id)

	{

	    $itemSet = null;

	    $subtree = $this->tree_manager->get_children($id, array('testcase' => 'exclude_me'));

	    if(!is_null($subtree) && count($subtree) > 0)

	    {

			foreach( $subtree as $the_key => $elem)

			{

	    		$itemKeys[] = $elem['id'];

			}

	    	$itemSet = $this->get_by_id($itemKeys, 'ORDER BY node_order');

	    }

	    return $itemSet;

	}



} // end class



?>