eccodes/tools/grib_ls.cc

/*
 * (C) Copyright 2005- ECMWF.
 *
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
 *
 * In applying this licence, ECMWF does not waive the privileges and immunities granted to it by
 * virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.
 */

#include "grib_tools.h"

grib_option grib_options[] = {
    /*  {id, args, help}, on, command_line, value*/
    { "f", 0, 0, 1, 0, 0 },
    { "p:", 0, 0, 0, 1, 0 },
    { "F:", 0, 0, 1, 1, "%g" },
    { "P:", 0, 0, 0, 1, 0 },
    { "w:", 0, 0, 0, 1, 0 },
    { "j", 0, "JSON output.\n", 0, 1, 0 },
    { "B:", 0, 0, 0, 1, 0 },
    { "l:", 0, 0, 0, 1, 0 },
    { "s:", 0, 0, 0, 1, 0 },
    { "i:", 0, 0, 0, 1, 0 },
    { "n:", 0, 0, 1, 1, "ls" },
    { "m", 0, 0, 0, 1, 0 },
    { "V", 0, 0, 0, 1, 0 },
    { "W:", 0, 0, 1, 1, "10" },
    { "S", 0, 0, 1, 0, 0 },
    { "M", 0, 0, 0, 1, 0 },
    { "H", 0, 0, 1, 0, 0 },
    { "g", 0, 0, 0, 1, 0 },
    { "P", 0, 0, 1, 0, 0 },
    { "T:", 0, 0, 0, 1, 0 },
    { "7", 0, 0, 0, 1, 0 },
    { "v", 0, 0, 1, 0, 0 },
    { "X:", 0, 0, 0, 1, 0 },
    { "x", 0, 0, 0, 1, 0 },
    { "h", 0, 0, 0, 1, 0 },
};

const char* tool_description =
    "List content of GRIB files printing values of "
    "some keys.\n\tIt does not fail when a key is not found.";
const char* tool_name       = "grib_ls";
const char* tool_online_doc = "https://confluence.ecmwf.int/display/ECC/grib_ls";
const char* tool_usage      = "[options] grib_file grib_file ...";
static const char* new_handle = "";

int grib_options_count = sizeof(grib_options) / sizeof(grib_option);
static double lat      = 0;
static double lon      = 0;
static int mode        = 0;
/* Note:
 * There are two JSON-output modes:
 *  1. With a provided lat-lon for the nearest neighbour (options->latlon==1)
 *  2. All other cases (options->json_output==1)
 * The first is special and has a very different format. They need to be
 * treated differently
 */
static int json_latlon       = 0;
static int first_handle      = 1;
static grib_nearest* nearest = NULL;

int main(int argc, char* argv[])
{
    return grib_tool(argc, argv);
}

/*
 This is executed before processing the options with
 getopt and therefore it is the right place for hacking
 the arguments if needed
*/
int grib_tool_before_getopt(grib_runtime_options* options)
{
    return 0;
}

/*
 The options have been parsed and the structure
 grib_runtime_options* options has been loaded.
 Initialisation and startup can be done here
*/
int grib_tool_init(grib_runtime_options* options)
{
    char *theEnd = NULL, *end1 = NULL;
    size_t size = 4;
    int ret     = 0;
    double min = 0, max = 0;
    int i   = 0;
    char* p = NULL;
    if (options->latlon && grib_options_on("j")) {
        options->verbose = 0;
        json_latlon      = 1;
    }

    if (options->latlon) {
        lat = strtod(options->latlon, &theEnd);
        if (*theEnd != ',') {
            fprintf(stderr, "%s: Wrong latitude value. Please use 'latitude,longitude'\n", tool_name);
            exit(1);
        }
        lon = strtod(++theEnd, &end1);

        mode = GRIB_NEAREST_SAME_POINT | GRIB_NEAREST_SAME_GRID;

        if (end1 && *end1 == ',') {
            end1++;
            if (*end1 != '0') {
                p = end1;
                while (*p != ',' && *p != '\0')
                    p++;
                if (*end1 == '4') {
                    options->latlon_mode = 4;
                }
                else if (*end1 == '1') {
                    options->latlon_mode = 1;
                }
                else {
                    fprintf(stderr, "%s: Wrong mode given for the '-l' option (Please use 1 or 4)\n", tool_name);
                    exit(1);
                }
            }
            if (p && *p == ',') {
                p++;
                options->latlon_mask = strdup(p);
            }
        }
    }

    if (options->latlon && options->latlon_mask) {
        grib_handle* hh;
        int idx = 0, land_found = 0;
        double min_overall = 0.0;
        int idx_overall    = -1;
        FILE* f            = fopen(options->latlon_mask, "r");
        if (!f) {
            fprintf(stderr, "%s: unable to open mask file %s\n", tool_name, options->latlon_mask);
            perror(options->latlon_mask);
            exit(1);
        }
        hh = grib_handle_new_from_file(0, f, &ret);
        fclose(f);
        GRIB_CHECK_NOLINE(ret, 0);
        nearest = grib_nearest_new(hh, &ret);
        GRIB_CHECK_NOLINE(ret, 0);
        GRIB_CHECK_NOLINE(grib_nearest_find(nearest, hh, lat, lon, mode,
                                            options->lats, options->lons, options->mask_values, options->distances, options->indexes, &size),
                          0);
        grib_nearest_delete(nearest);
        nearest = NULL;
        grib_handle_delete(hh);

        max                 = options->distances[0];
        for (i = 0; i < LATLON_SIZE; i++)
            if (max < options->distances[i]) {
                max = options->distances[i];
            }
        min         = max;
        min_overall = max;
        /* See GRIB-213 */
        for (i = 0; i < LATLON_SIZE; i++) {
            if (min_overall >= options->distances[i]) { /* find overall min and index ignoring mask */
                min_overall = options->distances[i];
                idx_overall = i;
            }
            if ((min >= options->distances[i]) && (options->mask_values[i] >= 0.5)) {
                land_found = 1; /* found at least one point which is land */
                min        = options->distances[i];
                idx        = i;
            }
        }
        if (land_found) {
            options->latlon_idx = idx;
        }
        else {
            options->latlon_idx = idx_overall; /* all points were sea, so pick the min overall */
        }

        if (options->latlon_idx < 0) {
            min                 = 0;
            options->latlon_idx = 0;
            for (i = 1; i < LATLON_SIZE; i++)
                if (min > options->distances[i]) {
                    min                 = options->distances[i];
                    options->latlon_idx = i;
                }
        }
    }
    if (json_latlon)
        printf("[\n");

    return 0;
}

/*
 A new file is being parsed. The file name is file. This function is called every time
 a new input file name is processed, before opening the file.
*/
int grib_tool_new_filename_action(grib_runtime_options* options, const char* file)
{
    return 0;
}

int grib_tool_new_file_action(grib_runtime_options* options, grib_tools_file* file)
{
    exit_if_input_is_directory(tool_name, file->name);
    if (nearest)
        grib_nearest_delete(nearest);
    nearest = NULL;
    return 0;
}

static void print_key_values(grib_runtime_options* options, grib_handle* h)
{
    int i;
    int ret       = 0;
    const char* s = "\"keys\" : {";
    double dvalue = 0;
    long lvalue   = 0;
    char value[MAX_STRING_LEN];
    size_t len = MAX_STRING_LEN;
    for (i = 0; i < options->print_keys_count; i++) {
        ret = GRIB_SUCCESS;
        printf("%s", s);
        len = MAX_STRING_LEN;
        printf("\"%s\" : ", options->print_keys[i].name);
        if (grib_is_missing(h, options->print_keys[i].name, &ret) && ret == GRIB_SUCCESS)
            printf("\"missing\"");
        else if (ret == GRIB_SUCCESS) {
            if (options->print_keys[i].type == GRIB_TYPE_UNDEFINED)
                grib_get_native_type(h, options->print_keys[i].name, &(options->print_keys[i].type));
            switch (options->print_keys[i].type) {
                case GRIB_TYPE_STRING:
                    ret = grib_get_string(h, options->print_keys[i].name, value, &len);
                    printf("\"%s\"", value);
                    break;
                case GRIB_TYPE_DOUBLE:
                    ret = grib_get_double(h, options->print_keys[i].name, &dvalue);
                    printf("%g", dvalue);
                    break;
                case GRIB_TYPE_LONG:
                    ret = grib_get_long(h, options->print_keys[i].name, &lvalue);
                    printf("%ld", lvalue);
                    break;
                default:
                    printf("invalid_type");
                    break;
            }
        }
        if (ret == GRIB_NOT_FOUND)
            printf("null");
        s = ", ";
    }
    printf("}");
}

/*
 A new handle is available from the current input file and can be processed here.
 The handle available in this function is in the set of messages satisfying the constraint
 of the -w option. They are not to be skipped.
*/
int grib_tool_new_handle_action(grib_runtime_options* options, grib_handle* h)
{
    size_t size = 4;
    double v    = 0;
    int err     = 0;
    int i;

    if (!options->skip) {
        if (options->set_values_count != 0)
            err = grib_set_values(h, options->set_values, options->set_values_count);

        if (err != GRIB_SUCCESS && options->fail)
            exit(err);
    }

    if (options->latlon) {
        double min;
        err = 0;
        if (!nearest)
            nearest = grib_nearest_new(h, &err);
        if (err == GRIB_NOT_IMPLEMENTED) {
            char grid_desc[200];
            int err1 = 0;
            size_t g_len = sizeof(grid_desc);
            err1 = grib_get_string(h, "gridDefinitionDescription", grid_desc, &g_len);
            if (!err1) {
                fprintf(stderr, "%s: Nearest neighbour functionality is not supported for grid: %s\n", tool_name, grid_desc);
            } else {
                fprintf(stderr, "%s: Nearest neighbour functionality is not supported for this grid type\n", tool_name);
            }
        }
        GRIB_CHECK_NOLINE(err, 0);
        {
            int nn_flag = 0;
            if (options->latlon_mask) {
                nn_flag = mode; /* ECC-638 */
            }
            GRIB_CHECK_NOLINE(grib_nearest_find(nearest, h, lat, lon, nn_flag,
                                                options->lats, options->lons, options->values,
                                                options->distances, options->indexes, &size),
                              0);
        }

        if (!options->latlon_mask) {
            min                 = options->distances[0];
            options->latlon_idx = 0;
            for (i = 1; i < LATLON_SIZE; i++) {
                if (min > options->distances[i]) {
                    min                 = options->distances[i];
                    options->latlon_idx = i;
                }
            }
        }

        if (json_latlon) {
            int istart = 0;
            int iend   = LATLON_SIZE;
            const char* s       = "\n[\n";
            double missingValue = 9999;
            char value[MAX_STRING_LEN];
            size_t len = MAX_STRING_LEN;
            printf("%s", new_handle);
            printf("{\n");
            print_key_values(options, h);
            if (options->latlon_mode == 4) {
                printf("\n, \"selected\" : %d", options->latlon_idx);
            } else {
                printf("\n");
            }
            printf(", \"method\" : ");
            if (options->latlon_mask)
                printf("\"nearest_land\"");
            else
                printf("\"nearest\"");
            printf("\n, \"neighbours\" : ");
            if (options->latlon_mode == 1) {
                istart = options->latlon_idx;
                iend = istart + 1;
            }
            for (i = istart; i < iend; i++) {
                printf("%s", s);
                len = MAX_STRING_LEN;
                printf(
                    "{\"index\" : %d, \"latitude\" : %g, \"longitude\" : %g, \"distance\" : %g, "
                    "\"distance_unit\" : \"km\", ",
                    (int)options->indexes[i], options->lats[i], options->lons[i],
                    options->distances[i]);
                if (grib_get_double_element(h, "values", options->indexes[i], &v) == GRIB_SUCCESS) {
                    if (v == missingValue)
                        printf("\"value\" : null ");
                    else
                        printf("\"value\" : %g ", v);
                }

                if (grib_get_string(h, "units", value, &len) == GRIB_SUCCESS)
                    printf(", \"unit\" : \"%s\"", value);

                if (options->latlon_mask)
                    printf(", \"mask_value\" : %.2f", options->mask_values[i]);
                printf("}");
                s = "\n,";
            }

            printf("\n]");
            printf("\n}");
        }
    }

    if (!json_latlon && options->json_output) {
        if (!first_handle && options->handle_count > 1) {
            fprintf(stdout, ",\n");
        }
        if (options->json_output && first_handle) {
            fprintf(stdout, "{ \"messages\" : [ \n");
            first_handle = 0;
        }
    }

    if (options->current_infile && options->current_infile->name) {
        size = strlen(options->current_infile->name);
        grib_set_string(h, "file", options->current_infile->name, &size);
    }

    new_handle = "\n,";
    return 0;
}

/*
 A new handle to skip is available. At this point something can be done
 with the message to be skipped before deleting the handle
*/
int grib_tool_skip_handle(grib_runtime_options* options, grib_handle* h)
{
    grib_handle_delete(h);
    return 0;
}

/* This is executed after the last message in the last file is processed */
int grib_tool_finalise_action(grib_runtime_options* options)
{
    int i = 0;
    if (options->latlon && options->verbose) {
        printf("Input Point: latitude=%.2f  longitude=%.2f\n", lat, lon);
        if (options->latlon_idx >= 0 && options->latlon_idx < LATLON_SIZE) {
            printf("Grid Point chosen #%d index=%d latitude=%.2f longitude=%.2f distance=%.2f (Km)\n",
                   options->latlon_idx + 1, (int)options->indexes[options->latlon_idx],
                   options->lats[options->latlon_idx],
                   options->lons[options->latlon_idx],
                   options->distances[options->latlon_idx]);
        }
        if (options->latlon_mask) {
            printf("Mask values:\n");
            for (i = 0; i < LATLON_SIZE; i++) {
                printf("- %d - index=%d latitude=%.2f longitude=%.2f distance=%.2f (Km) value=%.2f\n",
                       i + 1, (int)options->indexes[i], options->lats[i], options->lons[i],
                       options->distances[i], options->mask_values[i]);
            }
        }
        else {
            printf("Other grid Points\n");
            for (i = 0; i < LATLON_SIZE; i++) {
                printf("- %d - index=%d latitude=%.2f longitude=%.2f distance=%.2f (Km)\n",
                       i + 1, (int)options->indexes[i], options->lats[i], options->lons[i],
                       options->distances[i]);
            }
        }
    }

    if (!json_latlon && options->json_output)
        fprintf(stdout, "\n]}\n");

    if (nearest)
        grib_nearest_delete(nearest);
    if (json_latlon)
        printf("\n]\n");

    return 0;
}

int grib_no_handle_action(grib_runtime_options* options, int err)
{
    if (options->json_output) {
        if (first_handle) {
            fprintf(dump_file, "{ \"messages\" : [ \n");
            first_handle = 0;
        }
        else {
            fprintf(dump_file, ",\n");
        }
    }
    fprintf(dump_file, "\t\t\"ERROR: unreadable message\"\n");
    return 0;
}