YaST2 Developers Documentation: Configuration of FtpServer

Configuration of FtpServer

modules/FtpServer.ycp
FtpServer settings, input and output functions
  • Jozef Uhliarik

This module has an unstable interface.

Representation of the configuration of FtpServer. Input and output routines.

Imports

  • CommandLine
  • Message
  • Mode
  • Package
  • Popup
  • PortAliases
  • Progress
  • Report
  • String
  • SuSEFirewall
  • SuSEFirewallServices
  • Summary
  • Users

Includes

  • ftp-server/write_load.ycp

Global Variables

Global Functions

Local Variables

Local Functions

global SetModified (boolean set_modified) -> void

Prototypes

Parameters:
set_modified
global modified -> boolean

Data was modified?

global proposal_valid -> boolean

general variable for proposal

global vsftpd_edit -> boolean

variable signifies if vsftpd is selected and edited via ftp-server (YaST module) global boolean variable

global vsftpd_installed -> boolean

variable signifies if vsftpd is installed and

global pureftpd_installed -> boolean

variable signifies if pure-ftpd is installed and

global vsftpd_xined_id -> integer

variable signifies position vsftpd record in structur Inetd::netd_conf -1 init value before calling Inetd::Read()

global pureftpd_xined_id -> integer

variable signifies if pure-ftpd is installed and in structur Inetd::netd_conf -1 init value before calling Inetd::Read()

global start_xinetd -> boolean

variable signifies if daemon will be started via xinetd

global pure_ftp_xinetd_running -> boolean

variable signifies if daemon is running via xinetd

global vsftp_xinetd_running -> boolean

variable signifies if daemon is running via xinetd

global stop_daemon_xinetd -> boolean

variable signifies if daemon will be stoped in xinetd

global create_upload_dir -> boolean

variable signifies if it is create upload dir only for vsftpd and anonymous connections with allowed upload

global upload_good_permission -> boolean

variable signifies if upload dir has good permissions only for vsftpd and anonymous connections with allowed upload

global pure_ftp_allowed_permissios_upload -> integer

variable signifies if upload dir for anonymous has good permissions it is only for pure-ftpd

global change_permissions -> boolean

variable signifies if user choose change permissions for home dir for anonymous connections with allowed upload

global anon_homedir -> string

variable signifies home dir for anonymous user

global anon_uid -> integer

variable signifies uid for anonymous user

local sl -> integer

variable signifies sleep time during reading settings

local userinfo -> map

variable includes user info about anonymous user

global pure_ftpd_xinet_conf -> list <string>

list includes xinetd server_args for pure-ftpd

global UI_keys -> list <string>

list of keys from map DEFAULT_CONFIG

global DEFAULT_CONFIG -> map <string, string >

map of deafult values for options in UI

global PURE_SETTINGS -> map <string, string >

map of pure-ftpd settings

global VS_SETTINGS -> map <string, string >

map of vsftpd settings

global EDIT_SETTINGS -> map <string, string >

map of vsftpd settings

local ReadPUREFTPDSettings () -> boolean

Read current pure-ftpd configuration

Return value:
successfull
local ReadVSFTPDSettings () -> boolean

Read current vsftpd configuration

Return value:
successfull
local ReadVSFTPDUpload () -> boolean

Read vsftpd configuration existing upload file and permissions

Return value:
successfull
local ReadPermisionUplaod () -> boolean

Read pure-fptd configuration checking permissions for upload

Return value:
successfull
local InitEDIT_SETTINGS () -> boolean

Remap current pure -FtpServer configuration to temporary structure

Return value:
successfull
local ReadSettings () -> boolean

Read current configuration

Return value:
successfull
local WritePUREFTPDSettings () -> boolean

Write pure-ftpd configuration to config file

Return value:
successfull
local WriteVSFTPDSettings () -> boolean

Write vsftpd configuration to config file

Return value:
successfull
local WriteToSETTINGS () -> boolean

Remap UI pure-ftpd or vsftpd configuration to write structure for SCR

Return value:
successfull
Info:

Restart daemon apply changes only if daemon running...

Return value:
successfull
local WriteFirewallSettings () -> boolean

Write firewall configuration

Return value:
successfull
global WriteToEditMap (string key, string value) -> boolean

Write value from UI to temporary structure

Parameters:
key
value
Return value:
successfull
global WriteSettings () -> boolean

Write current configuration

Return value:
successfull
global WriteXinetd () -> boolean

Write current configuration

Return value:
result of function (true/false)
global WriteUpload () -> boolean

Ask for creation upload directory It is necessary if user want to allow uploading for anonymous

Return value:
result of function (true/false)
global ValueUIEdit (string key) -> string

read value from PURE_EDIT_SETTINGS

Parameters:
key
Return value:
value of key from edit map
global ftps -> boolean

global write_only -> boolean

Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

Info:

Abort function return boolean return true if abort

global GetModified () -> boolean

Returns whether the configuration has been modified.

Return value:
modified
global SetModified (boolean set_modified) -> void

Function set modified variable.

Parameters:
set_modified
global Abort () -> boolean

Returns a confirmation popup dialog whether user wants to really abort.

Return value:
result of Popup::ReallyAbort(GetModified()
global PollAbort () -> boolean

Checks whether an Abort button has been pressed. If so, calls function to confirm the abort call.

Return value:
true if abort confirmed
global Modified () -> boolean

Data was modified?

Return value:
true if modified
global Read () -> boolean

Read all FtpServer settings

Return value:
true on success
global Write () -> boolean

Write all FtpServer settings

Return value:
true on success
global Import (map settings) -> boolean

Get all FtpServer settings from the first parameter (For use by autoinstallation.)

Parameters:
settings The YCP structure to be imported.
Return value:
True on success
global InitDaemon () -> boolean

Set which daemon will be configured (For use by autoinstallation.)

Return value:
True on success
global Export () -> map

Dump the FtpServer settings to a single map (For use by autoinstallation.)

Return value:
Dumped settings (later acceptable by Import ())
global OptionsSummary () -> string

Create unsorted list of options

Return value:
Returnes string with RichText-formated list
global Summary () -> string

Create a textual summary and a list of unconfigured cards

Return value:
summary of the current configuration
global Overview () -> list

Create an overview table with all configured cards

Return value:
table items