X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=aft.c;h=1234ee5a35aa8fdbe93ba225ef511e88205336d4;hp=2d5bbe8da4115ce3a9d3df3b304375904083164b;hb=a35c113e0bb9fa9ac02b77eb01dd32f49cd5c8d0;hpb=99ada213156df87aa7723c48c80d662a54458f09

diff --git a/aft.c b/aft.c
index 2d5bbe8d..1234ee5a 100644
--- a/aft.c
+++ b/aft.c
@@ -1,8 +1,4 @@
-/*
- * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
 /** \file aft.c Audio file table functions. */
 
@@ -138,7 +134,7 @@ struct ls_options {
 /**
  * Describes the layout of the mmapped-afs info struct.
  *
- * \sa struct afs_info.
+ * \sa struct \ref afs_info.
  */
 enum afsi_offsets {
 	/** Where .last_played is stored. */
@@ -167,7 +163,7 @@ enum afsi_offsets {
  * \param afsi Pointer to the audio file info to be converted.
  * \param obj Result pointer.
  *
- * \sa load_afsi().
+ * \sa \ref load_afsi().
  */
 static void save_afsi(struct afs_info *afsi, struct osl_object *obj)
 {
@@ -192,7 +188,7 @@ static void save_afsi(struct afs_info *afsi, struct osl_object *obj)
  *
  * \return Standard.
  *
- * \sa save_afsi().
+ * \sa \ref save_afsi().
  */
 static int load_afsi(struct afs_info *afsi, struct osl_object *obj)
 {
@@ -365,7 +361,10 @@ static void save_afhi(struct afh_info *afhi, char *buf)
 	write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
 	write_u32(buf + CHUNK_TV_TV_USEC_OFFSET, afhi->chunk_tv.tv_usec);
 	p = buf + AFHI_INFO_STRING_OFFSET;
-	/* The sprintf's below are OK as our caller made sure that buf is large enough */
+	/*
+	 * The below sprintf(3) calls are OK because our caller already made
+	 * sure that buf is large enough.
+	 */
 	p += sprintf(p, "%s", afhi->techinfo) + 1;
 	p += sprintf(p, "%s", afhi->tags.artist) + 1;
 	p += sprintf(p, "%s", afhi->tags.title) + 1;
@@ -374,6 +373,7 @@ static void save_afhi(struct afh_info *afhi, char *buf)
 	sprintf(p, "%s", afhi->tags.comment);
 }
 
+/* does not load the chunk table */
 static void load_afhi(const char *buf, struct afh_info *afhi)
 {
 	afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
@@ -528,7 +528,7 @@ static 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.
  *
- * The result is a pointer to mmapped data. The caller must not attempt
+ * The result is a pointer to memory-mapped data. The caller must not attempt
  * to free it.
  *
  * \return Standard.
@@ -538,10 +538,12 @@ int get_audio_file_path_of_row(const struct osl_row *row, char **path)
 	struct osl_object path_obj;
 	int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_PATH,
 		&path_obj));
+
 	if (ret < 0)
-		return ret;
-	*path = path_obj.data;
-	return 1;
+		*path = NULL;
+	else
+		*path = path_obj.data;
+	return ret;
 }
 
 /**
@@ -552,7 +554,7 @@ int get_audio_file_path_of_row(const struct osl_row *row, char **path)
  *
  * \return The return value of the underlying call to osl_get_object().
  *
- * \sa get_hash_of_row().
+ * \sa \ref get_hash_of_row().
  */
 static int get_hash_object_of_aft_row(const struct osl_row *row,
 		struct osl_object *obj)
@@ -589,6 +591,10 @@ static int get_hash_of_row(const struct osl_row *row, unsigned char **hash)
  * \param afhi Result pointer.
  *
  * \return The return value of the underlying call to osl_get_object().
+ *
+ * After the call the members of the afhi structure point to mapped memory
+ * which is owned by the osl table, Hence the caller must not attempt to free
+ * this memory by calling \ref clear_afhi().
  */
 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
 {
@@ -692,7 +698,7 @@ static int get_local_time(uint64_t *seconds, char *buf, size_t size,
 	/*
 	 * If the given time is more than six month away from the current time,
 	 * we print only the year. The additional space character in the format
-	 * string below makes the formated date align nicely with dates that
+	 * string below makes the formatted date align nicely with dates that
 	 * contain the time (those written by the above strftime() statement).
 	 */
 	if (!strftime(buf, size, "%b %e  %Y", tm))
@@ -746,11 +752,11 @@ static int write_attribute_items(struct para_buffer *b,
 	char *att_text;
 	int ret;
 
-	WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_BITMAP, "%s\n", att_bitmap);
+	WRITE_STATUS_ITEM(b, SI_attributes_bitmap, "%s\n", att_bitmap);
 	ret = get_attribute_text(&afsi->attributes, " ", &att_text);
 	if (ret < 0)
 		return ret;
-	WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_TXT, "%s\n", att_text);
+	WRITE_STATUS_ITEM(b, SI_attributes_txt, "%s\n", att_text);
 	free(att_text);
 	return ret;
 }
@@ -759,9 +765,9 @@ static void write_lyrics_items(struct para_buffer *b, struct afs_info *afsi)
 {
 	char *lyrics_name;
 
-	WRITE_STATUS_ITEM(b, SI_LYRICS_ID, "%u\n", afsi->lyrics_id);
+	WRITE_STATUS_ITEM(b, SI_lyrics_id, "%u\n", afsi->lyrics_id);
 	lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
-	WRITE_STATUS_ITEM(b, SI_LYRICS_NAME, "%s\n", lyrics_name?
+	WRITE_STATUS_ITEM(b, SI_lyrics_name, "%s\n", lyrics_name?
 		lyrics_name : "(none)");
 }
 
@@ -769,9 +775,9 @@ static void write_image_items(struct para_buffer *b, struct afs_info *afsi)
 {
 	char *image_name;
 
-	WRITE_STATUS_ITEM(b, SI_IMAGE_ID, "%u\n", afsi->image_id);
+	WRITE_STATUS_ITEM(b, SI_image_id, "%u\n", afsi->image_id);
 	img_get_name_by_id(afsi->image_id, &image_name);
-	WRITE_STATUS_ITEM(b, SI_IMAGE_NAME, "%s\n", image_name?
+	WRITE_STATUS_ITEM(b, SI_image_name, "%s\n", image_name?
 		image_name : "(none)");
 }
 
@@ -781,14 +787,14 @@ static void write_filename_items(struct para_buffer *b, const char *path,
 	char *val;
 
 	if (basename) {
-		WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", path);
+		WRITE_STATUS_ITEM(b, SI_basename, "%s\n", path);
 		return;
 	}
-	WRITE_STATUS_ITEM(b, SI_PATH, "%s\n", path);
+	WRITE_STATUS_ITEM(b, SI_path, "%s\n", path);
 	val = para_basename(path);
-	WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", val? val : "");
+	WRITE_STATUS_ITEM(b, SI_basename, "%s\n", val? val : "");
 	val = para_dirname(path);
-	WRITE_STATUS_ITEM(b, SI_DIRECTORY, "%s\n", val? val : "");
+	WRITE_STATUS_ITEM(b, SI_directory, "%s\n", val? val : "");
 	free(val);
 }
 
@@ -905,36 +911,36 @@ static int print_list_item(struct ls_data *d, struct ls_options *opts,
 	}
 	write_filename_items(b, d->path, lls_opt_given(r_b));
 	if (lls_opt_given(r_a))
-		WRITE_STATUS_ITEM(b, SI_SCORE, "%li\n", d->score);
+		WRITE_STATUS_ITEM(b, SI_score, "%li\n", d->score);
 	ret = write_attribute_items(b, att_buf, afsi);
 	if (ret < 0)
 		goto out;
 	write_image_items(b, afsi);
 	write_lyrics_items(b, afsi);
 	hash_to_asc(d->hash, asc_hash);
-	WRITE_STATUS_ITEM(b, SI_HASH, "%s\n", asc_hash);
-	WRITE_STATUS_ITEM(b, SI_BITRATE, "%dkbit/s\n", afhi->bitrate);
-	WRITE_STATUS_ITEM(b, SI_FORMAT, "%s\n",
+	WRITE_STATUS_ITEM(b, SI_hash, "%s\n", asc_hash);
+	WRITE_STATUS_ITEM(b, SI_bitrate, "%dkbit/s\n", afhi->bitrate);
+	WRITE_STATUS_ITEM(b, SI_format, "%s\n",
 		audio_format_name(afsi->audio_format_id));
-	WRITE_STATUS_ITEM(b, SI_FREQUENCY, "%dHz\n", afhi->frequency);
-	WRITE_STATUS_ITEM(b, SI_CHANNELS, "%d\n", afhi->channels);
-	WRITE_STATUS_ITEM(b, SI_DURATION, "%s\n", duration_buf);
-	WRITE_STATUS_ITEM(b, SI_SECONDS_TOTAL, "%" PRIu32 "\n",
+	WRITE_STATUS_ITEM(b, SI_frequency, "%dHz\n", afhi->frequency);
+	WRITE_STATUS_ITEM(b, SI_channels, "%d\n", afhi->channels);
+	WRITE_STATUS_ITEM(b, SI_duration, "%s\n", duration_buf);
+	WRITE_STATUS_ITEM(b, SI_seconds_total, "%" PRIu32 "\n",
 		afhi->seconds_total);
-	WRITE_STATUS_ITEM(b, SI_LAST_PLAYED, "%s\n", last_played_time);
-	WRITE_STATUS_ITEM(b, SI_NUM_PLAYED, "%u\n", afsi->num_played);
-	WRITE_STATUS_ITEM(b, SI_AMPLIFICATION, "%u\n", afsi->amp);
-	WRITE_STATUS_ITEM(b, SI_CHUNK_TIME, "%lu\n", tv2ms(&afhi->chunk_tv));
-	WRITE_STATUS_ITEM(b, SI_NUM_CHUNKS, "%" PRIu32 "\n",
+	WRITE_STATUS_ITEM(b, SI_last_played, "%s\n", last_played_time);
+	WRITE_STATUS_ITEM(b, SI_num_played, "%u\n", afsi->num_played);
+	WRITE_STATUS_ITEM(b, SI_amplification, "%u\n", afsi->amp);
+	WRITE_STATUS_ITEM(b, SI_chunk_time, "%lu\n", tv2ms(&afhi->chunk_tv));
+	WRITE_STATUS_ITEM(b, SI_num_chunks, "%" PRIu32 "\n",
 		afhi->chunks_total);
-	WRITE_STATUS_ITEM(b, SI_MAX_CHUNK_SIZE, "%" PRIu32 "\n",
+	WRITE_STATUS_ITEM(b, SI_max_chunk_size, "%" PRIu32 "\n",
 		afhi->max_chunk_size);
-	WRITE_STATUS_ITEM(b, SI_TECHINFO, "%s\n", afhi->techinfo);
-	WRITE_STATUS_ITEM(b, SI_ARTIST, "%s\n", afhi->tags.artist);
-	WRITE_STATUS_ITEM(b, SI_TITLE, "%s\n", afhi->tags.title);
-	WRITE_STATUS_ITEM(b, SI_YEAR, "%s\n", afhi->tags.year);
-	WRITE_STATUS_ITEM(b, SI_ALBUM, "%s\n", afhi->tags.album);
-	WRITE_STATUS_ITEM(b, SI_COMMENT, "%s\n", afhi->tags.comment);
+	WRITE_STATUS_ITEM(b, SI_techinfo, "%s\n", afhi->techinfo);
+	WRITE_STATUS_ITEM(b, SI_artist, "%s\n", afhi->tags.artist);
+	WRITE_STATUS_ITEM(b, SI_title, "%s\n", afhi->tags.title);
+	WRITE_STATUS_ITEM(b, SI_year, "%s\n", afhi->tags.year);
+	WRITE_STATUS_ITEM(b, SI_album, "%s\n", afhi->tags.album);
+	WRITE_STATUS_ITEM(b, SI_comment, "%s\n", afhi->tags.comment);
 	if (opts->mode == LS_MODE_MBOX) {
 		struct osl_object lyrics_def;
 		lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
@@ -968,8 +974,8 @@ static void make_inode_status_items(struct para_buffer *pb)
 	ret = strftime(mtime_str, 29, "%b %d %Y", &mtime_tm);
 	assert(ret > 0); /* number of bytes placed in mtime_str */
 out:
-	WRITE_STATUS_ITEM(pb, SI_MTIME, "%s\n", mtime_str);
-	WRITE_STATUS_ITEM(pb, SI_FILE_SIZE, "%ld\n", statbuf.st_size / 1024);
+	WRITE_STATUS_ITEM(pb, SI_mtime, "%s\n", mtime_str);
+	WRITE_STATUS_ITEM(pb, SI_file_size, "%ld\n", statbuf.st_size / 1024);
 }
 
 static int make_status_items(void)
@@ -981,6 +987,8 @@ static int make_status_items(void)
 	time_t current_time;
 	int ret;
 
+	if (!status_item_ls_data.path) /* no audio file open */
+		return 0;
 	ret = lls_parse(ARRAY_SIZE(argv), argv, cmd, &opts.lpr, NULL);
 	assert(ret >= 0);
 	time(&current_time);
@@ -1102,6 +1110,12 @@ out:
 	return ret;
 }
 
+static int ls_hash_compare(const void *a, const void *b)
+{
+	struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
+	return memcmp(d1->hash, d2->hash, HASH_SIZE);
+}
+
 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;
@@ -1219,6 +1233,8 @@ static int sort_matching_paths(struct ls_options *options)
 		compar = ls_duration_compare; break;
 	case LS_SORT_BY_AUDIO_FORMAT:
 		compar = ls_audio_format_compare; break;
+	case LS_SORT_BY_HASH:
+		compar = ls_hash_compare; break;
 	default:
 		return -E_BAD_SORT;
 	}
@@ -1367,7 +1383,6 @@ out:
 	return ret;
 }
 
-/* TODO: flags -h (sort by hash) */
 static int com_ls(struct command_context *cc, struct lls_parse_result *lpr)
 {
 	const struct lls_command *cmd = SERVER_CMD_CMD_PTR(LS);
@@ -1433,6 +1448,8 @@ static int com_ls(struct command_context *cc, struct lls_parse_result *lpr)
 			opts->sorting = LS_SORT_BY_DURATION;
 		else if (!strcmp(val, "a") || !strcmp(val, "audio-format"))
 			opts->sorting = LS_SORT_BY_AUDIO_FORMAT;
+		else if (!strcmp(val, "h") || !strcmp(val, "hash"))
+			opts->sorting = LS_SORT_BY_HASH;
 		else {
 			ret = -E_AFT_SYNTAX;
 			goto out;
@@ -2459,7 +2476,7 @@ int aft_check_attributes(uint64_t att_mask, struct para_buffer *pb)
  *
  * \param flags Usual flags that are passed to osl_close_table().
  *
- * \sa osl_close_table().
+ * \sa \ref osl_close_table().
  */
 static void aft_close(void)
 {
@@ -2474,7 +2491,7 @@ static void aft_close(void)
  *
  * \return Standard.
  *
- * \sa osl_open_table().
+ * \sa \ref osl_open_table().
  */
 static int aft_open(const char *dir)
 {
@@ -2550,6 +2567,17 @@ static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
 			return ret;
 		make_status_items();
 		return 1;
+	}
+	case BLOB_RENAME:
+	case BLOB_REMOVE:
+	case BLOB_ADD: {
+		/*
+		 * These events are rare. We don't bother to check whether the
+		 * current status items are affected and simply recreate them
+		 * every time.
+		 */
+		make_status_items();
+		return 0;
 	} default:
 		return 0;
 	}