<?php
/** 
 * TestLink Open Source Project - http://testlink.sourceforge.net/ 
 * This script is distributed under the GNU General Public License 2 or later. 
 *
 * link/unlink test cases to a test plan
 *
 * @package     TestLink
 * @filesource  planAddTC.php
 * @copyright   2007-2018, TestLink community 
 * @link        http://testlink.sourceforge.net/
 * 
 **/

require_once('../../config.inc.php');
require_once("common.php");
require_once('email_api.php');
require_once("specview.php");
require_once('Zend/Validate/EmailAddress.php');

testlinkInitPage($db);

$tree_mgr = new tree($db);
$tsuite_mgr = new testsuite($db);
$tplan_mgr = new testplan($db);
$tproject_mgr = new testproject($db);
$tcase_mgr = new testcase($db);
$req_mgr = new requirement_mgr($db);
$req_spec_mgr = new requirement_spec_mgr($db);

$templateCfg = templateConfiguration();
$args = init_args($tproject_mgr);
$gui = initializeGui($db,$args,$tplan_mgr,$tcase_mgr);

$keywordsFilter = null;
if(is_array($args->keyword_id)) {
  $keywordsFilter = new stdClass();
  $keywordsFilter->items = $args->keyword_id;
  $keywordsFilter->type = $gui->keywordsFilterType->selected;
}

$do_display = 0;
$do_display_coverage = 0;

switch($args->item_level) {
  case 'testsuite':
  case 'req':
  case 'req_spec':
    $do_display = 1;
  break;

  case 'reqcoverage':
  case 'reqspeccoverage':
    $do_display_coverage = 1;
  break;
  
  case 'testproject':
	  redirect($_SESSION['basehref'] . 
      "lib/results/printDocOptions.php?activity=$args->activity");
    exit();
  break;
}


switch($args->doAction) {
  case 'doAddRemove':
    // Remember:  checkboxes exist only if are checked
    $gui->itemQty = count((array)$args->testcases2add);
    
    if( !is_null($args->testcases2add) ) {
      addToTestPlan($db,$args,$gui,$tplan_mgr,$tcase_mgr);
    }  

    if(!is_null($args->testcases2remove)) {
      // remove without warning
      $items_to_unlink=null;
      foreach ($args->testcases2remove as $tcase_id => $info)  {
        foreach ($info as $platform_id => $tcversion_id)  {
          $items_to_unlink['tcversion'][$tcase_id] = $tcversion_id;
          $items_to_unlink['platform'][$platform_id] = $platform_id;
          $items_to_unlink['items'][$tcase_id][$platform_id] = $tcversion_id;
        }
      }
      $tplan_mgr->unlink_tcversions($args->tplan_id,$items_to_unlink);
    }
  
    doReorder($args,$tplan_mgr);
  break;
  
  case 'doReorder':
    doReorder($args,$tplan_mgr);
  break;

  case 'doSavePlatforms':
    doSavePlatforms($args,$tplan_mgr);
  break;

  case 'doSaveCustomFields':
    doSaveCustomFields($args,$_REQUEST,$tplan_mgr,$tcase_mgr);
  break;

  default:
  break;
}

$smarty = new TLSmarty();


if($do_display) {
  $tsuite_data = $tsuite_mgr->get_by_id($args->object_id);
  // see development documentation on [INSTALL DIR]/docs/development/planAddTC.php.txt
  $tplan_linked_tcversions = getFilteredLinkedVersions($db,$args,$tplan_mgr,$tcase_mgr,array('addImportance' => true));

  // Add Test Cases to Test plan - Right pane does not honor custom field filter
  $testCaseSet = $args->control_panel['filter_tc_id'];   
  if(!is_null($keywordsFilter) ) { 
    
    // With this pieces we implement the AND type of keyword filter.
    $keywordsTestCases = 
      $tproject_mgr->getKeywordsLatestTCV($args->tproject_id,
        $keywordsFilter->items,$keywordsFilter->type);

    if (sizeof($keywordsTestCases)) {
      $testCaseSet = array_keys($keywordsTestCases);
    }
  }
  
  // Choose enable/disable display of custom fields, analysing if this kind of custom fields
  // exists on this test project.
  $cfields = (array)$tsuite_mgr->cfield_mgr->get_linked_cfields_at_testplan_design($args->tproject_id,1,'testcase');
  $opt = array('write_button_only_if_linked' => 0, 'add_custom_fields' => 0);
  $opt['add_custom_fields'] = count($cfields) > 0 ? 1 : 0;

  // Add Test Cases to Test plan - Right pane does not honor custom field filter
  // filter by test case execution type
  $filters = array('keywords' => $args->keyword_id, 'testcases' => $testCaseSet, 
                   'exec_type' => $args->executionType, 'importance' => $args->importance,
                   'cfields' => $args->control_panel['filter_custom_fields'],
                   'workflow_status' => $args->workflow_status,
                   'tcase_name' => $args->control_panel['filter_testcase_name']);


  $out = gen_spec_view($db,'testPlanLinking',$args->tproject_id,$args->object_id,$tsuite_data['name'],
                       $tplan_linked_tcversions,null,$filters,$opt);
  
  $gui->has_tc = ($out['num_tc'] > 0 ? 1 : 0);
  $gui->items = $out['spec_view'];
  $gui->has_linked_items = $out['has_linked_items'];
  $gui->add_custom_fields = $opt['add_custom_fields'];
  $gui->drawSavePlatformsButton = false;
  $gui->drawSaveCFieldsButton = false;

  if( !is_null($gui->items) )
  {
    initDrawSaveButtons($gui);
  }
    
  // This has to be done ONLY AFTER has all data needed => after gen_spec_view() call
  setAdditionalGuiData($gui);

  // refresh tree only when action is done
  switch ($args->doAction) 
  {
    case 'doReorder':
    case 'doSavePlatforms':
    case 'doSaveCustomFields':
    case 'doAddRemove':
      $gui->refreshTree = $args->refreshTree;
    break;
    
    default:
      $gui->refreshTree = false;
    break;  
  }
    
  $smarty->assign('gui', $gui);
  $smarty->display($templateCfg->template_dir .  'planAddTC_m1.tpl');
} elseif ($do_display_coverage) {
	if($args->item_level == 'reqcoverage') {
		// Select coverage
	
		$requirement_data = $req_mgr->get_by_id($args->object_id, requirement_mgr::LATEST_VERSION);
		$requirement_data_name = $requirement_data[0]['req_doc_id'] . ' : ' . $requirement_data[0]['title'];
		// get chekbox value : setting_get_parent_child_relation.
		if($_SESSION['setting_get_parent_child_relation']){
			// if checkbox is checked.
			$requirements_child = $req_spec_mgr->get_requirement_child_by_id($args->object_id, requirement_mgr::LATEST_VERSION);
		} else {
			$requirements_child = null;
		}
	}
	elseif($args->item_level == 'reqspeccoverage') {
	
		// Select folder coverage
		$getOptions = array('order_by' => " ORDER BY id");
		//$getFilters = array('status' => VALID_REQ);
		$requirements = $req_spec_mgr->get_requirements($args->object_id,'all',null,$getOptions);
	}

	// This does filter on keywords ALWAYS in OR mode.
	//
	// CRITIC:
	// We have arrived after clicking in a node of Test Spec Tree where we have two classes of filters
	// 1. filters on attribute COMMON to all test case versions => TEST CASE attribute like keyword_id
	// 2. filters on attribute that can change on each test case version => execution type.
	//
	// For attributes at Version Level, filter is done ON LAST ACTIVE version, that can be NOT the VERSION
	// already linked to test plan.
	// This can produce same weird effects like this:
	//
	//  1. Test Suite A - create TC1 - Version 1 - exec type MANUAL
	//  2. Test Suite A - create TC2 - Version 1 - exec type AUTO
	//  3. Test Suite A - create TC3 - Version 1 - exec type MANUAL
	//  4. Use feature ADD/REMOVE test cases from test plan.
	//  5. Add TC1 - Version 1 to test plan
	//  6. Apply filter on exec type AUTO
	//  7. Tree will display (Folder) Test Suite A with 1 element
	//  8. click on folder, then on RIGHT pane:
	//     TC2 - Version 1 NOT ASSIGNED TO TEST PLAN is displayed
	//  9. Use feature edits test cases, to create a new version for TC1 -> Version 2 - exec type AUTO
	// 10. Use feature ADD/REMOVE test cases from test plan.
	// 11. Apply filter on exec type AUTO
	// 12. Tree will display (Folder) Test Suite A with 2 elements
	// 13. click on folder, then on RIGHT pane:
	//     TC2 - Version 1 NOT ASSIGNED TO TEST PLAN is displayed
	//     TC1 - Version 2 NOT ASSIGNED TO TEST PLAN is displayed  ----> THIS IS RIGHT but WRONG
	//     Only one TC version can be linked to test plan, and TC1 already is LINKED BUT with VERSION 1.
	//     Version 2 is displayed because it has EXEC TYPE AUTO
	//
	// How to solve ?
	// Filters regarding this kind of attributes WILL BE NOT APPLIEDED to get linked items
	// In this way counters on Test Spec Tree and amount of TC displayed on right pane will be coherent.
	//
	// 20130426
	// Hmm. But if I do as explained in ' How to solve ?'
	// I need to apply this filters on a second step or this filters will not work
	// Need to check what I've done
	//
	$tplan_linked_tcversions = getFilteredLinkedVersions($db,$args,$tplan_mgr,$tcase_mgr,null,false);

	// Add Test Cases to Test plan - Right pane does not honor custom field filter
	$testCaseSet = $args->control_panel['filter_tc_id'];
	if(!is_null($keywordsFilter) ) {

		// With this pieces we implement the AND type of keyword filter.
    $keywordsTestCases = 
      $tproject_mgr->getKeywordsLatestTCV($args->tproject_id,
        $keywordsFilter->items,$keywordsFilter->type);

		if (sizeof($keywordsTestCases)) {
			$testCaseSet = array_keys($keywordsTestCases);
		}
	}

	// Choose enable/disable display of custom fields, analysing if this kind of custom fields
	// exists on this test project.
	$cfields=$tsuite_mgr->cfield_mgr->get_linked_cfields_at_testplan_design($args->tproject_id,1,'testcase');
	$opt = array('write_button_only_if_linked' => 0, 'add_custom_fields' => 0);
	$opt['add_custom_fields'] = count($cfields) > 0 ? 1 : 0;

  // Add Test Cases to Test plan - Right pane does not honor custom field filter
  // filter by test case execution type
	$filters = array('keywords' => $args->keyword_id, 'testcases' => null,
	'exec_type' => $args->executionType, 'importance' => $args->importance,
	'cfields' => $args->control_panel['filter_custom_fields'],
	'tcase_name' => $args->control_panel['filter_testcase_name']);
	
	if($args->item_level == 'reqcoverage')
	{
	
	  $out = array();
	  $out = gen_coverage_view($db,'testPlanLinking',$args->tproject_id,$args->object_id,$requirement_data_name,
 	  $tplan_linked_tcversions,null,$filters,$opt);
	
	  // if requirement, has a child requirement.
	  if(!is_null($requirements_child)){
		
		// get parent name.
		$parentName = $requirement_data_name;
		
		foreach($requirements_child as $key => $req){
			$requirement_data_name = $req['req_doc_id'] . ' : ' . $req['name'] . " " . lang_get('req_rel_is_child_of') . " " . $parentName;
			$tmp = gen_coverage_view($db,'testPlanLinking',$args->tproject_id,$req['destination_id'],$requirement_data_name,
			$tplan_linked_tcversions,null,$filters,$opt);
			// update parent name.
			$parentName = $req['req_doc_id'] . ' : ' . $req['name'];
			// First requirement without test cases
				if (empty($tmp['spec_view']))
					continue;
				
				if(empty($out))
				{
					$out = $tmp;
				}
				else
				{	
					$tmp['spec_view'][1]["testsuite"] = $tmp['spec_view'][0]['testsuite'];
					array_push($out['spec_view'], $tmp['spec_view'][1]);
				}
			}
		}
	}
	elseif($args->item_level == 'reqspeccoverage')
	{
	
		$out = array();
		foreach($requirements as $key => $req)
		{
			if(empty($req['req_doc_id'])){
				$coverage_name = $req['doc_id'] . " : " . $req['title'];
			} else {
				$coverage_name = $req['req_doc_id'] . " : " . $req['title'];
			}		
			$tmp = gen_coverage_view($db,'testPlanLinking',$args->tproject_id,$req['id'], $coverage_name,
					$tplan_linked_tcversions,null,$filters,$opt);

			// First requirement without test cases
			if (empty($tmp['spec_view']))
				continue;
			
			if(empty($out))
			{
				$out = $tmp;
			}
			else
			{	
				$tmp['spec_view'][1]["testsuite"] = $tmp['spec_view'][0]['testsuite'];
				array_push($out['spec_view'], $tmp['spec_view'][1]);
			}
				
		}

	}

	// count nb testcases selected in view.
	$nbTestCaseSelected = 0;
	foreach($out['spec_view'][1]['testcases'] as $key => $value)
	{
		if($value['linked_version_id'] != 0){
			$nbTestCaseSelected++;
		}
	}

	$out['spec_view'][1]['linked_testcase_qty'] = $nbTestCaseSelected;
	$gui->has_tc = ($out['num_tc'] > 0 ? 1 : 0);
	$gui->items = $out['spec_view'];
	$gui->has_linked_items = $out['has_linked_items'];
	$gui->add_custom_fields = $opt['add_custom_fields'];
	$gui->drawSavePlatformsButton = false;
	$gui->drawSaveCFieldsButton = false;

    if( !is_null($gui->items) )
    {
		initDrawSaveButtons($gui);
	}

	// This has to be done ONLY AFTER has all data needed => after gen_spec_view() call
	setAdditionalGuiData($gui);

	// refresh tree only when action is done
	switch ($args->doAction)
	{
		case 'doReorder':
		case 'doSavePlatforms':
		case 'doSaveCustomFields':
		case 'doAddRemove':
		$gui->refreshTree = $args->refreshTree;
		break;

		default:
		$gui->refreshTree = false;
		break;
	}

	$smarty->assign('gui', $gui);
	$smarty->display($templateCfg->template_dir .  'planAddTC_m1.tpl');
}





/*
  function: init_args
            creates a sort of namespace

  args:

  returns: object with some REQUEST and SESSION values as members

*/
function init_args(&$tproject_mgr)
{
  $_REQUEST = strings_stripSlashes($_REQUEST);

  $args = new stdClass();

  $args->user = isset($_SESSION['currentUser']) ? $_SESSION['currentUser'] : 0;
  $args->userID = intval($args->user->dbID);

  $args->tplan_id = isset($_REQUEST['tplan_id']) ? intval($_REQUEST['tplan_id']) : intval($_SESSION['testplanID']);
  $args->tproject_id = intval($_SESSION['testprojectID']);
  $args->tproject_name = $_SESSION['testprojectName'];

  $args->object_id = isset($_REQUEST['id']) ? intval($_REQUEST['id']) : 0;
  $args->item_level = isset($_REQUEST['edit']) ? trim($_REQUEST['edit']) : null;
  $args->doAction = isset($_REQUEST['doAction']) ? $_REQUEST['doAction'] : "default";
  $args->testcases2add = isset($_REQUEST['achecked_tc']) ? $_REQUEST['achecked_tc'] : null;
  $args->tcversion_for_tcid = isset($_REQUEST['tcversion_for_tcid']) ? $_REQUEST['tcversion_for_tcid'] : null;
  $args->testcases2remove = isset($_REQUEST['remove_checked_tc']) ? $_REQUEST['remove_checked_tc'] : null;

  $args->testcases2order = isset($_REQUEST['exec_order']) ? $_REQUEST['exec_order'] : null;
  $args->linkedOrder = isset($_REQUEST['linked_exec_order']) ? $_REQUEST['linked_exec_order'] : null;
  $args->linkedVersion = isset($_REQUEST['linked_version']) ? $_REQUEST['linked_version'] : null;
  $args->linkedWithCF = isset($_REQUEST['linked_with_cf']) ? $_REQUEST['linked_with_cf'] : null;
  
  $args->feature2fix = isset($_REQUEST['feature2fix']) ? $_REQUEST['feature2fix'] : null;
  $args->testerID = isset($_REQUEST['testerID']) ? intval($_REQUEST['testerID']) : 0;
  $args->send_mail = isset($_REQUEST['send_mail']) ? $_REQUEST['send_mail'] : false;

  // For more information about the data accessed in session here, see the comment
  // in the file header of lib/functions/tlTestCaseFilterControl.class.php.
  $args->treeFormToken = isset($_REQUEST['form_token']) ? $_REQUEST['form_token'] : 0;
  $mode = 'plan_add_mode';
  $session_data = isset($_SESSION[$mode]) && isset($_SESSION[$mode][$args->treeFormToken]) ? 
                  $_SESSION[$mode][$args->treeFormToken] : null;

  // need to comunicate with left frame, will do via $_SESSION and form_token 
  if( $args->treeFormToken > 0 && ($args->item_level == 'testsuite' || $args->item_level == 'testcase'))
  {
    // do not understand why this do not works OK
    $_SESSION['loadRightPaneAddTC'][$args->treeFormToken] = false;
  }  


  // to be able to pass filters to functions present on specview.php
  $args->control_panel = $session_data;
  
 



  $getFromSession = !is_null($session_data);

  $booleankeys = array('refreshTree' => 'setting_refresh_tree_on_action','importance' => 'filter_importance',
                       'executionType' => 'filter_execution_type');

  foreach($booleankeys as $key => $value)
  {
    $args->$key = ($getFromSession && isset($session_data[$value])) ? $session_data[$value] : 0;
  }            
  $args->importance = ($args->importance > 0) ? $args->importance : null;


  // Filter Top level testsuite is implemented in an strange way:
  // contains WHAT TO REMOVE
  $args->topLevelTestSuite = 0;
  if( $getFromSession && isset($session_data['filter_toplevel_testsuite']) 
                      && count($session_data['filter_toplevel_testsuite']) > 0)
  {
    // get all
    $first_level_suites = $tproject_mgr->get_first_level_test_suites($args->tproject_id,
                                                                     'simple',array('accessKey' => 'id'));

  
    // remove unneeded
    $hit = array_diff_key($first_level_suites, $session_data['filter_toplevel_testsuite']);
    $args->topLevelTestSuite = intval(key($hit));
  }  
  
  // This has effect when 'show full (on right pane)' button is used
  if($args->tproject_id == $args->object_id && $args->topLevelTestSuite > 0)
  {
    $args->object_id = $args->topLevelTestSuite;
  }  



  $args->keyword_id = 0;
  $ak = 'filter_keywords';
  if (isset($session_data[$ak])) 
  {
    $args->keyword_id = $session_data[$ak];
    if (is_array($args->keyword_id) && count($args->keyword_id) == 1) 
    {
      $args->keyword_id = $args->keyword_id[0];
    }
  }
  
  $args->keywordsFilterType = null;
  $ak = 'filter_keywords_filter_type';
  if (isset($session_data[$ak])) 
  {
    $args->keywordsFilterType = $session_data[$ak];
  }


  $ak = 'filter_workflow_status';
  $args->workflow_status = isset($session_data[$ak]) ? $session_data[$ak] : null; 

  $args->build_id = isset($_REQUEST['build_id']) ? intval($_REQUEST['build_id']) : 0;
  $args->activity = isset($_REQUEST['activity']) ? $_REQUEST['activity'] : '';

  return $args;
}

/*
  function: doReorder
            writes to DB execution order of test case versions 
            linked to testplan.

  args: argsObj: user input data collected via HTML inputs
        tplanMgr: testplan manager object

  returns: -

*/
function doReorder(&$argsObj,&$tplanMgr)
{
    $mapo = null;
  
    // Do this to avoid update if order has not been changed on already linked items      
    if(!is_null($argsObj->linkedVersion))
    {
        // Using memory of linked test case, try to get order
        foreach($argsObj->linkedVersion as $tcid => $tcversion_id)
        {
            if($argsObj->linkedOrder[$tcid] != $argsObj->testcases2order[$tcid] )
            { 
                $mapo[$tcversion_id] = $argsObj->testcases2order[$tcid];
            }    
        }
    }
    
    // Now add info for new liked test cases if any
    if(!is_null($argsObj->testcases2add))
    {
        $tcaseSet = array_keys($argsObj->testcases2add);
        foreach($tcaseSet as $tcid)
        {
          // This check is needed because, after we have added test case
          // for a platform, this will not be present anymore
          // in tcversion_for_tcid, but it's present in  linkedVersion.
          // IMPORTANT:
          // We do not allow link of different test case version on a
          // testplan no matter we are using or not platform feature.
          //
            $tcversion_id=null;
          if( isset($argsObj->tcversion_for_tcid[$tcid]) )
          {
              $tcversion_id = $argsObj->tcversion_for_tcid[$tcid];
              //$mapo[$tcversion_id] = $argsObj->testcases2order[$tcid];
            }
            else if( isset($argsObj->linkedVersion[$tcid]) && 
                     !isset($mapo[$argsObj->linkedVersion[$tcid]]))
            {
              $tcversion_id = $argsObj->linkedVersion[$tcid];
            }
            if( !is_null($tcversion_id))
            {
              $mapo[$tcversion_id] = $argsObj->testcases2order[$tcid];
            }
        }
    }  
    
    if(!is_null($mapo))
    {
        $tplanMgr->setExecutionOrder($argsObj->tplan_id,$mapo);
    }
    
}


/*
  function: initializeGui

  args :
  
  returns: 

*/
function initializeGui(&$dbHandler,$argsObj,&$tplanMgr,&$tcaseMgr)
{
  
  $tcase_cfg = config_get('testcase_cfg');
  $title_separator = config_get('gui_title_separator_1');

  $gui = new stdClass();
  $gui->status_feeback = buildStatusFeedbackMsg();

  $gui->testCasePrefix = $tcaseMgr->tproject_mgr->getTestCasePrefix($argsObj->tproject_id);
  $gui->testCasePrefix .= $tcase_cfg->glue_character;

  $gui->can_remove_executed_testcases = $argsObj->user->hasRight($dbHandler,
                                                                 "testplan_unlink_executed_testcases",
                                                                 $argsObj->tproject_id,$argsObj->tplan_id);

  $tprojectInfo = $tcaseMgr->tproject_mgr->get_by_id($argsObj->tproject_id);
  $gui->priorityEnabled = $tprojectInfo['opt']->testPriorityEnabled;

  // $gui->keywordsFilterType = $argsObj->keywordsFilterType;
  // $gui->keywords_filter = '';
  $gui->has_tc = 0;
  $gui->items = null;
  $gui->has_linked_items = false;
    
  $gui->keywordsFilterType = new stdClass();
  $gui->keywordsFilterType->options = array('OR' => 'Or' , 'AND' =>'And'); 
  $gui->keywordsFilterType->selected=$argsObj->keywordsFilterType;
  $gui->keyword_id = $argsObj->keyword_id;

  $gui->keywords_filter_feedback = '';
  if( !is_null($gui->keyword_id) && $gui->keyword_id != 0 )
  {
    $gui->keywords_filter_feedback = 
      buildKeywordsFeedbackMsg($dbHandler,$argsObj,$gui); 
  }  


  // full_control, controls the operations planAddTC_m1.tpl will allow
  // 1 => add/remove
  // 0 => just remove
  $gui->full_control = 1;

  $tplan_info = $tplanMgr->get_by_id($argsObj->tplan_id);
  $gui->testPlanName = $tplan_info['name'];
  $gui->pageTitle = lang_get('test_plan') . $title_separator . $gui->testPlanName;
  $gui->refreshTree = $argsObj->refreshTree;
  $gui->canAssignExecTask = $argsObj->user->hasRight($dbHandler,"exec_assign_testcases",$argsObj->tproject_id,$argsObj->tplan_id);

  $tproject_mgr = new testproject($dbHandler);
  $tproject_info = $tproject_mgr->get_by_id($argsObj->tproject_id);

  $gui->testers = getTestersForHtmlOptions($dbHandler,$argsObj->tplan_id, $tproject_info);
  $gui->testerID = $argsObj->testerID;
  $gui->send_mail = $argsObj->send_mail;
  $gui->send_mail_checked = '';
  if($gui->send_mail)
  {
    $gui->send_mail_checked = ' checked="checked" ';
  }

  $platform_mgr = new tlPlatform($dbHandler, $argsObj->tproject_id);
  $gui->platforms = $platform_mgr->getLinkedToTestplan($argsObj->tplan_id);
  $gui->platformsForHtmlOptions = null;
  $gui->usePlatforms = $platform_mgr->platformsActiveForTestplan($argsObj->tplan_id);
  if($gui->usePlatforms)
  {
    // Create options for two different select boxes. $bulk_platforms
    // has "All platforms" on top and "$platformsForHtmlOptions" has an
    // empty item
    $gui->platformsForHtmlOptions[0]='';
    foreach($gui->platforms as $elem)
    {
      $gui->platformsForHtmlOptions[$elem['id']] =$elem['name'];
    }
    $gui->bulk_platforms = $platform_mgr->getLinkedToTestplanAsMap($argsObj->tplan_id);
    $gui->bulk_platforms[0] = lang_get("all_platforms");
    ksort($gui->bulk_platforms);
  }

  // 
  $gui->warning_msg = new stdClass();
  $gui->warning_msg->executed = lang_get('executed_can_not_be_removed');
  if( $gui->can_remove_executed_testcases )
  {
    $gui->warning_msg->executed = lang_get('has_been_executed');
  }

  $gui->build = init_build_selector($tplanMgr, $argsObj);

  return $gui;
}


/*
  function: doSaveCustomFields
            writes to DB value of custom fields displayed
            for test case versions linked to testplan.

  args: argsObj: user input data collected via HTML inputs
        tplanMgr: testplan manager object

  returns: -

*/
function doSaveCustomFields(&$argsObj,&$userInput,&$tplanMgr,&$tcaseMgr)
{
    // N.B.: I've use this piece of code also on write_execution(), think is time to create
    //       a method on cfield_mgr class.
    //       One issue: find a good method name
    $cf_prefix = $tcaseMgr->cfield_mgr->get_name_prefix();
  $len_cfp = tlStringLen($cf_prefix);
    $cf_nodeid_pos=4;
    
    $nodeid_array_cfnames=null;

    // Example: two test cases (21 and 19 are testplan_tcversions.id => FEATURE_ID)
    //          with 3 custom fields
    //
    // custom_field_[TYPE]_[CFIELD_ID]_[FEATURE_ID]
    //
    // (
    // [21] => Array
    //     (
    //         [0] => custom_field_0_3_21
    //         [1] => custom_field_0_7_21
    //         [5] => custom_field_6_9_21
    //     )
    // 
    // [19] => Array
    //     (
    //         [0] => custom_field_0_3_19
    //         [1] => custom_field_0_7_19
    //         [5] => custom_field_6_9_19
    //     )
    // )
    //    
    foreach($userInput as $input_name => $value)
    {
        if( strncmp($input_name,$cf_prefix,$len_cfp) == 0 )
        {
          $dummy=explode('_',$input_name);
          $nodeid_array_cfnames[$dummy[$cf_nodeid_pos]][]=$input_name;
        } 
    }
     
    // foreach($argsObj->linkedWithCF as $key => $link_id)
    foreach( $nodeid_array_cfnames as $link_id => $customFieldsNames)
    {   
      
      
        // Create a SubSet of userInput just with inputs regarding CF for a link_id
        // Example for link_id=21:
        //
        // $cfvalues=( 'custom_field_0_3_21' => A
        //             'custom_field_0_7_21' => 
        //             'custom_field_8_8_21_day' => 0
        //             'custom_field_8_8_21_month' => 0
        //             'custom_field_8_8_21_year' => 0
        //             'custom_field_6_9_21_' => Every day)
        //
        $cfvalues=null;
        foreach($customFieldsNames as $cf)
        {
           $cfvalues[$cf]=$userInput[$cf];
        }  
        $tcaseMgr->cfield_mgr->testplan_design_values_to_db($cfvalues,null,$link_id);
    }
}


/*
  function: doSavePlatforms
            writes to DB execution ... of test case versions linked to testplan.

  args: argsObj: user input data collected via HTML inputs
        tplanMgr: testplan manager object

  returns: -

*/
function doSavePlatforms(&$argsObj,&$tplanMgr)
{
  foreach($argsObj->feature2fix as $feature_id => $tcversion_platform)
  {
    $tcversion_id = key($tcversion_platform);
    $platform_id = current($tcversion_platform);
    if( $platform_id != 0 )
    {
      $tplanMgr->changeLinkedTCVersionsPlatform($argsObj->tplan_id,0,$platform_id,$tcversion_id);
    } 
  }
}


/**
 * send_mail_to_testers
 *
 *
 * @return void
 */
function send_mail_to_testers(&$dbHandler,&$tcaseMgr,&$guiObj,&$argsObj,$features,$operation)
{
  $testers['new']=null;
  $mail_details['new']=lang_get('mail_testcase_assigned') . "<br /><br />";
  $mail_subject['new']=lang_get('mail_subject_testcase_assigned');
  $use_testers['new']= true ;
   
  $tcaseSet=null;
  $tcnames=null;
  $email=array();
   
  $userSet[]=$argsObj->userID;
  $userSet[]=$argsObj->testerID;
    
  $userData=tlUser::getByIDs($dbHandler,$userSet);
  $assigner=$userData[$argsObj->userID]->firstName . ' ' . $userData[$argsObj->userID]->lastName ;
              
  $email['from_address']=config_get('from_email');
  $body_first_lines = lang_get('testproject') . ': ' . $argsObj->tproject_name . '<br />' .
                      lang_get('testplan') . ': ' . $guiObj->testPlanName .'<br /><br />';
        
  // Get testers id
  foreach($features as $feature_id => $value)
  {
    if($use_testers['new'])
    {
      $testers['new'][$value['user_id']][$value['tcase_id']]=$value['tcase_id'];              
    }
    $tcaseSet[$value['tcase_id']]=$value['tcase_id'];
    $tcversionSet[$value['tcversion_id']]=$value['tcversion_id'];
  } 
    
  $infoSet=$tcaseMgr->get_by_id_bulk($tcaseSet,$tcversionSet);
  foreach($infoSet as $value)
  {
    $tcnames[$value['testcase_id']] = $guiObj->testCasePrefix . $value['tc_external_id'] . ' ' . $value['name'];    
  }

  $path_info = $tcaseMgr->tree_manager->get_full_path_verbose($tcaseSet,array('output_format' => 'simple'));
  $flat_path=null;
  foreach($path_info as $tcase_id => $pieces)
  {
    $flat_path[$tcase_id]=implode('/',$pieces) . '/' . $tcnames[$tcase_id];  
  }
    
  $validator = new Zend_Validate_EmailAddress();
  foreach($testers as $tester_type => $tester_set)
  {
    if( !is_null($tester_set) )
    {
      $email['subject'] = $mail_subject[$tester_type] . ' ' . $guiObj->testPlanName;  
      foreach($tester_set as $user_id => $value)
      {
        $userObj=$userData[$user_id];
        $email['to_address'] = trim($userObj->emailAddress);
        if($email['to_address'] == '' || !$validator->isValid($email['to_address']))
        {
          continue;
        }  

        $email['body'] = $body_first_lines;
        $email['body'] .= sprintf($mail_details[$tester_type],
                                  $userObj->firstName . ' ' .$userObj->lastName,$assigner);
        
        foreach($value as $tcase_id)
        {
          $email['body'] .= $flat_path[$tcase_id] . '<br />';  
        }  
        $email['body'] .= '<br />' . date(DATE_RFC1123);

        $email['cc'] = '';
        $email['attachment'] = null;
        $email['exit_on_error'] = true;
        $email['htmlFormat'] = true; 

        $email_op = email_send($email['from_address'], $email['to_address'], 
                               $email['subject'], $email['body'],
                               $email['cc'],$email['attachment'],
                               $email['exit_on_error'],$email['htmlFormat']);
      } 
    }                       
  }
}


/**
 * initDrawSaveButtons
 *
 */
function initDrawSaveButtons(&$guiObj)
{
  $keySet = array_keys($guiObj->items);

  // 20100225 - eloff - BUGID 3205 - check only when platforms are active
  // Logic to initialize drawSavePlatformsButton.
  if ($guiObj->usePlatforms)
  {
    // Looks for a platform with id = 0
    foreach($keySet as $key)
    {
      $breakLoop = false;
      $testSuite = &$guiObj->items[$key];
      if($testSuite['linked_testcase_qty'] > 0)
      {
        $tcaseSet = array_keys($testSuite['testcases']);
        foreach($tcaseSet as $tcaseKey)
        {
          if( isset($testSuite['testcases'][$tcaseKey]['feature_id'][0]) )
          {
            $breakLoop = true;
            $guiObj->drawSavePlatformsButton = true;
            break;
          }
        }
      }
      if( $breakLoop )
      {
        break;
      }
    }
  }
    
    // Logic to initialize drawSaveCFieldsButton
  reset($keySet);
  foreach($keySet as $key)
  {
    $breakLoop = false;
    $tcaseSet = &$guiObj->items[$key]['testcases'];
    if( !is_null($tcaseSet) )
    {
      $tcversionSet = array_keys($tcaseSet);
      foreach($tcversionSet as $tcversionID)
      {
        if( isset($tcaseSet[$tcversionID]['custom_fields']) && 
            !is_null($tcaseSet[$tcversionID]['custom_fields']))
        {
          $breakLoop = true;
          $guiObj->drawSaveCFieldsButton = true;
          break;
        }
      }
    }
    if( $breakLoop )
    {
      break;
    }
  }
}


/**
 * 
 *
 */
function setAdditionalGuiData($guiObj)
{ 
  $actionTitle = 'title_remove_test_from_plan';
  $buttonValue = 'btn_remove_selected_tc';
    $guiObj->exec_order_input_disabled = 'disabled="disabled"';

    if( $guiObj->full_control )
  {
      $actionTitle = 'title_add_test_to_plan';
      $buttonValue = 'btn_add_selected_tc';
    if( $guiObj->has_linked_items )
    {
        $actionTitle = 'title_add_remove_test_to_plan';
        $buttonValue = 'btn_add_remove_selected_tc';
    }
    $guiObj->exec_order_input_disabled = ' ';
  }
  $guiObj->actionTitle = lang_get($actionTitle);
  $guiObj->buttonValue = lang_get($buttonValue);
}

/**
 * Initialize the HTML select box for selection of a build to which
 * user wants to assign testers which are added to testplan.
 * 
 * @author Andreas Simon
 * @param testplan $testplan_mgr reference to testplan manager object
 * @param object $argsObj reference to user input object
 * @return array $html_menu array structure with all information needed for the menu
 */
function init_build_selector(&$testplan_mgr, &$argsObj) {

  // init array
  $html_menu = array('items' => null, 'selected' => null, 'count' => 0);

  $html_menu['items'] = $testplan_mgr->get_builds_for_html_options($argsObj->tplan_id,
                                                                   testplan::GET_ACTIVE_BUILD,
                                                                   testplan::GET_OPEN_BUILD);
  $html_menu['count'] = count($html_menu['items']);
  
  // if no build has been chosen yet, select the newest build by default
  $build_id = $argsObj->build_id;
  if (!$build_id && $html_menu['count']) {
    $keys = array_keys($html_menu['items']);
    $build_id = end($keys);
  }
  $html_menu['selected'] = $build_id;
  
  return $html_menu;
} // end of method

/**
 *
 */ 
function addToTestPlan(&$dbHandler,&$argsObj,&$guiObj,&$tplanMgr,&$tcaseMgr)
{
  // items_to_link structure:
  // key: test case id , value: map 
  //                            key: platform_id value: test case VERSION ID
  $items_to_link = null;
  foreach ($argsObj->testcases2add as $tcase_id => $info) 
  {
    foreach ($info as $platform_id => $tcase_id) 
    {
      if( isset($argsObj->tcversion_for_tcid[$tcase_id]) )
      {
        $tcversion_id = $argsObj->tcversion_for_tcid[$tcase_id];
      }
      else
      {
        $tcversion_id = $argsObj->linkedVersion[$tcase_id];
      }
      $items_to_link['tcversion'][$tcase_id] = $tcversion_id;
      $items_to_link['platform'][$platform_id] = $platform_id;
      $items_to_link['items'][$tcase_id][$platform_id] = $tcversion_id;
    }
  }

  $linked_features=$tplanMgr->link_tcversions($argsObj->tplan_id,$items_to_link,$argsObj->userID);

  if( $argsObj->testerID > 0 )
  {
    $features2add = null;
    $status_map = $tplanMgr->assignment_mgr->get_available_status();
    $types_map = $tplanMgr->assignment_mgr->get_available_types();
    $db_now = $dbHandler->db_now();
    $tcversion_tcase = array_flip($items_to_link['tcversion']);
                
    $getOpt = array('outputFormat' => 'map', 'addIfNull' => true);
    $platformSet = $tplanMgr->getPlatforms($argsObj->tplan_id,$getOpt);
                
    foreach($linked_features as $platform_id => $tcversion_info)
    {
      foreach($tcversion_info as $tcversion_id => $feature_id)
      {
        $features2['add'][$feature_id]['user_id'] = $argsObj->testerID;
        $features2['add'][$feature_id]['type'] = $types_map['testcase_execution']['id'];
        $features2['add'][$feature_id]['status'] = $status_map['open']['id'];
        $features2['add'][$feature_id]['assigner_id'] = $argsObj->userID;
        $features2['add'][$feature_id]['tcase_id'] = $tcversion_tcase[$tcversion_id];
        $features2['add'][$feature_id]['tcversion_id'] = $tcversion_id;
        $features2['add'][$feature_id]['creation_ts'] = $db_now;
        $features2['add'][$feature_id]['platform_name'] = $platformSet[$platform_id];
        $features2['add'][$feature_id]['build_id'] = $argsObj->build_id;
      }
    }
        
    foreach($features2 as $key => $values)
    {
      $tplanMgr->assignment_mgr->assign($values);
      $called[$key]=true;
    }
    
    if($argsObj->send_mail)
    {
      foreach($called as $ope => $ope_status)
      {
        if($ope_status)
        {
          send_mail_to_testers($dbHandler,$tcaseMgr,$guiObj,$argsObj,$features2['add'],$ope);     
        }
      }
    }
  }
}

/**
 *
 *
 */
function buildStatusFeedbackMsg()
{
  $ret = '';  
  $hideStatusSet = config_get('tplanDesign')->hideTestCaseWithStatusIn;
  if( !is_null($hideStatusSet) )
  {
    $cfx = getConfigAndLabels('testCaseStatus');
    $sc = array_flip($cfx['cfg']);
    $msg = array();
    foreach( $hideStatusSet as $code => $verbose)
    {
      $msg[] = $cfx['lbl'][$sc[$code]];
    }  
    $ret = 
      sprintf(lang_get('hint_add_testcases_to_testplan_status'),implode(',',$msg));
  }

  return $ret;
}

/**
 *
 */
function buildKeywordsFeedbackMsg(&$dbHandler,&$argsObj,&$gui)
{
  $opx = array('tproject_id' => $argsObj->tproject_id, 
               'cols' => 'id,keyword', 'accessKey' => 'id');

  $kwSet = tlKeyword::getSimpleSet($dbHandler, $opx);
  $msg = array();
  $k2s = (array)$gui->keyword_id;
  foreach( $k2s as $idt )
  {
    $msg[] = $kwSet[$idt]['keyword'];
  }  
  return implode(',',$msg); 
}