cla/fs - Local Filesystem Access

These functions are for accessing the Clarive server instance filesystem.

For remote filesystem management, look at the agent Resource.

fs.createFile(file,contents)

Creates and writes content to file in one go.

var fs = require('cla/fs');
fs.createFile("/tmp/myfile", "first line\nsecond line\n");

fs.slurp(file)

Reads files content into a string in one go.

var fs = require('cla/fs');
var content = fs.slurp("/tmp/myfile");

fs.openFile(filepath, mode, encoding = utf-8)

Opens a file for reading, returning a file handle.

var fs = require('cla/fs');
var fh = fs.openFile("/tmp/myfile", "r");
while( !fh.eof() ) {
    print( fh.readLine() );
}

The encoding parameter is optional, by default it's set to utf-8. Only the following encodings are allowed:

• utf-8
• iso-8859-15
• raw

Here's an example for reading and writing a binary file:

var fs = require("cla/fs");
var a = fs.openFile('/tmp/a.tar','r', 'raw');
var b = fs.openFile('/tmp/b.tar','w', 'raw');

while( !a.eof() ) {
    var data = a.readChunk();
    b.write(data);
}
a.close();
b.close();

fh.readLine()

Reads a single line from the file.

var fs = require('cla/fs');
var fh = fs.openFile("/tmp/myfile", "r");
while( !fh.eof() ) {
    print( fh.readLine() );
}

Returns undefined if the file has reach its end.

fh.readChunk(length)

Reads any number of bytes from a file.

var fs = require('cla/fs');
var fh = fs.openFile("/tmp/myfile", "r");
while( !fh.eof() ) {
    print( fh.readChunk(10) ); // read only 10 bytes out from the file
}

Returns undefined if the file has reach its end.

fh.eof()

Checks if filehandle has reached the end of file.

fh.close()

Closes a file.

var fs = require('cla/fs');
var fh = fs.openFile("/tmp/myfile", "r");
fh.close();

fh.fileno()

Returns the filehandle number.

var fs = require('cla/fs');
var fh = fs.openFile("/tmp/myfile", "r");
print( fh.fileno() );

fs.iterateDir(dirpath,cb)

Iterates through directory contents.

var fs = require('cla/fs');
fs.iterateDir( "/tmp", function(file,path){
    if( fs.isDir(file) ) return;
});

fs.stat(file)

Returns status info for a file.

var fs = require('cla/fs');
console.log( fs.stat("/tmp/myfile") );

Not all fields are supported on all filesystem types. Here are the meanings of the fields:

 0 dev      device number of filesystem
 1 ino      inode number
 2 mode     file mode  (type and permissions)
 3 nlink    number of (hard) links to the file
 4 uid      numeric user ID of file's owner
 5 gid      numeric group ID of file's owner
 6 rdev     the device identifier (special files only)
 7 size     total size of file, in bytes
 8 atime    last access time in seconds since the epoch
 9 mtime    last modify time in seconds since the epoch
10 ctime    inode change time in seconds since the epoch
11 blksize  preferred I/O size in bytes for interacting with the file (may vary from file to file)
12 blocks   actual number of system-specific blocks allocated on disk (often, but not always, 512 bytes each)

fs.isDir(path)

Returns true if path is a directory.

fs.isFile(path)

Returns true if path is a file.

fs.deleteFile(path)

Deletes a file.

var fs = require('cla/fs');
fs.deleteFile("/tmp/myfile");

fs.createDir()

Creates a directory in the filesystem, but does not create the intermediate paths.

var fs = require('cla/fs');
var dir = "/tmp/dad/son";
if( !fs.isDir(dir) ) {
    fs.createDir(dir);
}

fs.createPath()

Creates a directory in the filesystem, creating the intermediate parent path if necessary.

var fs = require('cla/fs');
var dir = "/tmp/dad/son";
fs.createPath(dir);

fs.deleteDir()

Deletes an empty directory.

var fs = require('cla/fs');
fs.deleteDir("/tmp/dad/son");

Returns true if deletion was successful.