Metaflac UTF-8 fixes (Windows)
[flac.git] / src / metaflac / operations_shorthand_vorbiscomment.c
1 /* metaflac - Command-line FLAC metadata editor
2  * Copyright (C) 2001,2002,2003,2004,2005,2006,2007,2008,2009  Josh Coalson
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17  */
18
19 #if HAVE_CONFIG_H
20 #  include <config.h>
21 #endif
22
23 #include "options.h"
24 #include "utils.h"
25 #include "FLAC/assert.h"
26 #include "share/grabbag.h" /* for grabbag__file_get_filesize() */
27 #include "share/utf8.h"
28 #include <errno.h>
29 #include <stdlib.h>
30 #include <string.h>
31 #include "operations_shorthand.h"
32 #include "share/compat.h"
33
34 static FLAC__bool remove_vc_all(const char *filename, FLAC__StreamMetadata *block, FLAC__bool *needs_write);
35 static FLAC__bool remove_vc_field(const char *filename, FLAC__StreamMetadata *block, const char *field_name, FLAC__bool *needs_write);
36 static FLAC__bool remove_vc_firstfield(const char *filename, FLAC__StreamMetadata *block, const char *field_name, FLAC__bool *needs_write);
37 static FLAC__bool set_vc_field(const char *filename, FLAC__StreamMetadata *block, const Argument_VcField *field, FLAC__bool *needs_write, FLAC__bool raw);
38 static FLAC__bool import_vc_from(const char *filename, FLAC__StreamMetadata *block, const Argument_String *vc_filename, FLAC__bool *needs_write, FLAC__bool raw);
39 static FLAC__bool export_vc_to(const char *filename, FLAC__StreamMetadata *block, const Argument_String *vc_filename, FLAC__bool raw);
40
41 FLAC__bool do_shorthand_operation__vorbis_comment(const char *filename, FLAC__bool prefix_with_filename, FLAC__Metadata_Chain *chain, const Operation *operation, FLAC__bool *needs_write, FLAC__bool raw)
42 {
43         FLAC__bool ok = true, found_vc_block = false;
44         FLAC__StreamMetadata *block = 0;
45         FLAC__Metadata_Iterator *iterator = FLAC__metadata_iterator_new();
46
47         if(0 == iterator)
48                 die("out of memory allocating iterator");
49
50         FLAC__metadata_iterator_init(iterator, chain);
51
52         do {
53                 block = FLAC__metadata_iterator_get_block(iterator);
54                 if(block->type == FLAC__METADATA_TYPE_VORBIS_COMMENT)
55                         found_vc_block = true;
56         } while(!found_vc_block && FLAC__metadata_iterator_next(iterator));
57
58         if(!found_vc_block) {
59                 /* create a new block if necessary */
60                 if(operation->type == OP__SET_VC_FIELD || operation->type == OP__IMPORT_VC_FROM) {
61                         block = FLAC__metadata_object_new(FLAC__METADATA_TYPE_VORBIS_COMMENT);
62                         if(0 == block)
63                                 die("out of memory allocating VORBIS_COMMENT block");
64                         while(FLAC__metadata_iterator_next(iterator))
65                                 ;
66                         if(!FLAC__metadata_iterator_insert_block_after(iterator, block)) {
67                                 print_error_with_chain_status(chain, "%s: ERROR: adding new VORBIS_COMMENT block to metadata", filename);
68                                 return false;
69                         }
70                         /* iterator is left pointing to new block */
71                         FLAC__ASSERT(FLAC__metadata_iterator_get_block(iterator) == block);
72                 }
73                 else {
74                         FLAC__metadata_iterator_delete(iterator);
75                         return ok;
76                 }
77         }
78
79         FLAC__ASSERT(0 != block);
80         FLAC__ASSERT(block->type == FLAC__METADATA_TYPE_VORBIS_COMMENT);
81
82         switch(operation->type) {
83                 case OP__SHOW_VC_VENDOR:
84                         write_vc_field(prefix_with_filename? filename : 0, &block->data.vorbis_comment.vendor_string, raw, stdout);
85                         break;
86                 case OP__SHOW_VC_FIELD:
87                         write_vc_fields(prefix_with_filename? filename : 0, operation->argument.vc_field_name.value, block->data.vorbis_comment.comments, block->data.vorbis_comment.num_comments, raw, stdout);
88                         break;
89                 case OP__REMOVE_VC_ALL:
90                         ok = remove_vc_all(filename, block, needs_write);
91                         break;
92                 case OP__REMOVE_VC_FIELD:
93                         ok = remove_vc_field(filename, block, operation->argument.vc_field_name.value, needs_write);
94                         break;
95                 case OP__REMOVE_VC_FIRSTFIELD:
96                         ok = remove_vc_firstfield(filename, block, operation->argument.vc_field_name.value, needs_write);
97                         break;
98                 case OP__SET_VC_FIELD:
99 #ifdef _WIN32 /* do not convert anything or things will break */
100                         ok = set_vc_field(filename, block, &operation->argument.vc_field, needs_write, true);
101 #else
102                         ok = set_vc_field(filename, block, &operation->argument.vc_field, needs_write, raw);
103 #endif
104                         break;
105                 case OP__IMPORT_VC_FROM:
106                         ok = import_vc_from(filename, block, &operation->argument.filename, needs_write, raw);
107                         break;
108                 case OP__EXPORT_VC_TO:
109                         ok = export_vc_to(filename, block, &operation->argument.filename, raw);
110                         break;
111                 default:
112                         ok = false;
113                         FLAC__ASSERT(0);
114                         break;
115         };
116
117         FLAC__metadata_iterator_delete(iterator);
118         return ok;
119 }
120
121 /*
122  * local routines
123  */
124
125 FLAC__bool remove_vc_all(const char *filename, FLAC__StreamMetadata *block, FLAC__bool *needs_write)
126 {
127         FLAC__ASSERT(0 != block);
128         FLAC__ASSERT(block->type == FLAC__METADATA_TYPE_VORBIS_COMMENT);
129         FLAC__ASSERT(0 != needs_write);
130
131         if(0 != block->data.vorbis_comment.comments) {
132                 FLAC__ASSERT(block->data.vorbis_comment.num_comments > 0);
133                 if(!FLAC__metadata_object_vorbiscomment_resize_comments(block, 0)) {
134                         flac_fprintf(stderr, "%s: ERROR: memory allocation failure\n", filename);
135                         return false;
136                 }
137                 *needs_write = true;
138         }
139         else {
140                 FLAC__ASSERT(block->data.vorbis_comment.num_comments == 0);
141         }
142
143         return true;
144 }
145
146 FLAC__bool remove_vc_field(const char *filename, FLAC__StreamMetadata *block, const char *field_name, FLAC__bool *needs_write)
147 {
148         int n;
149
150         FLAC__ASSERT(0 != needs_write);
151
152         n = FLAC__metadata_object_vorbiscomment_remove_entries_matching(block, field_name);
153
154         if(n < 0) {
155                 flac_fprintf(stderr, "%s: ERROR: memory allocation failure\n", filename);
156                 return false;
157         }
158         else if(n > 0)
159                 *needs_write = true;
160
161         return true;
162 }
163
164 FLAC__bool remove_vc_firstfield(const char *filename, FLAC__StreamMetadata *block, const char *field_name, FLAC__bool *needs_write)
165 {
166         int n;
167
168         FLAC__ASSERT(0 != needs_write);
169
170         n = FLAC__metadata_object_vorbiscomment_remove_entry_matching(block, field_name);
171
172         if(n < 0) {
173                 flac_fprintf(stderr, "%s: ERROR: memory allocation failure\n", filename);
174                 return false;
175         }
176         else if(n > 0)
177                 *needs_write = true;
178
179         return true;
180 }
181
182 FLAC__bool set_vc_field(const char *filename, FLAC__StreamMetadata *block, const Argument_VcField *field, FLAC__bool *needs_write, FLAC__bool raw)
183 {
184         FLAC__StreamMetadata_VorbisComment_Entry entry;
185         char *converted;
186
187         FLAC__ASSERT(0 != block);
188         FLAC__ASSERT(block->type == FLAC__METADATA_TYPE_VORBIS_COMMENT);
189         FLAC__ASSERT(0 != field);
190         FLAC__ASSERT(0 != needs_write);
191
192         if(field->field_value_from_file) {
193                 /* read the file into 'data' */
194                 FILE *f = 0;
195                 char *data = 0;
196                 const FLAC__off_t size = grabbag__file_get_filesize(field->field_value);
197                 if(size < 0) {
198                         flac_fprintf(stderr, "%s: ERROR: can't open file '%s' for '%s' tag value\n", filename, field->field_value, field->field_name);
199                         return false;
200                 }
201                 if(size >= 0x100000) { /* magic arbitrary limit, actual format limit is near 16MB */
202                         flac_fprintf(stderr, "%s: ERROR: file '%s' for '%s' tag value is too large\n", filename, field->field_value, field->field_name);
203                         return false;
204                 }
205                 if(0 == (data = malloc(size+1)))
206                         die("out of memory allocating tag value");
207                 data[size] = '\0';
208                 if(0 == (f = flac_fopen(field->field_value, "rb")) || fread(data, 1, size, f) != (size_t)size) {
209                         flac_fprintf(stderr, "%s: ERROR: while reading file '%s' for '%s' tag value: %s\n", filename, field->field_value, field->field_name, strerror(errno));
210                         free(data);
211                         if(f)
212                                 fclose(f);
213                         return false;
214                 }
215                 fclose(f);
216                 if(strlen(data) != (size_t)size) {
217                         free(data);
218                         flac_fprintf(stderr, "%s: ERROR: file '%s' for '%s' tag value has embedded NULs\n", filename, field->field_value, field->field_name);
219                         return false;
220                 }
221
222                 /* move 'data' into 'converted', converting to UTF-8 if necessary */
223                 if(raw) {
224                         converted = data;
225                 }
226                 else if(utf8_encode(data, &converted) >= 0) {
227                         free(data);
228                 }
229                 else {
230                         free(data);
231                         flac_fprintf(stderr, "%s: ERROR: converting file '%s' contents to UTF-8 for tag value\n", filename, field->field_value);
232                         return false;
233                 }
234
235                 /* create and entry and append it */
236                 if(!FLAC__metadata_object_vorbiscomment_entry_from_name_value_pair(&entry, field->field_name, converted)) {
237                         free(converted);
238                         flac_fprintf(stderr, "%s: ERROR: file '%s' for '%s' tag value is not valid UTF-8\n", filename, field->field_value, field->field_name);
239                         return false;
240                 }
241                 free(converted);
242                 if(!FLAC__metadata_object_vorbiscomment_append_comment(block, entry, /*copy=*/false)) {
243                         flac_fprintf(stderr, "%s: ERROR: memory allocation failure\n", filename);
244                         return false;
245                 }
246
247                 *needs_write = true;
248                 return true;
249         }
250         else {
251                 FLAC__bool needs_free = false;
252                 entry.entry = (FLAC__byte *)field->field;
253                 if(raw) {
254                         entry.entry = (FLAC__byte *)field->field;
255                 }
256                 else if(utf8_encode(field->field, &converted) >= 0) {
257                         entry.entry = (FLAC__byte *)converted;
258                         needs_free = true;
259                 }
260                 else {
261                         flac_fprintf(stderr, "%s: ERROR: converting comment '%s' to UTF-8\n", filename, field->field);
262                         return false;
263                 }
264                 entry.length = strlen((const char *)entry.entry);
265                 if(!FLAC__format_vorbiscomment_entry_is_legal(entry.entry, entry.length)) {
266                         if(needs_free)
267                                 free(converted);
268                         /*
269                          * our previous parsing has already established that the field
270                          * name is OK, so it must be the field value
271                          */
272                         flac_fprintf(stderr, "%s: ERROR: tag value for '%s' is not valid UTF-8\n", filename, field->field_name);
273                         return false;
274                 }
275
276                 if(!FLAC__metadata_object_vorbiscomment_append_comment(block, entry, /*copy=*/true)) {
277                         if(needs_free)
278                                 free(converted);
279                         flac_fprintf(stderr, "%s: ERROR: memory allocation failure\n", filename);
280                         return false;
281                 }
282
283                 *needs_write = true;
284                 if(needs_free)
285                         free(converted);
286                 return true;
287         }
288 }
289
290 FLAC__bool import_vc_from(const char *filename, FLAC__StreamMetadata *block, const Argument_String *vc_filename, FLAC__bool *needs_write, FLAC__bool raw)
291 {
292         FILE *f;
293         char line[65536];
294         FLAC__bool ret;
295
296         if(0 == vc_filename->value || strlen(vc_filename->value) == 0) {
297                 flac_fprintf(stderr, "%s: ERROR: empty import file name\n", filename);
298                 return false;
299         }
300         if(0 == strcmp(vc_filename->value, "-"))
301                 f = stdin;
302         else
303                 f = flac_fopen(vc_filename->value, "r");
304
305         if(0 == f) {
306                 flac_fprintf(stderr, "%s: ERROR: can't open import file %s: %s\n", filename, vc_filename->value, strerror(errno));
307                 return false;
308         }
309
310         ret = true;
311         while(ret && !feof(f) && fgets(line, sizeof(line), f) != NULL) {
312                 if(!feof(f)) {
313                         char *p = strchr(line, '\n');
314                         if(0 == p) {
315                                 flac_fprintf(stderr, "%s: ERROR: line too long, aborting\n", vc_filename->value);
316                                 ret = false;
317                         }
318                         else {
319                                 const char *violation;
320                                 Argument_VcField field;
321                                 *p = '\0';
322                                 memset(&field, 0, sizeof(Argument_VcField));
323                                 field.field_value_from_file = false;
324                                 if(!parse_vorbis_comment_field(line, &field.field, &field.field_name, &field.field_value, &field.field_value_length, &violation)) {
325                                         FLAC__ASSERT(0 != violation);
326                                         flac_fprintf(stderr, "%s: ERROR: malformed vorbis comment field \"%s\",\n       %s\n", vc_filename->value, line, violation);
327                                         ret = false;
328                                 }
329                                 else {
330                                         ret = set_vc_field(filename, block, &field, needs_write, raw);
331                                 }
332                                 if(0 != field.field)
333                                         free(field.field);
334                                 if(0 != field.field_name)
335                                         free(field.field_name);
336                                 if(0 != field.field_value)
337                                         free(field.field_value);
338                         }
339                 }
340         };
341
342         if(f != stdin)
343                 fclose(f);
344         return ret;
345 }
346
347 FLAC__bool export_vc_to(const char *filename, FLAC__StreamMetadata *block, const Argument_String *vc_filename, FLAC__bool raw)
348 {
349         FILE *f;
350         FLAC__bool ret;
351
352         if(0 == vc_filename->value || strlen(vc_filename->value) == 0) {
353                 flac_fprintf(stderr, "%s: ERROR: empty export file name\n", filename);
354                 return false;
355         }
356         if(0 == strcmp(vc_filename->value, "-"))
357                 f = stdout;
358         else
359                 f = flac_fopen(vc_filename->value, "w");
360
361         if(0 == f) {
362                 flac_fprintf(stderr, "%s: ERROR: can't open export file %s: %s\n", filename, vc_filename->value, strerror(errno));
363                 return false;
364         }
365
366         ret = true;
367
368         write_vc_fields(0, 0, block->data.vorbis_comment.comments, block->data.vorbis_comment.num_comments, raw, f);
369
370         if(f != stdout)
371                 fclose(f);
372         return ret;
373 }