src/server/webdav/multistatus.h

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2019 Olaf Wintermann. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef MULTISTATUS_H
#define MULTISTATUS_H

#include "../public/webdav.h"

#include <ucx/map.h>
#include <ucx/buffer.h>
#include <libxml/tree.h>
#include "../util/writer.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct Multistatus Multistatus;
typedef struct MSResponse MSResponse;

typedef struct PropertyOkList PropertyOkList;
typedef struct PropertyErrorList PropertyErrorList;

/*
 * implements the WebdavResponse interface
 */
struct Multistatus {
    WebdavResponse response;
    Session *sn;
    Request *rq;
    MSResponse *first;
    MSResponse *current;
    
    /*
     * Map of document namespace definitions
     * 
     * key: (char*) namespace prefix
     * value: WSNamespace*
     */
    UcxMap *namespaces;
    
    /*
     * Is this a proppatch request?
     * 
     * In a proppatch response, when the first property with an error occurs,
     * all already added properties will be set to 424 Failed Dependency.
     */
    WSBool proppatch;
};

/*
 * implements the WebdavResource interface
 */
struct MSResponse {
    WebdavResource resource;
    Multistatus *multistatus;
    
    /*
     * Contains all properties that were added to the response
     * key: <href> null-byte <name>
     * value: WebdavProperty*
     */
    UcxMap *properties;
    
    /*
     * All properties with status != 200
     */
    PropertyErrorList *errors;
    
    /*
     * All properties with status == 200
     */
    PropertyOkList *plist_begin;
    PropertyOkList *plist_end;
    
    MSResponse *next;
    WSBool closing;
};

struct PropertyOkList {
    WebdavProperty *property;
    WebdavNSList   *nsdef;
    PropertyOkList *next;
};

struct PropertyErrorList {
    /*
     * next list for different status code
     */
    PropertyErrorList *next;
    
    /*
     * property list for all properties with this status code
     */
    WebdavPList *begin;
    
    /*
     * tail of the property list
     */
    WebdavPList *end;
    
    /*
     * property response status code
     */
    int status;
};

Multistatus* multistatus_response(Session *sn, Request *rq);

int multistatus_send(Multistatus *ms, SYS_NETFD out);

WebdavResource * multistatus_addresource(
        WebdavResponse *response,
        const char *path);

int msresponse_addproperty(
        WebdavResource *res,
        WebdavProperty *property,
        int status);

int msresponse_addproperror(
        MSResponse *response,
        WebdavProperty *property,
        int statuscode);

int msresponse_close(WebdavResource *res);

#ifdef __cplusplus
}
#endif

#endif /* MULTISTATUS_H */