2 * $Id: fce_api.c,v 0.01 2010-10-01 00:00:0 mw Exp $
\r
4 * Copyright (c) 2010 Mark Williams
\r
6 * File change event API for netatalk
\r
8 * for every detected filesystem change a UDP packet is sent to an arbitrary list
\r
9 * of listeners. Each packet contains unix path of modified filesystem element,
\r
10 * event reason, and a consecutive event id (32 bit). Technically we are UDP client and are sending
\r
11 * out packets synchronuosly as they are created by the afp functions. This should not affect
\r
12 * performance measurably. The only delaying calls occur during initialization, if we have to
\r
13 * resolve non-IP hostnames to IP. All numeric data inside the packet is network byte order, so use
\r
14 * ntohs / ntohl to resolve length and event id. Ideally a listener receives every packet with
\r
15 * no gaps in event ids, starting with event id 1 and mode FCE_CONN_START followed by
\r
16 * data events from id 2 up to 0xFFFFFFFF, followed by 0 to 0xFFFFFFFF and so on.
\r
18 * A gap or not starting with 1 mode FCE_CONN_START or receiving mode FCE_CONN_BROKEN means that
\r
19 * the listener has lost at least one filesystem event
\r
21 * All Rights Reserved. See COPYRIGHT.
\r
24 #ifdef HAVE_CONFIG_H
\r
26 #endif /* HAVE_CONFIG_H */
\r
36 #include <sys/param.h>
\r
37 #include <sys/socket.h>
\r
38 #include <netinet/in.h>
\r
39 #include <arpa/inet.h>
\r
42 #include <netatalk/at.h>
\r
44 #include <atalk/adouble.h>
\r
45 #include <atalk/vfs.h>
\r
46 #include <atalk/logger.h>
\r
47 #include <atalk/afp.h>
\r
48 #include <atalk/util.h>
\r
49 #include <atalk/cnid.h>
\r
50 #include <atalk/unix.h>
\r
54 #include "globals.h"
\r
55 #include "directory.h"
\r
56 #include "desktop.h"
\r
59 #include "fce_api.h"
\r
61 // ONLY USED IN THIS FILE
\r
62 #include "fce_api_internal.h"
\r
67 /* We store our connection data here */
\r
68 static struct udp_entry udp_socket_list[FCE_MAX_UDP_SOCKS];
\r
69 static int udp_sockets = 0;
\r
70 static int udp_initialized = FCE_FALSE;
\r
73 static const char *skip_files[] =
\r
81 * Initialize network structs for any listeners
\r
82 * We dont give return code because all errors are handled internally (I hope..)
\r
87 if (udp_initialized == FCE_TRUE)
\r
91 for (int i = 0; i < udp_sockets; i++)
\r
93 struct udp_entry *udp_entry = udp_socket_list + i;
\r
95 /* Close any pending sockets */
\r
96 if (udp_entry->sock != -1)
\r
98 close( udp_entry->sock );
\r
101 /* resolve IP to network address */
\r
102 if (inet_aton( udp_entry->ip, &udp_entry->addr.sin_addr ) ==0 )
\r
104 /* Hmm, failed try to resolve host */
\r
105 struct hostent *hp = gethostbyname( udp_entry->ip );
\r
108 LOG(log_error, logtype_afpd, "Cannot resolve host name for fce UDP connection: %s (errno %d)", udp_entry->ip, errno );
\r
111 memcpy( &udp_entry->addr.sin_addr, &hp->h_addr, sizeof(udp_entry->addr.sin_addr) );
\r
114 /* Create UDP socket */
\r
115 udp_entry->sock = socket( AF_INET, SOCK_DGRAM, 0 );
\r
116 if (udp_entry->sock == -1)
\r
118 LOG(log_error, logtype_afpd, "Cannot create socket for fce UDP connection: errno %d", errno );
\r
122 /* Set socket address params */
\r
123 udp_entry->addr.sin_family = AF_INET;
\r
124 udp_entry->addr.sin_port = htons(udp_entry->port);
\r
126 udp_initialized = FCE_TRUE;
\r
131 if (udp_initialized == FCE_FALSE )
\r
134 for (int i = 0; i < udp_sockets; i++)
\r
136 struct udp_entry *udp_entry = udp_socket_list + i;
\r
138 /* Close any pending sockets */
\r
139 if (udp_entry->sock != -1)
\r
141 close( udp_entry->sock );
\r
142 udp_entry->sock = -1;
\r
145 udp_initialized = FCE_FALSE;
\r
150 * Construct a UDP packet for our listeners and return packet size
\r
152 static unsigned short build_fce_packet( struct fce_packet *packet, char *path, int mode, uint32_t event_id )
\r
154 unsigned short data_len = 0;
\r
156 strncpy(packet->magic, FCE_PACKET_MAGIC, sizeof(packet->magic) );
\r
157 packet->version = FCE_PACKET_VERSION;
\r
158 packet->mode = mode;
\r
160 data_len = strlen( path );
\r
162 /* This should never happen, but before we bust this server, we send nonsense, fce listener has to cope */
\r
163 if (data_len >= FCE_MAX_PATH_LEN)
\r
165 data_len = FCE_MAX_PATH_LEN - 1;
\r
168 /* This is the payload len. Means: the stream has len bytes more until packet is finished */
\r
169 /* A server should read the first 16 byte, decode them and then fetch the rest */
\r
170 packet->len = htons( data_len);
\r
171 packet->event_id = htonl( event_id );
\r
173 strncpy( packet->data, path, data_len );
\r
175 /* return the packet len */
\r
176 return sizeof(struct fce_packet) - FCE_MAX_PATH_LEN + data_len;
\r
180 * Send the fce information to all (connected) listeners
\r
181 * We dont give return code because all errors are handled internally (I hope..)
\r
183 static void send_fce_event( char *path, int mode )
\r
185 struct fce_packet packet;
\r
186 void *data = &packet;
\r
187 static uint32_t event_id = 0; /* the unique packet couter to detect packet/data loss. Going from 0xFFFFFFFF to 0x0 is a valid increment */
\r
189 time_t now = time(NULL);
\r
191 /* build our data packet */
\r
192 int data_len = build_fce_packet( &packet, path, mode, ++event_id );
\r
195 for (int i = 0; i < udp_sockets; i++)
\r
198 struct udp_entry *udp_entry = udp_socket_list + i;
\r
200 /* we had a problem earlier ? */
\r
201 if (udp_entry->sock == -1)
\r
203 /* We still have to wait ?*/
\r
204 if (now < udp_entry->next_try_on_error)
\r
207 /* Reopen socket */
\r
208 udp_entry->sock = socket( AF_INET, SOCK_DGRAM, 0 );
\r
210 if (udp_entry->sock == -1)
\r
212 /* failed again, so go to rest again */
\r
213 LOG(log_error, logtype_afpd, "Cannot recreate socket for fce UDP connection: errno %d", errno );
\r
215 udp_entry->next_try_on_error = now + FCE_SOCKET_RETRY_DELAY_S;
\r
219 udp_entry->next_try_on_error = 0;
\r
221 /* Okay, we have a running socket again, send server that we had a problem on our side*/
\r
222 data_len = build_fce_packet( &packet, "", FCE_CONN_BROKEN, 0 );
\r
224 sendto( udp_entry->sock, data, data_len, 0, &udp_entry->addr, sizeof(udp_entry->addr) );
\r
226 /* Rebuild our original data packet */
\r
227 data_len = build_fce_packet( &packet, path, mode, event_id );
\r
230 sent_data = sendto( udp_entry->sock, data, data_len, 0, &udp_entry->addr, sizeof(udp_entry->addr) );
\r
233 if (sent_data != data_len)
\r
235 /* Argh, socket broke, we close and retry later */
\r
236 LOG(log_error, logtype_afpd, "Error while sending packet to %s for fce UDP connection: transfered: %d of %d errno %d",
\r
237 udp_entry->port, sent_data, data_len, errno );
\r
239 close( udp_entry->sock );
\r
240 udp_entry->sock = -1;
\r
241 udp_entry->next_try_on_error = now + FCE_SOCKET_RETRY_DELAY_S;
\r
246 static int add_udp_socket( char *target_ip, int target_port )
\r
248 if (target_port == 0)
\r
249 target_port = FCE_DEFAULT_PORT;
\r
251 if (udp_sockets >= FCE_MAX_UDP_SOCKS)
\r
253 LOG(log_error, logtype_afpd, "Too many file change api UDP connections (max %d allowed)", FCE_MAX_UDP_SOCKS );
\r
254 return AFPERR_PARAM;
\r
257 strncpy( udp_socket_list[udp_sockets].ip, target_ip, FCE_MAX_IP_LEN - 1);
\r
258 udp_socket_list[udp_sockets].port = target_port;
\r
259 udp_socket_list[udp_sockets].sock = -1;
\r
260 memset( &udp_socket_list[udp_sockets].addr, 0, sizeof(struct sockaddr_in) );
\r
261 udp_socket_list[udp_sockets].next_try_on_error = 0;
\r
270 * Dispatcher for all incoming file change events
\r
273 static int register_fce( char *u_name, int is_dir, int mode )
\r
275 if (u_name == NULL)
\r
276 return AFPERR_PARAM;
\r
278 static int first_event = FCE_TRUE;
\r
280 /* do some initialization on the fly the first time */
\r
283 fce_initialize_history();
\r
287 /* handle files which should not cause events (.DS_Store atc. ) */
\r
288 for (int i = 0; skip_files[i] != NULL; i++)
\r
290 if (!strcmp( u_name, skip_files[i]))
\r
295 char full_path_buffer[FCE_MAX_PATH_LEN + 1] = {""};
\r
296 const char *cwd = getcwdpath();
\r
298 if (!is_dir || mode == FCE_DIR_DELETE)
\r
300 if (strlen( cwd ) + strlen( u_name) + 1 >= FCE_MAX_PATH_LEN)
\r
302 LOG(log_error, logtype_afpd, "FCE file name too long: %s/%s", cwd, u_name );
\r
303 return AFPERR_PARAM;
\r
305 sprintf( full_path_buffer, "%s/%s", cwd, u_name );
\r
309 if (strlen( cwd ) >= FCE_MAX_PATH_LEN)
\r
311 LOG(log_error, logtype_afpd, "FCE directory name too long: %s", cwd);
\r
312 return AFPERR_PARAM;
\r
314 strcpy( full_path_buffer, cwd);
\r
317 /* Can we ignore this event based on type or history? */
\r
318 if (fce_handle_coalescation( full_path_buffer, is_dir, mode ))
\r
320 LOG(log_debug9, logtype_afpd, "Coalesced fc event <%d> for <%s>", mode, full_path_buffer );
\r
324 LOG(log_debug9, logtype_afpd, "Detected fc event <%d> for <%s>", mode, full_path_buffer );
\r
327 /* we do initilization on the fly, no blocking calls in here
\r
328 * (except when using FQDN in broken DNS environment)
\r
330 if (first_event == FCE_TRUE)
\r
334 /* Notify listeners the we start from the beginning */
\r
335 send_fce_event( "", FCE_CONN_START );
\r
337 first_event = FCE_FALSE;
\r
340 /* Handle UDP transport */
\r
341 send_fce_event( full_path_buffer, mode );
\r
347 /******************** External calls start here **************************/
\r
350 * API-Calls for file change api, called form outside (file.c directory.c ofork.c filedir.c)
\r
352 #ifndef FCE_TEST_MAIN
\r
355 int fce_register_delete_file( struct path *path )
\r
360 return AFPERR_PARAM;
\r
363 ret = register_fce( path->u_name, FALSE, FCE_FILE_DELETE );
\r
367 int fce_register_delete_dir( char *name )
\r
372 return AFPERR_PARAM;
\r
375 ret = register_fce( name, TRUE, FCE_DIR_DELETE);
\r
380 int fce_register_new_dir( struct path *path )
\r
385 return AFPERR_PARAM;
\r
387 ret = register_fce( path->u_name, TRUE, FCE_DIR_CREATE );
\r
393 int fce_register_new_file( struct path *path )
\r
398 return AFPERR_PARAM;
\r
400 ret = register_fce( path->u_name, FALSE, FCE_FILE_CREATE );
\r
406 int fce_register_file_modification( struct ofork *ofork )
\r
408 char *u_name = NULL;
\r
413 if (ofork == NULL || ofork->of_vol == NULL || ofork->of_dir == NULL)
\r
414 return AFPERR_PARAM;
\r
416 vol = ofork->of_vol;
\r
417 dir = ofork->of_dir;
\r
419 if (NULL == (u_name = mtoupath(vol, of_name(ofork), dir->d_did, utf8_encoding())))
\r
421 return AFPERR_MISC;
\r
424 ret = register_fce( u_name, FALSE, FCE_FILE_MODIFY );
\r
432 * Extern connect to afpd parameter, can be called multiple times for multiple listeners (up to MAX_UDP_SOCKS times)
\r
435 int fce_add_udp_socket( char *target )
\r
437 int port = FCE_DEFAULT_PORT;
\r
438 char target_ip[256] = {""};
\r
440 strncpy( target_ip, target, sizeof(target_ip) -1);
\r
441 char *port_delim = strchr( target_ip, ':' );
\r
445 port = atoi( port_delim + 1);
\r
447 return add_udp_socket( target_ip, port );
\r
452 #ifdef FCE_TEST_MAIN
\r
455 void shortsleep( unsigned int us )
\r
459 int main( int argc, char*argv[] )
\r
463 int delay_between_events = 1000;
\r
464 int event_code = FCE_FILE_MODIFY;
\r
465 char pathbuff[1024];
\r
466 int duration_in_seconds = 0; // TILL ETERNITY
\r
468 char *path = getcwd( pathbuff, sizeof(pathbuff) );
\r
470 // FULLSPEED TEST IS "-s 1001" -> delay is 0 -> send packets without pause
\r
474 fprintf( stdout, "%s: -p Port -h Listener1 [ -h Listener2 ...] -P path -s Delay_between_events_in_us -e event_code -d Duration \n", argv[0]);
\r
479 for (int i = 1; i < argc; i++)
\r
482 if (*p == '-' && p[1])
\r
484 char *arg = argv[i + 1];
\r
487 case 'p': if (arg) port = atoi( arg ), i++; break;
\r
488 case 'P': if (arg) path = arg, i++; break;
\r
489 case 's': if (arg) delay_between_events = atoi( arg ), i++; break;
\r
490 case 'e': if (arg) event_code = atoi( arg ), i++; break;
\r
491 case 'd': if (arg) duration_in_seconds = atoi( arg ), i++; break;
\r
498 sprintf( target, "%s:%d", host, port );
\r
499 ret += fce_add_udp_socket( target );
\r
512 sprintf( target, "127.0.0.1:%d", port );
\r
513 ret += fce_add_udp_socket( target );
\r
521 time_t start_time = time(NULL);
\r
522 time_t end_time = 0;
\r
524 if (duration_in_seconds)
\r
525 end_time = start_time + duration_in_seconds;
\r
529 time_t now = time(NULL);
\r
530 if (now > start_time)
\r
533 fprintf( stdout, "%d events/s\n", ev_cnt );
\r
536 if (end_time && now >= end_time)
\r
539 register_fce( path, event_code );
\r
543 shortsleep( delay_between_events );
\r
546 #endif /* TESTMAIN*/
\r