Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/utils/lib/mime.js
blob: bbc22ff501032387ac6ca68c69484b614d58ed89 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/**
    This module provides basic functions for handling mime-types. It can
    handle matching mime-types against a list of media-ranges. See section
    14.1 of the HTTP specification [RFC 2616] for a complete explanation.
    
      <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1>
    
    A port to JavaScript of Joe Gregorio's MIME-Type Parser:
    
      <http://code.google.com/p/mimeparse/>
    
    Ported by J. Chris Anderson <jchris@apache.org>, targeting the Spidermonkey runtime.
    
    To run the tests, open mimeparse-js-test.html in a browser.
    Ported from version 0.1.2.
    Comments are mostly excerpted from the original.
*/

var util = require("util");

/*** parseMimeType
    Carves up a mime-type and returns an Array of the
    [type, subtype, params] where "params" is a Hash of all
    the parameters for the media range.

    For example, the media range "application/xhtml;q=0.5" would
    get parsed into::

        ["application", "xhtml", { "q" : "0.5" }]
*/
exports.parseMimeType = function (mimeType) {
    var fullType, typeParts, params = {}, parts = mimeType.split(';');
    for (var i=0; i < parts.length; i++) {
        var p = parts[i].split('=');
        if (p.length == 2) {
            params[util.trim(p[0])] = util.trim(p[1]);
        }
    };
    fullType = parts[0].replace(/^\s+/, '').replace(/\s+$/, '');
    if (fullType == '*') fullType = '*/*';
    typeParts = fullType.split('/');
    return [typeParts[0], typeParts[1], params];
};

/*** parseMediaRange
    Carves up a media range and returns an Array of the
    [type, subtype, params] where "params" is a Object with
    all the parameters for the media range.
    
    For example, the media range "application/*;q=0.5" would
    get parsed into::
    
        ["application", "*", { "q" : "0.5" }]
    
    In addition this function also guarantees that there
    is a value for "q" in the params dictionary, filling it
    in with a proper default if necessary.
*/
exports.parseMediaRange = function (range) {
    var q, parsedType = exports.parseMimeType(range);
    if (!parsedType[2]['q']) {
        parsedType[2]['q'] = '1';
    } else {
        q = parseFloat(parsedType[2]['q']);
        if (isNaN(q)) {
            parsedType[2]['q'] = '1';
        } else if (q > 1 || q < 0) {
            parsedType[2]['q'] = '1';
        }
    }
    return parsedType;
};

/*** fitnessAndQualityParsed
    Find the best match for a given mime-type against
    a list of media_ranges that have already been
    parsed by parseMediaRange(). Returns an array of
    the fitness value and the value of the 'q' quality
    parameter of the best match, or (-1, 0) if no match
    was found. Just as for qualityParsed(), 'parsed_ranges'
    must be a list of parsed media ranges.
*/
exports.fitnessAndQualityParsed = function (mimeType, parsedRanges) {
    var bestFitness = -1, bestFitQ = 0, target = exports.parseMediaRange(mimeType);
    var targetType = target[0], targetSubtype = target[1], targetParams = target[2];

    for (var i=0; i < parsedRanges.length; i++) {
        var parsed = parsedRanges[i];
        var type = parsed[0], subtype = parsed[1], params = parsed[2];
        if ((type == targetType || type == "*" || targetType == "*") &&
            (subtype == targetSubtype || subtype == "*" || targetSubtype == "*")) {
            var matchCount = 0;
            for (param in targetParams) {
                if (param != 'q' && params[param] && params[param] == targetParams[param]) {
                    matchCount += 1;
                }
            }

            var fitness = (type == targetType) ? 100 : 0;
            fitness += (subtype == targetSubtype) ? 10 : 0;
            fitness += matchCount;

            if (fitness > bestFitness) {
                bestFitness = fitness;
                bestFitQ = params["q"];
            }
        }
    };
    return [bestFitness, parseFloat(bestFitQ)];
};

/*** qualityParsed
    Find the best match for a given mime-type against
    a list of media_ranges that have already been
    parsed by parseMediaRange(). Returns the
    'q' quality parameter of the best match, 0 if no
    match was found. This function bahaves the same as quality()
    except that 'parsedRanges' must be a list of
    parsed media ranges.
*/
exports.qualityParsed = function (mimeType, parsedRanges) {
    return exports.fitnessAndQualityParsed(mimeType, parsedRanges)[1];
};

/*** quality
    Returns the quality 'q' of a mime-type when compared
    against the media-ranges in ranges. For example::

        >>> Mimeparse.quality('text/html','text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, *\/*;q=0.5')
        0.7
*/
exports.quality = function (mimeType, ranges) {
    return exports.qualityParsed(mimeType, parseRanges(ranges));
};

/*** bestMatch
    Takes a list of supported mime-types and finds the best
    match for all the media-ranges listed in header. The value of
    header must be a string that conforms to the format of the
    HTTP Accept: header. The value of 'supported' is a list of
    mime-types::
    
        >>> bestMatch(['application/xbel+xml', 'text/xml'], 'text/*;q=0.5,*\/*; q=0.1')
        'text/xml'
*/
exports.bestMatch = function (supported, header) {
    var parsedHeader = parseRanges(header);
    var weighted = [];
    for (var i=0; i < supported.length; i++) {
        weighted.push([
            exports.fitnessAndQualityParsed(supported[i], parsedHeader),
            supported[i]
        ])
    };
    weighted.sort();
    return weighted[weighted.length-1][0][1] ? weighted[weighted.length-1][1] : '';
};

function parseRanges(ranges) {
    var parsedRanges = [], rangeParts = ranges.split(",");
    for (var i=0; i < rangeParts.length; i++) {
        parsedRanges.push(exports.parseMediaRange(rangeParts[i]));
    };
    return parsedRanges;
};