sydney/IPB
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Version 5.0.0 beta 1

Browse Source
This commit is contained in:
Neo committed 2025-12-19 16:27:35 -08:00
1 parent 25ddeb65d6
commit 15c7beabc5
6736 files changed
+627902 -497943
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

system/Settings/Settings.php
+99 -36
View File
@@ -11,36 +11,53 @@
namespace IPS;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
use InvalidArgumentException;
use IPS\Data\Store;
use IPS\Extensions\SSOAbstract;
use IPS\Patterns\Singleton;
use function defined;
use function in_array;
use function is_object;
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* Settings class
*/
class _Settings extends \IPS\Patterns\Singleton
class Settings extends Singleton
{
/**
* @brief Singleton Instances
*/
protected static $instance = NULL;
protected static ?Singleton $instance = NULL;
/**
* @brief Data Store
*/
protected $data = NULL;
protected ?array $data = array();
/**
* @brief Settings loaded?
*/
protected $loaded = FALSE;
protected bool $loaded = FALSE;
/**
* @brief Store $INFO so we know what came from conf_global later
*/
protected static $confGlobal = array();
protected static array $confGlobal = array();
/**
* Allow list of settings the SSO extension can override.
* @var array|string[]
*/
protected array $ssoExtensionAllowList = [ 'post_before_registering', 'allow_reg', 'allow_reg_target',
'allow_email_changes', 'allow_email_changes_target', 'allow_password_changes', 'allow_password_changes_target',
'allow_forgot_password', 'allow_forgot_password_target' ];
/**
* Constructor
@@ -49,11 +66,21 @@ class _Settings extends \IPS\Patterns\Singleton
*/
protected function __construct()
{
if ( file_exists( \IPS\SITE_FILES_PATH . '/conf_global.php' ) )
if ( file_exists( SITE_FILES_PATH . '/conf_global.php' ) )
{
$allowedFields = $this->getAllowedFields();
require( \IPS\SITE_FILES_PATH . '/conf_global.php' );
require( SITE_FILES_PATH . '/conf_global.php' );
if ( CIC2 )
{
/* cannot import with use as it cicloud may not exist */
$auth = \IPS\Cicloud\getMysqlPassword();
$INFO['sql_pass'] = $auth['sql_pass'];
$INFO['sql_read_pass'] = $auth['sql_read_pass'];
}
if ( isset( $INFO ) )
{
if( isset( $INFO['board_url'] ) AND ( !isset( $INFO['base_url'] ) OR !$INFO['base_url'] ) )
@@ -71,7 +98,7 @@ class _Settings extends \IPS\Patterns\Singleton
foreach( $INFO as $k => $v )
{
if ( ! \in_array( $k, $allowedFields ) )
if ( ! in_array( $k, $allowedFields ) )
{
unset( $INFO[ $k ] );
}
@@ -89,7 +116,7 @@ class _Settings extends \IPS\Patterns\Singleton
*
* @return array
*/
public function getAllowedFields()
public function getAllowedFields(): array
{
return array( 'sql_host', 'sql_database', 'sql_user', 'sql_pass', 'sql_port', 'sql_socket', 'sql_tbl_prefix', 'sql_utf8mb4', 'board_start', 'installed', 'base_url', 'guest_group', 'member_group', 'admin_group' );
}
@@ -100,21 +127,42 @@ class _Settings extends \IPS\Patterns\Singleton
* @param mixed $key Key
* @return mixed Value from the datastore
*/
public function __get( $key )
public function __get( mixed $key ) :mixed
{
/* CiC hardcoded */
if ( \IPS\CIC )
if ( CIC )
{
if ( \in_array( $key, array( 'xforward_matching', 'use_friendly_urls', 'htaccess_mod_rewrite', 'seo_r_on' ) ) )
if ( in_array( $key, array( 'xforward_matching', 'use_friendly_urls', 'htaccess_mod_rewrite', 'seo_r_on', 'archive_on' ) ) )
{
return TRUE;
}
if ( $key == 'nexus_prune_history' )
{
return 4383; # This is 12 years or there abouts in days
}
if ( $key == 'prune_member_history' )
{
return 365; # This is 1 year or there abouts in days
}
if ( $key == 'api_log_prune' )
{
return 3;
}
if ( $key == 'api_log_prune_failures' )
{
return 14;
}
if ( $key == 'task_use_cron' )
{
return 'normal';
}
}
/* Get normally */
$return = parent::__get( $key );
if ( $return === NULL and !$this->loaded )
@@ -132,9 +180,9 @@ class _Settings extends \IPS\Patterns\Singleton
* @param mixed $key Key
* @return mixed Value
*/
public function getFromConfGlobal( $key )
public function getFromConfGlobal( mixed $key ): mixed
{
return isset( $this->data[ $key ] ) ? $this->data[ $key ] : NULL;
return $this->data[$key] ?? NULL;
}
/**
@@ -143,7 +191,7 @@ class _Settings extends \IPS\Patterns\Singleton
* @param mixed $key Key
* @return bool
*/
public function __isset( $key )
public function __isset( mixed $key ): bool
{
$return = parent::__isset( $key );
@@ -161,26 +209,41 @@ class _Settings extends \IPS\Patterns\Singleton
*
* @return void
*/
protected function loadFromDb()
protected function loadFromDb() : void
{
$settings = [];
if ( isset( \IPS\Data\Store::i()->settings ) )
if ( isset( Store::i()->settings ) )
{
$settings = \IPS\Data\Store::i()->settings;
$settings = Store::i()->settings;
}
else
{
foreach ( \IPS\Db::i()->select( 'conf_key, conf_default, conf_value', 'core_sys_conf_settings' )->setKeyField( 'conf_key' ) as $k => $data )
foreach (Db::i()->select( 'conf_key, conf_default, conf_value', 'core_sys_conf_settings' )->setKeyField( 'conf_key' ) as $k => $data )
{
$settings[ $k ] = ( $data['conf_value'] === '' ) ? $data['conf_default'] : $data['conf_value'];
}
\IPS\Data\Store::i()->settings = $settings;
Store::i()->settings = $settings;
}
/* We don't want to 'cache' what is in conf_global */
$this->data = array_merge( $this->data, $settings );
$this->loaded = TRUE;
/* Check SSO Extensions for overloads */
foreach( Application::allExtensions( 'core', 'SSO', FALSE ) as $ext )
{
/* @var SSOAbstract $ext */
if( $ext->isEnabled() )
{
$newSettings = $ext->overrideSettings();
$overrides = [];
array_walk( $newSettings, function( $val, $key ) use ( &$overrides ) {
if( in_array( $key, $this->ssoExtensionAllowList ) ) { $overrides[ $key ] = $val; }
} );
$this->data = array_merge( $this->data, $overrides );
}
}
}
/**
@@ -190,9 +253,9 @@ class _Settings extends \IPS\Patterns\Singleton
the same values to be written, which is not desired
* @return void
*/
public function clearCache()
public function clearCache() : void
{
unset( \IPS\Data\Store::i()->settings );
unset( Store::i()->settings );
$this->data = static::$confGlobal;
$this->loaded = FALSE;
}
@@ -200,10 +263,10 @@ class _Settings extends \IPS\Patterns\Singleton
/**
* Change values
*
* @param array $newValues New values
* @param array $newValues New values
* @return void
*/
public function changeValues( $newValues )
public function changeValues( array $newValues ) : void
{
/* Get the current values if we don't have them already */
if ( !$this->loaded )
@@ -220,21 +283,21 @@ class _Settings extends \IPS\Patterns\Singleton
$defaultValues[] = $k;
}
}
$defaultValues = iterator_to_array( \IPS\Db::i()->select( array( 'conf_default', 'conf_key' ), 'core_sys_conf_settings', \IPS\Db::i()->in( 'conf_key', $defaultValues ) )->setKeyField( 'conf_key' )->setValueField( 'conf_default' ) );
$validKeys = iterator_to_array( \IPS\Db::i()->select( 'conf_key', 'core_sys_conf_settings', \IPS\Db::i()->in( 'conf_key', array_keys( $newValues ) ) ) );
$defaultValues = iterator_to_array( Db::i()->select( array( 'conf_default', 'conf_key' ), 'core_sys_conf_settings', Db::i()->in( 'conf_key', $defaultValues ) )->setKeyField( 'conf_key' )->setValueField( 'conf_default' ) );
$validKeys = iterator_to_array( Db::i()->select( 'conf_key', 'core_sys_conf_settings', Db::i()->in( 'conf_key', array_keys( $newValues ) ) ) );
/* Update the database */
$changed = FALSE;
foreach ( $newValues as $k => $v )
{
$valueToCache = isset( $defaultValues[ $k ] ) ? $defaultValues[ $k ] : $v;
$valueToCache = $defaultValues[$k] ?? $v;
/* Make sure the key is valid */
if( !\in_array( $k, $validKeys ) )
if( !in_array( $k, $validKeys ) )
{
if ( \IPS\IN_DEV )
if (IN_DEV)
{
throw new \InvalidArgumentException( 'unknown_setting: ' . $k );
throw new InvalidArgumentException( 'unknown_setting: ' . $k );
}
continue;
}
@@ -242,7 +305,7 @@ class _Settings extends \IPS\Patterns\Singleton
if ( $this->$k != $valueToCache )
{
$this->$k = $valueToCache;
\IPS\Db::i()->update( 'core_sys_conf_settings', array( 'conf_value' => $v ), array( 'conf_key=?', $k ) );
Db::i()->update( 'core_sys_conf_settings', array( 'conf_value' => $v ), array( 'conf_key=?', $k ) );
$changed = TRUE;
}
@@ -257,7 +320,7 @@ class _Settings extends \IPS\Patterns\Singleton
if ( ! isset( static::$confGlobal[ $dk ] ) )
{
/* Make sure objects are cast to string as the DB bind layer will do this automatically when saving */
if ( \is_object( $dv ) and method_exists( $dv, '__toString' ) )
if ( is_object( $dv ) and method_exists( $dv, '__toString' ) )
{
$dv = (string) $dv;
}
@@ -265,7 +328,7 @@ class _Settings extends \IPS\Patterns\Singleton
$toStore[ $dk ] = $dv;
}
}
\IPS\Data\Store::i()->settings = $toStore;
Store::i()->settings = $toStore;
}
}
}