Append ls -v output to status items.
[paraslash.git] / aft.c
diff --git a/aft.c b/aft.c
index 3666a2eb90de28431dd25b5adbac41503bf80d92..e45938d3942619989cc6eecbc9f29e986d3f5f30 100644 (file)
--- a/aft.c
+++ b/aft.c
@@ -6,6 +6,7 @@
 
 /** \file aft.c Audio file table functions. */
 
+#include <dirent.h> /* readdir() */
 #include "para.h"
 #include "error.h"
 #include "string.h"
@@ -15,6 +16,8 @@
 #include "afs.h"
 #include "net.h"
 #include "vss.h"
+#include "fd.h"
+#include "ipc.h"
 
 static struct osl_table *audio_file_table;
 
@@ -93,30 +96,27 @@ struct ls_widths {
        unsigned short num_played_width;
 };
 
-/** Data passed to the different compare functions (called by qsort()). */
-struct ls_data {
-       /** Usual audio format handler information. */
-       struct audio_format_info afhi;
-       /** Audio file selector information. */
-       struct afs_info afsi;
-       /** The full path of the audio file. */
-       char *path;
-       /** The score value (if -a was given). */
-       long score;
-       /** The sha1 hash of audio file. */
-       HASH_TYPE *hash;
-};
-
+/** Data passed from the ls command handler to its callback function. */
 struct ls_options {
+       /** The given command line flags. */
        unsigned flags;
+       /** The sorting method given at the command line. */
        enum ls_sorting_method sorting;
+       /** The given listing mode (short, long, verbose, mbox). */
        enum ls_listing_mode mode;
+       /** The arguments passed to the ls command. */
        char **patterns;
+       /** Number of non-option arguments. */
        int num_patterns;
+       /** Used for long listing mode to align the output fields. */
        struct ls_widths widths;
+       /** Size of the \a data array. */
        uint32_t array_size;
+       /** Number of used entries in the data array. */
        uint32_t num_matching_paths;
+       /** Array of matching entries. */
        struct ls_data *data;
+       /** Used to sort the array. */
        struct ls_data **data_ptr;
 };
 
@@ -138,8 +138,10 @@ enum afsi_offsets {
        AFSI_LYRICS_ID_OFFSET = 24,
        /** Storage position of the .audio_format_id field. */
        AFSI_AUDIO_FORMAT_ID_OFFSET = 28,
+       /** 3 bytes reserved space for future usage. */
+       AFSI_AUDIO_FORMAT_UNUSED_OFFSET = 29,
        /** On-disk storage space needed. */
-       AFSI_SIZE = 29
+       AFSI_SIZE = 32
 };
 
 /**
@@ -161,6 +163,7 @@ void save_afsi(struct afs_info *afsi, struct osl_object *obj)
        write_u32(buf + AFSI_LYRICS_ID_OFFSET, afsi->lyrics_id);
        write_u8(buf + AFSI_AUDIO_FORMAT_ID_OFFSET,
                afsi->audio_format_id);
+       memset(buf + AFSI_AUDIO_FORMAT_UNUSED_OFFSET, 0, 3);
 }
 
 /**
@@ -306,22 +309,28 @@ enum afhi_offsets {
        AFHI_BITRATE_OFFSET = 4,
        /** Position of the frequency. */
        AFHI_FREQUENCY_OFFSET = 8,
+       /** Location of the audio file header. */
+       AFHI_HEADER_OFFSET_OFFSET = 12,
+       /* Length of the audio file header. Zero means: No header. */
+       AFHI_HEADER_LEN_OFFSET = 16,
        /** Number of channels is stored here. */
-       AFHI_CHANNELS_OFFSET = 12,
+       AFHI_CHANNELS_OFFSET = 20,
+       /** EOF timeout in ms. */
+       AFHI_EOF_OFFSET = 21,
        /** The tag info position. */
-       AFHI_INFO_STRING_OFFSET = 13,
+       AFHI_INFO_STRING_OFFSET = 23,
        /** Minimal on-disk size of a valid afhi struct. */
-       MIN_AFHI_SIZE = 14
+       MIN_AFHI_SIZE = 24
 };
 
-static unsigned sizeof_afhi_buf(const struct audio_format_info *afhi)
+static unsigned sizeof_afhi_buf(const struct afh_info *afhi)
 {
        if (!afhi)
                return 0;
        return strlen(afhi->info_string) + MIN_AFHI_SIZE;
 }
 
-static void save_afhi(struct audio_format_info *afhi, char *buf)
+static void save_afhi(struct afh_info *afhi, char *buf)
 {
        if (!afhi)
                return;
@@ -329,25 +338,33 @@ static void save_afhi(struct audio_format_info *afhi, char *buf)
                afhi->seconds_total);
        write_u32(buf + AFHI_BITRATE_OFFSET, afhi->bitrate);
        write_u32(buf + AFHI_FREQUENCY_OFFSET, afhi->frequency);
+       write_u32(buf + AFHI_HEADER_OFFSET_OFFSET, afhi->header_offset);
+       write_u32(buf + AFHI_HEADER_LEN_OFFSET, afhi->header_len);
        write_u8(buf + AFHI_CHANNELS_OFFSET, afhi->channels);
+       write_u16(buf + AFHI_EOF_OFFSET, tv2ms(&afhi->eof_tv));
        strcpy(buf + AFHI_INFO_STRING_OFFSET, afhi->info_string); /* OK */
        PARA_DEBUG_LOG("last byte written: %p\n", buf + AFHI_INFO_STRING_OFFSET + strlen(afhi->info_string));
 }
 
-static void load_afhi(const char *buf, struct audio_format_info *afhi)
+static void load_afhi(const char *buf, struct afh_info *afhi)
 {
        afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
        afhi->bitrate = read_u32(buf + AFHI_BITRATE_OFFSET);
        afhi->frequency = read_u32(buf + AFHI_FREQUENCY_OFFSET);
        afhi->channels = read_u8(buf + AFHI_CHANNELS_OFFSET);
+       afhi->header_offset = read_u32(buf + AFHI_HEADER_OFFSET_OFFSET);
+       afhi->header_len = read_u32(buf + AFHI_HEADER_LEN_OFFSET);
+       ms2tv(read_u16(buf + AFHI_EOF_OFFSET), &afhi->eof_tv);
        strcpy(afhi->info_string, buf + AFHI_INFO_STRING_OFFSET);
 }
 
-static unsigned sizeof_chunk_info_buf(struct audio_format_info *afhi)
+//#define SIZEOF_CHUNK_TABLE(afhi) (((afhi)->chunks_total + 1) * sizeof(uint32_t))
+
+static unsigned sizeof_chunk_info_buf(struct afh_info *afhi)
 {
        if (!afhi)
                return 0;
-       return 4 * afhi->chunks_total + 20;
+       return 4 * (afhi->chunks_total + 1) + 20;
 
 }
 
@@ -367,11 +384,25 @@ enum chunk_info_offsets{
        CHUNK_TABLE_OFFSET = 20,
 };
 
-/* TODO: audio format handlers could just produce this */
-static void save_chunk_info(struct audio_format_info *afhi, char *buf)
+static void save_chunk_table(struct afh_info *afhi, char *buf)
 {
        int i;
 
+       PARA_DEBUG_LOG("%lu chunks\n", afhi->chunks_total);
+       for (i = 0; i <= afhi->chunks_total; i++)
+               write_u32(buf + 4 * i, afhi->chunk_table[i]);
+}
+
+static void load_chunk_table(struct afh_info *afhi, char *buf)
+{
+       int i;
+       for (i = 0; i <= afhi->chunks_total; i++)
+               afhi->chunk_table[i] = read_u32(buf + 4 * i);
+}
+
+/* TODO: audio format handlers could just produce this */
+static void save_chunk_info(struct afh_info *afhi, char *buf)
+{
        if (!afhi)
                return;
        write_u32(buf + CHUNKS_TOTAL_OFFSET, afhi->chunks_total);
@@ -379,14 +410,12 @@ static void save_chunk_info(struct audio_format_info *afhi, char *buf)
        write_u32(buf + HEADER_OFFSET_OFFSET, afhi->header_offset);
        write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
        write_u32(buf + CHUNK_TV_TV_USEC, afhi->chunk_tv.tv_usec);
-       for (i = 0; i < afhi->chunks_total; i++)
-               write_u32(buf + CHUNK_TABLE_OFFSET + 4 * i, afhi->chunk_table[i]);
+       save_chunk_table(afhi, buf + CHUNK_TABLE_OFFSET);
 }
 
-static int load_chunk_info(struct osl_object *obj, struct audio_format_info *afhi)
+static int load_chunk_info(struct osl_object *obj, struct afh_info *afhi)
 {
        char *buf = obj->data;
-       int i;
 
        if (obj->size < CHUNK_TABLE_OFFSET)
                return -E_BAD_DATA_SIZE;
@@ -397,11 +426,10 @@ static int load_chunk_info(struct osl_object *obj, struct audio_format_info *afh
        afhi->chunk_tv.tv_sec = read_u32(buf + CHUNK_TV_TV_SEC_OFFSET);
        afhi->chunk_tv.tv_usec = read_u32(buf + CHUNK_TV_TV_USEC);
 
-       if (afhi->chunks_total * 4 + CHUNK_TABLE_OFFSET > obj->size)
+       if ((afhi->chunks_total + 1) * 4 + CHUNK_TABLE_OFFSET > obj->size)
                return -E_BAD_DATA_SIZE;
-       afhi->chunk_table = para_malloc(afhi->chunks_total * sizeof(size_t));
-       for (i = 0; i < afhi->chunks_total; i++)
-               afhi->chunk_table[i] = read_u32(buf + CHUNK_TABLE_OFFSET + 4 * i);
+       afhi->chunk_table = para_malloc((afhi->chunks_total + 1) * 4);
+       load_chunk_table(afhi, buf + CHUNK_TABLE_OFFSET);
        return 1;
 }
 
@@ -505,7 +533,10 @@ int get_afsi_of_path(const char *path, struct afs_info *afsi)
  * \param row Pointer to a row in the audio file table.
  * \param path Result pointer.
  *
- * \return Positive on success, negative on errors.
+ * The result is a pointer to mmapped data. The caller must not attempt
+ * to free it.
+ *
+ * \return Standard.
  */
 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
 {
@@ -565,7 +596,7 @@ static int get_hash_of_row(const struct osl_row *row, HASH_TYPE **hash)
  *
  * \sa get_chunk_table_of_row().
  */
-int get_afhi_of_row(const struct osl_row *row, struct audio_format_info *afhi)
+int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
 {
        struct osl_object obj;
        int ret = osl_get_object(audio_file_table, row, AFTCOL_AFHI,
@@ -576,28 +607,52 @@ int get_afhi_of_row(const struct osl_row *row, struct audio_format_info *afhi)
        return 1;
 }
 
-/**
- * Get the chunk table of an audio file, given a row of the audio file table.
- *
- * \param row Pointer to a row of the audio file table.
- * \param afhi Result pointer.
- *
- * \return The return value of the underlying call to osl_open_disk_object().
- *
- * \sa get_afhi_of_row().
- */
-static int get_chunk_table_of_row(const struct osl_row *row, struct audio_format_info *afhi)
+/* returns shmid on success */
+static int save_afd(struct audio_file_data *afd)
 {
-       struct osl_object obj;
-       int ret = osl_open_disk_object(audio_file_table, row, AFTCOL_CHUNKS,
-               &obj);
+       size_t size = sizeof(*afd)
+               + 4 * (afd->afhi.chunks_total + 1);
+
+       PARA_DEBUG_LOG("size: %zu\n", size);
+       int shmid, ret = shm_new(size);
+       void *shm_afd;
+       char *buf;
+
        if (ret < 0)
                return ret;
-       ret = load_chunk_info(&obj, afhi);
-       osl_close_disk_object(&obj);
+       shmid = ret;
+       ret = shm_attach(shmid, ATTACH_RW, &shm_afd);
+       if (ret < 0)
+               goto err;
+       *(struct audio_file_data *)shm_afd = *afd;
+       buf = shm_afd;
+       buf += sizeof(*afd);
+       save_chunk_table(&afd->afhi, buf);
+       shm_detach(shm_afd);
+       return shmid;
+err:
+       shm_destroy(shmid);
        return ret;
 }
 
+int load_afd(int shmid, struct audio_file_data *afd)
+{
+       void *shm_afd;
+       char *buf;
+       int ret;
+
+       ret = shm_attach(shmid, ATTACH_RO, &shm_afd);
+       if (ret < 0)
+               return ret;
+       *afd = *(struct audio_file_data *)shm_afd;
+       buf = shm_afd;
+       buf += sizeof(*afd);
+       afd->afhi.chunk_table = para_malloc((afd->afhi.chunks_total + 1) * 4);
+       load_chunk_table(&afd->afhi, buf);
+       shm_detach(shm_afd);
+       return 1;
+}
+
 /**
  * Mmap the given audio file and update statistics.
  *
@@ -616,12 +671,17 @@ int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *
        struct osl_object afsi_obj;
        struct afs_info new_afsi;
        int ret = get_hash_of_row(aft_row, &aft_hash);
+       struct afsi_change_event_data aced;
+       struct osl_object map, chunk_table_obj;
+       char *tmp, *path;
 
        if (ret < 0)
                return ret;
-       ret = get_audio_file_path_of_row(aft_row, &afd->path);
+       ret = get_audio_file_path_of_row(aft_row, &path);
        if (ret < 0)
                return ret;
+       strncpy(afd->path, path, sizeof(afd->path) - 1);
+       afd->path[sizeof(afd->path) - 1] = '\0';
        ret = get_afsi_object_of_row(aft_row, &afsi_obj);
        if (ret < 0)
                return ret;
@@ -631,30 +691,62 @@ int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *
        ret = get_afhi_of_row(aft_row, &afd->afhi);
        if (ret < 0)
                return ret;
-       ret = get_chunk_table_of_row(aft_row, &afd->afhi);
+       ret = osl_open_disk_object(audio_file_table, aft_row,
+               AFTCOL_CHUNKS, &chunk_table_obj);
        if (ret < 0)
                return ret;
-       ret = mmap_full_file(afd->path, O_RDONLY, &afd->map);
+       ret = mmap_full_file(path, O_RDONLY, &map.data,
+               &map.size, &afd->fd);
        if (ret < 0)
                goto err;
-       hash_function(afd->map.data, afd->map.size, file_hash);
-       ret = -E_HASH_MISMATCH;
-       if (hash_compare(file_hash, aft_hash))
+       hash_function(map.data, map.size, file_hash);
+       ret = hash_compare(file_hash, aft_hash);
+       para_munmap(map.data, map.size);
+       if (ret) {
+               ret = -E_HASH_MISMATCH;
                goto err;
+       }
        new_afsi = afd->afsi;
        new_afsi.num_played++;
        new_afsi.last_played = time(NULL);
        save_afsi(&new_afsi, &afsi_obj); /* in-place update */
-       if (afd->current_play_mode == PLAY_MODE_PLAYLIST)
-               ret = playlist_update_audio_file(aft_row);
-       else {
-               struct afsi_change_event_data aced = {.aft_row = aft_row,
-                       .old_afsi = &afd->afsi};
-               afs_event(AFSI_CHANGE, NULL, &aced);
+
+       ret = load_chunk_info(&chunk_table_obj, &afd->afhi);
+       if (ret < 0)
+               goto err;
+       ret = get_attribute_text(&afd->afsi.attributes, " ", &tmp);
+       if (ret < 0)
+               goto err;
+       assert(tmp);
+       strncpy(afd->attributes_string, tmp, sizeof(afd->attributes_string));
+       afd->attributes_string[sizeof(afd->attributes_string) - 1] = '\0';
+       free(tmp);
+
+       {
+               struct ls_data d = {
+                       .afhi = afd->afhi,
+                       .afsi = afd->afsi,
+                       .path = path,
+                       .score = afd->score,
+                       .hash = file_hash
+               };
+               struct para_buffer pb = {.buf = NULL};
+               ret = make_status_items(&d, &pb);
+               if (ret < 0)
+                       goto err;
+               strncpy(afd->afs_status_info, pb.buf, AFS_STATUS_INFO_SIZE);
+               afd->afs_status_info[AFS_STATUS_INFO_SIZE] = '\0';
+               free(pb.buf);
        }
-       return ret;
-err:
+       aced.aft_row = aft_row;
+       aced.old_afsi = &afd->afsi;
+       afs_event(AFSI_CHANGE, NULL, &aced);
+       ret = save_afd(afd);
+       if (ret < 0)
+               goto err;
        free(afd->afhi.chunk_table);
+err:
+       osl_close_disk_object(&chunk_table_obj);
        return ret;
 }
 
@@ -714,16 +806,17 @@ static void get_duration_buf(int seconds, char *buf, short unsigned max_width)
                        seconds % 60);
 }
 
-static char *make_attribute_line(const char *att_bitmap, struct afs_info *afsi)
+static char *make_attribute_lines(const char *att_bitmap, struct afs_info *afsi)
 {
-       char *att_text, *att_line;
+       char *att_text, *att_lines;
 
        get_attribute_text(&afsi->attributes, " ", &att_text);
        if (!att_text)
                return para_strdup(att_bitmap);
-       att_line = make_message("%s (%s)", att_bitmap, att_text);
+       att_lines = make_message("%s\nattributes_txt: %s",
+               att_bitmap, att_text);
        free(att_text);
-       return att_line;
+       return att_lines;
 }
 
 static char *make_lyrics_line(struct afs_info *afsi)
@@ -754,11 +847,11 @@ static int print_list_item(struct ls_data *d, struct ls_options *opts,
        char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
        char score_buf[30] = "";
        struct afs_info *afsi = &d->afsi;
-       struct audio_format_info *afhi = &d->afhi;
+       struct afh_info *afhi = &d->afhi;
        struct ls_widths *w = &opts->widths;
        int have_score = opts->flags & LS_FLAG_ADMISSIBLE_ONLY;
        char asc_hash[2 * HASH_SIZE + 1];
-       char *att_line, *lyrics_line, *image_line;
+       char *att_lines, *lyrics_line, *image_line;
 
        if (opts->mode == LS_MODE_SHORT) {
                para_printf(b, "%s\n", d->path);
@@ -807,11 +900,10 @@ static int print_list_item(struct ls_data *d, struct ls_options *opts,
                return 1;
        }
        hash_to_asc(d->hash, asc_hash);
-       att_line = make_attribute_line(att_buf, afsi);
+       att_lines = make_attribute_lines(att_buf, afsi);
        lyrics_line = make_lyrics_line(afsi);
        image_line = make_image_line(afsi);
        if (opts->mode == LS_MODE_VERBOSE) {
-
                para_printf(b,
                        "%s: %s\n" /* path */
                        "%s%s%s" /* score */
@@ -831,7 +923,7 @@ static int print_list_item(struct ls_data *d, struct ls_options *opts,
                                "path" : "file", d->path,
                        have_score? "score: " : "", score_buf,
                                have_score? "\n" : "",
-                       att_line,
+                       att_lines,
                        asc_hash,
                        image_line,
                        lyrics_line,
@@ -852,7 +944,7 @@ static int print_list_item(struct ls_data *d, struct ls_options *opts,
                        "Received: from\nTo: bar\nFrom: a\n"
                        "Subject: %s\n\n" /* path */
                        "%s%s%s" /* score */
-                       "attributes: %s\n"
+                       "%s\n" /* attributes */
                        "hash: %s\n"
                        "image_id: %s\n"
                        "lyrics_id: %s\n"
@@ -868,7 +960,7 @@ static int print_list_item(struct ls_data *d, struct ls_options *opts,
                        d->path,
                        have_score? "score: " : "", score_buf,
                                have_score? "\n" : "",
-                       att_line,
+                       att_lines,
                        asc_hash,
                        image_line,
                        lyrics_line,
@@ -885,12 +977,25 @@ static int print_list_item(struct ls_data *d, struct ls_options *opts,
                if (lyrics_def.data)
                        osl_close_disk_object(lyrics_def.data);
        }
-       free(att_line);
+       free(att_lines);
        free(lyrics_line);
        free(image_line);
        return 1;
 }
 
+int make_status_items(struct ls_data *d, struct para_buffer *pb)
+{
+       struct ls_options opts = {
+               .flags = LS_FLAG_FULL_PATH | LS_FLAG_ADMISSIBLE_ONLY,
+               .mode = LS_MODE_VERBOSE,
+       };
+       time_t current_time;
+
+       time(&current_time);
+       return print_list_item(d, &opts, pb, current_time);
+}
+
+
 static int ls_audio_format_compare(const void *a, const void *b)
 {
        struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
@@ -1143,13 +1248,9 @@ out:
 }
 
 /*
- * TODO: flags -h (sort by hash) -lm (list in mbox format)
- *
- * long list: list hash, attributes as (xx--x-x-), file size, lastplayed
- * full list: list everything, including afsi, afhi, atts as clear text
- *
- * */
-int com_afs_ls(int fd, int argc, char * const * const argv)
+ * TODO: flags -h (sort by hash)
+ */
+int com_ls(int fd, int argc, char * const * const argv)
 {
        int i, ret;
        unsigned flags = 0;
@@ -1295,7 +1396,7 @@ enum aft_row_offsets {
 /* never save the afsi, as the server knows it too. Note that afhi might be NULL.
  * In this case, afhi won't be stored in the buffer  */
 static void save_audio_file_info(HASH_TYPE *hash, const char *path,
-               struct audio_format_info *afhi, uint32_t flags,
+               struct afh_info *afhi, uint32_t flags,
                uint8_t audio_format_num, struct osl_object *obj)
 {
        size_t path_len = strlen(path) + 1;
@@ -1504,8 +1605,11 @@ out:
        return 1;
 }
 
+/** Used by com_add(). */
 struct private_add_data {
+       /** The socket file descriptor. */
        int fd;
+       /** The given add flags. */
        uint32_t flags;
 };
 
@@ -1543,9 +1647,9 @@ static int add_one_audio_file(const char *path, const void *private_data)
        int ret, ret2;
        uint8_t format_num = -1;
        const struct private_add_data *pad = private_data;
-       struct audio_format_info afhi, *afhi_ptr = NULL;
+       struct afh_info afhi, *afhi_ptr = NULL;
        struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
-       struct osl_object map, obj = {.data = NULL}, query, result;
+       struct osl_object map, obj = {.data = NULL}, query, result = {.data = NULL};
        HASH_TYPE hash[HASH_SIZE];
 
        afhi.header_offset = 0;
@@ -1569,7 +1673,7 @@ static int add_one_audio_file(const char *path, const void *private_data)
                goto out_free;
        }
        /* We still want to add this file. Compute its hash. */
-       ret = mmap_full_file(path, O_RDONLY, &map);
+       ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, NULL);
        if (ret < 0)
                goto out_free;
        hash_function(map.data, map.size, hash);
@@ -1612,7 +1716,7 @@ static int add_one_audio_file(const char *path, const void *private_data)
        save_audio_file_info(hash, path, afhi_ptr, pad->flags, format_num, &obj);
        /* Ask afs to consider this entry for adding. */
        ret = send_callback_request(com_add_callback, &obj, &result);
-       if (result.data && result.size) {
+       if (ret > 0) {
                ret2 = send_va_buffer(pad->fd, "%s", (char *)result.data);
                free(result.data);
                if (ret >= 0 && ret2 < 0)
@@ -1712,16 +1816,25 @@ enum touch_flags {
        TOUCH_FLAG_VERBOSE = 2
 };
 
+/** Options used by com_touch(). */
 struct com_touch_options {
+       /** New num_played value. */
        int32_t num_played;
+       /** New last played count. */
        int64_t last_played;
+       /** new lyrics id. */
        int32_t lyrics_id;
+       /** new image id. */
        int32_t image_id;
+       /** command line flags (see \ref touch_flags). */
        unsigned flags;
 };
 
+/** Data passed to the action handler of com_touch(). */
 struct touch_action_data {
+       /** Command line options (see \ref com_touch_options). */
        struct com_touch_options *cto;
+       /** Message buffer. */
        struct para_buffer pb;
 };
 
@@ -1861,27 +1974,35 @@ int com_touch(int fd, int argc, char * const * const argv)
        if (ret > 0) {
                send_buffer(fd, (char *)result.data);
                free(result.data);
-       } else
+       } else if (ret < 0)
                send_va_buffer(fd, "%s\n", PARA_STRERROR(-ret));
        return ret;
 }
 
+/** Flags for com_rm(). */
 enum rm_flags {
+       /** -v */
        RM_FLAG_VERBOSE = 1,
+       /** -f */
        RM_FLAG_FORCE = 2,
+       /** -p */
        RM_FLAG_FNM_PATHNAME = 4
 };
 
-struct com_rm_data {
+/** Data passed to the action handler of com_rm(). */
+struct com_rm_action_data {
+       /** Command line flags ((see \ref rm_flags). */
        uint32_t flags;
+       /** Message buffer. */
        struct para_buffer pb;
+       /** Number of audio files removed. */
        unsigned num_removed;
 };
 
 static int remove_audio_file(__a_unused struct osl_table *table,
                struct osl_row *row, const char *name, void *data)
 {
-       struct com_rm_data *crd = data;
+       struct com_rm_action_data *crd = data;
        int ret;
 
        if (crd->flags & RM_FLAG_VERBOSE)
@@ -1898,7 +2019,7 @@ static int remove_audio_file(__a_unused struct osl_table *table,
 static int com_rm_callback(const struct osl_object *query,
                __a_unused struct osl_object *result)
 {
-       struct com_rm_data crd = {.flags = *(uint32_t *)query->data};
+       struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data};
        int ret;
        struct pattern_match_data pmd = {
                .table = audio_file_table,
@@ -1929,7 +2050,7 @@ static int com_rm_callback(const struct osl_object *query,
 }
 
 /* TODO options: -r (recursive) */
-int com_afs_rm(int fd, int argc,  char * const * const argv)
+int com_rm(int fd, int argc,  char * const * const argv)
 {
        uint32_t flags = 0;
        struct osl_object query = {.data = &flags, .size = sizeof(flags)},
@@ -1990,10 +2111,15 @@ enum cpsi_flags {
        CPSI_FLAG_VERBOSE = 32,
 };
 
+/** Data passed to the action handler of com_cpsi(). */
 struct cpsi_action_data {
+       /** command line flags (see \ref cpsi_flags). */
        unsigned flags;
+       /** Number of audio files changed. */
        unsigned num_copied;
+       /** Message buffer. */
        struct para_buffer pb;
+       /** Values are copied from here. */
        struct afs_info source_afsi;
 };
 
@@ -2187,7 +2313,7 @@ int aft_check_callback(__a_unused const struct osl_object *query, struct osl_obj
 /**
  * Close the audio file table.
  *
- * \param flags Ususal flags that are passed to osl_close_table().
+ * \param flags Usual flags that are passed to osl_close_table().
  *
  * \sa osl_close_table().
  */