src/server/admin/admin.h

changeset 81
d25825f37967
equal deleted inserted replaced
80:0de4a90979e1 81:d25825f37967
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2013 Olaf Wintermann. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 #ifndef ADMIN_H
30 #define ADMIN_H
31
32 #include "../public/nsapi.h"
33 #include "webui.h"
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 typedef struct admin_page Page;
40 typedef struct admin_request AdminRequest;
41 typedef int (*admin_service_f)(Page *, AdminRequest *);
42
43 struct admin_page {
44 /*
45 * The name of the page is an element of the admin page path. The path is
46 * used to map urls to admin pages. If the name is NULL, every name is
47 * mapped to this page.
48 */
49 char *name;
50
51 /*
52 * Parent page
53 */
54 Page *parent;
55
56 /*
57 *
58 */
59 Page *next;
60
61 /*
62 * Pointer to the first child
63 */
64 Page *children;
65
66 /*
67 * int service(Page *page, AdminRequest *rq)
68 *
69 * Service handler function for the page
70 */
71 int (*service)(Page *page, AdminRequest *rq);
72
73 /*
74 * custom user data
75 */
76 void *data;
77 };
78
79 struct admin_request {
80 Session *sn;
81 Request *rq;
82 char *name;
83 };
84
85 int admin_init(pblock *pb, Session *sn, Request *rq);
86 int admin_service(pblock *pb, Session *sn, Request *rq);
87
88 int admin_root(Page *page, AdminRequest *rq);
89 int adm_listener(Page *page, AdminRequest *rq);
90 int adm_cfglistener(Page *page, AdminRequest *rq);
91 int adm_auth(Page *page, AdminRequest *rq);
92
93 Page* admin_page_create(pool_handle_t *pool, char *name, admin_service_f f);
94 void admin_add_page(Page *parent, Page *child);
95
96
97 #ifdef __cplusplus
98 }
99 #endif
100
101 #endif /* ADMIN_H */
102

mercurial