common-sysconfig.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2011-2015 Hewlett-Packard Development Company, L.P.
 SPDX-FileCopyrightText: © 2021 Siemens AG
 
 SPDX-License-Identifier: LGPL-2.1-only
*/
 
use Fossology\Lib\Auth\Auth;
 
define("CONFIG_TYPE_INT", 1);
define("CONFIG_TYPE_TEXT", 2);
define("CONFIG_TYPE_TEXTAREA", 3);
define("CONFIG_TYPE_PASSWORD", 4);
define("CONFIG_TYPE_DROP", 5);
define("CONFIG_TYPE_BOOL", 6);
 
 
if (!function_exists('resolve_sysconfig_value')) {
  function resolve_sysconfig_value($value, array $scope)
  {
    return preg_replace_callback('/\$(?:([A-Za-z_][A-Za-z0-9_]*)|\{([A-Za-z_][A-Za-z0-9_]*)\})/', static function ($matches) use ($scope) {
      $name = !empty($matches[1]) ? $matches[1] : $matches[2];
      return array_key_exists($name, $scope) ? $scope[$name] : $matches[0];
    }, $value);
  }
}
 
 
function ConfigInit($sysconfdir, &$SysConf, $exitOnDbFail=true)
{
  global $PG_CONN;
 
  $PG_CONN = get_pg_conn($sysconfdir, $SysConf, $exitOnDbFail);
 
  populate_from_sysconfig($PG_CONN, $SysConf);
  return $PG_CONN;
} // ConfigInit()
 
function get_pg_conn($sysconfdir, &$SysConf, $exitOnDbFail=true)
{
  /*************  Parse VERSION *******************/
  $versionFile = "{$sysconfdir}/VERSION";
  $versionConf = parse_ini_file($versionFile, true);
  $resolvedValues = array();
 
  /* Add this file contents to $SysConf, then destroy $VersionConf.
   * This file can define its own groups and uses simple placeholder expansion.
   */
  foreach ($versionConf as $groupName => $groupArray) {
    foreach ($groupArray as $var => $assign) {
      $resolvedValue = resolve_sysconfig_value($assign, $resolvedValues);
      $resolvedValues[$var] = $resolvedValue;
      $SysConf[$groupName][$var] = $resolvedValue;
      ${$var} = $resolvedValue;
      $GLOBALS[$var] = $resolvedValue;
    }
  }
  unset($versionConf);
 
  /*************  Parse Db.conf *******************/
  $dbPath = "{$sysconfdir}/Db.conf";
  $dbConf = parse_ini_file($dbPath, true);
 
  /* Add this file contents to $SysConf, then destroy $dbConf
   * This file can define its own groups and is eval'd.
   */
  foreach ($dbConf as $var => $val) {
    $SysConf['DBCONF'][$var] = $val;
  }
  unset($dbConf);
 
  /*
   * Connect to the database.  If the connection fails,
   * DBconnect() will print a failure message and exit.
   */
  $pg_conn = DBconnect($sysconfdir, "", $exitOnDbFail);
 
  if (! $exitOnDbFail && ($pg_conn === null || $pg_conn === false)) {
    return -1;
  }
 
  global $container;
  $postgresDriver = new \Fossology\Lib\Db\Driver\Postgres($pg_conn);
  $container->get('db.manager')->setDriver($postgresDriver);
 
  return $pg_conn;
}
 
function populate_from_sysconfig($conn, &$SysConf)
{
  /* populate the global $SysConf array with variable/value pairs */
  $sql = "SELECT variablename, conf_value FROM sysconfig;";
  $result = pg_query($conn, $sql);
  DBCheckResult($result, $sql, __FILE__, __LINE__);
 
  while ($row = pg_fetch_assoc($result)) {
    $SysConf['SYSCONFIG'][$row['variablename']] = $row['conf_value'];
  }
  pg_free_result($result);
}
 
function Populate_sysconfig()
{
  global $PG_CONN;
 
  $columns = array("variablename", "conf_value", "ui_label", "vartype", "group_name",
    "group_order", "description", "validation_function", "option_value");
  $valueArray = array();
 
  /*  CorsOrigin */
  $variable = "CorsOrigins";
  $prompt = _('Allowed origins for REST API');
  $desc = _('[scheme]://[hostname]:[port], "*" for anywhere');
  $valueArray[$variable] = array("'$variable'", "'*'", "'$prompt'",
    strval(CONFIG_TYPE_TEXT), "'PAT'", "3", "'$desc'", "null", "null");
 
  /*  Email */
  $variable = "SupportEmailLabel";
  $supportEmailLabelPrompt = _('Support Email Label');
  $supportEmailLabelDesc = _('e.g. "Support"<br>Text that the user clicks on to create a new support email. This new email will be preaddressed to this support email address and subject.  HTML is ok.');
  $valueArray[$variable] = array("'$variable'", "'Support'", "'$supportEmailLabelPrompt'",
    strval(CONFIG_TYPE_TEXT), "'Support'", "1", "'$supportEmailLabelDesc'", "null", "null");
 
  $variable = "SupportEmailAddr";
  $supportEmailAddrPrompt = _('Support Email Address');
  $supportEmailAddrValid = "check_email_address";
  $supportEmailAddrDesc = _('e.g. "support@mycompany.com"<br>Individual or group email address to those providing FOSSology support.');
  $valueArray[$variable] = array("'$variable'", "null", "'$supportEmailAddrPrompt'",
    strval(CONFIG_TYPE_TEXT), "'Support'", "2", "'$supportEmailAddrDesc'", "'$supportEmailAddrValid'", "null");
 
  $variable = "SupportEmailSubject";
  $supportEmailSubjectPrompt = _('Support Email Subject line');
  $supportEmailSubjectDesc = _('e.g. "fossology support"<br>Subject line to use on support email.');
  $valueArray[$variable] = array("'$variable'", "'FOSSology Support'", "'$supportEmailSubjectPrompt'",
    strval(CONFIG_TYPE_TEXT), "'Support'", "3", "'$supportEmailSubjectDesc'", "null", "null");
 
  /* oAuth2 Service */
  $variable = "OidcAppName";
  $oidcPrompt = _('OIDC App Name');
  $oidcDesc = _('e.g. "my oAuth"<br>App name to display on login page.');
  $valueArray[$variable] = array("'$variable'", "null", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "1", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcClientIdClaim";
  $oidcPrompt = _('OIDC Client Id Claim');
  $oidcDesc = _('e.g. "azp"<br>Client ID claim in the decoded payload.');
  $valueArray[$variable] = array("'$variable'", "'client-id'", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "2", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcResourceOwnerId";
  $oidcPrompt = _('Resource owner id field');
  $oidcDesc = _('e.g. "email", "upn"<br>Field in token which provides user id. The field <b>should not be empty</b>.');
  $valueArray[$variable] = array("'$variable'", "'email'", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "3", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcTokenType";
  $oidcPrompt = _('Token to use from provider');
  $oidcDesc = _('OpenID Connect providers 2 types of tokens, access and id. Which to use for authentication?<br>AzureAD prefers ID token.');
  $valueArray[$variable] = array("'$variable'", "'A'", "'$oidcPrompt'",
    strval(CONFIG_TYPE_DROP), "'OauthSupport'", "4", "'$oidcDesc'", "null", "'Access Token{A}|ID Token{I}'");
 
  $variable = "OidcAppId";
  $oidcPrompt = _('OIDC Client Id');
  $oidcDesc = _('e.g. "e0ec21b9f4b21adc76f185962b52bdfc13af134a"<br>Client ID generated while registering your application.');
  $valueArray[$variable] = array("'$variable'", "null", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "5", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcSecret";
  $oidcPrompt = _('OIDC Secret');
  $oidcDesc = _('e.g. "cf13476f185b9f4b2e0ec962b52211adbdfc13aa"<br>Secret generated while registering your application.');
  $valueArray[$variable] = array("'$variable'", "null", "'$oidcPrompt'",
    strval(CONFIG_TYPE_PASSWORD), "'OauthSupport'", "6", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcRedirectURL";
  $oidcPrompt = _('Redirect URL');
  $oidcDesc = _('e.g. "http://fossology.application.url.com/repo"<br>URL of your fossology application.');
  $valueArray[$variable] = array("'$variable'", "null", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "7", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcDiscoveryURL";
  $oidcPrompt = _('OIDC Discovery URL');
  $oidcDesc = _('e.g. "http://oauth.com/.well-known/openid-configuration"<br>URL for OIDC Discovery document JSON to fill following fields upon save.');
  $valueArray[$variable] = array("'$variable'", "null", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "8", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcIssuer";
  $oidcPrompt = _('OIDC Token Issuer');
  $oidcDesc = _('e.g. "http://oauth.com"<br>Issuer for OIDC tokens.');
  $valueArray[$variable] = array("'$variable'", "null", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "9", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcAuthorizeURL";
  $oidcPrompt = _('OIDC Authorize URL');
  $oidcDesc = _('e.g. "http://oauth.com/authorization.oauth2"<br>URL for OAuth2 authorization endpoint.');
  $valueArray[$variable] = array("'$variable'", "null", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "10", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcAccessTokenURL";
  $oidcPrompt = _('OIDC Access Token URL');
  $oidcDesc = _('e.g. "http://oauth.com/token.oauth2"<br>URL for OAuth2 access token endpoint.');
  $valueArray[$variable] = array("'$variable'", "null", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "11", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcResourceURL";
  $oidcPrompt = _('OIDC User Info URL');
  $oidcDesc = _('e.g. "http://oauth.com/userinfo.oauth2"<br>URL for OAuth2 user info endpoint.');
  $valueArray[$variable] = array("'$variable'", "null", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "12", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcJwksURL";
  $oidcPrompt = _('OIDC JWKS URL');
  $oidcDesc = _('e.g. "http://oauth.com/jwks.oauth2"<br>URL for OIDC JWKS keys.');
  $valueArray[$variable] = array("'$variable'", "null", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "13", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcJwkAlgInject";
  $oidcPrompt = _('OIDC JWKS Algorithm inject');
  $oidcDesc = _('Algorithm value to inject for JWKS. Leave empty to not modify.' .
    '<br><a href="https://datatracker.ietf.org/doc/html/rfc7517#section-4.4">Check info</a>.');
  $valueArray[$variable] = array("'$variable'", "null", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "14", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcLogoutURL";
  $oidcPrompt = _('Logout URL');
  $oidcDesc = _('e.g. "http://oauth.com/logout.oauth2"<br>URL to redirect user to for logout.');
  $valueArray[$variable] = array("'$variable'", "null", "'$oidcPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "15", "'$oidcDesc'", "null", "null");
 
  $variable = "OidcScope";
  $prompt = _('OIDC Scope');
  $desc = _('Scope of OIDC for client_credential grant. Used with LicenseDB.');
  $valueArray[$variable] = array("'$variable'", "''", "'$prompt'",
    strval(CONFIG_TYPE_TEXT), "'OauthSupport'", "16", "'$oidcDesc'", "null", "null");
 
  /*  Banner Message */
  $variable = "BannerMsg";
  $bannerMsgPrompt = _('Banner message');
  $bannerMsgDesc = _('This is message will be displayed on every page with a banner.  HTML is ok.');
  $valueArray[$variable] = array("'$variable'", "null", "'$bannerMsgPrompt'",
    strval(CONFIG_TYPE_TEXTAREA), "'Banner'", "1", "'$bannerMsgDesc'", "null", "null");
 
  /*  Logo  */
  $variable = "LogoImage";
  $logoImagePrompt = _('Logo Image URL');
  $logoImageValid = "check_logo_image_url";
  $logoImageDesc = _('e.g. "http://mycompany.com/images/companylogo.png" or "images/mylogo.png"<br>This image replaces the fossology project logo. Image is constrained to 150px wide.  80-100px high is a good target.  If you change this URL, you MUST also enter a logo URL.');
  $valueArray[$variable] = array("'$variable'", "null", "'$logoImagePrompt'",
    strval(CONFIG_TYPE_TEXT), "'Logo'", "1", "'$logoImageDesc'", "'$logoImageValid'", "null");
 
  $variable = "LogoLink";
  $logoLinkPrompt = _('Logo URL');
  $logoLinkDesc = _('e.g. "http://mycompany.com/fossology"<br>URL a person goes to when they click on the logo.  If you change the Logo URL, you MUST also enter a Logo Image.');
  $logoLinkValid = "check_logo_url";
  $valueArray[$variable] = array("'$variable'", "null", "'$logoLinkPrompt'",
    strval(CONFIG_TYPE_TEXT), "'Logo'", "2", "'$logoLinkDesc'", "'$logoLinkValid'", "null");
 
  $variable = "FOSSologyURL";
  $urlPrompt = _("FOSSology URL");
  $hostname = exec("hostname -f");
  if (empty($hostname)) {
    $hostname = "localhost";
  }
  $fossologyURL = $hostname."/repo/";
  $urlDesc = _("URL of this FOSSology server, e.g. $fossologyURL");
  $urlValid = "check_fossology_url";
  $valueArray[$variable] = array("'$variable'", "'$fossologyURL'", "'$urlPrompt'",
    strval(CONFIG_TYPE_TEXT), "'URL'", "1", "'$urlDesc'", "'$urlValid'", "null");
 
  $variable = "ClearlyDefinedURL";
  $urlPrompt = _("ClearlyDefined URL");
  $cdURL = "https://api.clearlydefined.io/";
  $urlDesc = _("URL of ClearlyDefined server, e.g. $cdURL");
  $urlValid = "check_url";
  $valueArray[$variable] = array("'$variable'", "'$cdURL'", "'$urlPrompt'",
    strval(CONFIG_TYPE_TEXT), "'URL'", "2", "'$urlDesc'", "'$urlValid'", "null");
 
  $variable = "NomostListNum";
  $nomosNumPrompt = _("Maximum licenses to List");
  $nomostListNum = "2200";
  $NomosNumDesc = _("For License List and License List Download, you can set the maximum number of lines to list/download. Default 2200.");
  $valueArray[$variable] = array("'$variable'", "'$nomostListNum'", "'$nomosNumPrompt'",
    strval(CONFIG_TYPE_TEXT), "'Number'", "1", "'$NomosNumDesc'", "null", "null");
 
  $variable = "BlockSizeHex";
  $hexPrompt = _("Chars per page in hex view");
  $hexDesc = _("Number of characters per page in hex view");
  $valueArray[$variable] = array("'$variable'", "'8192'", "'$hexPrompt'",
    strval(CONFIG_TYPE_TEXT), "'Number'", "2", "'$hexDesc'", "null", "null");
 
  $variable = "BlockSizeText";
  $textPrompt = _("Chars per page in text view");
  $textDesc = _("Number of characters per page in text view");
  $valueArray[$variable] = array("'$variable'", "'81920'", "'$textPrompt'",
    strval(CONFIG_TYPE_TEXT), "'Number'", "3", "'$textDesc'", "null", "null");
 
  $variable = "ShowJobsAutoRefresh";
  $contextNamePrompt = _("ShowJobs Auto Refresh Time");
  $contextValue = "10";
  $contextDesc = _("No of seconds to refresh ShowJobs");
  $valueArray[$variable] = array("'$variable'", "'$contextValue'", "'$contextNamePrompt'",
    strval(CONFIG_TYPE_TEXT), "'Number'", "4", "'$contextDesc'", "null", "null");
 
  /* Report Header Text */
  $variable = "ReportHeaderText";
  $contextNamePrompt = _("Report Header Text");
  $contextValue = "FOSSology";
  $contextDesc = _("Report Header Text at right side corner");
  $valueArray[$variable] = array("'$variable'", "'$contextValue'", "'$contextNamePrompt'",
    strval(CONFIG_TYPE_TEXT), "'ReportText'", "1", "'$contextDesc'", "null", "null");
 
  $variable = "CommonObligation";
  $contextNamePrompt = _("Common Obligation");
  $contextValue = "";
  $commonExObligations = _('you can add HTML line break, Also use json format for table rows');
  $contextDesc = _("Common Obligation Text,". "$commonExObligations");
  $valueArray[$variable] = array("'$variable'", "'$contextValue'", "'$contextNamePrompt'",
    strval(CONFIG_TYPE_TEXTAREA), "'ReportText'", "2", "'$contextDesc'", "null", "null");
 
  $variable = "AdditionalObligation";
  $contextNamePrompt = _("Additional Obligation");
  $contextValue = "";
  $contextDesc = _("Additional Obligation Text,". "$commonExObligations");
  $valueArray[$variable] = array("'$variable'", "'$contextValue'", "'$contextNamePrompt'",
    strval(CONFIG_TYPE_TEXTAREA), "'ReportText'", "3", "'$contextDesc'", "null", "null");
 
  $variable = "ObligationAndRisk";
  $contextNamePrompt = _("Obligation And Risk Assessment");
  $contextValue = "";
  $contextDesc = _("Obligations and risk assessment,". "$commonExObligations");
  $valueArray[$variable] = array("'$variable'", "'$contextValue'", "'$contextNamePrompt'",
    strval(CONFIG_TYPE_TEXTAREA), "'ReportText'", "4", "'$contextDesc'", "null", "null");
 
  $variable         = "EnableOsselotReuse";
  $prompt           = ("Enable OSSelot Reuse");
  $desc             = ("When enabled, shows the OSSelot-based reuse option in the Reuser plugin");
  $valueArray[$variable] = array("'$variable'","true","'$prompt'",
      strval(CONFIG_TYPE_BOOL),"'ReportText'","5","'$desc'","'check_boolean'","null");
 
  $variable = "OsselotCuratedUrl";
  $osselotCuratedPrompt = _('OSSelot Curated API URL');
  $osselotCuratedValid = "check_url";
  $osselotCuratedDesc = _('URL for OSSelot curated package information API.');
  $valueArray[$variable] = array("'$variable'", "'https://www.osselot.org/curated.php'", "'$osselotCuratedPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OSSelot'", "1", "'$osselotCuratedDesc'", "'$osselotCuratedValid'", "null");
 
  $variable = "OsselotPackageAnalysisUrl";
  $osselotPackagePrompt = _('OSSelot Package Analysis Base URL');
  $osselotPackageValid = "check_url";
  $osselotPackageDesc = _('Base URL for OSSelot package analysis repository.');
  $valueArray[$variable] = array("'$variable'", "'https://raw.githubusercontent.com/Open-Source-Compliance/package-analysis/main/analysed-packages'", "'$osselotPackagePrompt'",
    strval(CONFIG_TYPE_TEXT), "'OSSelot'", "2", "'$osselotPackageDesc'", "'$osselotPackageValid'", "null");
 
  $variable = "OsselotPrimaryDomain";
  $osselotPrimaryPrompt = _('OSSelot Primary Domain');
  $osselotPrimaryValid = "check_domain";
  $osselotPrimaryDesc = _('Primary domain used in OSSelot package analysis URLs (e.g., raw.githubusercontent.com).');
  $valueArray[$variable] = array("'$variable'", "'raw.githubusercontent.com'", "'$osselotPrimaryPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OSSelot'", "3", "'$osselotPrimaryDesc'", "'$osselotPrimaryValid'", "null");
 
  $variable = "OsselotFallbackDomain";
  $osselotFallbackPrompt = _('OSSelot Fallback Domain');
  $osselotFallbackValid = "check_domain";
  $osselotFallbackDesc = _('Fallback domain used when primary domain fails (e.g., osselot.org).');
  $valueArray[$variable] = array("'$variable'", "'osselot.org'", "'$osselotFallbackPrompt'",
    strval(CONFIG_TYPE_TEXT), "'OSSelot'", "4", "'$osselotFallbackDesc'", "'$osselotFallbackValid'", "null");
 
  /*  "Upload from server"-configuration  */
  $variable = "UploadFromServerWhitelist";
  $contextNamePrompt = _("Whitelist for serverupload");
  $contextValue = "/tmp";
  $contextDesc = _("List of allowed prefixes for upload, separated by \":\" (colon)");
  $valueArray[$variable] = array("'$variable'", "'$contextValue'", "'$contextNamePrompt'",
    strval(CONFIG_TYPE_TEXT), "'UploadFromServer'", "1", "'$contextDesc'", "null", "null");
 
  $variable = "UploadFromServerAllowedHosts";
  $contextNamePrompt = _("List of allowed hosts for serverupload");
  $contextValue = "localhost";
  $contextDesc = _("List of allowed hosts for upload, separated by \":\" (colon)");
  $valueArray[$variable] = array("'$variable'", "'$contextValue'", "'$contextNamePrompt'",
    strval(CONFIG_TYPE_TEXT), "'UploadFromServer'", "2", "'$contextDesc'", "null", "null");
 
  /*  SMTP config */
  $variable = "SMTPHostName";
  $smtpHostPrompt = _('SMTP Host Name');
  $smtpHostDesc = _('e.g.: "smtp.domain.com"<br>The domain to be used to send emails.');
  $valueArray[$variable] = array("'$variable'", "null", "'$smtpHostPrompt'",
    strval(CONFIG_TYPE_TEXT), "'SMTP'", "1", "'$smtpHostDesc'", "null", "null");
 
  $variable = "SMTPPort";
  $smtpPortPrompt = _('SMTP Port');
  $smtpPortDesc = _('e.g.: "25"<br>SMTP port to be used.');
  $valueArray[$variable] = array("'$variable'", "25", "'$smtpPortPrompt'",
    strval(CONFIG_TYPE_INT), "'SMTP'", "2", "'$smtpPortDesc'", "null", "null");
 
  $variable = "SMTPAuth";
  $smtpAuthPrompt = _('SMTP Auth Type');
  $smtpAuthDesc = _('Algorithm to use for login.<br>Login => Encrypted<br>None => No authentication<br>Plain => Send as plain text');
  $valueArray[$variable] = array("'$variable'", "'L'", "'$smtpAuthPrompt'",
    strval(CONFIG_TYPE_DROP), "'SMTP'", "3", "'$smtpAuthDesc'", "null", "'Login{L}|None{N}|Plain{P}'");
 
  $variable = "SMTPFrom";
  $smtpFrom = _('SMTP Email');
  $smtpFromDesc = _('e.g.: "user@domain.com"<br>Sender email.');
  $valueArray[$variable] = array("'$variable'", "null", "'$smtpFrom'",
    strval(CONFIG_TYPE_TEXT), "'SMTP'", "4", "'$smtpFromDesc'", "'check_email_address'", "null");
 
  $variable = "SMTPAuthUser";
  $smtpAuthUserPrompt = _('SMTP User');
  $smtpAuthUserDesc = _('e.g.: "user"<br>Login to be used for login on SMTP Server.');
  $valueArray[$variable] = array("'$variable'", "null", "'$smtpAuthUserPrompt'",
    strval(CONFIG_TYPE_TEXT), "'SMTP'", "5", "'$smtpAuthUserDesc'", "null", "null");
 
  $variable = "SMTPAuthPasswd";
  $smtpAuthPasswdPrompt = _('SMTP Login Password');
  $smtpAuthPasswdDesc = _('Password used for SMTP login.');
  $valueArray[$variable] = array("'$variable'", "null", "'$smtpAuthPasswdPrompt'",
    strval(CONFIG_TYPE_PASSWORD), "'SMTP'", "6", "'$smtpAuthPasswdDesc'", "null", "null");
 
  $variable = "SMTPSslVerify";
  $smtpSslPrompt = _('SMTP SSL Verify');
  $smtpSslDesc = _('The SSL verification for connection is required?');
  $valueArray[$variable] = array("'$variable'", "'S'", "'$smtpSslPrompt'",
    strval(CONFIG_TYPE_DROP), "'SMTP'", "7", "'$smtpSslDesc'", "null", "'Ignore{I}|Strict{S}|Warn{W}'");
 
  $variable = "SMTPStartTls";
  $smtpTlsPrompt = _('Start TLS');
  $smtpTlsDesc = _('Use TLS connection for SMTP?');
  $valueArray[$variable] = array("'$variable'", "'1'", "'$smtpTlsPrompt'",
    strval(CONFIG_TYPE_DROP), "'SMTP'", "8", "'$smtpTlsDesc'", "null", "'Yes{1}|No{2}'");
 
  $variable = "UploadVisibility";
  $prompt = _('Default Upload Visibility');
  $desc = _('Default Visibility for uploads by the user');
  $valueArray[$variable] = array("'$variable'", "'protected'", "'$prompt'",
    strval(CONFIG_TYPE_DROP), "'UploadFlag'", "1", "'$desc'", "null", "'Visible only for active group{private}|Visible for all groups{protected}|Make Public{public}'");
 
  /* Password policy config */
  $variable = "PasswdPolicy";
  $prompt = _('Enable password policy');
  $desc = _('Enable password policy check');
  $valueArray[$variable] = array("'$variable'", "false", "'$prompt'",
    strval(CONFIG_TYPE_BOOL), "'PASSWD'", "1", "'$desc'",
    "'check_boolean'", "null");
 
  $variable = "PasswdPolicyMinChar";
  $prompt = _('Minimum characters');
  $desc = _('Blank for no limit');
  $valueArray[$variable] = array("'$variable'", "8", "'$prompt'",
    strval(CONFIG_TYPE_INT), "'PASSWD'", "2", "'$desc'", "null", "null");
 
  $variable = "PasswdPolicyMaxChar";
  $prompt = _('Maximum characters');
  $desc = _('Blank for no limit');
  $valueArray[$variable] = array("'$variable'", "16", "'$prompt'",
    strval(CONFIG_TYPE_INT), "'PASSWD'", "3", "'$desc'", "null", "null");
 
  $variable = "PasswdPolicyLower";
  $prompt = _('Lowercase');
  $desc = _('Minimum one lowercase character.');
  $valueArray[$variable] = array("'$variable'", "true", "'$prompt'",
    strval(CONFIG_TYPE_BOOL), "'PASSWD'", "4", "'$desc'",
    "'check_boolean'", "null");
 
  $variable = "PasswdPolicyUpper";
  $prompt = _('Uppercase');
  $desc = _('Minimum one uppercase character.');
  $valueArray[$variable] = array("'$variable'", "true", "'$prompt'",
    strval(CONFIG_TYPE_BOOL), "'PASSWD'", "5", "'$desc'",
    "'check_boolean'", "null");
 
  $variable = "PasswdPolicyDigit";
  $prompt = _('Digit');
  $desc = _('Minimum one digit.');
  $valueArray[$variable] = array("'$variable'", "true", "'$prompt'",
    strval(CONFIG_TYPE_BOOL), "'PASSWD'", "6", "'$desc'",
    "'check_boolean'", "null");
 
  $variable = "PasswdPolicySpecial";
  $prompt = _('Allowed special characters');
  $desc = _('Empty for do not care');
  $valueArray[$variable] = array("'$variable'", "'@$!%*?&'", "'$prompt'",
    strval(CONFIG_TYPE_TEXT), "'PASSWD'", "7", "'$desc'", "null", "null");
 
  $variable = "PATMaxExipre";
  $patTokenValidityPrompt = _('Max token validity');
  $patTokenValidityDesc = _('Maximum validity of tokens (in days)');
  $valueArray[$variable] = array("'$variable'", "30", "'$patTokenValidityPrompt'",
    strval(CONFIG_TYPE_INT), "'PAT'", "1", "'$patTokenValidityDesc'", "null", "null");
 
  $variable = "PATMaxPostExpiryRetention";
  $patTokenRetentionPrompt = _('Max expired token retention period');
  $patTokenRetentionDesc = _('Maximum retention period of expired tokens (in days) for Maintagent');
  $valueArray[$variable] = array("'$variable'", "30", "'$patTokenRetentionPrompt'",
    strval(CONFIG_TYPE_INT), "'PAT'", "2", "'$patTokenRetentionDesc'", "null", "null");
 
  $variable = "SkipFiles";
  $mimeTypeToSkip = _("Skip MimeTypes from scanning");
  $mimeTypeDesc = _("add  comma (,) separated mimetype to exclude files from scanning");
  $valueArray[$variable] = array("'$variable'", "null", "'$mimeTypeToSkip'",
    strval(CONFIG_TYPE_TEXT), "'Skip'", "1", "'$mimeTypeDesc'", "null", "null");
 
  $perm_admin=Auth::PERM_ADMIN;
  $perm_write=Auth::PERM_WRITE;
  $variable = "SourceCodeDownloadRights";
  $SourceDownloadRightsPrompt = _('Access rights required to download source code');
  $SourceDownloadRightsDesc = _('Choose which access level will be required for user to be able to download source code.');
  $valueArray[$variable] = array("'$variable'", "'$perm_write'", "'$SourceDownloadRightsPrompt'",
  strval(CONFIG_TYPE_DROP), "'DOWNLOAD'", "1", "'$SourceDownloadRightsDesc'", "null", "'Administrator{{$perm_admin}}|Read_Write{{$perm_write}}'");
 
  $variable = "UserDescReadOnly";
  $prompt = _('Make account details read-only');
  $desc = _('Make account details (username, email, description) read-only');
  $valueArray[$variable] = array("'$variable'", "false", "'$prompt'",
    strval(CONFIG_TYPE_BOOL), "'USER_READ_ONLY'", "1", "'$desc'",
    "'check_boolean'", "null");
 
  $variable = "LicenseTypes";
  $licenseTypeTitle = _("License Types");
  $licenseTypeDesc = _("add comma (,) separated different license types");
  $valueArray[$variable] = array("'$variable'",
    "'Permissive, Strong Copyleft, Weak Copyleft, Network Copyleft, Public Domain, Non-commercial, Source Available, Font, Data, Exception, Unknown'",
    "'$licenseTypeTitle'",
    strval(CONFIG_TYPE_TEXT), "'LICENSE'", "1", "'$licenseTypeDesc'", "null", "null");
 
  /* SoftwareHeritage agent config */
  $variable = "SwhURL";
  $prompt = _('SoftwareHeritage URL');
  $desc = _('URL to Software Heritage servers');
  $valueArray[$variable] = array("'$variable'",
    "'https://archive.softwareheritage.org'", "'$prompt'",
    strval(CONFIG_TYPE_TEXT), "'SWH'", "1", "'$desc'", "'check_url'", "null");
 
  $variable = "SwhBaseURL";
  $prompt = _('SoftwareHeritage API base URI');
  $desc = _('Base URI for API calls');
  $valueArray[$variable] = array("'$variable'", "'/api/1/content/sha256:'",
    "'$prompt'", strval(CONFIG_TYPE_TEXT), "'SWH'", "2", "'$desc'", "null",
    "null");
 
  $variable = "SwhContent";
  $prompt = _('Content endpoint');
  $desc = _('Endpoint to get content about file');
  $valueArray[$variable] = array("'$variable'", "'/license'", "'$prompt'",
    strval(CONFIG_TYPE_TEXT), "'SWH'", "3", "'$desc'", "null", "null");
 
  $variable = "SwhSleep";
  $prompt = _('Max sleep time');
  $desc = _('Max time to sleep for rate-limit. Note: This concerns with scheduler heartbeat.');
  $valueArray[$variable] = array("'$variable'", "100", "'$prompt'",
    strval(CONFIG_TYPE_INT), "'SWH'", "4", "'$desc'", "null", "null");
 
  $variable = "SwhToken";
  $prompt = _('Auth token');
  $desc = _('');
  $valueArray[$variable] = array("'$variable'", "''", "'$prompt'",
    strval(CONFIG_TYPE_PASSWORD), "'SWH'", "5", "'$desc'", "null", "null");
 
  $variable = "ScAPIURL";
  $prompt = _('Scanoss API url');
  $desc = _('Set URL to SCANOSS API (blank for default osskb.org)');
  $valueArray[$variable] = array("'$variable'",
    "''", "'$prompt'",
    strval(CONFIG_TYPE_TEXT), "'SSS'", "1", "'$desc'", "null", "null");
 
  $variable = "ScToken";
  $prompt = _('Access token');
  $desc = _('Set token to access full service (blank for basic scan)');
  $valueArray[$variable] = array("'$variable'",
    "''", "'$prompt'",
    strval(CONFIG_TYPE_TEXT), "'SSS'", "2", "'$desc'", "null", "null");
 
  /* LicenseDB config */
  $variable = "LicenseDBBaseURL";
  $prompt = _('LicenseDB API base URI');
  $desc = _('Base URI for API calls e.g. /api/v1');
  $valueArray[$variable] = array("'$variable'", "'http://localhost:8080/api/v1'",
    "'$prompt'", strval(CONFIG_TYPE_TEXT), "'LicenseDB'", "1", "'$desc'", "null",
    "null");
 
  $variable = "LicenseDBHealth";
  $prompt = _('Health check');
  $desc = _('Endpoint to check health of LicenseDB service');
  $valueArray[$variable] = array("'$variable'", "'/health'", "'$prompt'",
    strval(CONFIG_TYPE_TEXT), "'LicenseDB'", "2", "'$desc'", "null", "null");
 
  $variable = "LicenseDBContent";
  $prompt = _('Export endpoint Licenses');
  $desc = _('Endpoint to Export licenses in JSON e.g. /licenses/export');
  $valueArray[$variable] = array("'$variable'", "'/licenses/export'", "'$prompt'",
    strval(CONFIG_TYPE_TEXT), "'LicenseDB'", "3", "'$desc'", "null", "null");
 
  $variable = "LicenseDBContentObligations";
  $prompt = _('Export endpoint Obligations');
  $desc = _('Endpoint to Export Obligations in JSON e.g. /obligations/export');
  $valueArray[$variable] = array("'$variable'", "'/obligations/export'", "'$prompt'",
    strval(CONFIG_TYPE_TEXT), "'LicenseDB'", "4", "'$desc'", "null", "null");
 
  $variable = "LicenseDBToken";
  $prompt = _('Auth token For LicenseDB');
  $desc = _("Token from LicenseDB. Do not set if using OIDC for LicenseDB and FOSSology communication.");
  $valueArray[$variable] = array("'$variable'", "''", "'$prompt'",
    strval(CONFIG_TYPE_PASSWORD), "'LicenseDB'", "5", "'$desc'", "null", "null");
 
  $variable = "ExcludeFolders";
  $mimeTypeToSkip = _("Exclude Folders from scanning");
  $mimeTypeDesc = _("Add comma (,) separated folder patterns to exclude from unpacking");
  $valueArray[$variable] = array("'$variable'", "null", "'$mimeTypeToSkip'",
    strval(CONFIG_TYPE_TEXT), "'Skip'", "1", "'$mimeTypeDesc'", "null", "null");
 
  /* kotoba Agent */
  $variable = "KotobaDelimiters";
  $prompt = _('Kotoba Agent Delimiters');
  $desc = _('Comma-separated list of additional delimiter characters for kotoba agent. Space, comma, tab, newline, carriage return, and form feed are always included as delimiters. Leave empty to use only the default delimiters. Example: "#,^,%,*" to add special characters');
  $valueArray[$variable] = array("'$variable'", "null", "'$prompt'",
    strval(CONFIG_TYPE_TEXT), "'Kotoba'", "1", "'$desc'", "null", "null");
 
  /* Doing all the rows as a single insert will fail if any row is a dupe.
   So insert each one individually so that new variables get added.
  */
  foreach ($valueArray as $variable => $values) {
    /*
     * Check if the variable already exists. Insert it if it does not.
     * This is better than an insert ignoring duplicates, because that
     * generates a postresql log message.
     */
    $VarRec = GetSingleRec("sysconfig", "WHERE variablename='$variable'");
    if (empty($VarRec)) {
      $sql = "INSERT INTO sysconfig (" . implode(",", $columns) . ") VALUES (" .
        implode(",", $values) . ");";
    } else { // Values exist, update them
      $updateString = [];
      foreach ($columns as $index => $column) {
        if ($index != 0 && $index != 1) { // Skip variablename and conf_value
          $updateString[] = $column . "=" . $values[$index];
        }
      }
      $sql = "UPDATE sysconfig SET " . implode(",", $updateString) .
        " WHERE variablename='$variable';";
    }
    $result = pg_query($PG_CONN, $sql);
    DBCheckResult($result, $sql, __FILE__, __LINE__);
    pg_free_result($result);
    unset($VarRec);
  }
}
 
function check_boolean($value)
{
  if (! strcmp($value, 'true') || ! strcmp($value, 'false')) {
    return 1;
  } else {
    return 0;
  }
}
 
function check_fossology_url($url)
{
  $url_array = explode("/", $url, 2);
  $name = $url_array[0];
  if (! empty($name)) {
    $hostname = exec("hostname -f");
    if (empty($hostname)) {
      $hostname = "localhost";
    }
    if (check_IP($name)) {
      $hostname1 = gethostbyaddr($name);
      if (strcmp($hostname, $hostname1) == 0) {
        return 0; // host is not reachable
      }
    }
    $server_name = $_SERVER['SERVER_NAME'];
 
    /* intput $name must match either the hostname or the server name */
    if (strcmp($name, $hostname) && strcmp($name, $server_name)) {
      return 0;
    }
  } else {
    return 0;
  }
  return 1;
}
 
function check_logo_url($url)
{
  if (empty($url)) {
    return 1; /* logo url can be null, with the default */
  }
  // $res = check_url($url);
  $res = is_available($url);
  if (1 == $res) {
    return 1;
  } else {
    return 0;
  }
}
 
function check_logo_image_url($url)
{
  global $SysConf;
 
  if (empty($url)) {
    return 1; /* logo url can be null, with the default */
  }
  $logoLink = @$SysConf["LogoLink"];
  $new_url = $logoLink . $url;
  if (is_available($url) || is_available($new_url)) {
    return 1;
  } else {
    return 0;
  }
 
}
 
function check_email_address($email_address)
{
  return 1;
}
 
function is_available($url, $timeout = 2, $tries = 2)
{
  global $SysConf;
 
  $proxyStmts = "";
  if (array_key_exists('http_proxy', $SysConf['FOSSOLOGY']) &&
    $SysConf['FOSSOLOGY']['http_proxy']) {
    $proxyStmts .= "export http_proxy={$SysConf['FOSSOLOGY']['http_proxy']};";
  }
  if (array_key_exists('https_proxy', $SysConf['FOSSOLOGY']) &&
    $SysConf['FOSSOLOGY']['https_proxy']) {
    $proxyStmts .= "export https_proxy={$SysConf['FOSSOLOGY']['https_proxy']};";
  }
  if (array_key_exists('ftp_proxy', $SysConf['FOSSOLOGY']) &&
    $SysConf['FOSSOLOGY']['ftp_proxy']) {
    $proxyStmts .= "export ftp_proxy={$SysConf['FOSSOLOGY']['ftp_proxy']};";
  }
 
  $commands = "$proxyStmts wget --spider '$url' --tries=$tries --timeout=$timeout";
  system($commands, $return_var);
  if (0 == $return_var) {
    return 1;
  } else {
    return 0;
  }
}
 
function check_url($url)
{
  if (empty($url) ||
    preg_match("@^((http)|(https)|(ftp))://([[:alnum:]]+)@i", $url) != 1 ||
    preg_match("@[[:space:]]@", $url) != 0) {
    return 0;
  } else {
    return 1;
  }
}
 
function check_IP($ip)
{
  $e = "([0-9]|1[0-9]{2}|[1-9][0-9]|2[0-4][0-9]|25[0-5])";
  return preg_match("/^$e\.$e\.$e\.$e$/", $ip);
}
 
function set_python_path(): array
{
  global $SysConf;
  $path = "/home/" . $SysConf['DIRECTORIES']['PROJECTUSER'] . "/pythondeps";
  putenv("PYTHONPATH=$path");
  return ["PYTHONPATH" => $path];
}
function get_system_load_average()
{
  // Get No.of cores
  $cores = trim(shell_exec("nproc"));
 
  // Get CPU load
  $load = sys_getloadavg()[1];
 
  $percentageOfLoad = ($load / $cores);
 
  if ($percentageOfLoad < 0.30) {
    $class = 'btn-success';
  } else if ($percentageOfLoad < 0.60) {
    $class = 'btn-warning';
  } else {
    $class = 'btn-danger';
  }
 
  return '<button type="button" aria-disabled="true" disabled class="btn '.$class.'">System Load</button>';
}