More work on API dependencies
[oonf.git] / src-api / tools / olsr_telnet.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2013, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #ifndef OLSR_TELNET_H_
43 #define OLSR_TELNET_H_
44
45 #include "common/common_types.h"
46 #include "common/avl.h"
47 #include "common/list.h"
48 #include "common/netaddr.h"
49 #include "common/netaddr_acl.h"
50 #include "core/olsr_stream_socket.h"
51
52 enum olsr_telnet_result {
53   TELNET_RESULT_ACTIVE,
54   TELNET_RESULT_CONTINOUS,
55   TELNET_RESULT_INTERNAL_ERROR,
56   TELNET_RESULT_QUIT,
57
58   /*
59    * this one is used internally for the telnet API,
60    * it should not be returned by a command handler
61    */
62   _TELNET_RESULT_UNKNOWN_COMMAND,
63 };
64
65 /*
66  * represents a cleanup handler that must be called when the
67  * telnet core is shut down.
68  */
69 struct olsr_telnet_cleanup {
70   /* pointer to telnet data */
71   struct olsr_telnet_data *data;
72
73   /* callback for cleanup */
74   void (*cleanup_handler)(struct olsr_telnet_cleanup *);
75
76   /* custom data pointer for cleanup handler */
77   void *custom;
78
79   /* node for list of cleanup handlers */
80   struct list_entity node;
81 };
82
83 /*
84  * represents the data part of a telnet connection to a client
85  */
86 struct olsr_telnet_data {
87   /* address of remote communication partner */
88   struct netaddr *remote;
89
90   /* output buffer for telnet commands */
91   struct autobuf *out;
92
93   /* current telnet command and parameters */
94   const char *command;
95   const char *parameter;
96
97   /* remember if echo mode is active */
98   bool show_echo;
99
100   /* millisecond timeout between commands */
101   uint32_t timeout_value;
102
103   /* callback and data to stop a continous output txt command */
104   void (*stop_handler)(struct olsr_telnet_data *);
105   void *stop_data[4];
106
107   struct list_entity cleanup_list;
108 };
109
110 /*
111  * represents a full telnet session including socket
112  */
113 struct olsr_telnet_session {
114   struct olsr_stream_session session;
115   struct olsr_telnet_data data;
116 };
117
118 typedef enum olsr_telnet_result (*olsr_telnethandler)
119     (struct olsr_telnet_data *con);
120
121 #if !defined(REMOVE_HELPTEXT)
122 #define TELNET_CMD(cmd, cb, helptext, args...) { .command = (cmd), .handler = (cb), .help = helptext, ##args }
123 #else
124 #define TELNET_CMD(cmd, cb, helptext, args...) { .command = (cmd), .handler = (cb), .help = "", ##args }
125 #endif
126
127 /* represents a telnet command */
128 struct olsr_telnet_command {
129   /* name of telnet command */
130   const char *command;
131
132   /* help text for telnet command, NULL if it uses a custom help handler */
133   const char *help;
134
135   /* access control list for telnet command, NULL if not used */
136   struct netaddr_acl *acl;
137
138   /* handler for telnet command */
139   olsr_telnethandler handler;
140
141   /* handler for help text */
142   olsr_telnethandler help_handler;
143
144   /* node for tree of telnet commands */
145   struct avl_node _node;
146 };
147
148 EXPORT extern struct oonf_subsystem oonf_telnet_subsystem;
149
150 EXPORT struct avl_tree telnet_cmd_tree;
151
152 EXPORT int olsr_telnet_add(struct olsr_telnet_command *command);
153 EXPORT void olsr_telnet_remove(struct olsr_telnet_command *command);
154
155 EXPORT void olsr_telnet_stop(struct olsr_telnet_data *data);
156
157 EXPORT enum olsr_telnet_result olsr_telnet_execute(
158     const char *cmd, const char *para,
159     struct autobuf *out, struct netaddr *remote);
160
161 /**
162  * Add a cleanup handler to a telnet session
163  * @param data pointer to telnet data
164  * @param cleanup pointer to initialized cleanup handler
165  */
166 static INLINE void
167 olsr_telnet_add_cleanup(struct olsr_telnet_data *data,
168     struct olsr_telnet_cleanup *cleanup) {
169   cleanup->data = data;
170   list_add_tail(&data->cleanup_list, &cleanup->node);
171 }
172
173 /**
174  * Removes a cleanup handler to a telnet session
175  * @param cleanup pointer to cleanup handler
176  */
177 static INLINE void
178 olsr_telnet_remove_cleanup(struct olsr_telnet_cleanup *cleanup) {
179   list_remove(&cleanup->node);
180 }
181
182 /**
183  * Flushs the output stream of a telnet session. This will be only
184  * necessary for continous output.
185  * @param data pointer to telnet data
186  */
187 static INLINE void
188 olsr_telnet_flush_session(struct olsr_telnet_data *data) {
189   struct olsr_telnet_session *session;
190
191   session = container_of(data, struct olsr_telnet_session, data);
192   olsr_stream_flush(&session->session);
193 }
194
195 #endif /* OLSR_TELNET_H_ */