Unverified Commit fb30ac5a authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

URL-API 

See header file and man pages for API. All documented API details work
and are tested in the 1560 test case.

Closes #2842
parent 17ca0ccf

docs/libcurl/Makefile.inc

+80 −23
Original line number Diff line number Diff line 
# Shared between Makefile.am and CMakeLists.txt



man_MANS = curl_easy_cleanup.3 curl_easy_getinfo.3 curl_easy_init.3      \

  curl_easy_perform.3 curl_easy_setopt.3 curl_easy_duphandle.3           \

  curl_formadd.3 curl_formfree.3 curl_getdate.3 curl_getenv.3            \

  curl_slist_append.3 curl_slist_free_all.3 curl_version.3               \

  curl_version_info.3 curl_escape.3 curl_unescape.3 curl_free.3          \

  curl_strequal.3 curl_strnequal.3  curl_mprintf.3 curl_global_init.3    \

  curl_global_cleanup.3 curl_multi_add_handle.3 curl_multi_cleanup.3     \

  curl_multi_fdset.3 curl_multi_info_read.3 curl_multi_init.3            \

  curl_multi_perform.3 curl_multi_remove_handle.3 curl_share_cleanup.3   \

  curl_share_init.3 curl_share_setopt.3 libcurl.3 libcurl-easy.3         \

  libcurl-multi.3 libcurl-share.3 libcurl-errors.3 curl_easy_strerror.3  \

  curl_multi_strerror.3 curl_share_strerror.3 curl_global_init_mem.3     \

  libcurl-tutorial.3 curl_easy_reset.3 curl_easy_escape.3                \

  curl_easy_unescape.3 curl_multi_setopt.3 curl_multi_socket.3           \

  curl_multi_timeout.3 curl_formget.3 curl_multi_assign.3                \

  curl_easy_pause.3 curl_easy_recv.3 curl_easy_send.3                    \

  curl_multi_socket_action.3 curl_multi_wait.3 libcurl-symbols.3         \

  libcurl-thread.3 curl_multi_socket_all.3 curl_global_sslset.3          \

  curl_mime_init.3 curl_mime_free.3 curl_mime_addpart.3 curl_mime_name.3 \

  curl_mime_data.3 curl_mime_data_cb.3 curl_mime_filedata.3              \

  curl_mime_filename.3 curl_mime_subparts.3                              \

  curl_mime_type.3 curl_mime_headers.3 curl_mime_encoder.3 libcurl-env.3 \

  libcurl-security.3 curl_easy_upkeep.3
 
man_MANS =			\

 curl_easy_cleanup.3		\

 curl_easy_duphandle.3		\

 curl_easy_escape.3		\

 curl_easy_getinfo.3		\

 curl_easy_init.3		\

 curl_easy_pause.3		\

 curl_easy_perform.3		\

 curl_easy_recv.3		\

 curl_easy_reset.3		\

 curl_easy_send.3		\

 curl_easy_setopt.3		\

 curl_easy_strerror.3		\

 curl_easy_unescape.3		\

 curl_easy_upkeep.3		\

 curl_escape.3			\

 curl_formadd.3			\

 curl_formfree.3		\

 curl_formget.3			\

 curl_free.3			\

 curl_getdate.3			\

 curl_getenv.3			\

 curl_global_cleanup.3		\

 curl_global_init.3		\

 curl_global_init_mem.3		\

 curl_global_sslset.3		\

 curl_mime_addpart.3		\

 curl_mime_data.3		\

 curl_mime_data_cb.3		\

 curl_mime_encoder.3		\

 curl_mime_filedata.3		\

 curl_mime_filename.3		\

 curl_mime_free.3		\

 curl_mime_headers.3		\

 curl_mime_init.3		\

 curl_mime_name.3		\

 curl_mime_subparts.3		\

 curl_mime_type.3		\

 curl_mprintf.3			\

 curl_multi_add_handle.3	\

 curl_multi_assign.3		\

 curl_multi_cleanup.3		\

 curl_multi_fdset.3		\

 curl_multi_info_read.3		\

 curl_multi_init.3		\

 curl_multi_perform.3		\

 curl_multi_remove_handle.3	\

 curl_multi_setopt.3		\

 curl_multi_socket.3		\

 curl_multi_socket_action.3	\

 curl_multi_socket_all.3	\

 curl_multi_strerror.3		\

 curl_multi_timeout.3		\

 curl_multi_wait.3		\

 curl_share_cleanup.3		\

 curl_share_init.3		\

 curl_share_setopt.3		\

 curl_share_strerror.3		\

 curl_slist_append.3		\

 curl_slist_free_all.3		\

 curl_strequal.3		\

 curl_strnequal.3		\

 curl_unescape.3		\

 curl_url.3			\

 curl_url_cleanup.3		\

 curl_url_dup.3			\

 curl_url_get.3			\

 curl_url_set.3			\

 curl_version.3			\

 curl_version_info.3		\

 libcurl-easy.3			\

 libcurl-env.3			\

 libcurl-errors.3		\

 libcurl-multi.3		\

 libcurl-security.3		\

 libcurl-share.3		\

 libcurl-symbols.3		\

 libcurl-thread.3		\

 libcurl-tutorial.3		\

 libcurl.3

docs/libcurl/curl_url.3

0 → 100644
+61 −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 curl_url 3 "6 Aug 2018" "libcurl" "libcurl Manual"

.SH NAME

curl_url - returns a new CURLU handle

.SH SYNOPSIS

.B #include <curl/curl.h>



CURLU *curl_url();

.SH EXPERIMENTAL

The URL API is considered \fBEXPERIMENTAL\fP until further notice. Please test

it, report bugs and help us perfect it. Once proven to be reliable, the

experimental label will be removed.



While this API is marked experimental, we reserve the right to modify the API

slightly if we deem it necessary and it makes it notably better or easier to

use.

.SH DESCRIPTION

This function will allocates and returns a pointer to a fresh CURLU handle, to

be used for further use of the URL API.

.SH RETURN VALUE

Returns a \fBCURLU *\fP if successful, or NULL if out of memory.

.SH EXAMPLE

.nf

  CURLUcode rc;

  CURLU *url = curl_url();

  rc = curl_url_set(url, CURLUPART_URL, "https://example.com", 0);

  if(!rc) {

    char *scheme;

    rc = curl_url_get(url, CURLUPART_SCHEME, &scheme, 0);

    if(!rc) {

      printf("the scheme is %s\n", scheme);

      curl_free(scheme);

    }

    curl_url_cleanup(url);

  }

.fi

.SH AVAILABILITY

Added in curl 7.63.0

.SH "SEE ALSO"

.BR curl_url_cleanup "(3), " curl_url_get "(3), " curl_url_set "(3), "

.BR curl_url_dup "(3), "

docs/libcurl/curl_url_cleanup.3

0 → 100644
+44 −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 curl_url_cleanup 3 "6 Aug 2018" "libcurl" "libcurl Manual"

.SH NAME

curl_url_cleanup - free a CURLU handle

.SH SYNOPSIS

.B #include <curl/curl.h>



void curl_url_cleanup(CURLU *handle);

.fi

.SH DESCRIPTION

Frees all the resources associated with the given CURLU handle!

.SH RETURN VALUE

none

.SH EXAMPLE

.nf

  CURLU *url = curl_url();

  curl_url_set(url, CURLUPART_URL, "https://example.com", 0);

  curl_url_cleanup(url);

.fi

.SH AVAILABILITY

Added in curl 7.63.0

.SH "SEE ALSO"

.BR curl_url_dup "(3), " curl_url "(3), " curl_url_set "(3), "

.BR curl_url_get "(3), "

docs/libcurl/curl_url_dup.3

0 → 100644
+52 −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 curl_url_dup 3 "6 Aug 2018" "libcurl" "libcurl Manual"

.SH NAME

curl_url_dup - duplicate a CURLU handle

.SH SYNOPSIS

.B #include <curl/curl.h>



CURLU *curl_url_dup(CURLU *inhandle);

.fi

.SH DESCRIPTION

Duplicates a given CURLU \fIinhandle\fP and all its contents and returns a

pointer to a new CURLU handle. The new handle also needs to be freed with

\fIcurl_url_cleanup(3)\fP.

.SH RETURN VALUE

Returns a new handle or NULL if out of memory.

.SH EXAMPLE

.nf

  CURLUcode rc;

  CURLU *url = curl_url();

  CURLU *url2;

  rc = curl_url_set(url, CURLUPART_URL, "https://example.com", 0);

  if(!rc) {

    url2 = curl_url_dup(url); /* clone it! */

    curl_url_cleanup(url2);

  }

  curl_url_cleanup(url);

.fi

.SH AVAILABILITY

Added in curl 7.63.0

.SH "SEE ALSO"

.BR curl_url_cleanup "(3), " curl_url "(3), " curl_url_set "(3), "

.BR curl_url_get "(3), "

docs/libcurl/curl_url_get.3

0 → 100644
+110 −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 curl_url_get 3 "6 Aug 2018" "libcurl" "libcurl Manual"

.SH NAME

curl_url_get - extract a part from a URL

.SH SYNOPSIS

.B #include <curl/curl.h>



.nf

CURLUcode curl_url_get(CURLU *url,

                       CURLUPart what,

                       char **part,

                       unsigned int flags)

.fi

.SH DESCRIPTION

Given the \fIurl\fP handle of an already parsed URL, this function lets the

user extract individual pieces from it.



The \fIwhat\fP argument should be the particular part to extract (see list

below) and \fIpart\fP points to a 'char *' to get updated to point to a newly

allocated string with the contents.



The \fIflags\fP argument is a bitmask with individual features.



The returned part pointer must be freed with \fIcurl_free(3)\fP after use.

.SH FLAGS

The flags argument is zero, one or more bits set in a bitmask.

.IP CURLU_DEFAULT_PORT

If the handle has no port stored, this option will make \fIcurl_url_get(3)\fP

return the default port for the used scheme.

.IP CURLU_DEFAULT_SCHEME

If the handle has no scheme stored, this option will make

\fIcurl_url_get(3)\fP return the default scheme instead of error.

.IP CURLU_NO_DEFAULT_PORT

Instructs \fIcurl_url_get(3)\fP to not return a port number if it matches the

default port for the scheme.

.IP CURLU_URLDECODE

Asks \fIcurl_url_get(3)\fP to URL decode the contents before returning it. It

will not attempt to decode the scheme, the port number or the full URL.



The query component will also get plus-to-space convertion as a bonus when

this bit is set.



Note that this URL decoding is charset unaware and you will get a zero

terminated string back with data that could be intended for a particular

encoding.



If there's any byte values lower than 32 in the decoded string, the get

operation will return an error instead.

.SH PARTS

.IP CURLUPART_URL

When asked to return the full URL, \fIcurl_url_get(3)\fP will return a

normalized and possibly cleaned up version of what was previously parsed.

.IP CURLUPART_SCHEME

Scheme cannot be URL decoded on get.

.IP CURLUPART_USER

.IP CURLUPART_PASSWORD

.IP CURLUPART_OPTIONS

.IP CURLUPART_HOST

.IP CURLUPART_PORT

Port cannot be URL decoded on get.

.IP CURLUPART_PATH

.IP CURLUPART_QUERY

The query part will also get pluses converted to space when asked to URL

decode on get with the CURLU_URLDECODE bit.

.IP CURLUPART_FRAGMENT

.SH RETURN VALUE

Returns a CURLUcode error value, which is CURLUE_OK (0) if everything went

fine.



If this function returns an error, no URL part is returned.

.SH EXAMPLE

.nf

  CURLUcode rc;

  CURLU *url = curl_url();

  rc = curl_url_set(url, CURLUPART_URL, "https://example.com", 0);

  if(!rc) {

    char *scheme;

    rc = curl_url_get(url, CURLUPART_SCHEME, &scheme, 0);

    if(!rc) {

      printf("the scheme is %s\n", scheme);

      curl_free(scheme);

    }

    curl_url_cleanup(url);

  }

.fi

.SH AVAILABILITY

Added in curl 7.63.0

.SH "SEE ALSO"

.BR curl_url_cleanup "(3), " curl_url "(3), " curl_url_set "(3), "

.BR curl_url_dup "(3), "