mirror of
https://github.com/pmmp/PocketMine-MP.git
synced 2025-05-10 07:49:42 +00:00
205e13d880
Config->getPath() returns the path of the config i.e. the place where the config file is located.
575 lines
13 KiB
PHP
575 lines
13 KiB
PHP
<?php
|
|
|
|
/*
|
|
*
|
|
* ____ _ _ __ __ _ __ __ ____
|
|
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
|
|
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
|
|
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
|
|
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* @author PocketMine Team
|
|
* @link http://www.pocketmine.net/
|
|
*
|
|
*
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace pocketmine\utils;
|
|
|
|
use function array_change_key_case;
|
|
use function array_keys;
|
|
use function array_pop;
|
|
use function array_shift;
|
|
use function basename;
|
|
use function count;
|
|
use function date;
|
|
use function explode;
|
|
use function file_exists;
|
|
use function file_get_contents;
|
|
use function file_put_contents;
|
|
use function implode;
|
|
use function is_array;
|
|
use function is_bool;
|
|
use function json_decode;
|
|
use function json_encode;
|
|
use function preg_match_all;
|
|
use function preg_replace;
|
|
use function serialize;
|
|
use function str_replace;
|
|
use function strlen;
|
|
use function strtolower;
|
|
use function substr;
|
|
use function trim;
|
|
use function unserialize;
|
|
use function yaml_emit;
|
|
use function yaml_parse;
|
|
use const CASE_LOWER;
|
|
use const JSON_BIGINT_AS_STRING;
|
|
use const JSON_PRETTY_PRINT;
|
|
|
|
/**
|
|
* Config Class for simple config manipulation of multiple formats.
|
|
*/
|
|
class Config{
|
|
public const DETECT = -1; //Detect by file extension
|
|
public const PROPERTIES = 0; // .properties
|
|
public const CNF = Config::PROPERTIES; // .cnf
|
|
public const JSON = 1; // .js, .json
|
|
public const YAML = 2; // .yml, .yaml
|
|
//const EXPORT = 3; // .export, .xport
|
|
public const SERIALIZED = 4; // .sl
|
|
public const ENUM = 5; // .txt, .list, .enum
|
|
public const ENUMERATION = Config::ENUM;
|
|
|
|
/** @var array */
|
|
private $config = [];
|
|
|
|
private $nestedCache = [];
|
|
|
|
/** @var string */
|
|
private $file;
|
|
/** @var int */
|
|
private $type = Config::DETECT;
|
|
/** @var int */
|
|
private $jsonOptions = JSON_PRETTY_PRINT | JSON_BIGINT_AS_STRING;
|
|
|
|
/** @var bool */
|
|
private $changed = false;
|
|
|
|
public static $formats = [
|
|
"properties" => Config::PROPERTIES,
|
|
"cnf" => Config::CNF,
|
|
"conf" => Config::CNF,
|
|
"config" => Config::CNF,
|
|
"json" => Config::JSON,
|
|
"js" => Config::JSON,
|
|
"yml" => Config::YAML,
|
|
"yaml" => Config::YAML,
|
|
//"export" => Config::EXPORT,
|
|
//"xport" => Config::EXPORT,
|
|
"sl" => Config::SERIALIZED,
|
|
"serialize" => Config::SERIALIZED,
|
|
"txt" => Config::ENUM,
|
|
"list" => Config::ENUM,
|
|
"enum" => Config::ENUM
|
|
];
|
|
|
|
/**
|
|
* @param string $file Path of the file to be loaded
|
|
* @param int $type Config type to load, -1 by default (detect)
|
|
* @param array $default Array with the default values that will be written to the file if it did not exist
|
|
*/
|
|
public function __construct(string $file, int $type = Config::DETECT, array $default = []){
|
|
$this->load($file, $type, $default);
|
|
}
|
|
|
|
/**
|
|
* Removes all the changes in memory and loads the file again
|
|
*/
|
|
public function reload(){
|
|
$this->config = [];
|
|
$this->nestedCache = [];
|
|
$this->load($this->file, $this->type);
|
|
}
|
|
|
|
public function hasChanged() : bool{
|
|
return $this->changed;
|
|
}
|
|
|
|
public function setChanged(bool $changed = true) : void{
|
|
$this->changed = $changed;
|
|
}
|
|
|
|
/**
|
|
* @param string $str
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function fixYAMLIndexes(string $str) : string{
|
|
return preg_replace("#^( *)(y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF)( *)\:#m", "$1\"$2\"$3:", $str);
|
|
}
|
|
|
|
/**
|
|
* @param string $file
|
|
* @param int $type
|
|
* @param array $default
|
|
*
|
|
* @throws \InvalidArgumentException if config type could not be auto-detected
|
|
* @throws \InvalidStateException if config type is invalid
|
|
*/
|
|
private function load(string $file, int $type = Config::DETECT, array $default = []) : void{
|
|
$this->file = $file;
|
|
|
|
$this->type = $type;
|
|
if($this->type === Config::DETECT){
|
|
$extension = explode(".", basename($this->file));
|
|
$extension = strtolower(trim(array_pop($extension)));
|
|
if(isset(Config::$formats[$extension])){
|
|
$this->type = Config::$formats[$extension];
|
|
}else{
|
|
throw new \InvalidArgumentException("Cannot detect config type of " . $this->file);
|
|
}
|
|
}
|
|
|
|
if(!file_exists($file)){
|
|
$this->config = $default;
|
|
$this->save();
|
|
}else{
|
|
$content = file_get_contents($this->file);
|
|
switch($this->type){
|
|
case Config::PROPERTIES:
|
|
$this->parseProperties($content);
|
|
break;
|
|
case Config::JSON:
|
|
$this->config = json_decode($content, true);
|
|
break;
|
|
case Config::YAML:
|
|
$content = self::fixYAMLIndexes($content);
|
|
$this->config = yaml_parse($content);
|
|
break;
|
|
case Config::SERIALIZED:
|
|
$this->config = unserialize($content);
|
|
break;
|
|
case Config::ENUM:
|
|
$this->parseList($content);
|
|
break;
|
|
default:
|
|
throw new \InvalidStateException("Config type is unknown");
|
|
}
|
|
if(!is_array($this->config)){
|
|
$this->config = $default;
|
|
}
|
|
if($this->fillDefaults($default, $this->config) > 0){
|
|
$this->save();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the path of the config.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getPath() : string{
|
|
return $this->file;
|
|
}
|
|
|
|
/**
|
|
* Flushes the config to disk in the appropriate format.
|
|
*
|
|
* @throws \InvalidStateException if config type is not valid
|
|
*/
|
|
public function save() : void{
|
|
$content = null;
|
|
switch($this->type){
|
|
case Config::PROPERTIES:
|
|
$content = $this->writeProperties();
|
|
break;
|
|
case Config::JSON:
|
|
$content = json_encode($this->config, $this->jsonOptions);
|
|
break;
|
|
case Config::YAML:
|
|
$content = yaml_emit($this->config, YAML_UTF8_ENCODING);
|
|
break;
|
|
case Config::SERIALIZED:
|
|
$content = serialize($this->config);
|
|
break;
|
|
case Config::ENUM:
|
|
$content = implode("\r\n", array_keys($this->config));
|
|
break;
|
|
default:
|
|
throw new \InvalidStateException("Config type is unknown, has not been set or not detected");
|
|
}
|
|
|
|
file_put_contents($this->file, $content);
|
|
|
|
$this->changed = false;
|
|
}
|
|
|
|
/**
|
|
* Sets the options for the JSON encoding when saving
|
|
*
|
|
* @param int $options
|
|
*
|
|
* @return Config $this
|
|
* @throws \RuntimeException if the Config is not in JSON
|
|
* @see json_encode
|
|
*/
|
|
public function setJsonOptions(int $options) : Config{
|
|
if($this->type !== Config::JSON){
|
|
throw new \RuntimeException("Attempt to set JSON options for non-JSON config");
|
|
}
|
|
$this->jsonOptions = $options;
|
|
$this->changed = true;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Enables the given option in addition to the currently set JSON options
|
|
*
|
|
* @param int $option
|
|
*
|
|
* @return Config $this
|
|
* @throws \RuntimeException if the Config is not in JSON
|
|
* @see json_encode
|
|
*/
|
|
public function enableJsonOption(int $option) : Config{
|
|
if($this->type !== Config::JSON){
|
|
throw new \RuntimeException("Attempt to enable JSON option for non-JSON config");
|
|
}
|
|
$this->jsonOptions |= $option;
|
|
$this->changed = true;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Disables the given option for the JSON encoding when saving
|
|
*
|
|
* @param int $option
|
|
*
|
|
* @return Config $this
|
|
* @throws \RuntimeException if the Config is not in JSON
|
|
* @see json_encode
|
|
*/
|
|
public function disableJsonOption(int $option) : Config{
|
|
if($this->type !== Config::JSON){
|
|
throw new \RuntimeException("Attempt to disable JSON option for non-JSON config");
|
|
}
|
|
$this->jsonOptions &= ~$option;
|
|
$this->changed = true;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Returns the options for the JSON encoding when saving
|
|
*
|
|
* @return int
|
|
* @throws \RuntimeException if the Config is not in JSON
|
|
* @see json_encode
|
|
*/
|
|
public function getJsonOptions() : int{
|
|
if($this->type !== Config::JSON){
|
|
throw new \RuntimeException("Attempt to get JSON options for non-JSON config");
|
|
}
|
|
return $this->jsonOptions;
|
|
}
|
|
|
|
/**
|
|
* @param string $k
|
|
*
|
|
* @return bool|mixed
|
|
*/
|
|
public function __get($k){
|
|
return $this->get($k);
|
|
}
|
|
|
|
/**
|
|
* @param string $k
|
|
* @param mixed $v
|
|
*/
|
|
public function __set($k, $v){
|
|
$this->set($k, $v);
|
|
}
|
|
|
|
/**
|
|
* @param string $k
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function __isset($k){
|
|
return $this->exists($k);
|
|
}
|
|
|
|
/**
|
|
* @param string $k
|
|
*/
|
|
public function __unset($k){
|
|
$this->remove($k);
|
|
}
|
|
|
|
/**
|
|
* @param string $key
|
|
* @param mixed $value
|
|
*/
|
|
public function setNested($key, $value){
|
|
$vars = explode(".", $key);
|
|
$base = array_shift($vars);
|
|
|
|
if(!isset($this->config[$base])){
|
|
$this->config[$base] = [];
|
|
}
|
|
|
|
$base =& $this->config[$base];
|
|
|
|
while(count($vars) > 0){
|
|
$baseKey = array_shift($vars);
|
|
if(!isset($base[$baseKey])){
|
|
$base[$baseKey] = [];
|
|
}
|
|
$base =& $base[$baseKey];
|
|
}
|
|
|
|
$base = $value;
|
|
$this->nestedCache = [];
|
|
$this->changed = true;
|
|
}
|
|
|
|
/**
|
|
* @param string $key
|
|
* @param mixed $default
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getNested($key, $default = null){
|
|
if(isset($this->nestedCache[$key])){
|
|
return $this->nestedCache[$key];
|
|
}
|
|
|
|
$vars = explode(".", $key);
|
|
$base = array_shift($vars);
|
|
if(isset($this->config[$base])){
|
|
$base = $this->config[$base];
|
|
}else{
|
|
return $default;
|
|
}
|
|
|
|
while(count($vars) > 0){
|
|
$baseKey = array_shift($vars);
|
|
if(is_array($base) and isset($base[$baseKey])){
|
|
$base = $base[$baseKey];
|
|
}else{
|
|
return $default;
|
|
}
|
|
}
|
|
|
|
return $this->nestedCache[$key] = $base;
|
|
}
|
|
|
|
public function removeNested(string $key) : void{
|
|
$this->nestedCache = [];
|
|
$this->changed = true;
|
|
|
|
$vars = explode(".", $key);
|
|
|
|
$currentNode =& $this->config;
|
|
while(count($vars) > 0){
|
|
$nodeName = array_shift($vars);
|
|
if(isset($currentNode[$nodeName])){
|
|
if(empty($vars)){ //final node
|
|
unset($currentNode[$nodeName]);
|
|
}elseif(is_array($currentNode[$nodeName])){
|
|
$currentNode =& $currentNode[$nodeName];
|
|
}
|
|
}else{
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $k
|
|
* @param mixed $default
|
|
*
|
|
* @return bool|mixed
|
|
*/
|
|
public function get($k, $default = false){
|
|
return $this->config[$k] ?? $default;
|
|
}
|
|
|
|
/**
|
|
* @param string $k key to be set
|
|
* @param mixed $v value to set key
|
|
*/
|
|
public function set($k, $v = true){
|
|
$this->config[$k] = $v;
|
|
$this->changed = true;
|
|
foreach($this->nestedCache as $nestedKey => $nvalue){
|
|
if(substr($nestedKey, 0, strlen($k) + 1) === ($k . ".")){
|
|
unset($this->nestedCache[$nestedKey]);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param array $v
|
|
*/
|
|
public function setAll(array $v){
|
|
$this->config = $v;
|
|
$this->changed = true;
|
|
}
|
|
|
|
/**
|
|
* @param string $k
|
|
* @param bool $lowercase If set, searches Config in single-case / lowercase.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function exists($k, bool $lowercase = false) : bool{
|
|
if($lowercase){
|
|
$k = strtolower($k); //Convert requested key to lower
|
|
$array = array_change_key_case($this->config, CASE_LOWER); //Change all keys in array to lower
|
|
return isset($array[$k]); //Find $k in modified array
|
|
}else{
|
|
return isset($this->config[$k]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $k
|
|
*/
|
|
public function remove($k){
|
|
unset($this->config[$k]);
|
|
$this->changed = true;
|
|
}
|
|
|
|
/**
|
|
* @param bool $keys
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getAll(bool $keys = false) : array{
|
|
return ($keys ? array_keys($this->config) : $this->config);
|
|
}
|
|
|
|
/**
|
|
* @param array $defaults
|
|
*/
|
|
public function setDefaults(array $defaults){
|
|
$this->fillDefaults($defaults, $this->config);
|
|
}
|
|
|
|
/**
|
|
* @param array $default
|
|
* @param array &$data
|
|
*
|
|
* @return int
|
|
*/
|
|
private function fillDefaults(array $default, &$data) : int{
|
|
$changed = 0;
|
|
foreach($default as $k => $v){
|
|
if(is_array($v)){
|
|
if(!isset($data[$k]) or !is_array($data[$k])){
|
|
$data[$k] = [];
|
|
}
|
|
$changed += $this->fillDefaults($v, $data[$k]);
|
|
}elseif(!isset($data[$k])){
|
|
$data[$k] = $v;
|
|
++$changed;
|
|
}
|
|
}
|
|
|
|
if($changed > 0){
|
|
$this->changed = true;
|
|
}
|
|
|
|
return $changed;
|
|
}
|
|
|
|
/**
|
|
* @param string $content
|
|
*/
|
|
private function parseList(string $content){
|
|
foreach(explode("\n", trim(str_replace("\r\n", "\n", $content))) as $v){
|
|
$v = trim($v);
|
|
if($v == ""){
|
|
continue;
|
|
}
|
|
$this->config[$v] = true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
private function writeProperties() : string{
|
|
$content = "#Properties Config file\r\n#" . date("D M j H:i:s T Y") . "\r\n";
|
|
foreach($this->config as $k => $v){
|
|
if(is_bool($v)){
|
|
$v = $v ? "on" : "off";
|
|
}elseif(is_array($v)){
|
|
$v = implode(";", $v);
|
|
}
|
|
$content .= $k . "=" . $v . "\r\n";
|
|
}
|
|
|
|
return $content;
|
|
}
|
|
|
|
/**
|
|
* @param string $content
|
|
*/
|
|
private function parseProperties(string $content){
|
|
if(preg_match_all('/^\s*([a-zA-Z0-9\-_\.]+)[ \t]*=([^\r\n]*)/um', $content, $matches) > 0){ //false or 0 matches
|
|
foreach($matches[1] as $i => $k){
|
|
$v = trim($matches[2][$i]);
|
|
switch(strtolower($v)){
|
|
case "on":
|
|
case "true":
|
|
case "yes":
|
|
$v = true;
|
|
break;
|
|
case "off":
|
|
case "false":
|
|
case "no":
|
|
$v = false;
|
|
break;
|
|
}
|
|
if(isset($this->config[$k])){
|
|
\GlobalLogger::get()->debug("[Config] Repeated property " . $k . " on file " . $this->file);
|
|
}
|
|
$this->config[$k] = $v;
|
|
}
|
|
}
|
|
}
|
|
}
|