]> git.tuebingen.mpg.de Git - paraslash.git/blobdiff - aft.c
Introduce signal_shutdown().
[paraslash.git] / aft.c
diff --git a/aft.c b/aft.c
index d0580bba8a5fa3c271c0119d368794c09b7c81b3..5c1605207f67cb114b7e7d6d4add234824bc3af5 100644 (file)
--- a/aft.c
+++ b/aft.c
@@ -99,7 +99,7 @@ struct ls_widths {
 /** Data passed to the different compare functions (called by qsort()). */
 struct ls_data {
        /** Usual audio format handler information. */
-       struct audio_format_info afhi;
+       struct afh_info afhi;
        /** Audio file selector information. */
        struct afs_info afsi;
        /** The full path of the audio file. */
@@ -110,16 +110,27 @@ struct ls_data {
        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;
 };
 
@@ -320,14 +331,14 @@ enum afhi_offsets {
        MIN_AFHI_SIZE = 14
 };
 
-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;
@@ -340,7 +351,7 @@ static void save_afhi(struct audio_format_info *afhi, char *buf)
        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);
@@ -351,7 +362,7 @@ static void load_afhi(const char *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 audio_format_info *afhi)
+static unsigned sizeof_chunk_info_buf(struct afh_info *afhi)
 {
        if (!afhi)
                return 0;
@@ -375,16 +386,16 @@ enum chunk_info_offsets{
        CHUNK_TABLE_OFFSET = 20,
 };
 
-static void save_chunk_table(struct audio_format_info *afhi, char *buf)
+static void save_chunk_table(struct afh_info *afhi, char *buf)
 {
        int i;
 
-       PARA_NOTICE_LOG("%lu chunks\n", afhi->chunks_total);
+       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 audio_format_info *afhi, char *buf)
+static void load_chunk_table(struct afh_info *afhi, char *buf)
 {
        int i;
        for (i = 0; i <= afhi->chunks_total; i++)
@@ -392,7 +403,7 @@ static void load_chunk_table(struct audio_format_info *afhi, char *buf)
 }
 
 /* TODO: audio format handlers could just produce this */
-static void save_chunk_info(struct audio_format_info *afhi, char *buf)
+static void save_chunk_info(struct afh_info *afhi, char *buf)
 {
        if (!afhi)
                return;
@@ -404,7 +415,7 @@ static void save_chunk_info(struct audio_format_info *afhi, char *buf)
        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;
 
@@ -587,7 +598,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,
@@ -604,7 +615,7 @@ static int save_afd(struct audio_file_data *afd)
        size_t size = sizeof(*afd)
                + 4 * (afd->afhi.chunks_total + 1);
 
-       PARA_NOTICE_LOG("size: %zu\n", size);
+       PARA_DEBUG_LOG("size: %zu\n", size);
        int shmid, ret = shm_new(size);
        void *shm_afd;
        char *buf;
@@ -780,16 +791,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)
@@ -820,11 +832,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);
@@ -873,11 +885,11 @@ 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);
+       /* TODO: Merge this with status items */
        if (opts->mode == LS_MODE_VERBOSE) {
-
                para_printf(b,
                        "%s: %s\n" /* path */
                        "%s%s%s" /* score */
@@ -897,7 +909,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,
@@ -918,7 +930,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"
                        "hash: %s\n"
                        "image_id: %s\n"
                        "lyrics_id: %s\n"
@@ -934,7 +946,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,
@@ -951,7 +963,7 @@ 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;
@@ -1361,7 +1373,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;
@@ -1570,8 +1582,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;
 };
 
@@ -1609,7 +1624,7 @@ 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 = {.data = NULL};
        HASH_TYPE hash[HASH_SIZE];
@@ -1927,7 +1942,7 @@ 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;
 }
@@ -2253,7 +2268,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().
  */