Convenience functionality for properties load and miracle_server_id function
[melted] / src / miracle / miracle_server.c
1 /*
2 * miracle_server.c -- DV Server
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 <valerie/valerie_remote.h>
45 #include <valerie/valerie_tokeniser.h>
46
47 #define VERSION "0.0.1"
48
49 static void miracle_command_received( mlt_listener listener, mlt_properties owner, miracle_server this, void **args )
50 {
51 if ( listener != NULL )
52 listener( owner, this, ( valerie_response ** )args[ 0 ], ( char * )args[ 1 ] );
53 }
54
55 static void miracle_doc_received( mlt_listener listener, mlt_properties owner, miracle_server this, void **args )
56 {
57 if ( listener != NULL )
58 listener( owner, this, ( valerie_response ** )args[ 0 ], ( char * )args[ 1 ], ( char * )args[ 2 ] );
59 }
60
61 static void miracle_push_received( mlt_listener listener, mlt_properties owner, miracle_server this, void **args )
62 {
63 if ( listener != NULL )
64 listener( owner, this, ( valerie_response ** )args[ 0 ], ( char * )args[ 1 ], ( mlt_service )args[ 2 ] );
65 }
66
67 /** Initialise a server structure.
68 */
69
70 miracle_server miracle_server_init( char *id )
71 {
72 miracle_server server = malloc( sizeof( miracle_server_t ) );
73 if ( server != NULL )
74 memset( server, 0, sizeof( miracle_server_t ) );
75 if ( server != NULL && mlt_properties_init( &server->parent, server ) == 0 )
76 {
77 server->id = id;
78 server->port = DEFAULT_TCP_PORT;
79 server->socket = -1;
80 server->shutdown = 1;
81 mlt_events_init( &server->parent );
82 mlt_events_register( &server->parent, "command-received", ( mlt_transmitter )miracle_command_received );
83 mlt_events_register( &server->parent, "doc-received", ( mlt_transmitter )miracle_doc_received );
84 mlt_events_register( &server->parent, "push-received", ( mlt_transmitter )miracle_push_received );
85 }
86 return server;
87 }
88
89 const char *miracle_server_id( miracle_server server )
90 {
91 return server != NULL && server->id != NULL ? server->id : "miracle";
92 }
93
94 void miracle_server_set_config( miracle_server server, char *config )
95 {
96 if ( server != NULL )
97 {
98 free( server->config );
99 server->config = config != NULL ? strdup( config ) : NULL;
100 }
101 }
102
103 /** Set the port of the server.
104 */
105
106 void miracle_server_set_port( miracle_server server, int port )
107 {
108 server->port = port;
109 }
110
111 void miracle_server_set_proxy( miracle_server server, char *proxy )
112 {
113 valerie_tokeniser tokeniser = valerie_tokeniser_init( );
114 server->proxy = 1;
115 server->remote_port = DEFAULT_TCP_PORT;
116 valerie_tokeniser_parse_new( tokeniser, proxy, ":" );
117 strcpy( server->remote_server, valerie_tokeniser_get_string( tokeniser, 0 ) );
118 if ( valerie_tokeniser_count( tokeniser ) == 2 )
119 server->remote_port = atoi( valerie_tokeniser_get_string( tokeniser, 1 ) );
120 valerie_tokeniser_close( tokeniser );
121 }
122
123 /** Wait for a connection.
124 */
125
126 static int miracle_server_wait_for_connect( miracle_server server )
127 {
128 struct timeval tv;
129 fd_set rfds;
130
131 /* Wait for a 1 second. */
132 tv.tv_sec = 1;
133 tv.tv_usec = 0;
134
135 FD_ZERO( &rfds );
136 FD_SET( server->socket, &rfds );
137
138 return select( server->socket + 1, &rfds, NULL, NULL, &tv);
139 }
140
141 /** Run the server thread.
142 */
143
144 static void *miracle_server_run( void *arg )
145 {
146 miracle_server server = arg;
147 pthread_t cmd_parse_info;
148 connection_t *tmp = NULL;
149 pthread_attr_t thread_attributes;
150 int socksize;
151
152 socksize = sizeof( struct sockaddr );
153
154 miracle_log( LOG_NOTICE, "%s version %s listening on port %i", server->id, VERSION, server->port );
155
156 /* Create the initial thread. We want all threads to be created detached so
157 their resources get freed automatically. (CY: ... hmmph...) */
158 pthread_attr_init( &thread_attributes );
159 pthread_attr_setdetachstate( &thread_attributes, PTHREAD_CREATE_DETACHED );
160 pthread_attr_init( &thread_attributes );
161 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
162 /* pthread_attr_setschedpolicy( &thread_attributes, SCHED_RR ); */
163
164 while ( !server->shutdown )
165 {
166 /* Wait for a new connection. */
167 if ( miracle_server_wait_for_connect( server ) )
168 {
169 /* Create a new block of data to hold a copy of the incoming connection for
170 our server thread. The thread should free this when it terminates. */
171
172 tmp = (connection_t*) malloc( sizeof(connection_t) );
173 tmp->owner = &server->parent;
174 tmp->parser = server->parser;
175 tmp->fd = accept( server->socket, (struct sockaddr*) &(tmp->sin), &socksize );
176
177 /* Pass the connection to a parser thread :-/ */
178 if ( tmp->fd != -1 )
179 pthread_create( &cmd_parse_info, &thread_attributes, parser_thread, tmp );
180 }
181 }
182
183 miracle_log( LOG_NOTICE, "%s version %s server terminated.", server->id, VERSION );
184
185 return NULL;
186 }
187
188 /** Execute the server thread.
189 */
190
191 int miracle_server_execute( miracle_server server )
192 {
193 int error = 0;
194 valerie_response response = NULL;
195 int index = 0;
196 struct sockaddr_in ServerAddr;
197 int flag = 1;
198
199 server->shutdown = 0;
200
201 ServerAddr.sin_family = AF_INET;
202 ServerAddr.sin_port = htons( server->port );
203 ServerAddr.sin_addr.s_addr = INADDR_ANY;
204
205 /* Create socket, and bind to port. Listen there. Backlog = 5
206 should be sufficient for listen (). */
207 server->socket = socket( AF_INET, SOCK_STREAM, 0 );
208
209 if ( server->socket == -1 )
210 {
211 server->shutdown = 1;
212 perror( "socket" );
213 miracle_log( LOG_ERR, "%s unable to create socket.", server->id );
214 return -1;
215 }
216
217 setsockopt( server->socket, SOL_SOCKET, SO_REUSEADDR, (char *)&flag, sizeof( int ) );
218
219 if ( bind( server->socket, (struct sockaddr *) &ServerAddr, sizeof (ServerAddr) ) != 0 )
220 {
221 server->shutdown = 1;
222 perror( "bind" );
223 miracle_log( LOG_ERR, "%s unable to bind to port %d.", server->id, server->port );
224 return -1;
225 }
226
227 if ( listen( server->socket, 5 ) != 0 )
228 {
229 server->shutdown = 1;
230 perror( "listen" );
231 miracle_log( LOG_ERR, "%s unable to listen on port %d.", server->id, server->port );
232 return -1;
233 }
234
235 fcntl( server->socket, F_SETFL, O_NONBLOCK );
236
237 if ( !server->proxy )
238 {
239 miracle_log( LOG_NOTICE, "Starting server on %d.", server->port );
240 server->parser = miracle_parser_init_local( );
241 }
242 else
243 {
244 miracle_log( LOG_NOTICE, "Starting proxy for %s:%d on %d.", server->remote_server, server->remote_port, server->port );
245 server->parser = valerie_parser_init_remote( server->remote_server, server->remote_port );
246 }
247
248 response = valerie_parser_connect( server->parser );
249
250 if ( response != NULL && valerie_response_get_error_code( response ) == 100 )
251 {
252 /* read configuration file */
253 if ( response != NULL && !server->proxy && server->config != NULL )
254 {
255 valerie_response_close( response );
256 response = valerie_parser_run( server->parser, server->config );
257
258 if ( valerie_response_count( response ) > 1 )
259 {
260 if ( valerie_response_get_error_code( response ) > 299 )
261 miracle_log( LOG_ERR, "Error evaluating server configuration. Processing stopped." );
262 for ( index = 0; index < valerie_response_count( response ); index ++ )
263 miracle_log( LOG_DEBUG, "%4d: %s", index, valerie_response_get_line( response, index ) );
264 }
265 }
266
267 if ( response != NULL )
268 {
269 pthread_attr_t attr;
270 int result;
271 pthread_attr_init( &attr );
272 pthread_attr_setdetachstate( &attr, PTHREAD_CREATE_JOINABLE );
273 pthread_attr_setinheritsched( &attr, PTHREAD_EXPLICIT_SCHED );
274 pthread_attr_setschedpolicy( &attr, SCHED_FIFO );
275 pthread_attr_setscope( &attr, PTHREAD_SCOPE_SYSTEM );
276 valerie_response_close( response );
277 result = pthread_create( &server->thread, &attr, miracle_server_run, server );
278 if ( result )
279 {
280 miracle_log( LOG_WARNING, "Failed to schedule realtime (%s)", strerror(errno) );
281 pthread_attr_setschedpolicy( &attr, SCHED_OTHER );
282 result = pthread_create( &server->thread, &attr, miracle_server_run, server );
283 if ( result )
284 {
285 miracle_log( LOG_CRIT, "Failed to launch TCP listener thread" );
286 error = -1;
287 }
288 }
289 }
290 }
291 else
292 {
293 miracle_log( LOG_ERR, "Error connecting to parser. Processing stopped." );
294 server->shutdown = 1;
295 error = -1;
296 }
297
298 return error;
299 }
300
301 /** Shutdown the server.
302 */
303
304 void miracle_server_shutdown( miracle_server server )
305 {
306 if ( server != NULL && !server->shutdown )
307 {
308 server->shutdown = 1;
309 pthread_join( server->thread, NULL );
310 miracle_server_set_config( server, NULL );
311 valerie_parser_close( server->parser );
312 server->parser = NULL;
313 close( server->socket );
314 }
315 }
316
317 /** Close the server.
318 */
319
320 void miracle_server_close( miracle_server server )
321 {
322 if ( server != NULL && mlt_properties_dec_ref( &server->parent ) <= 0 )
323 {
324 mlt_properties_close( &server->parent );
325 miracle_server_shutdown( server );
326 free( server );
327 }
328 }