mambax7 / xoositemap

class/Preferences.php

<?php

namespace XoopsModules\Xoositemap;

/**
 * Xoopreferences : Preferences Manager
 *
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code
 * which is considered copyrighted (c) material of the original comment or credit authors.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * @copyright       XOOPS Project (https://xoops.org)
 * @license         GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
 * @package         Xoositemap
 * @since           2.6.0
 * @author          Laurent JEN (Aka DuGris)

 */
class Preferences
{
    public $config = [];
    public $basicConfig = [];
    public  $configPath;
    public  $configFile;
    private $moduleDirName = 'xoositemap';

    /**
     * Xoositemap\Preferences constructor.
     */
    public function __construct()
    {
        $xoops = \Xoops::getInstance();
        $this->configFile = 'config.' . $this->moduleDirName . '.php';

        $this->configPath = \XoopsBaseConfig::get('var-path') . '/configs/' . $this->moduleDirName . '/';

        $this->basicConfig = $this->loadBasicConfig();
        $this->config      = @$this->loadConfig();

        if (count($this->config) != count($this->basicConfig)) {
            $this->config = array_merge($this->basicConfig, $this->config);
            $this->writeConfig($this->config);
        }
    }

    /**
     * @return mixed
     */
    public static function getInstance()
    {
        static $instance;
        if (!isset($instance)) {
            $class    = __CLASS__;
            $instance = new $class();
        }

        return $instance;
    }

    /**
     * @return array
     */
    public function getConfig()
    {
        return $this->config;
    }

    /**
     * Xoositemap\Preferences::loadConfig()
     *
     * @return array
     */
    public function loadConfig()
    {
        if (!$config = $this->readConfig()) {
            $config = $this->loadBasicConfig();
            $this->writeConfig($config);
        }

        return $config;
    }

    /**
     * Xoositemap\Preferences::loadBasicConfig()
     *
     * @return array
     */
    public function loadBasicConfig()
    {
        if (file_exists($file_path = dirname(__DIR__) . '/include/' . $this->configFile)) {
            $config = include $file_path;
        }

        return $config;
    }

    /**
     * Xoositemap\Preferences::readConfig()
     *
     * @return array
     */
    public function readConfig()
    {
        $file_path = $this->configPath . $this->configFile;
        \XoopsLoad::load('XoopsFile');
        $file = \XoopsFile::getHandler('file', $file_path);

        return eval(@$file->read());
    }

    /**
     * Xoositemap\Preferences::writeConfig()
     *
     * @param  array $config
     * @return bool|null
     * @internal param string $filename
     */
    public function writeConfig($config)
    {
        if ($this->createPath($this->configPath)) {
            $file_path = $this->configPath . $this->configFile;
            \XoopsLoad::load('XoopsFile');
            $file = \XoopsFile::getHandler('file', $file_path);

            return $file->write('return ' . var_export($config, true) . ';');
        }

        return null;
    }

    /**
     * @param              $pathname
     * @param mixed|string $pathout
     * @return bool
     */
    private function createPath($pathname, $pathout = XOOPS_ROOT_PATH)
    {
        $xoops = \Xoops::getInstance();
        $pathname = mb_substr($pathname, mb_strlen(\XoopsBaseConfig::get('root-path')));
        $pathname = str_replace(DIRECTORY_SEPARATOR, '/', $pathname);

        $dest  = $pathout;
        $paths = explode('/', $pathname);

        foreach ($paths as $path) {
            if (!empty($path)) {
                $dest = $dest . '/' . $path;
                if (!is_dir($dest)) {
                    if (!mkdir($dest, 0755) && !is_dir($dest)) {
                        return false;
                    }
                    $this->writeIndex(\XoopsBaseConfig::get('uploads-path'), 'index.html', $dest);
                }
            }
        }

        return true;
    }

    /**
     * @param $folder_in
     * @param $source_file
     * @param $folder_out
     * @return bool
     */
    private function writeIndex($folder_in, $source_file, $folder_out)
    {
        if (!is_dir($folder_out)) {
            if (!$this->createPath($folder_out)) {
                return false;
            }
        }

        // Simple copy for a file
        if (is_file($folder_in . '/' . $source_file)) {
            return copy($folder_in . '/' . $source_file, $folder_out . '/' . basename($source_file));
        }

        return false;
    }

    /**
     * @param null      $data

Are you sure the doc-type for parameter $data is correct as it would always require null to be passed?

     * @param bool|true $module
     * @return array
     */
    public function prepare2Save($data = null, $module = true)
    {
        if (!isset($data)) {
            $data = $_POST;
        }

        $config = [];
        foreach (array_keys($data) as $k) {
            if (is_array($data[$k])) {
                $config[$k] = $this->prepare2Save($data[$k], false);
            } else {
                if (false !== mb_strpos($k, $this->moduleDirName . '_') || !$module) {
                    $config[$k] = $data[$k];
                }
            }
        }

        return $config;
    }
}