This pr should probably be delayed until after Version 4.5.

Primary change is to cleanup code and remove duplicated code.

1. Unify the rc file reading into libdispatch/drc.c. Eventually extend
   if we need rc file for netcdf itself as opposed to the dap code.
2. Unify the extraction from the rc file of DAP authorization info.
3. Misc. other small unifications: make temp file, read file.
4. Avoid use of libcurl when reading file:// because
   there is some kind of problem with the Visual Studio version.
   Might be related to the winpath problem.
   In any case, do direct read instead.
5. Add new error code NC_ERCFILE for errors in reading RC file.
6. Complete documentation cleanup as indicated in this comment
   #472 (comment)
7. Convert some occurrences of #ifdef _WIN32 to #ifdef _MSC_VER

Author: DennisHeimbigner

CMakeLists.txt

@@ -1350,6 +1350,7 @@ CHECK_FUNCTION_EXISTS(strtoll HAVE_STRTOLL)
 CHECK_FUNCTION_EXISTS(strtoull  HAVE_STRTOULL)
 CHECK_FUNCTION_EXISTS(strstr  HAVE_STRSTR)
 CHECK_FUNCTION_EXISTS(mkstemp HAVE_MKSTEMP)
+CHECK_FUNCTION_EXISTS(mktemp HAVE_MKTEMP)
 CHECK_FUNCTION_EXISTS(rand  HAVE_RAND)
 CHECK_FUNCTION_EXISTS(random HAVE_RANDOM)
 CHECK_FUNCTION_EXISTS(gettimeofday  HAVE_GETTIMEOFDAY)

cf.cmake

@@ -1,6 +1,9 @@
 # Visual Studio
 VS=1
-#VSSETUP=1
+
+if test "x$1" = xsetup ; then
+VSSETUP=1
+fi
 
 #export NCPATHDEBUG=1
 

config.h.cmake.in

@@ -17,7 +17,7 @@
 #cmakedefine HAVE_WINSOCK2_H
 
 #ifdef HAVE_WINSOCK2_H
-   #define _WINSOCKAPI_
+//   #define _WINSOCKAPI_
 #endif
 
    #if _MSC_VER>=1900
@@ -288,6 +288,9 @@ are set when opening a binary file on Windows. */
 /* Define to 1 if you have the `mkstemp' function. */
 #cmakedefine HAVE_MKSTEMP 1
 
+/* Define to 1 if you have the `mktemp' function. */
+#cmakedefine HAVE_MKTEMP 1
+
 /* Define to 1 if you have a working `mmap' system call. */
 #cmakedefine HAVE_MMAP 1
 

configure.ac

@@ -796,7 +796,7 @@ AC_CHECK_HEADERS([ftw.h])
 # Check for these functions...
 AC_CHECK_FUNCS([strlcat strerror snprintf strchr strrchr strcat strcpy \
                 strdup strcasecmp strtod strtoll strtoull strstr \
-		mkstemp rand random memcmp \
+		mkstemp mktemp rand random memcmp \
 		getrlimit gettimeofday fsync MPI_Comm_f2c])
 
 # Does the user want to use NC_DISKLESS?

docs/auth.md

@@ -125,12 +125,14 @@ will have HTTP.VERBOSE set to 0 because its host+port matches the example above.
 ## Authorization-Related Keys {#AUTHKEYS}
 
 The currently defined set of authorization-related keys are as follows.
-The second column is the affected curl_easy_setopt option(s), if any.
+The second column is the affected curl_easy_setopt option(s), if any
+(see reference #1).
 <table>
 <tr><th>Key</th><th>Affected curl_easy_setopt Options</th><th>Notes</th>
 <tr><td>HTTP.COOKIEJAR</td><td>CURLOPT_COOKIEJAR</td>
 <tr><td>HTTP.COOKIEFILE</td><td>CURLOPT_COOKIEJAR</td><td>Alias for CURLOPT_COOKIEJAR</td>
-<tr><td>HTTP.PROXY_SERVER</td><td>CURLOPT_PROXY, CURLOPT_PROXYPORT, CURLOPT_PROXYUSERPWD</td>
+<tr><td>HTTP.PROXY.SERVER</td><td>CURLOPT_PROXY, CURLOPT_PROXYPORT, CURLOPT_PROXYUSERPWD</td>
+<tr><td>HTTP.PROXY_SERVER</td><td>CURLOPT_PROXY, CURLOPT_PROXYPORT, CURLOPT_PROXYUSERPWD</td><td>Decprecated: use HTTP.PROXY.SERVER</td>
 <tr><td>HTTP.SSL.CERTIFICATE</td><td>CURLOPT_SSLCERT</td>
 <tr><td>HTTP.SSL.KEY</td><td>CURLOPT_SSLKEY</td>
 <tr><td>HTTP.SSL.KEYPASSWORD</td><td>CURLOPT_KEYPASSWORD</td>
@@ -191,15 +193,19 @@ specifies the password for accessing the HTTP.SSL.CERTIFICAT/HTTP.SSL.key file.
 HTTP.SSL.CAPATH
 specifies the path to a directory containing
 trusted certificates for validating server sertificates.
+See reference #2 for more info.
 
 HTTP.SSL.VALIDATE
 is a boolean (1/0) value that if true (1)
 specifies that the client should verify the server's presented certificate.
 
-HTTP.PROXY_SERVER
+HTTP.PROXY.SERVER
 specifies the url for accessing the proxy:
 e.g. *http://[username:password@]host[:port]*
 
+HTTP.PROXY_SERVER
+deprecated; use HTTP.PROXY.SERVER
+
 HTTP.NETRC
 specifies the absolute path of the .netrc file.
 See [redirection authorization](#REDIR)
@@ -296,6 +302,11 @@ This requires setting the following entries:
 
 Note that the first two are there to support re-direction based authentication.
 
+## References
+
+1. https://curl.haxx.se/libcurl/c/curl_easy_setopt.html
+2. https://curl.haxx.se/docs/ssl-compared.html
+
 ## Appendix A. All RC-File Keys {#allkeys}
 
 For completeness, this is the list of all rc-file keys.
@@ -309,6 +320,7 @@ the code is definitive.
 <tr><td>HTTP.USERAGENT</td><td>CUROPT_USERAGENT</td>
 <tr><td>HTTP.COOKIEJAR</td><td>CUROPT_COOKIEJAR</td>
 <tr><td>HTTP.COOKIE_JAR</td><td>CUROPT_COOKIEJAR</td>
+<tr valign="top"><td>HTTP.PROXY.SERVER</td><td>CURLOPT_PROXY,<br>CURLOPT_PROXYPORT,<br>CURLOPT_PROXYUSERPWD</td>
 <tr valign="top"><td>HTTP.PROXY_SERVER</td><td>CURLOPT_PROXY,<br>CURLOPT_PROXYPORT,<br>CURLOPT_PROXYUSERPWD</td>
 <tr><td>HTTP.SSL.CERTIFICATE</td><td>CUROPT_SSLCERT</td>
 <tr><td>HTTP.SSL.KEY</td><td>CUROPT_SSLKEY</td>

include/ncauth.h

@@ -17,7 +17,6 @@ Every curl connection will need a copy of this.
 
 typedef struct NCauth {
     struct curlflags {
-        int proto_file; /* Is file: supported? */
         int proto_https; /* is https: supported? */
 	int compress; /*CURLOPT_ENCODING*/
 	int verbose; /*CURLOPT_ENCODING*/

include/ncrc.h

@@ -54,6 +54,6 @@ extern char* NC_backslashEscape(const char* s);
 extern char* NC_backslashUnescape(const char* esc);
 extern char* NC_entityescape(const char* s);
 extern int NC_readfile(const char* filename, NCbytes* content);
-extern int NC_mktmp(const char* base, char** tmpnamep);
+extern char* NC_mktmp(const char* base);
 
 #endif /*NCRC_H*/

libdap4/d4curlfunctions.c

@@ -258,11 +258,9 @@ NCD4_curl_protocols(NCD4INFO* state)
     curl_version_info_data* curldata;
     curldata = curl_version_info(CURLVERSION_NOW);
     for(proto=curldata->protocols;*proto;proto++) {
-        if(strcmp("file",*proto)==0) {state->auth.curlflags.proto_file=1;}
         if(strcmp("http",*proto)==0) {state->auth.curlflags.proto_https=1;}
     }
 #ifdef D4DEBUG	
-    nclog(NCLOGNOTE,"Curl file:// support = %d",state->auth.curlflags.proto_file);
     nclog(NCLOGNOTE,"Curl https:// support = %d",state->auth.curlflags.proto_https);
 #endif
 }

libdap4/d4read.c

@@ -37,7 +37,7 @@ NCD4_readDAP(NCD4INFO* state, int flags)
     } else { /*((flags & NCF_ONDISK) != 0) */
         NCURI* url = state->uri;
         int fileprotocol = (strcmp(url->protocol,"file")==0);
-        if(fileprotocol && !state->auth.curlflags.proto_file) {
+        if(fileprotocol) {
             stat = readfiletofile(url, ".dap", state->data.ondiskfile, &state->data.datasize);
         } else {
 	    char* readurl = NULL;
@@ -86,7 +86,7 @@ readpacket(NCD4INFO* state, NCURI* url, NCbytes* packet, NCD4mode dxx, long* las
 
     fileprotocol = (strcmp(url->protocol,"file")==0);
 
-    if(fileprotocol && !state->auth.curlflags.proto_file) {
+    if(fileprotocol) {
 	/* Short circuit file://... urls*/
 	/* We do this because the test code always needs to read files*/
 	stat = readfile(url,suffix,packet);
@@ -151,10 +151,6 @@ readfile(const NCURI* uri, const char* suffix, NCbytes* packet)
 {
     int stat = NC_NOERR;
     char buf[1024];
-    int fd = -1;
-    int flags = 0;
-    d4size_t filesize = 0;
-    d4size_t totalread = 0;
     NCbytes* tmp = ncbytesnew();
     char* filename = NULL;
 
@@ -163,53 +159,7 @@ readfile(const NCURI* uri, const char* suffix, NCbytes* packet)
     ncbytesnull(tmp);
     filename = ncbytesextract(tmp);
     ncbytesfree(tmp);
-    flags = O_RDONLY;
-#ifdef O_BINARY
-    flags |= O_BINARY;
-#endif
-
-    fd = NCopen2(filename,flags);
-    if(fd < 0) {
-	nclog(NCLOGERR,"open failed:%s",filename);
-	fprintf(stderr,"XXX: open failed: flags=0x%x file=%s\n",flags,filename);
-        fflush(stderr);
-	stat = NC_ENOTFOUND;
-	goto done;
-    }
-    /* Get the file size */
-    filesize = lseek(fd,(d4size_t)0,SEEK_END);
-    if(filesize < 0) {
-	stat = NC_EIO;
-	nclog(NCLOGERR,"lseek failed: %s",filename);
-	goto done;
-    }
-    /* Move file pointer back to the beginning of the file */
-    (void)lseek(fd,(d4size_t)0,SEEK_SET);
-    stat = NC_NOERR;
-    for(totalread=0;;) {
-	d4size_t count = (d4size_t)read(fd,buf,sizeof(buf));
-	if(count == 0)
-	    break; /*eof*/
-	else if(count <  0) {
-	    stat = NC_EIO;
-	    nclog(NCLOGERR,"read failed: %s",filename);
-	    goto done;
-	}
-	ncbytesappendn(packet,buf,(unsigned long)count);
-	totalread += count;
-    }
-    if(totalread < filesize) {
-	stat = NC_EIO;
-	nclog(NCLOGERR,"short read: |%s|=%lu read=%lu\n",
-		filename,(unsigned long)filesize,(unsigned long)totalread);
-        goto done;
-    }
 
-done:
-#ifdef D4DEBUG
-fprintf(stderr,"readfile: filesize=%lu totalread=%lu\n",
-		(unsigned long)filesize,(unsigned long)totalread);
-#endif
-    if(fd >= 0) close(fd);
+    stat = NC_readfile(filename,packet);
     return THROW(stat);
 }

libdispatch/dauth.c

@@ -5,22 +5,26 @@ See LICENSE.txt for license information.
 
 
 #include "config.h"
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif
 #ifdef HAVE_STDARG_H
 #include <stdarg.h>
 #endif
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
 #include "netcdf.h"
 #include "ncbytes.h"
 #include "ncuri.h"
 #include "ncauth.h"
 #include "nclog.h"
 #include "ncwinpath.h"
 
+#ifdef _MSC_VER
+#include <windows.h>
+#endif
+
 #undef MEMCHECK
 #define MEMCHECK(x) if((x)==NULL) {goto nomem;} else {}
 
@@ -111,6 +115,8 @@ NC_authsetup(NCauth* auth, NCURI* uri)
 			NC_rclookup("HTTP.COOKIEJAR",uri_hostport));
     setauthfield(auth,"HTTP.COOKIE_JAR",
 			NC_rclookup("HTTP.COOKIE_JAR",uri_hostport));
+    setauthfield(auth,"HTTP.PROXY.SERVER",
+			NC_rclookup("HTTP.PROXY.SERVER",uri_hostport));
     setauthfield(auth,"HTTP.PROXY_SERVER",
 			NC_rclookup("HTTP.PROXY_SERVER",uri_hostport));
     setauthfield(auth,"HTTP.SSL.VALIDATE",
@@ -229,11 +235,11 @@ setauthfield(NCauth* auth, const char* flag, const char* value)
             nclog(NCLOGNOTE,"HTTP.COOKIEJAR: %s", auth->curlflags.cookiejar);
 #endif
     }
-    if(strcmp(flag,"HTTP.PROXY_SERVER")==0) {
+    if(strcmp(flag,"HTTP.PROXY.SERVER")==0 || strcmp(flag,"HTTP.PROXY_SERVER")==0) {
         ret = NC_parseproxy(auth,value);
         if(ret != NC_NOERR) goto done;
 #ifdef D4DEBUG
-            nclog(NCLOGNOTE,"HTTP.PROXY_SERVER: %s", value);
+            nclog(NCLOGNOTE,"HTTP.PROXY.SERVER: %s", value);
 #endif
     }
     if(strcmp(flag,"HTTP.SSL.VALIDATE")==0) {