Skip to content

Commit

Permalink
docs/examples: avoid deprecated options in examples where possible
Browse files Browse the repository at this point in the history
Example programs targeting a deprecated feature/option are commented with
a warning about it.
Other examples are adapted to not use deprecated options.
  • Loading branch information
monnerat committed Oct 6, 2022
1 parent e80c4ff commit e8448dc
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 46 deletions.
56 changes: 20 additions & 36 deletions docs/examples/anyauthput.c
Expand Up @@ -34,11 +34,9 @@
#include <curl/curl.h>

#ifdef WIN32
# include <io.h>
# define READ_3RD_ARG unsigned int
# define FILENO(fp) _fileno(fp)
#else
# include <unistd.h>
# define READ_3RD_ARG size_t
# define FILENO(fp) fileno(fp)
#endif

#if LIBCURL_VERSION_NUM < 0x070c03
Expand All @@ -50,33 +48,22 @@
* type. It PUTs a file given as a command line argument to the URL also given
* on the command line.
*
* Since libcurl 7.12.3, using "any" auth and POST/PUT requires a set ioctl
* Since libcurl 7.12.3, using "any" auth and POST/PUT requires a set seek
* function.
*
* This example also uses its own read callback.
*/

/* ioctl callback function */
static curlioerr my_ioctl(CURL *handle, curliocmd cmd, void *userp)
/* seek callback function */
static int my_seek(void *userp, curl_off_t offset, int origin)
{
int *fdp = (int *)userp;
int fd = *fdp;
FILE *fp = (FILE *) userp;

(void)handle; /* not used in here */
if(-1 == fseek(fp, (long) offset, origin))
/* couldn't seek */
return CURL_SEEKFUNC_CANTSEEK;

switch(cmd) {
case CURLIOCMD_RESTARTREAD:
/* mr libcurl kindly asks as to rewind the read data stream to start */
if(-1 == lseek(fd, 0, SEEK_SET))
/* couldn't rewind */
return CURLIOE_FAILRESTART;

break;

default: /* ignore unknown commands */
return CURLIOE_UNKNOWNCMD;
}
return CURLIOE_OK; /* success! */
return CURL_SEEKFUNC_OK; /* success! */
}

/* read callback function, fread() look alike */
Expand All @@ -85,10 +72,7 @@ static size_t read_callback(char *ptr, size_t size, size_t nmemb, void *stream)
ssize_t retcode;
unsigned long nread;

int *fdp = (int *)stream;
int fd = *fdp;

retcode = read(fd, ptr, (READ_3RD_ARG)(size * nmemb));
retcode = fread(ptr, size, nmemb, stream);

if(retcode > 0) {
nread = (unsigned long)retcode;
Expand All @@ -102,7 +86,7 @@ int main(int argc, char **argv)
{
CURL *curl;
CURLcode res;
int hd;
FILE *fp;
struct stat file_info;

char *file;
Expand All @@ -115,8 +99,8 @@ int main(int argc, char **argv)
url = argv[2];

/* get the file size of the local file */
hd = open(file, O_RDONLY);
fstat(hd, &file_info);
fp = fopen(file, "rb");
fstat(FILENO(fp), &file_info);

/* In windows, this will init the winsock stuff */
curl_global_init(CURL_GLOBAL_ALL);
Expand All @@ -128,13 +112,13 @@ int main(int argc, char **argv)
curl_easy_setopt(curl, CURLOPT_READFUNCTION, read_callback);

/* which file to upload */
curl_easy_setopt(curl, CURLOPT_READDATA, (void *)&hd);
curl_easy_setopt(curl, CURLOPT_READDATA, (void *) fp);

/* set the ioctl function */
curl_easy_setopt(curl, CURLOPT_IOCTLFUNCTION, my_ioctl);
/* set the seek function */
curl_easy_setopt(curl, CURLOPT_SEEKFUNCTION, my_seek);

/* pass the file descriptor to the ioctl callback as well */
curl_easy_setopt(curl, CURLOPT_IOCTLDATA, (void *)&hd);
/* pass the file descriptor to the seek callback as well */
curl_easy_setopt(curl, CURLOPT_SEEKDATA, (void *) fp);

/* enable "uploading" (which means PUT when doing HTTP) */
curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
Expand Down Expand Up @@ -166,7 +150,7 @@ int main(int argc, char **argv)
/* always cleanup */
curl_easy_cleanup(curl);
}
close(hd); /* close the local file */
fclose(fp); /* close the local file */

curl_global_cleanup();
return 0;
Expand Down
9 changes: 5 additions & 4 deletions docs/examples/ftpgetinfo.c
Expand Up @@ -46,7 +46,7 @@ int main(void)
CURL *curl;
CURLcode res;
long filetime = -1;
double filesize = 0.0;
curl_off_t filesize = 0;
const char *filename = strrchr(ftpurl, '/') + 1;

curl_global_init(CURL_GLOBAL_DEFAULT);
Expand All @@ -72,10 +72,11 @@ int main(void)
time_t file_time = (time_t)filetime;
printf("filetime %s: %s", filename, ctime(&file_time));
}
res = curl_easy_getinfo(curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD,
res = curl_easy_getinfo(curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD_T,
&filesize);
if((CURLE_OK == res) && (filesize>0.0))
printf("filesize %s: %0.0f bytes\n", filename, filesize);
if((CURLE_OK == res) && (filesize>0))
printf("filesize %s: %" CURL_FORMAT_CURL_OFF_T " bytes\n",
filename, filesize);
}
else {
/* we failed */
Expand Down
9 changes: 7 additions & 2 deletions docs/examples/multi-formadd.c
Expand Up @@ -26,6 +26,11 @@
* </DESC>
*/

/*
* Warning: this example uses the deprecated form api. See "multi-post.c"
* for a similar example using the mime api.
*/

#include <stdio.h>
#include <string.h>
#include <sys/time.h>
Expand All @@ -49,14 +54,14 @@ int main(void)
curl_formadd(&formpost,
&lastptr,
CURLFORM_COPYNAME, "sendfile",
CURLFORM_FILE, "postit2.c",
CURLFORM_FILE, "multi-formadd.c",
CURLFORM_END);

/* Fill in the filename field */
curl_formadd(&formpost,
&lastptr,
CURLFORM_COPYNAME, "filename",
CURLFORM_COPYCONTENTS, "postit2.c",
CURLFORM_COPYCONTENTS, "multi-formadd.c",
CURLFORM_END);

/* Fill in the submit field too, even if this is rarely needed */
Expand Down
12 changes: 8 additions & 4 deletions docs/examples/postit2-formadd.c
Expand Up @@ -25,17 +25,21 @@
* HTTP Multipart formpost with file upload and two additional parts.
* </DESC>
*/
/* Example code that uploads a file name 'foo' to a remote script that accepts

/*
* Example code that uploads a file name 'foo' to a remote script that accepts
* "HTML form based" (as described in RFC1738) uploads using HTTP POST.
*
* Warning: this example uses the deprecated form api. See "postit2.c"
* for a similar example using the mime api.
*
* The imaginary form we will fill in looks like:
*
* <form method="post" enctype="multipart/form-data" action="examplepost.cgi">
* Enter file: <input type="file" name="sendfile" size="40">
* Enter file name: <input type="text" name="filename" size="30">
* <input type="submit" value="send" name="submit">
* </form>
*
*/

#include <stdio.h>
Expand All @@ -59,14 +63,14 @@ int main(int argc, char *argv[])
curl_formadd(&formpost,
&lastptr,
CURLFORM_COPYNAME, "sendfile",
CURLFORM_FILE, "postit2.c",
CURLFORM_FILE, "postit2-formadd.c",
CURLFORM_END);

/* Fill in the filename field */
curl_formadd(&formpost,
&lastptr,
CURLFORM_COPYNAME, "filename",
CURLFORM_COPYCONTENTS, "postit2.c",
CURLFORM_COPYCONTENTS, "postit2-formadd.c",
CURLFORM_END);


Expand Down

0 comments on commit e8448dc

Please sign in to comment.