mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-11-27 07:30:33 +08:00
f1506d552e
* For URL paths, the new approach essentially centralizes all information
in the URL into the "#mode=" fragment key and uses that value
to determine the dispatcher for (most) URLs.
* The new approach has the following steps:
1. canonicalize the path if it is a URL.
2. use the mode= fragment key to determine the dispatcher
3. if dispatcher still not determined, then use the mode flags
argument to nc_open/nc_create to determine the dispatcher.
4. if the path points to something readable, attempt to read the
magic number at the front, and use that to determine the dispatcher.
this case may override all previous cases.
* Misc changes.
1. Update documentation
2. Moved some unit tests from libdispatch to unit_test directory.
3. Fixed use of wrong #ifdef macro in test_filter_reg.c
[I think this may fix an previously reported esupport query].
107 lines
3.4 KiB
C
107 lines
3.4 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 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);
|
|
|
|
/* Replace the fragment list */
|
|
extern int ncurisetfragments(NCURI*, const char* fragments);
|
|
|
|
/* 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, const char* allowable);
|
|
/* Encode user or pwd */
|
|
extern char* ncuriencodeuserpwd(char* s);
|
|
|
|
#if defined(_CPLUSPLUS_) || defined(__CPLUSPLUS__) || defined(__CPLUSPLUS)
|
|
}
|
|
#endif
|
|
|
|
#endif /*NCURI_H*/
|