common-db.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2011-2012 Hewlett-Packard Development Company, L.P.
 SPDX-FileCopyrightText: © 2017 Siemens AG
 
 SPDX-License-Identifier: LGPL-2.1-only
*/
 
function DBconnect($sysconfdir, $options="", $exitOnFail=true)
{
  global $PG_CONN;
 
  if (! empty($PG_CONN)) {
    return $PG_CONN;
  }
 
  $path="$sysconfdir/Db.conf";
  if (empty($options)) {
    $dbConf = file_get_contents($path);
    if ($exitOnFail && (false === $dbConf)) {
      $text = _("Could not connect to FOSSology database.");
      echo "<h2>$text</h2>";
      echo _('permission denied for configuration file');
      exit();
    }
    if (false === $dbConf) {
      $PG_CONN = false;
      return;
    }
    $options = $dbConf;
  }
  if (! empty($options)) {
    $PG_CONN = pg_connect(str_replace(";", " ", $options));
  }
 
  if (! empty($PG_CONN)) {
    /* success */
    return $PG_CONN;
  }
 
  if ($exitOnFail) {
    $text = _("Could not connect to FOSSology database.");
    echo "<h2>$text</h2>";
    exit();
  }
  $PG_CONN = false;
}
 
 
function GetSingleRec($Table, $Where="")
{
  global $PG_CONN;
 
  $sql = "SELECT * from $Table $Where limit 1";
  $result = pg_query($PG_CONN, $sql);
  DBCheckResult($result, $sql, __FILE__, __LINE__);
 
  $row = pg_fetch_assoc($result);
  pg_free_result($result);
  return $row;
}
 
 
function DB2KeyValArray($Table, $KeyCol, $ValCol, $Where="")
{
  global $PG_CONN;
 
  $ResArray = array();
 
  $sql = "SELECT $KeyCol, $ValCol from $Table $Where";
  $result = pg_query($PG_CONN, $sql);
  DBCheckResult($result, $sql, __FILE__, __LINE__);
 
  while ($row = pg_fetch_assoc($result)) {
    $ResArray[$row[$KeyCol]] = $row[$ValCol];
  }
  pg_free_result($result);
  return $ResArray;
}
 
function DB2ValArray($Table, $ValCol, $Uniq=false, $Where="")
{
  global $PG_CONN;
 
  $ResArray = array();
 
  if ($Uniq) {
    $sql = "SELECT DISTINCT $ValCol from $Table $Where";
  } else {
    $sql = "SELECT $ValCol from $Table $Where";
  }
  $result = pg_query($PG_CONN, $sql);
  DBCheckResult($result, $sql, __FILE__, __LINE__);
 
  $i = 0;
  while ($row = pg_fetch_assoc($result)) {
    $ResArray[$i] = $row[$ValCol];
    ++ $i;
  }
  pg_free_result($result);
  return $ResArray;
}
 
 
function DBCheckResult($result, $sql, $filenm, $lineno)
{
  global $PG_CONN;
 
  if (! $result) {
    echo "<hr>File: $filenm, Line number: $lineno<br>";
    if (pg_connection_status($PG_CONN) === PGSQL_CONNECTION_OK) {
      echo pg_last_error($PG_CONN);
    } else {
      echo "FATAL: DB connection lost.";
    }
    echo "<br> ".htmlspecialchars($sql);
    debugbacktrace();
    echo "<hr>";
    exit(1);
  }
}
 
 
function DB_TableExists($tableName)
{
  global $PG_CONN;
  global $SysConf;
 
  $sql = "select count(*) as count from information_schema.tables where "
       . "table_catalog='{$SysConf['DBCONF']['dbname']}' and table_name='$tableName'";
  $result = pg_query($PG_CONN, $sql);
  DBCheckResult($result, $sql, __FILE__, __LINE__);
  $row = pg_fetch_assoc($result);
  $count = $row['count'];
  pg_free_result($result);
  return($count);
} /* DB_TableExists()  */
 
 
function DB_ColExists($tableName, $colName, $DBName='fossology')
{
  global $PG_CONN;
 
  $sql = "select count(*) as count from information_schema.columns where "
       . "table_catalog='$DBName' and table_name='$tableName' and column_name='$colName'";
  $result = pg_query($PG_CONN, $sql);
  DBCheckResult($result, $sql, __FILE__, __LINE__);
  $row = pg_fetch_assoc($result);
  $count = $row['count'];
  pg_free_result($result);
  return($count);
} /* DB_ColExists()  */
 
 
function DB_ConstraintExists($ConstraintName, $DBName='fossology')
{
  global $PG_CONN;
 
  $sql = "select count(*) as count from information_schema.table_constraints "
       . "where table_catalog='$DBName' and constraint_name='$ConstraintName' limit 1";
  $result = pg_query($PG_CONN, $sql);
  DBCheckResult($result, $sql, __FILE__, __LINE__);
  $row = pg_fetch_assoc($result);
  $count = $row['count'];
  pg_free_result($result);
  if ($count == 1) {
    return true;
  }
  return False;
} /* DB_ColExists()  */
 
 
function GetLastSeq($seqname, $tablename)
{
  global $PG_CONN;
 
  $sql = "SELECT currval('$seqname') as mykey FROM $tablename";
  $result = pg_query($PG_CONN, $sql);
  DBCheckResult($result, $sql, __FILE__, __LINE__);
  $row = pg_fetch_assoc($result);
  $mykey = $row["mykey"];
  pg_free_result($result);
  return($mykey);
}