1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package com.google.common.net;
18
19 import static com.google.common.base.CharMatcher.ASCII;
20 import static com.google.common.base.CharMatcher.JAVA_ISO_CONTROL;
21 import static com.google.common.base.Charsets.UTF_8;
22 import static com.google.common.base.Preconditions.checkArgument;
23 import static com.google.common.base.Preconditions.checkNotNull;
24 import static com.google.common.base.Preconditions.checkState;
25
26 import com.google.common.annotations.Beta;
27 import com.google.common.annotations.GwtCompatible;
28 import com.google.common.base.Ascii;
29 import com.google.common.base.CharMatcher;
30 import com.google.common.base.Function;
31 import com.google.common.base.Joiner;
32 import com.google.common.base.Joiner.MapJoiner;
33 import com.google.common.base.Objects;
34 import com.google.common.base.Optional;
35 import com.google.common.collect.ImmutableListMultimap;
36 import com.google.common.collect.ImmutableMultiset;
37 import com.google.common.collect.ImmutableSet;
38 import com.google.common.collect.Iterables;
39 import com.google.common.collect.Maps;
40 import com.google.common.collect.Multimap;
41 import com.google.common.collect.Multimaps;
42
43 import java.nio.charset.Charset;
44 import java.nio.charset.IllegalCharsetNameException;
45 import java.nio.charset.UnsupportedCharsetException;
46 import java.util.Collection;
47 import java.util.Map;
48 import java.util.Map.Entry;
49
50 import javax.annotation.Nullable;
51 import javax.annotation.concurrent.Immutable;
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79 @Beta
80 @GwtCompatible
81 @Immutable
82 public final class MediaType {
83 private static final String CHARSET_ATTRIBUTE = "charset";
84 private static final ImmutableListMultimap<String, String> UTF_8_CONSTANT_PARAMETERS =
85 ImmutableListMultimap.of(CHARSET_ATTRIBUTE, Ascii.toLowerCase(UTF_8.name()));
86
87
88 private static final CharMatcher TOKEN_MATCHER = ASCII.and(JAVA_ISO_CONTROL.negate())
89 .and(CharMatcher.isNot(' '))
90 .and(CharMatcher.noneOf("()<>@,;:\\\"/[]?="));
91 private static final CharMatcher QUOTED_TEXT_MATCHER = ASCII
92 .and(CharMatcher.noneOf("\"\\\r"));
93
94
95
96
97 private static final CharMatcher LINEAR_WHITE_SPACE = CharMatcher.anyOf(" \t\r\n");
98
99
100 private static final String APPLICATION_TYPE = "application";
101 private static final String AUDIO_TYPE = "audio";
102 private static final String IMAGE_TYPE = "image";
103 private static final String TEXT_TYPE = "text";
104 private static final String VIDEO_TYPE = "video";
105
106 private static final String WILDCARD = "*";
107
108 private static final Map<MediaType, MediaType> KNOWN_TYPES = Maps.newHashMap();
109
110 private static MediaType createConstant(String type, String subtype) {
111 return addKnownType(new MediaType(type, subtype, ImmutableListMultimap.<String, String>of()));
112 }
113
114 private static MediaType createConstantUtf8(String type, String subtype) {
115 return addKnownType(new MediaType(type, subtype, UTF_8_CONSTANT_PARAMETERS));
116 }
117
118 private static MediaType addKnownType(MediaType mediaType) {
119 KNOWN_TYPES.put(mediaType, mediaType);
120 return mediaType;
121 }
122
123
124
125
126
127
128
129
130
131
132
133 public static final MediaType ANY_TYPE = createConstant(WILDCARD, WILDCARD);
134 public static final MediaType ANY_TEXT_TYPE = createConstant(TEXT_TYPE, WILDCARD);
135 public static final MediaType ANY_IMAGE_TYPE = createConstant(IMAGE_TYPE, WILDCARD);
136 public static final MediaType ANY_AUDIO_TYPE = createConstant(AUDIO_TYPE, WILDCARD);
137 public static final MediaType ANY_VIDEO_TYPE = createConstant(VIDEO_TYPE, WILDCARD);
138 public static final MediaType ANY_APPLICATION_TYPE = createConstant(APPLICATION_TYPE, WILDCARD);
139
140
141 public static final MediaType CACHE_MANIFEST_UTF_8 =
142 createConstantUtf8(TEXT_TYPE, "cache-manifest");
143 public static final MediaType CSS_UTF_8 = createConstantUtf8(TEXT_TYPE, "css");
144 public static final MediaType CSV_UTF_8 = createConstantUtf8(TEXT_TYPE, "csv");
145 public static final MediaType HTML_UTF_8 = createConstantUtf8(TEXT_TYPE, "html");
146 public static final MediaType I_CALENDAR_UTF_8 = createConstantUtf8(TEXT_TYPE, "calendar");
147 public static final MediaType PLAIN_TEXT_UTF_8 = createConstantUtf8(TEXT_TYPE, "plain");
148
149
150
151
152
153 public static final MediaType TEXT_JAVASCRIPT_UTF_8 = createConstantUtf8(TEXT_TYPE, "javascript");
154
155
156
157
158
159
160 public static final MediaType TSV_UTF_8 = createConstantUtf8(TEXT_TYPE, "tab-separated-values");
161 public static final MediaType VCARD_UTF_8 = createConstantUtf8(TEXT_TYPE, "vcard");
162 public static final MediaType WML_UTF_8 = createConstantUtf8(TEXT_TYPE, "vnd.wap.wml");
163
164
165
166
167
168 public static final MediaType XML_UTF_8 = createConstantUtf8(TEXT_TYPE, "xml");
169
170
171 public static final MediaType BMP = createConstant(IMAGE_TYPE, "bmp");
172
173
174
175
176
177
178
179
180
181 public static final MediaType CRW = createConstant(IMAGE_TYPE, "x-canon-crw");
182 public static final MediaType GIF = createConstant(IMAGE_TYPE, "gif");
183 public static final MediaType ICO = createConstant(IMAGE_TYPE, "vnd.microsoft.icon");
184 public static final MediaType JPEG = createConstant(IMAGE_TYPE, "jpeg");
185 public static final MediaType PNG = createConstant(IMAGE_TYPE, "png");
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202 public static final MediaType PSD = createConstant(IMAGE_TYPE, "vnd.adobe.photoshop");
203 public static final MediaType SVG_UTF_8 = createConstantUtf8(IMAGE_TYPE, "svg+xml");
204 public static final MediaType TIFF = createConstant(IMAGE_TYPE, "tiff");
205 public static final MediaType WEBP = createConstant(IMAGE_TYPE, "webp");
206
207
208 public static final MediaType MP4_AUDIO = createConstant(AUDIO_TYPE, "mp4");
209 public static final MediaType MPEG_AUDIO = createConstant(AUDIO_TYPE, "mpeg");
210 public static final MediaType OGG_AUDIO = createConstant(AUDIO_TYPE, "ogg");
211 public static final MediaType WEBM_AUDIO = createConstant(AUDIO_TYPE, "webm");
212
213
214 public static final MediaType MP4_VIDEO = createConstant(VIDEO_TYPE, "mp4");
215 public static final MediaType MPEG_VIDEO = createConstant(VIDEO_TYPE, "mpeg");
216 public static final MediaType OGG_VIDEO = createConstant(VIDEO_TYPE, "ogg");
217 public static final MediaType QUICKTIME = createConstant(VIDEO_TYPE, "quicktime");
218 public static final MediaType WEBM_VIDEO = createConstant(VIDEO_TYPE, "webm");
219 public static final MediaType WMV = createConstant(VIDEO_TYPE, "x-ms-wmv");
220
221
222
223
224
225
226
227 public static final MediaType APPLICATION_XML_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "xml");
228 public static final MediaType ATOM_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "atom+xml");
229 public static final MediaType BZIP2 = createConstant(APPLICATION_TYPE, "x-bzip2");
230
231
232
233
234
235
236
237
238 public static final MediaType EOT = createConstant(APPLICATION_TYPE, "vnd.ms-fontobject");
239
240
241
242
243
244
245
246
247
248 public static final MediaType EPUB = createConstant(APPLICATION_TYPE, "epub+zip");
249 public static final MediaType FORM_DATA = createConstant(APPLICATION_TYPE,
250 "x-www-form-urlencoded");
251
252
253
254
255
256
257
258 public static final MediaType KEY_ARCHIVE = createConstant(APPLICATION_TYPE, "pkcs12");
259
260
261
262
263
264
265
266
267
268
269
270 public static final MediaType APPLICATION_BINARY = createConstant(APPLICATION_TYPE, "binary");
271 public static final MediaType GZIP = createConstant(APPLICATION_TYPE, "x-gzip");
272
273
274
275
276
277 public static final MediaType JAVASCRIPT_UTF_8 =
278 createConstantUtf8(APPLICATION_TYPE, "javascript");
279 public static final MediaType JSON_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "json");
280 public static final MediaType KML = createConstant(APPLICATION_TYPE, "vnd.google-earth.kml+xml");
281 public static final MediaType KMZ = createConstant(APPLICATION_TYPE, "vnd.google-earth.kmz");
282 public static final MediaType MBOX = createConstant(APPLICATION_TYPE, "mbox");
283 public static final MediaType MICROSOFT_EXCEL = createConstant(APPLICATION_TYPE, "vnd.ms-excel");
284 public static final MediaType MICROSOFT_POWERPOINT =
285 createConstant(APPLICATION_TYPE, "vnd.ms-powerpoint");
286 public static final MediaType MICROSOFT_WORD = createConstant(APPLICATION_TYPE, "msword");
287 public static final MediaType OCTET_STREAM = createConstant(APPLICATION_TYPE, "octet-stream");
288 public static final MediaType OGG_CONTAINER = createConstant(APPLICATION_TYPE, "ogg");
289 public static final MediaType OOXML_DOCUMENT = createConstant(APPLICATION_TYPE,
290 "vnd.openxmlformats-officedocument.wordprocessingml.document");
291 public static final MediaType OOXML_PRESENTATION = createConstant(APPLICATION_TYPE,
292 "vnd.openxmlformats-officedocument.presentationml.presentation");
293 public static final MediaType OOXML_SHEET =
294 createConstant(APPLICATION_TYPE, "vnd.openxmlformats-officedocument.spreadsheetml.sheet");
295 public static final MediaType OPENDOCUMENT_GRAPHICS =
296 createConstant(APPLICATION_TYPE, "vnd.oasis.opendocument.graphics");
297 public static final MediaType OPENDOCUMENT_PRESENTATION =
298 createConstant(APPLICATION_TYPE, "vnd.oasis.opendocument.presentation");
299 public static final MediaType OPENDOCUMENT_SPREADSHEET =
300 createConstant(APPLICATION_TYPE, "vnd.oasis.opendocument.spreadsheet");
301 public static final MediaType OPENDOCUMENT_TEXT =
302 createConstant(APPLICATION_TYPE, "vnd.oasis.opendocument.text");
303 public static final MediaType PDF = createConstant(APPLICATION_TYPE, "pdf");
304 public static final MediaType POSTSCRIPT = createConstant(APPLICATION_TYPE, "postscript");
305
306
307
308
309
310 public static final MediaType PROTOBUF = createConstant(APPLICATION_TYPE, "protobuf");
311 public static final MediaType RDF_XML_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "rdf+xml");
312 public static final MediaType RTF_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "rtf");
313
314
315
316
317
318
319
320
321
322 public static final MediaType SFNT = createConstant(APPLICATION_TYPE, "font-sfnt");
323 public static final MediaType SHOCKWAVE_FLASH = createConstant(APPLICATION_TYPE,
324 "x-shockwave-flash");
325 public static final MediaType SKETCHUP = createConstant(APPLICATION_TYPE, "vnd.sketchup.skp");
326 public static final MediaType TAR = createConstant(APPLICATION_TYPE, "x-tar");
327
328
329
330
331
332
333
334
335
336 public static final MediaType WOFF = createConstant(APPLICATION_TYPE, "font-woff");
337 public static final MediaType XHTML_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "xhtml+xml");
338
339
340
341
342
343
344
345 public static final MediaType XRD_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "xrd+xml");
346 public static final MediaType ZIP = createConstant(APPLICATION_TYPE, "zip");
347
348 private final String type;
349 private final String subtype;
350 private final ImmutableListMultimap<String, String> parameters;
351
352 private MediaType(String type, String subtype,
353 ImmutableListMultimap<String, String> parameters) {
354 this.type = type;
355 this.subtype = subtype;
356 this.parameters = parameters;
357 }
358
359
360 public String type() {
361 return type;
362 }
363
364
365 public String subtype() {
366 return subtype;
367 }
368
369
370 public ImmutableListMultimap<String, String> parameters() {
371 return parameters;
372 }
373
374 private Map<String, ImmutableMultiset<String>> parametersAsMap() {
375 return Maps.transformValues(parameters.asMap(),
376 new Function<Collection<String>, ImmutableMultiset<String>>() {
377 @Override public ImmutableMultiset<String> apply(Collection<String> input) {
378 return ImmutableMultiset.copyOf(input);
379 }
380 });
381 }
382
383
384
385
386
387
388
389
390
391 public Optional<Charset> charset() {
392 ImmutableSet<String> charsetValues = ImmutableSet.copyOf(parameters.get(CHARSET_ATTRIBUTE));
393 switch (charsetValues.size()) {
394 case 0:
395 return Optional.absent();
396 case 1:
397 return Optional.of(Charset.forName(Iterables.getOnlyElement(charsetValues)));
398 default:
399 throw new IllegalStateException("Multiple charset values defined: " + charsetValues);
400 }
401 }
402
403
404
405
406
407 public MediaType withoutParameters() {
408 return parameters.isEmpty() ? this : create(type, subtype);
409 }
410
411
412
413
414
415
416 public MediaType withParameters(Multimap<String, String> parameters) {
417 return create(type, subtype, parameters);
418 }
419
420
421
422
423
424
425
426
427
428 public MediaType withParameter(String attribute, String value) {
429 checkNotNull(attribute);
430 checkNotNull(value);
431 String normalizedAttribute = normalizeToken(attribute);
432 ImmutableListMultimap.Builder<String, String> builder = ImmutableListMultimap.builder();
433 for (Entry<String, String> entry : parameters.entries()) {
434 String key = entry.getKey();
435 if (!normalizedAttribute.equals(key)) {
436 builder.put(key, entry.getValue());
437 }
438 }
439 builder.put(normalizedAttribute, normalizeParameterValue(normalizedAttribute, value));
440 MediaType mediaType = new MediaType(type, subtype, builder.build());
441
442 return Objects.firstNonNull(KNOWN_TYPES.get(mediaType), mediaType);
443 }
444
445
446
447
448
449
450
451
452
453
454 public MediaType withCharset(Charset charset) {
455 checkNotNull(charset);
456 return withParameter(CHARSET_ATTRIBUTE, charset.name());
457 }
458
459
460 public boolean hasWildcard() {
461 return WILDCARD.equals(type) || WILDCARD.equals(subtype);
462 }
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490 public boolean is(MediaType mediaTypeRange) {
491 return (mediaTypeRange.type.equals(WILDCARD) || mediaTypeRange.type.equals(this.type))
492 && (mediaTypeRange.subtype.equals(WILDCARD) || mediaTypeRange.subtype.equals(this.subtype))
493 && this.parameters.entries().containsAll(mediaTypeRange.parameters.entries());
494 }
495
496
497
498
499
500
501
502 public static MediaType create(String type, String subtype) {
503 return create(type, subtype, ImmutableListMultimap.<String, String>of());
504 }
505
506
507
508
509
510
511 static MediaType createApplicationType(String subtype) {
512 return create(APPLICATION_TYPE, subtype);
513 }
514
515
516
517
518
519
520 static MediaType createAudioType(String subtype) {
521 return create(AUDIO_TYPE, subtype);
522 }
523
524
525
526
527
528
529 static MediaType createImageType(String subtype) {
530 return create(IMAGE_TYPE, subtype);
531 }
532
533
534
535
536
537
538 static MediaType createTextType(String subtype) {
539 return create(TEXT_TYPE, subtype);
540 }
541
542
543
544
545
546
547 static MediaType createVideoType(String subtype) {
548 return create(VIDEO_TYPE, subtype);
549 }
550
551 private static MediaType create(String type, String subtype,
552 Multimap<String, String> parameters) {
553 checkNotNull(type);
554 checkNotNull(subtype);
555 checkNotNull(parameters);
556 String normalizedType = normalizeToken(type);
557 String normalizedSubtype = normalizeToken(subtype);
558 checkArgument(!WILDCARD.equals(normalizedType) || WILDCARD.equals(normalizedSubtype),
559 "A wildcard type cannot be used with a non-wildcard subtype");
560 ImmutableListMultimap.Builder<String, String> builder = ImmutableListMultimap.builder();
561 for (Entry<String, String> entry : parameters.entries()) {
562 String attribute = normalizeToken(entry.getKey());
563 builder.put(attribute, normalizeParameterValue(attribute, entry.getValue()));
564 }
565 MediaType mediaType = new MediaType(normalizedType, normalizedSubtype, builder.build());
566
567 return Objects.firstNonNull(KNOWN_TYPES.get(mediaType), mediaType);
568 }
569
570 private static String normalizeToken(String token) {
571 checkArgument(TOKEN_MATCHER.matchesAllOf(token));
572 return Ascii.toLowerCase(token);
573 }
574
575 private static String normalizeParameterValue(String attribute, String value) {
576 return CHARSET_ATTRIBUTE.equals(attribute) ? Ascii.toLowerCase(value) : value;
577 }
578
579
580
581
582
583
584 public static MediaType parse(String input) {
585 checkNotNull(input);
586 Tokenizer tokenizer = new Tokenizer(input);
587 try {
588 String type = tokenizer.consumeToken(TOKEN_MATCHER);
589 tokenizer.consumeCharacter('/');
590 String subtype = tokenizer.consumeToken(TOKEN_MATCHER);
591 ImmutableListMultimap.Builder<String, String> parameters = ImmutableListMultimap.builder();
592 while (tokenizer.hasMore()) {
593 tokenizer.consumeCharacter(';');
594 tokenizer.consumeTokenIfPresent(LINEAR_WHITE_SPACE);
595 String attribute = tokenizer.consumeToken(TOKEN_MATCHER);
596 tokenizer.consumeCharacter('=');
597 final String value;
598 if ('"' == tokenizer.previewChar()) {
599 tokenizer.consumeCharacter('"');
600 StringBuilder valueBuilder = new StringBuilder();
601 while ('"' != tokenizer.previewChar()) {
602 if ('\\' == tokenizer.previewChar()) {
603 tokenizer.consumeCharacter('\\');
604 valueBuilder.append(tokenizer.consumeCharacter(ASCII));
605 } else {
606 valueBuilder.append(tokenizer.consumeToken(QUOTED_TEXT_MATCHER));
607 }
608 }
609 value = valueBuilder.toString();
610 tokenizer.consumeCharacter('"');
611 } else {
612 value = tokenizer.consumeToken(TOKEN_MATCHER);
613 }
614 parameters.put(attribute, value);
615 }
616 return create(type, subtype, parameters.build());
617 } catch (IllegalStateException e) {
618 throw new IllegalArgumentException("Could not parse '" + input + "'", e);
619 }
620 }
621
622 private static final class Tokenizer {
623 final String input;
624 int position = 0;
625
626 Tokenizer(String input) {
627 this.input = input;
628 }
629
630 String consumeTokenIfPresent(CharMatcher matcher) {
631 checkState(hasMore());
632 int startPosition = position;
633 position = matcher.negate().indexIn(input, startPosition);
634 return hasMore() ? input.substring(startPosition, position) : input.substring(startPosition);
635 }
636
637 String consumeToken(CharMatcher matcher) {
638 int startPosition = position;
639 String token = consumeTokenIfPresent(matcher);
640 checkState(position != startPosition);
641 return token;
642 }
643
644 char consumeCharacter(CharMatcher matcher) {
645 checkState(hasMore());
646 char c = previewChar();
647 checkState(matcher.matches(c));
648 position++;
649 return c;
650 }
651
652 char consumeCharacter(char c) {
653 checkState(hasMore());
654 checkState(previewChar() == c);
655 position++;
656 return c;
657 }
658
659 char previewChar() {
660 checkState(hasMore());
661 return input.charAt(position);
662 }
663
664 boolean hasMore() {
665 return (position >= 0) && (position < input.length());
666 }
667 }
668
669 @Override public boolean equals(@Nullable Object obj) {
670 if (obj == this) {
671 return true;
672 } else if (obj instanceof MediaType) {
673 MediaType that = (MediaType) obj;
674 return this.type.equals(that.type)
675 && this.subtype.equals(that.subtype)
676
677 && this.parametersAsMap().equals(that.parametersAsMap());
678 } else {
679 return false;
680 }
681 }
682
683 @Override public int hashCode() {
684 return Objects.hashCode(type, subtype, parametersAsMap());
685 }
686
687 private static final MapJoiner PARAMETER_JOINER = Joiner.on("; ").withKeyValueSeparator("=");
688
689
690
691
692
693 @Override public String toString() {
694 StringBuilder builder = new StringBuilder().append(type).append('/').append(subtype);
695 if (!parameters.isEmpty()) {
696 builder.append("; ");
697 Multimap<String, String> quotedParameters = Multimaps.transformValues(parameters,
698 new Function<String, String>() {
699 @Override public String apply(String value) {
700 return TOKEN_MATCHER.matchesAllOf(value) ? value : escapeAndQuote(value);
701 }
702 });
703 PARAMETER_JOINER.appendTo(builder, quotedParameters.entries());
704 }
705 return builder.toString();
706 }
707
708 private static String escapeAndQuote(String value) {
709 StringBuilder escaped = new StringBuilder(value.length() + 16).append('"');
710 for (char ch : value.toCharArray()) {
711 if (ch == '\r' || ch == '\\' || ch == '"') {
712 escaped.append('\\');
713 }
714 escaped.append(ch);
715 }
716 return escaped.append('"').toString();
717 }
718
719 }