YaST2 Developers Documentation: Common widget manipulation, TSIG keys management widget


functions
files
intro

Common widget manipulation, TSIG keys management widget

 modules/CWMTsigKeys.ycp
Routines for management of TSIG keys

Imports

  • CWM
  • Label
  • Popup
  • Report

Global Functions

Local Variables

Local Functions

local tsig_keys -> list<map<string,string> >

Currently configured TSIG keys Each entry is a map with keys "filename" and "key"

local deleted_tsig_keys -> list<string>

Filenames of the files that contained deleted TSIG keys

local new_tsig_keys -> list<string>

Filenames of the new added TSIG keys

local DdnsKeysWidgetRedraw () -> void

Redraw the table of DDNS keys

local Key2File (string key) -> string

Get the file that contains the specified key

Parameters:
key string key ID
Return value:
file containing the key

local RemoveTSIGKeyFile (string filename) -> void

Remove file with all TSIG keys it contains

Parameters:
filename string filename of the file with the TSIG keys

local RemoveTSIGKey (string key) -> void

Remove file containing specified TSIG key

Parameters:
key string key ID

local AddTSIGKeyFile (string filename) -> void

Add new file with TSIG key

Parameters:
filename string filename of the file with the TSIG key

global NormalizeFilename (string filename) -> string

Remove leading and trailibg blanks and quotes from file name

Parameters:
filename string file name
Return value:
file name without leading/trailing quotes and blanks

global AnalyzeTSIGKeyFile (string filename) -> list<string>

Analyze file that may contain TSIG keys

Parameters:
filename string filename of the file that may contain TSIG keys
Return value:
a list of all TSIG key IDs in the file

global DeleteTSIGKeyFromDisk (string main) -> void

Remove all 3 files holding the TSIG key data

Parameters:
main string filename of the main file

global Files2KeyMaps (list<string> filenames) -> list<map<string,string> >

Transformate the list of files to the list of TSIG key description maps

Parameters:
filenames a list of file names of the TSIG keys
Return value:
a list of TSIG key describing maps

global Files2Keys (list<string> filenames) -> list<string>

Get all TSIG keys that present in the files

Parameters:
filenames
Return value:
a list of all TSIG key IDs

global Init (map<string,any> widget, string key) -> void

Init function of the widget

Parameters:
widget
key strnig the widget key

global Handle (map<string,any> widget, string key, map event) -> symbol

Handle function of the widget

Parameters:
widget
key strnig the widget key
event map event to be handled
Return value:
for wizard sequencer or nil

global Store (map<string,any> widget, string key, map event) -> void

Store function of the widget

Parameters:
widget
key strnig the widget key
event map that caused widget data storing

global InitWrapper (string key) -> void

Store function of the widget

Parameters:
key strnig the widget key

global HandleWrapper (string key, map event) -> symbol

Handle function of the widget

Parameters:
key strnig the widget key
event map event to be handled
Return value:
for wizard sequencer or nil

global StoreWrapper (string key, map event) -> void

Store function of the widget

Parameters:
key strnig the widget key
event map that caused widget data storing

global CreateWidget (map<string,any> settings) -> map<string,any>

Get the widget description map

Parameters:
settings a map of all parameters needed to create the widget properly 
 "get_keys_info" : map() -- function for getting information
          about TSIG keys. Return map should contain:
           - "removed_files" : list -- files that have been removed
           - "new_files" : list -- files that have been added
           - "tsig_keys" : list> -- list of all TSIG keys
           - "key_files" : list -- list of all files that may contain
                       TSIG keys
           Either "tsig_keys" or "key_files" are mandatory
 "set_keys_info" : void (map) -- function for storing information
          about keys. Map has keys:
           - "removed_files" : list -- files that have been removed
           - "new_files" : list -- files that have been added
           - "tsig_keys" : list> -- list of all TSIG keys
           - "key_files" : list -- list of all files that contain
                       TSIG keys

 Additional settings:
 - "list_used_keys" : list() -- function for getting the list of
          used TSIG keys. The list is used to prevent used TSIG keys from
          being deleted. If not present, all keys may get deleted.
 - "help" : string -- help to the whole widget. If not specified, generic help
          is used (button labels are patched correctly)
Return value:
a map the widget description map
YaST2 Developers Documentation