<?php
/**
* Generic configuration model serializer for portable Loco configs
*/
abstract class Loco_config_Model {
/**
* Root directory for calculating relative file paths
*/
private string $base;
/**
* registry of location constants that may have been overridden
*/
private array $dirs;
/**
* @return Iterator
*/
abstract public function query( $query, $context = null );
/**
* @return void
*/
abstract public function createDom();
/**
* @return DOMDocument|LocoConfigDocument
*/
abstract public function getDom();
/**
* Super constructor for all model types
*/
final public function __construct(){
$this->dirs = [];
$this->createDom();
$this->setDirectoryPath( loco_constant('ABSPATH') );
}
/**
* @return void
*/
public function setDirectoryPath( $path, $key = null ){
$path = untrailingslashit($path);
if( is_null($key) ){
$this->base = $path;
}
else {
$this->dirs[$key] = $path;
}
}
/**
* Evaluate a name constant pointing to a file location
* @param string|null $key one of 'LOCO_LANG_DIR', 'WP_LANG_DIR', 'WP_PLUGIN_DIR', 'WPMU_PLUGIN_DIR', 'WP_CONTENT_DIR', or 'ABSPATH'
*/
public function getDirectoryPath( $key = null ){
if( is_null($key) ){
$value = $this->base;
}
else if( isset($this->dirs[$key]) ){
$value = $this->dirs[$key];
}
else {
$value = untrailingslashit( loco_constant($key) );
}
return $value;
}
/**
* @return LocoConfigElement
*/
public function createFileElement( Loco_fs_File $file ){
$path = $file->getPath();
// only test concrete file type if existence is testable
if( '' === $path || '/' !== $path[0] ){
$type = $file->extension() ? 'file' : 'directory';
}
else {
$type = $file->isDirectory() ? 'directory' : 'file';
}
$node = $this->getDom()->createElement($type);
// Calculate relative path to the config file itself
$relpath = $file->getRelativePath($this->base);
// Map to a configured base path if target is not under our root. This makes XML more portable
// matching order is the most specific first, resulting in the shortest path
if( $relpath && ( Loco_fs_File::abs($relpath) || '..' === substr($relpath,0,2) || $this->base === $this->getDirectoryPath('ABSPATH') ) ){
$bases = [ 'LOCO_LANG_DIR', 'WP_LANG_DIR', 'WP_PLUGIN_DIR', 'WPMU_PLUGIN_DIR', 'WP_CONTENT_DIR', 'ABSPATH' ];
foreach( $bases as $key ){
if( ( $base = $this->getDirectoryPath($key) ) && $base !== $this->base ){
$base .= '/';
$len = strlen($base);
if( substr($path,0,$len) === $base ){
$node->setAttribute('base',$key);
$relpath = substr( $path, $len );
break;
}
}
}
}
$this->setFileElementPath($node,$relpath);
return $node;
}
/**
* @param LocoConfigElement $node
* @param string $path
* @return LocoConfigText
*/
protected function setFileElementPath( $node, $path ){
$text = $this->getDom()->createTextNode($path);
$node->appendChild($text);
return $text;
}
/**
* @param LocoConfigElement $el
* @return Loco_fs_File
*/
public function evaluateFileElement( $el ){
$path = $el->textContent;
switch( $el->nodeName ){
case 'directory':
$file = new Loco_fs_Directory($path);
break;
case 'file':
$file = new Loco_fs_File($path);
break;
case 'path':
$file = new Loco_fs_File($path);
if( $file->isDirectory() ){
$file = new Loco_fs_Directory($path);
}
break;
default:
throw new InvalidArgumentException('Cannot evaluate file element from <'.$el->nodeName.'>');
}
if( $el->hasAttribute('base') ){
$key = $el->getAttribute('base');
$base = $this->getDirectoryPath($key);
$file->normalize( $base );
}
else {
$file->normalize( $this->base );
}
return $file;
}
/**
* @param LocoConfigElement $el
* @param string $attr
* @return bool
*/
public function evaluateBooleanAttribute( $el, $attr ){
if( ! $el->hasAttribute($attr) ){
return false;
}
$value = (string) $el->getAttribute($attr);
return 'false' !== $value && 'no' !== $value && '' !== $value;
}
}