Fix a typo on the Documentation web page.
[paraslash.git] / aft.c
diff --git a/aft.c b/aft.c
index 19e357525ba88c7b2ccfabafc4d974b73f18fb39..001026db4e956caa8b46256797d29cddced6ddf5 100644 (file)
--- a/aft.c
+++ b/aft.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -660,6 +660,7 @@ int open_and_update_audio_file(struct osl_row *aft_row, long score,
                AFTCOL_CHUNKS, &chunk_table_obj);
        if (ret < 0)
                return ret;
+       afd->afhi.chunk_table = NULL;
        ret = mmap_full_file(path, O_RDONLY, &map.data,
                &map.size, &afd->fd);
        if (ret < 0)
@@ -697,10 +698,8 @@ int open_and_update_audio_file(struct osl_row *aft_row, long score,
        aced.old_afsi = &old_afsi;
        afs_event(AFSI_CHANGE, NULL, &aced);
        ret = save_afd(afd);
-       free(afd->afhi.chunk_table);
-       if (ret < 0)
-               goto err;
 err:
+       free(afd->afhi.chunk_table);
        osl_close_disk_object(&chunk_table_obj);
        return ret;
 }
@@ -804,8 +803,8 @@ static char *make_image_lines(struct afs_info *afsi)
 
 static char *make_filename_lines(const char *path, unsigned flags)
 {
-       char *basename, *dirname;
-       char *ret;
+       char *dirname, *ret;
+       const char *basename;
 
        if (!(flags & LS_FLAG_FULL_PATH))
                return make_message("%s: %s\n",
@@ -814,9 +813,8 @@ static char *make_filename_lines(const char *path, unsigned flags)
        dirname = para_dirname(path);
        ret = make_message("%s: %s\n%s: %s\n%s: %s\n",
                status_item_list[SI_PATH], path,
-               status_item_list[SI_DIRECTORY], dirname,
-               status_item_list[SI_BASENAME], basename);
-       free(basename);
+               status_item_list[SI_DIRECTORY], dirname? dirname : "?",
+               status_item_list[SI_BASENAME], basename? basename : "?");
        free(dirname);
        return ret;
 }
@@ -887,13 +885,15 @@ static int print_list_item(struct ls_data *d, struct ls_options *opts,
        lyrics_lines = make_lyrics_lines(afsi);
        image_lines = make_image_lines(afsi);
        filename_lines = make_filename_lines(d->path, opts->flags);
-       if (opts->mode == LS_MODE_MBOX)
+       if (opts->mode == LS_MODE_MBOX) {
+               const char *bn = para_basename(d->path);
                para_printf(b,
                        "From foo@localhost %s\n"
                        "Received: from\nTo: bar\nFrom: a\n"
                        "Subject: %s\n\n",
                        last_played_time,
-                       d->path);
+                       bn? bn : "?");
+       }
        para_printf(b,
                "%s" /* filename stuff */
                "%s%s%s%s" /* score */
@@ -1395,44 +1395,56 @@ static struct osl_row *find_hash_sister(HASH_TYPE *hash)
        return row;
 }
 
-enum aft_row_offsets {
-       AFTROW_AFHI_OFFSET_POS = 0,
-       AFTROW_CHUNKS_OFFSET_POS = 2,
-       AFTROW_AUDIO_FORMAT_OFFSET = 4,
-       AFTROW_FLAGS_OFFSET = 5,
-       AFTROW_HASH_OFFSET = 9,
-       AFTROW_PATH_OFFSET = (AFTROW_HASH_OFFSET + HASH_SIZE),
+/** The format of the data stored by save_audio_file_data(). */
+enum com_add_buffer_offsets {
+       /** afhi (if present) starts here. */
+       CAB_AFHI_OFFSET_POS = 0,
+       /** Start of the chunk table (if present). */
+       CAB_CHUNKS_OFFSET_POS = 2,
+       /** Audio format id. */
+       CAB_AUDIO_FORMAT_OFFSET = 4,
+       /** Flags given to the add command. */
+       CAB_FLAGS_OFFSET = 5,
+       /** The hash of the audio file being added. */
+       CAB_HASH_OFFSET = 9,
+       /** Start of the path of the audio file. */
+       CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
 };
 
-/* 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,
+/*
+ * Store the given data to a single buffer. Doesn't need the audio file selector
+ * info struct as the server knows it as well.
+ *
+ * It's OK to call this with afhi == NULL. In this case, the audio format
+ * handler info won't be stored in the buffer.
+ */
+static void save_add_callback_buffer(HASH_TYPE *hash, const char *path,
                struct afh_info *afhi, uint32_t flags,
                uint8_t audio_format_num, struct osl_object *obj)
 {
        size_t path_len = strlen(path) + 1;
        size_t afhi_size = sizeof_afhi_buf(afhi);
-       size_t size = AFTROW_PATH_OFFSET + path_len + afhi_size
+       size_t size = CAB_PATH_OFFSET + path_len + afhi_size
                + sizeof_chunk_table(afhi);
        char *buf = para_malloc(size);
        uint16_t pos;
 
-       write_u8(buf + AFTROW_AUDIO_FORMAT_OFFSET, audio_format_num);
-       write_u32(buf + AFTROW_FLAGS_OFFSET, flags);
+       write_u8(buf + CAB_AUDIO_FORMAT_OFFSET, audio_format_num);
+       write_u32(buf + CAB_FLAGS_OFFSET, flags);
 
-       memcpy(buf + AFTROW_HASH_OFFSET, hash, HASH_SIZE);
-       strcpy(buf + AFTROW_PATH_OFFSET, path);
+       memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
+       strcpy(buf + CAB_PATH_OFFSET, path);
 
-       pos = AFTROW_PATH_OFFSET + path_len;
+       pos = CAB_PATH_OFFSET + path_len;
        PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
        PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
                pos + afhi_size - 1);
-       write_u16(buf + AFTROW_AFHI_OFFSET_POS, pos);
+       write_u16(buf + CAB_AFHI_OFFSET_POS, pos);
        save_afhi(afhi, buf + pos);
 
        pos += afhi_size;
        PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
-       write_u16(buf + AFTROW_CHUNKS_OFFSET_POS, pos);
+       write_u16(buf + CAB_CHUNKS_OFFSET_POS, pos);
        if (afhi)
                save_chunk_table(afhi, buf + pos);
        PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
@@ -1441,43 +1453,53 @@ static void save_audio_file_info(HASH_TYPE *hash, const char *path,
 }
 
 /*
-input:
+
+Overview of the add command.
+
+Input: What was passed to the callback by the command handler.
 ~~~~~~
-HS:    hash sister
-PB:    path brother
-F:     force flag given
+HS:    Hash sister. Whether an audio file with identical hash
+       already exists in the osl database.
+
+PB:    Path brother. Whether a file with the given path exists
+       in the table.
 
-output:
+F:     Force flag given. Whether add was called with -f.
+
+output: Action performed by the callback.
 ~~~~~~~
-AFHI:  whether afhi and chunk table are computed and sent
-ACTION:        table modifications to be performed
-
-+---+----+-----+------+---------------------------------------------------+
-| HS | PB | F  | AFHI | ACTION
-+---+----+-----+------+---------------------------------------------------+
-| Y |  Y |  Y  |  Y   | if HS != PB: remove PB. HS: force afhi update,
-|                     | update path, keep afsi
-+---+----+-----+------+---------------------------------------------------+
-| Y |  Y |  N  |  N   | if HS == PB: do not send callback request at all.
-|                     | otherwise: remove PB, HS: update path, keep afhi,
-|                     | afsi.
-+---+----+-----+------+---------------------------------------------------+
-| Y |  N |  Y  |  Y   | (rename) force afhi update of HS, update path of
-|                     | HS, keep afsi
-+---+----+-----+------+---------------------------------------------------+
-| Y |  N |  N  |  N   | (file rename) update path of HS, keep afsi, afhi
-+---+----+-----+------+---------------------------------------------------+
-| N |  Y |  Y  |  Y   | (file change) update afhi, hash, of PB, keep afsi
-|                     | (force has no effect)
-+---+----+-----+------+---------------------------------------------------+
-| N |  Y |  N  |  Y   | (file change) update afhi, hash of PB, keep afsi
-+---+----+-----+------+---------------------------------------------------+
-| N |  N |  Y  |  Y   | (new file) create new entry (force has no effect)
-+---+----+-----+------+---------------------------------------------------+
-| N |  N |  N  |  Y   | (new file) create new entry
-+---+----+-----+------+---------------------------------------------------+
-
-afhi <=> force or no HS
+AFHI:  Whether afhi and chunk table are computed and sent.
+ACTION:        Table modifications to be done by the callback.
+
++----+----+---+------+---------------------------------------------------+
+| HS | PB | F | AFHI | ACTION
++----+----+---+------+---------------------------------------------------+
+| Y  |  Y | Y |  Y   | if HS != PB: remove PB. HS: force afhi update,
+|                    | update path, keep afsi
++----+----+---+------+---------------------------------------------------+
+| Y  |  Y | N |  N   | if HS == PB: do not send callback request at all.
+|                    | otherwise: remove PB, HS: update path, keep afhi,
+|                    | afsi.
++----+----+---+------+---------------------------------------------------+
+| Y  |  N | Y |  Y   | (rename) force afhi update of HS, update path of
+|                    | HS, keep afsi
++----+----+---+------+---------------------------------------------------+
+| Y  |  N | N |  N   | (file rename) update path of HS, keep afsi, afhi
++----+----+---+------+---------------------------------------------------+
+| N  |  Y | Y |  Y   | (file change) update afhi, hash, of PB, keep afsi
+|                    | (force has no effect)
++----+----+---+------+---------------------------------------------------+
+| N  |  Y | N |  Y   | (file change) update afhi, hash of PB, keep afsi
++----+----+---+------+---------------------------------------------------+
+| N  |  N | Y |  Y   | (new file) create new entry (force has no effect)
++----+----+---+------+---------------------------------------------------+
+|  N |  N | N |  Y   | (new file) create new entry
++----+----+---+------+---------------------------------------------------+
+
+Notes:
+
+       afhi <=> force or no HS
+       F => AFHI
 
 */
 
@@ -1504,16 +1526,16 @@ static int com_add_callback(const struct osl_object *query,
        char asc[2 * HASH_SIZE + 1];
        int ret;
        char afsi_buf[AFSI_SIZE];
-       uint32_t flags = read_u32(buf + AFTROW_FLAGS_OFFSET);
+       uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
        struct afs_info default_afsi = {.last_played = 0};
        struct para_buffer msg = {.buf = NULL};
 
-       hash = (HASH_TYPE *)buf + AFTROW_HASH_OFFSET;
+       hash = (HASH_TYPE *)buf + CAB_HASH_OFFSET;
        hash_to_asc(hash, asc);;
-       objs[AFTCOL_HASH].data = buf + AFTROW_HASH_OFFSET;
+       objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
        objs[AFTCOL_HASH].size = HASH_SIZE;
 
-       path = buf + AFTROW_PATH_OFFSET;
+       path = buf + CAB_PATH_OFFSET;
        objs[AFTCOL_PATH].data = path;
        objs[AFTCOL_PATH].size = strlen(path) + 1;
 
@@ -1555,8 +1577,8 @@ static int com_add_callback(const struct osl_object *query,
                        goto out;
        }
        /* no hs or force mode, child must have sent afhi */
-       uint16_t afhi_offset = read_u16(buf + AFTROW_AFHI_OFFSET_POS);
-       uint16_t chunks_offset = read_u16(buf + AFTROW_CHUNKS_OFFSET_POS);
+       uint16_t afhi_offset = read_u16(buf + CAB_AFHI_OFFSET_POS);
+       uint16_t chunks_offset = read_u16(buf + CAB_CHUNKS_OFFSET_POS);
 
        objs[AFTCOL_AFHI].data = buf + afhi_offset;
        objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
@@ -1600,7 +1622,7 @@ static int com_add_callback(const struct osl_object *query,
        if (flags & ADD_FLAG_VERBOSE)
                para_printf(&msg, "new file\n");
        default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
-       default_afsi.audio_format_id = read_u8(buf + AFTROW_AUDIO_FORMAT_OFFSET);
+       default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_OFFSET);
 
        objs[AFTCOL_AFSI].data = &afsi_buf;
        objs[AFTCOL_AFSI].size = AFSI_SIZE;
@@ -1609,7 +1631,7 @@ static int com_add_callback(const struct osl_object *query,
        afs_event(AUDIO_FILE_ADD, &msg, aft_row);
 out:
        if (ret < 0)
-               para_printf(&msg, "%s\n", PARA_STRERROR(-ret));
+               para_printf(&msg, "%s\n", para_strerror(-ret));
        if (!msg.buf)
                return 0;
        result->data = msg.buf;
@@ -1725,7 +1747,7 @@ static int add_one_audio_file(const char *path, const void *private_data)
                if (send_ret < 0)
                        goto out_free;
        }
-       save_audio_file_info(hash, path, afhi_ptr, pad->flags, format_num, &obj);
+       save_add_callback_buffer(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 (ret > 0) {
@@ -1739,7 +1761,7 @@ out_unmap:
 out_free:
        if (ret < 0 && send_ret >= 0)
                send_ret = send_va_buffer(pad->fd, "failed to add %s (%s)\n", path,
-                       PARA_STRERROR(-ret));
+                       para_strerror(-ret));
        free(obj.data);
        if (afhi_ptr)
                free(afhi_ptr->chunk_table);
@@ -1784,7 +1806,8 @@ int com_add(int fd, int argc, char * const * const argv)
                char *path;
                ret = verify_path(argv[i], &path);
                if (ret < 0) {
-                       ret = send_va_buffer(fd, "%s: %s\n", argv[i], PARA_STRERROR(-ret));
+                       ret = send_va_buffer(fd, "%s: %s\n", argv[i],
+                               para_strerror(-ret));
                        if (ret < 0)
                                return ret;
                        continue;
@@ -1804,7 +1827,7 @@ int com_add(int fd, int argc, char * const * const argv)
                else
                        ret = add_one_audio_file(path, &pad);
                if (ret < 0) {
-                       send_va_buffer(fd, "%s: %s\n", path, PARA_STRERROR(-ret));
+                       send_va_buffer(fd, "%s: %s\n", path, para_strerror(-ret));
                        free(path);
                        return ret;
                }
@@ -1860,12 +1883,12 @@ static int touch_audio_file(__a_unused struct osl_table *table,
 
        ret = get_afsi_object_of_row(row, &obj);
        if (ret < 0) {
-               para_printf(&tad->pb, "%s: %s\n", name, PARA_STRERROR(-ret));
+               para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
                return 1;
        }
        ret = load_afsi(&old_afsi, &obj);
        if (ret < 0) {
-               para_printf(&tad->pb, "%s: %s\n", name, PARA_STRERROR(-ret));
+               para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
                return 1;
        }
        new_afsi = old_afsi;
@@ -1913,7 +1936,7 @@ static int com_touch_callback(const struct osl_object *query,
                pmd.fnmatch_flags |= FNM_PATHNAME;
        ret = for_each_matching_row(&pmd);
        if (ret < 0)
-               para_printf(&tad.pb, "%s\n", PARA_STRERROR(-ret));
+               para_printf(&tad.pb, "%s\n", para_strerror(-ret));
        if (tad.pb.buf) {
                result->data = tad.pb.buf;
                result->size = tad.pb.size;
@@ -1981,11 +2004,14 @@ int com_touch(int fd, int argc, char * const * const argv)
                return -E_AFT_SYNTAX;
        ret = send_option_arg_callback_request(&query, argc - i,
                argv + i, com_touch_callback, &result);
-       if (ret > 0) {
-               send_buffer(fd, (char *)result.data);
-               free(result.data);
-       } else if (ret < 0)
-               send_va_buffer(fd, "%s\n", PARA_STRERROR(-ret));
+       if (!ret)
+               return 0;
+       if (ret < 0) {
+               send_va_buffer(fd, "%s\n", para_strerror(-ret));
+               return ret;
+       }
+       ret = send_buffer(fd, (char *)result.data);
+       free(result.data);
        return ret;
 }
 
@@ -2020,7 +2046,7 @@ static int remove_audio_file(__a_unused struct osl_table *table,
        afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
        ret = osl_del_row(audio_file_table, row);
        if (ret < 0)
-               para_printf(&crd->pb, "%s: %s\n", name, PARA_STRERROR(-ret));
+               para_printf(&crd->pb, "%s: %s\n", name, para_strerror(-ret));
        else
                crd->num_removed++;
        return 1;
@@ -2044,7 +2070,7 @@ static int com_rm_callback(const struct osl_object *query,
                pmd.fnmatch_flags |= FNM_PATHNAME;
        ret = for_each_matching_row(&pmd);
        if (ret < 0)
-               para_printf(&crd.pb, "%s\n", PARA_STRERROR(-ret));
+               para_printf(&crd.pb, "%s\n", para_strerror(-ret));
        if (!crd.num_removed && !(crd.flags & RM_FLAG_FORCE))
                para_printf(&crd.pb, "no matches -- nothing removed\n");
        else {
@@ -2093,11 +2119,14 @@ int com_rm(int fd, int argc,  char * const * const argv)
                return -E_AFT_SYNTAX;
        ret = send_option_arg_callback_request(&query, argc - i, argv + i,
                com_rm_callback, &result);
-       if (ret > 0) {
-               send_buffer(fd, (char *)result.data);
-               free(result.data);
-       } else if (ret < 0)
-               send_va_buffer(fd, "%s\n", PARA_STRERROR(-ret));
+       if (!ret)
+               return 0;
+       if (ret < 0) {
+               send_va_buffer(fd, "%s\n", para_strerror(-ret));
+               return ret;
+       }
+       ret = send_buffer(fd, (char *)result.data);
+       free(result.data);
        return ret;
 }
 
@@ -2190,7 +2219,7 @@ static int com_cpsi_callback(const struct osl_object *query,
        ret = for_each_matching_row(&pmd);
 out:
        if (ret < 0)
-               para_printf(&cad.pb, "%s\n", PARA_STRERROR(-ret));
+               para_printf(&cad.pb, "%s\n", para_strerror(-ret));
        if (cad.flags & CPSI_FLAG_VERBOSE) {
                if (cad.num_copied)
                        para_printf(&cad.pb, "copied requested afsi from %s "
@@ -2254,11 +2283,14 @@ int com_cpsi(int fd, int argc,  char * const * const argv)
                flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
        ret = send_option_arg_callback_request(&options, argc - i, argv + i,
                com_cpsi_callback, &result);
-       if (ret > 0) {
-               send_buffer(fd, (char *)result.data);
-               free(result.data);
-       } else
-               send_va_buffer(fd, "%s\n", PARA_STRERROR(-ret));
+       if (!ret)
+               return 0;
+       if (ret < 0) {
+               send_va_buffer(fd, "%s\n", para_strerror(-ret));
+               return ret;
+       }
+       ret = send_buffer(fd, (char *)result.data);
+       free(result.data);
        return ret;
 }
 
@@ -2273,7 +2305,7 @@ static int check_audio_file(struct osl_row *row, void *data)
        char *blob_name;
 
        if (ret < 0) {
-               para_printf(pb, "%s\n", PARA_STRERROR(-ret));
+               para_printf(pb, "%s\n", para_strerror(-ret));
                return 1;
        }
        if (stat(path, &statbuf) < 0)
@@ -2284,17 +2316,17 @@ static int check_audio_file(struct osl_row *row, void *data)
        }
        ret = get_afsi_of_row(row, &afsi);
        if (ret < 0) {
-               para_printf(pb, "%s: %s\n", path, PARA_STRERROR(-ret));
+               para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
                return 1;
        }
        ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
        if (ret < 0)
                para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
-                       PARA_STRERROR(-ret));
+                       para_strerror(-ret));
        ret = img_get_name_by_id(afsi.image_id, &blob_name);
        if (ret < 0)
                para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
-                       PARA_STRERROR(-ret));
+                       para_strerror(-ret));
        return 1;
 }