/*
MIT License
Copyright (c) 2021 Max Kas
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
if (kind === "m") throw new TypeError("Private method is not writable");
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
};
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
};
var __asyncValues = (this && this.__asyncValues) || function (o) {
if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
var m = o[Symbol.asyncIterator], i;
return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
};
var _File_fileHandle, _File_parent, _File_name;
import { CopyContentsOptions, CopyOptions, MoveOptions, copyFileContents } from './ifile.js';
import { FileStream } from '../streams/file_stream.js';
import { IOException } from '../../../salmon-core/streams/io_exception.js';
/**
* Salmon real local filesystem implementation for Javascript. This can be used only with the
* browser.
*/
export class File {
/**
* Instantiate a real file represented by the filepath provided.
* @param {FileSystemHandle|null} fileHandle The fileHandle.
*/
constructor(fileHandle, parent = null, name = null) {
_File_fileHandle.set(this, void 0);
_File_parent.set(this, void 0);
_File_name.set(this, void 0);
__classPrivateFieldSet(this, _File_fileHandle, fileHandle, "f");
__classPrivateFieldSet(this, _File_parent, parent, "f");
__classPrivateFieldSet(this, _File_name, name, "f");
}
/**
* Create a directory under this directory.
* @param {string} dirName The name of the new directory.
* @returns {Promise<IFile>} The newly created directory.
*/
async createDirectory(dirName) {
try {
let nDirHandle = await __classPrivateFieldGet(this, _File_fileHandle, "f")
.getDirectoryHandle(dirName, { create: false });
if (nDirHandle)
throw new Error("directory already exists");
}
catch (ex) { }
let nDirHandle = await __classPrivateFieldGet(this, _File_fileHandle, "f")
.getDirectoryHandle(dirName, { create: true });
let jsDir = new File(nDirHandle, this);
return jsDir;
}
/**
* Create a file under this directory.
* @param {string} filename The name of the new file.
* @returns {Promise<IFile>} The newly created file.
* @throws IOException Thrown if there is an IO error.
*/
async createFile(filename) {
let nFileHandle = await __classPrivateFieldGet(this, _File_fileHandle, "f")
.getFileHandle(filename, { create: true });
let jsFile = new File(nFileHandle, this);
return jsFile;
}
/**
* Delete this file or directory.
* @returns {Promise<boolean>} True if deletion is successful.
*/
async delete() {
if (__classPrivateFieldGet(this, _File_fileHandle, "f") && __classPrivateFieldGet(this, _File_fileHandle, "f").remove != undefined)
__classPrivateFieldGet(this, _File_fileHandle, "f").remove();
else if (__classPrivateFieldGet(this, _File_parent, "f"))
await __classPrivateFieldGet(this, _File_parent, "f").getPath().removeEntry(this.getName(), { recursive: true });
return !await this.exists();
}
/**
* True if file or directory exists.
* @returns {Promise<boolean>} True if exists
*/
async exists() {
// if this is the root handle we assume it always exists
if (__classPrivateFieldGet(this, _File_fileHandle, "f") == null)
return false;
if (__classPrivateFieldGet(this, _File_parent, "f") == null)
return true;
try {
let nFileHandle = null;
try {
nFileHandle = await __classPrivateFieldGet(this, _File_parent, "f").getPath().getFileHandle(this.getName(), { create: false });
}
catch (ex) { }
if (nFileHandle == null) {
try {
nFileHandle = await __classPrivateFieldGet(this, _File_parent, "f").getPath().getDirectoryHandle(this.getName(), { create: false });
}
catch (ex) { }
}
if (nFileHandle)
return true;
}
catch (ex) { }
return false;
}
/**
* Get the path of this file. For local filesystem see FileSystemHandle
* @returns {FileSystemHandle}
*/
getPath() {
return __classPrivateFieldGet(this, _File_fileHandle, "f");
}
/**
* Get the absolute path on the physical disk. For local file system this is the FileHandle.
* @returns {any} The absolute path.
*/
getDisplayPath() {
let filename = __classPrivateFieldGet(this, _File_fileHandle, "f") ? __classPrivateFieldGet(this, _File_fileHandle, "f").name : __classPrivateFieldGet(this, _File_name, "f");
if (__classPrivateFieldGet(this, _File_parent, "f") == null)
return "/" + (filename ? filename : "");
return __classPrivateFieldGet(this, _File_parent, "f").getDisplayPath() + File.separator + filename;
}
/**
* Get the name of this file or directory.
* @returns {string} The name of this file or directory.
*/
getName() {
if (__classPrivateFieldGet(this, _File_fileHandle, "f") == null && __classPrivateFieldGet(this, _File_name, "f"))
return __classPrivateFieldGet(this, _File_name, "f");
else if (__classPrivateFieldGet(this, _File_fileHandle, "f") == null)
throw new Error("Filehandle is not assigned");
return __classPrivateFieldGet(this, _File_fileHandle, "f").name;
}
/**
* Get a stream for reading the file.
* @returns {Promise<RandomAccessStream>} The stream to read from.
* @throws FileNotFoundException
*/
async getInputStream() {
let fileStream = new FileStream(this, "r");
return fileStream;
}
/**
* Get a stream for writing to this file.
* @returns {Promise<RandomAccessStream>} The stream to write to.
* @throws FileNotFoundException
*/
async getOutputStream() {
if (!await this.exists()) {
let parent = await this.getParent();
if (parent == null)
throw new Error("Could not get parent");
let nFile = await parent.createFile(this.getName());
__classPrivateFieldSet(this, _File_fileHandle, nFile.getPath(), "f");
}
let fileStream = new FileStream(this, "rw");
return fileStream;
}
/**
* Get the parent directory of this file or directory.
* @returns {Promise<IFile | null>} The parent directory.
*/
async getParent() {
return __classPrivateFieldGet(this, _File_parent, "f");
}
/**
* True if this is a directory.
* @returns {Promise<boolean>} True if directory.
*/
async isDirectory() {
return __classPrivateFieldGet(this, _File_fileHandle, "f") && __classPrivateFieldGet(this, _File_fileHandle, "f").kind === 'directory';
}
/**
* True if this is a file.
* @returns {Promise<boolean>} True if file.
*/
async isFile() {
return __classPrivateFieldGet(this, _File_fileHandle, "f") && __classPrivateFieldGet(this, _File_fileHandle, "f").kind === 'file';
}
/**
* Get the last modified date on disk.
* @returns {Promise<number>} The last date modified.
*/
async getLastDateModified() {
if (await this.isDirectory())
return 0;
let fileBlob = await __classPrivateFieldGet(this, _File_fileHandle, "f").getFile();
return fileBlob.lastModified;
}
/**
* Get the size of the file on disk.
* @returns {Promise<number>} The file length
*/
async getLength() {
if (await this.isDirectory())
return 0;
let fileBlob = await __classPrivateFieldGet(this, _File_fileHandle, "f").getFile();
return fileBlob.size;
}
/**
* Get the count of files and subdirectories
* @returns {Promise<number>} The number of children
*/
async getChildrenCount() {
return (await this.listFiles()).length;
}
/**
* List all files under this directory.
* @returns {Promise<IFile[]>} The list of files.
*/
async listFiles() {
var _a, e_1, _b, _c;
let files = [];
let nFiles = [];
try {
for (var _d = true, _e = __asyncValues(__classPrivateFieldGet(this, _File_fileHandle, "f").entries()), _f; _f = await _e.next(), _a = _f.done, !_a; _d = true) {
_c = _f.value;
_d = false;
const [key, value] = _c;
let file = new File(value, this);
if (await file.isFile())
nFiles.push(file);
else
files.push(file);
}
}
catch (e_1_1) { e_1 = { error: e_1_1 }; }
finally {
try {
if (!_d && !_a && (_b = _e.return)) await _b.call(_e);
}
finally { if (e_1) throw e_1.error; }
}
files = files.concat(nFiles);
return files;
}
/**
* Move this file or directory under a new directory.
* @param {IFile} newDir The target directory.
* @param {MoveOptions} [options] The options
* @returns {Promise<IFile>} The moved file. Use this file for subsequent operations instead of the original.
* @throws IOException Thrown if there is an IO error.
*/
async move(newDir, options) {
if (!options)
options = new MoveOptions();
let newName = options.newFilename ? options.newFilename : this.getName();
if (newDir == null || !await newDir.exists())
throw new IOException("Target directory does not exist");
let newFile = await newDir.getChild(newName);
if (newFile && await newFile.exists())
throw new IOException("Another file/directory already exists");
if (typeof (__classPrivateFieldGet(this, _File_fileHandle, "f").move) !== 'undefined') {
if (options.onProgressChanged != null)
options.onProgressChanged(0, await this.getLength());
await __classPrivateFieldGet(this, _File_fileHandle, "f").move(newDir.getPath(), newName);
newFile = await newDir.getChild(newName);
if (options.onProgressChanged != null)
options.onProgressChanged(await newFile.getLength(), await newFile.getLength());
return newFile;
}
else {
let oldFilename = this.getName();
let parent = await this.getParent();
let copyOptions = new CopyOptions();
copyOptions.newFilename = newName;
copyOptions.onProgressChanged = options.onProgressChanged;
await this.copy(newDir, copyOptions);
let newFile = await newDir.getChild(newName);
if (newFile == null)
throw new IOException("Could not move file");
if (parent) {
let oldFile = await parent.getChild(oldFilename);
if (oldFile)
await oldFile.delete();
}
return newFile;
}
}
/**
* Move this file or directory under a new directory.
* @param {IFile} newDir The target directory.
* @param {CopyOptions} [options] The options
* @returns {Promise<IFile | null>} The copied file. Use this file for subsequent operations instead of the original.
* @throws IOException Thrown if there is an IO error.
*/
async copy(newDir, options) {
if (!options)
options = new CopyOptions();
let newName = options.newFilename ? options.newFilename : this.getName();
if (newDir == null || !await newDir.exists())
throw new IOException("Target directory does not exists");
let newFile = await newDir.getChild(newName);
if (newFile && await newFile.exists())
throw new IOException("Another file/directory already exists");
if (await this.isDirectory()) {
let parent = await this.getParent();
if (await this.getChildrenCount() > 0 || parent == null)
throw new IOException("Could not copy directory use IFile copyRecursively() instead");
return parent.createDirectory(newName);
}
else {
newFile = await newDir.createFile(newName);
let copyContentOptions = new CopyContentsOptions();
copyContentOptions.onProgressChanged = options.onProgressChanged;
let res = await copyFileContents(this, newFile, copyContentOptions);
return res ? newFile : null;
}
}
/**
* Get the file or directory under this directory with the provided name.
* @param {string} filename The name of the file or directory.
* @returns {Promise<IFile | null>} The file or directory
*/
async getChild(filename) {
if (await this.isFile())
throw new Error("Parent is a file");
let nFileHandle = null;
try {
nFileHandle = await __classPrivateFieldGet(this, _File_fileHandle, "f").getFileHandle(filename, { create: false });
}
catch (ex) { }
if (nFileHandle == null) {
try {
nFileHandle = await __classPrivateFieldGet(this, _File_fileHandle, "f").getDirectoryHandle(filename, { create: false });
}
catch (ex) { }
}
if (nFileHandle == null)
return new File(null, this, filename);
let child = new File(nFileHandle, this);
return child;
}
/**
* Rename the current file or directory.
* @param {string} newFilename The new name for the file or directory.
* @returns {boolean} True if successfully renamed.
*/
async renameTo(newFilename) {
if (typeof (__classPrivateFieldGet(this, _File_fileHandle, "f").move) !== 'undefined')
await __classPrivateFieldGet(this, _File_fileHandle, "f").move(newFilename);
else if (__classPrivateFieldGet(this, _File_parent, "f") == null) {
return false;
}
else if (await this.isDirectory() && (await this.listFiles()).length > 0) {
throw new Error("Cannot rename non-empty directory. Create a new directory manually and moveRecursively() instead");
}
else {
let moveOptions = new MoveOptions();
moveOptions.newFilename = newFilename;
let nFile = await this.move(__classPrivateFieldGet(this, _File_parent, "f"), moveOptions);
__classPrivateFieldSet(this, _File_fileHandle, nFile.getPath(), "f");
}
return __classPrivateFieldGet(this, _File_fileHandle, "f").name == newFilename;
}
/**
* Create this directory under the current filepath.
* @returns {boolean} True if created.
*/
async mkdir() {
if (__classPrivateFieldGet(this, _File_parent, "f") == null)
return false;
let dir = await __classPrivateFieldGet(this, _File_parent, "f").createDirectory(this.getName());
__classPrivateFieldSet(this, _File_fileHandle, dir.getPath(), "f");
return await dir.exists();
}
/**
* Reset cached properties
*/
reset() {
}
/**
* Returns a string representation of this object
* @returns {string} The string
*/
toString() {
return this.getName();
}
}
_File_fileHandle = new WeakMap(), _File_parent = new WeakMap(), _File_name = new WeakMap();
File.separator = "/";