filezilla-js v0.0.9

FileZillaJS - Interface for reading sitemanager.xml into js objects

Examples

Instantiating siteManager

The SiteManager class can be instantiated in two different ways.

Either using the default XML file (found using your current environment variables):

import {getDefaultSiteManager} from "filezilla-js";

const siteManager = getDefaultSiteManager();

Or by using a specific sitemanager.xml path by using getSiteManager instead of getDefaultSiteManager:

import {getSiteManager} from "filezilla-js";

// Point at the custom sitemanager.xml file
const siteManager = getSiteManager(path.join(__dirname, 'fixtures/sitemanager.xml'));

Fetching servers

Getting a single server by root path

Use siteManager.getServerByPath(path) to get a single Server object or NULL if it wasn't found:

import {getDefaultSiteManager} from "filezilla-js";

const siteManager = getDefaultSiteManager();

// Get server by path "SFTP (root location)" (a server with that name, in the root of the sitemanager.xml)
const server = siteManager.getServerByPath(`SFTP (root location)`);

if (!server) {
    console.error(`Error: Could not find server by path ${serverPath}`);
} else {
    console.log(`${serverPath} (host: ${server.properties.host}:${server.properties.port})`);
}

Getting a single server by sub paths

Use siteManager.getServerByPath(path) to get a single Server object or NULL if it wasn't found:

import {getDefaultSiteManager} from "filezilla-js";

const siteManager = getDefaultSiteManager();

// Get server by path "Rebex/SFTP" (a server with that the name "SFTP" in the "Rebex" folder)
const server = siteManager.getServerByPath(`Rebex/SFTP`);

if (!server) {
    console.error(`Error: Could not find server by path ${serverPath}`);
} else {
    console.log(`${serverPath} (host: ${server.properties.host}:${server.properties.port})`);
}

Getting all servers in an array

Use siteManager.getServers() to get a list of Server objects:

import {getDefaultSiteManager} from "filezilla-js";

const siteManager = getDefaultSiteManager();

const servers = siteManager.getServers();

for (let server of servers) {
    console.log(`${server.path} (host: ${server.properties.host}:${server.properties.port})`);
}

Classes

Server

The main object returned from siteManager.getServer is a Server. It has the following properties: path: string;

Properties

Methods

Server.getRemoteDirectory(defaultRemoteDirectory:string = ''):

Gets a human readable path (instead of the raw FileZilla path).

Example:

<RemoteDir>1 0 3 pub 7 example</RemoteDir>
           ^ ^ ^ ^   ^ ^
           | | | |   | |
           | | | |   | \-- The name of the sub folder
           | | | |   \-- The length of the sub folder ("example".length)
           | | | \-- The name of the main folder
           | | \-- The length of the main folder ("pub".length)
           | \-- The length of the prefix
           \-- The ServerType (see the definition)

In the instance above, the output of Server.getRemoteDirectory() would be /pub/example

Definitions

ServerProperties

Enums

Note: A lot of these enums can be found in the Filezilla sourcecode's server.h file

CharsetEncoding

LogonType

PasvMode

ServerFormat

ServerProtocol

ServerType