C# Class Filezilla, FileZilla.NET

Summary description for Filezilla

Mostrar archivo Open project: sancsoft/FileZilla.NET Class Usage Examples

Protected Properties

Property	Type	Description
config	XmlDocument

Public Methods

Method	Description
AddUsersToList ( List &userList ) : int	Add the users in the file to a list of users
AllowDirCreate ( string username, string foldername ) : bool
AllowDirDelete ( string username, string foldername ) : bool
AllowDirList ( string username, string foldername ) : bool
AllowDirSubdirs ( string username, string foldername ) : bool
AllowFileDelete ( string username, string foldername ) : bool
AllowFileRead ( string username, string foldername ) : bool
AllowFileWrite ( string username, string foldername ) : bool
AssignUserPassword ( string username, string password ) : bool	Assign the supplied password to the supplied user account
Authenticate ( string username, string password ) : bool	Attempt to authenticate using the provided account and password
AuthenticateAdministration ( string password ) : bool	Authenticate as the server administrator - for some reason, this isn't encrypted
AutoCreate ( string username, string foldername ) : bool
CreateUser ( string username, string password, bool enabled, bool fileRead, bool fileWrite, bool fileDelete, bool fileAppend, bool dirCreate, bool dirDelete, bool dirList, bool dirSubdirs, bool autoCreate ) : bool	Create a new user account
Filezilla ( string configurationFile ) : System
ForceServerConfigurationLoad ( ) : bool	Force the server to reload the configuration
GetMd5Sum ( string str ) : string	Calculated the md5 encrypted version of a string
GetUser ( string userName ) : FilezillaUser,	Retrieve a user object by user name. This will throw if the user cannot be found
HomeDirectory ( string username ) : string	Retrieve this user's home directory from the configuration. Throws an exception if the user is not defined
IsHome ( string username, string foldername ) : bool
NormalizeFolderName ( string rawFolder ) : string	Normalize the definition of a folder to something we can work with
UserExists ( string userName ) : bool	Check to see if a valid user exists
WriteConfiguration ( string filename ) : void	Write the XML back to the configuration file

Protected Methods

Method	Description
AccountNotification ( string action, string username, string password ) : void	Notify the system administration email address of account information
CheckPermission ( string username, string foldername, string permission ) : bool	Check an permission flag

Method Details

AccountNotification() protected method

Notify the system administration email address of account information

protected AccountNotification ( string action, string username, string password ) : void
action	string	action description
username	string	account
password	string	password (unencrypted)
return	void

AddUsersToList() public method

Add the users in the file to a list of users

public AddUsersToList ( List &userList ) : int
userList	List	list to receive users
return	int

AllowDirCreate() public method

public AllowDirCreate ( string username, string foldername ) : bool
username	string
foldername	string
return	bool

AllowDirDelete() public method

public AllowDirDelete ( string username, string foldername ) : bool
username	string
foldername	string
return	bool

AllowDirList() public method

public AllowDirList ( string username, string foldername ) : bool
username	string
foldername	string
return	bool

AllowDirSubdirs() public method

public AllowDirSubdirs ( string username, string foldername ) : bool
username	string
foldername	string
return	bool

AllowFileDelete() public method

public AllowFileDelete ( string username, string foldername ) : bool
username	string
foldername	string
return	bool

AllowFileRead() public method

public AllowFileRead ( string username, string foldername ) : bool
username	string
foldername	string
return	bool

AllowFileWrite() public method

public AllowFileWrite ( string username, string foldername ) : bool
username	string
foldername	string
return	bool

AssignUserPassword() public method

Assign the supplied password to the supplied user account

public AssignUserPassword ( string username, string password ) : bool
username	string	user account
password	string	new password
return	bool

Authenticate() public method

Attempt to authenticate using the provided account and password

public Authenticate ( string username, string password ) : bool
username	string	user name for login
password	string	clear text password
return	bool

AuthenticateAdministration() public method

Authenticate as the server administrator - for some reason, this isn't encrypted

public AuthenticateAdministration ( string password ) : bool
password	string
return	bool

AutoCreate() public method

public AutoCreate ( string username, string foldername ) : bool
username	string
foldername	string
return	bool

CheckPermission() protected method

Check an permission flag

protected CheckPermission ( string username, string foldername, string permission ) : bool
username	string	account
foldername	string	dir for permissions
permission	string	specific permission
return	bool

CreateUser() public method

Create a new user account

public CreateUser ( string username, string password, bool enabled, bool fileRead, bool fileWrite, bool fileDelete, bool fileAppend, bool dirCreate, bool dirDelete, bool dirList, bool dirSubdirs, bool autoCreate ) : bool
username	string
password	string
enabled	bool
fileRead	bool
fileWrite	bool
fileDelete	bool
fileAppend	bool
dirCreate	bool
dirDelete	bool
dirList	bool
dirSubdirs	bool
autoCreate	bool
return	bool

Filezilla() public method

public Filezilla ( string configurationFile ) : System
configurationFile	string
return	System

ForceServerConfigurationLoad() public method

Force the server to reload the configuration

public ForceServerConfigurationLoad ( ) : bool
return	bool

GetMd5Sum() static public method

Calculated the md5 encrypted version of a string

static public GetMd5Sum ( string str ) : string
str	string	string to encrypt
return	string

GetUser() public method

Retrieve a user object by user name. This will throw if the user cannot be found

public GetUser ( string userName ) : FilezillaUser,
userName	string	target user
return	FilezillaUser,

HomeDirectory() public method

Retrieve this user's home directory from the configuration. Throws an exception if the user is not defined

public HomeDirectory ( string username ) : string
username	string	account
return	string

IsHome() public method

public IsHome ( string username, string foldername ) : bool
username	string
foldername	string
return	bool

NormalizeFolderName() public method

Normalize the definition of a folder to something we can work with

public NormalizeFolderName ( string rawFolder ) : string
rawFolder	string	raw folder definition
return	string

UserExists() public method

Check to see if a valid user exists

public UserExists ( string userName ) : bool
userName	string
return	bool

WriteConfiguration() public method

Write the XML back to the configuration file

public WriteConfiguration ( string filename ) : void
filename	string	destination
return	void

Property Details

config protected_oe property

protected XmlDocument config
return	XmlDocument