getServerInfo();
return !empty($info[$all ? 'pg_dumpall_path' : 'pg_dump_path']);
}
/**
* Sets the href tracking variable
*/
function setHREF() {
$this->href = $this->getHREF();
}
/**
* Get a href query string, excluding objects below the given object type (inclusive)
*/
function getHREF($exclude_from = null) {
$href = '';
if (isset($_REQUEST['server']) && $exclude_from != 'server') {
$href .= 'server=' . urlencode($_REQUEST['server']);
if (isset($_REQUEST['database']) && $exclude_from != 'database') {
$href .= '&database=' . urlencode($_REQUEST['database']);
if (isset($_REQUEST['schema']) && $exclude_from != 'schema') {
$href .= '&schema=' . urlencode($_REQUEST['schema']);
}
}
}
return $href;
}
/**
* Sets the form tracking variable
*/
function setForm() {
$this->form = '';
if (isset($_REQUEST['server'])) {
$this->form .= "\n";
if (isset($_REQUEST['database'])) {
$this->form .= "\n";
if (isset($_REQUEST['schema'])) {
$this->form .= "\n";
}
}
}
}
/**
* Render a value into HTML using formatting rules specified
* by a type name and parameters.
*
* @param $str The string to change
*
* @param $type Field type (optional), this may be an internal PostgreSQL type, or:
* yesno - same as bool, but renders as 'Yes' or 'No'.
* pre - render in a
block.
* nbsp - replace all spaces with 's
* verbatim - render exactly as supplied, no escaping what-so-ever.
* callback - render using a callback function supplied in the 'function' param.
*
* @param $params Type parameters (optional), known parameters:
* null - string to display if $str is null, or set to TRUE to use a default 'NULL' string,
* otherwise nothing is rendered.
* clip - if true, clip the value to a fixed length, and append an ellipsis...
* cliplen - the maximum length when clip is enabled (defaults to $conf['max_chars'])
* ellipsis - the string to append to a clipped value (defaults to $lang['strellipsis'])
* tag - an HTML element name to surround the value.
* class - a class attribute to apply to any surrounding HTML element.
* align - an align attribute ('left','right','center' etc.)
* true - (type='bool') the representation of true.
* false - (type='bool') the representation of false.
* function - (type='callback') a function name, accepts args ($str, $params) and returns a rendering.
* lineno - prefix each line with a line number.
* map - an associative array.
*
* @return The HTML rendered value
*/
function printVal($str, $type = null, $params = array()) {
global $lang, $conf;
// Shortcircuit for a NULL value
if (is_null($str))
return isset($params['null'])
? ($params['null'] === true ? 'NULL' : $params['null'])
: '';
if (isset($params['map']) && isset($params['map'][$str])) $str = $params['map'][$str];
// Clip the value if the 'clip' parameter is true.
if (isset($params['clip']) && $params['clip'] === true) {
$maxlen = isset($params['cliplen']) && is_integer($params['cliplen']) ? $params['cliplen'] : $conf['max_chars'];
$ellipsis = isset($params['ellipsis']) ? $params['ellipsis'] : $lang['strellipsis'];
if (strlen($str) > $maxlen) {
$str = substr($str, 0, $maxlen-1) . $ellipsis;
}
}
$out = '';
switch ($type) {
case 'int2':
case 'int4':
case 'int8':
case 'float4':
case 'float8':
case 'money':
case 'numeric':
case 'oid':
case 'xid':
case 'cid':
case 'tid':
$align = 'right';
$out = nl2br(htmlspecialchars($str));
break;
case 'yesno':
if (!isset($params['true'])) $params['true'] = $lang['stryes'];
if (!isset($params['false'])) $params['false'] = $lang['strno'];
// No break - fall through to boolean case.
case 'bool':
case 'boolean':
if (is_bool($str)) $str = $str ? 't' : 'f';
switch ($str) {
case 't':
$out = (isset($params['true']) ? $params['true'] : $lang['strtrue']);
$align = 'center';
break;
case 'f':
$out = (isset($params['false']) ? $params['false'] : $lang['strfalse']);
$align = 'center';
break;
default:
$out = htmlspecialchars($str);
}
break;
case 'bytea':
// addCSlashes converts all weird ASCII characters to octal representation,
// EXCEPT the 'special' ones like \r \n \t, etc.
$out = htmlspecialchars(addCSlashes($str, "\0..\37\177..\377"));
break;
case 'pre':
$tag = 'pre';
$out = htmlspecialchars($str);
break;
case 'prenoescape':
$tag = 'pre';
$out = $str;
break;
case 'nbsp':
$out = nl2br(str_replace(' ', ' ', htmlspecialchars($str)));
break;
case 'verbatim':
$out = $str;
break;
case 'callback':
$out = $params['function']($str, $params);
break;
default:
// If the string contains at least one instance of >1 space in a row, a tab
// character, a space at the start of a line, or a space at the start of
// the whole string then render within a pre-formatted element (
).
if (preg_match('/(^ | |\t|\n )/m', $str)) {
$tag = 'pre';
$class = 'data';
$out = htmlspecialchars($str);
} else {
$out = nl2br(htmlspecialchars($str));
}
}
if (isset($params['class'])) $class = $params['class'];
if (isset($params['align'])) $align = $params['align'];
if (!isset($tag) && (isset($class) || isset($align))) $tag = 'div';
if (isset($tag)) {
$alignattr = isset($align) ? " align=\"{$align}\"" : '';
$classattr = isset($class) ? " class=\"{$class}\"" : '';
$out = "<{$tag}{$alignattr}{$classattr}>{$out}";
}
// Add line numbers if 'lineno' param is true
if (isset($params['lineno']) && $params['lineno'] === true) {
$lines = explode("\n", $str);
$num = count($lines);
if ($num > 0) {
$temp = "
\n";
$out = $temp;
}
unset($lines);
}
return $out;
}
/**
* A function to recursively strip slashes. Used to
* enforce magic_quotes_gpc being off.
* @param &var The variable to strip
*/
function stripVar(&$var) {
if (is_array($var)) {
foreach($var as $k => $v) {
$this->stripVar($var[$k]);
}
}
else
$var = stripslashes($var);
}
/**
* Print out the page heading and help link
* @param $title Title, already escaped
* @param $help (optional) The identifier for the help link
*/
function printTitle($title, $help = null) {
global $data, $lang;
echo "
";
$this->printHelp($title, $help);
echo "
\n";
}
/**
* Print out a message
* @param $msg The message to print
*/
function printMsg($msg) {
if ($msg != '') echo "
{$msg}
\n";
}
/**
* Creates a database accessor
*/
function &getDatabaseAccessor($database, $server_id = null) {
global $lang, $conf, $misc;
$server_info = $this->getServerInfo($server_id);
// Perform extra security checks if this config option is set
if ($conf['extra_login_security']) {
// Disallowed logins if extra_login_security is enabled.
// These must be lowercase.
$bad_usernames = array('pgsql', 'postgres', 'root', 'administrator');
$username = strtolower($server_info['username']);
if ($server_info['password'] == '' || in_array($username, $bad_usernames)) {
unset($_SESSION['webdbLogin'][$_REQUEST['server']]);
$msg = $lang['strlogindisallowed'];
include('./login.php');
exit;
}
}
// Create the connection object and make the connection
$_connection = new Connection(
$server_info['host'],
$server_info['port'],
$server_info['username'],
$server_info['password'],
$database
);
// Get the name of the database driver we need to use.
// The description of the server is returned in $platform.
$_type = $_connection->getDriver($platform);
if ($_type === null) {
printf($lang['strpostgresqlversionnotsupported'], $postgresqlMinVer);
exit;
}
$this->setServerInfo('platform', $platform, $server_id);
// Create a database wrapper class for easy manipulation of the
// connection.
include_once('./classes/database/' . $_type . '.php');
$data =& new $_type($_connection->conn);
$data->platform = $_connection->platform;
return $data;
}
/**
* Prints the page header. If global variable $_no_output is
* set then no header is drawn.
* @param $title The title of the page
* @param $script script tag
*/
function printHeader($title = '', $script = null) {
global $appName, $lang, $_no_output, $conf;
if (!isset($_no_output)) {
header("Content-Type: text/html; charset=" . $lang['appcharset']);
// Send XHTML headers, or regular HTML headers
if (isset($conf['use_xhtml']) && $conf['use_xhtml']) {
echo "\n";
echo "\n";
echo "\n";
} else {
echo "\n";
echo "\n";
}
echo "\n";
echo "", htmlspecialchars($appName);
if ($title != '') echo " - {$title}";
echo "\n";
echo "\n";
// Theme
echo "\n";
if ($script) echo "{$script}\n";
echo "\n";
}
}
/**
* Prints the page footer
* @param $doBody True to output body tag, false otherwise
*/
function printFooter($doBody = true) {
global $_reload_browser, $_reload_drop_database;
if ($doBody) {
if (isset($_reload_browser)) $this->printReload(false);
elseif (isset($_reload_drop_database)) $this->printReload(true);
echo "\n";
}
echo "\n";
}
/**
* Prints the page body.
* @param $doBody True to output body tag, false otherwise
* @param $bodyClass - name of body class
*/
function printBody($bodyClass = '', $doBody = true ) {
global $_no_output;
if (!isset($_no_output)) {
if ($doBody) {
$bodyClass = htmlspecialchars($bodyClass);
echo "\n";
}
}
}
/**
* Outputs JavaScript code that will reload the browser
* @param $database True if dropping a database, false otherwise
*/
function printReload($database) {
echo "\n";
}
/**
* Display navigation tabs
* @param $tabs An associative array of tabs definitions, see printNav() for an example.
* @param $activetab The name of the tab to be highlighted.
*/
function printTabs($tabs, $activetab) {
global $misc, $conf, $data, $lang;
if (is_string($tabs)) {
switch ($tabs) {
case 'database':
case 'schema':
if ($data->hasSchemas() === false) {
$this->printTabs($this->getNavTabs('database'),$activetab);
$this->printTabs($this->getNavTabs('schema'),$activetab);
$_SESSION['webdbLastTab']['database'] = $activetab;
return;
}
default:
$_SESSION['webdbLastTab'][$tabs] = $activetab;
$tabs = $this->getNavTabs($tabs);
}
}
echo "
\n";
}
}
/**
* Displays link to the context help.
* @param $str - the string that the context help is related to (already escaped)
* @param $help - help section identifier
*/
function printHelp($str, $help) {
global $lang, $data;
echo $str;
if ($help) {
echo "{$lang['strhelpicon']}";
}
}
/**
* Outputs JavaScript to set default focus
* @param $object eg. forms[0].username
*/
function setFocus($object) {
echo "\n";
}
/**
* Outputs JavaScript to set the name of the browser window.
* @param $name the window name
* @param $addServer if true (default) then the server id is
* attached to the name.
*/
function setWindowName($name, $addServer = true) {
echo "\n";
}
/**
* Converts a PHP.INI size variable to bytes. Taken from publically available
* function by Chris DeRose, here: http://www.php.net/manual/en/configuration.directives.php#ini.file-uploads
* @param $strIniSize The PHP.INI variable
* @return size in bytes, false on failure
*/
function inisizeToBytes($strIniSize) {
// This function will take the string value of an ini 'size' parameter,
// and return a double (64-bit float) representing the number of bytes
// that the parameter represents. Or false if $strIniSize is unparseable.
$a_IniParts = array();
if (!is_string($strIniSize))
return false;
if (!preg_match ('/^(\d+)([bkm]*)$/i', $strIniSize,$a_IniParts))
return false;
$nSize = (double) $a_IniParts[1];
$strUnit = strtolower($a_IniParts[2]);
switch($strUnit) {
case 'm':
return ($nSize * (double) 1048576);
case 'k':
return ($nSize * (double) 1024);
case 'b':
default:
return $nSize;
}
}
/**
* Display a URL given an action associative array.
* @param $action An associative array of the follow properties:
* 'url' => The first part of the URL (before the ?)
* 'urlvars' => Associative array of (URL variable => field name)
* these are appended to the URL
* 'urlfn' => Function to apply to URL before display
* @param $fields Field data from which 'urlfield' and 'vars' are obtained.
* @param $attr If supplied then the URL will be quoted and prefixed with
* '$attr='.
*/
function printActionUrl(&$action, &$fields, $attr = null) {
$url = value($action['url'], $fields);
if ($url === false) return '';
if (!empty($action['urlvars'])) {
$urlvars = value($action['urlvars'], $fields);
} else {
$urlvars = array();
}
if (isset($urlvars['subject'])) {
$subject = value($urlvars['subject'], $fields);
if (isset($_REQUEST['server']) && $subject != 'root') {
$urlvars['server'] = $_REQUEST['server'];
if (isset($_REQUEST['database']) && $subject != 'server') {
$urlvars['database'] = $_REQUEST['database'];
if (isset($_REQUEST['schema']) && $subject != 'database') {
$urlvars['schema'] = $_REQUEST['schema'];
}
}
}
}
$sep = '?';
foreach ($urlvars as $var => $varfield) {
$url .= $sep . value_url($var, $fields) . '=' . value_url($varfield, $fields);
$sep = '&';
}
$url = htmlentities($url);
if ($attr !== null && $url != '')
return ' '.$attr.'="'.$url.'"';
else
return $url;
}
function getRequestVars($subject = '') {
$v = array();
if (!empty($subject))
$v['subject'] = $subject;
if (isset($_REQUEST['server']) && $subject != 'root') {
$v['server'] = $_REQUEST['server'];
if (isset($_REQUEST['database']) && $subject != 'server') {
$v['database'] = $_REQUEST['database'];
if (isset($_REQUEST['schema']) && $subject != 'database') {
$v['schema'] = $_REQUEST['schema'];
}
}
}
return $v;
}
function printUrlVars(&$vars, &$fields) {
foreach ($vars as $var => $varfield) {
echo "{$var}=", urlencode($fields[$varfield]), "&";
}
}
/**
* Display a table of data.
* @param $tabledata A set of data to be formatted, as returned by $data->getDatabases() etc.
* @param $columns An associative array of columns to be displayed:
* $columns = array(
* column_id => array(
* 'title' => Column heading,
* 'field' => Field name for $tabledata->f[...],
* 'help' => Help page for this column,
* ), ...
* );
* @param $actions Actions that can be performed on each object:
* $actions = array(
* action_id => array(
* 'title' => Action heading,
* 'url' => Static part of URL,
* 'vars' => Associative array of (URL variable => field name),
* ), ...
* );
* @param $nodata (optional) Message to display if data set is empty.
* @param $pre_fn (optional) Name of a function to call for each row,
* it will be passed two params: $rowdata and $actions,
* it may be used to derive new fields or modify actions.
* It can return an array of actions specific to the row,
* or if nothing is returned then the standard actions are used.
* (see functions.php and constraints.php for examples)
*/
function printTable(&$tabledata, &$columns, &$actions, $nodata = null, $pre_fn = null) {
global $data, $conf, $misc;
global $PHP_SELF;
if ($tabledata->recordCount() > 0) {
// Remove the 'comment' column if they have been disabled
if (!$conf['show_comments']) {
unset($columns['comment']);
}
// Apply the 'properties' action to the first column
// and remove it from the action list.
// (Remove this section to keep the 'Properties' button instead of links)
if (isset($actions['properties'])) {
reset($columns);
$first_column = key($columns);
$columns[$first_column]['url'] = $actions['properties']['url'];
$columns[$first_column]['vars'] = $actions['properties']['vars'];
unset($actions['properties']);
}
if (isset($columns['comment'])) {
// Uncomment this for clipped comments.
// TODO: This should be a user option.
//$columns['comment']['params']['clip'] = true;
}
echo "
\n";
echo "
\n";
// Display column headings
foreach ($columns as $column_id => $column) {
switch ($column_id) {
case 'actions':
echo "
{$column['title']}
\n";
break;
default:
echo "
";
if (isset($column['help']))
$this->printHelp($column['title'], $column['help']);
else
echo $column['title'];
echo "
\n";
}
return false;
}
}
/** Produce XML data for the browser tree
* @param $treedata A set of records to populate the tree.
* @param $attrs Attributes for tree items
* 'text' - the text for the tree node
* 'icon' - an icon for node
* 'openIcon' - an alternative icon when the node is expanded
* 'toolTip' - tool tip text for the node
* 'action' - URL to visit when single clicking the node
* 'branch' - URL for child nodes (tree XML)
* 'expand' - the action to return XML for the subtree
* 'nodata' - message to display when node has no children
* 'nohead' - suppress headers and opening tag
* 'nofoot' - suppress closing tag
*/
function printTreeXML(&$treedata, &$attrs) {
global $conf, $lang;
if (!isset($attrs['nohead']) || $attrs['nohead'] === false) {
header("Content-Type: text/xml");
header("Cache-Control: no-cache");
echo "\n";
echo "\n";
}
if ($treedata->recordCount() > 0) {
while (!$treedata->EOF) {
$rec =& $treedata->f;
echo "icon(value($attrs['icon'], $rec));
echo value_xml_attr('icon', $icon, $rec);
if (!empty($attrs['openIcon'])) {
$icon = $this->icon(value($attrs['openIcon'], $rec));
}
echo value_xml_attr('openIcon', $icon, $rec);
echo value_xml_attr('toolTip', $attrs['toolTip'], $rec);
echo "/>\n";
$treedata->moveNext();
}
} else {
$msg = isset($attrs['nodata']) ? $attrs['nodata'] : $lang['strnoobjects'];
echo "icon('error'), "\"/>\n";
}
if (!isset($attrs['nofoot']) || $attrs['nofoot'] === false) {
echo "\n";
}
}
function &adjustTabsForTree(&$tabs) {
include_once('classes/ArrayRecordSet.php');
foreach ($tabs as $i => $tab) {
if ((isset($tab['hide']) && $tab['hide'] === true) || (isset($tab['tree']) && $tab['tree'] === false)) {
unset($tabs[$i]);
}
}
return new ArrayRecordSet($tabs);
}
function icon($icon) {
global $conf;
$path = "images/themes/{$conf['theme']}/{$icon}";
if (file_exists($path.'.png')) return $path.'.png';
if (file_exists($path.'.gif')) return $path.'.gif';
$path = "images/themes/default/{$icon}";
if (file_exists($path.'.png')) return $path.'.png';
if (file_exists($path.'.gif')) return $path.'.gif';
return '';
}
/**
* Function to escape command line parameters
* @param $str The string to escape
* @return The escaped string
*/
function escapeShellArg($str) {
global $data, $lang;
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
// Due to annoying PHP bugs, shell arguments cannot be escaped
// (command simply fails), so we cannot allow complex objects
// to be dumped.
if (ereg('^[_.[:alnum:]]+$', $str))
return $str;
else {
echo $lang['strcannotdumponwindows'];
exit;
}
}
else
return escapeshellarg($str);
}
/**
* Function to escape command line programs
* @param $str The string to escape
* @return The escaped string
*/
function escapeShellCmd($str) {
global $data;
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
$data->fieldClean($str);
return '"' . $str . '"';
}
else
return escapeshellcmd($str);
}
/**
* Get list of servers
* @param $recordset return as RecordSet suitable for printTable if true,
* otherwise just return an array.
*/
function &getServers($recordset = false) {
global $conf;
$srvs = isset($_SESSION['webdbLogin']) && is_array($_SESSION['webdbLogin']) ? $_SESSION['webdbLogin'] : array();
foreach($conf['servers'] as $idx => $info) {
$server_id = $info['host'].':'.$info['port'];
if (!isset($srvs[$server_id])) {
$srvs[$server_id] = $info;
}
$srvs[$server_id]['id'] = $server_id;
}
function _cmp_desc($a, $b) {
return strcmp($a['desc'], $b['desc']);
}
uasort($srvs, '_cmp_desc');
if ($recordset) {
include_once('classes/ArrayRecordSet.php');
return new ArrayRecordSet($srvs);
}
return $srvs;
}
/**
* Get information on a server.
* If the parameter isn't supplied then the currently
* connected server is returned.
* @param $server_id A server identifier (host:port)
* @return An associative array of server properties
*/
function getServerInfo($server_id = null) {
global $conf;
if ($server_id === null && isset($_REQUEST['server']))
$server_id = $_REQUEST['server'];
// Check for the server in the logged-in list
if (isset($_SESSION['webdbLogin'][$server_id]))
return $_SESSION['webdbLogin'][$server_id];
// Otherwise, look for it in the conf file
foreach($conf['servers'] as $idx => $info) {
if ($server_id == $info['host'].':'.$info['port'])
return $info;
}
return null;
}
/**
* Set server information.
* @param $key parameter name to set, or null to replace all
* params with the assoc-array in $value.
* @param $value the new value, or null to unset the parameter
* @param $server_id the server identifier, or null for current
* server.
*/
function setServerInfo($key, $value, $server_id = null)
{
if ($server_id === null && isset($_REQUEST['server']))
$server_id = $_REQUEST['server'];
if ($key === null) {
if ($value === null)
unset($_SESSION['webdbLogin'][$server_id]);
else
$_SESSION['webdbLogin'][$server_id] = $value;
} else {
if ($value === null)
unset($_SESSION['webdbLogin'][$server_id][$key]);
else
$_SESSION['webdbLogin'][$server_id][$key] = $value;
}
}
}
?>