mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-11-21 03:13:42 +08:00
bf2746b8ea
re: issue https://github.com/Unidata/netcdf-c/issues/1251 Assume that you have the URL to a remote dataset which is a normal netcdf-3 or netcdf-4 file. This PR allows the netcdf-c to read that dataset's contents as a netcdf file using HTTP byte ranges if the remote server supports byte-range access. Originally, this PR was set up to access Amazon S3 objects, but it can also access other remote datasets such as those provided by a Thredds server via the HTTPServer access protocol. It may also work for other kinds of servers. Note that this is not intended as a true production capability because, as is known, this kind of access to can be quite slow. In addition, the byte-range IO drivers do not currently do any sort of optimization or caching. An additional goal here is to gain some experience with the Amazon S3 REST protocol. This architecture and its use documented in the file docs/byterange.dox. There are currently two test cases: 1. nc_test/tst_s3raw.c - this does a simple open, check format, close cycle for a remote netcdf-3 file and a remote netcdf-4 file. 2. nc_test/test_s3raw.sh - this uses ncdump to investigate some remote datasets. This PR also incorporates significantly changed model inference code (see the superceded PR https://github.com/Unidata/netcdf-c/pull/1259). 1. It centralizes the code that infers the dispatcher. 2. It adds support for byte-range URLs Other changes: 1. NC_HDF5_finalize was not being properly called by nc_finalize(). 2. Fix minor bug in ncgen3.l 3. fix memory leak in nc4info.c 4. add code to walk the .daprc triples and to replace protocol= fragment tag with a more general mode= tag. Final Note: Th inference code is still way too complicated. We need to move to the validfile() model used by netcdf Java, where each dispatcher is asked if it can process the file. This decentralizes the inference code. This will be done after all the major new dispatchers (PIO, Zarr, etc) have been implemented.
117 lines
3.7 KiB
C
117 lines
3.7 KiB
C
/*
|
|
* Copyright 2018, University Corporation for Atmospheric Research
|
|
* See netcdf/COPYRIGHT file for copying and redistribution conditions.
|
|
*/
|
|
|
|
#ifndef NCURI_H
|
|
#define NCURI_H
|
|
|
|
/* Define error codes */
|
|
#define NCU_OK (0)
|
|
#define NCU_EINVAL (1) /* Generic, mostly means bad argument */
|
|
#define NCU_EBADURL (2)
|
|
#define NCU_ENOMEM (3)
|
|
#define NCU_EPROTO (4)
|
|
#define NCU_EPATH (5)
|
|
#define NCU_EUSRPWD (6)
|
|
#define NCU_EHOST (7)
|
|
#define NCU_EPORT (8)
|
|
#define NCU_EPARAMS (9)
|
|
#define NCU_ENOPARAM (10)
|
|
#define NCU_ECONSTRAINTS (11)
|
|
|
|
/* Define flags to control what is included by ncuribuild*/
|
|
#define NCURIPATH 1
|
|
#define NCURIPWD 2
|
|
#define NCURIQUERY 4
|
|
#define NCURIFRAG 8
|
|
#define NCURIENCODE 16 /* If output should be encoded */
|
|
#define NCURIBASE (NCURIPWD|NCURIPATH)
|
|
#define NCURISVC (NCURIQUERY|NCURIBASE) /* for sending to server */
|
|
#define NCURIALL (NCURIPATH|NCURIPWD|NCURIQUERY|NCURIFRAG) /* for rebuilding after changes */
|
|
|
|
|
|
/*! This is an open structure meaning
|
|
it is ok to directly access its fields
|
|
*/
|
|
typedef struct NCURI {
|
|
char* uri; /* copy of url as passed by the caller */
|
|
char* protocol;
|
|
char* user; /* from user:password@ */
|
|
char* password; /* from user:password@ */
|
|
char* host; /*!< host*/
|
|
char* port; /*!< port */
|
|
char* path; /*!< path */
|
|
char* query; /*!< query */
|
|
char* fragment; /*!< fragment */
|
|
char** fraglist; /* envv style list of decomposed fragment*/
|
|
char** querylist; /* envv style list of decomposed query*/
|
|
#if 0
|
|
char* projection; /*!< without leading '?'*/
|
|
char* selection; /*!< with leading '&'*/
|
|
#endif
|
|
} NCURI;
|
|
|
|
/* Declaration modifiers for DLL support (MSC et al) */
|
|
#if defined(DLL_NETCDF) /* define when library is a DLL */
|
|
# if defined(DLL_EXPORT) /* define when building the library */
|
|
# define MSC_EXTRA __declspec(dllexport)
|
|
# else
|
|
# define MSC_EXTRA __declspec(dllimport)
|
|
# endif
|
|
# include <io.h>
|
|
#else
|
|
#define MSC_EXTRA /**< Needed for DLL build. */
|
|
#endif /* defined(DLL_NETCDF) */
|
|
|
|
#define EXTERNL MSC_EXTRA extern /**< Needed for DLL build. */
|
|
|
|
#if defined(_CPLUSPLUS_) || defined(__CPLUSPLUS__) || defined(__CPLUSPLUS)
|
|
extern "C" {
|
|
#endif
|
|
|
|
EXTERNL int ncuriparse(const char* s, NCURI** ncuri);
|
|
extern void ncurifree(NCURI* ncuri);
|
|
|
|
/* Replace the protocol */
|
|
extern int ncurisetprotocol(NCURI*,const char* newprotocol);
|
|
|
|
/* Replace the constraints */
|
|
EXTERNL int ncurisetquery(NCURI*,const char* query);
|
|
|
|
/* Construct a complete NC URI; caller frees returned string */
|
|
EXTERNL char* ncuribuild(NCURI*,const char* prefix, const char* suffix, int flags);
|
|
|
|
/*! Search the fragment for a given parameter
|
|
Null result => entry not found; !NULL=>found;
|
|
In any case, the result is imutable and should not be free'd.
|
|
*/
|
|
extern const char* ncurilookup(NCURI*, const char* param);
|
|
|
|
/*! Search the query for a given parameter
|
|
Null result => entry not found; !NULL=>found;
|
|
In any case, the result is imutable and should not be free'd.
|
|
*/
|
|
extern const char* ncuriquerylookup(NCURI*, const char* param);
|
|
|
|
/* Obtain the complete list of fragment pairs in envv format */
|
|
extern const char** ncurifragmentparams(NCURI*);
|
|
|
|
/* Obtain the complete list of query pairs in envv format */
|
|
extern const char** ncuriqueryparams(NCURI*);
|
|
|
|
/* URL Encode/Decode */
|
|
extern char* ncuridecode(char* s);
|
|
/* Partial decode */
|
|
extern char* ncuridecodepartial(char* s, const char* decodeset);
|
|
/* Encode using specified character set */
|
|
extern char* ncuriencodeonly(char* s, char* allowable);
|
|
/* Encode user or pwd */
|
|
extern char* ncuriencodeuserpwd(char* s);
|
|
|
|
#if defined(_CPLUSPLUS_) || defined(__CPLUSPLUS__) || defined(__CPLUSPLUS)
|
|
}
|
|
#endif
|
|
|
|
#endif /*NCURI_H*/
|