r3037 - maintenance->trunk sync of changesets 2025~2026
[racktables] / inc / functions.php
index c4470e8..ce2ce5f 100644 (file)
@@ -36,27 +36,176 @@ $etype_by_pageno = array
        'file' => 'file',
 );
 
+// Rack thumbnail image width summands: "front", "interior" and "rear" elements w/o surrounding border.
+$rtwidth = array
+(
+       0 => 9,
+       1 => 21,
+       2 => 9
+);
+
+$netmaskbylen = array
+(
+       32 => '255.255.255.255',
+       31 => '255.255.255.254',
+       30 => '255.255.255.252',
+       29 => '255.255.255.248',
+       28 => '255.255.255.240',
+       27 => '255.255.255.224',
+       26 => '255.255.255.192',
+       25 => '255.255.255.128',
+       24 => '255.255.255.0',
+       23 => '255.255.254.0',
+       22 => '255.255.252.0',
+       21 => '255.255.248.0',
+       20 => '255.255.240.0',
+       19 => '255.255.224.0',
+       18 => '255.255.192.0',
+       17 => '255.255.128.0',
+       16 => '255.255.0.0',
+       15 => '255.254.0.0',
+       14 => '255.252.0.0',
+       13 => '255.248.0.0',
+       12 => '255.240.0.0',
+       11 => '255.224.0.0',
+       10 => '255.192.0.0',
+       9 => '255.128.0.0',
+       8 => '255.0.0.0',
+       7 => '254.0.0.0',
+       6 => '252.0.0.0',
+       5 => '248.0.0.0',
+       4 => '240.0.0.0',
+       3 => '224.0.0.0',
+       2 => '192.0.0.0',
+       1 => '128.0.0.0'
+);
+
+$wildcardbylen = array
+(
+       32 => '0.0.0.0',
+       31 => '0.0.0.1',
+       30 => '0.0.0.3',
+       29 => '0.0.0.7',
+       28 => '0.0.0.15',
+       27 => '0.0.0.31',
+       26 => '0.0.0.63',
+       25 => '0.0.0.127',
+       24 => '0.0.0.255',
+       23 => '0.0.1.255',
+       22 => '0.0.3.255',
+       21 => '0.0.7.255',
+       20 => '0.0.15.255',
+       19 => '0.0.31.255',
+       18 => '0.0.63.255',
+       17 => '0.0.127.255',
+       16 => '0.0.255.25',
+       15 => '0.1.255.255',
+       14 => '0.3.255.255',
+       13 => '0.7.255.255',
+       12 => '0.15.255.255',
+       11 => '0.31.255.255',
+       10 => '0.63.255.255',
+       9 => '0.127.255.255',
+       8 => '0.255.255.255',
+       7 => '1.255.255.255',
+       6 => '3.255.255.255',
+       5 => '7.255.255.255',
+       4 => '15.255.255.255',
+       3 => '31.255.255.255',
+       2 => '63.255.255.255',
+       1 => '127.255.255.255'
+);
+
+// This function assures that specified argument was passed
+// and is a number greater than zero.
+function assertUIntArg ($argname, $caller = 'N/A', $allow_zero = FALSE)
+{
+       if (!isset ($_REQUEST[$argname]))
+       {
+               showError ("Parameter '${argname}' is missing (calling function is [${caller}]).", __FUNCTION__);
+               die();
+       }
+       if (!is_numeric ($_REQUEST[$argname]))
+       {
+               showError ("Parameter '${argname}' is not a number (calling function is [${caller}]).", __FUNCTION__);
+               die();
+       }
+       if ($_REQUEST[$argname] < 0)
+       {
+               showError ("Parameter '${argname}' is less than zero (calling function is [${caller}]).", __FUNCTION__);
+               die();
+       }
+       if (!$allow_zero and $_REQUEST[$argname] === 0)
+       {
+               showError ("Parameter '${argname}' is equal to zero (calling function is [${caller}]).", __FUNCTION__);
+               die();
+       }
+}
+
+// This function assures that specified argument was passed
+// and is a non-empty string.
+function assertStringArg ($argname, $caller = 'N/A', $ok_if_empty = FALSE)
+{
+       if (!isset ($_REQUEST[$argname]))
+       {
+               showError ("Parameter '${argname}' is missing (calling function is [${caller}]).", __FUNCTION__);
+               die();
+       }
+       if (!is_string ($_REQUEST[$argname]))
+       {
+               showError ("Parameter '${argname}' is not a string (calling function is [${caller}]).", __FUNCTION__);
+               die();
+       }
+       if (!$ok_if_empty and !strlen ($_REQUEST[$argname]))
+       {
+               showError ("Parameter '${argname}' is an empty string (calling function is [${caller}]).", __FUNCTION__);
+               die();
+       }
+}
+
+function assertBoolArg ($argname, $caller = 'N/A', $ok_if_empty = FALSE)
+{
+       if (!isset ($_REQUEST[$argname]))
+       {
+               showError ("Parameter '${argname}' is missing (calling function is [${caller}]).", __FUNCTION__);
+               die();
+       }
+       if (!is_string ($_REQUEST[$argname]) or $_REQUEST[$argname] != 'on')
+       {
+               showError ("Parameter '${argname}' is not a string (calling function is [${caller}]).", __FUNCTION__);
+               die();
+       }
+       if (!$ok_if_empty and !strlen ($_REQUEST[$argname]))
+       {
+               showError ("Parameter '${argname}' is an empty string (calling function is [${caller}]).", __FUNCTION__);
+               die();
+       }
+}
+
+function assertIPv4Arg ($argname, $caller = 'N/A', $ok_if_empty = FALSE)
+{
+       assertStringArg ($argname, $caller, $ok_if_empty);
+       if (strlen ($_REQUEST[$argname]) and long2ip (ip2long ($_REQUEST[$argname])) !== $_REQUEST[$argname])
+       {
+               showError ("IPv4 address validation failed for value '" . $_REQUEST[$argname] . "' (calling function is [${caller}]).", __FUNCTION__);
+               die();
+       }
+}
+
 // Objects of some types should be explicitly shown as
 // anonymous (labelless). This function is a single place where the
 // decision about displayed name is made.
-function displayedName ($objectData)
+function setDisplayedName (&$cell)
 {
-       if ($objectData['name'] != '')
-               return $objectData['name'];
-       // handle transition of argument type
-       if (isset ($objectData['realm']))
-       {
-               if (considerConfiguredConstraint ($objectData, 'NAMEWARN_LISTSRC'))
-                       return "ANONYMOUS " . $objectData['objtype_name'];
-               else
-                       return "[${objectData['objtype_name']}]";
-       }
+       if ($cell['name'] != '')
+               $cell['dname'] = $cell['name'];
        else
        {
-               if (considerConfiguredConstraint (spotEntity ('object', $objectData['id']), 'NAMEWARN_LISTSRC'))
-                       return "ANONYMOUS " . $objectData['objtype_name'];
+               $cell['atags'][] = array ('tag' => '$nameless');
+               if (considerConfiguredConstraint ($cell, 'NAMEWARN_LISTSRC'))
+                       $cell['dname'] = 'ANONYMOUS ' . decodeObjectType ($cell['objtype_id'], 'o');
                else
-                       return "[${objectData['objtype_name']}]";
+                       $cell['dname'] = '[' . decodeObjectType ($cell['objtype_id'], 'o') . ']';
        }
 }
 
@@ -380,44 +529,25 @@ function markupObjectProblems (&$rackData)
                        }
 }
 
-function search_cmpObj ($a, $b)
-{
-       return ($a['score'] > $b['score'] ? -1 : 1);
-}
-
-function getObjectSearchResults ($terms)
-{
-       $objects = array();
-       mergeSearchResults ($objects, $terms, 'name');
-       mergeSearchResults ($objects, $terms, 'label');
-       mergeSearchResults ($objects, $terms, 'asset_no');
-       mergeSearchResults ($objects, $terms, 'barcode');
-       if (count ($objects) == 1)
-               usort ($objects, 'search_cmpObj');
-       return $objects;
-}
-
-// This function removes all colons and dots from a string.
+// Return a uniformly (010203040506 or 0102030405060708) formatted address, if it is present
+// in the provided string, an empty string for an empty string or NULL for error.
 function l2addressForDatabase ($string)
 {
        $string = strtoupper ($string);
        switch (TRUE)
        {
-               case ($string == '' or preg_match (RE_L2_SOLID, $string)):
+               case ($string == '' or preg_match (RE_L2_SOLID, $string) or preg_match (RE_L2_WWN_SOLID, $string)):
                        return $string;
-               case (preg_match (RE_L2_IFCFG, $string)):
-                       $pieces = explode (':', $string);
-                       // This workaround is for SunOS ifconfig.
-                       foreach ($pieces as &$byte)
-                               if (strlen ($byte) == 1)
-                                       $byte = '0' . $byte;
-                       // And this workaround is for PHP.
-                       unset ($byte);
-                       return implode ('', $pieces);
+               case (preg_match (RE_L2_IFCFG, $string) or preg_match (RE_L2_WWN_COLON, $string)):
+                       // reformat output of SunOS ifconfig
+                       $ret = '';
+                       foreach (explode (':', $string) as $byte)
+                               $ret .= (strlen ($byte) == 1 ? '0' : '') . $byte;
+                       return $ret;
                case (preg_match (RE_L2_CISCO, $string)):
-                       return implode ('', explode ('.', $string));
-               case (preg_match (RE_L2_IPCFG, $string)):
-                       return implode ('', explode ('-', $string));
+                       return str_replace ('.', '', $string);
+               case (preg_match (RE_L2_IPCFG, $string) or preg_match (RE_L2_WWN_HYPHEN, $string)):
+                       return str_replace ('-', '', $string);
                default:
                        return NULL;
        }
@@ -428,7 +558,7 @@ function l2addressFromDatabase ($string)
        switch (strlen ($string))
        {
                case 12: // Ethernet
-               case 16: // FireWire
+               case 16: // FireWire/Fibre Channel
                        $ret = implode (':', str_split ($string, 2));
                        break;
                default:
@@ -556,16 +686,6 @@ function sortObjectAddressesAndNames ($a, $b)
        return $objname_cmp;
 }
 
-function sortAddresses ($a, $b)
-{
-       $name_cmp = sortTokenize($a['name'], $b['name']);
-       if ($name_cmp == 0)
-       {
-               return sortTokenize($a['ip'], $b['ip']);
-       }
-       return $name_cmp;
-}
-
 // This function expands port compat list into a matrix.
 function buildPortCompatMatrixFromList ($portTypeList, $portCompatList)
 {
@@ -585,15 +705,14 @@ function buildPortCompatMatrixFromList ($portTypeList, $portCompatList)
 // object is returned (which may appear 0 and more elements long).
 function findAllEndpoints ($object_id, $fallback = '')
 {
-       $values = getAttrValues ($object_id);
-       foreach ($values as $record)
-               if ($record['name'] == 'FQDN' && !empty ($record['value']))
+       foreach (getAttrValues ($object_id) as $record)
+               if ($record['id'] == 3 && strlen ($record['value'])) // FQDN
                        return array ($record['value']);
        $regular = array();
        foreach (getObjectIPv4Allocations ($object_id) as $dottedquad => $alloc)
                if ($alloc['type'] == 'regular')
                        $regular[] = $dottedquad;
-       if (!count ($regular) && !empty ($fallback))
+       if (!count ($regular) && strlen ($fallback))
                return array ($fallback);
        return $regular;
 }
@@ -605,11 +724,13 @@ function findAllEndpoints ($object_id, $fallback = '')
 // 3. [[word word word | URL]]
 // This function parses the line and returns text suitable for either A
 // (rendering <A HREF>) or O (for <OPTION>).
-function parseWikiLink ($line, $which, $strip_optgroup = FALSE)
+function parseWikiLink ($line, $which)
 {
        if (preg_match ('/^\[\[.+\]\]$/', $line) == 0)
        {
-               if ($strip_optgroup)
+               // always strip the marker for A-data, but let cookOptgroup()
+               // do this later (otherwise it can't sort groups out)
+               if ($which == 'a')
                        return ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $line));
                else
                        return $line;
@@ -617,25 +738,17 @@ function parseWikiLink ($line, $which, $strip_optgroup = FALSE)
        $line = preg_replace ('/^\[\[(.+)\]\]$/', '$1', $line);
        $s = explode ('|', $line);
        $o_value = trim ($s[0]);
-       if ($strip_optgroup)
-               $o_value = ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $o_value));
-       $a_value = trim ($s[1]);
-       if ($which == 'a')
-               return "<a href='${a_value}'>${o_value}</a>";
        if ($which == 'o')
                return $o_value;
+       $o_value = ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $o_value));
+       $a_value = trim ($s[1]);
+       return "<a href='${a_value}'>${o_value}</a>";
 }
 
-// FIXME: only renderIPv4Address() is using this function, consider
-// phasing it out.
-function buildVServiceName ($vsinfo = NULL)
+// FIXME: should this be saved as "P-data"?
+function execGMarker ($line)
 {
-       if ($vsinfo == NULL)
-       {
-               showError ('NULL argument', __FUNCTION__);
-               return NULL;
-       }
-       return $vsinfo['vip'] . ':' . $vsinfo['vport'] . '/' . $vsinfo['proto'];
+       return ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $line));
 }
 
 // rackspace usage for a single rack
@@ -682,7 +795,7 @@ function getRSUforRackRow ($rowData = NULL)
 function lf_wrap ($str)
 {
        $ret = trim ($str, "\r\n");
-       if (!empty ($ret))
+       if (strlen ($ret))
                $ret .= "\n";
        return $ret;
 }
@@ -764,14 +877,35 @@ function pokeNode (&$tree, $trace, $key, $value, $threshold = 0)
        }
 }
 
+// Likewise traverse the tree with the trace and return the final node.
+function peekNode ($tree, $trace, $target_id)
+{
+       $self = __FUNCTION__;
+       if (NULL === ($next = array_shift ($trace))) // warm
+       {
+               foreach ($tree as $node)
+                       if ($node['id'] == $target_id) // hot
+                               return $node;
+       }
+       else // cold
+       {
+               foreach ($tree as $node)
+                       if ($node['id'] == $next) // warmer
+                               return $self ($node['kids'], $trace, $target_id);
+       }
+       // HCF
+       return NULL;
+}
+
 // Build a tree from the item list and return it. Input and output data is
 // indexed by item id (nested items in output are recursively stored in 'kids'
 // key, which is in turn indexed by id. Functions, which are ready to handle
 // tree collapsion/expansion themselves, may request non-zero threshold value
 // for smaller resulting tree.
-function treeFromList ($nodelist, $threshold = 0, $return_main_payload = TRUE)
+function treeFromList (&$orig_nodelist, $threshold = 0, $return_main_payload = TRUE)
 {
        $tree = array();
+       $nodelist = $orig_nodelist;
        // Array equivalent of traceEntity() function.
        $trace = array();
        // set kidc and kids only once
@@ -811,10 +945,12 @@ function treeFromList ($nodelist, $threshold = 0, $return_main_payload = TRUE)
                }
        }
        while ($nextpass);
-       if ($return_main_payload)
-               return $tree;
-       else
+       if (!$return_main_payload)
                return $nodelist;
+       // update each input node with its backtrace route
+       foreach ($trace as $nodeid => $route)
+               $orig_nodelist[$nodeid]['trace'] = $route;
+       return $tree;
 }
 
 // Build a tree from the tag list and return everything _except_ the tree.
@@ -841,119 +977,39 @@ function serializeTags ($chain, $baseurl = '')
        return $ret;
 }
 
-// For each tag add all its parent tags onto the list. Don't expect anything
-// except user's tags on the chain.
-function getTagChainExpansion ($chain, $tree = NULL)
-{
-       $self = __FUNCTION__;
-       if ($tree === NULL)
-       {
-               global $tagtree;
-               $tree = $tagtree;
-       }
-       // For each tag find its path from the root, then combine items
-       // of all paths and add them to the chain, if they aren't there yet.
-       $ret = array();
-       foreach ($tree as $taginfo1)
-       {
-               $hit = FALSE;
-               foreach ($chain as $taginfo2)
-                       if ($taginfo1['id'] == $taginfo2['id'])
-                       {
-                               $hit = TRUE;
-                               break;
-                       }
-               if (count ($taginfo1['kids']) > 0)
-               {
-                       $subsearch = $self ($chain, $taginfo1['kids']);
-                       if (count ($subsearch))
-                       {
-                               $hit = TRUE;
-                               $ret = array_merge ($ret, $subsearch);
-                       }
-               }
-               if ($hit)
-                       $ret[] = $taginfo1;
-       }
-       return $ret;
-}
-
 // Return the list of missing implicit tags.
 function getImplicitTags ($oldtags)
 {
-       $ret = array();
-       $newtags = getTagChainExpansion ($oldtags);
-       foreach ($newtags as $newtag)
-       {
-               $already_exists = FALSE;
-               foreach ($oldtags as $oldtag)
-                       if ($newtag['id'] == $oldtag['id'])
-                       {
-                               $already_exists = TRUE;
-                               break;
-                       }
-               if ($already_exists)
-                       continue;
-               $ret[] = array ('id' => $newtag['id'], 'tag' => $newtag['tag'], 'parent_id' => $newtag['parent_id']);
-       }
-       return $ret;
+       global $taglist;
+       $tmp = array();
+       foreach ($oldtags as $taginfo)
+               $tmp = array_merge ($tmp, $taglist[$taginfo['id']]['trace']);
+       // don't call array_unique here, it is in the function we will call now
+       return buildTagChainFromIds ($tmp);
 }
 
 // Minimize the chain: exclude all implicit tags and return the result.
-function getExplicitTagsOnly ($chain, $tree = NULL)
+// This function makes use of an external cache with a miss/hit ratio
+// about 3/7 (ticket:255).
+function getExplicitTagsOnly ($chain)
 {
-       $self = __FUNCTION__;
-       global $tagtree;
-       if ($tree === NULL)
-               $tree = $tagtree;
+       global $taglist, $tagRelCache;
        $ret = array();
-       foreach ($tree as $taginfo)
+       foreach (array_keys ($chain) as $keyA) // check each A
        {
-               if (isset ($taginfo['kids']))
+               $tagidA = $chain[$keyA]['id'];
+               // do not include A in result, if A is seen on the trace of any B!=A
+               foreach (array_keys ($chain) as $keyB)
                {
-                       $harvest = $self ($chain, $taginfo['kids']);
-                       if (count ($harvest) > 0)
-                       {
-                               $ret = array_merge ($ret, $harvest);
+                       $tagidB = $chain[$keyB]['id'];
+                       if ($tagidA == $tagidB)
                                continue;
-                       }
+                       if (!isset ($tagRelCache[$tagidA][$tagidB]))
+                               $tagRelCache[$tagidA][$tagidB] = in_array ($tagidA, $taglist[$tagidB]['trace']);
+                       if ($tagRelCache[$tagidA][$tagidB] === TRUE) // A is ancestor of B
+                               continue 2; // skip this A
                }
-               // This tag isn't implicit, test is for being explicit.
-               foreach ($chain as $testtag)
-                       if ($taginfo['id'] == $testtag['id'])
-                       {
-                               $ret[] = $testtag;
-                               break;
-                       }
-       }
-       return $ret;
-}
-
-// Maximize the chain: for each tag add all tags, for which it is direct or indirect parent.
-// Unlike other functions, this one accepts and returns a list of integer tag IDs, not
-// a list of tag structures. Same structure (tag ID list) is returned after processing.
-function complementByKids ($idlist, $tree = NULL, $getall = FALSE)
-{
-       $self = __FUNCTION__;
-       global $tagtree;
-       if ($tree === NULL)
-               $tree = $tagtree;
-       $getallkids = $getall;
-       $ret = array();
-       foreach ($tree as $taginfo)
-       {
-               foreach ($idlist as $test_id)
-                       if ($getall or $taginfo['id'] == $test_id)
-                       {
-                               $ret[] = $taginfo['id'];
-                               // Once matched node makes all sub-nodes match, but don't make
-                               // a mistake of matching every other node at the current level.
-                               $getallkids = TRUE;
-                               break;
-                       }
-               if (isset ($taginfo['kids']))
-                       $ret = array_merge ($ret, $self ($idlist, $taginfo['kids'], $getallkids));
-               $getallkids = FALSE;
+               $ret[] = $chain[$keyA];
        }
        return $ret;
 }
@@ -969,7 +1025,7 @@ function generateEntityAutoTags ($cell)
                        $ret[] = array ('tag' => '$rackid_' . $cell['id']);
                        $ret[] = array ('tag' => '$any_rack');
                        break;
-               case 'object': // during transition bypass is already the whole structure
+               case 'object':
                        $ret[] = array ('tag' => '$id_' . $cell['id']);
                        $ret[] = array ('tag' => '$typeid_' . $cell['objtype_id']);
                        $ret[] = array ('tag' => '$any_object');
@@ -977,10 +1033,22 @@ function generateEntityAutoTags ($cell)
                                $ret[] = array ('tag' => '$cn_' . $cell['name']);
                        if (!strlen ($cell['rack_id']))
                                $ret[] = array ('tag' => '$unmounted');
+                       if (!$cell['nports'])
+                               $ret[] = array ('tag' => '$portless');
                        break;
-               case 'ipv4net': // during transition bypass is already the whole structure
+               case 'ipv4net':
                        $ret[] = array ('tag' => '$ip4netid_' . $cell['id']);
                        $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $cell['ip']) . '-' . $cell['mask']);
+                       for ($i = 8; $i < 32; $i++)
+                       {
+                               // these conditions hit 1 to 3 times per each i
+                               if ($cell['mask'] >= $i)
+                                       $ret[] = array ('tag' => '$masklen_ge_' . $i);
+                               if ($cell['mask'] <= $i)
+                                       $ret[] = array ('tag' => '$masklen_le_' . $i);
+                               if ($cell['mask'] == $i)
+                                       $ret[] = array ('tag' => '$masklen_eq_' . $i);
+                       }
                        $ret[] = array ('tag' => '$any_ip4net');
                        $ret[] = array ('tag' => '$any_net');
                        break;
@@ -1008,6 +1076,21 @@ function generateEntityAutoTags ($cell)
                default: // HCF!
                        break;
        }
+       // {$tagless} doesn't apply to users
+       switch ($cell['realm'])
+       {
+               case 'rack':
+               case 'object':
+               case 'ipv4net':
+               case 'ipv4vs':
+               case 'ipv4rspool':
+               case 'file':
+                       if (!count ($cell['etags']))
+                               $ret[] = array ('tag' => '$untagged');
+                       break;
+               default:
+                       break;
+       }
        return $ret;
 }
 
@@ -1031,17 +1114,6 @@ function tagNameOnChain ($tagname, $tagchain)
        return FALSE;
 }
 
-// Idem, but use ID list instead of chain.
-function tagOnIdList ($taginfo, $tagidlist)
-{
-       if (!isset ($taginfo['id']))
-               return FALSE;
-       foreach ($tagidlist as $tagid)
-               if ($taginfo['id'] == $tagid)
-                       return TRUE;
-       return FALSE;
-}
-
 // Return TRUE, if two tags chains differ (order of tags doesn't matter).
 // Assume, that neither of the lists contains duplicates.
 // FIXME: a faster, than O(x^2) method is possible for this calculation.
@@ -1098,7 +1170,9 @@ function fixContext ()
        {
                // Each page listed in the map above requires one uint argument.
                assertUIntArg ($page[$pageno]['bypass'], __FUNCTION__);
-               $target = spotEntity ($etype_by_pageno[$pageno], $_REQUEST[$page[$pageno]['bypass']]);
+               $target_realm = $etype_by_pageno[$pageno];
+               $target_id = $_REQUEST[$page[$pageno]['bypass']];
+               $target = spotEntity ($target_realm, $target_id);
                $target_given_tags = $target['etags'];
                // Don't reset autochain, because auth procedures could push stuff there in.
                // Another important point is to ignore 'user' realm, so we don't infuse effective
@@ -1126,31 +1200,31 @@ function buildTagChainFromIds ($tagidlist)
 
 // Process a given tag tree and return only meaningful branches. The resulting
 // (sub)tree will have refcnt leaves on every last branch.
-function getObjectiveTagTree ($tree, $realm)
+function getObjectiveTagTree ($tree, $realm, $preselect)
 {
        $self = __FUNCTION__;
        $ret = array();
        foreach ($tree as $taginfo)
        {
-               $subsearch = array();
-               $pick = FALSE;
-               if (count ($taginfo['kids']))
-               {
-                       $subsearch = $self ($taginfo['kids'], $realm);
-                       $pick = count ($subsearch) > 0;
-               }
-               if (isset ($taginfo['refcnt'][$realm]))
-                       $pick = TRUE;
-               if (!$pick)
-                       continue;
-               $ret[] = array
+               $subsearch = $self ($taginfo['kids'], $realm, $preselect);
+               // If the current node addresses something, add it to the result
+               // regardless of how many sub-nodes it features.
+               if
                (
-                       'id' => $taginfo['id'],
-                       'tag' => $taginfo['tag'],
-                       'parent_id' => $taginfo['parent_id'],
-                       'refcnt' => $taginfo['refcnt'],
-                       'kids' => $subsearch
-               );
+                       isset ($taginfo['refcnt'][$realm]) or
+                       count ($subsearch) > 1 or
+                       in_array ($taginfo['id'], $preselect)
+               )
+                       $ret[] = array
+                       (
+                               'id' => $taginfo['id'],
+                               'tag' => $taginfo['tag'],
+                               'parent_id' => $taginfo['parent_id'],
+                               'refcnt' => $taginfo['refcnt'],
+                               'kids' => $subsearch
+                       );
+               else
+                       $ret = array_merge ($ret, $subsearch);
        }
        return $ret;
 }
@@ -1383,8 +1457,8 @@ function buildLVSConfig ($object_id = 0)
        foreach ($lbconfig as $vs_id => $vsinfo)
        {
                $newconfig .=  "########################################################\n" .
-                       "# VS (id == ${vs_id}): " . (empty ($vsinfo['vs_name']) ? 'NO NAME' : $vsinfo['vs_name']) . "\n" .
-                       "# RS pool (id == ${vsinfo['pool_id']}): " . (empty ($vsinfo['pool_name']) ? 'ANONYMOUS' : $vsinfo['pool_name']) . "\n" .
+                       "# VS (id == ${vs_id}): " . (!strlen ($vsinfo['vs_name']) ? 'NO NAME' : $vsinfo['vs_name']) . "\n" .
+                       "# RS pool (id == ${vsinfo['pool_id']}): " . (!strlen ($vsinfo['pool_name']) ? 'ANONYMOUS' : $vsinfo['pool_name']) . "\n" .
                        "########################################################\n";
                # The order of inheritance is: VS -> LB -> pool [ -> RS ]
                $macros = array
@@ -1406,7 +1480,7 @@ function buildLVSConfig ($object_id = 0)
                );
                foreach ($vsinfo['rslist'] as $rs)
                {
-                       if (empty ($rs['rsport']))
+                       if (!strlen ($rs['rsport']))
                                $rs['rsport'] = $vsinfo['vport'];
                        $macros['%RSIP%'] = $rs['rsip'];
                        $macros['%RSPORT%'] = $rs['rsport'];
@@ -1517,7 +1591,7 @@ function IPv4NetworkCmp ($netA, $netB)
 // Modify the given tag tree so, that each level's items are sorted alphabetically.
 function sortTree (&$tree, $sortfunc = '')
 {
-       if (empty ($sortfunc))
+       if (!strlen ($sortfunc))
                return;
        $self = __FUNCTION__;
        usort ($tree, $sortfunc);
@@ -1529,7 +1603,7 @@ function sortTree (&$tree, $sortfunc = '')
 
 function iptree_fill (&$netdata)
 {
-       if (!isset ($netdata['kids']) or empty ($netdata['kids']))
+       if (!isset ($netdata['kids']) or !count ($netdata['kids']))
                return;
        // If we really have nested prefixes, they must fit into the tree.
        $worktree = array
@@ -1607,13 +1681,13 @@ function iptree_embed (&$node, $pfx)
 
 function treeApplyFunc (&$tree, $func = '', $stopfunc = '')
 {
-       if (empty ($func))
+       if (!strlen ($func))
                return;
        $self = __FUNCTION__;
        foreach (array_keys ($tree) as $key)
        {
                $func ($tree[$key]);
-               if (!empty ($stopfunc) and $stopfunc ($tree[$key]))
+               if (strlen ($stopfunc) and $stopfunc ($tree[$key]))
                        continue;
                $self ($tree[$key]['kids'], $func);
        }
@@ -1633,7 +1707,7 @@ function countOwnIPv4Addresses (&$node)
        $node['mask_bin_inv'] = binInvMaskFromDec ($node['mask']);
        $node['db_first'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] & $node['mask_bin']);
        $node['db_last'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] | ($node['mask_bin_inv']));
-       if (empty ($node['kids']))
+       if (!count ($node['kids']))
        {
                $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
                $node['addrt'] = binInvMaskFromDec ($node['mask']) + 1;
@@ -1658,7 +1732,7 @@ function nodeIsCollapsed ($node)
 function loadOwnIPv4Addresses (&$node)
 {
        $toscan = array();
-       if (empty ($node['kids']))
+       if (!isset ($node['kids']) or !count ($node['kids']))
                $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
        else
                foreach ($node['kids'] as $nested)
@@ -2018,7 +2092,7 @@ function scanRealmByText ($realm = NULL, $ftext = '')
                }
                return filterCellList (listCells ($realm), $fexpr);
        default:
-               return NULL;
+               throw new InvalidArgException ('$realm', $realm);
        }
 
 }
@@ -2027,7 +2101,7 @@ function getIPv4VSOptions ()
 {
        $ret = array();
        foreach (listCells ('ipv4vs') as $vsid => $vsinfo)
-               $ret[$vsid] = $vsinfo['dname'] . (empty ($vsinfo['name']) ? '' : " (${vsinfo['name']})");
+               $ret[$vsid] = $vsinfo['dname'] . (!strlen ($vsinfo['name']) ? '' : " (${vsinfo['name']})");
        return $ret;
 }
 
@@ -2052,9 +2126,59 @@ function constructUserCell ($username)
                'user_realname' => '',
                'etags' => array(),
                'itags' => array(),
-               'atags' => array(),
        );
+       $ret['atags'] = generateEntityAutoTags ($ret);
+       return $ret;
+}
+
+// Let's have this debug helper here to enable debugging of process.php w/o interface.php.
+function dump ($var)
+{
+       echo '<div align=left><pre>';
+       print_r ($var);
+       echo '</pre></div>';
+}
+
+function getTagChart ($limit = 0, $realm = 'total', $special_tags = array())
+{
+       global $taglist;
+       // first build top-N chart...
+       $toplist = array();
+       foreach ($taglist as $taginfo)
+               if (isset ($taginfo['refcnt'][$realm]))
+                       $toplist[$taginfo['id']] = $taginfo['refcnt'][$realm];
+       arsort ($toplist, SORT_NUMERIC);
+       $ret = array();
+       $done = 0;
+       foreach (array_keys ($toplist) as $tag_id)
+       {
+               $ret[$tag_id] = $taglist[$tag_id];
+               if (++$done == $limit)
+                       break;
+       }
+       // ...then make sure, that every item of the special list is shown
+       // (using the same sort order)
+       $extra = array();
+       foreach ($special_tags as $taginfo)
+               if (!array_key_exists ($taginfo['id'], $ret))
+                       $extra[$taginfo['id']] = $taglist[$taginfo['id']]['refcnt'][$realm];
+       arsort ($extra, SORT_NUMERIC);
+       foreach (array_keys ($extra) as $tag_id)
+               $ret[] = $taglist[$tag_id];
        return $ret;
 }
 
+function decodeObjectType ($objtype_id, $style = 'r')
+{
+       static $types = array();
+       if (!count ($types))
+               $types = array
+               (
+                       'r' => readChapter (CHAP_OBJTYPE),
+                       'a' => readChapter (CHAP_OBJTYPE, 'a'),
+                       'o' => readChapter (CHAP_OBJTYPE, 'o')
+               );
+       return $types[$style][$objtype_id];
+}
+
 ?>