README

A powerful PHP library for parsing and working with FileZilla sitemanager.xml files. It allows you to extract server details, manage configurations, and integrate FileZilla data into your PHP applications.

Features

• 🎉 Parse FileZilla sitemanager.xml files: Extract and work with server folders as well as individual server details.
• 🔒 Stop using credentials in your code: If FileZilla already provides this unencrypted, and you're already using it, why not just read it from there?
• ✨ Supports all FileZilla server attributes: Including host, port, protocol, and more.
• 🔧 Flexible API: Query specific server details or all servers in a folder.
• 📜 Enum-Based Design: Strongly typed enums for protocols, logon types, and more.
• ⚙️ Works out of the box: The library defaults to the sitemanager.xml of your system. No need to specify a path.
• 🚀 PHP 8.0+ Compatible: Built with modern PHP practices and strict typing.

Installation

Install the package via Composer:

composer require jalsoedesign/filezilla

Usage

Basic usage

Load the default sitemanager.xml from your system (using fromSystem()) and iterate through all servers and print their name.

use jalsoedesign\filezilla\SiteManager;

$siteManager = SiteManager::fromSystem();

$servers = $siteManager->getServers();

foreach ($servers as $server) {
    echo 'Full server path: ' . $server->getPath() . PHP_EOL;
}

Many other examples

See the examples folder.

Structure of sitemanager.xml

The test fixture tests/fixtures/sitemanager.xml provides an example of all possible options.

📁 My Sites
│   📁 Protocols
│   ├── ☁️ azure-blob-storage.example.com
│   ├── ☁️ azure-file-storage.example.com
│   ├── ☁️ backblaze-b2.example.com
│   ├── ☁️ box.example.com
│   ├── ☁️ dropbox.example.com
│   ├── 🌐 ftp.example.com - explicit ftp over tls
│   ├── 🌐 ftp.example.com - explicit ftp over tls if available
│   ├── 🌐 ftp.example.com - implicit ftp over tls
│   ├── 🌐 ftp.example.com - plain ftp
│   ├── 🌐 google-cloudstorage.example.com
│   ├── ☁️ google-drive.example.com
│   ├── ☁️ onedrive.example.com
│   ├── ☁️ openstack-swift.example.com
│   ├── ☁️ rackspace-cloud-storage.example.com
│   ├── ☁️ s3.example.com
│   ├── 🌐 sftp.example.com
│   ├── 🌐 webdav.example.com - http
│   ├── 🌐 webdav.example.com - https
│   📁 Settings
│   │   📁 Advanced
│   │   ├── 🌐 _default
│   │   │   📁 Adjusted server time
│   │   │   ├── 🌐 minus 1 hour
│   │   │   ├── 🌐 plus 1 hour
│   │   │   ├── 🌐 plus 30 minutes
│   │   │   📁 Bypass proxy
│   │   │   ├── 🌐 disabled
│   │   │   ├── 🌐 enabled
│   │   │   📁 Directory comparison
│   │   │   ├── 🌐 disabled
│   │   │   ├── 🌐 enabled
│   │   │   📁 Local directory
│   │   │   ├── 🌐 local directory - Unix
│   │   │   ├── 🌐 local directory - Windows
│   │   │   📁 Remote directory
│   │   │   ├── 🌐 remote directory - Unix
│   │   │   ├── 🌐 remote directory - Windows
│   │   │   📁 Server type
│   │   │   ├── 🌐 cygwin
│   │   │   ├── 🌐 default
│   │   │   ├── 🌐 dos with back slashes
│   │   │   ├── 🌐 dos with forward slashes
│   │   │   ├── 🌐 doslike
│   │   │   ├── 🌐 hp nonstop
│   │   │   ├── 🌐 mvs
│   │   │   ├── 🌐 unix
│   │   │   ├── 🌐 vms
│   │   │   ├── 🌐 vxworks
│   │   │   ├── 🌐 zvm
│   │   │   📁 Synchronized browsing
│   │   │   ├── 🌐 disabled
│   │   │   ├── 🌐 enabled
│   │   📁 Charset
│   │   ├── 🌐 autodetect
│   │   ├── 🌐 custom charset - utf16
│   │   ├── 🌐 force utf8
│   │   📁 General
│   │   │   📁 Background color
│   │   │   ├── 🌐 none
│   │   │   ├── 🌐 red
│   │   │   📁 Comments
│   │   │   ├── 🌐 no comments
│   │   │   ├── 🌐 with comments
│   │   │   📁 Custom port
│   │   │   ├── 🌐 custom port 8080
│   │   │   ├── 🌐 default port
│   │   📁 Transfer Settings
│   │   ├── 🌐 transfer mode - 6 limit
│   │   ├── 🌐 transfer mode - Active
│   │   ├── 🌐 transfer mode - Default
│   │   ├── 🌐 transfer mode - No limit
│   │   ├── 🌐 transfer mode - Passive
│   📁 Various
│   ├── 🌐 Special !"#¤%&()=<>
│   ├── 🌐 Utf8 💞💢💫

Documentation

API Reference

Server

The Server class represents a single server configuration from the FileZilla sitemanager.xml file. It provides access to all attributes of a server, including its host, protocol, directories, and more.

Folder

The Folder class represents a collection of Server and/or Folder objects, allowing for recursive structures of servers and folders.

SiteManager

The SiteManager class extends Folder, inheriting all of its functionality, and represents the root structure of FileZilla's server and folder configuration as defined in the sitemanager.xml file. In addition to managing nested folders and servers, it provides access to metadata about the configuration file itself.

Enums

All enum classes have Enum::toCamelCase($value) as well as Enum::getConstantName($value) methods.

Filezilla config parsing

Contributing

Contributions are welcome! Please submit a pull request or open an issue if you find a bug or have an idea for an enhancement.

License

This library is open-sourced under the MIT license.

Credits

• Author: JalsoeDesign

Support

If you find this library useful, feel free to ⭐ the repository or share your feedback!