Source: formats/kml/KmzFile.js

/*
 * Copyright 2003-2006, 2009, 2017, 2020 United States Government, as represented
 * by the Administrator of the National Aeronautics and Space Administration.
 * All rights reserved.
 *
 * The NASAWorldWind/WebWorldWind platform is licensed under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License
 * at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * NASAWorldWind/WebWorldWind also contains the following 3rd party Open Source
 * software:
 *
 *    ES6-Promise – under MIT License
 *    libtess.js – SGI Free Software License B
 *    Proj4 – under MIT License
 *    JSZip – under MIT License
 *
 * A complete listing of 3rd Party software notices and licenses included in
 * WebWorldWind can be found in the WebWorldWind 3rd-party notices and licenses
 * PDF found in code  directory.
 */
/**
 * @exports KmzFile
 */
define([
    '../../util/jszip',
    '../../util/Promise',
    '../../util/WWUtil'
], function (JsZip,
             Promise,
             WWUtil) {
    "use strict";

    /**
     * Constructs KmzFile. It expects binary representation of the file and the Cache to be used.
     * @constructor
     * @alias KmzFile
     * @param binary {Object} Binary representation of the file.
     * @param fileCache {KmlFileCache} Cache for the contents of the file.
     */
    var KmzFile = function (binary, fileCache) {
        this._binary = binary;

        this._fileCache = fileCache;
    };

    /**
     * It loads the whole file and register all its contents. Version 0.1 uses file cache mechanism.
     * @returns Promise
     */
    KmzFile.prototype.load = function () {
        var self = this;
        var rootDocument = null;
        var rootFound = false;

        return new JsZip().loadAsync(this._binary).then(function (zipFile) {
            return Promise.all(Object.keys(zipFile.files).map(function (key) {
                return zipFile.files[key];
            }).map(function (file) {
                if (self.hasExtension("kml", file.name) && !rootFound) {
                    rootFound = true;

                    return file.async("text")
                        .then(function (kmlTextRepresentation) {
                            rootDocument = kmlTextRepresentation;
                        });
                } else if(self.hasExtension("kml", file.name)) {
                    return file.async("base64")
                        .then(function (kmlTextRepresentation) {
                            return new WorldWind.KmlFile(kmlTextRepresentation).then(function(kmlFile){
                                self._fileCache.add('href;' + file.name, kmlFile);
                            });
                        });
                } else {
                    return file.async("base64")
                        .then(function (mediaFile) {
                            var dataURI = "data:image/jpeg;base64," + mediaFile;
                            self._fileCache.add('href;' + file.name, dataURI);
                        });
                }
            }));
        }).then(function () {
            return rootDocument;
        });
    };

    /**
     * FOR INTERNAL USE ONLY.
     * Returns a value indicating whether the URL ends with the given extension.
     * @param url {String} Url to a file
     * @param extension {String} Extension of the file.
     * @returns {boolean} true if the extension matches otherwise false
     * @private
     */
    KmzFile.prototype.hasExtension = function (extension, url) {
        return WWUtil.endsWith(url, "." + extension);
    };

    return KmzFile;
});