mime_util.h

Go to the documentation of this file.

// -*- mode: c++; c-basic-offset:4 -*-

// This file is part of libdap, A C++ implementation of the OPeNDAP Data
// Access Protocol.

// Copyright (c) 2002,2003 OPeNDAP, Inc.
// Author: James Gallagher <jgallagher@opendap.org>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.

// (c) COPYRIGHT URI/MIT 1995-1999
// Please read the full copyright statement in the file COPYRIGHT_URI.
//
// Authors:
//      jhrg,jimg       James Gallagher <jgallagher@gso.uri.edu>
//      reza            Reza Nekovei <reza@intcomm.net>

// External definitions for utility functions used by servers.
//
// 2/22/95 jhrg

#ifndef _mime_util_h
#define _mime_util_h

#include "media_types.h"        // Remove when the deprecated stuff comes out of the library. 11/12/13 jhrg

#ifndef _object_type_h
#include "ObjectType.h"
#endif

#ifndef _encoding_type_h
#include "EncodingType.h"
#endif

namespace libdap
{

std::string rfc822_date(const time_t t);
time_t last_modified_time(const std::string &name);
ObjectType get_description_type(const std::string &value);
bool is_boundary(const char *line, const std::string &boundary);
std::string cid_to_header_value(const std::string &cid);

std::string read_multipart_boundary(std::istream &in, const std::string &boundary = "");

void parse_mime_header(const std::string &header, std::string &name, std::string &value);
std::string name_path(const std::string &path);
std::string get_next_mime_header(std::istream &in);

void read_multipart_headers(std::istream &in, const std::string &content_type,
        const ObjectType object_type, const std::string &cid = "");

// For testing only
void remove_mime_header(std::istream &in);

// All of these are deprecated
std::string read_multipart_boundary(FILE *in, const std::string &boundary = "");
void read_multipart_headers(FILE *in, const std::string &content_type,
        const ObjectType object_type, const std::string &cid = "");
bool do_version(const std::string &script_ver, const std::string &dataset_ver);
void ErrMsgT(const std::string &Msgt);
ObjectType get_type(const std::string &value);
std::string get_next_mime_header(FILE *in);
bool remove_mime_header(FILE *in);

#if 0
bool found_override(std::string name, std::string &doc);
#endif


void set_mime_text(FILE *out, ObjectType type = unknown_type,
                   const std::string &version = "", EncodingType enc = x_plain,
                   const time_t last_modified = 0);
void set_mime_text(std::ostream &out, ObjectType type = unknown_type,
                   const std::string &version = "", EncodingType enc = x_plain,
                   const time_t last_modified = 0);
void set_mime_text(std::ostream &out, ObjectType type = unknown_type,
                   EncodingType enc = x_plain,
                   const time_t last_modified = 0,
                   const std::string &protocol = "");

void set_mime_html(FILE *out, ObjectType type = unknown_type,
                   const std::string &version = "", EncodingType enc = x_plain,
                   const time_t last_modified = 0);
void set_mime_html(std::ostream &out, ObjectType type = unknown_type,
                   const std::string &version = "", EncodingType enc = x_plain,
                   const time_t last_modified = 0);
void set_mime_html(std::ostream &out, ObjectType type = unknown_type,
                   EncodingType enc = x_plain,
                   const time_t last_modified = 0,
                   const std::string &protocol = "");

void set_mime_binary(FILE *out, ObjectType type = unknown_type,
                     const std::string &version = "", EncodingType enc = x_plain,
                     const time_t last_modified = 0);
void set_mime_binary(std::ostream &out, ObjectType type = unknown_type,
                     const std::string &version = "", EncodingType enc = x_plain,
                     const time_t last_modified = 0);
void set_mime_binary(std::ostream &out, ObjectType type = unknown_type,
                     EncodingType enc = x_plain,
                     const time_t last_modified = 0,
                     const std::string &protocol = "");

void set_mime_multipart(std::ostream &out, const std::string &boundary,
        const std::string &start, ObjectType type = unknown_type,
        const std::string &version = "", EncodingType enc = x_plain,
        const time_t last_modified = 0);

void set_mime_multipart(std::ostream &out, const std::string &boundary,
        const std::string &start, ObjectType type = unknown_type, EncodingType enc = x_plain,
        const time_t last_modified = 0, const std::string &protocol = "",
        const std::string &url = "");

void set_mime_ddx_boundary(std::ostream &out, const std::string &boundary,
        const std::string &start, ObjectType type = unknown_type,
        EncodingType enc = x_plain);

void set_mime_data_boundary(std::ostream &out, const std::string &boundary,
        const std::string &cid, ObjectType type = unknown_type,
        EncodingType enc = x_plain);

void set_mime_error(FILE *out, int code = 404,
                    const std::string &reason = "Dataset not found",
                    const std::string &version = "");
void set_mime_error(std::ostream &out, int code = 404,
                    const std::string &reason = "Dataset not found",
                    const std::string &version = "");

void set_mime_not_modified(FILE *out);
void set_mime_not_modified(std::ostream &out);



} // namespace libdap

#endif // _mime_util_h