All files / dash.js/src/dash/models PatchManifestModel.js

100% Statements 42/42
95.55% Branches 43/45
100% Functions 10/10
100% Lines 42/42

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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                                                                                47x     47x       3x       16x       16x       16x       28x 1x       27x 37x     37x 2x 2x     35x     35x 6x 1x 1x         5x     34x 34x 1x 1x     33x 33x 13x 20x 13x 13x   13x 13x 13x   13x       33x   33x 15x     33x 37x     47x               47x   47x     1x    
/**
 * The copyright in this software is being made available under the BSD License,
 * included below. This software may be subject to other third party and contributor
 * rights, including patent rights, and no such rights are granted under this license.
 *
 * Copyright (c) 2013, Dash Industry Forum.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *  * Redistributions of source code must retain the above copyright notice, this
 *  list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation and/or
 *  other materials provided with the distribution.
 *  * Neither the name of Dash Industry Forum nor the names of its
 *  contributors may be used to endorse or promote products derived from this software
 *  without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS AND ANY
 *  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */
import DashConstants from '../constants/DashConstants.js';
import FactoryMaker from '../../core/FactoryMaker.js';
import Debug from '../../core/Debug.js';
import SimpleXPath from '../vo/SimpleXPath.js';
import PatchOperation from '../vo/PatchOperation.js';
 
function PatchManifestModel() {
    let instance,
        logger;
 
    const context = this.context;
 
    function setup() {
        logger = Debug(context).getInstance().getLogger(instance);
    }
 
    function getIsPatch(patch) {
        return patch && patch.hasOwnProperty(DashConstants.ORIGINAL_MPD_ID) || false;
    }
 
    function getPublishTime(patch) {
        return patch && patch.hasOwnProperty(DashConstants.PUBLISH_TIME) ? new Date(patch[DashConstants.PUBLISH_TIME]) : null;
    }
 
    function getOriginalPublishTime(patch) {
        return patch && patch.hasOwnProperty(DashConstants.ORIGINAL_PUBLISH_TIME) ? new Date(patch[DashConstants.ORIGINAL_PUBLISH_TIME]) : null;
    }
 
    function getMpdId(patch) {
        return (patch && patch[DashConstants.ORIGINAL_MPD_ID]) || null;
    }
 
    function getPatchOperations(patch) {
        if (!patch) {
            return [];
        }
 
        // Go through the patch operations in order and parse their actions out for usage
        return (patch.__children || []).map((node) => {
            const action = node.tagName;
 
            // we only look add add/remove/replace actions
            if (action !== 'add' && action !== 'remove' && action !== 'replace') {
                logger.warn(`Ignoring node of invalid action: ${action}`);
                return null;
            }
 
            let selector = node.sel;
 
            // add action can have special targeting via the 'type' attribute
            if (action === 'add' && node.type) {
                if (!node.type.startsWith('@')) {
                    logger.warn(`Ignoring add action for prefixed namespace declaration: ${node.type}=${node.__text}`);
                    return null;
                }
 
                // for our purposes adding/replacing attribute are equivalent and we can normalize
                // our processing logic by appending the attribute to the selector path
                selector = `${selector}/${node.type}`;
            }
 
            let xpath = new SimpleXPath(selector);
            if (!xpath.isValid()) {
                logger.warn(`Ignoring action with invalid selector: ${action} - ${selector}`);
                return null;
            }
 
            let value = null;
            if (xpath.findsAttribute() || xpath.findsTextReplace()) {
                value = node.__text || '';
            } else if (action !== 'remove') {
                value = node.__children.reduce((groups, child) => {
                    let key = child.tagName;
                    // we also ignore
                    if (key !== '#text') {
                        groups[key] = groups[key] || [];
                        groups[key].push(child);
                    }
                    return groups;
                }, {});
            }
 
            let operation = new PatchOperation(action, xpath, value);
 
            if (action === 'add') {
                operation.position = node.pos;
            }
 
            return operation;
        }).filter((operation) => !!operation);
    }
 
    instance = {
        getIsPatch,
        getMpdId,
        getOriginalPublishTime,
        getPatchOperations,
        getPublishTime
    };
 
    setup();
 
    return instance;
}
 
PatchManifestModel.__dashjs_factory_name = 'PatchManifestModel';
export default FactoryMaker.getSingletonFactory(PatchManifestModel);