1
0
Fork 0
arangodb/js/common/bootstrap/module-fs.js

200 lines
7.2 KiB
JavaScript

/*jslint indent: 2, nomen: true, maxlen: 120, sloppy: true, vars: true, white: true, plusplus: true */
/*global require */
////////////////////////////////////////////////////////////////////////////////
/// @brief module "js"
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2004-2013 triAGENS GmbH, Cologne, Germany
///
/// 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.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Dr. Frank Celler
/// @author Copyright 2010-2013, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- Module "fs"
// -----------------------------------------------------------------------------
// -----------------------------------------------------------------------------
// --SECTION-- public functions
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup ArangoShell
/// @{
////////////////////////////////////////////////////////////////////////////////
(function () {
var internal = require("internal");
var fs = require("fs");
////////////////////////////////////////////////////////////////////////////////
/// @brief tests if a file exists
////////////////////////////////////////////////////////////////////////////////
fs.exists = internal.exists;
////////////////////////////////////////////////////////////////////////////////
/// @brief returns a temporary file
////////////////////////////////////////////////////////////////////////////////
fs.getTempFile = internal.getTempFile;
////////////////////////////////////////////////////////////////////////////////
/// @brief returns the temporary path
////////////////////////////////////////////////////////////////////////////////
fs.getTempPath = internal.getTempPath;
////////////////////////////////////////////////////////////////////////////////
/// @brief returns the home directory
////////////////////////////////////////////////////////////////////////////////
fs.home = function () {
return internal.homeDirectory;
};
////////////////////////////////////////////////////////////////////////////////
/// @brief tests if path points to a directory
////////////////////////////////////////////////////////////////////////////////
fs.isDirectory = internal.isDirectory;
////////////////////////////////////////////////////////////////////////////////
/// @brief tests if path points to a file
////////////////////////////////////////////////////////////////////////////////
fs.isFile = internal.isFile;
////////////////////////////////////////////////////////////////////////////////
/// @brief joins two paths (dummy implementation)
////////////////////////////////////////////////////////////////////////////////
fs.join = function () {
var list = [];
var i;
for (i = 0; i < arguments.length; ++i) {
var p = arguments[i];
if (p !== '') {
if (p.substr(- internal.PATH_SEPARATOR.length) !== internal.PATH_SEPARATOR) {
list.push(p);
}
}
}
return list.join(internal.PATH_SEPARATOR);
};
////////////////////////////////////////////////////////////////////////////////
/// @brief lists all files and directories under a given path recursively
////////////////////////////////////////////////////////////////////////////////
fs.listTree = internal.listTree;
////////////////////////////////////////////////////////////////////////////////
/// @brief lists all files and directories under a given path
////////////////////////////////////////////////////////////////////////////////
fs.list = internal.listDirectory;
////////////////////////////////////////////////////////////////////////////////
/// @brief creates a directory
////////////////////////////////////////////////////////////////////////////////
fs.makeDirectory = internal.makeDirectory;
////////////////////////////////////////////////////////////////////////////////
/// @brief make a directory with all parent paths
////////////////////////////////////////////////////////////////////////////////
fs.makeDirectoryRecursive = function (path) {
var parts, subPart;
parts = path.split(internal.PATH_SEPARATOR);
subPart = '';
parts.forEach(function (s, i) {
if (i > 0) {
subPart += internal.PATH_SEPARATOR;
}
subPart += s;
try {
// directory may already exist
fs.makeDirectory(subPart);
}
catch (err) {
}
});
};
////////////////////////////////////////////////////////////////////////////////
/// @brief moves a file or directory
////////////////////////////////////////////////////////////////////////////////
fs.move = internal.move;
////////////////////////////////////////////////////////////////////////////////
/// @brief reads a file
////////////////////////////////////////////////////////////////////////////////
fs.read = internal.read;
////////////////////////////////////////////////////////////////////////////////
/// @brief removes a file
////////////////////////////////////////////////////////////////////////////////
fs.remove = internal.remove;
////////////////////////////////////////////////////////////////////////////////
/// @brief removes a directory. the directory must be empty
////////////////////////////////////////////////////////////////////////////////
fs.removeDirectory = internal.removeDirectory;
////////////////////////////////////////////////////////////////////////////////
/// @brief removes a directory with all data in it
////////////////////////////////////////////////////////////////////////////////
fs.removeDirectoryRecursive = internal.removeDirectoryRecursive;
////////////////////////////////////////////////////////////////////////////////
/// @brief returns the size of a file
////////////////////////////////////////////////////////////////////////////////
fs.size = internal.fileSize;
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
}());
// -----------------------------------------------------------------------------
// --SECTION-- END-OF-FILE
// -----------------------------------------------------------------------------
// Local Variables:
// mode: outline-minor
// outline-regexp: "/// @brief\\|/// @addtogroup\\|/// @page\\|// --SECTION--\\|/// @\\}\\|/\\*jslint"
// End: