/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * Copyright by the Board of Trustees of the University of Illinois.         *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of HDF.  The full HDF copyright notice, including       *
 * terms governing use, modification, and redistribution, is contained in    *
 * the files COPYING and Copyright.html.  COPYING can be found at the root   *
 * of the source code distribution tree; Copyright.html can be found at      *
 * http://hdfgroup.org/products/hdf4/doc/Copyright.html.  If you do not have *
 * access to either file, you may request a copy from help@hdfgroup.org.     *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#ifdef RCSID
static char RcsId[] = "@(#)$Revision: 4937 $";
#endif

/* $Id: he_file.c 4937 2007-09-10 16:36:16Z pvn $ */

/* --- he-file.c  --- file and annotation manipulation routines */
#include "he.h"
#ifdef VMS
#   include <descrip.h>
#   include <processes.h>
#   include <unixlib.h>
/*
#   include <tpudef.h>
*/
#   include <tpu$routines>
#endif

/* get the prototype for the wait() func. */
#if defined SUN | defined HP9000 | defined IRIX | defined UNIX386
#include <sys/wait.h>
#endif /* SUN | HP9000 */
#if defined _POSIX_SOURCE | defined IRIX
#include <unistd.h>
#endif

int
HEannotate(HE_CMD * cmd)
{
    int i;
    const char       *editor = NULL;
    int         ann = HE_LABEL;

    for (i = 1; i < cmd->argc; i++)
        if (cmd->argv[i][0] == '-')
            switch (findOpt(cmd->argv[i] + 1))
              {
                  case HE_HELP:
                      puts("annotate [-label|-descriptor] [-editor <editor>]");
                      puts("\tEdit an annotation");
                      puts("\t-label\t\tEdit label (default)");
                      puts("\t-descriptor\tEdit descriptor");
                      puts("\t-editor\t\tUse editor (default EDITOR env value)");
                      return HE_OK;
                  case HE_LABEL:
                      ann = HE_LABEL;
                      break;
                  case HE_DESCRIPTOR:
                      ann = HE_DESCRIPTOR;
                      break;
                  case HE_EDITOR:
                      if (++i < cmd->argc)
                          editor = cmd->argv[i];
                      break;
                  case HE_NOTFOUND:
                      unkOpt(cmd->argv[i]);
                      return HE_FAIL;
                  case HE_AMBIG:
                      ambigOpt(cmd->argv[i]);
                      return HE_FAIL;
                  default:
                      irrOpt(cmd->argv[i]);
                      return HE_FAIL;
              }
        else
          {
              unkArg(cmd->argv[i]);
              return HE_FAIL;
          }
    return annotate(editor, ann);
}

/* Edit annontations (labels and descriptions) for the
 * current data element */
int
annotate(const char *editor, int ann)
{

#if !defined MAC && !defined WIN386 && !defined(macintosh)

    int32       len;            /* length of annotation */
    char       *buf;            /* annotation buffer */
    char       *file;           /* tmp file name */
    int i;
    int         ret;

    /* check if any hdf file is open
     */
    if (!fileOpen())
      {
          noFile();
          return HE_FAIL;
      }

    /* Get the annotation from hdf file
     */
    len = getAnn(ann, currTag, he_desc[he_currDesc].ref, &buf);

    (void) getTmpName(&file);

    /* if there is prior annotation, put it into the tmp file
     */
    if (len > 0 && buf != NULL)
      {
          /* doctor the buffer a little for the editors
           */
          if (ann == HE_LABEL)
              buf[len] = '\n';
          else
              len--;
          writeToFile(file, buf, len + 1);
          HDfree(buf);
      }

#ifndef VMS
    /* make sure some editor will be used
       * defaults to /usr/bin/ex
       * but should be made a comple time option
     */
    if (editor == NULL)
      {
          editor = (char *) getenv("EDITOR");
          if (editor == NULL)
              editor = "/usr/bin/ex";
      }
#ifdef CRAYMPP
    {	char	cmd[256];
	if (HDstrlen(editor) > 100) {
	    fprintf(stderr, "Environment variable EDITOR too big\n");
	}
	else {
	    sprintf(cmd, "%s %s", editor, file);
	    system(cmd);
	}
    }
#else
    /* Use the fork/wait or system methods if supported, else no support. */
#ifdef __CRAY_XT3__
    fprintf(stderr, "annotate feature not supported.\n");
#else
#if defined(H4_HAVE_FORK) && defined(H4_HAVE_WAIT)
    if (fork() == 0)
      {
          /* this is the child */
          if (execl(editor, editor, file, 0) == -1)
              fprintf(stderr, "Error while editing label.\n");

          /* return control to the parent if exec fails
           */
          exit(0);
      }

    /* the parent waits for the child to die */
    wait(0);
#elif defined(H4_HAVE_SYSTEM)
    {   char    cmd[256];
        if (HDstrlen(editor) > 100) {
            fprintf(stderr, "Environment variable EDITOR too big\n");
        }
        else {
            sprintf(cmd, "%s %s", editor, file);
            system(cmd);
        }
    }
#endif
#endif
#endif
#else  /* VMS  */
    if (vfork() == 0)
        /* this is the child */
      {
          intn        ret_status;
 
          $DESCRIPTOR(input_file, file);
          $DESCRIPTOR(output_file, file);
          ret_status = TPU$EDIT(&input_file, &output_file);
          fprintf(stderr, "TPU$EDIT return status: %d. \n", ret_status);
          exit(0);
      }

    /* the parent waits for the child to die */
    wait(0);
#endif

    /* read in edited annotation
     */
    len = readFromFile(file, &buf);
    if (len <= 0 || buf == NULL)
        return len;

    /* doctor the buffer for standard format
     */
    if (ann == HE_LABEL)
      {
          /* take out control characters from the end */
          for (i = len; i >= 0 && !isgraph((int)buf[i]); i--)
              ;
          buf[i + 1] = '\0';
      }

    /* forget the tmp file
     */
    removeFile(file);

    /* write annotation to the hdf file
     */
    ret = putAnn(ann, currTag, he_desc[he_currDesc].ref, buf, len);
    updateDesc();

    /* clean up
     */
    HDfree(buf);
    return ret;

#else
    /* shut compiler up */
    ann = ann;
    editor = editor;

    return 1;

#endif /* not def MAC & WIN386 & macintosh */

}

extern int  he_backup;

int
HEopen(HE_CMD * cmd)
{
    int         backup = YES;
    int i;
    char       *file = NULL;

    for (i = 1; i < cmd->argc; i++)
        if (cmd->argv[i][0] != '-')
          {
              if (!file)
                  file = cmd->argv[i];
              else
                {
                    fprintf(stderr, "Only one file allowed.\n");
                    return FAIL;
                }
          }
        else
            switch (findOpt(cmd->argv[i] + 1))
              {
                  case HE_HELP:
                      puts("open <file> [-nobackup]");
                      puts("\t-nobackup\tDon't make a backup for this file.");
                      return HE_OK;
                  case HE_NOBACKUP:
                      backup = 0;
                      break;
                  case HE_NOTFOUND:
                      unkOpt(cmd->argv[i]);
                      return FAIL;
                  case HE_AMBIG:
                      ambigOpt(cmd->argv[i]);
                      return FAIL;
                  default:
                      irrOpt(cmd->argv[i]);
                      return FAIL;
              }

    if (!file)
      {
          fprintf(stderr, "Please specify a file name.\n");
          return FAIL;
      }

    return openFile(file, backup);
}

/* openFile -- Internal open file routine. */
/* Called by:   HEopen, main */
/* Returns:     HE_OK and FAIL */
int
openFile(char *file, int backup)
{
    ASSERT(file);

    /* only allow one file at a time */
    if (fileOpen())
      {
          fprintf(stderr, "File: %s is still open. Close before reopening.\n",
                  he_file);
          return FAIL;
      }

    /* Make backup first if necessary */
    if (backup)
      {
          if (backupFile(file) < 0)
              return FAIL;
          he_backup = 1;
      }
    else
        he_backup = 0;

    if (initFile(file) < 0)
        return FAIL;

    return HE_OK;
}

/* HEclose -- close current file */
/* Called by HEdoCmd */
int
HEclose(HE_CMD * cmd)
{
    int i;
    int         keep = NO;

    for (i = 1; i < cmd->argc; i++)
        if (cmd->argv[i][0] != '-')
          {
              unkArg(cmd->argv[i]);
              return FAIL;
          }
        else
            switch (findOpt(cmd->argv[i] + 1))
              {
                  case HE_HELP:
                      puts("close [-keep]");
                      puts("\t-keep\t\tDon't delete the backup file.");
                      return HE_OK;
                  case HE_KEEP:
                      keep = YES;
                      break;
                  case HE_NOTFOUND:
                      unkOpt(cmd->argv[i]);
                      return FAIL;
                  case HE_AMBIG:
                      ambigOpt(cmd->argv[i]);
                      return FAIL;
                  default:
                      irrOpt(cmd->argv[i]);
                      return FAIL;
              }

    return closeFile(keep);
}

int
HErevert(HE_CMD * cmd)
{
    if (cmd->argc < 2)
        return revert();

    if (cmd->argv[1][0] != '-' || findOpt(cmd->argv[1] + 1) == HE_HELP)
      {
          puts("revert");
          puts("\tDiscard all changes.");
          return HE_OK;
      }
    return HE_FAIL;
}

int
HEwrite(HE_CMD * cmd)
{
    int i;
    char       *file;
    uint16      ref = 0;
    uint16      tag = 0;

    if (cmd->argc < 2 ||
        (cmd->argv[1][0] == '-' && findOpt(cmd->argv[1] + 1) == HE_HELP))
      {
          puts("write <file> [-attachto <atag> <aref>]");
          puts("\tWrite an element or group into another HDF file");
          puts("\t-attchto\tONLY for writing annontations");
          puts("\t\t\tWhat element to attach annotation to");
          return HE_OK;
      }

    file = cmd->argv[1];
    for (i = 2; i < cmd->argc; i++)
        if (cmd->argv[i][0] != '-')
            file = cmd->argv[i];
        else
            switch (findOpt(cmd->argv[i] + 1))
              {
                  case HE_ATTACHTO:
                      tag = (uint16) atoi(cmd->argv[++i]);
                      ref = (uint16) atoi(cmd->argv[++i]);
                      break;
                  case HE_NOTFOUND:
                      unkOpt(cmd->argv[i]);
                      return HE_FAIL;
                  case HE_AMBIG:
                      ambigOpt(cmd->argv[i]);
                      return HE_FAIL;
                  default:
                      irrOpt(cmd->argv[i]);
                      return HE_FAIL;
              }
    return writ(file, tag, ref);
}

int
writ(char *file, uint16 tag, uint16 ref)
{
    int         ret;
    uint16      ref1;

    if (!fileOpen())
      {
          noFile();
          return HE_FAIL;
      }
    if (!HDstrcmp(file, he_file))
      {
          fprintf(stderr, "Cannot write to self.\n");
          return HE_FAIL;
      }

    /* handle special cases */
    if (isAnnot(currTag))
        return writeAnnot(file, tag, ref);
    if (isGrp(currTag))
        return writeGrp(file);

    if (getNewRef(file, &ref1) < 0)
        return HE_FAIL;

    ret = writeElt(file, ref1, he_currDesc);
    return ret;
}

/* --------------------------- get a r8 from a file ----------------------- */

int
HEgetR8(HE_CMD * cmd)
{
    int i;
    int         xdim = 0, ydim = 0;
    char       *image, *pal = NULL;
    int         compress = 0;

    if (cmd->argc < 4 ||
        (cmd->argv[1][0] == '-' && findOpt(cmd->argv[1] + 1) == HE_HELP))
      {
          puts("getr8 <image> <xdim> <ydim> [-palette <palette>] [-raster|-rle|-imcomp]");
          puts("\tGet a r8 group from raw files");
          puts("\t-palette\tRaw palette file");
          puts("\t-raster\t\tNo compression (default)");
          puts("\t-rle\t\tRun-length compression");
          puts("\t-imcomp\t\tImcomp compression");
          return HE_OK;
      }
    image = cmd->argv[1];
    xdim = atoi(cmd->argv[2]);
    ydim = atoi(cmd->argv[3]);

    for (i = 4; i < cmd->argc; i++)
        if (cmd->argv[i][0] == '-')
            switch (findOpt(cmd->argv[i] + 1))
              {
                  case HE_PALETTE:
                      pal = cmd->argv[++i];
                      break;
                  case HE_RASTER:
                      compress = 0;
                      break;
                  case HE_RLE:
                      compress = HE_RLE;
                      break;
                  case HE_IMCOMP:
                      compress = HE_IMCOMP;
                      break;
                  case HE_NOTFOUND:
                      unkOpt(cmd->argv[i]);
                      return FAIL;
                  case HE_AMBIG:
                      ambigOpt(cmd->argv[i]);
                      return FAIL;
                  default:
                      irrOpt(cmd->argv[i]);
                      return FAIL;
              }
        else
          {
              unkArg(cmd->argv[i]);
              return FAIL;
          }

    if (!image)
      {
          fprintf(stderr, "No image file specified.\n");
          return FAIL;
      }
    if (xdim == 0 || ydim == 0)
      {
          fprintf(stderr, "No dimensions specified.\n");
          return FAIL;
      }
    return getR8(xdim, ydim, image, pal, compress);
}

/* --------------- generic put routines ---------------------- */

int
HEput(HE_CMD * cmd)
{
    int i;
    int         verbose = NO;
    char       *template = (char *)"elt#.@";

    for (i = 1; i < cmd->argc; i++)
        if (cmd->argv[i][0] == '-')
            switch (findOpt(cmd->argv[i] + 1))
              {
                  case HE_HELP:
                      puts("put [-file <file>] [-verbose]");
                      puts("\tPut the raw binary of this element in a file");
                      puts("\t-file\t\tOut file name (default \"elt#.@\")");
                      puts("\t-verbose\tOutput diagnostic info");
                      return HE_OK;
                  case HE_FILE:
                      template = cmd->argv[++i];
                      break;
                  case HE_VERBOSE:
                      verbose = YES;
                      break;
                  case HE_NOTFOUND:
                      unkOpt(cmd->argv[i]);
                      return HE_FAIL;
                  case HE_AMBIG:
                      ambigOpt(cmd->argv[i]);
                      return HE_FAIL;
                  default:
                      irrOpt(cmd->argv[i]);
                      return HE_FAIL;
              }
        else
          {
              unkArg(cmd->argv[i]);
              return HE_FAIL;
          }
    return put(template, verbose);
}

int
put(char *template, int verbose)
{
    int         length;
    char       *data;
    int         ret;

    length = (int) getElement(he_currDesc, &data);
    if ((length <= 0) || (data == NULL))
        return HE_FAIL;
    ret = putWithTempl(template, he_currDesc, length, 1, data, length,
                       verbose);
    HDfree(data);

    return ret;
}

/* ------------------ routines to put an r8 into a file --------------------- */

int
HEputR8(HE_CMD * cmd)
{
    int i;
    int         verbose = NO;
    char       *image = "img#.@.%";
    char       *pal = "pal#";

    for (i = 1; i < cmd->argc; i++)
        if (cmd->argv[i][0] == '-')
            switch (findOpt(cmd->argv[i] + 1))
              {
                  case HE_HELP:
                      puts("putr8 [-image <img>] [-palette <pal>] [-verbose]");
                      puts("\tPut an r8 group into raw image and palette files");
                      puts("\t-image\t\tImage file name template (default \"img#.@.%\")");
                      puts("\t-palette\tPalette file name template (default \"pal#\")");
                      puts("\t-verbose\tTo give output of steps taken");
                      return HE_OK;
                  case HE_IMAGE:
                      image = cmd->argv[++i];
                      break;
                  case HE_PALETTE:
                      pal = cmd->argv[++i];
                      break;
                  case HE_VERBOSE:
                      verbose = YES;
                      break;
                  case HE_NOTFOUND:
                      unkOpt(cmd->argv[i]);
                      return HE_FAIL;
                  case HE_AMBIG:
                      ambigOpt(cmd->argv[i]);
                      return HE_FAIL;
                  default:
                      irrOpt(cmd->argv[i]);
                      return HE_FAIL;
              }
        else
          {
              unkArg(cmd->argv[i]);
              return HE_FAIL;
          }
    return putR8(image, pal, verbose);
}

int
putR8(char *image, char *pal, int verbose)
{
    int         ret;
    int32       xdim, ydim;
    char       *palette;
    char       *raster;

    if (!fileOpen())
      {
          noFile();
          return HE_FAIL;
      }
    if (!isRig(currTag))
      {
          fprintf(stderr, "Current element not an image group.");
          return HE_FAIL;
      }
    getCurrRig(&xdim, &ydim, &palette, &raster);
    if (raster == NULL)
      {
          fprintf(stderr, "Cannot find raster.\n");
          return HE_FAIL;
      }
    ret = putWithTempl(image, he_currDesc, (int) xdim, (int) ydim, raster, (int) (xdim * ydim),
                       verbose);
    HDfree(raster);
    if (ret < 0)
        return HE_FAIL;
    if (palette != NULL)
      {
          int i;
          char        p[HE_PALETTE_SZ];

          for (i = 0; i < HE_COLOR_SZ; i++)
            {
                p[i] = *palette++;
                p[HE_COLOR_SZ + i] = *palette++;
                p[2 * HE_COLOR_SZ + i] = *palette++;
            }
          ret = putWithTempl(pal, he_currDesc, (int) xdim, (int) ydim, p,
                             HE_PALETTE_SZ, verbose);
          HDfree(palette);
          if (ret < 0)
              return HE_FAIL;
      }

    return HE_OK;
}

/* end of he-file.c */
