DevTools: Split out the "workspace" and "bindings" modules from "sdk"

Source/devtools/front_end/sdk/TempFile.js

-/*
- * Copyright (C) 2013 Google Inc. 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 Google Inc. 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
- * OWNER 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.
- */
-
-window.requestFileSystem = window.requestFileSystem || window.webkitRequestFileSystem;
-
-/**
- * @constructor
- * @param {!string} dirPath
- * @param {!string} name
- * @param {!function(?WebInspector.TempFile)} callback
- */
-WebInspector.TempFile = function(dirPath, name, callback)
-{
-    this._fileEntry = null;
-    this._writer = null;
-
-    /**
-     * @param {!FileSystem} fs
-     * @this {WebInspector.TempFile}
-     */
-    function didInitFs(fs)
-    {
-        fs.root.getDirectory(dirPath, { create: true }, didGetDir.bind(this), errorHandler);
-    }
-
-    /**
-     * @param {!DirectoryEntry} dir
-     * @this {WebInspector.TempFile}
-     */
-    function didGetDir(dir)
-    {
-        dir.getFile(name, { create: true }, didCreateFile.bind(this), errorHandler);
-    }
-
-    /**
-     * @param {!FileEntry} fileEntry
-     * @this {WebInspector.TempFile}
-     */
-    function didCreateFile(fileEntry)
-    {
-        this._fileEntry = fileEntry;
-        fileEntry.createWriter(didCreateWriter.bind(this), errorHandler);
-    }
-
-    /**
-     * @param {!FileWriter} writer
-     * @this {WebInspector.TempFile}
-     */
-    function didCreateWriter(writer)
-    {
-        /**
-         * @this {WebInspector.TempFile}
-         */
-        function didTruncate(e)
-        {
-            this._writer = writer;
-            writer.onwrite = null;
-            writer.onerror = null;
-            callback(this);
-        }
-
-        function onTruncateError(e)
-        {
-            WebInspector.console.error("Failed to truncate temp file " + e.code + " : " + e.message);
-            callback(null);
-        }
-
-        if (writer.length) {
-            writer.onwrite = didTruncate.bind(this);
-            writer.onerror = onTruncateError;
-            writer.truncate(0);
-        } else {
-            this._writer = writer;
-            callback(this);
-        }
-    }
-
-    function errorHandler(e)
-    {
-        WebInspector.console.error("Failed to create temp file " + e.code + " : " + e.message);
-        callback(null);
-    }
-
-    /**
-     * @this {WebInspector.TempFile}
-     */
-    function didClearTempStorage()
-    {
-        window.requestFileSystem(window.TEMPORARY, 10, didInitFs.bind(this), errorHandler);
-    }
-    WebInspector.TempFile._ensureTempStorageCleared(didClearTempStorage.bind(this));
-}
-
-WebInspector.TempFile.prototype = {
-    /**
-     * @param {!string} data
-     * @param {!function(boolean)} callback
-     */
-    write: function(data, callback)
-    {
-        var blob = new Blob([data], {type: 'text/plain'});
-        this._writer.onerror = function(e)
-        {
-            WebInspector.console.error("Failed to write into a temp file: " + e.message);
-            callback(false);
-        }
-        this._writer.onwrite = function(e)
-        {
-            callback(true);
-        }
-        this._writer.write(blob);
-    },
-
-    finishWriting: function()
-    {
-        this._writer = null;
-    },
-
-    /**
-     * @param {function(?string)} callback
-     */
-    read: function(callback)
-    {
-        /**
-         * @param {!File} file
-         */
-        function didGetFile(file)
-        {
-            var reader = new FileReader();
-
-            /**
-             * @this {FileReader}
-             */
-            reader.onloadend = function(e)
-            {
-                callback(/** @type {?string} */ (this.result));
-            }
-            reader.onerror = function(error)
-            {
-                WebInspector.console.error("Failed to read from temp file: " + error.message);
-            }
-            reader.readAsText(file);
-        }
-        function didFailToGetFile(error)
-        {
-            WebInspector.console.error("Failed to load temp file: " + error.message);
-            callback(null);
-        }
-        this._fileEntry.file(didGetFile, didFailToGetFile);
-    },
-
-    /**
-     * @param {!WebInspector.OutputStream} outputStream
-     * @param {!WebInspector.OutputStreamDelegate} delegate
-     */
-    writeToOutputSteam: function(outputStream, delegate)
-    {
-        /**
-         * @param {!File} file
-         */
-        function didGetFile(file)
-        {
-            var reader = new WebInspector.ChunkedFileReader(file, 10*1000*1000, delegate);
-            reader.start(outputStream);
-        }
-
-        function didFailToGetFile(error)
-        {
-            WebInspector.console.error("Failed to load temp file: " + error.message);
-            outputStream.close();
-        }
-
-        this._fileEntry.file(didGetFile, didFailToGetFile);
-    },
-
-    remove: function()
-    {
-        if (this._fileEntry)
-            this._fileEntry.remove(function() {});
-    }
-}
-
-/**
- * @constructor
- * @param {!string} dirPath
- * @param {!string} name
- */
-WebInspector.BufferedTempFileWriter = function(dirPath, name)
-{
-    this._chunks = [];
-    this._tempFile = null;
-    this._isWriting = false;
-    this._finishCallback = null;
-    this._isFinished = false;
-    new WebInspector.TempFile(dirPath, name, this._didCreateTempFile.bind(this));
-}
-
-WebInspector.BufferedTempFileWriter.prototype = {
-    /**
-     * @param {!string} data
-     */
-    write: function(data)
-    {
-        if (!this._chunks)
-            return;
-        if (this._finishCallback)
-            throw new Error("No writes are allowed after close.");
-        this._chunks.push(data);
-        if (this._tempFile && !this._isWriting)
-            this._writeNextChunk();
-    },
-
-    /**
-     * @param {!function(?WebInspector.TempFile)} callback
-     */
-    close: function(callback)
-    {
-        this._finishCallback = callback;
-        if (this._isFinished)
-            callback(this._tempFile);
-        else if (!this._isWriting && !this._chunks.length)
-            this._notifyFinished();
-    },
-
-    _didCreateTempFile: function(tempFile)
-    {
-        this._tempFile = tempFile;
-        if (!tempFile) {
-            this._chunks = null;
-            this._notifyFinished();
-            return;
-        }
-        if (this._chunks.length)
-            this._writeNextChunk();
-    },
-
-    _writeNextChunk: function()
-    {
-        var chunkSize = 0;
-        var endIndex = 0;
-        for (; endIndex < this._chunks.length; endIndex++) {
-            chunkSize += this._chunks[endIndex].length;
-            if (chunkSize > 10 * 1000 * 1000)
-                break;
-        }
-        var chunk = this._chunks.slice(0, endIndex + 1).join("");
-        this._chunks.splice(0, endIndex + 1);
-        this._isWriting = true;
-        this._tempFile.write(chunk, this._didWriteChunk.bind(this));
-    },
-
-    _didWriteChunk: function(success)
-    {
-        this._isWriting = false;
-        if (!success) {
-            this._tempFile = null;
-            this._chunks = null;
-            this._notifyFinished();
-            return;
-        }
-        if (this._chunks.length)
-            this._writeNextChunk();
-        else if (this._finishCallback)
-            this._notifyFinished();
-    },
-
-    _notifyFinished: function()
-    {
-        this._isFinished = true;
-        if (this._tempFile)
-            this._tempFile.finishWriting();
-        if (this._finishCallback)
-            this._finishCallback(this._tempFile);
-    }
-}
-
-/**
- * @constructor
- */
-WebInspector.TempStorageCleaner = function()
-{
-    this._worker = new SharedWorker("temp_storage_shared_worker/TempStorageSharedWorker.js", "TempStorage");
-    this._callbacks = [];
-    this._worker.port.onmessage = this._handleMessage.bind(this);
-    this._worker.port.onerror = this._handleError.bind(this);
-}
-
-WebInspector.TempStorageCleaner.prototype = {
-    /**
-     * @param {!function()} callback
-     */
-    ensureStorageCleared: function(callback)
-    {
-        if (this._callbacks)
-            this._callbacks.push(callback);
-        else
-            callback();
-    },
-
-    _handleMessage: function(event)
-    {
-        if (event.data.type === "tempStorageCleared") {
-            if (event.data.error)
-                WebInspector.console.error(event.data.error);
-            this._notifyCallbacks();
-        }
-    },
-
-    _handleError: function(event)
-    {
-        WebInspector.console.error(WebInspector.UIString("Failed to clear temp storage: %s", event.data));
-        this._notifyCallbacks();
-    },
-
-    _notifyCallbacks: function()
-    {
-        var callbacks = this._callbacks;
-        this._callbacks = null;
-        for (var i = 0; i < callbacks.length; i++)
-            callbacks[i]();
-    }
-}
-
-/**
- * @param {!function()} callback
- */
-WebInspector.TempFile._ensureTempStorageCleared = function(callback)
-{
-    if (!WebInspector.TempFile._storageCleaner)
-        WebInspector.TempFile._storageCleaner = new WebInspector.TempStorageCleaner();
-    WebInspector.TempFile._storageCleaner.ensureStorageCleared(callback);
-}