mirror of
https://github.com/Unidata/netcdf-c.git
synced 2025-01-12 15:45:21 +08:00
4d8fbbf501
dap code will create a real temporary file in which to store the converted metadata for the DAP .dds or .dmr. It was assumed that the nc_close code would reclaim the temporary file. For DAP2, reclamation occurs in the ncio code. For DAP4, it was assumed that the libsrc4 code would do the reclamation, but for whatever reason, this is not happening. Thus, in this situation, a temporary file is left in the file system. Aside from being irritating to users, this screws up 'make distcheck'. So the DAP4 code is fixed to ensure that the temporary file is properly reclaimed independent of the libsrc4 code.
517 lines
14 KiB
C
517 lines
14 KiB
C
/*********************************************************************
|
|
* Copyright 2016, UCAR/Unidata
|
|
* See netcdf/COPYRIGHT file for copying and redistribution conditions.
|
|
*********************************************************************/
|
|
|
|
#include "ncdispatch.h"
|
|
#include "ncd4dispatch.h"
|
|
#include "d4includes.h"
|
|
#include "d4read.h"
|
|
#include "d4curlfunctions.h"
|
|
|
|
#if defined(_WIN32) || defined(_WIN64)
|
|
#include <process.h>
|
|
#include <direct.h>
|
|
#endif
|
|
|
|
#ifdef HAVE_SYS_STAT_H
|
|
#include <sys/stat.h>
|
|
#endif
|
|
|
|
/**************************************************/
|
|
/* Forward */
|
|
|
|
static void applyclientmetacontrols(NCD4meta* meta);
|
|
static void applyclientparamcontrols(NCD4INFO*);
|
|
static int constrainable(NCURI*);
|
|
static void freeCurl(NCD4curl*);
|
|
static void freeInfo(NCD4INFO*);
|
|
static int paramcheck(NCD4INFO*, const char* key, const char* subkey);
|
|
static const char* getparam(NCD4INFO* info, const char* key);
|
|
static int set_curl_properties(NCD4INFO*);
|
|
|
|
/**************************************************/
|
|
/* Constants */
|
|
|
|
static const char* checkseps = "+,:;";
|
|
|
|
/**************************************************/
|
|
int
|
|
NCD4_open(const char * path, int mode,
|
|
int basepe, size_t *chunksizehintp,
|
|
int useparallel, void* mpidata,
|
|
NC_Dispatch* dispatch, NC* nc)
|
|
{
|
|
int ret = NC_NOERR;
|
|
NCD4INFO* d4info = NULL;
|
|
const char* value;
|
|
NCD4meta* meta;
|
|
|
|
if(path == NULL)
|
|
return THROW(NC_EDAPURL);
|
|
|
|
assert(dispatch != NULL);
|
|
|
|
/* Setup our NC and NCDAPCOMMON state*/
|
|
|
|
d4info = (NCD4INFO*)calloc(1,sizeof(NCD4INFO));
|
|
if(d4info == NULL) {ret = NC_ENOMEM; goto done;}
|
|
|
|
nc->dispatchdata = d4info;
|
|
nc->int_ncid = nc__pseudofd(); /* create a unique id */
|
|
d4info->controller = (NC*)nc;
|
|
|
|
/* Parse url and params */
|
|
if(ncuriparse(nc->path,&d4info->uri) != NCU_OK)
|
|
{ret = NC_EDAPURL; goto done;}
|
|
|
|
if(!constrainable(d4info->uri))
|
|
SETFLAG(d4info->controls.flags,NCF_UNCONSTRAINABLE);
|
|
|
|
/* fail if we are unconstrainable but have constraints */
|
|
if(FLAGSET(d4info->controls.flags,NCF_UNCONSTRAINABLE)) {
|
|
if(d4info->uri->query != NULL) {
|
|
nclog(NCLOGWARN,"Attempt to constrain an unconstrainable data source: %s",
|
|
d4info->uri->query);
|
|
ret = THROW(NC_EDAPCONSTRAINT);
|
|
goto done;
|
|
}
|
|
}
|
|
|
|
/* process control client parameters */
|
|
applyclientparamcontrols(d4info);
|
|
|
|
/* Use libsrc4 code (netcdf-4) for storing metadata */
|
|
{
|
|
char tmpname[NC_MAX_NAME];
|
|
|
|
/* Create fake file name: exact name must be unique,
|
|
but is otherwise irrelevant because we are using NC_DISKLESS
|
|
*/
|
|
if(strlen(d4info->controls.substratename) > 0)
|
|
snprintf(tmpname,sizeof(tmpname),"%s",d4info->controls.substratename);
|
|
else
|
|
snprintf(tmpname,sizeof(tmpname),"tmp_%d",nc->int_ncid);
|
|
|
|
/* Now, use the file to create the hidden substrate netcdf file.
|
|
We want this hidden file to always be NC_NETCDF4, so we need to
|
|
force default format temporarily in case user changed it.
|
|
If diskless is enabled, then create file in-memory, else
|
|
create an actual temporary file in the file system.
|
|
*/
|
|
{
|
|
int new = NC_NETCDF4;
|
|
int old = 0;
|
|
int ncid = 0;
|
|
int ncflags = NC_NETCDF4|NC_CLOBBER;
|
|
#ifdef USE_DISKLESS
|
|
ncflags |= NC_DISKLESS;
|
|
#endif
|
|
if(FLAGSET(d4info->controls.debugflags,NCF_DEBUG_COPY)) {
|
|
/* Cause data to be dumped to real file */
|
|
ncflags |= NC_WRITE;
|
|
ncflags &= ~(NC_DISKLESS); /* use real file */
|
|
}
|
|
nc_set_default_format(new,&old); /* save and change */
|
|
ret = nc_create(tmpname,ncflags,&ncid);
|
|
nc_set_default_format(old,&new); /* restore */
|
|
d4info->substrate.realfile = ((ncflags & NC_DISKLESS) == 0);
|
|
d4info->substrate.filename = strdup(tmpname);
|
|
if(tmpname == NULL) ret = NC_ENOMEM;
|
|
d4info->substrate.nc4id = ncid;
|
|
}
|
|
if(ret != NC_NOERR) goto done;
|
|
/* Avoid fill */
|
|
nc_set_fill(getnc4id(nc),NC_NOFILL,NULL);
|
|
}
|
|
|
|
/* Turn on logging; only do this after oc_open*/
|
|
if((value = ncurilookup(d4info->uri,"log")) != NULL) {
|
|
ncloginit();
|
|
if(nclogopen(value))
|
|
ncsetlogging(1);
|
|
ncloginit();
|
|
if(nclogopen(value))
|
|
ncsetlogging(1);
|
|
}
|
|
|
|
/* Setup a curl connection */
|
|
{
|
|
CURL* curl = NULL; /* curl handle*/
|
|
d4info->curl = (NCD4curl*)calloc(1,sizeof(NCD4curl));
|
|
if(d4info->curl == NULL)
|
|
{ret = NC_ENOMEM; goto done;}
|
|
/* create the connection */
|
|
if((ret=NCD4_curlopen(&curl))!= NC_NOERR) goto done;
|
|
d4info->curl->curl = curl;
|
|
if((ret=set_curl_properties(d4info))!= NC_NOERR) goto done;
|
|
/* Set the one-time curl flags */
|
|
if((ret=NCD4_set_flags_perlink(d4info))!= NC_NOERR) goto done;
|
|
#if 1 /* temporarily make per-link */
|
|
if((ret=NCD4_set_flags_perfetch(d4info))!= NC_NOERR) goto done;
|
|
#endif
|
|
}
|
|
|
|
d4info->curl->packet = ncbytesnew();
|
|
ncbytessetalloc(d4info->curl->packet,DFALTPACKETSIZE); /*initial reasonable size*/
|
|
|
|
/* fetch the dmr + data*/
|
|
{
|
|
int inmem = FLAGSET(d4info->controls.flags,NCF_ONDISK) ? 0 : 1;
|
|
if((ret = NCD4_readDAP(d4info,inmem))) goto done;
|
|
}
|
|
|
|
/* if the url goes astray to a random web page, then try to just dump it */
|
|
{
|
|
char* response = ncbytescontents(d4info->curl->packet);
|
|
size_t responselen = ncbyteslength(d4info->curl->packet);
|
|
|
|
/* Apply some heuristics to see what we have.
|
|
The leading byte will have the chunk flags, which should
|
|
be less than 0x0f (for now). However, it will not be zero if
|
|
the data was little-endian
|
|
*/
|
|
if(responselen == 0 || response[0] >= ' ') {
|
|
/* does not look like a chunk, so probable server failure */
|
|
if(responselen == 0)
|
|
nclog(NCLOGERR,"Empty DAP4 response");
|
|
else {/* probable html response */
|
|
nclog(NCLOGERR,"Unexpected DAP response:");
|
|
nclog(NCLOGERR,"==============================");
|
|
nclogtext(NCLOGERR,response);
|
|
nclog(NCLOGERR,"==============================\n");
|
|
}
|
|
ret = NC_EDAPSVC;
|
|
fflush(stderr);
|
|
goto done;
|
|
}
|
|
}
|
|
|
|
/* Build the meta data */
|
|
if((d4info->substrate.metadata=NCD4_newmeta(ncbyteslength(d4info->curl->packet),
|
|
ncbytescontents(d4info->curl->packet)))==NULL)
|
|
{ret = NC_ENOMEM; goto done;}
|
|
meta = d4info->substrate.metadata;
|
|
meta->controller = d4info;
|
|
meta->ncid = getnc4id(nc); /* Transfer netcdf ncid */
|
|
|
|
/* process meta control parameters */
|
|
applyclientmetacontrols(meta);
|
|
|
|
/* Infer the mode */
|
|
if((ret=NCD4_infermode(meta))) goto done;
|
|
|
|
if((ret=NCD4_dechunk(meta))) goto done;
|
|
|
|
#ifdef D4DUMPDMR
|
|
{
|
|
fprintf(stderr,"=============\n");
|
|
fputs(d4info->substrate.metadata->serial.dmr,stderr);
|
|
fprintf(stderr,"\n=============\n");
|
|
fflush(stderr);
|
|
}
|
|
#endif
|
|
|
|
if((ret = NCD4_parse(d4info->substrate.metadata))) goto done;
|
|
#ifdef D4DEBUGMETA
|
|
{
|
|
fprintf(stderr,"\n/////////////\n");
|
|
NCbytes* buf = ncbytesnew();
|
|
NCD4_print(d4info->substrate.metadata,buf);
|
|
ncbytesnull(buf);
|
|
fputs(ncbytescontents(buf),stderr);
|
|
ncbytesfree(buf);
|
|
fprintf(stderr,"\n/////////////\n");
|
|
fflush(stderr);
|
|
}
|
|
#endif
|
|
if((ret = NCD4_metabuild(d4info->substrate.metadata,d4info->substrate.metadata->ncid))) goto done;
|
|
if(ret != NC_NOERR && ret != NC_EVARSIZE) goto done;
|
|
if((ret = NCD4_processdata(d4info->substrate.metadata))) goto done;
|
|
|
|
return THROW(ret);
|
|
|
|
done:
|
|
if(ret) {
|
|
freeInfo(d4info);
|
|
nc->dispatchdata = NULL;
|
|
}
|
|
return THROW(ret);
|
|
}
|
|
|
|
int
|
|
NCD4_close(int ncid)
|
|
{
|
|
int ret = NC_NOERR;
|
|
NC* nc;
|
|
NCD4INFO* d4info;
|
|
int substrateid;
|
|
|
|
ret = NC_check_id(ncid, (NC**)&nc);
|
|
if(ret != NC_NOERR) goto done;
|
|
d4info = (NCD4INFO*)nc->dispatchdata;
|
|
substrateid = makenc4id(nc,ncid);
|
|
|
|
/* We call abort rather than close to avoid trying to write anything,
|
|
except if we are debugging
|
|
*/
|
|
if(FLAGSET(d4info->controls.debugflags,NCF_DEBUG_COPY)) {
|
|
/* Dump the data into the substrate */
|
|
if((ret = NCD4_debugcopy(d4info)))
|
|
goto done;
|
|
ret = nc_close(substrateid);
|
|
} else {
|
|
ret = nc_abort(substrateid);
|
|
}
|
|
|
|
freeInfo(d4info);
|
|
|
|
done:
|
|
return THROW(ret);
|
|
}
|
|
|
|
int
|
|
NCD4_abort(int ncid)
|
|
{
|
|
return NCD4_close(ncid);
|
|
}
|
|
|
|
/**************************************************/
|
|
|
|
static void
|
|
freeInfo(NCD4INFO* d4info)
|
|
{
|
|
if(d4info == NULL) return;
|
|
d4info->controller = NULL; /* break link */
|
|
nullfree(d4info->rawurltext);
|
|
nullfree(d4info->urltext);
|
|
ncurifree(d4info->uri);
|
|
freeCurl(d4info->curl);
|
|
nullfree(d4info->data.memory);
|
|
nullfree(d4info->data.ondiskfilename);
|
|
if(d4info->data.ondiskfile != NULL)
|
|
fclose(d4info->data.ondiskfile);
|
|
if(d4info->substrate.realfile
|
|
&& !FLAGSET(d4info->controls.debugflags,NCF_DEBUG_COPY)) {
|
|
/* We used real file, so we need to delete the temp file
|
|
unless we are debugging.
|
|
Assume caller has done nc_close|nc_abort on the ncid.
|
|
Note that in theory, this should not be necessary since
|
|
AFAIK the substrate file is still in def mode, and
|
|
when aborted, it should be deleted. But that is not working
|
|
for some reason, so we delete it ourselves.
|
|
*/
|
|
if(d4info->substrate.filename != NULL) {
|
|
unlink(d4info->substrate.filename);
|
|
}
|
|
}
|
|
nullfree(d4info->substrate.filename); /* always reclaim */
|
|
NCD4_reclaimMeta(d4info->substrate.metadata);
|
|
free(d4info);
|
|
}
|
|
|
|
static void
|
|
freeCurl(NCD4curl* curl)
|
|
{
|
|
if(curl == NULL) return;
|
|
NCD4_curlclose(curl->curl);
|
|
ncbytesfree(curl->packet);
|
|
nullfree(curl->errdata.code);
|
|
nullfree(curl->errdata.message);
|
|
nullfree(curl->curlflags.useragent);
|
|
nullfree(curl->curlflags.cookiejar);
|
|
nullfree(curl->curlflags.netrc);
|
|
nullfree(curl->ssl.certificate);
|
|
nullfree(curl->ssl.key);
|
|
nullfree(curl->ssl.keypasswd);
|
|
nullfree(curl->ssl.cainfo);
|
|
nullfree(curl->ssl.capath);
|
|
nullfree(curl->proxy.host);
|
|
nullfree(curl->proxy.userpwd);
|
|
nullfree(curl->creds.userpwd);
|
|
}
|
|
|
|
/* Define the set of protocols known to be constrainable */
|
|
static char* constrainableprotocols[] = {"http", "https",NULL};
|
|
|
|
static int
|
|
constrainable(NCURI* durl)
|
|
{
|
|
char** protocol = constrainableprotocols;
|
|
for(;*protocol;protocol++) {
|
|
if(strcmp(durl->protocol,*protocol)==0)
|
|
return 1;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/*
|
|
Set curl properties for link based on rc files etc.
|
|
*/
|
|
static int
|
|
set_curl_properties(NCD4INFO* d4info)
|
|
{
|
|
int ret = NC_NOERR;
|
|
|
|
/* defaults first */
|
|
NCD4_rcdefault(d4info);
|
|
|
|
/* extract the relevant triples into d4info */
|
|
NCD4_rcprocess(d4info);
|
|
|
|
if(d4info->curl->curlflags.useragent == NULL) {
|
|
size_t len = strlen(DFALTUSERAGENT) + strlen(VERSION) + 1;
|
|
char* agent = (char*)malloc(len+1);
|
|
strncpy(agent,DFALTUSERAGENT,len);
|
|
strncat(agent,VERSION,len);
|
|
d4info->curl->curlflags.useragent = agent;
|
|
}
|
|
|
|
/* Some servers (e.g. thredds and columbia) appear to require a place
|
|
to put cookies in order for some security functions to work
|
|
*/
|
|
if(d4info->curl->curlflags.cookiejar != NULL
|
|
&& strlen(d4info->curl->curlflags.cookiejar) == 0) {
|
|
free(d4info->curl->curlflags.cookiejar);
|
|
d4info->curl->curlflags.cookiejar = NULL;
|
|
}
|
|
|
|
if(d4info->curl->curlflags.cookiejar == NULL) {
|
|
/* If no cookie file was defined, define a default */
|
|
char tmp[4096+1];
|
|
int ok;
|
|
#if defined(_WIN32) || defined(_WIN64)
|
|
int pid = _getpid();
|
|
#else
|
|
pid_t pid = getpid();
|
|
#endif
|
|
snprintf(tmp,sizeof(tmp)-1,"%s/%s.%ld/",NCD4_globalstate->tempdir,"netcdf",(long)pid);
|
|
|
|
#if defined(_WIN32) || defined(_WIN64)
|
|
ok = _mkdir(tmp);
|
|
#else
|
|
ok = mkdir(tmp,S_IRUSR | S_IWUSR | S_IXUSR);
|
|
#endif
|
|
if(ok != 0 && errno != EEXIST) {
|
|
fprintf(stderr,"Cannot create cookie directory\n");
|
|
goto fail;
|
|
}
|
|
errno = 0;
|
|
/* Create the unique cookie file name */
|
|
ok = NCD4_mktmp(tmp,&d4info->curl->curlflags.cookiejar);
|
|
d4info->curl->curlflags.createdflags |= COOKIECREATED;
|
|
if(ok != NC_NOERR && errno != EEXIST) {
|
|
fprintf(stderr,"Cannot create cookie file\n");
|
|
goto fail;
|
|
}
|
|
errno = 0;
|
|
}
|
|
assert(d4info->curl->curlflags.cookiejar != NULL);
|
|
|
|
/* Make sure the cookie jar exists and can be read and written */
|
|
{
|
|
FILE* f = NULL;
|
|
char* fname = d4info->curl->curlflags.cookiejar;
|
|
/* See if the file exists already */
|
|
f = fopen(fname,"r");
|
|
if(f == NULL) {
|
|
/* Ok, create it */
|
|
f = fopen(fname,"w+");
|
|
if(f == NULL) {
|
|
fprintf(stderr,"Cookie file cannot be read and written: %s\n",fname);
|
|
{ret= NC_EPERM; goto fail;}
|
|
}
|
|
} else { /* test if file can be written */
|
|
fclose(f);
|
|
f = fopen(fname,"r+");
|
|
if(f == NULL) {
|
|
fprintf(stderr,"Cookie file is cannot be written: %s\n",fname);
|
|
{ret = NC_EPERM; goto fail;}
|
|
}
|
|
}
|
|
if(f != NULL) fclose(f);
|
|
}
|
|
|
|
return THROW(ret);
|
|
|
|
fail:
|
|
return THROW(ret);
|
|
}
|
|
|
|
static void
|
|
applyclientparamcontrols(NCD4INFO* info)
|
|
{
|
|
NCD4meta* meta = info->substrate.metadata;
|
|
const char* value;
|
|
|
|
/* clear the flags */
|
|
CLRFLAG(info->controls.flags,NCF_CACHE);
|
|
CLRFLAG(info->controls.flags,NCF_SHOWFETCH);
|
|
CLRFLAG(info->controls.flags,NCF_NC4);
|
|
CLRFLAG(info->controls.flags,NCF_NCDAP);
|
|
|
|
/* Turn on any default on flags */
|
|
SETFLAG(info->controls.flags,DFALT_ON_FLAGS);
|
|
SETFLAG(info->controls.flags,(NCF_NC4|NCF_NCDAP));
|
|
|
|
if(paramcheck(info,"show","fetch"))
|
|
SETFLAG(info->controls.flags,NCF_SHOWFETCH);
|
|
|
|
if(paramcheck(info,"translate","nc4"))
|
|
info->controls.translation = NCD4_TRANSNC4;
|
|
|
|
/* Look at the debug flags */
|
|
if(paramcheck(info,"debug","copy"))
|
|
SETFLAG(info->controls.debugflags,NCF_DEBUG_COPY); /* => close */
|
|
|
|
value = getparam(info,"substratename");
|
|
if(value != NULL)
|
|
strncpy(info->controls.substratename,value,NC_MAX_NAME);
|
|
|
|
}
|
|
|
|
static void
|
|
applyclientmetacontrols(NCD4meta* meta)
|
|
{
|
|
NCD4INFO* info = meta->controller;
|
|
const char* value = getparam(info,"checksummode");
|
|
if(value != NULL) {
|
|
if(strcmp(value,"ignore")==0)
|
|
meta->ignorechecksums = 1;
|
|
}
|
|
}
|
|
|
|
/* Search for substring in value of param. If substring == NULL; then just
|
|
check if param is defined.
|
|
*/
|
|
static int
|
|
paramcheck(NCD4INFO* info, const char* key, const char* subkey)
|
|
{
|
|
const char* value;
|
|
char* p;
|
|
|
|
value = getparam(info, key);
|
|
if(value == NULL)
|
|
return 0;
|
|
if(subkey == NULL) return 1;
|
|
p = strstr(value,subkey);
|
|
if(p == NULL) return 0;
|
|
p += strlen(subkey);
|
|
if(*p != '\0' && strchr(checkseps,*p) == NULL) return 0;
|
|
return 1;
|
|
}
|
|
|
|
/*
|
|
Given a parameter key, return its value or NULL if not defined.
|
|
*/
|
|
static const char*
|
|
getparam(NCD4INFO* info, const char* key)
|
|
{
|
|
const char* value;
|
|
|
|
if(info == NULL || key == NULL) return NULL;
|
|
if((value=ncurilookup(info->uri,key)) == NULL)
|
|
return NULL;
|
|
return value;
|
|
}
|