2017-08-31 07:44:57 +08:00
|
|
|
/*
|
2018-12-07 05:29:57 +08:00
|
|
|
Copyright (c) 1998-2018 University Corporation for Atmospheric Research/Unidata
|
2017-08-31 07:44:57 +08:00
|
|
|
See LICENSE.txt for license information.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#include "config.h"
|
2010-08-05 10:44:59 +08:00
|
|
|
#include "ncdispatch.h"
|
2012-08-09 07:15:18 +08:00
|
|
|
#include "ncuri.h"
|
2017-08-31 07:44:57 +08:00
|
|
|
#include "nclog.h"
|
|
|
|
|
#include "ncbytes.h"
|
|
|
|
|
#include "ncrc.h"
|
2019-03-31 04:06:20 +08:00
|
|
|
#include "ncoffsets.h"
|
Codify cross-platform file paths
The netcdf-c code has to deal with a variety of platforms:
Windows, OSX, Linux, Cygwin, MSYS, etc. These platforms differ
significantly in the kind of file paths that they accept. So in
order to handle this, I have created a set of replacements for
the most common file system operations such as _open_ or _fopen_
or _access_ to manage the file path differences correctly.
A more limited version of this idea was already implemented via
the ncwinpath.h and dwinpath.c code. So this can be viewed as a
replacement for that code. And in path in many cases, the only
change that was required was to replace '#include <ncwinpath.h>'
with '#include <ncpathmgt.h>' and then replace file operation
calls with the NCxxx equivalent from ncpathmgr.h Note that
recently, the ncwinpath.h was renamed ncpathmgmt.h, so this pull
request should not require dealing with winpath.
The heart of the change is include/ncpathmgmt.h, which provides
alternate operations such as NCfopen or NCaccess and which properly
parse and rebuild path arguments to work for the platform on which
the code is executing. This mostly matters for Windows because of the
way that it uses backslash and drive letters, as compared to *nix*.
One important feature is that the user can do string manipulations
on a file path without having to worry too much about the platform
because the path management code will properly handle most mixed cases.
So one can for example concatenate a path suffix that uses forward
slashes to a Windows path and have it work correctly.
The conversion code is in libdispatch/dpathmgr.c, and the
important function there is NCpathcvt which does the proper
conversions to the local path format.
As a rule, most code should just replace their file operations with
the corresponding NCxxx ones defined in include/ncpathmgmt.h. These
NCxxx functions all call NCpathcvt on their path arguments before
executing the actual file operation.
In some rare cases, the client may need to directly use NCpathcvt,
but this should be avoided as much as possible. If there is a need
for supporting a new file operation not already in ncpathmgmt.h, then
use the code in dpathmgr.c as a template. Also please notify Unidata
so we can include it as a formal part or our supported operations.
Also, if you see an operation in the library that is not using the
NCxxx form, then please submit an issue so we can fix it.
Misc. Changes:
* Clean up the utf8 testing code; it is impossible to get some
tests to work under windows using shell scripts; the args do
not pass as utf8 but as some other encoding.
* Added an extra utf8 test case: test_unicode_path.sh
* Add a true test for HDF5 1.10.6 or later because as noted in
PR https://github.com/Unidata/netcdf-c/pull/1794,
HDF5 changed its Windows file path handling.
2021-03-05 04:41:31 +08:00
|
|
|
#include "ncpathmgr.h"
|
2021-11-02 12:37:05 +08:00
|
|
|
#include "ncxml.h"
|
2022-01-30 06:27:52 +08:00
|
|
|
#include "nc4internal.h"
|
2017-08-31 07:44:57 +08:00
|
|
|
|
|
|
|
|
/* Required for getcwd, other functions. */
|
|
|
|
|
#ifdef HAVE_UNISTD_H
|
|
|
|
|
#include <unistd.h>
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
/* Required for getcwd, other functions. */
|
2020-08-18 09:15:47 +08:00
|
|
|
#ifdef _WIN32
|
2017-08-31 07:44:57 +08:00
|
|
|
#include <direct.h>
|
|
|
|
|
#endif
|
|
|
|
|
|
2024-03-19 04:32:23 +08:00
|
|
|
#if defined(NETCDF_ENABLE_BYTERANGE) || defined(NETCDF_ENABLE_DAP) || defined(NETCDF_ENABLE_DAP4)
|
2019-05-04 03:22:54 +08:00
|
|
|
#include <curl/curl.h>
|
|
|
|
|
#endif
|
2010-12-16 05:45:05 +08:00
|
|
|
|
2024-03-19 04:40:19 +08:00
|
|
|
#ifdef NETCDF_ENABLE_S3
|
2021-10-30 10:06:37 +08:00
|
|
|
#include "ncs3sdk.h"
|
|
|
|
|
#endif
|
|
|
|
|
|
2022-06-15 04:44:23 +08:00
|
|
|
#define MAXPATH 1024
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-11-15 01:26:33 +08:00
|
|
|
/* Define vectors of zeros and ones for use with various nc_get_varX functions */
|
This PR adds EXPERIMENTAL support for accessing data in the
cloud using a variant of the Zarr protocol and storage
format. This enhancement is generically referred to as "NCZarr".
The data model supported by NCZarr is netcdf-4 minus the user-defined
types and the String type. In this sense it is similar to the CDF-5
data model.
More detailed information about enabling and using NCZarr is
described in the document NUG/nczarr.md and in a
[Unidata Developer's blog entry](https://www.unidata.ucar.edu/blogs/developer/en/entry/overview-of-zarr-support-in).
WARNING: this code has had limited testing, so do use this version
for production work. Also, performance improvements are ongoing.
Note especially the following platform matrix of successful tests:
Platform | Build System | S3 support
------------------------------------
Linux+gcc | Automake | yes
Linux+gcc | CMake | yes
Visual Studio | CMake | no
Additionally, and as a consequence of the addition of NCZarr,
major changes have been made to the Filter API. NOTE: NCZarr
does not yet support filters, but these changes are enablers for
that support in the future. Note that it is possible
(probable?) that there will be some accidental reversions if the
changes here did not correctly mimic the existing filter testing.
In any case, previously filter ids and parameters were of type
unsigned int. In order to support the more general zarr filter
model, this was all converted to char*. The old HDF5-specific,
unsigned int operations are still supported but they are
wrappers around the new, char* based nc_filterx_XXX functions.
This entailed at least the following changes:
1. Added the files libdispatch/dfilterx.c and include/ncfilter.h
2. Some filterx utilities have been moved to libdispatch/daux.c
3. A new entry, "filter_actions" was added to the NCDispatch table
and the version bumped.
4. An overly complex set of structs was created to support funnelling
all of the filterx operations thru a single dispatch
"filter_actions" entry.
5. Move common code to from libhdf5 to libsrc4 so that it is accessible
to nczarr.
Changes directly related to Zarr:
1. Modified CMakeList.txt and configure.ac to support both C and C++
-- this is in support of S3 support via the awd-sdk libraries.
2. Define a size64_t type to support nczarr.
3. More reworking of libdispatch/dinfermodel.c to
support zarr and to regularize the structure of the fragments
section of a URL.
Changes not directly related to Zarr:
1. Make client-side filter registration be conditional, with default off.
2. Hack include/nc4internal.h to make some flags added by Ed be unique:
e.g. NC_CREAT, NC_INDEF, etc.
3. cleanup include/nchttp.h and libdispatch/dhttp.c.
4. Misc. changes to support compiling under Visual Studio including:
* Better testing under windows for dirent.h and opendir and closedir.
5. Misc. changes to the oc2 code to support various libcurl CURLOPT flags
and to centralize error reporting.
6. By default, suppress the vlen tests that have unfixed memory leaks; add option to enable them.
7. Make part of the nc_test/test_byterange.sh test be contingent on remotetest.unidata.ucar.edu being accessible.
Changes Left TO-DO:
1. fix provenance code, it is too HDF5 specific.
2020-06-29 08:02:47 +08:00
|
|
|
/* Note, this form of initialization fails under Cygwin */
|
2019-10-10 07:18:48 +08:00
|
|
|
size_t NC_coord_zero[NC_MAX_VAR_DIMS] = {0};
|
|
|
|
|
size_t NC_coord_one[NC_MAX_VAR_DIMS] = {1};
|
|
|
|
|
ptrdiff_t NC_stride_one[NC_MAX_VAR_DIMS] = {1};
|
2010-06-22 21:25:14 +08:00
|
|
|
|
2010-07-31 06:16:15 +08:00
|
|
|
/*
|
2010-06-22 21:25:14 +08:00
|
|
|
static nc_type longtype = (sizeof(long) == sizeof(int)?NC_INT:NC_INT64);
|
2010-07-31 06:16:15 +08:00
|
|
|
static nc_type ulongtype = (sizeof(unsigned long) == sizeof(unsigned int)?NC_UINT:NC_UINT64);
|
|
|
|
|
*/
|
2010-06-22 21:25:14 +08:00
|
|
|
|
2015-08-16 06:26:35 +08:00
|
|
|
/* Allow dispatch to do general initialization and finalization */
|
2011-09-19 04:57:51 +08:00
|
|
|
int
|
|
|
|
|
NCDISPATCH_initialize(void)
|
|
|
|
|
{
|
2015-08-16 06:26:35 +08:00
|
|
|
int status = NC_NOERR;
|
2011-09-21 01:30:02 +08:00
|
|
|
int i;
|
2022-01-30 06:27:52 +08:00
|
|
|
NCglobalstate* globalstate = NULL;
|
2017-08-31 07:44:57 +08:00
|
|
|
|
2019-11-15 01:26:33 +08:00
|
|
|
for(i=0;i<NC_MAX_VAR_DIMS;i++) {
|
|
|
|
|
NC_coord_zero[i] = 0;
|
|
|
|
|
NC_coord_one[i] = 1;
|
|
|
|
|
NC_stride_one[i] = 1;
|
2015-08-16 06:26:35 +08:00
|
|
|
}
|
2017-08-31 07:44:57 +08:00
|
|
|
|
2022-01-30 06:27:52 +08:00
|
|
|
globalstate = NC_getglobalstate(); /* will allocate and clear */
|
2019-03-31 04:06:20 +08:00
|
|
|
|
2017-08-31 07:44:57 +08:00
|
|
|
/* Capture temp dir*/
|
|
|
|
|
{
|
Codify cross-platform file paths
The netcdf-c code has to deal with a variety of platforms:
Windows, OSX, Linux, Cygwin, MSYS, etc. These platforms differ
significantly in the kind of file paths that they accept. So in
order to handle this, I have created a set of replacements for
the most common file system operations such as _open_ or _fopen_
or _access_ to manage the file path differences correctly.
A more limited version of this idea was already implemented via
the ncwinpath.h and dwinpath.c code. So this can be viewed as a
replacement for that code. And in path in many cases, the only
change that was required was to replace '#include <ncwinpath.h>'
with '#include <ncpathmgt.h>' and then replace file operation
calls with the NCxxx equivalent from ncpathmgr.h Note that
recently, the ncwinpath.h was renamed ncpathmgmt.h, so this pull
request should not require dealing with winpath.
The heart of the change is include/ncpathmgmt.h, which provides
alternate operations such as NCfopen or NCaccess and which properly
parse and rebuild path arguments to work for the platform on which
the code is executing. This mostly matters for Windows because of the
way that it uses backslash and drive letters, as compared to *nix*.
One important feature is that the user can do string manipulations
on a file path without having to worry too much about the platform
because the path management code will properly handle most mixed cases.
So one can for example concatenate a path suffix that uses forward
slashes to a Windows path and have it work correctly.
The conversion code is in libdispatch/dpathmgr.c, and the
important function there is NCpathcvt which does the proper
conversions to the local path format.
As a rule, most code should just replace their file operations with
the corresponding NCxxx ones defined in include/ncpathmgmt.h. These
NCxxx functions all call NCpathcvt on their path arguments before
executing the actual file operation.
In some rare cases, the client may need to directly use NCpathcvt,
but this should be avoided as much as possible. If there is a need
for supporting a new file operation not already in ncpathmgmt.h, then
use the code in dpathmgr.c as a template. Also please notify Unidata
so we can include it as a formal part or our supported operations.
Also, if you see an operation in the library that is not using the
NCxxx form, then please submit an issue so we can fix it.
Misc. Changes:
* Clean up the utf8 testing code; it is impossible to get some
tests to work under windows using shell scripts; the args do
not pass as utf8 but as some other encoding.
* Added an extra utf8 test case: test_unicode_path.sh
* Add a true test for HDF5 1.10.6 or later because as noted in
PR https://github.com/Unidata/netcdf-c/pull/1794,
HDF5 changed its Windows file path handling.
2021-03-05 04:41:31 +08:00
|
|
|
char* tempdir = NULL;
|
2021-05-15 01:33:03 +08:00
|
|
|
#if defined _WIN32 || defined __MSYS__ || defined __CYGWIN__
|
2017-08-31 07:44:57 +08:00
|
|
|
tempdir = getenv("TEMP");
|
|
|
|
|
#else
|
|
|
|
|
tempdir = "/tmp";
|
|
|
|
|
#endif
|
|
|
|
|
if(tempdir == NULL) {
|
|
|
|
|
fprintf(stderr,"Cannot find a temp dir; using ./\n");
|
Codify cross-platform file paths
The netcdf-c code has to deal with a variety of platforms:
Windows, OSX, Linux, Cygwin, MSYS, etc. These platforms differ
significantly in the kind of file paths that they accept. So in
order to handle this, I have created a set of replacements for
the most common file system operations such as _open_ or _fopen_
or _access_ to manage the file path differences correctly.
A more limited version of this idea was already implemented via
the ncwinpath.h and dwinpath.c code. So this can be viewed as a
replacement for that code. And in path in many cases, the only
change that was required was to replace '#include <ncwinpath.h>'
with '#include <ncpathmgt.h>' and then replace file operation
calls with the NCxxx equivalent from ncpathmgr.h Note that
recently, the ncwinpath.h was renamed ncpathmgmt.h, so this pull
request should not require dealing with winpath.
The heart of the change is include/ncpathmgmt.h, which provides
alternate operations such as NCfopen or NCaccess and which properly
parse and rebuild path arguments to work for the platform on which
the code is executing. This mostly matters for Windows because of the
way that it uses backslash and drive letters, as compared to *nix*.
One important feature is that the user can do string manipulations
on a file path without having to worry too much about the platform
because the path management code will properly handle most mixed cases.
So one can for example concatenate a path suffix that uses forward
slashes to a Windows path and have it work correctly.
The conversion code is in libdispatch/dpathmgr.c, and the
important function there is NCpathcvt which does the proper
conversions to the local path format.
As a rule, most code should just replace their file operations with
the corresponding NCxxx ones defined in include/ncpathmgmt.h. These
NCxxx functions all call NCpathcvt on their path arguments before
executing the actual file operation.
In some rare cases, the client may need to directly use NCpathcvt,
but this should be avoided as much as possible. If there is a need
for supporting a new file operation not already in ncpathmgmt.h, then
use the code in dpathmgr.c as a template. Also please notify Unidata
so we can include it as a formal part or our supported operations.
Also, if you see an operation in the library that is not using the
NCxxx form, then please submit an issue so we can fix it.
Misc. Changes:
* Clean up the utf8 testing code; it is impossible to get some
tests to work under windows using shell scripts; the args do
not pass as utf8 but as some other encoding.
* Added an extra utf8 test case: test_unicode_path.sh
* Add a true test for HDF5 1.10.6 or later because as noted in
PR https://github.com/Unidata/netcdf-c/pull/1794,
HDF5 changed its Windows file path handling.
2021-03-05 04:41:31 +08:00
|
|
|
tempdir = ".";
|
2017-08-31 07:44:57 +08:00
|
|
|
}
|
Codify cross-platform file paths
The netcdf-c code has to deal with a variety of platforms:
Windows, OSX, Linux, Cygwin, MSYS, etc. These platforms differ
significantly in the kind of file paths that they accept. So in
order to handle this, I have created a set of replacements for
the most common file system operations such as _open_ or _fopen_
or _access_ to manage the file path differences correctly.
A more limited version of this idea was already implemented via
the ncwinpath.h and dwinpath.c code. So this can be viewed as a
replacement for that code. And in path in many cases, the only
change that was required was to replace '#include <ncwinpath.h>'
with '#include <ncpathmgt.h>' and then replace file operation
calls with the NCxxx equivalent from ncpathmgr.h Note that
recently, the ncwinpath.h was renamed ncpathmgmt.h, so this pull
request should not require dealing with winpath.
The heart of the change is include/ncpathmgmt.h, which provides
alternate operations such as NCfopen or NCaccess and which properly
parse and rebuild path arguments to work for the platform on which
the code is executing. This mostly matters for Windows because of the
way that it uses backslash and drive letters, as compared to *nix*.
One important feature is that the user can do string manipulations
on a file path without having to worry too much about the platform
because the path management code will properly handle most mixed cases.
So one can for example concatenate a path suffix that uses forward
slashes to a Windows path and have it work correctly.
The conversion code is in libdispatch/dpathmgr.c, and the
important function there is NCpathcvt which does the proper
conversions to the local path format.
As a rule, most code should just replace their file operations with
the corresponding NCxxx ones defined in include/ncpathmgmt.h. These
NCxxx functions all call NCpathcvt on their path arguments before
executing the actual file operation.
In some rare cases, the client may need to directly use NCpathcvt,
but this should be avoided as much as possible. If there is a need
for supporting a new file operation not already in ncpathmgmt.h, then
use the code in dpathmgr.c as a template. Also please notify Unidata
so we can include it as a formal part or our supported operations.
Also, if you see an operation in the library that is not using the
NCxxx form, then please submit an issue so we can fix it.
Misc. Changes:
* Clean up the utf8 testing code; it is impossible to get some
tests to work under windows using shell scripts; the args do
not pass as utf8 but as some other encoding.
* Added an extra utf8 test case: test_unicode_path.sh
* Add a true test for HDF5 1.10.6 or later because as noted in
PR https://github.com/Unidata/netcdf-c/pull/1794,
HDF5 changed its Windows file path handling.
2021-03-05 04:41:31 +08:00
|
|
|
globalstate->tempdir= strdup(tempdir);
|
2017-08-31 07:44:57 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/* Capture $HOME */
|
|
|
|
|
{
|
2022-06-15 04:44:23 +08:00
|
|
|
#if defined(_WIN32) && !defined(__MINGW32__)
|
|
|
|
|
char* home = getenv("USERPROFILE");
|
2022-06-22 04:09:10 +08:00
|
|
|
#else
|
|
|
|
|
char* home = getenv("HOME");
|
2022-06-15 04:44:23 +08:00
|
|
|
#endif
|
2017-08-31 07:44:57 +08:00
|
|
|
if(home == NULL) {
|
2022-06-15 04:44:23 +08:00
|
|
|
/* use cwd */
|
|
|
|
|
home = malloc(MAXPATH+1);
|
|
|
|
|
NCgetcwd(home,MAXPATH);
|
|
|
|
|
} else
|
|
|
|
|
home = strdup(home); /* make it always free'able */
|
|
|
|
|
assert(home != NULL);
|
|
|
|
|
NCpathcanonical(home,&globalstate->home);
|
|
|
|
|
nullfree(home);
|
2017-08-31 07:44:57 +08:00
|
|
|
}
|
2022-06-15 04:44:23 +08:00
|
|
|
|
Upgrade the nczarr code to match Zarr V2
Re: https://github.com/zarr-developers/zarr-python/pull/716
The Zarr version 2 spec has been extended to include the ability
to choose the dimension separator in chunk name keys. The legal
separators has been extended from {'.'} to {'.' '/'}. So now it
is possible to use a key like "0/1/2/0" for chunk names.
This PR implements this for NCZarr. The V2 spec now says that
this separator can be set on a per-variable basis. For now, I
have chosen to allow this be set only globally by adding a key
named "ZARR.DIMENSION_SEPARATOR=<char>" in the
.daprc/.dodsrc/ncrc file. Currently, the only legal separator
characters are '.' (the default) and '/'. On writing, this key
will only be written if its value is different than the default.
This change caused problems because supporting a separator of '/'
is difficult to parse when keys/paths use '/' as the path separator.
A test case was added for this.
Additionally, make nczarr be enabled default by default. This required
some additional changes so that if zip and/or AWS S3 sdk are unavailable,
then they are disabled for NCZarr.
In addition the following unrelated changes were made.
1. Tested that pure-zarr mode could read an nczarr formatted store.
1. The .rc file handling now merges all known .rc files (.ncrc,.daprc, and .dodsrc) in that order and using those in HOME first, then in current directory. For duplicate entries, the later ones override the earlier ones. This change is to remove some of the conflicts inherent in the current .rc file load process. A set of test cases was also added.
1. Re-order tests in configure.ac and CMakeLists.txt so that if libcurl
is not found then the other options that depend upon it properly
are disabled.
1. I decided that xarray support should be enabled by default for pure
zarr. In order to allow disabling, I added a new mode flag "noxarray".
1. Certain test in nczarr_test depend on use of .dodsrc. In order for these
to work when testing in parallel, some inter-test dependencies needed to
be added.
1. Improved authorization testing to use changes in thredds.ucar.edu
2021-04-25 09:48:15 +08:00
|
|
|
/* Capture $CWD */
|
|
|
|
|
{
|
|
|
|
|
char cwdbuf[4096];
|
|
|
|
|
|
|
|
|
|
cwdbuf[0] = '\0';
|
|
|
|
|
(void)NCgetcwd(cwdbuf,sizeof(cwdbuf));
|
|
|
|
|
|
|
|
|
|
if(strlen(cwdbuf) == 0) {
|
|
|
|
|
/* use tempdir */
|
|
|
|
|
strcpy(cwdbuf, globalstate->tempdir);
|
|
|
|
|
}
|
|
|
|
|
globalstate->cwd = strdup(cwdbuf);
|
|
|
|
|
}
|
|
|
|
|
|
2017-08-31 07:44:57 +08:00
|
|
|
ncloginit();
|
|
|
|
|
|
2021-09-28 08:36:33 +08:00
|
|
|
/* Now load RC Files */
|
|
|
|
|
ncrc_initialize();
|
|
|
|
|
|
2019-03-31 04:06:20 +08:00
|
|
|
/* Compute type alignments */
|
|
|
|
|
NC_compute_alignments();
|
|
|
|
|
|
2024-03-19 04:32:23 +08:00
|
|
|
#if defined(NETCDF_ENABLE_BYTERANGE) || defined(NETCDF_ENABLE_DAP) || defined(NETCDF_ENABLE_DAP4)
|
2021-10-30 10:06:37 +08:00
|
|
|
/* Initialize curl if it is being used */
|
2019-10-10 07:18:48 +08:00
|
|
|
{
|
2019-05-04 03:22:54 +08:00
|
|
|
CURLcode cstat = curl_global_init(CURL_GLOBAL_ALL);
|
|
|
|
|
if(cstat != CURLE_OK)
|
|
|
|
|
status = NC_ECURL;
|
|
|
|
|
}
|
|
|
|
|
#endif
|
2021-10-30 10:06:37 +08:00
|
|
|
|
2015-08-16 06:26:35 +08:00
|
|
|
return status;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
int
|
|
|
|
|
NCDISPATCH_finalize(void)
|
|
|
|
|
{
|
|
|
|
|
int status = NC_NOERR;
|
2024-03-19 04:32:23 +08:00
|
|
|
#if defined(NETCDF_ENABLE_BYTERANGE) || defined(NETCDF_ENABLE_DAP) || defined(NETCDF_ENABLE_DAP4)
|
2019-05-04 03:22:54 +08:00
|
|
|
curl_global_cleanup();
|
2021-11-02 12:37:05 +08:00
|
|
|
#endif
|
2024-03-19 04:32:23 +08:00
|
|
|
#if defined(NETCDF_ENABLE_DAP4)
|
2021-11-02 12:37:05 +08:00
|
|
|
ncxml_finalize();
|
2019-05-04 03:22:54 +08:00
|
|
|
#endif
|
2023-12-03 12:03:59 +08:00
|
|
|
NC_freeglobalstate(); /* should be one of the last things done */
|
2015-08-16 06:26:35 +08:00
|
|
|
return status;
|
2011-09-19 04:57:51 +08:00
|
|
|
}
|
