Rename miracle, valerie, humperdink, and albino.
[melted] / src / melted / melted_server.c
1 /*
2 * miracle_server.c
3 * Copyright (C) 2002-2003 Ushodaya Enterprises Limited
4 * Author: Charles Yates <charles.yates@pandora.be>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
21 /* System header files */
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <signal.h>
26
27 #include <fcntl.h>
28 #include <pthread.h>
29 #include <signal.h>
30 #include <stdlib.h>
31 #include <unistd.h>
32
33 #include <string.h>
34 #include <netinet/in.h>
35 #include <netdb.h>
36 #include <errno.h>
37 #include <arpa/inet.h>
38
39 /* Application header files */
40 #include "miracle_server.h"
41 #include "miracle_connection.h"
42 #include "miracle_local.h"
43 #include "miracle_log.h"
44 #include "miracle_commands.h"
45 #include <valerie/valerie_remote.h>
46 #include <valerie/valerie_tokeniser.h>
47
48 #define VERSION "0.0.1"
49
50 static void miracle_command_received( mlt_listener listener, mlt_properties owner, miracle_server this, void **args )
51 {
52 if ( listener != NULL )
53 listener( owner, this, ( valerie_response ** )args[ 0 ], ( char * )args[ 1 ] );
54 }
55
56 static void miracle_doc_received( mlt_listener listener, mlt_properties owner, miracle_server this, void **args )
57 {
58 if ( listener != NULL )
59 listener( owner, this, ( valerie_response ** )args[ 0 ], ( char * )args[ 1 ], ( char * )args[ 2 ] );
60 }
61
62 static void miracle_push_received( mlt_listener listener, mlt_properties owner, miracle_server this, void **args )
63 {
64 if ( listener != NULL )
65 listener( owner, this, ( valerie_response ** )args[ 0 ], ( char * )args[ 1 ], ( mlt_service )args[ 2 ] );
66 }
67
68 /** Initialise a server structure.
69 */
70
71 miracle_server miracle_server_init( char *id )
72 {
73 miracle_server server = malloc( sizeof( miracle_server_t ) );
74 if ( server != NULL )
75 memset( server, 0, sizeof( miracle_server_t ) );
76 if ( server != NULL && mlt_properties_init( &server->parent, server ) == 0 )
77 {
78 server->id = id;
79 server->port = DEFAULT_TCP_PORT;
80 server->socket = -1;
81 server->shutdown = 1;
82 mlt_events_init( &server->parent );
83 mlt_events_register( &server->parent, "command-received", ( mlt_transmitter )miracle_command_received );
84 mlt_events_register( &server->parent, "doc-received", ( mlt_transmitter )miracle_doc_received );
85 mlt_events_register( &server->parent, "push-received", ( mlt_transmitter )miracle_push_received );
86 }
87 return server;
88 }
89
90 const char *miracle_server_id( miracle_server server )
91 {
92 return server != NULL && server->id != NULL ? server->id : "miracle";
93 }
94
95 void miracle_server_set_config( miracle_server server, const char *config )
96 {
97 if ( server != NULL )
98 {
99 free( server->config );
100 server->config = config != NULL ? strdup( config ) : NULL;
101 }
102 }
103
104 /** Set the port of the server.
105 */
106
107 void miracle_server_set_port( miracle_server server, int port )
108 {
109 server->port = port;
110 }
111
112 void miracle_server_set_proxy( miracle_server server, char *proxy )
113 {
114 valerie_tokeniser tokeniser = valerie_tokeniser_init( );
115 server->proxy = 1;
116 server->remote_port = DEFAULT_TCP_PORT;
117 valerie_tokeniser_parse_new( tokeniser, proxy, ":" );
118 strcpy( server->remote_server, valerie_tokeniser_get_string( tokeniser, 0 ) );
119 if ( valerie_tokeniser_count( tokeniser ) == 2 )
120 server->remote_port = atoi( valerie_tokeniser_get_string( tokeniser, 1 ) );
121 valerie_tokeniser_close( tokeniser );
122 }
123
124 /** Wait for a connection.
125 */
126
127 static int miracle_server_wait_for_connect( miracle_server server )
128 {
129 struct timeval tv;
130 fd_set rfds;
131
132 /* Wait for a 1 second. */
133 tv.tv_sec = 1;
134 tv.tv_usec = 0;
135
136 FD_ZERO( &rfds );
137 FD_SET( server->socket, &rfds );
138
139 return select( server->socket + 1, &rfds, NULL, NULL, &tv);
140 }
141
142 /** Run the server thread.
143 */
144
145 static void *miracle_server_run( void *arg )
146 {
147 miracle_server server = arg;
148 pthread_t cmd_parse_info;
149 connection_t *tmp = NULL;
150 pthread_attr_t thread_attributes;
151 socklen_t socksize;
152
153 socksize = sizeof( struct sockaddr );
154
155 miracle_log( LOG_NOTICE, "%s version %s listening on port %i", server->id, VERSION, server->port );
156
157 /* Create the initial thread. We want all threads to be created detached so
158 their resources get freed automatically. (CY: ... hmmph...) */
159 pthread_attr_init( &thread_attributes );
160 pthread_attr_setdetachstate( &thread_attributes, PTHREAD_CREATE_DETACHED );
161
162 while ( !server->shutdown )
163 {
164 /* Wait for a new connection. */
165 if ( miracle_server_wait_for_connect( server ) )
166 {
167 /* Create a new block of data to hold a copy of the incoming connection for
168 our server thread. The thread should free this when it terminates. */
169
170 tmp = (connection_t*) malloc( sizeof(connection_t) );
171 tmp->owner = &server->parent;
172 tmp->parser = server->parser;
173 tmp->fd = accept( server->socket, (struct sockaddr*) &(tmp->sin), &socksize );
174
175 /* Pass the connection to a parser thread :-/ */
176 if ( tmp->fd != -1 )
177 pthread_create( &cmd_parse_info, &thread_attributes, parser_thread, tmp );
178 }
179 }
180
181 miracle_log( LOG_NOTICE, "%s version %s server terminated.", server->id, VERSION );
182
183 return NULL;
184 }
185
186 /** Execute the server thread.
187 */
188
189 int miracle_server_execute( miracle_server server )
190 {
191 int error = 0;
192 valerie_response response = NULL;
193 int index = 0;
194 struct sockaddr_in ServerAddr;
195 int flag = 1;
196
197 server->shutdown = 0;
198
199 ServerAddr.sin_family = AF_INET;
200 ServerAddr.sin_port = htons( server->port );
201 ServerAddr.sin_addr.s_addr = INADDR_ANY;
202
203 /* Create socket, and bind to port. Listen there. Backlog = 5
204 should be sufficient for listen (). */
205 server->socket = socket( AF_INET, SOCK_STREAM, 0 );
206
207 if ( server->socket == -1 )
208 {
209 server->shutdown = 1;
210 perror( "socket" );
211 miracle_log( LOG_ERR, "%s unable to create socket.", server->id );
212 return -1;
213 }
214
215 setsockopt( server->socket, SOL_SOCKET, SO_REUSEADDR, (char *)&flag, sizeof( int ) );
216
217 if ( bind( server->socket, (struct sockaddr *) &ServerAddr, sizeof (ServerAddr) ) != 0 )
218 {
219 server->shutdown = 1;
220 perror( "bind" );
221 miracle_log( LOG_ERR, "%s unable to bind to port %d.", server->id, server->port );
222 return -1;
223 }
224
225 if ( listen( server->socket, 5 ) != 0 )
226 {
227 server->shutdown = 1;
228 perror( "listen" );
229 miracle_log( LOG_ERR, "%s unable to listen on port %d.", server->id, server->port );
230 return -1;
231 }
232
233 fcntl( server->socket, F_SETFL, O_NONBLOCK );
234
235 if ( !server->proxy )
236 {
237 miracle_log( LOG_NOTICE, "Starting server on %d.", server->port );
238 server->parser = miracle_parser_init_local( );
239 }
240 else
241 {
242 miracle_log( LOG_NOTICE, "Starting proxy for %s:%d on %d.", server->remote_server, server->remote_port, server->port );
243 server->parser = valerie_parser_init_remote( server->remote_server, server->remote_port );
244 }
245
246 response = valerie_parser_connect( server->parser );
247
248 if ( response != NULL && valerie_response_get_error_code( response ) == 100 )
249 {
250 /* read configuration file */
251 if ( response != NULL && !server->proxy && server->config != NULL )
252 {
253 valerie_response_close( response );
254 response = valerie_parser_run( server->parser, server->config );
255
256 if ( valerie_response_count( response ) > 1 )
257 {
258 if ( valerie_response_get_error_code( response ) > 299 )
259 miracle_log( LOG_ERR, "Error evaluating server configuration. Processing stopped." );
260 for ( index = 0; index < valerie_response_count( response ); index ++ )
261 miracle_log( LOG_DEBUG, "%4d: %s", index, valerie_response_get_line( response, index ) );
262 }
263 }
264
265 if ( response != NULL )
266 {
267 int result;
268 valerie_response_close( response );
269 result = pthread_create( &server->thread, NULL, miracle_server_run, server );
270 if ( result )
271 {
272 miracle_log( LOG_CRIT, "Failed to launch TCP listener thread" );
273 error = -1;
274 }
275 }
276 }
277 else
278 {
279 miracle_log( LOG_ERR, "Error connecting to parser. Processing stopped." );
280 server->shutdown = 1;
281 error = -1;
282 }
283
284 return error;
285 }
286
287 /** Fetch a units properties
288 */
289
290 mlt_properties miracle_server_fetch_unit( miracle_server server, int index )
291 {
292 miracle_unit unit = miracle_get_unit( index );
293 return unit != NULL ? unit->properties : NULL;
294 }
295
296 /** Shutdown the server.
297 */
298
299 void miracle_server_shutdown( miracle_server server )
300 {
301 if ( server != NULL && !server->shutdown )
302 {
303 server->shutdown = 1;
304 pthread_join( server->thread, NULL );
305 miracle_server_set_config( server, NULL );
306 valerie_parser_close( server->parser );
307 server->parser = NULL;
308 close( server->socket );
309 }
310 }
311
312 /** Close the server.
313 */
314
315 void miracle_server_close( miracle_server server )
316 {
317 if ( server != NULL && mlt_properties_dec_ref( &server->parent ) <= 0 )
318 {
319 mlt_properties_close( &server->parent );
320 miracle_server_shutdown( server );
321 free( server );
322 }
323 }