allow Rows to have attributes (#1133)

[racktables-incomplete-works] / wwwroot / inc / ophandlers.php

<?php

# This file is a part of RackTables, a datacenter and server room management
# framework. See accompanying file "COPYING" for the full copyright and
# licensing information.

/*

"Ophandler" in RackTables stands for "operation handler", or a function
that handles execution of "operation" (in the meaning explained in
navigation.php). Most of the ophandlers are meant to perform one specific
action, for example, to set a name of an object. Each such action often
requires a set of parameters (e. g. ID of the object and the new name),
and it is responsibility of each ophandler function to verify, that all
necessary parameters are provided by the user and have proper values. There
is a number of helper functions to make such verification simpler.

Errors occuring in ophandlers are typically indicated with exceptions of
assorted classes. Namely, an "InvalidRequestArgException" class means, that
at least one of the parameters provided by the user is not acceptable. This
is a "soft" error, which gets displayed in the standard message area of
otherwise usual interface. A different case is "InvalidArgException", which
means that one of the internal functions detected its argument(s) invalid
or corrupted, and that argument(s) did not come from user's input (and thus
cannot be fixed without fixing a bug in the code). Such "hard" errors don't
get special early handling and end up in the default catching block. The
latter may print a detailed stack trace instead of the interface HTML to
help a developer debug the issue.

As long as an ophandler makes through its request (extracting arguments,
performing validation and actually updating records in the database), it
may queue up messages (often referred to as "green" and "red" bars) by
means of showError() and showSuccess() functions. The messages are not
displayed immediately, because successfull ophandlers are expected to
return only the new URL, where the user will be immediately redirected to
(it is also possible to return an empty string to mean, that the current
logical location remains the same). The page at the "next" location is
supposed to translate message buffer into the standard message area.

A very special case of an ophandler is tableHandler(). This generic
function handles the most trivial actions, which map to a single INSERT,
UPDATE or DELETE SQL statement with a fixed number of arguments. The rules
of argument validation and mapping are listed in $opspec_list (operation
specifications list) array.

*/

// This array is deprecated. Please do not add new message constants to it.
// use the new showError, showWarning, showSuccess functions instead
global $msgcode;
$msgcode = array();

global $opspec_list;
$opspec_list = array();

$opspec_list['object-edit-unlinkObjects'] = array
(
        'table' => 'EntityLink',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'link_id', 'table_colname' => 'id', 'assertion' => 'uint'),
        ),
);
$opspec_list['object-ports-useup'] = array
(
        'table' => 'Port',
        'action' => 'UPDATE',
        'set_arglist' => array
        (
                array ('fix_argname' => 'reservation_comment', 'fix_argvalue' => NULL),
        ),
        'where_arglist' => array
        (
                array ('url_argname' => 'port_id', 'table_colname' => 'id', 'assertion' => 'uint'),
                array ('url_argname' => 'object_id', 'assertion' => 'uint'), # preserve context
        ),
);
$opspec_list['object-ports-delPort'] = array
(
        'table' => 'Port',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'port_id', 'table_colname' => 'id', 'assertion' => 'uint'),
                array ('url_argname' => 'object_id', 'assertion' => 'uint'),
        ),
);
$opspec_list['object-ports-deleteAll'] = array
(
        'table' => 'Port',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'object_id', 'assertion' => 'uint'),
        ),
);
$opspec_list['location-log-del'] = array
(
        'table' => 'ObjectLog',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'log_id', 'table_colname' => 'id', 'assertion' => 'uint'),
                array ('url_argname' => 'location_id', 'table_colname' => 'object_id', 'assertion' => 'uint'),
        ),
);
$opspec_list['object-log-del'] = array
(
        'table' => 'ObjectLog',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'log_id', 'table_colname' => 'id', 'assertion' => 'uint'),
                array ('url_argname' => 'object_id', 'assertion' => 'uint'),
        ),
);
$opspec_list['rack-log-del'] = array
(
        'table' => 'ObjectLog',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'log_id', 'table_colname' => 'id', 'assertion' => 'uint'),
                array ('url_argname' => 'rack_id', 'table_colname' => 'object_id', 'assertion' => 'uint'),
        ),
);
$opspec_list['ipv4vs-editlblist-delLB'] =
$opspec_list['ipv4rspool-editlblist-delLB'] =
$opspec_list['object-editrspvs-delLB'] = array
(
        'table' => 'IPv4LB',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'object_id', 'assertion' => 'uint'),
                array ('url_argname' => 'pool_id', 'table_colname' => 'rspool_id', 'assertion' => 'uint'),
                array ('url_argname' => 'vs_id', 'assertion' => 'uint'),
        ),
);
$opspec_list['ipv4vs-editlblist-updLB'] =
$opspec_list['ipv4rspool-editlblist-updLB'] =
$opspec_list['object-editrspvs-updLB'] = array
(
        'table' => 'IPv4LB',
        'action' => 'UPDATE',
        'set_arglist' => array
        (
                array ('url_argname' => 'vsconfig', 'assertion' => 'string0', 'if_empty' => 'NULL'),
                array ('url_argname' => 'rsconfig', 'assertion' => 'string0', 'if_empty' => 'NULL'),
                array ('url_argname' => 'prio', 'assertion' => 'string0', 'if_empty' => 'NULL'),
        ),
        'where_arglist' => array
        (
                array ('url_argname' => 'object_id', 'assertion' => 'uint'),
                array ('url_argname' => 'pool_id', 'table_colname' => 'rspool_id', 'assertion' => 'uint'),
                array ('url_argname' => 'vs_id', 'assertion' => 'uint'),
        ),
);
$opspec_list['object-cacti-add'] = array
(
        'table' => 'CactiGraph',
        'action' => 'INSERT',
        'arglist' => array
        (
                array ('url_argname' => 'object_id', 'assertion' => 'uint'),
                array ('url_argname' => 'server_id', 'assertion' => 'uint'),
                array ('url_argname' => 'graph_id', 'assertion' => 'uint'),
                array ('url_argname' => 'caption', 'assertion' => 'string0'),
        ),
);
$opspec_list['object-cacti-del'] = array
(
        'table' => 'CactiGraph',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'object_id', 'assertion' => 'uint'),
                array ('url_argname' => 'server_id', 'assertion' => 'uint'),
                array ('url_argname' => 'graph_id', 'assertion' => 'uint'),
        ),
);
$opspec_list['object-munin-add'] = array
(
        'table' => 'MuninGraph',
        'action' => 'INSERT',
        'arglist' => array
        (
                array ('url_argname' => 'object_id', 'assertion' => 'uint'),
                array ('url_argname' => 'server_id', 'assertion' => 'uint'),
                array ('url_argname' => 'graph', 'assertion' => 'string'),
                array ('url_argname' => 'caption', 'assertion' => 'string0'),
        ),
);
$opspec_list['object-munin-del'] = array
(
        'table' => 'MuninGraph',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'object_id', 'assertion' => 'uint'),
                array ('url_argname' => 'server_id', 'assertion' => 'uint'),
                array ('url_argname' => 'graph', 'assertion' => 'string'),
        ),
);
$opspec_list['ipv4rspool-editrslist-delRS'] = array
(
        'table' => 'IPv4RS',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'id', 'assertion' => 'uint'),
        ),
);
$opspec_list['parentmap-edit-add'] = array
(
        'table' => 'ObjectParentCompat',
        'action' => 'INSERT',
        'arglist' => array
        (
                array ('url_argname' => 'parent_objtype_id', 'assertion' => 'uint'),
                array ('url_argname' => 'child_objtype_id', 'assertion' => 'uint'),
        ),
);
$opspec_list['parentmap-edit-del'] = array
(
        'table' => 'ObjectParentCompat',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'parent_objtype_id', 'assertion' => 'uint'),
                array ('url_argname' => 'child_objtype_id', 'assertion' => 'uint'),
        ),
);
$opspec_list['portmap-edit-add'] = array
(
        'table' => 'PortCompat',
        'action' => 'INSERT',
        'arglist' => array
        (
                array ('url_argname' => 'type1', 'assertion' => 'uint'),
                array ('url_argname' => 'type2', 'assertion' => 'uint'),
        ),
);
$opspec_list['portmap-edit-del'] = array
(
        'table' => 'PortCompat',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'type1', 'assertion' => 'uint'),
                array ('url_argname' => 'type2', 'assertion' => 'uint'),
        ),
);
$opspec_list['portifcompat-edit-del'] = array
(
        'table' => 'PortInterfaceCompat',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'iif_id', 'assertion' => 'uint'),
                array ('url_argname' => 'oif_id', 'assertion' => 'uint'),
        ),
);
$opspec_list['attrs-editmap-del'] = array
(
        'table' => 'AttributeMap',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'attr_id', 'assertion' => 'uint'),
                array ('url_argname' => 'objtype_id', 'assertion' => 'uint'),
        ),
);
$opspec_list['attrs-editattrs-add'] = array
(
        'table' => 'Attribute',
        'action' => 'INSERT',
        'arglist' => array
        (
                array ('url_argname' => 'attr_type', 'table_colname' => 'type', 'assertion' => 'enum/attr_type'),
                array ('url_argname' => 'attr_name', 'table_colname' => 'name', 'assertion' => 'string'),
        ),
);
$opspec_list['attrs-editattrs-del'] = array
(
        'table' => 'Attribute',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'attr_id', 'table_colname' => 'id', 'assertion' => 'uint'),
        ),
);
$opspec_list['attrs-editattrs-upd'] = array
(
        'table' => 'Attribute',
        'action' => 'UPDATE',
        'set_arglist' => array
        (
                array ('url_argname' => 'attr_name', 'table_colname' => 'name', 'assertion' => 'string'),
        ),
        'where_arglist' => array
        (
                array ('url_argname' => 'attr_id', 'table_colname' => 'id', 'assertion' => 'uint'),
        ),
);
$opspec_list['dict-chapters-add'] = array
(
        'table' => 'Chapter',
        'action' => 'INSERT',
        'arglist' => array
        (
                array ('url_argname' => 'chapter_name', 'table_colname' => 'name', 'assertion' => 'string')
        ),
);
$opspec_list['chapter-edit-add'] = array
(
        'table' => 'Dictionary',
        'action' => 'INSERT',
        'arglist' => array
        (
                array ('url_argname' => 'chapter_no', 'table_colname' => 'chapter_id', 'assertion' => 'uint'),
                array ('url_argname' => 'dict_value', 'assertion' => 'string'),
        ),
);
$opspec_list['chapter-edit-del'] = array
(
        'table' => 'Dictionary',
        'action' => 'DELETE',
        'arglist' => array
        (
                // Technically dict_key is enough to delete, but including chapter_id into
                // WHERE clause makes sure, that the action actually happends for the same
                // chapter that authorization was granted for.
                array ('url_argname' => 'chapter_no', 'table_colname' => 'chapter_id', 'assertion' => 'uint'),
                array ('url_argname' => 'dict_key', 'assertion' => 'uint'),
                array ('fix_argname' => 'dict_sticky', 'fix_argvalue' => 'no'), # protect system rows
        ),
);
$opspec_list['chapter-edit-upd'] = array
(
        'table' => 'Dictionary',
        'action' => 'UPDATE',
        'set_arglist' => array
        (
                array ('url_argname' => 'dict_value', 'assertion' => 'string'),
        ),
        'where_arglist' => array
        (
                # same as above for listing chapter_no
                array ('url_argname' => 'chapter_no', 'table_colname' => 'chapter_id', 'assertion' => 'uint'),
                array ('url_argname' => 'dict_key', 'assertion' => 'uint'),
                array ('fix_argname' => 'dict_sticky', 'fix_argvalue' => 'no'), # protect system rows
        ),
);
$opspec_list['tagtree-edit-createTag'] = array
(
        'table' => 'TagTree',
        'action' => 'INSERT',
        'arglist' => array
        (
                array ('url_argname' => 'tag_name', 'table_colname' => 'tag', 'assertion' => 'tag'),
                array ('url_argname' => 'parent_id', 'assertion' => 'uint0', 'if_empty' => 'NULL'),
                array ('url_argname' => 'is_assignable', 'assertion' => 'enum/yesno'),
        ),
);
$opspec_list['tagtree-edit-destroyTag'] = array
(
        'table' => 'TagTree',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'tag_id', 'table_colname' => 'id', 'assertion' => 'uint'),
        ),
);
$opspec_list['8021q-vstlist-add'] = array
(
        'table' => 'VLANSwitchTemplate',
        'action' => 'INSERT',
        'arglist' => array
        (
                array ('url_argname' => 'vst_descr', 'table_colname' => 'description', 'assertion' => 'string'),
        ),
);
$opspec_list['8021q-vstlist-del'] = array
(
        'table' => 'VLANSwitchTemplate',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'vst_id', 'table_colname' => 'id', 'assertion' => 'uint'),
        ),
);
$opspec_list['8021q-vstlist-upd'] = array
(
        'table' => 'VLANSwitchTemplate',
        'action' => 'UPDATE',
        'set_arglist' => array
        (
                array ('url_argname' => 'vst_descr', 'table_colname' => 'description', 'assertion' => 'string'),
        ),
        'where_arglist' => array
        (
                array ('url_argname' => 'vst_id', 'table_colname' => 'id', 'assertion' => 'uint'),
        ),
);
$opspec_list['8021q-vdlist-del'] = array
(
        'table' => 'VLANDomain',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'vdom_id', 'table_colname' => 'id', 'assertion' => 'uint'),
        ),
);
$opspec_list['8021q-vdlist-upd'] = array
(
        'table' => 'VLANDomain',
        'action' => 'UPDATE',
        'set_arglist' => array
        (
                array ('url_argname' => 'vdom_descr', 'table_colname' => 'description', 'assertion' => 'string'),
        ),
        'where_arglist' => array
        (
                array ('url_argname' => 'vdom_id', 'table_colname' => 'id', 'assertion' => 'uint'),
        ),
);
$opspec_list['vlandomain-vlanlist-add'] = array
(
        'table' => 'VLANDescription',
        'action' => 'INSERT',
        'arglist' => array
        (
                array ('url_argname' => 'vdom_id', 'table_colname' => 'domain_id', 'assertion' => 'uint'),
                array ('url_argname' => 'vlan_id', 'assertion' => 'vlan'),
                array ('url_argname' => 'vlan_type', 'assertion' => 'enum/vlan_type'),
                array ('url_argname' => 'vlan_descr', 'assertion' => 'string0', 'if_empty' => 'NULL'),
        ),
);
$opspec_list['vlandomain-vlanlist-del'] = array
(
        'table' => 'VLANDescription',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'vdom_id', 'table_colname' => 'domain_id', 'assertion' => 'uint'),
                array ('url_argname' => 'vlan_id', 'assertion' => 'vlan'),
        ),
);
$opspec_list['vlan-edit-upd'] = // both locations are using the same tableHandler op
$opspec_list['vlandomain-vlanlist-upd'] = array
(
        'table' => 'VLANDescription',
        'action' => 'UPDATE',
        'set_arglist' => array
        (
                array ('url_argname' => 'vlan_type', 'assertion' => 'enum/vlan_type'),
                array ('url_argname' => 'vlan_descr', 'assertion' => 'string0', 'if_empty' => 'NULL'),
        ),
        'where_arglist' => array
        (
                array ('url_argname' => 'vdom_id', 'table_colname' => 'domain_id', 'assertion' => 'uint'),
                array ('url_argname' => 'vlan_id', 'assertion' => 'vlan'),
        ),
);
$opspec_list['dict-chapters-upd'] = array
(
        'table' => 'Chapter',
        'action' => 'UPDATE',
        'set_arglist' => array
        (
                array ('url_argname' => 'chapter_name', 'table_colname' => 'name', 'assertion' => 'string'),
        ),
        'where_arglist' => array
        (
                array ('url_argname' => 'chapter_no', 'table_colname' => 'id', 'assertion' => 'uint'),
                array ('fix_argname' => 'sticky', 'fix_argvalue' => 'no'), # protect system chapters
        ),
);
$opspec_list['dict-chapters-del'] = array
(
        'table' => 'Chapter',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'chapter_no', 'table_colname' => 'id', 'assertion' => 'uint'),
                array ('fix_argname' => 'sticky', 'fix_argvalue' => 'no'), # protect system chapters
        ),
);
$opspec_list['cacti-servers-add'] = array
(
        'table' => 'CactiServer',
        'action' => 'INSERT',
        'arglist' => array
        (
                array ('url_argname' => 'base_url', 'assertion' => 'string'),
                array ('url_argname' => 'username', 'assertion' => 'string0'),
                array ('url_argname' => 'password', 'assertion' => 'string0'),
        ),
);
$opspec_list['cacti-servers-del'] = array
(
        'table' => 'CactiServer',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'id', 'assertion' => 'uint'),
        ),
);
$opspec_list['cacti-servers-upd'] = array
(
        'table' => 'CactiServer',
        'action' => 'UPDATE',
        'set_arglist' => array
        (
                array ('url_argname' => 'base_url', 'assertion' => 'string'),
                array ('url_argname' => 'username', 'assertion' => 'string0'),
                array ('url_argname' => 'password', 'assertion' => 'string0'),
        ),
        'where_arglist' => array
        (
                array ('url_argname' => 'id', 'assertion' => 'uint'),
        ),
);
$opspec_list['munin-servers-add'] = array
(
        'table' => 'MuninServer',
        'action' => 'INSERT',
        'arglist' => array
        (
                array ('url_argname' => 'base_url', 'assertion' => 'string')
        ),
);
$opspec_list['munin-servers-del'] = array
(
        'table' => 'MuninServer',
        'action' => 'DELETE',
        'arglist' => array
        (
                array ('url_argname' => 'id', 'assertion' => 'uint'),
        ),
);
$opspec_list['munin-servers-upd'] = array
(
        'table' => 'MuninServer',
        'action' => 'UPDATE',
        'set_arglist' => array
        (
                array ('url_argname' => 'base_url', 'assertion' => 'string'),
        ),
        'where_arglist' => array
        (
                array ('url_argname' => 'id', 'assertion' => 'uint'),
        ),
);

$msgcode['addPortForwarding']['OK'] = 48;
function addPortForwarding ()
{
        assertUIntArg ('object_id');
        $localip_bin = assertIPv4Arg ('localip');
        $remoteip_bin = assertIPv4Arg ('remoteip');
        if ($_REQUEST['proto'] != 'ALL')
        {
                assertUIntArg ('localport');
                assertUIntArg ('remoteport');
        }
        assertStringArg ('proto');
        assertStringArg ('description', TRUE);
        $remoteport = isset ($_REQUEST['remoteport']) ? $_REQUEST['remoteport'] : '';
        if (!strlen ($remoteport))
                $remoteport = $_REQUEST['localport'];

        newPortForwarding
        (
                $_REQUEST['object_id'],
                $localip_bin,
                $_REQUEST['localport'],
                $remoteip_bin,
                $remoteport,
                $_REQUEST['proto'],
                $_REQUEST['description']
        );

        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['delPortForwarding']['OK'] = 49;
function delPortForwarding ()
{
        assertUIntArg ('object_id');
        $localip_bin = assertIPv4Arg ('localip');
        $remoteip_bin = assertIPv4Arg ('remoteip');
        if ($_REQUEST['proto'] != 'ALL')
        {
                assertUIntArg ('localport');
                assertUIntArg ('remoteport');
        }
        assertStringArg ('proto');

        deletePortForwarding
        (
                $_REQUEST['object_id'],
                $localip_bin,
                $_REQUEST['localport'],
                $remoteip_bin,
                $_REQUEST['remoteport'],
                $_REQUEST['proto']
        );
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['updPortForwarding']['OK'] = 51;
function updPortForwarding ()
{
        assertUIntArg ('object_id');
        $localip_bin = assertIPv4Arg ('localip');
        $remoteip_bin = assertIPv4Arg ('remoteip');
        if ($_REQUEST['proto'] != 'ALL')
        {
                assertUIntArg ('localport');
                assertUIntArg ('remoteport');
        }
        assertStringArg ('proto');
        assertStringArg ('description', TRUE);

        updatePortForwarding
        (
                $_REQUEST['object_id'],
                $localip_bin,
                $_REQUEST['localport'],
                $remoteip_bin,
                $_REQUEST['remoteport'],
                $_REQUEST['proto'],
                $_REQUEST['description']
        );
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['addPortForObject']['OK'] = 48;
function addPortForObject ()
{
        assertStringArg ('port_name', TRUE);
        genericAssertion ('port_l2address', 'l2address0');
        genericAssertion ('port_name', 'string');
        commitAddPort
        (
                $_REQUEST['object_id'],
                trim ($_REQUEST['port_name']),
                $_REQUEST['port_type_id'],
                trim ($_REQUEST['port_label']),
                trim ($_REQUEST['port_l2address'])
        );
        showFuncMessage (__FUNCTION__, 'OK', array ($_REQUEST['port_name']));
}

$msgcode['editPortForObject']['OK'] = 6;
function editPortForObject ()
{
        global $sic;
        assertUIntArg ('port_id');
        assertUIntArg ('port_type_id');
        assertStringArg ('reservation_comment', TRUE);
        genericAssertion ('l2address', 'l2address0');
        genericAssertion ('name', 'string');
        commitUpdatePort ($sic['object_id'], $sic['port_id'], $sic['name'], $sic['port_type_id'], $sic['label'], $sic['l2address'], $sic['reservation_comment']);
        if (array_key_exists ('cable', $_REQUEST))
                commitUpdatePortLink ($sic['port_id'], $sic['cable']);
        showFuncMessage (__FUNCTION__, 'OK', array ($_REQUEST['name']));
}

$msgcode['addMultiPorts']['OK'] = 10;
function addMultiPorts ()
{
        assertStringArg ('format');
        assertStringArg ('input');
        assertStringArg ('port_type');
        $format = $_REQUEST['format'];
        $port_type = $_REQUEST['port_type'];
        $object_id = $_REQUEST['object_id'];
        // Input lines are escaped, so we have to explode and to chop by 2-char
        // \n and \r respectively.
        $lines1 = explode ("\n", $_REQUEST['input']);
        foreach ($lines1 as $line)
        {
                $parts = explode ('\r', $line);
                reset ($parts);
                if (!strlen ($parts[0]))
                        continue;
                else
                        $lines2[] = rtrim ($parts[0]);
        }
        $ports = array();
        foreach ($lines2 as $line)
        {
                switch ($format)
                {
                        case 'fisxii':
                                $words = explode (' ', preg_replace ('/[[:space:]]+/', ' ', $line));
                                list ($slot, $port) = explode ('/', $words[0]);
                                $ports[] = array
                                (
                                        'name' => "e ${slot}/${port}",
                                        'l2address' => $words[8],
                                        'label' => "slot ${slot} port ${port}"
                                );
                                break;
                        case 'c3600asy':
                                $words = explode (' ', preg_replace ('/[[:space:]]+/', ' ', trim (substr ($line, 3))));
/*
How Async Lines are Numbered in Cisco 3600 Series Routers
http://www.cisco.com/en/US/products/hw/routers/ps274/products_tech_note09186a00801ca70b.shtml

Understanding 16- and 32-Port Async Network Modules
http://www.cisco.com/en/US/products/hw/routers/ps274/products_tech_note09186a00800a93f0.shtml
*/
                                $async = $words[0];
                                $slot = floor (($async - 1) / 32);
                                $octalgroup = floor (($async - 1 - $slot * 32) / 8);
                                $cable = $async - $slot * 32 - $octalgroup * 8;
                                $og_label[0] = 'async 0-7';
                                $og_label[1] = 'async 8-15';
                                $og_label[2] = 'async 16-23';
                                $og_label[3] = 'async 24-31';
                                $ports[] = array
                                (
                                        'name' => "async ${async}",
                                        'l2address' => '',
                                        'label' => "slot ${slot} " . $og_label[$octalgroup] . " cable ${cable}"
                                );
                                break;
                        case 'fiwg':
                                $words = explode (' ', preg_replace ('/[[:space:]]+/', ' ', $line));
                                $ifnumber = $words[0] * 1;
                                $ports[] = array
                                (
                                        'name' => "e ${ifnumber}",
                                        'l2address' => "${words[8]}",
                                        'label' => "${ifnumber}"
                                );
                                break;
                        case 'ssv1':
                                $words = explode (' ', $line);
                                if (!strlen ($words[0]) or !strlen ($words[1]))
                                        continue;
                                $ports[] = array
                                (
                                        'name' => $words[0],
                                        'l2address' => $words[1],
                                        'label' => ''
                                );
                                break;
                        default:
                                throw new InvalidRequestArgException ('format', $format);
                                break;
                }
        }
        // Create ports, if they don't exist.
        $added_count = $updated_count = $error_count = 0;
        foreach ($ports as $port)
        {
                $port_ids = getPortIDs ($object_id, $port['name']);
                if (!count ($port_ids))
                {
                        commitAddPort ($object_id, $port['name'], $port_type, $port['label'], $port['l2address']);
                        $added_count++;
                }
                elseif (count ($port_ids) == 1) // update only single-socket ports
                {
                        commitUpdatePort ($object_id, $port_ids[0], $port['name'], $port_type, $port['label'], $port['l2address']);
                        $updated_count++;
                }
        }
        showFuncMessage (__FUNCTION__, 'OK', array ($added_count, $updated_count, $error_count));
}

$msgcode['addBulkPorts']['OK'] = 82;
function addBulkPorts ()
{
        assertStringArg ('port_type_id');
        assertStringArg ('port_name', TRUE);
        assertStringArg ('port_label', TRUE);
        assertUIntArg ('port_numbering_start', TRUE);
        assertUIntArg ('port_numbering_count');

        $object_id = $_REQUEST['object_id'];
        $port_name = $_REQUEST['port_name'];
        $port_type_id = $_REQUEST['port_type_id'];
        $port_label = $_REQUEST['port_label'];
        $port_numbering_start = $_REQUEST['port_numbering_start'];
        $port_numbering_count = $_REQUEST['port_numbering_count'];

        $added_count = $error_count = 0;
        if(strrpos($port_name, "%u") === false )
                $port_name .= '%u';
        for ($i=0,$c=$port_numbering_start; $i<$port_numbering_count; $i++,$c++)
        {
                commitAddPort ($object_id, @sprintf($port_name,$c), $port_type_id, @sprintf($port_label,$c), '');
                $added_count++;
        }
        showFuncMessage (__FUNCTION__, 'OK', array ($added_count, $error_count));
}

$msgcode['updIPAllocation']['OK'] = 51;
function updIPAllocation ()
{
        $ip_bin = assertIPArg ('ip');
        assertUIntArg ('object_id');
        assertStringArg ('bond_name', TRUE);
        genericAssertion ('bond_type', 'enum/alloc_type');
        updateIPBond ($ip_bin, $_REQUEST['object_id'], $_REQUEST['bond_name'], $_REQUEST['bond_type']);
        showFuncMessage (__FUNCTION__, 'OK');
        return buildRedirectURL (NULL, NULL, array ('hl_ip' => ip_format ($ip_bin)));
}

$msgcode['delIPAllocation']['OK'] = 49;
function delIPAllocation ()
{
        $ip_bin = assertIPArg ('ip');
        assertUIntArg ('object_id');

        unbindIPFromObject ($ip_bin, $_REQUEST['object_id']);
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['addIPAllocation']['OK'] = 48;
$msgcode['addIPAllocation']['ERR1'] = 170;
function addIPAllocation ()
{
        $ip_bin = assertIPArg ('ip');
        assertUIntArg ('object_id');
        assertStringArg ('bond_name', TRUE);
        genericAssertion ('bond_type', 'enum/alloc_type');

        if  (getConfigVar ('IPV4_JAYWALK') != 'yes' and NULL === getIPAddressNetworkId ($ip_bin))
        {
                showFuncMessage (__FUNCTION__, 'ERR1', array (ip_format ($ip_bin)));
                return;
        }

        bindIPToObject ($ip_bin, $_REQUEST['object_id'], $_REQUEST['bond_name'], $_REQUEST['bond_type']);

        showFuncMessage (__FUNCTION__, 'OK');
        return buildRedirectURL (NULL, NULL, array ('hl_ip' => ip_format ($ip_bin)));
}

function addIPv4Prefix ()
{
        assertStringArg ('range');
        assertStringArg ('name', TRUE);
        $taglist = genericAssertion ('taglist', 'array0');
        global $sic;
        $vlan_ck = empty ($sic['vlan_ck']) ? NULL : genericAssertion ('vlan_ck', 'uint-vlan1');
        $net_id = createIPv4Prefix ($_REQUEST['range'], $sic['name'], isCheckSet ('is_connected'), $taglist, $vlan_ck);
        showSuccess ('IP network ' . mkA ($_REQUEST['range'], 'ipv4net', $net_id) . ' has been created');
}

function addIPv6Prefix ()
{
        assertStringArg ('range');
        assertStringArg ('name', TRUE);
        $taglist = genericAssertion ('taglist', 'array0');
        global $sic;
        $vlan_ck = empty ($sic['vlan_ck']) ? NULL : genericAssertion ('vlan_ck', 'uint-vlan1');
        $net_id = createIPv6Prefix ($_REQUEST['range'], $sic['name'], isCheckSet ('is_connected'), $taglist, $vlan_ck);
        showSuccess ('IP network ' . mkA ($_REQUEST['range'], 'ipv6net', $net_id) . ' has been created');
}

$msgcode['delIPv4Prefix']['OK'] = 49;
function delIPv4Prefix ()
{
        assertUIntArg ('id');
        $netinfo = spotEntity ('ipv4net', $_REQUEST['id']);
        loadIPAddrList ($netinfo);
        if (! isIPNetworkEmpty ($netinfo))
        {
                showError ("There are allocations within prefix, delete forbidden");
                return;
        }
        if (array_key_exists ($netinfo['ip_bin'], $netinfo['addrlist']))
                updateV4Address ($netinfo['ip_bin'], '', 'no');
        $last_ip = ip_last ($netinfo);
        if (array_key_exists ($last_ip, $netinfo['addrlist']))
                updateV4Address ($last_ip, '', 'no');
        destroyIPv4Prefix ($_REQUEST['id']);
        showFuncMessage (__FUNCTION__, 'OK');
        global $pageno;
        if ($pageno == 'ipv4net')
                return buildRedirectURL ('index', 'default');
}

$msgcode['delIPv6Prefix']['OK'] = 49;
function delIPv6Prefix ()
{
        assertUIntArg ('id');
        $netinfo = spotEntity ('ipv6net', $_REQUEST['id']);
        loadIPAddrList ($netinfo);
        if (! isIPNetworkEmpty ($netinfo))
        {
                showError ("There are allocations within prefix, delete forbidden");
                return;
        }
        if (array_key_exists ($netinfo['ip_bin'], $netinfo['addrlist']))
                updateV6Address ($netinfo['ip_bin'], '', 'no');
        destroyIPv6Prefix ($_REQUEST['id']);
        showFuncMessage (__FUNCTION__, 'OK');
        global $pageno;
        if ($pageno == 'ipv6net')
                return buildRedirectURL ('index', 'default');
}

$msgcode['editAddress']['OK'] = 51;
function editAddress ()
{
        assertStringArg ('name', TRUE);
        assertStringArg ('comment', TRUE);
        $ip_bin = assertIPArg ('ip');
        updateAddress ($ip_bin, $_REQUEST['name'], isCheckSet ('reserved', 'yesno'), $_REQUEST['comment']);
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['createUser']['OK'] = 5;
function createUser ()
{
        assertStringArg ('username');
        assertStringArg ('realname', TRUE);
        assertStringArg ('password');
        $username = $_REQUEST['username'];
        $password = sha1 ($_REQUEST['password']);
        $user_id = commitCreateUserAccount ($username, $_REQUEST['realname'], $password);
        if (isset ($_REQUEST['taglist']))
                produceTagsForNewRecord ('user', $_REQUEST['taglist'], $user_id);
        showFuncMessage (__FUNCTION__, 'OK', array ($username));
}

$msgcode['updateUser']['OK'] = 6;
function updateUser ()
{
        genericAssertion ('user_id', 'uint');
        $username = assertStringArg ('username');
        assertStringArg ('realname', TRUE);
        $new_password = assertStringArg ('password');
        $userinfo = spotEntity ('user', $_REQUEST['user_id']);
        // Update user password only if provided password is not the same as current password hash.
        if ($new_password != $userinfo['user_password_hash'])
                $new_password = sha1 ($new_password);
        commitUpdateUserAccount ($_REQUEST['user_id'], $username, $_REQUEST['realname'], $new_password);
        // if user account renaming is being performed, change key value in UserConfig table
        if ($userinfo['user_name'] !== $username)
                usePreparedUpdateBlade ('UserConfig', array ('user' => $username), array('user' => $userinfo['user_name']));
        showFuncMessage (__FUNCTION__, 'OK', array ($username));
}

$msgcode['supplementAttrMap']['OK'] = 48;
$msgcode['supplementAttrMap']['ERR1'] = 154;
function supplementAttrMap ()
{
        assertUIntArg ('attr_id');
        assertUIntArg ('objtype_id');
        $attrMap = getAttrMap();
        if ($attrMap[$_REQUEST['attr_id']]['type'] != 'dict')
                $chapter_id = NULL;
        else
        {
                try
                {
                        assertUIntArg ('chapter_no');
                }
                catch (InvalidRequestArgException $e)
                {
                        showFuncMessage (__FUNCTION__, 'ERR1', array ('chapter not selected'));
                        return;
                }
                $chapter_id = $_REQUEST['chapter_no'];
        }
        commitSupplementAttrMap ($_REQUEST['attr_id'], $_REQUEST['objtype_id'], $chapter_id);
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['clearSticker']['OK'] = 49;
function clearSticker ()
{
        global $sic;
        assertUIntArg ('attr_id');
        if (permitted (NULL, NULL, NULL, array (array ('tag' => '$attr_' . $sic['attr_id']))))
                commitUpdateAttrValue (getBypassValue(), $sic['attr_id']);
        else
        {
                $oldvalues = getAttrValues (getBypassValue());
                showError ('Permission denied, "' . $oldvalues[$sic['attr_id']]['name'] . '" left unchanged');
        }
}

$msgcode['updateObjectAllocation']['OK'] = 63;
function updateObjectAllocation ()
{
        global $remote_username, $sic;
        if (!isset ($_REQUEST['got_atoms']))
        {
                unset($_GET['page']);
                unset($_GET['tab']);
                unset($_GET['op']);
                unset($_POST['page']);
                unset($_POST['tab']);
                unset($_POST['op']);
                return buildRedirectURL (NULL, NULL, $_REQUEST);
        }
        $object_id = getBypassValue();
        $changecnt = 0;
        // Get a list of all of this object's parents,
        // then trim the list to only include parents that are racks
        $objectParents = getEntityRelatives('parents', 'object', $object_id);
        $parentRacks = array();
        foreach ($objectParents as $parentData)
                if ($parentData['entity_type'] == 'rack')
                        $parentRacks[] = $parentData['entity_id'];
        $workingRacksData = array();
        foreach ($_REQUEST['rackmulti'] as $cand_id)
        {
                if (!isset ($workingRacksData[$cand_id]))
                {
                        $rackData = spotEntity ('rack', $cand_id);
                        amplifyCell ($rackData);
                        $workingRacksData[$cand_id] = $rackData;
                }
                // It's zero-U mounted to this rack on the form, but not in the DB.  Mount it.
                if (isset($_REQUEST["zerou_${cand_id}"]) && !in_array($cand_id, $parentRacks))
                {
                        $changecnt++;
                        commitLinkEntities ('rack', $cand_id, 'object', $object_id);
                }
                // It's not zero-U mounted to this rack on the form, but it is in the DB.  Unmount it.
                if (!isset($_REQUEST["zerou_${cand_id}"]) && in_array($cand_id, $parentRacks))
                {
                        $changecnt++;
                        commitUnlinkEntities ('rack', $cand_id, 'object', $object_id);
                }
        }

        foreach ($workingRacksData as &$rd)
                applyObjectMountMask ($rd, $object_id);

        $oldMolecule = getMoleculeForObject ($object_id);
        foreach ($workingRacksData as $rack_id => $rackData)
        {
                if (! processGridForm ($rackData, 'F', 'T', $object_id))
                        continue;
                $changecnt++;
                // Reload our working copy after form processing.
                $rackData = spotEntity ('rack', $cand_id);
                amplifyCell ($rackData);
                applyObjectMountMask ($rackData, $object_id);
                $workingRacksData[$rack_id] = $rackData;
        }
        if ($changecnt)
        {
                // Log a record.
                $newMolecule = getMoleculeForObject ($object_id);
                usePreparedInsertBlade
                (
                        'MountOperation',
                        array
                        (
                                'object_id' => $object_id,
                                'old_molecule_id' => count ($oldMolecule) ? createMolecule ($oldMolecule) : NULL,
                                'new_molecule_id' => count ($newMolecule) ? createMolecule ($newMolecule) : NULL,
                                'user_name' => $remote_username,
                                'comment' => empty ($sic['comment']) ? NULL : $sic['comment'],
                        )
                );
        }
        showFuncMessage (__FUNCTION__, 'OK', array ($changecnt));
}

$msgcode['updateObject']['OK'] = 51;
function updateObject ()
{
        $taglist = genericAssertion ('taglist', 'array0');
        genericAssertion ('num_attrs', 'uint0');
        genericAssertion ('object_name', 'string0');
        genericAssertion ('object_label', 'string0');
        genericAssertion ('object_asset_no', 'string0');
        genericAssertion ('object_comment', 'string0');
        genericAssertion ('object_type_id', 'uint');
        $object_id = getBypassValue();

        global $dbxlink, $sic;
        $dbxlink->beginTransaction();
        commitUpdateObject
        (
                $object_id,
                $_REQUEST['object_name'],
                $_REQUEST['object_label'],
                isCheckSet ('object_has_problems', 'yesno'),
                $_REQUEST['object_asset_no'],
                $_REQUEST['object_comment']
        );
        updateObjectAttributes ($object_id);
        $object = spotEntity ('object', $object_id);
        if ($sic['object_type_id'] != $object['objtype_id'])
        {
                if (! array_key_exists ($sic['object_type_id'], getObjectTypeChangeOptions ($object_id)))
                        throw new InvalidRequestArgException ('new type_id', $sic['object_type_id'], 'incompatible with requested attribute values');
                usePreparedUpdateBlade ('Object', array ('objtype_id' => $sic['object_type_id']), array ('id' => $object_id));
        }
        // Invalidate thumb cache of all racks objects could occupy.
        foreach (getResidentRacksData ($object_id, FALSE) as $rack_id)
                usePreparedDeleteBlade ('RackThumbnail', array ('rack_id' => $rack_id));
        $dbxlink->commit();
        rebuildTagChainForEntity ('object', $object_id, buildTagChainFromIds ($taglist), TRUE);
        showFuncMessage (__FUNCTION__, 'OK');
}

// Used when updating an object, location or rack
function updateObjectAttributes ($object_id)
{
        global $dbxlink;
        $type_id = getObjectType ($object_id);
        $oldvalues = getAttrValues ($object_id);
        $num_attrs = isset ($_REQUEST['num_attrs']) ? $_REQUEST['num_attrs'] : 0;
        for ($i = 0; $i < $num_attrs; $i++)
        {
                genericAssertion ("${i}_attr_id", 'uint');
                $attr_id = $_REQUEST["${i}_attr_id"];
                if (! array_key_exists ($attr_id, $oldvalues))
                        throw new InvalidRequestArgException ('attr_id', $attr_id, 'malformed request');
                $value = $_REQUEST["${i}_value"];

                // If the object is a rack, skip certain attributes as they are handled elsewhere
                // (height, sort_order)
                if ($type_id == 1560 and ($attr_id == 27 or $attr_id == 29))
                        continue;

                // Delete attribute and move on, when the field is empty or if the field
                // type is a dictionary and it is the "--NOT SET--" value of 0.
                if ($value == '' || ($oldvalues[$attr_id]['type'] == 'dict' && $value == 0))
                {
                        if (permitted (NULL, NULL, NULL, array (array ('tag' => '$attr_' . $attr_id))))
                                commitUpdateAttrValue ($object_id, $attr_id);
                        else
                                showError ('Permission denied, "' . $oldvalues[$attr_id]['name'] . '" left unchanged');
                        continue;
                }

                // The value could be uint/float, but we don't know ATM. Let SQL
                // server check this and complain.
                if ('date' == $oldvalues[$attr_id]['type'])
                        $value = assertDateArg ("${i}_value");
                else
                        assertStringArg ("${i}_value");

                switch ($oldvalues[$attr_id]['type'])
                {
                        case 'uint':
                        case 'float':
                        case 'string':
                        case 'date':
                                $oldvalue = $oldvalues[$attr_id]['value'];
                                break;
                        case 'dict':
                                $oldvalue = $oldvalues[$attr_id]['key'];
                                break;
                        default:
                }
                if ($value === $oldvalue) // ('' == 0), but ('' !== 0)
                        continue;
                if (permitted (NULL, NULL, NULL, array (array ('tag' => '$attr_' . $attr_id))))
                        commitUpdateAttrValue ($object_id, $attr_id, $value);
                else
                        showError ('Permission denied, "' . $oldvalues[$attr_id]['name'] . '" left unchanged');
        }
}

function addMultipleObjects()
{
        $taglist = genericAssertion ('taglist', 'array0');
        $max = getConfigVar ('MASSCOUNT');
        for ($i = 0; $i < $max; $i++)
        {
                if (!isset ($_REQUEST["${i}_object_type_id"]))
                {
                        showError ('Submitted form is invalid at line ' . ($i + 1));
                        return;
                }

                assertUIntArg ("${i}_object_type_id", TRUE);
                assertStringArg ("${i}_object_name", TRUE);
                assertStringArg ("${i}_object_label", TRUE);
                assertStringArg ("${i}_object_asset_no", TRUE);
                $name = $_REQUEST["${i}_object_name"];

                // It's better to skip silently, than to print a notice.
                if ($_REQUEST["${i}_object_type_id"] == 0)
                        continue;
                try
                {
                        $object_id = commitAddObject
                        (
                                $name,
                                $_REQUEST["${i}_object_label"],
                                $_REQUEST["${i}_object_type_id"],
                                $_REQUEST["${i}_object_asset_no"],
                                $taglist
                        );
                        $info = spotEntity ('object', $object_id);
                        amplifyCell ($info);
                        showSuccess ("added object " . formatPortLink ($info['id'], $info['dname'], NULL, NULL));
                }
                catch (RTDatabaseError $e)
                {
                        showError ("Error creating object '$name': " . $e->getMessage());
                        continue;
                }
        }
}

function addLotOfObjects()
{
        $taglist = genericAssertion ('taglist', 'array0');
        assertUIntArg ('global_type_id', TRUE);
        assertStringArg ('namelist', TRUE);
        $global_type_id = $_REQUEST['global_type_id'];
        if ($global_type_id == 0 or !strlen ($_REQUEST['namelist']))
        {
                showError ('Incomplete form has been ignored. Cheers.');
                return;
        }
        else
        {
                // The name extractor below was stolen from ophandlers.php:addMultiPorts()
                $names1 = explode ("\n", $_REQUEST['namelist']);
                $names2 = array();
                foreach ($names1 as $line)
                {
                        $parts = explode ('\r', $line);
                        reset ($parts);
                        if (!strlen ($parts[0]))
                                continue;
                        else
                                $names2[] = rtrim ($parts[0]);
                }
                foreach ($names2 as $name)
                        try
                        {
                                $object_id = commitAddObject ($name, NULL, $global_type_id, '', $taglist);
                                $info = spotEntity ('object', $object_id);
                                amplifyCell ($info);
                                showSuccess ("added object " . formatPortLink ($info['id'], $info['dname'], NULL, NULL));
                        }
                        catch (RTDatabaseError $e)
                        {
                                showError ("Error creating object '$name': " . $e->getMessage());
                                continue;
                        }
        }
}

function linkObjects ()
{
        assertStringArg ('parent_entity_type');
        assertUIntArg ('parent_entity_id');
        assertStringArg ('child_entity_type');
        assertUIntArg ('child_entity_id');

        commitLinkEntities
        (
                $_REQUEST['parent_entity_type'],
                $_REQUEST['parent_entity_id'],
                $_REQUEST['child_entity_type'],
                $_REQUEST['child_entity_id']
        );
        showSuccess ('Container set successfully');
}

$msgcode['deleteObject']['OK'] = 7;
function deleteObject ()
{
        assertUIntArg ('object_id');
        $oinfo = spotEntity ('object', $_REQUEST['object_id']);

        $racklist = getResidentRacksData ($_REQUEST['object_id'], FALSE);
        commitDeleteObject ($_REQUEST['object_id']);
        foreach ($racklist as $rack_id)
                usePreparedDeleteBlade ('RackThumbnail', array ('rack_id' => $rack_id));
        showFuncMessage (__FUNCTION__, 'OK', array ($oinfo['dname']));
}

$msgcode['resetObject']['OK'] = 57;
function resetObject ()
{
        $racklist = getResidentRacksData (getBypassValue(), FALSE);
        commitResetObject (getBypassValue());
        foreach ($racklist as $rack_id)
                usePreparedDeleteBlade ('RackThumbnail', array ('rack_id' => $rack_id));
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['updateUI']['OK'] = 51;
function updateUI ()
{
        assertUIntArg ('num_vars');

        for ($i = 0; $i < $_REQUEST['num_vars']; $i++)
        {
                assertStringArg ("${i}_varname");
                assertStringArg ("${i}_varvalue", TRUE);
                $varname = $_REQUEST["${i}_varname"];
                $varvalue = $_REQUEST["${i}_varvalue"];

                // If form value = value in DB, don't bother updating DB
                if (!isConfigVarChanged($varname, $varvalue))
                        continue;
                // any exceptions will be handled by process.php
                setConfigVar ($varname, $varvalue, TRUE);
        }
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['saveMyPreferences']['OK'] = 51;
function saveMyPreferences ()
{
        assertUIntArg ('num_vars');

        for ($i = 0; $i < $_REQUEST['num_vars']; $i++)
        {
                assertStringArg ("${i}_varname");
                assertStringArg ("${i}_varvalue", TRUE);
                $varname = $_REQUEST["${i}_varname"];
                $varvalue = $_REQUEST["${i}_varvalue"];

                // If form value = value in DB, don't bother updating DB
                if (!isConfigVarChanged($varname, $varvalue))
                        continue;
                setUserConfigVar ($varname, $varvalue);
        }
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['resetMyPreference']['OK'] = 51;
function resetMyPreference ()
{
        assertStringArg ("varname");
        resetUserConfigVar ($_REQUEST["varname"]);
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['resetUIConfig']['OK'] = 57;
function resetUIConfig()
{
        setConfigVar ('MASSCOUNT','8');
        setConfigVar ('MAXSELSIZE','30');
        setConfigVar ('ROW_SCALE','2');
        setConfigVar ('IPV4_ADDRS_PER_PAGE','256');
        setConfigVar ('DEFAULT_RACK_HEIGHT','42');
        setConfigVar ('DEFAULT_SLB_VS_PORT','');
        setConfigVar ('DEFAULT_SLB_RS_PORT','');
        setConfigVar ('DETECT_URLS','no');
        setConfigVar ('RACK_PRESELECT_THRESHOLD','1');
        setConfigVar ('DEFAULT_IPV4_RS_INSERVICE','no');
        setConfigVar ('AUTOPORTS_CONFIG','4 = 1*33*kvm + 2*24*eth%u;15 = 1*446*kvm');
        setConfigVar ('SHOW_EXPLICIT_TAGS','yes');
        setConfigVar ('SHOW_IMPLICIT_TAGS','yes');
        setConfigVar ('SHOW_AUTOMATIC_TAGS','no');
        setConfigVar ('DEFAULT_OBJECT_TYPE','4');
        setConfigVar ('IPV4_AUTO_RELEASE','1');
        setConfigVar ('SHOW_LAST_TAB', 'yes');
        setConfigVar ('EXT_IPV4_VIEW', 'yes');
        setConfigVar ('TREE_THRESHOLD', '25');
        setConfigVar ('IPV4_JAYWALK', 'no');
        setConfigVar ('ADDNEW_AT_TOP', 'yes');
        setConfigVar ('IPV4_TREE_SHOW_USAGE', 'no');
        setConfigVar ('PREVIEW_TEXT_MAXCHARS', '10240');
        setConfigVar ('PREVIEW_TEXT_ROWS', '25');
        setConfigVar ('PREVIEW_TEXT_COLS', '80');
        setConfigVar ('PREVIEW_IMAGE_MAXPXS', '320');
        setConfigVar ('VENDOR_SIEVE', '');
        setConfigVar ('IPV4LB_LISTSRC', 'false');
        setConfigVar ('IPV4OBJ_LISTSRC','not ({$typeid_3} or {$typeid_9} or {$typeid_10} or {$typeid_11})');
        setConfigVar ('IPV4NAT_LISTSRC','{$typeid_4} or {$typeid_7} or {$typeid_8} or {$typeid_798}');
        setConfigVar ('ASSETWARN_LISTSRC','{$typeid_4} or {$typeid_7} or {$typeid_8}');
        setConfigVar ('NAMEWARN_LISTSRC','{$typeid_4} or {$typeid_7} or {$typeid_8}');
        setConfigVar ('RACKS_PER_ROW','12');
        setConfigVar ('FILTER_PREDICATE_SIEVE','');
        setConfigVar ('FILTER_DEFAULT_ANDOR','and');
        setConfigVar ('FILTER_SUGGEST_ANDOR','yes');
        setConfigVar ('FILTER_SUGGEST_TAGS','yes');
        setConfigVar ('FILTER_SUGGEST_PREDICATES','yes');
        setConfigVar ('FILTER_SUGGEST_EXTRA','no');
        setConfigVar ('DEFAULT_SNMP_COMMUNITY','public');
        setConfigVar ('IPV4_ENABLE_KNIGHT','yes');
        setConfigVar ('TAGS_TOPLIST_SIZE','50');
        setConfigVar ('TAGS_QUICKLIST_SIZE','20');
        setConfigVar ('TAGS_QUICKLIST_THRESHOLD','50');
        setConfigVar ('ENABLE_MULTIPORT_FORM', 'no');
        setConfigVar ('DEFAULT_PORT_IIF_ID', '1');
        setConfigVar ('DEFAULT_PORT_OIF_IDS', '1=24; 3=1078; 4=1077; 5=1079; 6=1080; 8=1082; 9=1084; 10=1588; 11=1668');
        setConfigVar ('IPV4_TREE_RTR_AS_CELL', 'no');
        setConfigVar ('PROXIMITY_RANGE', 0);
        setConfigVar ('IPV4_TREE_SHOW_VLAN', 'yes');
        setConfigVar ('VLANSWITCH_LISTSRC', '');
        setConfigVar ('VLANIPV4NET_LISTSRC', '');
        setConfigVar ('DEFAULT_VDOM_ID', '');
        setConfigVar ('DEFAULT_VST_ID', '');
        setConfigVar ('STATIC_FILTER', 'yes');
        setConfigVar ('8021Q_DEPLOY_MINAGE', '300');
        setConfigVar ('8021Q_DEPLOY_MAXAGE', '3600');
        setConfigVar ('8021Q_DEPLOY_RETRY', '10800');
        setConfigVar ('8021Q_WRI_AFTER_CONFT_LISTSRC', 'false');
        setConfigVar ('8021Q_INSTANT_DEPLOY', 'no');
        setConfigVar ('CDP_RUNNERS_LISTSRC', '');
        setConfigVar ('LLDP_RUNNERS_LISTSRC', '');
        setConfigVar ('SHRINK_TAG_TREE_ON_CLICK', 'yes');
        setConfigVar ('MAX_UNFILTERED_ENTITIES', '0');
        setConfigVar ('SYNCDOMAIN_MAX_PROCESSES', '0');
        setConfigVar ('PORT_EXCLUSION_LISTSRC', '{$typeid_3} or {$typeid_10} or {$typeid_11} or {$typeid_1505} or {$typeid_1506}');
        setConfigVar ('FILTER_RACKLIST_BY_TAGS', 'yes');
        setConfigVar ('SSH_OBJS_LISTSRC', 'false');
        setConfigVar ('RDP_OBJS_LISTSRC', 'false');
        setConfigVar ('TELNET_OBJS_LISTSRC', 'false');
        setConfigVar ('SYNC_802Q_LISTSRC', '');
        setConfigVar ('QUICK_LINK_PAGES', 'depot,ipv4space,rackspace');
        setConfigVar ('CACTI_LISTSRC', 'false');
        setConfigVar ('MUNIN_LISTSRC', 'false');
        setConfigVar ('VIRTUAL_OBJ_LISTSRC', '1504,1505,1506,1507');
        setConfigVar ('DATETIME_ZONE', 'UTC');
        setConfigVar ('DATETIME_FORMAT', '%Y-%m-%d');
        setConfigVar ('SEARCH_DOMAINS', '');
        setConfigVar ('8021Q_EXTSYNC_LISTSRC', 'false');
        setConfigVar ('8021Q_MULTILINK_LISTSRC', 'false');
        setConfigVar ('REVERSED_RACKS_LISTSRC', 'false');
        setConfigVar ('NEAREST_RACKS_CHECKBOX', 'yes');
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['addRealServer']['OK'] = 48;
// Add single record.
function addRealServer ()
{
        global $sic;
        $rsip_bin = assertIPArg ('rsip');
        assertStringArg ('rsport', TRUE);
        assertStringArg ('rsconfig', TRUE);
        assertStringArg ('comment', TRUE);
        addRStoRSPool
        (
                getBypassValue(),
                $rsip_bin,
                $_REQUEST['rsport'],
                isCheckSet ('inservice', 'yesno'),
                $sic['rsconfig'],
                $sic['comment']
        );
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['addRealServers']['OK'] = 37;
$msgcode['addRealServers']['ERR1'] = 131;
// Parse textarea submitted and try adding a real server for each line.
function addRealServers ()
{
        global $sic;
        assertStringArg ('format');
        assertStringArg ('rawtext');
        $ngood = 0;
        // Keep in mind, that the text will have HTML entities (namely '>') escaped.
        foreach (explode ("\n", dos2unix ($sic['rawtext'])) as $line)
        {
                if (!strlen ($line))
                        continue;
                $match = array ();
                switch ($_REQUEST['format'])
                {
                        case 'ipvs_2': // address and port only
                                if (!preg_match ('/^  -> ([0-9\.]+):([0-9]+) /', $line, $match))
                                        if (!preg_match ('/^  -> \[([0-9a-fA-F:]+)\]:([0-9]+) /', $line, $match))
                                                continue;
                                addRStoRSPool (getBypassValue(), ip_parse ($match[1]), $match[2], getConfigVar ('DEFAULT_IPV4_RS_INSERVICE'), '');
                                break;
                        case 'ipvs_3': // address, port and weight
                                if (!preg_match ('/^  -> ([0-9\.]+):([0-9]+) +[a-zA-Z]+ +([0-9]+) /', $line, $match))
                                        if (!preg_match ('/^  -> \[([0-9a-fA-F:]+)\]:([0-9]+) +[a-zA-Z]+ +([0-9]+) /', $line, $match))
                                                continue;
                                addRStoRSPool (getBypassValue(), ip_parse ($match[1]), $match[2], getConfigVar ('DEFAULT_IPV4_RS_INSERVICE'), 'weight ' . $match[3]);
                                break;
                        case 'ssv_2': // IP address and port
                                if (!preg_match ('/^([0-9\.a-fA-F:]+) ([0-9]+)$/', $line, $match))
                                        continue;
                                addRStoRSPool (getBypassValue(), ip_parse ($match[1]), $match[2], getConfigVar ('DEFAULT_IPV4_RS_INSERVICE'), '');
                                break;
                        case 'ssv_1': // IP address
                                if (! $ip_bin = ip_checkparse ($line))
                                        continue;
                                addRStoRSPool (getBypassValue(), $ip_bin, 0, getConfigVar ('DEFAULT_IPV4_RS_INSERVICE'), '');
                                break;
                        default:
                                showFuncMessage (__FUNCTION__, 'ERR1');
                                return;
                }
                $ngood++;
        }
        showFuncMessage (__FUNCTION__, 'OK', array ($ngood));
}

function addVService ()
{
        global $sic;
        $vip_bin = assertIPArg ('vip');
        genericAssertion ('proto', 'enum/ipproto');
        assertStringArg ('name', TRUE);
        assertStringArg ('vsconfig', TRUE);
        assertStringArg ('rsconfig', TRUE);
        if ($_REQUEST['proto'] == 'MARK')
                $vport = NULL;
        else
        {
                assertUIntArg ('vport');
                $vport = $_REQUEST['vport'];
        }
        usePreparedInsertBlade
        (
                'IPv4VS',
                array
                (
                        'vip' => $vip_bin,
                        'vport' => $vport,
                        'proto' => $_REQUEST['proto'],
                        'name' => !mb_strlen ($_REQUEST['name']) ? NULL : $_REQUEST['name'],
                        'vsconfig' => !strlen ($sic['vsconfig']) ? NULL : $sic['vsconfig'],
                        'rsconfig' => !strlen ($sic['rsconfig']) ? NULL : $sic['rsconfig'],
                )
        );
        $vs_id = lastInsertID();
        if (isset ($_REQUEST['taglist']))
                produceTagsForNewRecord ('ipv4vs', $_REQUEST['taglist'], $vs_id);
        $vsinfo = spotEntity ('ipv4vs', $vs_id);
        showSuccess (mkCellA ($vsinfo) . ' created successfully');
}

function addVSG ()
{
        $name = assertStringArg ('name');
        usePreparedInsertBlade ('VS', array ('name' => $name));
        $vs_id = lastInsertID();
        if (isset ($_REQUEST['taglist']))
                produceTagsForNewRecord ('ipvs', $_REQUEST['taglist'], $vs_id);
        $vsinfo = spotEntity ('ipvs', $vs_id);
        showSuccess (mkCellA ($vsinfo) . ' created successfully');
}

$msgcode['deleteVService']['OK'] = 49;
function deleteVService ()
{
        assertUIntArg ('vs_id');
        $vsinfo = spotEntity ('ipv4vs', $_REQUEST['vs_id']);
        if ($vsinfo['refcnt'] != 0)
        {
                showError ("Could not delete linked virtual service");
                return;
        }
        commitDeleteVS ($vsinfo['id']);
        showFuncMessage (__FUNCTION__, 'OK');
        return buildRedirectURL ('ipv4slb', 'default');
}

function deleteVS()
{
        $vsinfo = spotEntity ('ipvs', assertUIntArg ('vs_id'));
        if (count (getTriplets ($vsinfo)) != 0)
        {
                showError ("Could not delete linked virtual service group");
                return;
        }
        commitDeleteVSG ($vsinfo['id']);
        showSuccess (formatEntityName ($vsinfo) . ' deleted');
        return buildRedirectURL ('ipv4slb', 'vs');
}

$msgcode['updateSLBDefConfig']['OK'] = 43;
function updateSLBDefConfig ()
{
        global $sic;
        commitUpdateSLBDefConf
        (
                array
                (
                        'vs' => $sic['vsconfig'],
                        'rs' => $sic['rsconfig'],
                )
        );
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['updateRealServer']['OK'] = 51;
function updateRealServer ()
{
        global $sic;
        assertUIntArg ('rs_id');
        $rsip_bin = assertIPArg ('rsip');
        assertStringArg ('rsport', TRUE);
        assertStringArg ('rsconfig', TRUE);
        assertStringArg ('comment', TRUE);
        commitUpdateRS (
                $_REQUEST['rs_id'],
                $rsip_bin,
                $_REQUEST['rsport'],
                isCheckSet ('inservice', 'yesno'),
                $sic['rsconfig'],
                $sic['comment']
        );
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['updateVService']['OK'] = 51;
function updateVService ()
{
        global $sic;
        assertUIntArg ('vs_id');
        $taglist = genericAssertion ('taglist', 'array0');
        $vip_bin = assertIPArg ('vip');
        genericAssertion ('proto', 'enum/ipproto');
        if ($_REQUEST['proto'] == 'MARK')
                assertStringArg ('vport', TRUE);
        else
                assertUIntArg ('vport');
        assertStringArg ('name', TRUE);
        assertStringArg ('vsconfig', TRUE);
        assertStringArg ('rsconfig', TRUE);
        commitUpdateVS (
                $_REQUEST['vs_id'],
                $vip_bin,
                $_REQUEST['vport'],
                $_REQUEST['proto'],
                $_REQUEST['name'],
                $sic['vsconfig'],
                $sic['rsconfig']
        );
        rebuildTagChainForEntity ('ipvs', $_REQUEST['vs_id'], buildTagChainFromIds ($taglist), TRUE);
        showFuncMessage (__FUNCTION__, 'OK');
}

function updateVS ()
{
        $taglist = genericAssertion ('taglist', 'array0');
        $vs_id = assertUIntArg ('vs_id');
        $name = assertStringArg ('name');
        $vsconfig = nullEmptyStr (assertStringArg ('vsconfig', TRUE));
        $rsconfig = nullEmptyStr (assertStringArg ('rsconfig', TRUE));

        usePreparedUpdateBlade ('VS', array ('name' => $name, 'vsconfig' => $vsconfig, 'rsconfig' => $rsconfig), array ('id' => $vs_id));
        rebuildTagChainForEntity ('ipvs', $vs_id, buildTagChainFromIds ($taglist), TRUE);
        showSuccess ("Service updated successfully");
}

function addIPToVS()
{
        $ip_bin = assertIPArg ('ip');
        $vsinfo = spotEntity ('ipvs', assertUIntArg ('vs_id'));
        amplifyCell ($vsinfo);
        $row = array ('vs_id' => $vsinfo['id'], 'vip' => $ip_bin, 'vsconfig' => NULL, 'rsconfig' => NULL);
        if ($vip = isVIPEnabled ($row, $vsinfo['vips']))
        {
                showError ("Service already contains IP " . formatVSIP ($vip));
                return;
        }
        usePreparedInsertBlade ('VSIPs', $row);
        showSuccess ("IP addded");
}

function addPortToVS()
{
        global $vs_proto;
        $proto = assertStringArg ('proto');
        if (! in_array ($proto, $vs_proto))
                throw new InvalidRequestArgException ('proto', "Invalid VS protocol");
        $vport = assertUIntArg ('port', TRUE);
        if ($proto == 'MARK')
        {
                if ($vport > 0xFFFFFFFF)
                {
                        showError ("fwmark value is too large");
                        return;
                }
        }
        else
                if ($vport == 0 || $vport >= 0xFFFF)
                {
                        showError ("Invalid $proto port value");
                        return;
                }

        $vsinfo = spotEntity ('ipvs', assertUIntArg ('vs_id'));
        amplifyCell ($vsinfo);
        $row = array ('vs_id' => $vsinfo['id'], 'proto' => $proto, 'vport' => $vport, 'vsconfig' => NULL, 'rsconfig' => NULL);
        if ($port = isPortEnabled ($row, $vsinfo['ports']))
        {
                showError ("Service already contains port " . formatVSPort ($port));
                return;
        }
        usePreparedInsertBlade ('VSPorts', $row);
        showSuccess ("port addded");
}

function updateIPInVS()
{
        $vs_id = assertUIntArg ('vs_id');
        $ip_bin = assertIPArg ('ip');
        $vsconfig = nullEmptyStr (assertStringArg ('vsconfig', TRUE));
        $rsconfig = nullEmptyStr (assertStringArg ('rsconfig', TRUE));
        if (usePreparedUpdateBlade ('VSIPs', array ('vsconfig' => $vsconfig, 'rsconfig' => $rsconfig), array ('vs_id' => $vs_id, 'vip' => $ip_bin)))
                showSuccess ("IP configuration updated");
        else
                showNotice ("Nothing changed");
}

function updatePortInVS()
{
        $vs_id = assertUIntArg ('vs_id');
        $proto = assertStringArg ('proto');
        $vport = assertUIntArg ('port', TRUE);
        $vsconfig = nullEmptyStr (assertStringArg ('vsconfig', TRUE));
        $rsconfig = nullEmptyStr (assertStringArg ('rsconfig', TRUE));
        if (usePreparedUpdateBlade ('VSPorts', array ('vsconfig' => $vsconfig, 'rsconfig' => $rsconfig), array ('vs_id' => $vs_id, 'proto' => $proto, 'vport' => $vport)))
                showSuccess ("Port configuration updated");
        else
                showNotice ("Nothing changed");
}

function removeIPFromVS()
{
        $vip = array ('vip' => assertIPArg ('ip'));
        $vsinfo = spotEntity ('ipvs', assertUIntArg ('vs_id'));
        amplifyCell ($vsinfo);
        $used = 0;
        foreach (getTriplets ($vsinfo) as $triplet)
                if (isVIPEnabled ($vip, $triplet['vips']))
                        $used++;
        if (usePreparedDeleteBlade ('VSIPs', array ('vs_id' => $vsinfo['id']) + $vip))
                showSuccess ("IP removed" . ($used ? ", it was binded with $used SLBs" : ''));
        else
                showNotice ("Nothing changed");
}

function removePortFromVS()
{
        $port = array ('proto' => assertStringArg ('proto'), 'vport' => assertUIntArg ('port', TRUE));
        $vsinfo = spotEntity ('ipvs', assertUIntArg ('vs_id'));
        amplifyCell ($vsinfo);
        $used = 0;
        foreach (getTriplets ($vsinfo) as $triplet)
                if (isPortEnabled ($port, $triplet['ports']))
                        $used++;
        if (usePreparedDeleteBlade ('VSPorts', array ('vs_id' => $vsinfo['id']) + $port))
                showSuccess ("Port removed" . ($used ? ", it was binded with $used SLBs" : ''));
        else
                showNotice ("Nothing changed");
}

function updateTripletConfig()
{
        $key_fields = array
        (
                'object_id' => assertUIntArg ('object_id'),
                'vs_id' => assertUIntArg ('vs_id'),
                'rspool_id' => assertUIntArg ('rspool_id'),
        );
        $config_fields = array
        (
                'vsconfig' => nullEmptyStr (assertStringArg ('vsconfig', TRUE)),
                'rsconfig' => nullEmptyStr (assertStringArg ('rsconfig', TRUE)),
        );

        $vsinfo = spotEntity ('ipvs', $key_fields['vs_id']);
        amplifyCell ($vsinfo);
        $found = FALSE;

        if ($_REQUEST['op'] == 'updPort')
        {
                $table = 'VSEnabledPorts';
                $proto = assertStringArg ('proto');
                $vport = assertUIntArg ('port', TRUE);
                $key_fields['proto'] = $proto;
                $key_fields['vport'] = $vport;
                $key = "Port $proto-$vport";
                // check if such port exists in VS
                foreach ($vsinfo['ports'] as $vs_port)
                        if ($vs_port['proto'] == $proto && $vs_port['vport'] == $vport)
                        {
                                $found = TRUE;
                                break;
                        }
        }
        else
        {
                $table = 'VSEnabledIPs';
                $vip = assertIPArg ('vip');
                $config_fields['prio'] = nullEmptyStr (assertStringArg ('prio', TRUE));
                $key_fields['vip'] = $vip;
                $key = "IP " . ip_format ($vip);
                // check if such VIP exists in VS
                foreach ($vsinfo['vips'] as $vs_vip)
                        if ($vs_vip['vip'] === $vip)
                        {
                                $found = TRUE;
                                break;
                        }
        }
        if (! $found)
        {
                showError ("$key not found in VS");
                return;
        }

        $nchanged = 0;
        if (! isCheckSet ('enabled'))
        {
                if ($nchanged += usePreparedDeleteBlade ($table, $key_fields))
                {
                        showSuccess ("$key disabled");
                        return;
                }
        }
        else
        {
                global $dbxlink;
                $dbxlink->beginTransaction();
                $q = "SELECT * FROM $table WHERE";
                $sep = '';
                $params = array();
                foreach ($key_fields as $field => $value)
                {
                        $q .= " $sep $field = ?";
                        $params[] = $value;
                        $sep = 'AND';
                }
                $result = usePreparedSelectBlade ("$q FOR UPDATE", $params);
                $row = $result->fetch (PDO::FETCH_ASSOC);
                unset ($result);
                if ($row)
                {
                        if ($nchanged += usePreparedUpdateBlade ($table, $config_fields, $key_fields))
                                showSuccess ("$key config updated");
                }
                else
                {
                        if (
                                $nchanged += ($table == 'VSEnabledIPs' ?
                                        addSLBIPLink ($key_fields + $config_fields) :
                                        addSLBPortLink ($key_fields + $config_fields)
                                )
                        )
                                showSuccess ("$key enabled");
                }
                $dbxlink->commit();
        }
        if (! $nchanged)
                showNotice ("No changes made");
}

function removeTriplet()
{
        $key_fields = array
        (
                'object_id' => assertUIntArg ('object_id'),
                'vs_id' => assertUIntArg ('vs_id'),
                'rspool_id' => assertUIntArg ('rspool_id'),
        );

        global $dbxlink;
        $dbxlink->beginTransaction();
        usePreparedDeleteBlade ('VSEnabledIPs', $key_fields);
        usePreparedDeleteBlade ('VSEnabledPorts', $key_fields);
        $dbxlink->commit();
        showSuccess ('Triplet deleted');
}

function createTriplet()
{
        global $dbxlink;
        $object_id = assertUIntArg ('object_id');
        $vs_id = assertUIntArg ('vs_id');
        $rspool_id = assertUIntArg ('rspool_id');
        $vips = genericAssertion ('enabled_vips', 'array0');
        $ports = genericAssertion ('enabled_ports', 'array0');

        $vsinfo = spotEntity ('ipvs', $vs_id);
        amplifyCell ($vsinfo);
        try
        {
                $dbxlink->beginTransaction();
                foreach ($vsinfo['vips'] as $vip)
                        if (in_array (ip_format ($vip['vip']), $vips))
                                addSLBIPLink (array ('object_id' => $object_id, 'vs_id' => $vs_id, 'rspool_id' => $rspool_id, 'vip' => $vip['vip']));
                foreach ($vsinfo['ports'] as $port)
                        if (in_array($port['proto'] . '-' . $port['vport'], $ports))
                                addSLBPortLink (array ('object_id' => $object_id, 'vs_id' => $vs_id, 'rspool_id' => $rspool_id, 'proto' => $port['proto'], 'vport' => $port['vport']));
                $dbxlink->commit();
        }
        catch (RTDatabaseError $e)
        {
                $dbxlink->rollBack();
                throw $e;
        }
        showSuccess ("SLB triplet created");
}

$msgcode['addLoadBalancer']['OK'] = 48;
function addLoadBalancer ()
{
        global $sic;
        assertUIntArg ('pool_id');
        assertUIntArg ('object_id');
        assertUIntArg ('vs_id');
        assertStringArg ('vsconfig', TRUE);
        assertStringArg ('rsconfig', TRUE);
        assertStringArg ('prio', TRUE);

        addLBtoRSPool (
                $_REQUEST['pool_id'],
                $_REQUEST['object_id'],
                $_REQUEST['vs_id'],
                $sic['vsconfig'],
                $sic['rsconfig'],
                $_REQUEST['prio']
        );
        showFuncMessage (__FUNCTION__, 'OK');
}

function addRSPool ()
{
        global $sic;
        assertStringArg ('name');
        assertStringArg ('vsconfig', TRUE);
        assertStringArg ('rsconfig', TRUE);
        $pool_id = commitCreateRSPool
        (
                $_REQUEST['name'],
                $sic['vsconfig'],
                $sic['rsconfig'],
                isset ($_REQUEST['taglist']) ? $_REQUEST['taglist'] : array()
        );
        showSuccess ('RS pool ' . mkA ($_REQUEST['name'], 'ipv4rspool', $pool_id) . ' created successfully');
}

$msgcode['deleteRSPool']['OK'] = 49;
function deleteRSPool ()
{
        assertUIntArg ('pool_id');
        $poolinfo = spotEntity ('ipv4rspool', $_REQUEST['pool_id']);
        if ($poolinfo['refcnt'] != 0)
        {
                showError ("Could not delete linked RS pool");
                return;
        }
        commitDeleteRSPool ($poolinfo['id']);
        showFuncMessage (__FUNCTION__, 'OK');
        return buildRedirectURL ('ipv4slb', 'rspools');
}

$msgcode['importPTRData']['OK'] = 26;
$msgcode['importPTRData']['ERR'] = 141;
function importPTRData ()
{
        $net = spotEntity ('ipv4net', getBypassValue());
        assertUIntArg ('addrcount');
        $nbad = $ngood = 0;
        for ($i = 1; $i <= $_REQUEST['addrcount']; $i++)
        {
                $inputname = "import_${i}";
                if (! isCheckSet ($inputname))
                        continue;
                $ip_bin = assertIPv4Arg ("addr_${i}");
                assertStringArg ("descr_${i}", TRUE);
                assertStringArg ("rsvd_${i}");
                // Non-existent addresses will not have this argument set in request.
                $rsvd = 'no';
                if ($_REQUEST["rsvd_${i}"] == 'yes')
                        $rsvd = 'yes';
                try
                {
                        if (! ip_in_range ($ip_bin, $net))
                                throw new InvalidArgException ('ip_bin', $ip_bin);
                        updateAddress ($ip_bin, $_REQUEST["descr_${i}"], $rsvd);
                        $ngood++;
                }
                catch (RackTablesError $e)
                {
                        $nbad++;
                }
        }
        if (!$nbad)
                showFuncMessage (__FUNCTION__, 'OK', array ($ngood));
        else
                showFuncMessage (__FUNCTION__, 'ERR', array ($nbad, $ngood));
}

$msgcode['generateAutoPorts']['OK'] = 21;
function generateAutoPorts ()
{
        $object = spotEntity ('object', getBypassValue());
        executeAutoPorts ($object['id'], $object['objtype_id']);
        showFuncMessage (__FUNCTION__, 'OK');
        return buildRedirectURL (NULL, 'ports');
}

function updateTag ()
{
        assertUIntArg ('tag_id');
        genericAssertion ('tag_name', 'tag');
        assertUIntArg ('parent_id', TRUE);
        genericAssertion ('is_assignable', 'enum/yesno');
        commitUpdateTag ($_REQUEST['tag_id'], $_REQUEST['tag_name'], $_REQUEST['parent_id'], $_REQUEST['is_assignable']);
        showSuccess ('Tag updated successfully');
}

$msgcode['saveEntityTags']['OK'] = 43;
function saveEntityTags ()
{
        global $pageno, $etype_by_pageno;
        if (!isset ($etype_by_pageno[$pageno]))
                throw new RackTablesError ('key not found in etype_by_pageno', RackTablesError::INTERNAL);
        $realm = $etype_by_pageno[$pageno];
        $entity_id = getBypassValue();
        $taglist = isset ($_REQUEST['taglist']) ? $_REQUEST['taglist'] : array();
        rebuildTagChainForEntity ($realm, $entity_id, buildTagChainFromIds ($taglist), TRUE);
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['rollTags']['OK'] = 67;
$msgcode['rollTags']['ERR'] = 149;
function rollTags ()
{
        assertStringArg ('sum', TRUE);
        assertUIntArg ('realsum');
        if ($_REQUEST['sum'] != $_REQUEST['realsum'])
        {
                showFuncMessage (__FUNCTION__, 'ERR');
                return;
        }
        // Even if the user requested an empty tag list, don't bail out, but process existing
        // tag chains with "zero" extra. This will make sure, that the stuff processed will
        // have its chains refined to "normal" form.
        $extratags = isset ($_REQUEST['taglist']) ? $_REQUEST['taglist'] : array();
        $n_ok = 0;
        // Minimizing the extra chain early, so that tag rebuilder doesn't have to
        // filter out the same tag again and again. It will have own noise to cancel.
        $extrachain = getExplicitTagsOnly (buildTagChainFromIds ($extratags));
        foreach (listCells ('rack', getBypassValue()) as $rack)
        {
                if (rebuildTagChainForEntity ('rack', $rack['id'], $extrachain))
                        $n_ok++;
                amplifyCell ($rack);
                foreach ($rack['mountedObjects'] as $object_id)
                        if (rebuildTagChainForEntity ('object', $object_id, $extrachain))
                                $n_ok++;
        }
        showFuncMessage (__FUNCTION__, 'OK', array ($n_ok));
}

$msgcode['changeMyPassword']['OK'] = 51;
$msgcode['changeMyPassword']['ERR1'] = 150;
$msgcode['changeMyPassword']['ERR2'] = 151;
$msgcode['changeMyPassword']['ERR3'] = 152;
function changeMyPassword ()
{
        global $remote_username, $user_auth_src;
        if ($user_auth_src != 'database')
        {
                showFuncMessage (__FUNCTION__, 'ERR1');
                return;
        }
        assertStringArg ('oldpassword');
        assertStringArg ('newpassword1');
        assertStringArg ('newpassword2');
        $remote_userid = getUserIDByUsername ($remote_username);
        $userinfo = spotEntity ('user', $remote_userid);
        if ($userinfo['user_password_hash'] != sha1 ($_REQUEST['oldpassword']))
        {
                showFuncMessage (__FUNCTION__, 'ERR2');
                return;
        }
        if ($_REQUEST['newpassword1'] != $_REQUEST['newpassword2'])
        {
                showFuncMessage (__FUNCTION__, 'ERR3');
                return;
        }
        commitUpdateUserAccount ($remote_userid, $userinfo['user_name'], $userinfo['user_realname'], sha1 ($_REQUEST['newpassword1']));
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['saveRackCode']['OK'] = 43;
$msgcode['saveRackCode']['ERR1'] = 154;
function saveRackCode ()
{
        assertStringArg ('rackcode');
        // For the test to succeed, unescape LFs, strip CRs.
        $newcode = dos2unix ($_REQUEST['rackcode']);
        $parseTree = getRackCode ($newcode);
        if ($parseTree['result'] != 'ACK')
        {
                showFuncMessage (__FUNCTION__, 'ERR1', array ($parseTree['load']));
                return;
        }
        saveScript ('RackCode', $newcode);
        saveScript ('RackCodeCache', base64_encode (serialize ($parseTree)));
        showFuncMessage (__FUNCTION__, 'OK');
}

function submitSLBConfig ()
{
        showNotice ("You should redefine submitSLBConfig ophandler in your local extension to install SLB config");
}

$msgcode['addLocation']['OK'] = 5;
function addLocation ()
{
        assertUIntArg ('parent_id', TRUE);
        assertStringArg ('name');

        $location_id = commitAddObject ($_REQUEST['name'], NULL, 1562, NULL);
        if ($_REQUEST['parent_id'])
                commitLinkEntities ('location', $_REQUEST['parent_id'], 'location', $location_id);
        showSuccess ('added location ' . mkA ($_REQUEST['name'], 'location', $location_id));
}

$msgcode['updateLocation']['OK'] = 6;
// This function is used by two forms:
//  - renderEditLocationForm - all attributes may be modified
//  - renderRackspaceLocationEditor - only the name and parent may be modified
function updateLocation ()
{
        global $pageno;
        assertUIntArg ('location_id');
        assertUIntArg ('parent_id', TRUE);
        assertStringArg ('name');

        if ($pageno == 'location')
        {
                $taglist = genericAssertion ('taglist', 'array0');
                $has_problems = (isset ($_REQUEST['has_problems']) and $_REQUEST['has_problems'] == 'on') ? 'yes' : 'no';
                assertStringArg ('comment', TRUE);
                commitUpdateObject ($_REQUEST['location_id'], $_REQUEST['name'], NULL, $has_problems, NULL, $_REQUEST['comment']);
                updateObjectAttributes ($_REQUEST['location_id']);
                rebuildTagChainForEntity ('location', $_REQUEST['location_id'], buildTagChainFromIds ($taglist), TRUE);
        }
        else
                commitRenameObject ($_REQUEST['location_id'], $_REQUEST['name']);

        $locationData = spotEntity ('location', $_REQUEST['location_id']);

        // parent_id was submitted, but no link exists - create it
        if ($_REQUEST['parent_id'] > 0 && !$locationData['parent_id'])
                commitLinkEntities ('location', $_REQUEST['parent_id'], 'location', $_REQUEST['location_id']);

        // parent_id was submitted, but it doesn't match the existing link - update it
        if ($_REQUEST['parent_id'] > 0 && $_REQUEST['parent_id'] != $locationData['parent_id'])
                commitUpdateEntityLink
                (
                        'location', $locationData['parent_id'], 'location', $_REQUEST['location_id'],
                        'location', $_REQUEST['parent_id'], 'location', $_REQUEST['location_id']
                );

        // no parent_id was submitted, but a link exists - delete it
        if ($_REQUEST['parent_id'] == 0 && $locationData['parent_id'])
                commitUnlinkEntities ('location', $locationData['parent_id'], 'location', $_REQUEST['location_id']);

        showFuncMessage (__FUNCTION__, 'OK', array ($_REQUEST['name']));
}

$msgcode['deleteLocation']['OK'] = 7;
$msgcode['deleteLocation']['ERR1'] = 206;
function deleteLocation ()
{
        assertUIntArg ('location_id');
        $locationData = spotEntity ('location', $_REQUEST['location_id']);
        amplifyCell ($locationData);
        if (count ($locationData['locations']) || count ($locationData['rows']))
        {
                showFuncMessage (__FUNCTION__, 'ERR1', array ($locationData['name']));
                return;
        }
        releaseFiles ('location', $_REQUEST['location_id']);
        destroyTagsForEntity ('location', $_REQUEST['location_id']);
        commitDeleteObject ($_REQUEST['location_id']);
        showFuncMessage (__FUNCTION__, 'OK', array ($locationData['name']));
        return buildRedirectURL ('rackspace', 'editlocations');
}

$msgcode['addRow']['OK'] = 5;
function addRow ()
{
        assertUIntArg ('location_id', TRUE);
        assertStringArg ('name');
        $row_id = commitAddObject ($_REQUEST['name'], NULL, 1561, NULL);
        if ($_REQUEST['location_id'])
                commitLinkEntities ('location', $_REQUEST['location_id'], 'row', $row_id);
        showSuccess ('added row ' . mkA ($_REQUEST['name'], 'row', $row_id));
}

$msgcode['updateRow']['OK'] = 6;
// This function is used by two forms:
//  - renderEditRowForm - all attributes may be modified
//  - renderRackspaceRowEditor - only the name and location may be modified
function updateRow ()
{
        assertUIntArg ('row_id');
        assertUIntArg ('location_id', TRUE);
        assertStringArg ('name');

        commitUpdateObject ($_REQUEST['row_id'], $_REQUEST['name'], NULL, NULL, NULL, NULL);

        global $pageno;
        if ($pageno == 'row')
                updateObjectAttributes ($_REQUEST['row_id']);

        $rowData = spotEntity ('row', $_REQUEST['row_id']);

        // location_id was submitted, but no link exists - create it
        if ($_REQUEST['location_id'] > 0 && !$rowData['location_id'])
                commitLinkEntities ('location', $_REQUEST['location_id'], 'row', $_REQUEST['row_id']);

        // location_id was submitted, but it doesn't match the existing link - update it
        if ($_REQUEST['location_id'] > 0 && $_REQUEST['location_id'] != $rowData['location_id'])
                commitUpdateEntityLink
                (
                        'location', $rowData['location_id'], 'row', $_REQUEST['row_id'],
                        'location', $_REQUEST['location_id'], 'row', $_REQUEST['row_id']
                );

        // no parent_id was submitted, but a link exists - delete it
        if ($_REQUEST['location_id'] == 0 && $rowData['location_id'])
                commitUnlinkEntities ('location', $rowData['location_id'], 'row', $_REQUEST['row_id']);

        showFuncMessage (__FUNCTION__, 'OK', array ($_REQUEST['name']));
}

$msgcode['deleteRow']['OK'] = 7;
$msgcode['deleteRow']['ERR1'] = 206;
function deleteRow ()
{
        assertUIntArg ('row_id');
        $rowData = spotEntity ('row', $_REQUEST['row_id']);
        amplifyCell ($rowData);
        if (count ($rowData['racks']))
        {
                showFuncMessage (__FUNCTION__, 'ERR1', array ($rowData['name']));
                return;
        }
        commitDeleteObject ($_REQUEST['row_id']);
        showFuncMessage (__FUNCTION__, 'OK', array ($rowData['name']));
        return buildRedirectURL ('rackspace', 'editrows');
}

$msgcode['addRack']['ERR2'] = 172;
function addRack ()
{
        $taglist = genericAssertion ('taglist', 'array0');

        // The new rack(s) should be placed on the bottom of the list, sort-wise
        $rowInfo = getRowInfo($_REQUEST['row_id']);
        $sort_order = $rowInfo['count']+1;

        if (isset ($_REQUEST['got_data']))
        {
                assertStringArg ('name');
                assertUIntArg ('height1');
                assertStringArg ('asset_no', TRUE);
                $rack_id = commitAddObject ($_REQUEST['name'], NULL, 1560, $_REQUEST['asset_no'], $taglist);
                produceTagsForNewRecord ('rack', $taglist, $rack_id);

                // Set the height and sort order
                commitUpdateAttrValue ($rack_id, 27, $_REQUEST['height1']);
                commitUpdateAttrValue ($rack_id, 29, $sort_order);

                // Link it to the row
                commitLinkEntities ('row', $_REQUEST['row_id'], 'rack', $rack_id);
                showSuccess ('added rack ' . mkA ($_REQUEST['name'], 'rack', $rack_id));
        }
        elseif (isset ($_REQUEST['got_mdata']))
        {
                assertUIntArg ('height2');
                assertStringArg ('names', TRUE);
                // copy-and-paste from renderAddMultipleObjectsForm()
                $names1 = explode ("\n", $_REQUEST['names']);
                $names2 = array();
                foreach ($names1 as $line)
                {
                        $parts = explode ('\r', $line);
                        reset ($parts);
                        if (!strlen ($parts[0]))
                                continue;
                        else
                                $names2[] = rtrim ($parts[0]);
                }
                foreach ($names2 as $cname)
                {
                        $rack_id = commitAddObject ($cname, NULL, 1560, NULL, $taglist);
                        produceTagsForNewRecord ('rack', $taglist, $rack_id);

                        // Set the height and sort order
                        commitUpdateAttrValue ($rack_id, 27, $_REQUEST['height2']);
                        commitUpdateAttrValue ($rack_id, 29, $sort_order);
                        $sort_order++;

                        // Link it to the row
                        commitLinkEntities ('row', $_REQUEST['row_id'], 'rack', $rack_id);
                        showSuccess ('added rack ' . mkA ($cname, 'rack', $rack_id));
                }
        }
        else
                showFuncMessage (__FUNCTION__, 'ERR2');
}

$msgcode['updateRack']['OK'] = 6;
function updateRack ()
{
        assertUIntArg ('row_id');
        assertStringArg ('name');
        assertUIntArg ('height');
        assertStringArg ('asset_no', TRUE);
        assertStringArg ('comment', TRUE);
        $taglist = genericAssertion ('taglist', 'array0');
        $rack_id = getBypassValue();
        usePreparedDeleteBlade ('RackThumbnail', array ('rack_id' => $rack_id));
        commitUpdateRack
        (
                $rack_id,
                $_REQUEST['row_id'],
                $_REQUEST['name'],
                $_REQUEST['height'],
                isCheckSet ('has_problems', 'yesno'),
                $_REQUEST['asset_no'],
                $_REQUEST['comment']
        );
        updateObjectAttributes ($rack_id);
        rebuildTagChainForEntity ('rack', $rack_id, buildTagChainFromIds ($taglist), TRUE);
        showFuncMessage (__FUNCTION__, 'OK', array ($_REQUEST['name']));
}

$msgcode['deleteRack']['OK'] = 7;
$msgcode['deleteRack']['ERR1'] = 206;
function deleteRack ()
{
        assertUIntArg ('rack_id');
        $rackData = spotEntity ('rack', $_REQUEST['rack_id']);
        amplifyCell ($rackData);
        if (count ($rackData['mountedObjects']))
        {
                showFuncMessage (__FUNCTION__, 'ERR1');
                return;
        }
        releaseFiles ('rack', $_REQUEST['rack_id']);
        destroyTagsForEntity ('rack', $_REQUEST['rack_id']);
        usePreparedDeleteBlade ('RackSpace', array ('rack_id' => $_REQUEST['rack_id']));
        commitDeleteObject ($_REQUEST['rack_id']);
        resetRackSortOrder ($rackData['row_id']);
        showFuncMessage (__FUNCTION__, 'OK', array ($rackData['name']));
        return buildRedirectURL ('rackspace', 'default');
}

function updateRackDesign ()
{
        $rackData = spotEntity ('rack', getBypassValue());
        amplifyCell ($rackData);
        applyRackDesignMask($rackData);
        if (processGridForm ($rackData, 'A', 'F'))
                showSuccess ("Saved successfully");
        else
                showNotice ("Nothing saved");
}

function updateRackProblems ()
{
        $rackData = spotEntity ('rack', getBypassValue());
        amplifyCell ($rackData);
        applyRackProblemMask($rackData);
        if (processGridForm ($rackData, 'F', 'U'))
                showSuccess ("Saved successfully");
        else
                showNotice ("Nothing saved");
}

function querySNMPData ()
{
        genericAssertion ('ver', 'uint');
        $snmpsetup = array ();
        switch ($_REQUEST['ver'])
        {
        case 1:
        case 2:
                genericAssertion ('community', 'string');
                $snmpsetup['community'] = $_REQUEST['community'];
                break;
        case 3:
                assertStringArg ('sec_name');
                assertStringArg ('sec_level');
                assertStringArg ('auth_protocol');
                assertStringArg ('auth_passphrase', TRUE);
                assertStringArg ('priv_protocol');
                assertStringArg ('priv_passphrase', TRUE);

                $snmpsetup['sec_name'] = $_REQUEST['sec_name'];
                $snmpsetup['sec_level'] = $_REQUEST['sec_level'];
                $snmpsetup['auth_protocol'] = $_REQUEST['auth_protocol'];
                $snmpsetup['auth_passphrase'] = $_REQUEST['auth_passphrase'];
                $snmpsetup['priv_protocol'] = $_REQUEST['priv_protocol'];
                $snmpsetup['priv_passphrase'] = $_REQUEST['priv_passphrase'];
                break;
        default:
                throw new InvalidRequestArgException ('ver', $_REQUEST['ver']);
        }
        $snmpsetup['version'] = $_REQUEST['ver'];
        doSNMPmining (getBypassValue(), $snmpsetup); // shows message by itself
}

$msgcode['addFileWithoutLink']['OK'] = 5;
// File-related functions
function addFileWithoutLink ()
{
        assertStringArg ('comment', TRUE);

        // Make sure the file can be uploaded
        if (get_cfg_var('file_uploads') != 1)
                throw new RackTablesError ('file uploads not allowed, change "file_uploads" parameter in php.ini', RackTablesError::MISCONFIGURED);

        $fp = fopen($_FILES['file']['tmp_name'], 'rb');
        global $sic;
        $file_id = commitAddFile ($_FILES['file']['name'], $_FILES['file']['type'], $fp, $sic['comment']);
        if (isset ($_REQUEST['taglist']))
                produceTagsForNewRecord ('file', $_REQUEST['taglist'], $file_id);
        showFuncMessage (__FUNCTION__, 'OK', array (htmlspecialchars ($_FILES['file']['name'])));
}

$msgcode['addFileToEntity']['OK'] = 5;
$msgcode['addFileToEntity']['ERR1'] = 207;
function addFileToEntity ()
{
        global $pageno, $etype_by_pageno;
        if (!isset ($etype_by_pageno[$pageno]))
                throw new RackTablesError ('key not found in etype_by_pageno', RackTablesError::INTERNAL);
        $realm = $etype_by_pageno[$pageno];
        assertStringArg ('comment', TRUE);

        // Make sure the file can be uploaded
        if (get_cfg_var('file_uploads') != 1)
                throw new RackTablesError ('file uploads not allowed, change "file_uploads" parameter in php.ini', RackTablesError::MISCONFIGURED);

        // Exit if the upload failed
        if ($_FILES['file']['error'])
        {
                showFuncMessage (__FUNCTION__, 'ERR1', array ($_FILES['file']['error']));
                return;
        }

        $fp = fopen($_FILES['file']['tmp_name'], 'rb');
        global $sic;
        commitAddFile ($_FILES['file']['name'], $_FILES['file']['type'], $fp, $sic['comment']);
        usePreparedInsertBlade
        (
                'FileLink',
                array
                (
                        'file_id' => lastInsertID(),
                        'entity_type' => $realm,
                        'entity_id' => getBypassValue(),
                )
        );
        showFuncMessage (__FUNCTION__, 'OK', array (htmlspecialchars ($_FILES['file']['name'])));
}

$msgcode['linkFileToEntity']['OK'] = 71;
function linkFileToEntity ()
{
        assertUIntArg ('file_id');
        global $pageno, $etype_by_pageno, $sic;
        if (!isset ($etype_by_pageno[$pageno]))
                throw new RackTablesError ('key not found in etype_by_pageno', RackTablesError::INTERNAL);

        usePreparedInsertBlade
        (
                'FileLink',
                array
                (
                        'file_id' => $sic['file_id'],
                        'entity_type' => $etype_by_pageno[$pageno],
                        'entity_id' => getBypassValue(),
                )
        );
        $fi = spotEntity ('file', $sic['file_id']);
        showFuncMessage (__FUNCTION__, 'OK', array (htmlspecialchars ($fi['name'])));
}

$msgcode['replaceFile']['OK'] = 7;
$msgcode['replaceFile']['ERR2'] = 201;
function replaceFile ()
{
        // Make sure the file can be uploaded
        if (get_cfg_var('file_uploads') != 1)
                throw new RackTablesError ('file uploads not allowed, change "file_uploads" parameter in php.ini', RackTablesError::MISCONFIGURED);
        $shortInfo = spotEntity ('file', getBypassValue());

        if (FALSE === $fp = fopen ($_FILES['file']['tmp_name'], 'rb'))
        {
                showFuncMessage (__FUNCTION__, 'ERR2');
                return;
        }
        commitReplaceFile ($shortInfo['id'], $fp);

        showFuncMessage (__FUNCTION__, 'OK', array (htmlspecialchars ($shortInfo['name'])));
}

$msgcode['unlinkFile']['OK'] = 72;
function unlinkFile ()
{
        assertUIntArg ('link_id');
        commitUnlinkFile ($_REQUEST['link_id']);
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['deleteFile']['OK'] = 7;
function deleteFile ()
{
        assertUIntArg ('file_id');
        $shortInfo = spotEntity ('file', $_REQUEST['file_id']);
        commitDeleteFile ($_REQUEST['file_id']);
        showFuncMessage (__FUNCTION__, 'OK', array (htmlspecialchars ($shortInfo['name'])));
}

$msgcode['updateFileText']['OK'] = 6;
$msgcode['updateFileText']['ERR1'] = 179;
$msgcode['updateFileText']['ERR2'] = 155;
function updateFileText ()
{
        assertStringArg ('mtime_copy');
        assertStringArg ('file_text', TRUE); // it's Ok to save empty
        $shortInfo = spotEntity ('file', getBypassValue());
        if ($shortInfo['mtime'] != $_REQUEST['mtime_copy'])
        {
                showFuncMessage (__FUNCTION__, 'ERR1');
                return;
        }
        global $sic;
        commitReplaceFile ($shortInfo['id'], $sic['file_text']);
        showFuncMessage (__FUNCTION__, 'OK', array (htmlspecialchars ($shortInfo['name'])));
}

$msgcode['addIIFOIFCompat']['OK'] = 48;
function addIIFOIFCompat ()
{
        assertUIntArg ('iif_id');
        assertUIntArg ('oif_id');
        commitSupplementPIC ($_REQUEST['iif_id'], $_REQUEST['oif_id']);
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['addIIFOIFCompatPack']['OK'] = 37;
function addIIFOIFCompatPack ()
{
        genericAssertion ('standard', 'enum/wdmstd');
        genericAssertion ('iif_id', 'iif');
        global $wdm_packs, $sic;
        $ngood = 0;
        foreach ($wdm_packs[$sic['standard']]['oif_ids'] as $oif_id)
        {
                commitSupplementPIC ($sic['iif_id'], $oif_id);
                $ngood++;
        }
        showFuncMessage (__FUNCTION__, 'OK', array ($ngood));
}

$msgcode['delIIFOIFCompatPack']['OK'] = 38;
function delIIFOIFCompatPack ()
{
        genericAssertion ('standard', 'enum/wdmstd');
        genericAssertion ('iif_id', 'iif');
        global $wdm_packs, $sic;
        $ngood = 0;
        foreach ($wdm_packs[$sic['standard']]['oif_ids'] as $oif_id)
        {
                usePreparedDeleteBlade ('PortInterfaceCompat', array ('iif_id' => $sic['iif_id'], 'oif_id' => $oif_id));
                $ngood++;
        }
        showFuncMessage (__FUNCTION__, 'OK', array ($ngood));
}

$msgcode['addOIFCompatPack']['OK'] = 21;
function addOIFCompatPack ()
{
        genericAssertion ('standard', 'enum/wdmstd');
        global $wdm_packs;
        $oifs = $wdm_packs[$_REQUEST['standard']]['oif_ids'];
        foreach ($oifs as $oif_id_1)
        {
                $args = $qmarks = array();
                $query = 'REPLACE INTO PortCompat (type1, type2) VALUES ';
                foreach ($oifs as $oif_id_2)
                {
                        $qmarks[] = '(?, ?)';
                        $args[] = $oif_id_1;
                        $args[] = $oif_id_2;
                }
                $query .= implode (', ', $qmarks);
                usePreparedExecuteBlade ($query, $args);
        }
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['delOIFCompatPack']['OK'] = 21;
function delOIFCompatPack ()
{
        genericAssertion ('standard', 'enum/wdmstd');
        global $wdm_packs;
        $oifs = $wdm_packs[$_REQUEST['standard']]['oif_ids'];
        foreach ($oifs as $oif_id_1)
                foreach ($oifs as $oif_id_2)
                        if ($oif_id_1 != $oif_id_2) # leave narrow-band mapping intact
                                usePreparedDeleteBlade ('PortCompat', array ('type1' => $oif_id_1, 'type2' => $oif_id_2));
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['add8021QOrder']['OK'] = 48;
function add8021QOrder ()
{
        assertUIntArg ('vdom_id');
        assertUIntArg ('object_id');
        assertUIntArg ('vst_id');
        global $sic, $pageno;
        fixContext();
        if ($pageno != 'object')
                spreadContext (spotEntity ('object', $sic['object_id']));
        if ($pageno != 'vst')
                spreadContext (spotEntity ('vst', $sic['vst_id']));
        assertPermission();
        usePreparedExecuteBlade
        (
                'INSERT INTO VLANSwitch (domain_id, object_id, template_id, last_change, out_of_sync) ' .
                'VALUES (?, ?, ?, NOW(), "yes")',
                array ($sic['vdom_id'], $sic['object_id'], $sic['vst_id'])
        );
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['del8021QOrder']['OK'] = 49;
function del8021QOrder ()
{
        assertUIntArg ('object_id');
        assertUIntArg ('vdom_id');
        assertUIntArg ('vst_id');
        global $sic, $pageno;
        fixContext();
        if ($pageno != 'object')
                spreadContext (spotEntity ('object', $sic['object_id']));
        if ($pageno != 'vst')
                spreadContext (spotEntity ('vst', $sic['vst_id']));
        assertPermission();
        usePreparedDeleteBlade ('VLANSwitch', array ('object_id' => $sic['object_id']));
        $focus_hints = array
        (
                'prev_objid' => $_REQUEST['object_id'],
                'prev_vstid' => $_REQUEST['vst_id'],
                'prev_vdid' => $_REQUEST['vdom_id'],
        );
        showFuncMessage (__FUNCTION__, 'OK');
        return buildRedirectURL (NULL, NULL, $focus_hints);
}

$msgcode['createVLANDomain']['OK'] = 48;
function createVLANDomain ()
{
        assertStringArg ('vdom_descr');
        global $sic;
        usePreparedInsertBlade
        (
                'VLANDomain',
                array
                (
                        'description' => $sic['vdom_descr'],
                )
        );
        usePreparedInsertBlade
        (
                'VLANDescription',
                array
                (
                        'domain_id' => lastInsertID(),
                        'vlan_id' => VLAN_DFL_ID,
                        'vlan_type' => 'compulsory',
                        'vlan_descr' => 'default',
                )
        );
        showFuncMessage (__FUNCTION__, 'OK');
}

function save8021QPorts ()
{
        global $sic;
        assertUIntArg ('mutex_rev', TRUE); // counts from 0
        assertStringArg ('form_mode');
        if ($sic['form_mode'] != 'save' and $sic['form_mode'] != 'duplicate')
                throw new InvalidRequestArgException ('form_mode', $sic['form_mode']);
        $extra = array();

        // prepare the $changes array
        $changes = array();
        switch ($sic['form_mode'])
        {
        case 'save':
                assertUIntArg ('nports');
                if ($sic['nports'] == 1)
                {
                        assertStringArg ('pn_0');
                        $extra = array ('port_name' => $sic['pn_0']);
                }
                for ($i = 0; $i < $sic['nports']; $i++)
                {
                        assertStringArg ('pn_' . $i);
                        assertStringArg ('pm_' . $i);
                        // An access port only generates form input for its native VLAN,
                        // which we derive allowed VLAN list from.
                        $native = isset ($sic['pnv_' . $i]) ? $sic['pnv_' . $i] : 0;
                        switch ($sic["pm_${i}"])
                        {
                        case 'trunk':
#                               assertArrayArg ('pav_' . $i);
                                $allowed = isset ($sic['pav_' . $i]) ? $sic['pav_' . $i] : array();
                                break;
                        case 'access':
                                if ($native == 'same')
                                        continue 2;
                                assertUIntArg ('pnv_' . $i);
                                $allowed = array ($native);
                                break;
                        default:
                                throw new InvalidRequestArgException ("pm_${i}", $_REQUEST["pm_${i}"], 'unknown port mode');
                        }
                        $changes[$sic['pn_' . $i]] = array
                        (
                                'mode' => $sic['pm_' . $i],
                                'allowed' => $allowed,
                                'native' => $native,
                        );
                }
                break;
        case 'duplicate':
                assertStringArg ('from_port');
#                       assertArrayArg ('to_ports');
                $before = getStored8021QConfig ($sic['object_id'], 'desired');
                if (!array_key_exists ($sic['from_port'], $before))
                        throw new InvalidArgException ('from_port', $sic['from_port'], 'this port does not exist');
                foreach ($sic['to_ports'] as $tpn)
                        if (!array_key_exists ($tpn, $before))
                                throw new InvalidArgException ('to_ports[]', $tpn, 'this port does not exist');
                        elseif ($tpn != $sic['from_port'])
                                $changes[$tpn] = $before[$sic['from_port']];
                break;
        }
        apply8021qChangeRequest ($sic['object_id'], $changes, TRUE, $sic['mutex_rev']);
        return buildRedirectURL (NULL, NULL, $extra);
}

$msgcode['bindVLANtoIPv4']['OK'] = 48;
function bindVLANtoIPv4 ()
{
        genericAssertion ('id', 'uint');
        genericAssertion ('vlan_ck', 'uint-vlan1');
        global $sic;
        commitSupplementVLANIPv4 ($sic['vlan_ck'], $sic['id']);
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['bindVLANtoIPv6']['OK'] = 48;
function bindVLANtoIPv6 ()
{
        genericAssertion ('id', 'uint');
        genericAssertion ('vlan_ck', 'uint-vlan1');
        global $sic;
        commitSupplementVLANIPv6 ($sic['vlan_ck'], $_REQUEST['id']);
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['unbindVLANfromIPv4']['OK'] = 49;
function unbindVLANfromIPv4 ()
{
        genericAssertion ('id', 'uint');
        genericAssertion ('vlan_ck', 'uint-vlan1');
        global $sic;
        commitReduceVLANIPv4 ($sic['vlan_ck'], $sic['id']);
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['unbindVLANfromIPv6']['OK'] = 49;
function unbindVLANfromIPv6 ()
{
        genericAssertion ('id', 'uint');
        genericAssertion ('vlan_ck', 'uint-vlan1');
        global $sic;
        commitReduceVLANIPv6 ($sic['vlan_ck'], $sic['id']);
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['process8021QSyncRequest']['OK'] = 63;
$msgcode['process8021QSyncRequest']['ERR'] = 191;
function process8021QSyncRequest ()
{
        // behave depending on current operation: exec8021QPull or exec8021QPush
        global $sic, $op;
        if (FALSE === $done = exec8021QDeploy ($sic['object_id'], $op == 'exec8021QPush'))
                showFuncMessage (__FUNCTION__, 'ERR');
        else
                showFuncMessage (__FUNCTION__, 'OK', array ($done));
}

$msgcode['process8021QRecalcRequest']['CHANGED'] = 87;
function process8021QRecalcRequest ()
{
        assertPermission (NULL, NULL, NULL, array (array ('tag' => '$op_recalc8021Q')));
        $counters = recalc8021QPorts (getBypassValue());
        if ($counters['ports'])
                showFuncMessage (__FUNCTION__, 'CHANGED', array ($counters['ports'], $counters['switches']));
        else
                showNotice ('No changes were made');
}

$msgcode['resolve8021QConflicts']['OK'] = 63;
$msgcode['resolve8021QConflicts']['ERR1'] = 179;
$msgcode['resolve8021QConflicts']['ERR2'] = 109;
function resolve8021QConflicts ()
{
        global $sic, $dbxlink;
        assertUIntArg ('mutex_rev', TRUE); // counts from 0
        assertUIntArg ('nrows');
        // Divide submitted radio buttons into 3 groups:
        // left (saved version wins)
        // asis (ignore)
        // right (running version wins)
        $F = array();
        for ($i = 0; $i < $sic['nrows']; $i++)
        {
                if (!array_key_exists ("i_${i}", $sic))
                        continue;
                // let's hope other inputs are in place
                switch ($sic["i_${i}"])
                {
                case 'left':
                case 'right':
                        $F[$sic["pn_${i}"]] = array
                        (
                                'mode' => $sic["rm_${i}"],
                                'allowed' => array_fetch ($sic, "ra_${i}", array()),
                                'native' => $sic["rn_${i}"],
                                'decision' => $sic["i_${i}"],
                        );
                        break;
                default:
                        // don't care
                }
        }
        $dbxlink->beginTransaction();
        try
        {
                if (NULL === $vswitch = getVLANSwitchInfo ($sic['object_id'], 'FOR UPDATE'))
                        throw new InvalidArgException ('object_id', $sic['object_id'], 'VLAN domain is not set for this object');
                if ($vswitch['mutex_rev'] != $sic['mutex_rev'])
                        throw new InvalidRequestArgException ('mutex_rev', $sic['mutex_rev'], 'expired form (table data has changed)');
                $D = getStored8021QConfig ($vswitch['object_id'], 'desired');
                $C = getStored8021QConfig ($vswitch['object_id'], 'cached');
                $R = getRunning8021QConfig ($vswitch['object_id']);
                $plan = get8021QSyncOptions ($vswitch, $D, $C, $R['portdata']);
                $ndone = 0;
                foreach ($F as $port_name => $port)
                {
                        if (!array_key_exists ($port_name, $plan))
                                continue;
                        elseif ($plan[$port_name]['status'] == 'merge_conflict')
                        {
                                // for R neither mutex nor revisions can be emulated, but revision change can be
                                if (!same8021QConfigs ($port, $R['portdata'][$port_name]))
                                        throw new InvalidRequestArgException ("port ${port_name}", '(hidden)', 'expired form (switch data has changed)');
                                if ($port['decision'] == 'right') // D wins, frame R by writing value of R to C
                                        $ndone += upd8021QPort ('cached', $vswitch['object_id'], $port_name, $port);
                                elseif ($port['decision'] == 'left') // R wins, cross D up
                                        $ndone += upd8021QPort ('cached', $vswitch['object_id'], $port_name, $D[$port_name]);
                                // otherwise there was no decision made
                        }
                        elseif
                        (
                                $plan[$port_name]['status'] == 'delete_conflict' or
                                $plan[$port_name]['status'] == 'martian_conflict'
                        )
                                if ($port['decision'] == 'left')
                                        // confirm deletion of local copy
                                        $ndone += del8021QPort ($vswitch['object_id'], $port_name);
                                // otherwise ignore a decision that doesn't address a conflict
                }
        }
        catch (InvalidRequestArgException $e)
        {
                $dbxlink->rollBack();
                showFuncMessage (__FUNCTION__, 'ERR1');
                return;
        }
        catch (Exception $e)
        {
                $dbxlink->rollBack();
                showFuncMessage (__FUNCTION__, 'ERR2');
                return;
        }
        $dbxlink->commit();
        showFuncMessage (__FUNCTION__, 'OK', array ($ndone));
}

function update8021QPortList()
{
        genericAssertion ('ports', 'array');
        $enabled = $disabled = 0;
        global $sic;
        $default_port = array
        (
                'mode' => 'access',
                'allowed' => array (VLAN_DFL_ID),
                'native' => VLAN_DFL_ID,
        );
        foreach ($sic['ports'] as $line)
                if (preg_match ('/^enable (.+)$/', $line, $m))
                        $enabled += add8021QPort (getBypassValue(), $m[1], $default_port);
                elseif (preg_match ('/^disable (.+)$/', $line, $m))
                        $disabled += del8021QPort (getBypassValue(), $m[1]);
                else
                        throw new InvalidRequestArgException ('ports[]', $line, 'malformed array item');
        # $enabled + $disabled > 0
        if ($enabled)
                showSuccess ("enabled 802.1Q for ${enabled} port(s)");
        if ($disabled)
                showSuccess ("disabled 802.1Q for ${disabled} port(s)");
}

$msgcode['cloneVST']['OK'] = 48;
function cloneVST()
{
        assertUIntArg ('mutex_rev', TRUE);
        assertUIntArg ('from_id');
        $src_vst = spotEntity ('vst', $_REQUEST['from_id']);
        amplifyCell ($src_vst);
        commitUpdateVSTRules (getBypassValue(), $_REQUEST['mutex_rev'], $src_vst['rules']);
        showFuncMessage (__FUNCTION__, 'OK');
}

$msgcode['updVSTRule']['OK'] = 43;
function updVSTRule()
{
        // this is used for making throwing an invalid argument exception easier.
        function updVSTRule_get_named_param ($name, $haystack, &$last_used_name)
        {
                $last_used_name = $name;
                return isset ($haystack[$name]) ? $haystack[$name] : NULL;
        }