YaST2 Developers Documentation: Unknown YCP Module

Unknown YCP Module

This module has an unstable interface.

Imports

  • FileUtils
  • Message
  • Progress
  • Report
  • Service
  • SuSEFirewall
  • Summary
  • Summary

Global Variables

Global Functions

Local Variables

Local Functions

Info:

File: modules/Squid.ycp Package: Configuration of squid Summary: Squid settings, input and output functions Authors: Daniel Fiser

$Id: Squid.ycp 27914 2006-02-13 14:32:08Z locilka $

local squid_path -> path

Defines path used in SCR::Read/Write functions

local sysconfig_file -> string

Defines location of sysconfig file

local firewall_service_name -> string

Defines name of service which is used by firewall when it's openning ports.

local modified -> boolean

Data was modified?

local service_enabled_on_startup -> boolean

Is service enabled?

local settings -> map <string,any>

Map of all configuration settings except consequential. Format: $[ "parameter name" : [ list of options (rest of line) ] ... ]

local http_ports -> list <map <string,any> >

List of http_ports. Format: [ $["host" : "hostname", "port" : "3128", "transparent" : true], ... ]

local acls -> list <map <string,any> >

List of acls. Format: [ $[ "name" : "localhost", "type" : "src", "options" : [ non-empty list of options ]] ... ]

local http_accesses -> list <map <string,any> >

List of access control parameters. Format: [ $["allow" : true, "acl" : ["acl1", "!acl2", ...] ], ... ]

local refresh_patterns -> list <map <string,any> >

List of refresh patterns. Format: [ $["regexp" : "^ftp:", "case_sensitive" : true, "min" : "12", "max" : "12", "percent" : "12"], ... ]

local parameters -> map <string, list>

Map of all available parameters with defalut values. $[ "parameter_name" : [ list of default options ], ... ]

global write_only -> boolean

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

local split (string str, string delim) -> list<string>

Same as splitstring(), but returns only non-empty strings.

Parameters:
str
delim
local verifyACLs () -> void

Verify and repair list of ACLs if something's wrong.

local setWritePremissionsToCacheDir (string dir) -> boolean

Function which sets permissions 'chmod 750' and 'chown squid:root' to directory dir if exists. If dir does not exist, function returns true;

Parameters:
dir
Info:

Abort function return boolean return true if abort

global Abort () -> boolean

Abort function

Return value:
return true if abort
global NumACLs (integer id_item) -> integer

Returns number of occurences of ACL (definition lines) in config file.

Parameters:
id_item
global NumACLsByName (string name) -> integer

Same as NumACLs but ACL is identified by name.

Parameters:
name
global ACLIsUsedBy (integer id_item) -> list<string>

Returns list of options which use this ACL (identified by id_item). It's necessary to run this function before deleting ACL to know if any options are not affected.

Parameters:
id_item
global GetHttpPortsOnly () -> list<string>

Returns only list of configured ports (no hosts and so on)

local readHttpPorts () -> boolean

Read setting of parameter http_port. http_port [hostname:]port [transparent]

local readHttpAccesses () -> boolean

Read setting of parameter http_access. http_access allow acl1 !acl2 ...

local readRefreshPatterns () -> boolean

Read setting of parameter refresh_pattern. refresh_pattern [-i] regexp min percent max [options (ignored)]

local readACLs () -> boolean

Read setting of parameter acl. acl aclname acltype string1 string2 ...

local readRestSetting () -> boolean

Read rest of setting. return true on success

global Read () -> boolean

Read all squid settings

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

Returns true if Squid service is running.

global StartService () -> boolean

Start Squid service if not running otherwise reload. Returns true if squid was successfuly started

global StopService () -> boolean

Stop Squid service. Returns true if squid was successfuly stopped

global Write () -> boolean

Write all squid settings

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

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

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

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

Return value:
Dumped settings (later acceptable by Import ())
global Summary () -> list

Create a textual summary and a list of unconfigured cards

Return value:
summary of the current configuration
Info:

Create an overview table with all configured cards

Return value:
table items global list Overview() { return []; }