Table of Contents
Table 8.1. Function Summary: Core Module
| function | description |
|---|---|
| read_conf | locate and read the XML based configuration file |
| check_auth | check that this is an authorised access |
| auth_error | report an authentication error and suggest remedies |
| auth_user | return the registered username for this IP |
| add_auth | add a new authentication token to access control system |
| update_auth | update the external content cache .htaccess files |
| find_config_location | try to locate the specified XML config file |
| conf_get_attr | get the requested configuration attribute |
| conf_dosubs | do substitutions for the standard wacs configuration variables |
| auth_get_attr | get the requested access control list attribute |
| dberror | produce a more helpful error page when db connections fail |
| gettoday | get today's date as a string suitable for the current DB |
| timecomps | break a date down into component parts |
| cacheloc | provide expected location of the cache files for specified set |
| vendlink | provide a link to the vendors site |
| loadattrvalues | load attribute values from the database |
| getvaluename | takes a single character flag and converts to string |
| geticonlist | gets the icon array for the specified object type |
| gettypecolour | get the prevailing colour scheme for the set type |
| divideup | make a directory name more readable |
| checkexclude | check for this file name being one to ignore/hide |
| checkindex | check for what might be an index file |
| makedbsafe | try to make the returned string safe for use in the database |
| addheadercss | add standard preamble to enable javascript menus |
| setgroupperms | set the appropriate group permissions for co-operative updating |
| treemkdir | create a tree of directories (mkdir -p equiv) |