/*
 *	aegis - project change supervisor
 *	Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999 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 implement remove file undo
 */

#include <ac/stdio.h>
#include <ac/stdlib.h>

#include <ael/change/files.h>
#include <aermu.h>
#include <arglex2.h>
#include <change_bran.h>
#include <change/file.h>
#include <commit.h>
#include <error.h>
#include <help.h>
#include <lock.h>
#include <log.h>
#include <os.h>
#include <progname.h>
#include <project.h>
#include <project/file.h>
#include <sub.h>
#include <trace.h>
#include <user.h>
#include <str_list.h>


/*
 * NAME
 *	remove_file_undo_usage
 *
 * SYNOPSIS
 *	void remove_file_undo_usage(void);
 *
 * DESCRIPTION
 *	The remove_file_undo_usage function is used to
 *	tell the user how to use the 'aegis -ReMove_file_Undo' command.
 */

static void remove_file_undo_usage _((void));

static void
remove_file_undo_usage()
{
	char		*progname;

	progname = progname_get();
	fprintf
	(
		stderr,
		"usage: %s -ReMove_file_Undo <filename>... [ <option>... ]\n",
		progname
	);
	fprintf
	(
		stderr,
		"       %s -ReMove_file_Undo -List [ <option>... ]\n",
		progname
	);
	fprintf(stderr, "       %s -ReMove_file_Undo -Help\n", progname);
	quit(1);
}


/*
 * NAME
 *	remove_file_undo_help
 *
 * SYNOPSIS
 *	void remove_file_undo_help(void);
 *
 * DESCRIPTION
 *	The remove_file_undo_help function is used to
 *	describe the 'aegis -ReMove_file_undo' command to the user.
 */

static void remove_file_undo_help _((void));

static void
remove_file_undo_help()
{
	help("aermu", remove_file_undo_usage);
}


/*
 * NAME
 *	remove_file_undo_list
 *
 * SYNOPSIS
 *	void remove_file_undo_list(void);
 *
 * DESCRIPTION
 *	The remove_file_undo_list function is used to
 *	list the file the user may wish to remove from the change
 *	as a deletion.  All relevant change files are listed.
 */

static void remove_file_undo_list _((void));

static void
remove_file_undo_list()
{
	string_ty	*project_name;
	long		change_number;

	trace(("remove_file_undo_list()\n{\n"/*}*/));
	project_name = 0;
	change_number = 0;
	arglex();
	while (arglex_token != arglex_token_eoln)
	{
		switch (arglex_token)
		{
		default:
			generic_argument(remove_file_undo_usage);
			continue;

		case arglex_token_change:
			if (arglex() != arglex_token_number)
				option_needs_number(arglex_token_change, remove_file_undo_usage);
			/* fall through... */

		case arglex_token_number:
			if (change_number)
				duplicate_option_by_name(arglex_token_change, remove_file_undo_usage);
			change_number = arglex_value.alv_number;
			if (change_number == 0)
				change_number = MAGIC_ZERO;
			else if (change_number < 1)
			{
				sub_context_ty	*scp;

				scp = sub_context_new();
				sub_var_set(scp, "Number", "%ld", change_number);
				fatal_intl(scp, i18n("change $number out of range"));
				/* NOTREACHED */
				sub_context_delete(scp);
			}
			break;

		case arglex_token_project:
			if (arglex() != arglex_token_string)
				option_needs_name(arglex_token_project, remove_file_undo_usage);
			if (project_name)
				duplicate_option_by_name(arglex_token_project, remove_file_undo_usage);
			project_name = str_from_c(arglex_value.alv_string);
			break;
		}
		arglex();
	}
	list_change_files(project_name, change_number);
	if (project_name)
		str_free(project_name);
	trace((/*{*/"}\n"));
}


/*
 * NAME
 *	remove_undo_main
 *
 * SYNOPSIS
 *	void remove_undo_main(void);
 *
 * DESCRIPTION
 *	The remove_undo_main function is used to
 *	remove a file from a change as a deletion.
 *
 *	The names of the relevant files are gleaned from the command line.
 */

static void remove_file_undo_main _((void));

static void
remove_file_undo_main()
{
	string_list_ty	wl, wl2;
	string_ty	*s1;
	string_ty	*s2;
	size_t		j, k;
	cstate		cstate_data;
	string_ty	*project_name;
	project_ty	*pp;
	long		change_number;
	change_ty	*cp;
	log_style_ty	log_style;
	user_ty		*up;
	string_ty	*dd;
	int		number_of_errors;
	string_list_ty	search_path;
	int		mend_symlinks;
	pconf		pconf_data;
	int		based;
	string_ty	*base;

	trace(("remove_file_undo_main()\n{\n"/*}*/));
	project_name = 0;
	change_number = 0;
	string_list_constructor(&wl);
	log_style = log_style_append_default;
	while (arglex_token != arglex_token_eoln)
	{
		switch (arglex_token)
		{
		default:
			generic_argument(remove_file_undo_usage);
			continue;

		case arglex_token_file:
		case arglex_token_directory:
			if (arglex() != arglex_token_string)
				remove_file_undo_usage();
			/* fall through... */

		case arglex_token_string:
			s2 = str_from_c(arglex_value.alv_string);
			string_list_append(&wl, s2);
			str_free(s2);
			break;

		case arglex_token_change:
			if (arglex() != arglex_token_number)
				option_needs_number(arglex_token_change, remove_file_undo_usage);
			/* fall through... */

		case arglex_token_number:
			if (change_number)
				duplicate_option_by_name(arglex_token_change, remove_file_undo_usage);
			change_number = arglex_value.alv_number;
			if (change_number == 0)
				change_number = MAGIC_ZERO;
			else if (change_number < 1)
			{
				sub_context_ty	*scp;

				scp = sub_context_new();
				sub_var_set(scp, "Number", "%ld", change_number);
				fatal_intl(scp, i18n("change $number out of range"));
				/* NOTREACHED */
				sub_context_delete(scp);
			}
			break;

		case arglex_token_project:
			if (arglex() != arglex_token_string)
				option_needs_name(arglex_token_project, remove_file_undo_usage);
			if (project_name)
				duplicate_option_by_name(arglex_token_project, remove_file_undo_usage);
			project_name = str_from_c(arglex_value.alv_string);
			break;

		case arglex_token_nolog:
			if (log_style == log_style_none)
				duplicate_option(remove_file_undo_usage);
			log_style = log_style_none;
			break;

		case arglex_token_wait:
		case arglex_token_wait_not:
			user_lock_wait_argument(remove_file_undo_usage);
			break;

		case arglex_token_base_relative:
		case arglex_token_current_relative:
			user_relative_filename_preference_argument(remove_file_undo_usage);
			break;
		}
		arglex();
	}
	if (!wl.nstrings)
	{
		error_intl(0, i18n("no file names"));
		remove_file_undo_usage();
	}

	/*
	 * locate project data
	 */
	if (!project_name)
		project_name = user_default_project();
	pp = project_alloc(project_name);
	str_free(project_name);
	project_bind_existing(pp);

	/*
	 * locate user data
	 */
	up = user_executing(pp);

	/*
	 * locate change data
	 */
	if (!change_number)
		change_number = user_default_change(up);
	cp = change_alloc(pp, change_number);
	change_bind_existing(cp);

	/*
	 * take the locks and read the change state
	 */
	change_cstate_lock_prepare(cp);
	lock_take();
	cstate_data = change_cstate_get(cp);

	log_open(change_logfile_get(cp), up, log_style);

	/*
	 * It is an error if the change is not in the in_development state.
	 * It is an error if the change is not assigned to the current user.
	 */
	if (cstate_data->state != cstate_state_being_developed)
		change_fatal(cp, 0, i18n("bad rmu state"));
	if (change_is_a_branch(cp))
		change_fatal(cp, 0, i18n("bad cp undo branch"));
	if (!str_equal(change_developer_name(cp), user_name(up)))
		change_fatal(cp, 0, i18n("not developer"));

	/*
	 * Search path for resolving filenames.
	 */
	change_search_path_get(cp, &search_path, 1);

	/*
	 * Find the base for relative filenames.
	 */
	based =
		(
			search_path.nstrings >= 1
		&&
			(
				user_relative_filename_preference
				(
					up,
				      uconf_relative_filename_preference_current
				)
			==
				uconf_relative_filename_preference_base
			)
		);
	if (based)
		base = search_path.string[0];
	else
	{
		os_become_orig();
		base = os_curdir();
		os_become_undo();
	}

	/*
	 * resolve the path of each file
	 * 1.	the absolute path of the file name is obtained
	 * 2.	if the file is inside the development directory, ok
	 * 3.	if the file is inside the baseline, ok
	 * 4.	if neither, error
	 */
	string_list_constructor(&wl2);
	number_of_errors = 0;
	for (j = 0; j < wl.nstrings; ++j)
	{
		string_list_ty	wl_in;

		s1 = wl.string[j];
		if (s1->str_text[0] == '/')
			s2 = str_copy(s1);
		else
			s2 = str_format("%S/%S", base, s1);
		user_become(up);
		s1 = os_pathname(s2, 1);
		user_become_undo();
		str_free(s2);
		s2 = 0;
		for (k = 0; k < search_path.nstrings; ++k)
		{
			s2 = os_below_dir(search_path.string[k], s1);
			if (s2)
				break;
		}
		str_free(s1);
		if (!s2)
		{
			sub_context_ty	*scp;

			scp = sub_context_new();
			sub_var_set(scp, "File_Name", "%S", wl.string[j]);
			change_error(cp, scp, i18n("$filename unrelated"));
			sub_context_delete(scp);
			++number_of_errors;
			continue;
		}
		change_file_directory_query(cp, s2, &wl_in, 0);
		if (wl_in.nstrings)
		{
			int	used;

			/*
			 * If the user named a directory, add all of the
			 * source files in that directory, provided they
			 * are not already in the change.
			 */
			used = 0;
			for (k = 0; k < wl_in.nstrings; ++k)
			{
				fstate_src	src_data;
				string_ty	*s3;

				s3 = wl_in.string[k];
				src_data = change_file_find(cp, s3);
				assert(src_data);
				if (src_data && src_data->action == file_action_remove)
				{
					if (string_list_member(&wl2, s3))
					{
						sub_context_ty	*scp;

						scp = sub_context_new();
						sub_var_set(scp, "File_Name", "%S", s3);
						change_error(cp, scp, i18n("too many $filename"));
						sub_context_delete(scp);
						++number_of_errors;
					}
					else
						string_list_append(&wl2, s3);
					++used;
				}
			}
			if (!used)
			{
				sub_context_ty	*scp;

				scp = sub_context_new();
				if (s2->str_length)
					sub_var_set(scp, "File_Name", "%S", s2);
				else
					sub_var_set(scp, "File_Name", ".");
				sub_var_set(scp, "Number", "%ld", (long)wl_in.nstrings);
				sub_var_optional(scp, "Number");
				change_error
				(
					cp,
					scp,
			  i18n("directory $filename contains no relevant files")
				);
				sub_context_delete(scp);
				++number_of_errors;
			}
		}
		else
		{
			if (string_list_member(&wl2, s2))
			{
				sub_context_ty	*scp;

				scp = sub_context_new();
				sub_var_set(scp, "File_Name", "%S", s2);
				change_error(cp, scp, i18n("too many $filename"));
				sub_context_delete(scp);
				++number_of_errors;
			}
			else
				string_list_append(&wl2, s2);
		}
		string_list_destructor(&wl_in);
		str_free(s2);
	}
	string_list_destructor(&wl);
	wl = wl2;
	string_list_destructor(&search_path);

	/*
	 * ensure that each file is part of the change
	 */
	for (j = 0; j < wl.nstrings; ++j)
	{
		fstate_src	c_src_data;

		s1 = wl.string[j];
		c_src_data = change_file_find(cp, s1);
		if (!c_src_data)
		{
			c_src_data = change_file_find_fuzzy(cp, s1);
			if (c_src_data)
			{
				sub_context_ty	*scp;

				scp = sub_context_new();
				sub_var_set(scp, "File_Name", "%S", s1);
				sub_var_set(scp, "Guess", "%S", c_src_data->file_name);
				change_error
				(
					cp,
					scp,
					i18n("no $filename, closest is $guess")
				);
				sub_context_delete(scp);
			}
			else
			{
				sub_context_ty	*scp;

				scp = sub_context_new();
				sub_var_set(scp, "File_Name", "%S", s1);
				change_error(cp, scp, i18n("no $filename"));
				sub_context_delete(scp);
			}
			++number_of_errors;
			continue;
		}
		if (c_src_data->action != file_action_remove)
		{
			sub_context_ty	*scp;

			scp = sub_context_new();
			sub_var_set(scp, "File_Name", "%S", s1);
			change_error(cp, scp, i18n("bad rm undo $filename"));
			sub_context_delete(scp);
			++number_of_errors;
			continue;
		}
		change_file_remove(cp, s1);
	}
	if (number_of_errors)
	{
		sub_context_ty	*scp;

		scp = sub_context_new();
		sub_var_set(scp, "Number", "%d", number_of_errors);
		sub_var_optional(scp, "Number");
		change_fatal(cp, scp, i18n("remove file undo fail"));
		/* NOTREACHED */
		sub_context_delete(scp);
	}

	/*
	 * Figure out if we need to mend symlinks as we go.
	 */
	pconf_data = change_pconf_get(cp, 0);
	mend_symlinks =
		(
			pconf_data->create_symlinks_before_build
		&&
			!pconf_data->remove_symlinks_after_build
		);

	/*
	 * Remove the difference files,
	 * and the dummy files,
	 * if they exist.
	 */
	dd = change_development_directory_get(cp, 0);
	user_become(up);
	for (j = 0; j < wl.nstrings; ++j)
	{
		fstate_src	psrc_data;

		s1 = wl.string[j];
		if (mend_symlinks)
		{
			psrc_data = project_file_find(pp, s1);
			if
			(
				psrc_data
			&&
				(
					psrc_data->deleted_by
				||
					psrc_data->about_to_be_created_by
				)
			)
				psrc_data = 0;
		}
		else
			psrc_data = 0;

		s2 = str_format("%S/%S", dd, s1);
		if (psrc_data)
		{
			string_ty *blf;

			/*
			 * This is not as robust in the face of errors
			 * as using commit.  Its merit is its simplicity.
			 *
			 * Also, the rename-and-delete shenanigans take
			 * a long time over NFS, and users expect this
			 * to be fast.
			 */
			user_become_undo();
			blf = project_file_path(pp, s1);
			assert(blf);
			user_become(up);
			if (os_exists(s2))
				os_unlink(s2);
			os_symlink(blf, s2);
			str_free(blf);
		}
		else
		{
			if (os_exists(s2))
				commit_unlink_errok(s2);
		}
		str_free(s2);

		s2 = str_format("%S/%S,D", dd, s1);
		if (os_exists(s2))
			commit_unlink_errok(s2);
		str_free(s2);

		s2 = str_format("%S/%S,B", dd, s1);
		if (os_exists(s2))
			commit_unlink_errok(s2);
		str_free(s2);
	}
	user_become_undo();

	/*
	 * the number of files changed, or the version did,
	 * so stomp on the validation fields.
	 */
	change_build_times_clear(cp);

	/*
	 * run the change file command
	 * and the project file command if necessary
	 */
	change_run_change_file_command(cp, &wl, up);
	change_run_project_file_command(cp, up);

	/*
	 * write the data and release the lock
	 */
	change_cstate_write(cp);
	commit();
	lock_release();

	/*
	 * verbose success message
	 */
	for (j = 0; j < wl.nstrings; ++j)
	{
		sub_context_ty	*scp;

		scp = sub_context_new();
		sub_var_set(scp, "File_Name", "%S", wl.string[j]);
		change_verbose(cp, scp, i18n("remove file undo $filename complete"));
		sub_context_delete(scp);
	}
	string_list_destructor(&wl);
	change_free(cp);
	project_free(pp);
	user_free(up);
	trace((/*{*/"}\n"));
}


/*
 * NAME
 *	remove_file_undo
 *
 * SYNOPSIS
 *	void remove_file_undo(void);
 *
 * DESCRIPTION
 *	The remove_file_undo function is used to
 *	dispatch the 'aegis -ReMove_file_Undo' command to the relevant
 *	function to do it's work.
 */

void
remove_file_undo()
{
	trace(("remove_file_undo()\n{\n"/*}*/));
	switch (arglex())
	{
	default:
		remove_file_undo_main();
		break;

	case arglex_token_help:
		remove_file_undo_help();
		break;

	case arglex_token_list:
		remove_file_undo_list();
		break;
	}
	trace((/*{*/"}\n"));
}
