//
// aegis - project change supervisor
// Copyright (C) 1993-1999, 2001-2009, 2011, 2012, 2014 Peter Miller
// Copyright (C) 2005, 2008, 2009 Walter Franzini
//
// 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 3 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, see <http://www.gnu.org/licenses/>.
//

#include <common/ac/assert.h>
#include <common/ac/stdio.h>

#include <common/error.h>
#include <common/progname.h>
#include <common/quit.h>
#include <common/sizeof.h>
#include <common/str_list.h>
#include <common/trace.h>
#include <libaegis/ael/project/files.h>
#include <libaegis/arglex/change.h>
#include <libaegis/arglex/project.h>
#include <libaegis/arglex2.h>
#include <libaegis/change/branch.h>
#include <libaegis/change/file.h>
#include <libaegis/change/identifier.h>
#include <libaegis/commit.h>
#include <libaegis/file.h>
#include <libaegis/help.h>
#include <libaegis/lock.h>
#include <libaegis/log.h>
#include <libaegis/move_list.h>
#include <libaegis/os.h>
#include <libaegis/project.h>
#include <libaegis/project/file.h>
#include <libaegis/search_path/base_get.h>
#include <libaegis/sub.h>
#include <libaegis/undo.h>
#include <libaegis/user.h>

#include <aegis/aemv.h>


static void
move_file_usage(void)
{
    const char      *progname;

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


static void
move_file_help(void)
{
    help("aemv", move_file_usage);
}


static void
move_file_list(void)
{
    trace(("move_file_list()\n{\n"));
    arglex();
    change_identifier cid;
    cid.command_line_parse_rest(move_file_usage);
    list_project_files(cid, 0);
    trace(("}\n"));
}


static void
move_file_innards(user_ty::pointer up, change::pointer cp, string_ty *old_name,
    string_ty *new_name, string_list_ty *wl_nf, string_list_ty *wl_nt,
    string_list_ty *wl_rm)
{
    project      *pp;
    fstate_src_ty   *p_src_data;
    fstate_src_ty   *pn_src_data;
    fstate_src_ty   *c_src_data;
    string_ty       *from;
    string_ty       *to;
    string_ty       *dd;

    pp = cp->project_get();

    //
    // the old file may not be in the change already
    //
    if (cp->file_find(nstring(old_name), view_path_first))
    {
        sub_context_ty  *scp;

        scp = sub_context_new();
        sub_var_set_string(scp, "File_Name", old_name);
        change_fatal(cp, scp, i18n("file $filename dup"));
        // NOTREACHED
        sub_context_delete(scp);
    }

    //
    // the old file must be in the baseline
    //
    p_src_data = pp->file_find(old_name, view_path_extreme);
    if (!p_src_data)
    {
        p_src_data = pp->file_find_fuzzy(old_name, view_path_extreme);
        if (p_src_data)
        {
            sub_context_ty  *scp;

            scp = sub_context_new();
            sub_var_set_string(scp, "File_Name", old_name);
            sub_var_set_string(scp, "Guess", p_src_data->file_name);
            project_fatal(pp, scp, i18n("no $filename, closest is $guess"));
            // NOTREACHED
            sub_context_delete(scp);
        }
        else
        {
            sub_context_ty  *scp;

            scp = sub_context_new();
            sub_var_set_string(scp, "File_Name", old_name);
            project_fatal(pp, scp, i18n("no $filename"));
            // NOTREACHED
            sub_context_delete(scp);
        }
    }

    //
    // You may not move a file on top of itself (use aecp!).
    //
    if (str_equal(old_name, new_name))
    {
        sub_context_ty  *scp;

        scp = sub_context_new();
        sub_var_set_string(scp, "File_Name", old_name);
        change_fatal(cp, scp, i18n("nil move $filename"));
        // NOTREACHED
        sub_context_delete(scp);
    }

    //
    // the new file name must be valid.
    //
    nstring err(change_filename_check(cp, new_name));
    if (!err.empty())
    {
        change_fatal(cp, 0, err.c_str());
    }

    //
    // The new file must not cause directory conflicts.
    //
    nstring conflicting_name(change_file_directory_conflict(cp, new_name));
    if (!conflicting_name.empty())
    {
        sub_context_ty  *scp;

        scp = sub_context_new();
        sub_var_set_string(scp, "File_Name", new_name);
        sub_var_set_string(scp, "File_Name2", conflicting_name);
        sub_var_optional(scp, "File_Name2");
        change_fatal
        (
            cp,
            scp,
            i18n("file $filename directory name conflict")
        );
        // NOTREACHED
        sub_context_delete(scp);
    }
    conflicting_name = nstring(project_file_directory_conflict(pp, new_name));
    if (!conflicting_name.empty())
    {
        sub_context_ty  *scp;

        scp = sub_context_new();
        sub_var_set_string(scp, "File_Name", new_name);
        sub_var_set_string(scp, "File_Name2", conflicting_name);
        sub_var_optional(scp, "File_Name2");
        project_fatal
        (
            pp,
            scp,
            i18n("file $filename directory name conflict")
        );
        // NOTREACHED
        sub_context_delete(scp);
    }

    //
    // the new file must not already be part of the change
    //
    if (cp->file_find(nstring(new_name), view_path_first))
    {
        sub_context_ty  *scp;

        scp = sub_context_new();
        sub_var_set_string(scp, "File_Name", new_name);
        change_fatal(cp, scp, i18n("file $filename dup"));
        // NOTREACHED
        sub_context_delete(scp);
    }

    //
    // the new file must not be part of the baseline
    //
    pn_src_data = pp->file_find(new_name, view_path_extreme);
    if (pn_src_data)
    {
        sub_context_ty  *scp;

        scp = sub_context_new();
        sub_var_set_string(scp, "File_Name", new_name);
        project_fatal(pp, scp, i18n("$filename in baseline"));
        // NOTREACHED
        sub_context_delete(scp);
    }

    //
    // Add the files to the change
    //
    assert(p_src_data);
    c_src_data = cp->file_new(p_src_data);
    c_src_data->action = file_action_remove;
    c_src_data->move = str_copy(new_name);
    assert(p_src_data->edit);
    assert(p_src_data->edit->revision);
    if (p_src_data->edit)
        c_src_data->edit_origin = history_version_copy(p_src_data->edit);

    c_src_data = cp->file_new(new_name);
    c_src_data->action = file_action_create;
    change_file_copy_basic_attributes(c_src_data, p_src_data);
    c_src_data->move = str_copy(old_name);
    if (p_src_data->edit && c_src_data->uuid)
        c_src_data->edit_origin = history_version_copy(p_src_data->edit);

    //
    // Add the file to the appropriate notification lists.
    //
    wl_rm->push_back(old_name);
    switch (c_src_data->usage)
    {
    case file_usage_test:
    case file_usage_manual_test:
        wl_nt->push_back(new_name);
        break;

    case file_usage_source:
    case file_usage_config:
    case file_usage_build:
        wl_nf->push_back(new_name);
        break;
    }

    //
    // If the file is built, we are done.
    //
    switch (c_src_data->usage)
    {
    case file_usage_build:
        return;

    case file_usage_source:
    case file_usage_config:
    case file_usage_test:
    case file_usage_manual_test:
        break;
    }

    //
    // Copy the file into the development directory.
    // Create any necessary directories along the way.
    //
    from = project_file_path(pp, old_name);
    assert(from);
    to = cp->file_path(new_name);
    assert(to);
    dd = cp->development_directory_get(0);

    //
    // Copy the file.
    //
    // Note: the file copy destroys anything in the development
    // direcory at both "from" and "to".
    //
    up->become_begin();
    os_mkdir_between(dd, new_name, 02755);
    undo_unlink_errok(to);
    if (os_exists(to))
        os_unlink(to);
    copy_whole_file(from, to, 0);
    up->become_end();
    str_free(from);
    str_free(to);

    //
    // remove the old file
    //
    change_file_whiteout_write(cp, old_name, up);
}


static void
move_file_main(void)
{
    sub_context_ty  *scp;
    string_ty       *s1;
    string_ty       *s2;
    string_ty       *project_name;
    project      *pp;
    long            change_number;
    change::pointer cp;
    log_style_ty    log_style;
    user_ty::pointer up;
    size_t          k;
    string_list_ty  search_path;
    move_list_ty    ml;
    size_t          j;
    size_t          i;

    trace(("move_file_main()\n{\n"));
    arglex();
    project_name = 0;
    change_number = 0;
    log_style = log_style_append_default;
    string_list_ty wl_args;
    move_list_constructor(&ml);
    while (arglex_token != arglex_token_eoln)
    {
        switch (arglex_token)
        {
        default:
            generic_argument(move_file_usage);
            continue;

        case arglex_token_string:
            s1 = str_from_c(arglex_value.alv_string);
            wl_args.push_back(s1);
            str_free(s1);
            break;

        case arglex_token_change:
            arglex();
            // fall through...

        case arglex_token_number:
            arglex_parse_change(&project_name, &change_number, move_file_usage);
            continue;

        case arglex_token_project:
            arglex();
            arglex_parse_project(&project_name, move_file_usage);
            continue;

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

        case arglex_token_wait:
        case arglex_token_wait_not:
            user_ty::lock_wait_argument(move_file_usage);
            break;

        case arglex_token_whiteout:
        case arglex_token_whiteout_not:
            user_ty::whiteout_argument(move_file_usage);
            break;

        case arglex_token_base_relative:
        case arglex_token_current_relative:
            user_ty::relative_filename_preference_argument(move_file_usage);
            break;
        }
        arglex();
    }

    if (wl_args.size() < 2)
    {
        error_intl(0, i18n("too few files named"));
        move_file_usage();
    }
    // It is an error if the user supply an odd number of
    // files/directories.
    if (wl_args.size() % 2)
    {
        error_intl(0, i18n("not an even number of args"));
        move_file_usage();
    }


    //
    // locate project data
    //
    if (!project_name)
    {
        nstring n = user_ty::create()->default_project();
        project_name = str_copy(n.get_ref());
    }
    pp = project_alloc(project_name);
    str_free(project_name);
    pp->bind_existing();

    //
    // locate user data
    //
    up = user_ty::create();

    //
    // locate change data
    //
    if (!change_number)
        change_number = up->default_change(pp);
    cp = change::create(pp, change_number);
    cp->bind_existing();

    //
    // lock the change file
    //
    change_cstate_lock_prepare(cp);
    lock_take();

    //
    // 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 (!cp->is_being_developed())
        change_fatal(cp, 0, i18n("bad mv state"));
    if (cp->is_a_branch())
        change_fatal(cp, 0, i18n("bad branch cp"));
    if (nstring(cp->developer_name()) != up->name())
        change_fatal(cp, 0, i18n("not developer"));

    //
    // 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
    //
    // To cope with automounters, directories are stored as given,
    // or are derived from the home directory in the passwd file.
    // Within aegis, pathnames have their symbolic links resolved,
    // and any comparison of paths is done on this "system idea"
    // of the pathname.
    //
    cp->search_path_get(&search_path, true);

    //
    // Find the base for relative filenames.
    //
    nstring base(search_path_base_get(nstring_list(search_path), up));

    for (i = 0; i < (wl_args.size() - 1); ++i)
    {
        string_ty *old_name;
        string_ty *new_name;

        trace(("i=%zd; old = \"%s\"; new = \"%s\"; \n",
               i,
               wl_args[i]->str_text,
               wl_args[i+1]->str_text));
        assert(0 == (i % 2));
        old_name = str_copy(wl_args[i]);
        new_name = str_copy(wl_args[++i]);

        //
        // Make the old name absolute, now we know where to make it
        // relative to.
        //
        if (old_name->str_text[0] != '/')
        {
            s1 = os_path_join(base.get_ref(), old_name);
            str_free(old_name);
            old_name = s1;
        }
        up->become_begin();
        s1 = os_pathname(old_name, 1);
        up->become_end();
        str_free(old_name);
        old_name = s1;

        //
        // Find the old name, relative to the project tree.
        //
        s2 = 0;
        for (k = 0; k < search_path.size(); ++k)
        {
            s2 = os_below_dir(search_path[k], old_name);
            if (s2)
                break;
        }
        if (!s2)
        {
            scp = sub_context_new();
            sub_var_set_string(scp, "File_Name", old_name);
            change_fatal(cp, scp, i18n("$filename unrelated"));
            // NOTREACHED
            sub_context_delete(scp);
        }
        str_free(old_name);
        old_name = s2;

        //
        // Make the new name absolute, now we know where to make it
        // relative to.
        //
        if (new_name->str_text[0] != '/')
        {
            s1 = os_path_join(base.get_ref(), new_name);
            str_free(new_name);
            new_name = s1;
        }
        up->become_begin();
        s1 = os_pathname(new_name, 1);
        up->become_end();
        str_free(new_name);
        new_name = s1;

        //
        // Find the new name, relative to the project tree.
        //
        s2 = 0;
        for (k = 0; k < search_path.size(); ++k)
        {
            s2 = os_below_dir(search_path[k], new_name);
            if (s2)
            break;
        }
        if (!s2)
        {
            scp = sub_context_new();
            sub_var_set_string(scp, "File_Name", new_name);
            change_fatal(cp, scp, i18n("$filename unrelated"));
            // NOTREACHED
            sub_context_delete(scp);
        }
        str_free(new_name);
        new_name = s2;

        //
        // If the old file was a directory, then move all of its
        // contents into the new directory.      If the old file was not a
        // directory, just move it.      All checks to see if the action is
        // valid are done in the inner function.
        //
        string_list_ty wl_in;
        pp->file_directory_query(old_name, &wl_in, 0, view_path_simple);
        if (wl_in.size())
        {
            for (j = 0; j < wl_in.size(); ++j)
            {
                string_ty           *filename_old;
                string_ty           *filename_tail;
                string_ty           *filename_new;

                //
                // Note: old_name and new_name will be empty
                // strings if they refer to the top of the
                // development directory tree.
                //
                filename_old = str_copy(wl_in[j]);
                if (old_name->str_length)
                {
                    filename_tail = os_below_dir(old_name, filename_old);
                    if (!filename_tail)
                    this_is_a_bug();
                }
                else
                {
                    // top-level directory
                    filename_tail = str_copy(filename_old);
                }
                if (new_name->str_length)
                    filename_new = os_path_join(new_name, filename_tail);
                else
                    filename_new = str_copy(filename_tail);
                str_free(filename_tail);

                move_list_append_create(&ml, filename_old, filename_new);

                str_free(filename_old);
                str_free(filename_new);
            }
        }
        else
        {
            move_list_append_create(&ml, old_name, new_name);
        }
        str_free(old_name);
        str_free(new_name);
    }

    string_list_ty wl_nf;
    string_list_ty wl_nt;
    string_list_ty wl_rm;
    if (ml.length)
    {
        for (j = 0; j < ml.length; ++j)
        {
            move_file_innards
            (
                up,
                cp,
                ml.item[j].from,
                ml.item[j].to,
                &wl_nf,
                &wl_nt,
                &wl_rm
            );
        }
    }

    if (wl_rm.size() != wl_nf.size() + wl_nt.size())
        this_is_a_bug();

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

    //
    // If the file manifest of the change is altered (e.g. by aenf, aenfu,
    // aecp, aecpu, etc), or the contents of any file is changed, the
    // UUID is cleared.  This is because it is no longer the same change
    // as was received by aedist or aepatch, and the UUID is invalidated.
    //
    change_uuid_clear(cp);

    // remember wer are about to do it
    bool recent_integration = cp->run_project_file_command_needed();
    if (recent_integration)
        cp->run_project_file_command_done();

    //
    // release the locks
    //
    cp->cstate_write();
    commit();
    lock_release();

    //
    // verbose success message
    //
    for (j = 0; j < ml.length; ++j)
    {
        scp = sub_context_new();
        sub_var_set_string(scp, "File_Name1", ml.item[j].from);
        sub_var_set_string(scp, "File_Name2", ml.item[j].to);
        change_verbose(cp, scp, i18n("move $filename1 to $filename2 complete"));
        sub_context_delete(scp);
    }
    move_list_destructor(&ml);

    //
    // run the change file commands
    //
    // Move is modeled as creates and removes, and the change set file
    // notifications are called to reflect that.
    //
    log_open(cp->logfile_get(), up, log_style);
    assert(wl_nf.size() > 0 || wl_nt.size() > 0);
    if (wl_nf.size())
        cp->run_new_file_command(&wl_nf, up);
    if (wl_nt.size())
        cp->run_new_file_command(&wl_nt, up);
    assert(wl_rm.size() > 0);
    assert(wl_rm.size() == wl_nf.size() + wl_nt.size());
    cp->run_remove_file_command(&wl_rm, up);
    if (recent_integration)
        cp->run_project_file_command(up);
    pp->free();
    trace(("}\n"));
}


void
move_file(void)
{
    static arglex_dispatch_ty dispatch[] =
    {
        { arglex_token_help, move_file_help, 0 },
        { arglex_token_list, move_file_list, 0 },
    };

    trace(("move_file()\n{\n"));
    arglex_dispatch(dispatch, SIZEOF(dispatch), move_file_main);
    trace(("}\n"));
}


// vim: set ts=8 sw=4 et :