]> arthur.barton.de Git - netatalk.git/blobdiff - etc/afpd/fce_api.c
Add a configurable hold time option to FCE file modification event generation, defaul...
[netatalk.git] / etc / afpd / fce_api.c
old mode 100755 (executable)
new mode 100644 (file)
index 0240b54..00a0424
 #include <atalk/cnid.h>\r
 #include <atalk/unix.h>\r
 #include <atalk/fce_api.h>\r
+#include <atalk/globals.h>\r
 \r
 #include "fork.h"\r
 #include "file.h"\r
-#include "globals.h"\r
 #include "directory.h"\r
 #include "desktop.h"\r
 #include "volume.h"\r
 static struct udp_entry udp_socket_list[FCE_MAX_UDP_SOCKS];\r
 static int udp_sockets = 0;\r
 static int udp_initialized = FCE_FALSE;\r
-static unsigned long fce_ev_enabled = 0;\r
-static size_t tm_used;          /* used for passing to event handler */\r
+static unsigned long fce_ev_enabled =\r
+    (1 << FCE_FILE_MODIFY) |\r
+    (1 << FCE_FILE_DELETE) |\r
+    (1 << FCE_DIR_DELETE) |\r
+    (1 << FCE_FILE_CREATE) |\r
+    (1 << FCE_DIR_CREATE);\r
+\r
+static uint64_t tm_used;          /* used for passing to event handler */\r
+#define MAXIOBUF 1024\r
+static char iobuf[MAXIOBUF];\r
 static const char *skip_files[] = \r
 {\r
        ".DS_Store",\r
        NULL\r
 };\r
+static struct fce_close_event last_close_event;\r
 \r
 /*\r
  *\r
@@ -118,7 +127,9 @@ void fce_init_udp()
             LOG(log_error, logtype_afpd, "fce_init_udp: no socket for %s:%s",\r
                 udp_entry->addr, udp_entry->port);\r
         }\r
+        udp_entry->addrinfo = *p;\r
         memcpy(&udp_entry->addrinfo, p, sizeof(struct addrinfo));\r
+        memcpy(&udp_entry->sockaddr, p->ai_addr, sizeof(struct sockaddr_storage));\r
         freeaddrinfo(servinfo);\r
     }\r
 \r
@@ -148,31 +159,70 @@ void fce_cleanup()
 /*\r
  * Construct a UDP packet for our listeners and return packet size\r
  * */\r
-static unsigned short build_fce_packet( struct fce_packet *packet, char *path, int mode, uint32_t event_id )\r
+static ssize_t build_fce_packet( struct fce_packet *packet, char *path, int mode, uint32_t event_id )\r
 {\r
-    unsigned short data_len = 0;\r
+    size_t pathlen;\r
+    ssize_t data_len = 0;\r
 \r
     strncpy(packet->magic, FCE_PACKET_MAGIC, sizeof(packet->magic) );\r
     packet->version = FCE_PACKET_VERSION;\r
     packet->mode = mode;\r
+    packet->event_id = event_id;\r
 \r
-    data_len = strlen( path );\r
+    pathlen = strlen(path) + 1; /* include string terminator */\r
 \r
     /* This should never happen, but before we bust this server, we send nonsense, fce listener has to cope */\r
-    if (data_len >= FCE_MAX_PATH_LEN)\r
-    {\r
-        data_len = FCE_MAX_PATH_LEN - 1;\r
-    }\r
+    if (pathlen >= MAXPATHLEN)\r
+        pathlen = MAXPATHLEN - 1;\r
 \r
     /* This is the payload len. Means: the stream has len bytes more until packet is finished */\r
     /* A server should read the first 16 byte, decode them and then fetch the rest */\r
-    packet->len = htons( data_len);\r
-    packet->event_id = htonl( event_id );\r
-\r
-    strncpy( packet->data, path, data_len );\r
+    data_len = FCE_PACKET_HEADER_SIZE + pathlen;\r
+    packet->datalen = pathlen;\r
+\r
+    switch (mode) {\r
+    case FCE_TM_SIZE:\r
+        tm_used = hton64(tm_used);\r
+        memcpy(packet->data, &tm_used, sizeof(tm_used));\r
+        strncpy(packet->data + sizeof(tm_used), path, pathlen);\r
+\r
+        packet->datalen += sizeof(tm_used);\r
+        data_len += sizeof(tm_used);\r
+        break;\r
+    default:\r
+        strncpy(packet->data, path, pathlen);\r
+        break;\r
+    }\r
 \r
     /* return the packet len */\r
-    return sizeof(struct fce_packet) - FCE_MAX_PATH_LEN + data_len;\r
+    return data_len;\r
+}\r
+\r
+static int pack_fce_packet(struct fce_packet *packet, unsigned char *buf)\r
+{\r
+    unsigned char *p = buf;\r
+\r
+    memcpy(p, &packet->magic[0], sizeof(packet->magic));\r
+    p += sizeof(packet->magic);\r
+\r
+    *p = packet->version;\r
+    p++;\r
+    \r
+    *p = packet->mode;\r
+    p++;\r
+    \r
+    uint32_t id = htonl(packet->event_id);\r
+    memcpy(p, &id, sizeof(id));\r
+    p += sizeof(packet->event_id);\r
+\r
+    uint16_t l = htons(packet->datalen);\r
+    memcpy(p, &l, sizeof(l));\r
+    p += sizeof(l);\r
+\r
+    memcpy(p, &packet->data[0], packet->datalen);\r
+    p += packet->datalen;\r
+\r
+    return 0;\r
 }\r
 \r
 /*\r
@@ -181,15 +231,26 @@ static unsigned short build_fce_packet( struct fce_packet *packet, char *path, i
  * */\r
 static void send_fce_event( char *path, int mode )\r
 {    \r
+    static int first_event = FCE_TRUE;\r
+\r
     struct fce_packet packet;\r
     void *data = &packet;\r
     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
-\r
     time_t now = time(NULL);\r
 \r
-    /* build our data packet */\r
-    int data_len = build_fce_packet( &packet, path, mode, ++event_id );\r
+    LOG(log_debug, logtype_afpd, "send_fce_event: start");\r
 \r
+    /* initialized ? */\r
+    if (first_event == FCE_TRUE) {\r
+        first_event = FCE_FALSE;\r
+        fce_init_udp();\r
+        /* Notify listeners the we start from the beginning */\r
+        send_fce_event( "", FCE_CONN_START );\r
+    }\r
+\r
+    /* build our data packet */\r
+    ssize_t data_len = build_fce_packet( &packet, path, mode, ++event_id );\r
+    pack_fce_packet(&packet, iobuf);\r
 \r
     for (int i = 0; i < udp_sockets; i++)\r
     {\r
@@ -204,10 +265,11 @@ static void send_fce_event( char *path, int mode )
                 continue;\r
 \r
             /* Reopen socket */\r
-            udp_entry->sock = socket( AF_INET, SOCK_DGRAM, 0 );\r
-\r
-            if (udp_entry->sock == -1)\r
-            {\r
+            udp_entry->sock = socket(udp_entry->addrinfo.ai_family,\r
+                                     udp_entry->addrinfo.ai_socktype,\r
+                                     udp_entry->addrinfo.ai_protocol);\r
+            \r
+            if (udp_entry->sock == -1) {\r
                 /* failed again, so go to rest again */\r
                 LOG(log_error, logtype_afpd, "Cannot recreate socket for fce UDP connection: errno %d", errno  );\r
 \r
@@ -219,31 +281,32 @@ static void send_fce_event( char *path, int mode )
 \r
             /* Okay, we have a running socket again, send server that we had a problem on our side*/\r
             data_len = build_fce_packet( &packet, "", FCE_CONN_BROKEN, 0 );\r
+            pack_fce_packet(&packet, iobuf);\r
 \r
             sendto(udp_entry->sock,\r
-                   data,\r
+                   iobuf,\r
                    data_len,\r
                    0,\r
-                   udp_entry->addrinfo.ai_addr,\r
+                   (struct sockaddr *)&udp_entry->sockaddr,\r
                    udp_entry->addrinfo.ai_addrlen);\r
 \r
             /* Rebuild our original data packet */\r
             data_len = build_fce_packet( &packet, path, mode, event_id );\r
+            pack_fce_packet(&packet, iobuf);\r
         }\r
 \r
         sent_data = sendto(udp_entry->sock,\r
-                           data,\r
+                           iobuf,\r
                            data_len,\r
                            0,\r
-                           udp_entry->addrinfo.ai_addr,\r
+                           (struct sockaddr *)&udp_entry->sockaddr,\r
                            udp_entry->addrinfo.ai_addrlen);\r
 \r
         /* Problems ? */\r
-        if (sent_data != data_len)\r
-        {\r
+        if (sent_data != data_len) {\r
             /* Argh, socket broke, we close and retry later */\r
-            LOG(log_error, logtype_afpd, "Error while sending packet to %s for fce UDP connection: transfered: %d of %d errno %d",\r
-                    udp_entry->port, sent_data, data_len, errno  );\r
+            LOG(log_error, logtype_afpd, "send_fce_event: error sending packet to %s:%s, transfered %d of %d: %s",\r
+                udp_entry->addr, udp_entry->port, sent_data, data_len, strerror(errno));\r
 \r
             close( udp_entry->sock );\r
             udp_entry->sock = -1;\r
@@ -265,7 +328,8 @@ static int add_udp_socket(const char *target_ip, const char *target_port )
     udp_socket_list[udp_sockets].addr = strdup(target_ip);\r
     udp_socket_list[udp_sockets].port = strdup(target_port);\r
     udp_socket_list[udp_sockets].sock = -1;\r
-    memset( &udp_socket_list[udp_sockets].addrinfo, 0, sizeof(struct sockaddr_in) );\r
+    memset(&udp_socket_list[udp_sockets].addrinfo, 0, sizeof(struct addrinfo));\r
+    memset(&udp_socket_list[udp_sockets].sockaddr, 0, sizeof(struct sockaddr_storage));\r
     udp_socket_list[udp_sockets].next_try_on_error = 0;\r
 \r
     udp_sockets++;\r
@@ -273,6 +337,23 @@ static int add_udp_socket(const char *target_ip, const char *target_port )
     return AFP_OK;\r
 }\r
 \r
+static void save_close_event(const char *path)\r
+{\r
+    time_t now = time(NULL);\r
+\r
+    /* Check if it's a close for the same event as the last one */\r
+    if (last_close_event.time   /* is there any saved event ? */\r
+        && (strcmp(path, last_close_event.path) != 0)) {\r
+        /* no, so send the saved event out now */\r
+        send_fce_event(last_close_event.path, FCE_FILE_MODIFY);\r
+    }\r
+\r
+    LOG(log_debug, logtype_afpd, "save_close_event: %s", path);\r
+\r
+    last_close_event.time = now;\r
+    strncpy(last_close_event.path, path, MAXPATHLEN);\r
+}\r
+\r
 /*\r
  *\r
  * Dispatcher for all incoming file change events\r
@@ -280,6 +361,8 @@ static int add_udp_socket(const char *target_ip, const char *target_port )
  * */\r
 static int register_fce(const char *u_name, int is_dir, int mode)\r
 {\r
+    static int first_event = FCE_TRUE;\r
+\r
     if (udp_sockets == 0)\r
         /* No listeners configured */\r
         return AFP_OK;\r
@@ -287,21 +370,12 @@ static int register_fce(const char *u_name, int is_dir, int mode)
     if (u_name == NULL)\r
         return AFPERR_PARAM;\r
 \r
-    static int first_event = FCE_TRUE;\r
-\r
        /* do some initialization on the fly the first time */\r
-       if (first_event)\r
-       {\r
+       if (first_event) {\r
                fce_initialize_history();\r
-        fce_ev_enabled =\r
-            (1 << FCE_FILE_MODIFY) |\r
-            (1 << FCE_FILE_DELETE) |\r
-            (1 << FCE_DIR_DELETE) |\r
-            (1 << FCE_FILE_CREATE) |\r
-            (1 << FCE_DIR_CREATE);\r
+        first_event = FCE_FALSE;\r
        }\r
 \r
-\r
        /* handle files which should not cause events (.DS_Store atc. ) */\r
        for (int i = 0; skip_files[i] != NULL; i++)\r
        {\r
@@ -310,19 +384,19 @@ static int register_fce(const char *u_name, int is_dir, int mode)
        }\r
 \r
 \r
-       char full_path_buffer[FCE_MAX_PATH_LEN + 1] = {""};\r
+       char full_path_buffer[MAXPATHLEN + 1] = {""};\r
        const char *cwd = getcwdpath();\r
 \r
-    if (mode & FCE_TM_SIZE) {\r
-        strncpy(full_path_buffer, u_name, FCE_MAX_PATH_LEN);\r
+    if (mode == FCE_TM_SIZE) {\r
+        strlcpy(full_path_buffer, u_name, MAXPATHLEN);\r
     } else if (!is_dir || mode == FCE_DIR_DELETE) {\r
-               if (strlen( cwd ) + strlen( u_name) + 1 >= FCE_MAX_PATH_LEN) {\r
+               if (strlen( cwd ) + strlen( u_name) + 1 >= MAXPATHLEN) {\r
                        LOG(log_error, logtype_afpd, "FCE file name too long: %s/%s", cwd, u_name );\r
                        return AFPERR_PARAM;\r
                }\r
                sprintf( full_path_buffer, "%s/%s", cwd, u_name );\r
        } else {\r
-               if (strlen( cwd ) >= FCE_MAX_PATH_LEN) {\r
+               if (strlen( cwd ) >= MAXPATHLEN) {\r
                        LOG(log_error, logtype_afpd, "FCE directory name too long: %s", cwd);\r
                        return AFPERR_PARAM;\r
                }\r
@@ -338,26 +412,29 @@ static int register_fce(const char *u_name, int is_dir, int mode)
 \r
        LOG(log_debug9, logtype_afpd, "Detected fc event <%d> for <%s>", mode, full_path_buffer );\r
 \r
-\r
-    /* we do initilization on the fly, no blocking calls in here \r
-     * (except when using FQDN in broken DNS environment)\r
-     */\r
-    if (first_event == FCE_TRUE)\r
-    {\r
-        fce_init_udp();\r
-        \r
-        /* Notify listeners the we start from the beginning */\r
-        send_fce_event( "", FCE_CONN_START );\r
-        \r
-        first_event = FCE_FALSE;\r
+    if (mode & FCE_FILE_MODIFY) {\r
+        save_close_event(full_path_buffer);\r
+        return AFP_OK;\r
     }\r
 \r
-       /* Handle UDP transport */\r
     send_fce_event( full_path_buffer, mode );\r
 \r
     return AFP_OK;\r
 }\r
 \r
+static void check_saved_close_events(int fmodwait)\r
+{\r
+    time_t now = time(NULL);\r
+\r
+    /* check if configured holdclose time has passed */\r
+    if (last_close_event.time && ((last_close_event.time + fmodwait) < now)) {\r
+        LOG(log_debug, logtype_afpd, "check_saved_close_events: sending event: %s", last_close_event.path);\r
+        /* yes, send event */\r
+        send_fce_event(&last_close_event.path[0], FCE_FILE_MODIFY);\r
+        last_close_event.path[0] = 0;\r
+        last_close_event.time = 0;\r
+    }\r
+}\r
 \r
 /******************** External calls start here **************************/\r
 \r
@@ -366,6 +443,12 @@ static int register_fce(const char *u_name, int is_dir, int mode)
  * */\r
 #ifndef FCE_TEST_MAIN\r
 \r
+void fce_pending_events(AFPObj *obj)\r
+{\r
+    vol_fce_tm_event();\r
+    check_saved_close_events(obj->options.fce_fmodwait);\r
+}\r
+\r
 int fce_register_delete_file( struct path *path )\r
 {\r
     int ret = AFP_OK;\r
@@ -496,21 +579,22 @@ int fce_set_events(const char *events)
         return AFPERR_PARAM;\r
 \r
     e = strdup(events);\r
+\r
     fce_ev_enabled = 0;\r
 \r
     for (p = strtok(e, ","); p; p = strtok(NULL, ",")) {\r
-        if (strcmp(e, "fmod") == 0) {\r
-            fce_ev_enabled |= FCE_FILE_MODIFY;\r
-        } else if (strcmp(e, "fdel") == 0) {\r
-            fce_ev_enabled |= FCE_FILE_DELETE;\r
-        } else if (strcmp(e, "ddel") == 0) {\r
-            fce_ev_enabled |= FCE_DIR_DELETE;\r
-        } else if (strcmp(e, "fcre") == 0) {\r
-            fce_ev_enabled |= FCE_FILE_CREATE;\r
-        } else if (strcmp(e, "dcre") == 0) {\r
-            fce_ev_enabled |= FCE_DIR_CREATE;\r
-        } else if (strcmp(e, "tmsz") == 0) {\r
-            fce_ev_enabled |= FCE_TM_SIZE;\r
+        if (strcmp(p, "fmod") == 0) {\r
+            fce_ev_enabled |= (1 << FCE_FILE_MODIFY);\r
+        } else if (strcmp(p, "fdel") == 0) {\r
+            fce_ev_enabled |= (1 << FCE_FILE_DELETE);\r
+        } else if (strcmp(p, "ddel") == 0) {\r
+            fce_ev_enabled |= (1 << FCE_DIR_DELETE);\r
+        } else if (strcmp(p, "fcre") == 0) {\r
+            fce_ev_enabled |= (1 << FCE_FILE_CREATE);\r
+        } else if (strcmp(p, "dcre") == 0) {\r
+            fce_ev_enabled |= (1 << FCE_DIR_CREATE);\r
+        } else if (strcmp(p, "tmsz") == 0) {\r
+            fce_ev_enabled |= (1 << FCE_TM_SIZE);\r
         }\r
     }\r
 \r