doc/developer-guide/api/functions/TSUrlStringGet.en.rst

.. Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.

.. include:: ../../../common.defs

.. default-domain:: c

TSUrlStringGet
**************

Traffic Server URL string representations API.

Synopsis
========

.. code-block:: cpp

    #include <ts/ts.h>

.. function:: char * TSUrlStringGet(TSMBuffer bufp, TSMLoc offset, int * length)
.. function:: char * TSHttpTxnEffectiveUrlStringGet(TSHttpTxn txn, int * length)
.. function:: TSReturnCode TSHttpHdrEffectiveUrlBufGet(TSMBuffer hdr_buf, TSMLoc hdr_loc, char * buf, int64_t size, int64_t* length)
.. function:: int TSUrlLengthGet(TSMBuffer bufp, TSMLoc offset)
.. function:: void TSUrlPrint(TSMBuffer bufp, TSMLoc offset, TSIOBuffer iobufp)

Description
===========

The URL data structure is a parsed version of a standard internet URL. The Traffic Server URL API
provides access to URL data stored in marshal buffers. The URL functions can create, copy, retrieve
or delete entire URLs, and retrieve or modify parts of URLs, such as their host, port or scheme
information.

:func:`TSUrlStringGet` constructs a string representation of the URL located at :arg:`offset` within
the marshal buffer :arg:`bufp`.  (However :arg:`bufp` is actually superfluous and may be null.)
:func:`TSUrlStringGet` stores the length of the allocated string in the parameter :arg:`length`.
This is the same length that :func:`TSUrlLengthGet` returns. The returned string is allocated by a
call to :func:`TSmalloc` and must be freed by a call to :func:`TSfree`. If length is :literal:`NULL`
then no attempt is made to de-reference it. The returned string is not guaranteed to have a null
terminator - :arg:`length` must be used to correctly display the string.

:func:`TSHttpTxnEffectiveUrlStringGet` is similar to :func:`TSUrlStringGet`. The two differences are:

*  The source is transaction :arg:`txn` and the URL is retrieved from the client request in that
   transaction.

*  If the client request URL has a host, that URL is returned, Otherwise, if there is a "Host" field
   the value of that field is used as the host in the returned URL.

This function is useful to guarantee a URL that is as complete as possible given the specific
request.

:func:`TSHttpHdrEffectiveUrlBufGet` returns the effective URL for any HTTP request (not just the client request).
If the request has a Host header field (and the URL does not contain a host specifier), the host specifier the header
provides is inserted into the URL.  The host and
scheme in the returned URL will be normalized to lower case letters (to make URL comparisons simple and fast).
This prints the effective URL for the header specified by :arg:`hdr_buf` and
:arg:`hdr_loc` to the buffer starting at :arg:`buf`. If the effective URL is longer than :arg:`size`, nothing is
written to :arg:`buf`.  Note that this is not considered an error case, the function will still return `TS_SUCCESS`.
It is the responsibility of the caller to check this result to determine if output was generated.
The full length of the URL is always returned in :arg:`*length` when the function returns `TS_SUCCESS`.

The typical usage would be
::

  TSMBuffer hdr_buf;
  TSMLoc hdr_loc;
  TSHttpTxnServerReqGet(txn, &hdr_buf, &hdr_loc);
  int64_t length;
  char store[2048];
  char *buf = store;
  TSHttpHdrEffectiveUrlBufGet(hdr_buf, hdr_loc, buf, sizeof(store), &length);
  if (length > sizeof(store)) {
    buf = static_cast<char *>(malloc(length));
    TSHttpHdrEffectiveUrlBufGet(hdr_buf, hdr_loc, buf, length, &length);
  }

:func:`TSUrlLengthGet` calculates the length of the URL located at :arg:`offset` within the marshal
buffer bufp as if it were returned as a string. This length will be the same as the length returned
by :func:`TSUrlStringGet`.

:func:`TSUrlPrint` formats a URL stored in an :type:`TSMBuffer` to an :type:`TSIOBuffer`. Capacity is
added as needed to the :arg:`iobufp` to print the entire URL.

See Also
========

:manpage:`TSAPI(3ts)`,
:manpage:`TSmalloc(3ts)`,
:manpage:`TSUrlCreate(3ts)`,
:manpage:`TSUrlHostGet(3ts)`,
:manpage:`TSUrlHostSet(3ts)`,
:manpage:`TSUrlPercentEncode(3ts)`