aio/src/server/admin/admin.h

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2013 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 ADMIN_H
#define	ADMIN_H

#include "../public/nsapi.h"
#include "webui.h"

#ifdef	__cplusplus
extern "C" {
#endif

typedef struct admin_page    Page;
typedef struct admin_request AdminRequest;
typedef int (*admin_service_f)(Page *, AdminRequest *);

struct admin_page {
    /*
     * The name of the page is an element of the admin page path. The path is
     * used to map urls to admin pages. If the name is NULL, every name is
     * mapped to this page.
     */
    char *name;
    
    /*
     * Parent page
     */
    Page *parent;
    
    /*
     * 
     */
    Page *next;
    
    /*
     * Pointer to the first child
     */
    Page *children;
    
    /*
     * int service(Page *page, AdminRequest *rq)
     * 
     * Service handler function for the page
     */
    int (*service)(Page *page, AdminRequest *rq);
    
    /*
     * custom user data
     */
    void *data;
};

struct admin_request {
    Session *sn;
    Request *rq;
    char    *name;
};

int admin_init(pblock *pb, Session *sn, Request *rq);
int admin_service(pblock *pb, Session *sn, Request *rq);

int admin_root(Page *page, AdminRequest *rq);
int adm_listener(Page *page, AdminRequest *rq);
int adm_cfglistener(Page *page, AdminRequest *rq);
int adm_auth(Page *page, AdminRequest *rq);

Page* admin_page_create(pool_handle_t *pool, char *name, admin_service_f f);
void admin_add_page(Page *parent, Page *child);


#ifdef	__cplusplus
}
#endif

#endif	/* ADMIN_H */