netcdf-c/libdap2/daputil.h
Dennis Heimbigner 793ecc8e60 Yet another fix for DAP2 double URL encoding.
re:  https://github.com/Unidata/netcdf-c/issues/1876
and: https://github.com/Unidata/netcdf-c/pull/1835
and: https://github.com/Unidata/netcdf4-python/issues/1041

The change in PR 1835 was correct with respect to using %20 instead of '+'
for encoding blanks. However, it was a mistake to assume everything was
unencoded and then to do encoding ourselves. The problem is that
different servers do different things, with Columbia being an outlier.

So, I have added a set of client controls that can at least give
the caller some control over this. The caller can append
the following fragment to his URL to control what gets encoded before
sending it to the server. The syntax is as follows:
````
https://<host>/<path>/<query>#encode=path|query|all|none
````

The possible values:
* path  -- URL encode (i.e. %xx encode) as needed in the path part of the URL.
* query -- URL encode as needed in the query part of the URL.
* all   -- equivalent to ````#encode=path,query````.
* none  -- do not url encode any part of the URL sent to the server; not strictly necessary, so mostly for completeness.

Note that if "encode=" is used, then before it is processed, all encoding
is turned of so that ````#encode=path```` will only encode the path
and not the query.

The default is ````#encode=query````, so the path is left untouched,
but the query is always encoded.

Internally, this required changes to pass the encode flags down into
the OC2 library.

Misc. Unrelated Changes:
* Shut up those irritating warning from putget.m4
2020-11-05 11:04:56 -07:00

78 lines
2.8 KiB
C

/*********************************************************************
* Copyright 2018, UCAR/Unidata
* See netcdf/COPYRIGHT file for copying and redistribution conditions.
*********************************************************************/
#ifndef DAPUTIL_H
#define DAPUTIL_H 1
/* Define a set of flags to control path construction */
#define PATHNC 1 /*Use ->ncname*/
#define PATHELIDE 2 /*Leave out elided nodes*/
/* mnemonic */
#define WITHDATASET 1
#define WITHOUTDATASET 0
/* sigh!, Forwards */
struct CDFnode;
struct NCTMODEL;
struct NCDAPCOMMON;
extern nc_type nctypeconvert(struct NCDAPCOMMON*, nc_type);
extern nc_type octypetonc(OCtype);
extern OCtype nctypetodap(nc_type);
extern size_t nctypesizeof(nc_type);
extern char* nctypetostring(nc_type);
extern char* maketmppath(char* path, char* prefix);
extern void collectnodepath(struct CDFnode*, NClist* path, int dataset);
extern void collectocpath(OClink conn, OCobject node, NClist* path);
extern char* makecdfpathstring(struct CDFnode*,const char*);
extern void clonenodenamepath(struct CDFnode*, NClist*, int);
extern char* makepathstring(NClist* path, const char* separator, int flags);
extern char* makeocpathstring(OClink, OCobject, const char*);
extern char* cdflegalname(char* dapname);
/* Given a param string; return its value or null if not found*/
extern const char* dapparamvalue(struct NCDAPCOMMON* drno, const char* param);
/* Given a param string; check for a given substring */
extern int dapparamcheck(struct NCDAPCOMMON* drno, const char* param, const char* substring);
extern int nclistconcat(NClist* l1, NClist* l2);
extern int nclistminus(NClist* l1, NClist* l2);
extern int nclistdeleteall(NClist* l1, void*);
extern char* getvaraprint(void* gv);
extern int dapinsequence(struct CDFnode* node);
extern int dapinstructarray(struct CDFnode* node);
extern int daptopgrid(struct CDFnode* node);
extern int daptopseq(struct CDFnode* node);
extern int daptoplevel(struct CDFnode* node);
extern int dapgridmap(struct CDFnode* node);
extern int dapgridarray(struct CDFnode* node);
extern int dapgridelement(struct CDFnode* node);
extern unsigned int modeldecode(int, const char*, const struct NCTMODEL*, unsigned int);
extern unsigned long getlimitnumber(const char* limit);
extern void dapexpandescapes(char *termstring);
/* Only used by libncdap4 */
extern int dapalignbuffer(NCbytes*, int alignment);
extern size_t dapdimproduct(NClist* dimensions);
/* Provide a wrapper for oc_fetch so we can log what it does */
extern NCerror dap_fetch(struct NCDAPCOMMON*,OClink,const char*,OCdxd,OCobject*);
extern int dap_badname(char* name);
extern char* dap_repairname(char* name);
extern char* dap_getselection(NCURI* uri);
extern int dapparamparselist(const char* s0, int delim, NClist* list);
#endif /*DAPUTIL_H*/