src/core/transport/http/common/http_header.c

/*
 * 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 <axis2_http_header.h>
#include <axutil_string.h>
#include <axis2_http_transport.h>
#include <stdio.h>
#include <string.h>

struct axis2_http_header
{
    axis2_char_t *name;
    axis2_char_t *value;
};

AXIS2_EXTERN axis2_http_header_t *AXIS2_CALL
axis2_http_header_create(
    const axutil_env_t * env,
    const axis2_char_t * name,
    const axis2_char_t * value)
{
    axis2_http_header_t *http_header = NULL;
    http_header = (axis2_http_header_t *)AXIS2_MALLOC(env->allocator, sizeof(axis2_http_header_t));
    if(!http_header)
    {
        AXIS2_HANDLE_ERROR(env, AXIS2_ERROR_NO_MEMORY, AXIS2_FAILURE);
        return NULL;
    }
    memset((void *)http_header, 0, sizeof(axis2_http_header_t));
    http_header->name = (axis2_char_t *)axutil_strdup(env, name);
    http_header->value = (axis2_char_t *)axutil_strdup(env, value);

    return http_header;
}

/**
 * Creates http header object from a string having format "header_name:     header_value"
 * (e.g. "SOAPAction: urn:hello")
 * @param env pointer to environment struct
 * @param str pointer to str
 */
AXIS2_EXTERN axis2_http_header_t *AXIS2_CALL
axis2_http_header_create_by_str(
    const axutil_env_t * env,
    const axis2_char_t * str)
{
    axis2_char_t *tmp_str = NULL;
    axis2_char_t *ch = NULL;
    axis2_char_t *ch2 = NULL;
    axis2_http_header_t *ret = NULL;
    int tmp_str_len = 0;
    AXIS2_PARAM_CHECK(env->error, str, NULL);

    /*
    tmp_str = axutil_strdup(env, str);
    if(!tmp_str)
    {
        AXIS2_LOG_ERROR(env->log, AXIS2_LOG_SI, "unable to strdup string, %s", str);
        return NULL;
    }
    */
    /*
     * strdup is removed to increase the performance. This method is called from
     * axis2_simple_http_svr_conn_read_request and axis2_http_client_receive_header and both of them
     * passes a temporary string. hence we can modify the contents without doing a strdup.
     * Above code is commented after 1.6.0 . If no issue is found until 1.8.0, above can be removed
     */
    tmp_str = (axis2_char_t *)str;

    /* remove trailing \r\n */
    tmp_str_len = axutil_strlen(tmp_str);
    if((tmp_str_len >= 2) && (AXIS2_RETURN == tmp_str[tmp_str_len - 2]))
    {
        tmp_str[tmp_str_len - 2] = AXIS2_ESC_NULL;
    }

    /* get http header */
    ch = strchr((const char *)tmp_str, AXIS2_COLON);
    if(!ch)
    {
        /*AXIS2_FREE(env->allocator, tmp_str);*/
        return NULL;
    }
    *ch = AXIS2_ESC_NULL;

    /* get http header value */
    ch2 = ++ch;

    /* skip spaces */
    while(AXIS2_SPACE == *ch2)
    {
        ++ch2;
    }

    ret = axis2_http_header_create(env, tmp_str, ch2);
    /*AXIS2_FREE(env->allocator, tmp_str);*/
    return ret;
}

AXIS2_EXTERN void AXIS2_CALL
axis2_http_header_free(
    axis2_http_header_t * http_header,
    const axutil_env_t * env)
{

    if(!http_header)
    {
        return;
    }

    if(http_header->name)
    {
        AXIS2_FREE(env->allocator, http_header->name);
    }
    if(http_header->value)
    {
        AXIS2_FREE(env->allocator, http_header->value);
    }

    AXIS2_FREE(env->allocator, http_header);
    return;
}

AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axis2_http_header_to_external_form(
    axis2_http_header_t * http_header,
    const axutil_env_t * env)
{
    axis2_ssize_t len = 0;
    axis2_char_t *external_form = NULL;

    AXIS2_PARAM_CHECK(env->error, http_header, NULL);

    len = axutil_strlen(http_header->name) + axutil_strlen(http_header->value) + 8;
    external_form = (axis2_char_t *)AXIS2_MALLOC(env->allocator, len);
    sprintf(external_form, "%s: %s%s", http_header->name, http_header->value, AXIS2_HTTP_CRLF);
    return external_form;
}

AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axis2_http_header_get_name(
    const axis2_http_header_t * http_header,
    const axutil_env_t * env)
{
    return http_header->name;
}

AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axis2_http_header_get_value(
    const axis2_http_header_t * http_header,
    const axutil_env_t * env)
{
    return http_header->value;
}

AXIS2_EXTERN void AXIS2_CALL
axis2_http_header_set_value(
    axis2_http_header_t * http_header,
    const axutil_env_t * env,
    const axis2_char_t *value)
{
    if(http_header->value)
    {
        AXIS2_FREE(env->allocator, http_header->value);
        http_header->value = NULL;
    }
    http_header->value = (axis2_char_t *)axutil_strdup(env, value);
}