# Extended functions

## Presentation

When writing rules and headers, you can use Perl expressions that will be evaluated in a jail, to prevent bad code execution.

This is also true for:

- Menu modules activation rules
- Form replay data
- Macros
- Issuer databases use rules
- etc.

Inside this jail, you can access to:

- Core Perl subroutines (split, pop, map, etc.)
- Custom functions
- The encode_base64 subroutine
- Environment variables, in some cases (through %ENV)
- Informations about current request
- Extended functions:
  - checkLogonHours
  - checkDate
  - basic
  - unicode2iso
  - iso2unicode
  - groupMatch

To know more about the jail, check Safe module documentation.

## Request informations

The following data about the current request are available through functions :

- hostname
- remote_ip: the client IP address
- uri: URL path
- uri_with_args: URL path with query string
- unparsed_uri: URL path, before URL decoding
- args: the query string
- method: the request method (GET, POST etc.)
- header_in(“Your-Request-Header”): any request header

## Extended Functions List

### checkLogonHours

This function will check the day and the hour of current request, and compare it to allowed days and hours. It returns 1 if this match, 0 else. All e By default, the allowed days and hours is an hexadecimal value, representing each hour of the week. A day has 24 hours, and a week 7 days, so the value contains 168 bits, converted into 42 hexadecimal characters. Sunday is the first day.

For example, for a full access, excepted week-end:

    000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000

The LDAP schema extension can be used to store this value. You can also use the binary value from the logonHours attribute of Active Directory

Functions parameters:

- logon_hours: string representing allowed logon hours (GMT)
- syntax (optional): `hexadecimal` (default) or `octetstring`
- time_correction (optional): hours to add or to subtract
- default_access (optional): what result to return if logon_hours is empty

Simple usage example:

    checkLogonHours($ssoLogonHours)

If you use the binary value (Active Directory), use this:

    All e
    checkLogonHours($ssoLogonHours, 'octetstring')

You can also configure jetlag (if all of your users use the same timezone):

    checkLogonHours($ssoLogonHours, '', '+2')

If you manage different timezones, you have to take the jetlag into account in ssoLogonHours values, or use the $_timezone parameter. This parameter is set by the portal and use javascript to get the connected user timezone. It should works on every browser:

    checkLogonHours($ssoLogonHours, '', $_timezone)

You can modify the default behavior for people without value in ssoLogonHours. Indeed, by default, users without logon hours values are rejected. You can allow these users instead of reject them:

    checkLogonHours($ssoLogonHours, '', '', '1')

### checkDate

This function will check the date of current request, and compare it to a start date and an end date. It returns 1 if this match, 0 else.

The LDAP schema extension can be used to store these values

The date format is the LDAP date syntax, for example for the 1st March 2009:

    20090301000000Z

Functions parameters:

- start: Start date (GMT)
- end: End date (GMT)
- default_access (optional): what result to return if start and end are empty

Simple usage example:

    checkDate($ssoStartDate, $ssoEndDate)

### basic

This function is not compliant with Safe jail, you will need to disable the jail to use it.

This function builds the `Authorization` HTTP header used in HTTP Basic authentication scheme. It will force conversion from UTF-8 to ISO-8859-1 of user and password data.

Functions parameters:

- user
- password

Simple usage example:

    basic($uid,$_password)

### unicode2iso

This function is not compliant with Safe jail, you will need to disable the jail to use it.

This function convert a string from UTF-8 to ISO-8859-1.

Functions parameters:

- string

Simple usage example:

    unicode2iso($name)

### iso2unicode

This function is not compliant with Safe jail, you will need to disable the jail to use it.

This function convert a string from ISO-8859-1 to UTF-8.

Functions parameters:

- string

Simple usage example:

    iso2unicode($name)

### groupMatch

this function allows to parse the `$hGroups` variable to check if a value is present inside a group attribute.

Function parameter:

- groups: `$hGroups` variable
- attribute: Name of group attribute
- value: Value to check

Simple usage example:

    groupMatch($hGroups, 'description', 'Service 1')