OFHTTPRequest.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * Alternatively, it may be distributed under the terms of the GNU General
 * Public License, either version 2 or 3, which can be found in the file
 * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
 * file.
 */

#import "OFObject.h"

@class OFString;
@class OFDictionary;
@class OFURL;
@class OFHTTPRequest;
@class OFHTTPRequestResult;
@class OFTCPSocket;
@class OFDataArray;

typedef enum of_http_request_type_t {
    OF_HTTP_REQUEST_TYPE_GET,
    OF_HTTP_REQUEST_TYPE_POST,
    OF_HTTP_REQUEST_TYPE_HEAD
} of_http_request_type_t;

#ifndef OF_HTTP_REQUEST_M
@protocol OFHTTPRequestDelegate <OFObject>
#else
@protocol OFHTTPRequestDelegate
#endif
#ifdef OF_HAVE_OPTIONAL_PROTOCOLS
@optional
#endif

-   (void)request: (OFHTTPRequest*)request
  didCreateSocket: (OFTCPSocket*)socket;

-     (void)request: (OFHTTPRequest*)request
  didReceiveHeaders: (OFDictionary*)headers
     withStatusCode: (int)statusCode;

-  (void)request: (OFHTTPRequest*)request
  didReceiveData: (const char*)data
      withLength: (size_t)length;

-    (BOOL)request: (OFHTTPRequest*)request
  willFollowRedirectTo: (OFURL*)URL;
@end

@interface OFHTTPRequest: OFObject
{
    OFURL *URL;
    of_http_request_type_t requestType;
    OFString *queryString;
    OFDictionary *headers;
    BOOL redirectsFromHTTPSToHTTPAllowed;
    id <OFHTTPRequestDelegate> delegate;
    BOOL storesData;
}

#ifdef OF_HAVE_PROPERTIES
@property (copy) OFURL *URL;
@property of_http_request_type_t requestType;
@property (copy) OFString *queryString;
@property (copy) OFDictionary *headers;
@property BOOL redirectsFromHTTPSToHTTPAllowed;
@property (assign) id <OFHTTPRequestDelegate> delegate;
@property BOOL storesData;
#endif

+ (instancetype)request;

+ (instancetype)requestWithURL: (OFURL*)URL;

- initWithURL: (OFURL*)URL;

- (void)setURL: (OFURL*)URL;

- (OFURL*)URL;

- (void)setRequestType: (of_http_request_type_t)requestType;

- (of_http_request_type_t)requestType;

- (void)setQueryString: (OFString*)queryString;

- (OFString*)queryString;

- (void)setHeaders: (OFDictionary*)headers;

- (OFDictionary*)headers;

- (void)setRedirectsFromHTTPSToHTTPAllowed: (BOOL)allowed;

- (BOOL)redirectsFromHTTPSToHTTPAllowed;

- (void)setDelegate: (id <OFHTTPRequestDelegate>)delegate;

- (id <OFHTTPRequestDelegate>)delegate;

- (void)setStoresData: (BOOL)storesData;

- (BOOL)storesData;

- (OFHTTPRequestResult*)perform;

- (OFHTTPRequestResult*)performWithRedirects: (size_t)redirects;
@end

@interface OFHTTPRequestResult: OFObject
{
    short statusCode;
    OFDataArray *data;
    OFDictionary *headers;
}

#ifdef OF_HAVE_PROPERTIES
@property (readonly) short statusCode;
@property (readonly, copy) OFDictionary *headers;
@property (readonly, retain) OFDataArray *data;
#endif

- initWithStatusCode: (short)status
         headers: (OFDictionary*)headers
        data: (OFDataArray*)data;

- (short)statusCode;

- (OFDictionary*)headers;

- (OFDataArray*)data;
@end

@interface OFObject (OFHTTPRequestDelegate) <OFHTTPRequestDelegate>
@end

extern Class of_http_request_tls_socket_class;