/lib/plan/tc_exec_assignment.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 		Francisco Mancardi (francisco.mancardi@gmail.com)

 * @copyright 	2005-2009, TestLink community 

 * @version    	CVS: $Id: tc_exec_assignment.php,v 1.56 2010/08/10 21:55:39 erikeloff Exp $

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

 *

 * @internal revisions:

 * 20100721 - asimon - BUGID 3406 - testcase execution assignment per build

 * 20100326 - amitkhullar - BUGID 3346: Update the date on updating test case asssigments

 * 20100228 - franciscom - BUGID 3226: Assignment of single test case not possible

 * 20100225 - eloff - remove unnecessary call to platformVisibleForTestplan

 * 20100215 - asimon - BUGID 2455, BUGID 3026

 * 20100212 - eloff - BUGID 3157 - fixes reassignment to other user

 * 20090807 - franciscom - new feature platforms

 * 20090201 - franciscom - new feature send mail to tester

 * 20080312 - franciscom - BUGID 1427

 * 20080114 - franciscom - added testcase external_id management

 * 20071228 - franciscom - BUG build combo of users using only users

 *                         that can execute test cases in testplan.

 * 20070912 - franciscom - BUGID 1041

 */

         

require_once(dirname(__FILE__)."/../../config.inc.php");

require_once("common.php");

require_once("treeMenu.inc.php");

require_once('email_api.php');

require_once("specview.php");



testlinkInitPage($db,false,false,"checkRights");



$tree_mgr = new tree($db); 

$tplan_mgr = new testplan($db); 

$tcase_mgr = new testcase($db); 

$assignment_mgr = new assignment_mgr($db); 



$templateCfg = templateConfiguration();



$args = init_args();

$gui = initializeGui($db,$args,$tplan_mgr,$tcase_mgr);

$keywordsFilter = new stdClass();

$keywordsFilter->items = null;

$keywordsFilter->type = null;

if(is_array($args->keyword_id))

{

    $keywordsFilter->items = $args->keyword_id;

    $keywordsFilter->type = $gui->keywordsFilterType;

}

$arrData = array();



if(!is_null($args->doAction))

{

	if(!is_null($args->achecked_tc))

	{

		$types_map = $assignment_mgr->get_available_types();

		$status_map = $assignment_mgr->get_available_status();



		$task_test_execution = $types_map['testcase_execution']['id'];

		$open = $status_map['open']['id'];

		$db_now = $db->db_now();



        $features2 = array( 'upd' => array(), 'ins' => array(), 'del' => array());

	    $method2call = array( 'upd' => 'update', 'ins' => 'assign', 'del' => 'delete_by_feature_id');

	    $called = array( 'upd' => false, 'ins' => false, 'del' => false);



		foreach($args->achecked_tc as $key_tc => $platform_tcversion)

		{

			foreach($platform_tcversion as $platform_id => $tcversion_id)

			{

				$feature_id = $args->feature_id[$key_tc][$platform_id];

				if($args->has_prev_assignment[$key_tc][$platform_id] > 0)

				{

					if($args->tester_for_tcid[$key_tc][$platform_id] > 0)

					{

            	        // Do only if tester has changed

					    if( $args->has_prev_assignment[$key_tc][$platform_id] != $args->tester_for_tcid[$key_tc][$platform_id])

					    {

				            $op='upd';

						    $features2[$op][$feature_id]['user_id'] = $args->tester_for_tcid[$key_tc][$platform_id];

						    $features2[$op][$feature_id]['type'] = $task_test_execution;

						    $features2[$op][$feature_id]['status'] = $open;

						    $features2[$op][$feature_id]['assigner_id'] = $args->user_id;

						    $features2[$op][$feature_id]['tcase_id'] = $key_tc;

						    $features2[$op][$feature_id]['tcversion_id'] = $tcversion_id;

            	            $features2[$op][$feature_id]['previous_user_id'] = $args->has_prev_assignment[$key_tc][$platform_id];					    

            	            $features2[$op][$feature_id]['creation_ts'] = $db_now; //BUGID 3346

            	            $features2[$op][$feature_id]['build_id'] = $args->build_id; // BUGID 3406

						}

					} 

					else

					{

            	        $op='del';

						$features2[$op][$feature_id]['tcase_id'] = $key_tc;

						$features2[$op][$feature_id]['tcversion_id'] = $tcversion_id;

            	        $features2[$op][$feature_id]['previous_user_id'] = $args->has_prev_assignment[$key_tc][$platform_id];

            	        $features2[$op][$feature_id]['build_id'] = $args->build_id; // BUGID 3406					    

					}	

				}

				else if($args->tester_for_tcid[$key_tc][$platform_id] > 0)

				{

				    $op='ins';

					$features2[$op][$feature_id]['user_id'] = $args->tester_for_tcid[$key_tc][$platform_id];

					$features2[$op][$feature_id]['type'] = $task_test_execution;

					$features2[$op][$feature_id]['status'] = $open;

					$features2[$op][$feature_id]['creation_ts'] = $db_now;

					$features2[$op][$feature_id]['assigner_id'] = $args->user_id;

					$features2[$op][$feature_id]['tcase_id'] = $key_tc;

					$features2[$op][$feature_id]['tcversion_id'] = $tcversion_id;

					$features2[$op][$feature_id]['build_id'] = $args->build_id; // BUGID 3406

				}

			}

			

		}

		

	    foreach($features2 as $key => $values)

	    {

	        if( count($features2[$key]) > 0 )

	        {

	            if( $key == 'del' )

	            {

	                $assignment_mgr->$method2call[$key](array_keys($values));

	            }

	            else

	            {

	           	    $assignment_mgr->$method2call[$key]($values);

	           	}

	           	$called[$key]=true;

	        }  

	    }

				

		if($args->send_mail)

		{

		    foreach($called as $ope => $ope_status)

		    {

	            if($ope_status)

	            {

	                send_mail_to_testers($db,$tcase_mgr,$gui,$args,$features2[$ope],$ope);     

		        }

		    }

		}	// if($args->send_mail)		

	}  

}





switch($args->level)

{

	case 'testcase':

		// build the data need to call gen_spec_view

        $xx=$tcase_mgr->getPathLayered(array($args->id));

        $yy = array_keys($xx);  // done to silence warning on end()

        $tsuite_data['id'] = end($yy);

        $tsuite_data['name'] = $xx[$tsuite_data['id']]['value']; 

		

		// 20100228 - franciscom - BUGID 3226: Assignment of single test case not possible

        $getFilters = array('tcase_id' => $args->id);

        

        // 3406

        //$getOptions = array('output' => 'mapOfArray');

        $getOptions = array('output' => 'mapOfArray', 'user_assignments_per_build' => $args->build_id);

		$linked_items = $tplan_mgr->get_linked_tcversions($args->tplan_id,$getFilters,$getOptions);



		$filters = array('keywords' => $keywordsFilter->items );	

		

		// 3406

		//$opt = array('write_button_only_if_linked' => 1);

		$opt = array('write_button_only_if_linked' => 1, 'user_assignments_per_build' => $args->build_id);

		

		$my_out = gen_spec_view($db,'testplan',$args->tplan_id,$tsuite_data['id'],$tsuite_data['name'],

						        $linked_items,null,$filters,$opt);

		

		// index 0 contains data for the parent test suite of this test case, 

		// other elements are not needed.

		$out = array();

		$out['spec_view'][0] = $my_out['spec_view'][0];

		$out['num_tc'] = 1;

		break;

		

	case 'testsuite':

		// BUGID 3026

		// BUGID 3516

		$tcaseFilter = (isset($args->testcases_to_show)) ? $args->testcases_to_show : null;

		

		// 3406

		$opt = array('user_assignments_per_build' => $args->build_id);

		$out = keywordFilteredSpecView($db, $args, $keywordsFilter, $tplan_mgr,

		                               $tcase_mgr, $tcaseFilter, $opt);

				

		break;



	default:

		show_instructions('tc_exec_assignment');

		break;

}



$gui->items = $out['spec_view'];



// useful to avoid error messages on smarty template.

$gui->items_qty = is_null($gui->items) ? 0 : count($gui->items);

$gui->has_tc = $out['num_tc'] > 0 ? 1:0;

$gui->support_array = array_keys($gui->items);



if ($_SESSION['testprojectOptions']->testPriorityEnabled) 

{

	$urgencyCfg = config_get('urgency');

	$gui->priority_labels = init_labels($urgencyCfg["code_label"]);

}



$smarty = new TLSmarty();

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

$smarty->display($templateCfg->template_dir . $templateCfg->default_template);





/*

  function: 



  args :

  

  returns: 



*/

function init_args()

{

	  $_REQUEST = strings_stripSlashes($_REQUEST);

	  $args = new stdClass();

	  $args->user_id = $_SESSION['userID'];

	  $args->tproject_id = $_SESSION['testprojectID'];

	  $args->tproject_name = $_SESSION['testprojectName'];

      

//	  $args->tplan_id = isset($_REQUEST['tplan_id']) ? $_REQUEST['tplan_id'] : $_SESSION['testplanID'];

//	  $key2loop = array('doAction' => null,'level' => null , 'achecked_tc' => null, 

//	    	              'version_id' => 0, 'has_prev_assignment' => null, 'send_mail' => false,

//	    	              'tester_for_tcid' => null, 'feature_id' => null, 'id' => 0, 'filter_assigned_to' => null);

	  $key2loop = array('doAction' => null,'level' => null , 'achecked_tc' => null, 

	    	              'version_id' => 0, 'has_prev_assignment' => null, 'send_mail' => false,

	    	              'tester_for_tcid' => null, 'feature_id' => null, 'id' => 0);

	  

	  foreach($key2loop as $key => $value)

	  {

	  	$args->$key = isset($_REQUEST[$key]) ? $_REQUEST[$key] : $value;

	  }

    

    // Can be a list (string with , (comma) has item separator), that will be trasformed in an array.

//    $keywordSet = isset($_REQUEST['keyword_id']) ? $_REQUEST['keyword_id'] : null;

//    $args->keyword_id = is_null($keywordSet) ? 0 : explode(',',$keywordSet); 

//    $args->keywordsFilterType = isset($_REQUEST['keywordsFilterType']) ? $_REQUEST['keywordsFilterType'] : 'OR';

//    

//    if( !is_null($args->filter_assigned_to) )

//    {

//        $args->filter_assigned_to = (array)$args->filter_assigned_to;  

//    }

    

 	// BUGID 2455, BUGID 3026

//	if (isset($_REQUEST['show_only_tcs']) && isset($_REQUEST['show_only_tcs']) != '') 

//	{

//		$args->tcids_to_show = explode(",", $_REQUEST['show_only_tcs']);

//	}

	

	// BUGID 3516

	

	// For more information about the data accessed in session here, see the comment

	// in the file header of lib/functions/tlTestCaseFilterControl.class.php.

	$form_token = isset($_REQUEST['form_token']) ? $_REQUEST['form_token'] : 0;

	

	$mode = 'plan_mode';

	

	$session_data = isset($_SESSION[$mode]) && isset($_SESSION[$mode][$form_token])

	                ? $_SESSION[$mode][$form_token] : null;

	

	$args->refreshTree = isset($session_data['setting_refresh_tree_on_action']) ?

                         $session_data['setting_refresh_tree_on_action'] : 0;

    

    $args->keyword_id = 0;

	$fk = 'filter_keywords';

	if (isset($session_data[$fk])) {

		$args->keyword_id = $session_data[$fk];

		if (is_array($args->keyword_id) && count($args->keyword_id) == 1) {

			$args->keyword_id = $args->keyword_id[0];

		}

	}

	

	$args->keywordsFilterType = null;

	$ft = 'filter_keywords_filter_type';

	if (isset($session_data[$ft])) {

		$args->keywordsFilterType = $session_data[$ft];

	}

	

	$args->filter_assigned_to = isset($session_data['filter_assigned_user']) ? 

	                            $session_data['filter_assigned_user'] : null;

	

	$args->testcases_to_show = null;

	if (isset($session_data['testcases_to_show'])) {

		$args->testcases_to_show = $session_data['testcases_to_show'];

	}

	

	// BUGID 3406

	$args->build_id = isset($session_data['setting_build']) ? $session_data['setting_build'] : 0;

	$args->tplan_id = isset($session_data['setting_testplan']) ? $session_data['setting_testplan'] : 0;

	if ($args->tplan_id) {

		$args->tplan_id = isset($_REQUEST['tplan_id']) ? $_REQUEST['tplan_id'] : $_SESSION['testplanID'];

	}

		

	return $args;

}



/*

  function: initializeGui



  args :

  

  returns: 



*/

function initializeGui(&$dbHandler,$argsObj,&$tplanMgr,&$tcaseMgr)

{

	$platform_mgr = new tlPlatform($dbHandler,$argsObj->tproject_id);

	

    $tcase_cfg = config_get('testcase_cfg');

    $gui = new stdClass();

    $gui->platforms = $platform_mgr->getLinkedToTestplanAsMap($argsObj->tplan_id);

    $gui->usePlatforms = $platform_mgr->platformsActiveForTestplan($argsObj->tplan_id);

    $gui->bulk_platforms = $platform_mgr->getLinkedToTestplanAsMap($argsObj->tplan_id);

    $gui->bulk_platforms[0] = lang_get("all_platforms");

    ksort($gui->bulk_platforms);

    

    $gui->send_mail = $argsObj->send_mail;

    $gui->send_mail_checked = "";

    if($gui->send_mail)

    {

    	$gui->send_mail_checked = ' checked="checked" ';

    }

    

    $gui->glueChar=$tcase_cfg->glue_character;

    

    if ($argsObj->level != 'testproject')

    {

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

	    $gui->testCasePrefix .= $tcase_cfg->glue_character;

									  

	    $gui->keywordsFilterType = $argsObj->keywordsFilterType;

	

	    $tplan_info = $tplanMgr->get_by_id($argsObj->tplan_id);

	    $gui->testPlanName = $tplan_info['name'];

	    

	    // 3406

	    $build_info = $tplanMgr->get_build_by_id($argsObj->tplan_id, $argsObj->build_id);

	    $gui->buildName = $build_info['name'];

	    $gui->main_descr = sprintf(lang_get('title_tc_exec_assignment'), 

	                               $gui->buildName, $gui->testPlanName);

	    

	    $gui->all_users = tlUser::getAll($dbHandler,null,"id",null);

	   	$gui->users = getUsersForHtmlOptions($dbHandler,null,null,null,$gui->all_users);

	   	$gui->testers = getTestersForHtmlOptions($dbHandler,$argsObj->tplan_id,$argsObj->tproject_id,$gui->all_users);

	}



    return $gui;

}





/**

 * send_mail_to_testers

 *

 *

 * @return void

 */

function send_mail_to_testers(&$dbHandler,&$tcaseMgr,&$guiObj,&$argsObj,$features,$operation)

{

    $testers['new']=null;

    $testers['old']=null;

    $mail_details['new']=lang_get('mail_testcase_assigned') . "<br /><br />";

    $mail_details['old']=lang_get('mail_testcase_assignment_removed'). "<br /><br />";

    $mail_subject['new']=lang_get('mail_subject_testcase_assigned');

    $mail_subject['old']=lang_get('mail_subject_testcase_assignment_removed');

    $use_testers['new']= ($operation == 'del') ? false : true ;

    $use_testers['old']= ($operation == 'ins') ? false : true ;

   



    $tcaseSet=null;

    $tcnames=null;

    $email=array();

   

    $assigner=$guiObj->all_users[$argsObj->user_id]->firstName . ' ' .

              $guiObj->all_users[$argsObj->user_id]->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'];              

        }

        if( $use_testers['old'] )

        {

            $testers['old'][$value['previous_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);

    $flat_path=null;

    foreach($path_info as $tcase_id => $pieces)

    {

        $flat_path[$tcase_id]=implode('/',$pieces) . '/' . $tcnames[$tcase_id];  

    }





    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=$guiObj->all_users[$user_id];

                $email['to_address']=$userObj->emailAddress;

                $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_op = email_send($email['from_address'], $email['to_address'], 

  	            		$email['subject'], $email['body'], '', true, true);

            } // foreach($tester_set as $user_id => $value)

  	    }                       

    }

}



function checkRights(&$db,&$user)

{

	return $user->hasRight($db,'testplan_planning');

}

?>