/****************************************************************
 *
 * MODULE:       v.what.rast
 *
 * AUTHOR(S):    Radim Blazek (adapted from r.what)
 *               Michael Shapiro, U.S. Army Construction Engineering
 *                 Research Laboratory (r.what)
 *               Hamish Bowman, University of Otago, NZ (interpolation)
 *
 *  PURPOSE:     Query raster map
 *
 *  COPYRIGHT:   (C) 2001-2015 by the GRASS Development Team
 *
 *               This program is free software under the GNU General
 *               Public License (>=v2).  Read the file COPYING that
 *               comes with GRASS for details.
 *
 * * TODO: fix user notification if where= is used
 ***************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <grass/raster.h>
#include <grass/dbmi.h>
#include <grass/vector.h>
#include <grass/glocale.h>
#include "local_proto.h"

int main(int argc, char *argv[])
{
    int i, j, type, field, cat, vtype, open_level;
    int fd;

    /* struct Categories RCats; */ /* TODO */
    struct Cell_head window;
    RASTER_MAP_TYPE out_type;
    CELL *cell_row, *prev_c_row, *next_c_row;
    DCELL *dcell_row, *prev_d_row, *next_d_row;
    int width;
    int row, col;
    char buf[DB_SQL_MAX];
    struct {
        struct Option *vect, *rast, *field, *type, *col, *where;
    } opt;
    struct Flag *interp_flag, *print_flag;
    int Cache_size;
    struct order *cache;
    int cur_row;
    struct GModule *module;

    struct Map_info Map;
    struct line_pnts *Points;
    struct line_cats *Cats;
    int point;
    int point_cnt;   /* number of points in cache */
    int outside_cnt; /* points outside region */
    int nocat_cnt;   /* points inside region but without category */
    int dupl_cnt;    /* duplicate categories */
    struct bound_box box;

    int *catexst, *cex;
    struct field_info *Fi;
    dbString stmt;
    dbDriver *driver;
    int select, norec_cnt, update_cnt, upderr_cnt, col_type;

    G_gisinit(argv[0]);

    module = G_define_module();
    G_add_keyword(_("vector"));
    G_add_keyword(_("sampling"));
    G_add_keyword(_("raster"));
    G_add_keyword(_("position"));
    G_add_keyword(_("querying"));
    G_add_keyword(_("attribute table"));
    G_add_keyword(_("surface information"));
    module->description =
        _("Uploads raster values at positions of vector points to the table.");

    opt.vect = G_define_standard_option(G_OPT_V_MAP);
    opt.vect->label =
        _("Name of vector points map for which to edit attributes");

    opt.field = G_define_standard_option(G_OPT_V_FIELD);

    opt.type = G_define_standard_option(G_OPT_V_TYPE);
    opt.type->options = "point,centroid";
    opt.type->answer = "point";

    opt.rast = G_define_standard_option(G_OPT_R_MAP);
    opt.rast->key = "raster";
    opt.rast->description = _("Name of existing raster map to be queried");

    opt.col = G_define_standard_option(G_OPT_DB_COLUMN);
    opt.col->required =
        NO; /* YES, but suppress_required only for this option */
    opt.col->description =
        _("Name of attribute column to be updated with the query result");

    opt.where = G_define_standard_option(G_OPT_DB_WHERE);

    interp_flag = G_define_flag();
    interp_flag->key = 'i';
    interp_flag->description =
        _("Interpolate values from the nearest four cells");

    print_flag = G_define_flag();
    print_flag->key = 'p';
    print_flag->description =
        _("Print categories and values instead of updating the database");

    if (G_parser(argc, argv))
        exit(EXIT_FAILURE);

    db_init_string(&stmt);
    Points = Vect_new_line_struct();
    Cats = Vect_new_cats_struct();

    if (!print_flag->answer && !opt.col->answer)
        G_fatal_error(_("Required parameter <%s> not set"), opt.col->key);

    G_get_window(&window);
    Vect_region_box(&window, &box); /* T and B set to +/- PORT_DOUBLE_MAX */

    /* Open vector */
    open_level =
        Vect_open_old2(&Map, opt.vect->answer,
                       print_flag->answer ? "" : G_mapset(), opt.field->answer);
    if (open_level < 0)
        G_fatal_error(_("Unable to open vector map <%s>"), opt.vect->answer);

    field = Vect_get_field_number(&Map, opt.field->answer);

    Fi = Vect_get_field(&Map, field);
    if (!print_flag->answer) {
        if (Fi == NULL)
            G_fatal_error(_("Database connection not defined for layer %d"),
                          field);

        /* Open driver */
        driver = db_start_driver_open_database(Fi->driver, Fi->database);
        if (driver == NULL) {
            G_fatal_error(_("Unable to open database <%s> by driver <%s>"),
                          Fi->database, Fi->driver);
        }
        db_set_error_handler_driver(driver);
    }

    /* Open raster */
    fd = Rast_open_old(opt.rast->answer, "");

    out_type = Rast_get_map_type(fd);

    width = 15;
    if (out_type == FCELL_TYPE)
        width = 7;

    /* TODO: Later possibly category labels */
    /*
       if ( Rast_read_cats (name, "", &RCats) < 0 )
       G_fatal_error ( "Cannot read category file");
     */

    if (!print_flag->answer) {
        col_type = db_column_Ctype(driver, Fi->table, opt.col->answer);

        if (col_type == -1) {
            /* column doesn't exist, create it */
            G_important_message(
                _("Column <%s> not found in the table <%s>. Creating..."),
                opt.col->answer, Fi->table);
            sprintf(buf, "ALTER TABLE \"%s\" ADD COLUMN \"%s\" %s", Fi->table,
                    opt.col->answer,
                    out_type == CELL_TYPE ? "INTEGER" : "DOUBLE PRECISION");
            db_set_string(&stmt, buf);
            if (db_execute_immediate(driver, &stmt) != DB_OK)
                G_fatal_error(_("Unable to add column <%s> to table <%s>"),
                              opt.col->answer, Fi->table);
        }
        else {
            /* check column type */
            if (col_type != DB_C_TYPE_INT && col_type != DB_C_TYPE_DOUBLE)
                G_fatal_error(_("Column type not supported"));

            if (out_type == CELL_TYPE && col_type == DB_C_TYPE_DOUBLE)
                G_warning(_("Raster type is integer and column type is float"));

            if (out_type != CELL_TYPE && col_type == DB_C_TYPE_INT)
                G_warning(_("Raster type is float and column type is integer, "
                            "some data lost!!"));
        }
    }

    vtype = Vect_option_to_types(opt.type);
    /* Read vector points to cache */
    if (open_level > 1) {
        Cache_size = Vect_get_num_primitives(&Map, vtype);
        /* Note: Some space may be wasted (outside region or no category) */
    }
    else {
        Cache_size = 1000;
    }
    cache = (struct order *)G_calloc(Cache_size, sizeof(struct order));

    point_cnt = outside_cnt = nocat_cnt = 0;

    G_important_message(_("Reading features from vector map..."));
    Vect_set_constraint_type(&Map, vtype);
    i = 0;
    while (TRUE) {
        /* register line */
        type = Vect_read_next_line(&Map, Points, Cats);
        if (type == -1) {
            G_fatal_error(_("Unable to read vector map"));
        }
        else if (type == -2) {
            break;
        }

        G_progress(++i, 1e4);

        G_debug(4, "line = %d type = %d", i, type);

        /* check region */
        if (!Vect_point_in_box(Points->x[0], Points->y[0], 0.0, &box)) {
            outside_cnt++;
            continue;
        }

        Vect_cat_get(Cats, field, &cat);
        if (cat < 0) { /* no category of given field */
            nocat_cnt++;
            continue;
        }

        G_debug(4, "    cat = %d", cat);

        /* Resize cache on level 1 if needed */
        if (open_level < 2) {
            if (point_cnt >= Cache_size) {
                Cache_size += 1000;
                cache = (struct order *)G_realloc(
                    cache, Cache_size * sizeof(struct order));
            }
        }

        /* Add point to cache */
        row = Rast_northing_to_row(Points->y[0], &window);
        col = Rast_easting_to_col(Points->x[0], &window);
        if (col < 0 || col >= window.cols || row < 0 || row >= window.rows)
            continue;

        cache[point_cnt].row = row;
        cache[point_cnt].col = col;
        if (interp_flag->answer) {
            cache[point_cnt].x = Points->x[0];
            cache[point_cnt].y = Points->y[0];
        }
        cache[point_cnt].cat = cat;
        cache[point_cnt].count = 1;
        point_cnt++;
    }
    G_progress(1, 1);
    Vect_close(&Map);

    if (!print_flag->answer) {
        if (Vect_open_update_head(&Map, opt.vect->answer, "") < 0)
            G_warning(_("Unable to write history for vector map <%s>"),
                      opt.vect->answer);
        Vect_set_db_updated(&Map);
        Vect_hist_command(&Map);
        Vect_close(&Map);
    }

    if (point_cnt < 1) {
        G_warning(_("No features of type (%s) found in the current "
                    "computational region"),
                  opt.type->answer);
        exit(EXIT_SUCCESS);
    }
    G_debug(1, "Read %d vector points", point_cnt);
    /* Cache may contain duplicate categories, sort by cat, find and remove
     * duplicates and recalc count and decrease point_cnt  */
    qsort(cache, point_cnt, sizeof(struct order), by_cat);

    G_debug(1, "Points are sorted, starting duplicate removal loop");

    for (i = 0, j = 1; j < point_cnt; j++)
        if (cache[i].cat != cache[j].cat)
            cache[++i] = cache[j];
        else
            cache[i].count++;

    point_cnt = i + 1;

    G_debug(1, "%d vector points left after removal of duplicates", point_cnt);

    /* Report number of points not used */
    if (outside_cnt)
        G_warning(_("%d points outside current region were skipped"),
                  outside_cnt);

    if (nocat_cnt)
        G_warning(_("%d points without category were skipped"), nocat_cnt);

    /* Sort cache by current region row */
    qsort(cache, point_cnt, sizeof(struct order), by_row);

    /* Allocate space for raster row */
    if (out_type == CELL_TYPE)
        cell_row = Rast_allocate_c_buf();
    else
        dcell_row = Rast_allocate_d_buf();

    if (interp_flag->answer) {
        if (out_type == CELL_TYPE) {
            prev_c_row = Rast_allocate_c_buf();
            next_c_row = Rast_allocate_c_buf();
        }
        else {
            prev_d_row = Rast_allocate_d_buf();
            next_d_row = Rast_allocate_d_buf();
        }

        G_begin_distance_calculations();
    }

    /* Extract raster values from file and store in cache */
    G_debug(1, "Extracting raster values");

    cur_row = -1;

    for (point = 0; point < point_cnt; point++) {
        if (cache[point].count > 1)
            continue; /* duplicate cats */

        if (cur_row != cache[point].row) {
            if (out_type == CELL_TYPE) {
                Rast_get_c_row(fd, cell_row, cache[point].row);

                if (interp_flag->answer) {
                    if (cache[point].row <= 0)
                        Rast_set_null_value(prev_c_row, window.cols, out_type);
                    else
                        Rast_get_c_row(fd, prev_c_row, cache[point].row - 1);

                    if (cache[point].row + 1 > window.rows - 1)
                        Rast_set_null_value(next_c_row, window.cols, out_type);
                    else
                        Rast_get_c_row(fd, next_c_row, cache[point].row + 1);
                }
            }
            else {
                Rast_get_d_row(fd, dcell_row, cache[point].row);

                if (interp_flag->answer) {
                    if (cache[point].row <= 0)
                        Rast_set_null_value(prev_d_row, window.cols,
                                            DCELL_TYPE);
                    else
                        Rast_get_d_row(fd, prev_d_row, cache[point].row - 1);

                    if (cache[point].row + 1 > window.rows - 1)
                        Rast_set_null_value(next_d_row, window.cols,
                                            DCELL_TYPE);
                    else
                        Rast_get_d_row(fd, next_d_row, cache[point].row + 1);
                }
            }
        }
        cur_row = cache[point].row;

        if (!interp_flag->answer) {
            if (out_type == CELL_TYPE)
                cache[point].value = cell_row[cache[point].col];
            else
                cache[point].dvalue = dcell_row[cache[point].col];
        }
        else {
            /* do four-way IDW */
            /* TODO: optimize, parallelize, and function-ize! */
            double distance[4], weight[4];
            double weightsum, valweight;
            int col_offset, row_offset;

            weightsum = valweight = 0;

            if (cache[point].x <
                Rast_col_to_easting(cache[point].col, &window) +
                    window.ew_res / 2)
                col_offset = -1;
            else
                col_offset = +1;

            if (cache[point].y >
                Rast_row_to_northing(cache[point].row, &window) -
                    window.ns_res / 2)
                row_offset = -1;
            else
                row_offset = +1;

            distance[0] =
                G_distance(cache[point].x, cache[point].y,
                           Rast_col_to_easting(cache[point].col, &window) +
                               window.ew_res / 2,
                           Rast_row_to_northing(cache[point].row, &window) -
                               window.ns_res / 2);

            distance[1] = G_distance(
                cache[point].x, cache[point].y,
                Rast_col_to_easting(cache[point].col + col_offset, &window) +
                    window.ew_res / 2,
                Rast_row_to_northing(cache[point].row, &window) -
                    window.ns_res / 2);

            if (row_offset == -1) {
                distance[2] = G_distance(
                    cache[point].x, cache[point].y,
                    Rast_col_to_easting(cache[point].col + col_offset,
                                        &window) +
                        window.ew_res / 2,
                    Rast_row_to_northing(cache[point].row - 1, &window) -
                        window.ns_res / 2);
                distance[3] = G_distance(
                    cache[point].x, cache[point].y,
                    Rast_col_to_easting(cache[point].col, &window) +
                        window.ew_res / 2,
                    Rast_row_to_northing(cache[point].row - 1, &window) -
                        window.ns_res / 2);
            }
            else {
                distance[2] = G_distance(
                    cache[point].x, cache[point].y,
                    Rast_col_to_easting(cache[point].col + col_offset,
                                        &window) +
                        window.ew_res / 2,
                    Rast_row_to_northing(cache[point].row + 1, &window) -
                        window.ns_res / 2);
                distance[3] = G_distance(
                    cache[point].x, cache[point].y,
                    Rast_col_to_easting(cache[point].col, &window) +
                        window.ew_res / 2,
                    Rast_row_to_northing(cache[point].row + 1, &window) -
                        window.ns_res / 2);
            }

            if (out_type == CELL_TYPE) {

                CELL nearby_c_val[4];

                /* avoid infinite weights */
                if (distance[0] < GRASS_EPSILON) {
                    cache[point].value = cell_row[cache[point].col];
                    continue;
                }

                nearby_c_val[0] = cell_row[cache[point].col];

                if (cache[point].col + col_offset < 0 ||
                    cache[point].col + col_offset >= window.cols) /* UNTESTED */
                    Rast_set_null_value(&nearby_c_val[1], 1,
                                        out_type); /* UNTESTED */
                else
                    nearby_c_val[1] = cell_row[cache[point].col + col_offset];

                if (row_offset == -1) {
                    if (cache[point].col + col_offset < 0 ||
                        cache[point].col + col_offset >= window.cols)
                        Rast_set_null_value(&nearby_c_val[2], 1, out_type);
                    else
                        nearby_c_val[2] =
                            prev_c_row[cache[point].col + col_offset];

                    nearby_c_val[3] = prev_c_row[cache[point].col];
                }
                else {
                    if (cache[point].col + col_offset < 0 ||
                        cache[point].col + col_offset >= window.cols)
                        Rast_set_null_value(&nearby_c_val[2], 1, out_type);
                    else
                        nearby_c_val[2] =
                            next_c_row[cache[point].col + col_offset];

                    nearby_c_val[3] = next_c_row[cache[point].col];
                }

                for (i = 0; i < 4; i++) {
                    if (!Rast_is_null_value(&nearby_c_val[i], out_type)) {
                        weight[i] = 1.0 / (distance[i] * distance[i]);
                        weightsum += weight[i];
                        valweight += weight[i] * nearby_c_val[i];
                    }
                }

                cache[point].value = valweight / weightsum;
            }
            else {
                DCELL nearby_d_val[4];

                /* avoid infinite weights */
                if (distance[0] < GRASS_EPSILON) {
                    cache[point].dvalue = dcell_row[cache[point].col];
                    continue;
                }

                nearby_d_val[0] = dcell_row[cache[point].col];

                if (cache[point].col + col_offset < 0 ||
                    cache[point].col + col_offset >= window.cols)
                    Rast_set_null_value(&nearby_d_val[1], 1, out_type);
                else
                    nearby_d_val[1] = dcell_row[cache[point].col + col_offset];

                if (row_offset == -1) {
                    if (cache[point].col + col_offset < 0 ||
                        cache[point].col + col_offset >= window.cols)
                        Rast_set_null_value(&nearby_d_val[2], 1, out_type);
                    else
                        nearby_d_val[2] =
                            prev_d_row[cache[point].col + col_offset];

                    nearby_d_val[3] = prev_d_row[cache[point].col];
                }
                else {
                    if (cache[point].col + col_offset < 0 ||
                        cache[point].col + col_offset >= window.cols)
                        Rast_set_null_value(&nearby_d_val[2], 1, out_type);
                    else
                        nearby_d_val[2] =
                            next_d_row[cache[point].col + col_offset];

                    nearby_d_val[3] = next_d_row[cache[point].col];
                }

                for (i = 0; i < 4; i++) {
                    if (!Rast_is_null_value(&nearby_d_val[i], out_type)) {
                        weight[i] = 1.0 / (distance[i] * distance[i]);
                        weightsum += weight[i];
                        valweight += weight[i] * nearby_d_val[i];
                    }
                }

                cache[point].dvalue = valweight / weightsum;
            }
        }
    } /* point loop */
    Rast_close(fd);

    if (print_flag->answer) {
        dupl_cnt = 0;

        if (Fi)
            G_message("%s|value", Fi->key);
        else
            G_message("cat|value");

        for (point = 0; point < point_cnt; point++) {
            if (cache[point].count > 1) {
                G_warning(_("Multiple points (%d) of category %d, value set to "
                            "'NULL'"),
                          cache[point].count,
                          cache[point].cat); /* TODO: improve message */
                dupl_cnt++;
            }

            fprintf(stdout, "%d|", cache[point].cat);

            if (out_type == CELL_TYPE) {
                if (cache[point].count > 1 ||
                    Rast_is_c_null_value(&cache[point].value)) {
                    fprintf(stdout, "*");
                }
                else
                    fprintf(stdout, "%d", cache[point].value);
            }
            else { /* FCELL or DCELL */
                if (cache[point].count > 1 ||
                    Rast_is_d_null_value(&cache[point].dvalue)) {
                    fprintf(stdout, "*");
                }
                else
                    fprintf(stdout, "%.*g", width, cache[point].dvalue);
            }
            fprintf(stdout, "\n");
        }
    }
    else {
        /* Update table from cache */
        G_debug(1, "Updating db table");

        /* select existing categories to array (array is sorted) */
        select = db_select_int(driver, Fi->table, Fi->key, NULL, &catexst);

        db_begin_transaction(driver);

        norec_cnt = update_cnt = upderr_cnt = dupl_cnt = 0;

        G_message("Update vector attributes...");
        for (point = 0; point < point_cnt; point++) {
            if (cache[point].count > 1) {
                G_warning(_("Multiple points (%d) of category %d, value set to "
                            "'NULL'"),
                          cache[point].count, cache[point].cat);
                dupl_cnt++;
            }

            G_percent(point, point_cnt, 2);

            /* category exist in DB ? */
            cex = (int *)bsearch((void *)&(cache[point].cat), catexst, select,
                                 sizeof(int), srch_cat);
            if (cex == NULL) { /* cat does not exist in DB */
                norec_cnt++;
                G_warning(_("No record for category %d in table <%s>"),
                          cache[point].cat, Fi->table);
                continue;
            }

            sprintf(buf, "update %s set %s = ", Fi->table, opt.col->answer);

            db_set_string(&stmt, buf);

            if (out_type == CELL_TYPE) {
                if (cache[point].count > 1 ||
                    Rast_is_c_null_value(&cache[point].value)) {
                    sprintf(buf, "NULL");
                }
                else
                    sprintf(buf, "%d ", cache[point].value);
            }
            else { /* FCELL or DCELL */
                if (cache[point].count > 1 ||
                    Rast_is_d_null_value(&cache[point].dvalue)) {
                    sprintf(buf, "NULL");
                }
                else
                    sprintf(buf, "%.*g", width, cache[point].dvalue);
            }
            db_append_string(&stmt, buf);

            sprintf(buf, " where %s = %d", Fi->key, cache[point].cat);
            db_append_string(&stmt, buf);
            /* user provides where condition: */
            if (opt.where->answer) {
                sprintf(buf, " AND %s", opt.where->answer);
                db_append_string(&stmt, buf);
            }
            G_debug(3, "%s", db_get_string(&stmt));

            /* Update table */
            if (db_execute_immediate(driver, &stmt) == DB_OK) {
                update_cnt++;
            }
            else {
                upderr_cnt++;
            }
        }
        G_percent(1, 1, 1);

        G_debug(1, "Committing DB transaction");
        db_commit_transaction(driver);

        G_free(catexst);
        db_close_database_shutdown_driver(driver);
        db_free_string(&stmt);
    }

    /* Report */
    G_verbose_message(_("%d categories loaded from vector"), point_cnt);
    if (dupl_cnt > 0)
        G_message(_("%d duplicate categories in vector map <%s>"), dupl_cnt,
                  opt.vect->answer);

    if (!print_flag->answer) {
        G_verbose_message(_("%d categories loaded from table"), select);
        G_verbose_message(_("%d categories from vector missing in table"),
                          norec_cnt);
        if (upderr_cnt > 0)
            G_warning(_("%d update errors"), upderr_cnt);

        G_done_msg(_("%d records updated."), update_cnt);
    }

    exit(EXIT_SUCCESS);
}
