Unverified Commit 8f69a9f2 authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

time: support > year 2038 time stamps for system with 32bit long 

... with the introduction of CURLOPT_TIMEVALUE_LARGE and
CURLINFO_FILETIME_T.

Fixes #2238
Closes #2264
parent 9caa3e24

docs/libcurl/curl_easy_getinfo.3

+4 −3
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms
@@ -54,8 +54,9 @@ See \fICURLINFO_HTTP_CONNECTCODE(3)\fP 
The http version used in the connection.

See \fICURLINFO_HTTP_VERSION(3)\fP

.IP CURLINFO_FILETIME

Remote time of the retrieved document.

See \fICURLINFO_FILETIME(3)\fP

Remote time of the retrieved document. See \fICURLINFO_FILETIME(3)\fP

.IP CURLINFO_FILETIME_T

Remote time of the retrieved document. See \fICURLINFO_FILETIME_T(3)\fP

.IP CURLINFO_TOTAL_TIME

Total time of previous transfer.

See \fICURLINFO_TOTAL_TIME(3)\fP

docs/libcurl/curl_easy_setopt.3

+3 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms
@@ -421,6 +421,8 @@ Maximum file size to get. See \fICURLOPT_MAXFILESIZE_LARGE(3)\fP 
Make a time conditional request. See \fICURLOPT_TIMECONDITION(3)\fP

.IP CURLOPT_TIMEVALUE

Time value for the time conditional request. See \fICURLOPT_TIMEVALUE(3)\fP

.IP CURLOPT_TIMEVALUE_LARGE

Time value for the time conditional request. See \fICURLOPT_TIMEVALUE_LARGE(3)\fP

.SH CONNECTION OPTIONS

.IP CURLOPT_TIMEOUT

Timeout for the entire request. See \fICURLOPT_TIMEOUT(3)\fP

docs/libcurl/opts/CURLINFO_FILETIME.3

+7 −4
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms
@@ -34,9 +34,12 @@ Pass a pointer to a long to receive the remote time of the retrieved document 
hide it or the server doesn't support the command that tells document time

etc) and the time of the document is unknown.



Note that you must tell the server to collect this information before the

transfer is made, by using the \fICURLOPT_FILETIME(3)\fP option to

\fIcurl_easy_setopt(3)\fP or you will unconditionally get a -1 back.

You must tell libcurl to collect this information before the transfer is made,

by using the \fICURLOPT_FILETIME(3)\fP option to \fIcurl_easy_setopt(3)\fP or

you will unconditionally get a -1 back.



Consider using \fICURLINFO_FILETIME_T(3)\fP to be able to extract dates beyond

the year 2038 on systems using 32 bit longs.

.SH PROTOCOLS

HTTP(S), FTP(S), SFTP

.SH EXAMPLE

docs/libcurl/opts/CURLINFO_FILETIME_T.3

0 → 100644
+71 −0
Original line number Diff line number Diff line 
.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms

.\" * are also available at https://curl.haxx.se/docs/copyright.html.

.\" *

.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell

.\" * copies of the Software, and permit persons to whom the Software is

.\" * furnished to do so, under the terms of the COPYING file.

.\" *

.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY

.\" * KIND, either express or implied.

.\" *

.\" **************************************************************************

.\"

.TH CURLINFO_FILETIME 3 "25 Jan 2018" "libcurl 7.59.0" "curl_easy_getinfo options"

.SH NAME

CURLINFO_FILETIME_T \- get the remote time of the retrieved document

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FILETIME_T, curl_off_t *timep);

.SH DESCRIPTION

Pass a pointer to a curl_off_t to receive the remote time of the retrieved

document (in number of seconds since 1 jan 1970 in the GMT/UTC time zone). If

you get -1, it can be because of many reasons (it might be unknown, the server

might hide it or the server doesn't support the command that tells document

time etc) and the time of the document is unknown.



You must ask libcurl to collect this information before the transfer is made,

by using the \fICURLOPT_FILETIME(3)\fP option to \fIcurl_easy_setopt(3)\fP or

you will unconditionally get a -1 back.



This option is an alternative to \fICURLINFO_FILETIME(3)\fP to allow systems

with 32 bit long variables to extract dates outside of the 32bit timestamp

range.

.SH PROTOCOLS

HTTP(S), FTP(S), SFTP

.SH EXAMPLE

.nf

curl = curl_easy_init();

if(curl) {

  curl_easy_setopt(curl, CURLOPT_URL, url);

  /* Ask for filetime */

  curl_easy_setopt(curl, CURLOPT_FILETIME, 1L);

  res = curl_easy_perform(curl);

  if(CURLE_OK == res) {

    curl_off_t filetime;

    res = curl_easy_getinfo(curl, CURLINFO_FILETIME_T, &filetime);

    if((CURLE_OK == res) && (filetime >= 0)) {

      time_t file_time = (time_t)filetime;

      printf("filetime %s: %s", filename, ctime(&file_time));

    }

  }

  /* always cleanup */

  curl_easy_cleanup(curl);

}

.fi

.SH AVAILABILITY

Added in 7.59.0

.SH RETURN VALUE

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

.SH "SEE ALSO"

.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "

docs/libcurl/opts/CURLOPT_TIMEVALUE.3

+4 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * This software is licensed as described in the file COPYING, which

.\" * you should have received as part of this distribution. The terms
@@ -31,6 +31,9 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEVALUE, long val); 
Pass a long \fIval\fP as parameter. This should be the time counted as seconds

since 1 Jan 1970, and the time will be used in a condition as specified with

\fICURLOPT_TIMECONDITION(3)\fP.



On systems with 32 bit 'long' variables, this option cannot set dates beyond

the year 2038. Consider \fICURLOPT_TIMEVALUE_LARGE(3)\fP instead.

.SH DEFAULT

0

.SH PROTOCOLS