buildEdit.php | searchcode

/lib/plan/buildEdit.php

https://bitbucket.org/pfernandez/testlink1.9.6
PHP | 574 lines | 369 code | 73 blank | 132 comment | 45 complexity | d0f0fdf62be7ed7e754e95f1bd076bfa MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1, GPL-3.0

<?php

/**

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

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

 *

 * Filename $RCSfile: buildEdit.php,v $

 *

 * @version $Revision: 1.27 $

 * @modified $Date: 2010/08/20 13:42:43 $ $Author: franciscom $

 *

 * @internal revision

 *	20100820 - franciscom - init_source_build_selector() - refactoring

 *							refactoring to use only one variable ($gui) in interface to smarty

 *  20100726 - asimon - added number of existing assignments to source build selection

 *  20100707 - asimon - BUGID 3406: copy user assignments from other builds

 *                                  on creation of new builds

 *	20100706 - franciscom - BUGID 3581 added better check on release date

 *	20091121 - franciscom - BUGID - contribution

 *  20090509 - franciscom - BUGID - release_date

 *  20080827 - franciscom - BUGID 1692

*/

require('../../config.inc.php');

require_once("common.php");

require_once("web_editor.php");

$editorCfg = getWebEditorCfg('build');

require_once(require_web_editor($editorCfg['type']));



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

$templateCfg = templateConfiguration();





$op = new stdClass();

$op->user_feedback = '';

$op->buttonCfg = new stdClass();

$op->buttonCfg->name = "";

$op->buttonCfg->value = "";



$smarty = new TLSmarty();

$tplan_mgr = new testplan($db);

$build_mgr = new build_mgr($db);



$args = init_args($_REQUEST,$_SESSION);

$gui = new stdClass();

$gui->main_descr = lang_get('title_build_2') . config_get('gui_title_separator_2') . 

                   lang_get('test_plan') . config_get('gui_title_separator_1') . $args->tplan_name;



$of = web_editor('notes',$_SESSION['basehref'],$editorCfg);

$of->Value = getItemTemplateContents('build_template', $of->InstanceName, $args->notes);







switch($args->do_action)

{

	case 'edit':

	  	$op = edit($args,$build_mgr);

        $gui->closed_on_date = $args->closed_on_date;

		$of->Value = $op->notes;

		break;



	case 'create':

	  	$op = create($args);

        $gui->closed_on_date = $args->closed_on_date;

		break;



	case 'do_delete':

	  	$op = doDelete($args,$build_mgr);

		break;



	case 'do_update':

	  	$op = doUpdate($args,$build_mgr,$tplan_mgr);

		$of->Value = $op->notes;

		$templateCfg->template = $op->template;

		break;



	case 'do_create':

	  	$op = doCreate($args,$build_mgr,$tplan_mgr);

		$of->Value = $op->notes;

		$templateCfg->template = $op->template;

		break;



}



$gui->release_date = $args->release_date;

$gui->operation_descr = $op->operation_descr;

$gui->user_feedback = $op->user_feedback;

$gui->buttonCfg = $op->buttonCfg;

$gui->mgt_view_events = $_SESSION['currentUser']->hasRight($db,"mgt_view_events");

$gui->editorType = $editorCfg['type'];



if(trim($gui->release_date) == '')

{

    $gui->release_date = '0000-00-00';

}



renderGui($smarty,$args,$tplan_mgr,$templateCfg,$of,$gui);





/*

 * INITialize page ARGuments, using the $_REQUEST and $_SESSION

 * super-global hashes.

 * Important: changes in HTML input elements on the Smarty template

 *            must be reflected here.

 *

 *

 * @parameter hash request_hash the $_REQUEST

 * @parameter hash session_hash the $_SESSION

 * @return    object with html values tranformed and other

 *                   generated variables.

 * @internal revisions:

 *   20100707 - asimon - BUGID 3406 - added source_build_id and copy_tester_assignments

*/

function init_args($request_hash, $session_hash)

{

	$args = new stdClass();

	$request_hash = strings_stripSlashes($request_hash);



	$nullable_keys = array('notes','do_action','build_name');

	foreach($nullable_keys as $value)

	{

		$args->$value = isset($request_hash[$value]) ? $request_hash[$value] : null;

	}



	// BUGID 3406 - added source_build_id

	$intval_keys = array('build_id' => 0, 'source_build_id' => 0);

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

	{

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

	}



	// BUGID 3406 - added copy_tester_assignments

	$bool_keys = array('is_active' => 0, 'is_open' => 0, 'copy_to_all_tplans' => 0,

	                   'copy_tester_assignments' => 0);

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

	{

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

	}



    $args->release_date = '';

    $args->closed_on_date = isset($request_hash['closed_on_date']) ? $request_hash['closed_on_date'] : null;

   

    // Important!!!  

    // name of these variables is generated by smarty (See html_select_date in Smarty Manual)

    $date_vars = array('release_date_Year','release_date_Month','release_date_Day');

    $create_date = true;

    foreach($date_vars as $my)

    {

        $$my = isset($_REQUEST[$my]) ? $_REQUEST[$my] : null;     

        $create_date = $create_date && !is_null($$my) && trim($$my) != ''; 

    }

    if($create_date)

    {

        $args->release_date = $release_date_Year . "-" . $release_date_Month . "-" . $release_date_Day;

    } 



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

	$args->tplan_name = isset($session_hash['testplanName']) ? $session_hash['testplanName']: '';

	$args->testprojectID = $session_hash['testprojectID'];

	$args->testprojectName = $session_hash['testprojectName'];

	$args->userID = $session_hash['userID'];



	return $args;

}





/*

  function: edit

            edit action

            

  args :



  returns:



*/

function edit(&$argsObj,&$buildMgr)

{

	$binfo = $buildMgr->get_by_id($argsObj->build_id);

	$op = new stdClass();

	$op->buttonCfg = new stdClass();

	$op->buttonCfg->name = "do_update";

	$op->buttonCfg->value = lang_get('btn_save');

	$op->notes = $binfo['notes'];

	$op->user_feedback = '';



	$argsObj->build_name = $binfo['name'];

	$argsObj->is_active = $binfo['active'];

	$argsObj->is_open = $binfo['is_open'];

	$argsObj->release_date = $binfo['release_date'];



	if( $binfo['closed_on_date'] == '')

	{

	    $argsObj->closed_on_date = mktime(0, 0, 0, date("m")  , date("d"), date("Y"));

	}    

	else

	{    

	    $datePieces = explode("-",$binfo['closed_on_date']);

	    $argsObj->closed_on_date = mktime(0,0,0,$datePieces[1],$datePieces[2],$datePieces[0]);

	}

	

	$op->operation_descr=lang_get('title_build_edit') . TITLE_SEP_TYPE3 . $argsObj->build_name;



    return $op;

}



/*

  function: create

            prepares environment to manage user interaction on a create operations

 

  args: $argsObj: reference to input values received by page.



  returns: object with part of gui configuration



*/

function create(&$argsObj)

{

	$op = new stdClass();

    $op->operation_descr = lang_get('title_build_create');

	$op->buttonCfg = new stdClass();

	$op->buttonCfg->name = "do_create";

	$op->buttonCfg->value = lang_get('btn_create');

	$op->user_feedback = '';

	$argsObj->is_active = 1;

	$argsObj->is_open = 1;

	$argsObj->closed_on_date = mktime(0, 0, 0, date("m")  , date("d"), date("Y"));



    return $op;

}



/*

  function: doDelete



  args :



  returns:



*/

function doDelete(&$argsObj,&$buildMgr)

{

	$op = new stdClass();

    $op->user_feedback = '';

    $op->operation_descr = '';

    $op->buttonCfg = null;



	$build = $buildMgr->get_by_id($argsObj->build_id);

	if (!$buildMgr->delete($argsObj->build_id))

	{

		$op->user_feedback = lang_get("cannot_delete_build");

	}

	else

	{

		logAuditEvent(TLS("audit_build_deleted",$argsObj->testprojectName,$argsObj->tplan_name,$build['name']),

		              "DELETE",$argsObj->build_id,"builds");

    }

    return $op;

}



/*

  function:



  args :



  returns:



*/

function renderGui(&$smartyObj,&$argsObj,&$tplanMgr,$templateCfg,$owebeditor,&$guiObj)

{

    $doRender = false;

    switch($argsObj->do_action)

    {

    	case "do_create":

    	case "do_delete":

    	case "do_update":

       	    $doRender = true;

    		$tpl = is_null($templateCfg->template) ? 'buildView.tpl' : $templateCfg->template;

    		break;



    	case "edit":

    	case "create":

        	$doRender = true;

    		$tpl = is_null($templateCfg->template) ? $templateCfg->default_template : $templateCfg->template;

    		break;

    }



    if($doRender)

    {

      	$enable_copy = ($argsObj->do_action == 'create' || $argsObj->do_action == 'do_create') ? 1 : 0;

   		

   		// Attention this is affected by changes in templates

   		$guiObj->buildSet=$tplanMgr->get_builds($argsObj->tplan_id);

   		$guiObj->tplan_name=$argsObj->tplan_name;

    	$guiObj->build_id = $argsObj->build_id;

    	$guiObj->build_name = $argsObj->build_name;

    	$guiObj->is_active = $argsObj->is_active;

    	$guiObj->is_open = $argsObj->is_open;

    	$guiObj->notes = $owebeditor->CreateHTML();

    	$guiObj->enable_copy = $enable_copy;

   		

    	// BUGID 3406

    	$html_menu = init_source_build_selector($tplanMgr, $argsObj);

    	$guiObj->source_build = $html_menu;

    	$guiObj->copy_tester_assignments = $argsObj->copy_tester_assignments;

   		

   		$smartyObj->assign('gui',$guiObj);

  		$smartyObj->display($templateCfg->template_dir . $tpl);

    }



}





/*

  function: doCreate



  args :



  returns:



  @internal revisions:

    20100722 - asimon - BUGID 3406 - using assignment_mgr of tplan_mgr instead of new one

    20100707 - asimon - BUGID 3406 - added assignment_mgr to copy assignments

*/

function doCreate(&$argsObj,&$buildMgr,&$tplanMgr) //,&$smartyObj)

{

	$op = new stdClass();

	$op->operation_descr = '';

	$op->user_feedback = '';

	$op->template = "buildEdit.tpl";

	$op->notes = $argsObj->notes;

	$op->status_ok = false;

	$op->buttonCfg = null;



	$check = crossChecks($argsObj,$tplanMgr);

    $targetDate=null;

	if($check->status_ok)

	{

		$user_feedback = lang_get("cannot_add_build");

		$buildID = $buildMgr->create($argsObj->tplan_id,$argsObj->build_name,$argsObj->notes,

		                             $argsObj->is_active,$argsObj->is_open,$argsObj->release_date);

		if ($buildID)

		{

		    if($argsObj->is_open == 1)

		    {

		        $targetDate=null;

		    } 

		    else

		    {

		        $targetDate=date("Y-m-d",$argsObj->closed_on_date);    

		    }

	        $buildMgr->setClosedOnDate($buildID,$targetDate);    

			

	        // BUGID 3406 - copy tester assignments from chosen source build

	        if ($argsObj->copy_tester_assignments && $argsObj->source_build_id) {

	        	$tplanMgr->assignment_mgr->copy_assignments($argsObj->source_build_id, $buildID, $argsObj->userID);

	        }

	        

			$op->user_feedback = '';

			$op->notes = '';

			$op->template = null;

			$op->status_ok = true;

			logAuditEvent(TLS("audit_build_created",$argsObj->testprojectName,$argsObj->tplan_name,$argsObj->build_name),

							"CREATE",$buildID,"builds");

		}

	}

	if(!$op->status_ok)

	{

		$op->buttonCfg = new stdClass();

		$op->buttonCfg->name = "do_create";

		$op->buttonCfg->value = lang_get('btn_create');

		$op->user_feedback = $check->user_feedback;

	}

	elseif($argsObj->copy_to_all_tplans)

	{

		doCopyToTestPlans($argsObj,$buildMgr,$tplanMgr);

	}

	return $op;

}





/*

  function: doUpdate



  args :



  returns:



*/

function doUpdate(&$argsObj,&$buildMgr,&$tplanMgr)

{

	$op = new stdClass();

	$op->operation_descr = '';

	$op->user_feedback = '';

	$op->template = "buildEdit.tpl";

	$op->notes = $argsObj->notes;

	$op->status_ok = false;

	$op->buttonCfg = null;



    $oldObjData = $buildMgr->get_by_id($argsObj->build_id);

    $oldname = $oldObjData['name'];



	$check = crossChecks($argsObj,$tplanMgr);

	if($check->status_ok)

	{

		$user_feedback = lang_get("cannot_update_build");

		if ($buildMgr->update($argsObj->build_id,$argsObj->build_name,$argsObj->notes,

		                      $argsObj->is_active,$argsObj->is_open,$argsObj->release_date))

		{

		    

		    if( $argsObj->closed_on_date == '')

	        {

	            $argsObj->closed_on_date = mktime(0, 0, 0, date("m")  , date("d"), date("Y"));

	        }

		    

   		    if($argsObj->is_open == 1)

		    {

   		        $targetDate=null;

		    } 

		    else

		    {

		        $targetDate=date("Y-m-d",$argsObj->closed_on_date);    

		    }

            $buildMgr->setClosedOnDate($argsObj->build_id,$targetDate);    



		    

		    

			$op->user_feedback = '';

			$op->notes = '';

			$op->template = null;

			$op->status_ok = true;

			logAuditEvent(TLS("audit_build_saved",$argsObj->testprojectName,$argsObj->tplan_name,$argsObj->build_name),

			              "SAVE",$argsObj->build_id,"builds");

		}

	}



	if(!$op->status_ok)

	{

		$op->operation_descr = lang_get('title_build_edit') . TITLE_SEP_TYPE3 . $oldname;

		$op->buttonCfg = new stdClass();

		$op->buttonCfg->name = "do_update";

		$op->buttonCfg->value = lang_get('btn_save');

		$op->user_feedback = $check->user_feedback;

	}

	return $op;

}



/*

  function: crossChecks

            do checks that are common to create and update operations

            - name already exists in this testplan?

  args:



  returns: -



  @internal revision

  20100706 - franciscom - BUGID 3581		

*/

function crossChecks($argsObj,&$tplanMgr)

{

	$op = new stdClass();

	$op->user_feedback = '';

	$op->status_ok = 1;

	$buildID = ($argsObj->do_action == 'do_update') ? $argsObj->build_id : null;

	if( $tplanMgr->check_build_name_existence($argsObj->tplan_id,$argsObj->build_name,$buildID) )

	{

	    $op->user_feedback = lang_get("warning_duplicate_build") . TITLE_SEP_TYPE3 . $argsObj->build_name;

	    $op->status_ok = 0;

	}

	

	// check is date is valid

	if( $op->status_ok )

	{

		$datestring = 'YYYY-MM-DD';

		$ok_len = strlen($datestring);

		$ok_pieces_qty = 3;

		

		$rdate = trim($argsObj->release_date);

		$rdate_len = strlen($rdate) ;

		if( $rdate_len != 0 && $rdate_len != $ok_len )

		{

	    	$op->status_ok = 0;

		}

	    else if ($rdate_len == $ok_len )

	    {

	    	// cut in pieces

	    	$idx_year = 0;

	    	$idx_month = 1;

	    	$idx_day = 2;

	    	$date_pieces = explode('-',$rdate);

	    	if( count($date_pieces) == $ok_pieces_qty )

	    	{

	    		$status_ok = checkdate($date_pieces[$idx_month],$date_pieces[$idx_day],$date_pieces[$idx_year]);	

	    		$op->status_ok = $status_ok ? 1 : 0;	

	    	}

	    }

	    

	    if( $op->status_ok == 0 )

	    {

	    	$op->user_feedback = lang_get("invalid_release_date");

		}

	}

	

	return $op;

}



/*

  function: doCopyToTestPlans

            copy do checks that are common to create and update operations

            - name already exists in this testplan?

  args:



  returns: -



*/

function doCopyToTestPlans(&$argsObj,&$buildMgr,&$tplanMgr)

{

    $tprojectMgr = new testproject($tplanMgr->db);



    // exclude this testplan

    $filters = array('tplan2exclude' => $argsObj->tplan_id);

    $tplanset = $tprojectMgr->get_all_testplans($argsObj->testprojectID,$filters);



    if(!is_null($tplanset))

    {

        foreach($tplanset as $id => $info)

        {

            if(!$tplanMgr->check_build_name_existence($id,$argsObj->build_name))

            {

                $buildMgr->create($id,$argsObj->build_name,$argsObj->notes,

                                  $argsObj->is_active,$argsObj->is_open);

            }

        }

    }

}



function checkRights(&$db,&$user)

{

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

}



/**

 * Initialize the HTML select box for selection of a source build when

 * user wants to copy the user assignments on creation of a new build.

 * 

 * @author Andreas Simon

 * @param testplan $testplan_mgr reference to testplan manager object

 * @param object $argsObj reference to user input object

 * @return array $htmlMenu array structure with all information needed for the menu

 *

 * @internal revision

 * 20100820 - franciscom - refactoring to remove unneeded support/temp variables and 

 *						   event viewer complain due to foreach() over a null variable.

 */

function init_source_build_selector(&$testplan_mgr, &$argsObj) {



	$htmlMenu = array('items' => null, 'selected' => null, 'build_count' => 0);

	$htmlMenu['items'] = $testplan_mgr->get_builds_for_html_options($argsObj->tplan_id);

	

	

	// get the number of existing execution assignments with each build

	if( !is_null($htmlMenu['items']) )

	{

		$htmlMenu['build_count'] = count($htmlMenu['items']);

		foreach ($htmlMenu['items'] as $key => $name) {

			$count = $testplan_mgr->assignment_mgr->get_count_of_assignments_for_build_id($key);

			$htmlMenu['items'][$key] = $name . " (" . $count . ")"; 

		}

		

		// if no build has been chosen yet, select the newest build by default

		if( !$argsObj->source_build_id )

		{

			$htmlMenu['selected'] = key($htmlMenu['items']);

		} 

	}   



	return $htmlMenu;

} // end of method

?>