/*
 *	aegis - project change supervisor
 *	Copyright (C) 2001 Peter Miller;
 *	All rights reserved.
 *
 *	This program is free software; you can redistribute it and/or modify
 *	it under the terms of the GNU General Public License as published by
 *	the Free Software Foundation; either version 2 of the License, or
 *	(at your option) any later version.
 *
 *	This program is distributed in the hope that it will be useful,
 *	but WITHOUT ANY WARRANTY; without even the implied warranty of
 *	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *	GNU General Public License for more details.
 *
 *	You should have received a copy of the GNU General Public License
 *	along with this program; if not, write to the Free Software
 *	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
 *
 * MANIFEST: functions to manipulate new_branchs
 */

#include <change.h>
#include <change/branch.h>
#include <cstate.h>
#include <error.h> /* for assert */
#include <os.h>
#include <pconf.h>
#include <project.h>
#include <project_hist.h>
#include <sub.h>
#include <trace.h>
#include <undo.h>
#include <user.h>


static string_ty *branch_description_invent _((project_ty *));

static string_ty *
branch_description_invent(pp)
	project_ty	*pp;
{
	string_ty	*s1;
	string_ty	*s2;
	size_t		len;
	string_ty	*result;

	s2 = project_version_short_get(pp);
	while (pp->parent)
		pp = pp->parent;
	s1 = project_description_get(pp);
	if (s1->str_length == 0)
	{
		str_free(s2);
		return str_copy(s1);
	}
	for (len = s1->str_length; len && s1->str_text[len - 1] == '.'; --len)
		;
	result = str_format("%.*S, branch %S.", (int)len, s1, s2);
	/* do not free s1 */
	str_free(s2);
	return result;
}


project_ty *
project_new_branch(ppp, up, change_number, topdir)
	project_ty	*ppp;
	user_ty		*up;
	long		change_number;
	string_ty	*topdir;
{
	cstate		cstate_data;
	cstate_history	history_data;
	change_ty	*cp;
	long		j;
	pconf		pconf_data;
	string_ty	*s;
	project_ty	*pp;

	/*
	 * On entry it is assumed that you have
	 * a project state lock, to create the branches
	 */
	trace(("project_new_branch(ppp = %8.8lX, change_number = %ld)\n{\n",
		(long)ppp, change_number));

	/*
	 * create the new branch.
	 * validity of the branch number was checked elsewhere.
	 */
	cp = change_alloc(ppp, change_number);
	change_bind_new(cp);
	change_branch_new(cp);
	pp = project_bind_branch(ppp, cp);

	/*
	 * The copyright years are not copied from the parent, because
	 * they are updated by integrations.  The copyright years thus
	 * represent the copyright years for the changes made by the
	 * branch.
	 *
	 * However, when copyright years are calculated for ``ael
	 * version'' the branch's copyright years (actually, all
	 * ancestors') are included.
	 */

	/*
	 * Create the change (branch) directory.
	 *
	 * It is in the same place as the rest of the project, unless
	 * otherwise specified.  This makes it easy to collect the whole
	 * project tree, branches, info and all, in a simple tar or cpio
	 * command for archiving or moving.
	 */
	if (!topdir)
	{
		sub_context_ty	*scp;

		topdir =
			str_format
			(
				"%S/branch.%ld",
				project_top_path_get(ppp, 0),
				magic_zero_decode(change_number)
			);
		scp = sub_context_new();
		sub_var_set_string(scp, "File_Name", topdir);
		change_verbose(cp, scp, i18n("development directory \"$filename\""));
		sub_context_delete(scp);
	}
	change_top_path_set(cp, topdir);

	/*
	 * Create the development directory.
	 *
	 * In a branch, the development directory contains
	 *	(a) a directory called "baseline" for the branch's baseline
	 *	(b) directories called "delta.*" for integrations, later
	 *	(c) directories called "branch.*" for branches, later
	 *
	 * A branch's development directory is owned by the project
	 * owner, not the creating user.
	 *
	 * The "info" and "history" directories are only present in the
	 * development directory of the trunk.  DO NOT create them here.
	 */
	s = str_format("%S/baseline", topdir);
	project_become(pp);
	os_mkdir(topdir, 02755);
	os_mkdir(s, 02755);
	undo_rmdir_errok(s);
	undo_rmdir_errok(topdir);
	project_become_undo();
	str_free(s);

	/*
	 * Create symbolic links from the nre branch's baseline into the
	 * branch's parent's baseline.	This is similar to what happens
	 * at develop begin.
	 */
	pconf_data = change_pconf_get(cp, 0);
	if
	(
		pconf_data->create_symlinks_before_integration_build
	&&
		!pconf_data->remove_symlinks_after_integration_build
	)
	{
		change_create_symlinks_to_baseline
		(
			cp,
			ppp,
			project_user(ppp),
			0
		);
	}

	/*
	 * Clear the time fields.
	 */
	change_build_times_clear(cp);

	/*
	 * many of the branch attributes are inherited from the parent
	 */
	change_branch_umask_set(cp, project_umask_get(ppp));
	change_branch_developer_may_review_set
	(
		cp,
		project_developer_may_review_get(ppp)
	);
	change_branch_developer_may_integrate_set
	(
		cp,
		project_developer_may_integrate_get(ppp)
	);
	change_branch_reviewer_may_integrate_set
	(
		cp,
		project_reviewer_may_integrate_get(ppp)
	);
	change_branch_developers_may_create_changes_set
	(
		cp,
		project_developers_may_create_changes_get(ppp)
	);
	change_branch_forced_develop_begin_notify_command_set
	(
		cp,
		project_forced_develop_begin_notify_command_get(ppp)
	);
	change_branch_develop_end_notify_command_set
	(
		cp,
		project_develop_end_notify_command_get(ppp)
	);
	change_branch_develop_end_undo_notify_command_set
	(
		cp,
		project_develop_end_undo_notify_command_get(ppp)
	);
	change_branch_review_begin_notify_command_set
	(
		cp,
		project_review_begin_notify_command_get(ppp)
	);
	change_branch_review_begin_undo_notify_command_set
	(
		cp,
		project_review_begin_undo_notify_command_get(ppp)
	);
	change_branch_review_pass_notify_command_set
	(
		cp,
		project_review_pass_notify_command_get(ppp)
	);
	change_branch_review_pass_undo_notify_command_set
	(
		cp,
		project_review_pass_undo_notify_command_get(ppp)
	);
	change_branch_review_fail_notify_command_set
	(
		cp,
		project_review_fail_notify_command_get(ppp)
	);
	change_branch_integrate_pass_notify_command_set
	(
		cp,
		project_integrate_pass_notify_command_get(ppp)
	);
	change_branch_integrate_fail_notify_command_set
	(
		cp,
		project_integrate_fail_notify_command_get(ppp)
	);
	change_branch_default_test_exemption_set
	(
		cp,
		project_default_test_exemption_get(ppp)
	);
	change_branch_default_development_directory_set
	(
		cp,
		project_default_development_directory_get(ppp)
	);

	/*
	 * staff lists are inherited from the parent
	 */
	for (j = 0; ; ++j)
	{
		s = project_administrator_nth(ppp, j);
		if (!s)
			break;
		change_branch_administrator_add(cp, s);
	}
	for (j = 0; ; ++j)
	{
		s = project_developer_nth(ppp, j);
		if (!s)
			break;
		change_branch_developer_add(cp, s);
	}
	for (j = 0; ; ++j)
	{
		s = project_reviewer_nth(ppp, j);
		if (!s)
			break;
		change_branch_reviewer_add(cp, s);
	}
	for (j = 0; ; ++j)
	{
		s = project_integrator_nth(ppp, j);
		if (!s)
			break;
		change_branch_integrator_add(cp, s);
	}
	change_branch_minimum_change_number_set
	(
		cp,
		project_minimum_change_number_get(ppp)
	);
	change_branch_reuse_change_numbers_set
	(
		cp,
		project_reuse_change_numbers_get(ppp)
	);
	change_branch_minimum_branch_number_set
	(
		cp,
		project_minimum_branch_number_get(ppp)
	);
	change_branch_skip_unlucky_set
	(
		cp,
		project_skip_unlucky_get(ppp)
	);
	change_branch_develop_end_action_set
	(
		cp,
		project_develop_end_action_get(ppp)
	);

	/*
	 * architecture is inherited from parent
	 */
	assert(pconf_data->architecture);
	change_architecture_clear(cp);
	for (j = 0; j < pconf_data->architecture->length; ++j)
	{
		change_architecture_add
		(
			cp,
			pconf_data->architecture->list[j]->name
		);
	}

	/*
	 * create the change history,
	 * and advance the change to 'being developed'
	 */
	history_data = change_history_new(cp, up);
	history_data->what = cstate_history_what_new_change;
	history_data = change_history_new(cp, up);
	history_data->what = cstate_history_what_develop_begin;
	cstate_data = change_cstate_get(cp);
	cstate_data->state = cstate_state_being_developed;

	/*
	 * set the attributes
	 */
	cstate_data->description = branch_description_invent(pp);
	cstate_data->brief_description = str_copy(cstate_data->description);
	cstate_data->cause = change_cause_internal_enhancement;
	cstate_data->test_exempt = 1;
	cstate_data->test_baseline_exempt = 1;
	cstate_data->regression_test_exempt = 1;

	/*
	 * Add the change to the list of existing changes
	 */
	project_change_append(ppp, change_number, 1);
	trace(("return %8.8lX;\n", (long)pp));
	trace(("}\n"));
	return pp;
}