xref: /plugin/farmer/helper.php (revision f64a85f7ef8593a387609801c962a904fe407d36)

<?php

use dokuwiki\Extension\Plugin;

/**
 * DokuWiki Plugin farmer (Helper Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  Michael Große <grosse@cosmocode.de>
 * @author  Andreas Gohr <gohr@cosmocode.de>
 */
class helper_plugin_farmer extends Plugin
{
    protected $defaultPluginState;
    protected $animalPluginState  = [];

    /**
     * Returns the name of the current animal if any, false otherwise
     *
     * @return string|false
     */
    public function getAnimal()
    {
        if (!isset($GLOBALS['FARMCORE'])) return false;
        return $GLOBALS['FARMCORE']->getAnimal();
    }

    /**
     * Get the farm config
     *
     * @return array
     */
    public function getConfig()
    {
        if (!isset($GLOBALS['FARMCORE'])) return [];
        return $GLOBALS['FARMCORE']->getConfig();
    }

    /**
     * Was the current animal requested by host?
     *
     * @return bool
     */
    public function isHostbased()
    {
        if (!isset($GLOBALS['FARMCORE'])) return false;
        return $GLOBALS['FARMCORE']->isHostbased();
    }

    /**
     * Was an animal requested that could not be found?
     *
     * @return bool
     */
    public function wasNotfound()
    {
        if (!isset($GLOBALS['FARMCORE'])) return false;
        return $GLOBALS['FARMCORE']->wasNotfound();
    }

    /**
     * Guess the URL for an animal
     *
     * @param $animal
     * @return string
     */
    public function getAnimalURL($animal)
    {
        $config = $this->getConfig();

        if (str_contains($animal, '.')) {
            return 'http://' . $animal;
        } elseif ($config['base']['basedomain']) {
            return 'http://' . $animal . '.' . $config['base']['basedomain'];
        } else {
            return DOKU_URL . '!' . $animal . '/';
        }
    }

    /**
     * List of all animals, i.e. directories within DOKU_FARMDIR without the template.
     *
     * @return array
     */
    public function getAllAnimals()
    {
        $animals = [];
        $list = glob(DOKU_FARMDIR . '*/conf/', GLOB_ONLYDIR);
        foreach ($list as $path) {
            $animal = basename(dirname($path));
            if ($animal == '_animal') continue; // old template
            $animals[] = $animal;
        }
        sort($animals);
        return $animals;
    }

    /**
     * checks wether $path is in under $container
     *
     * Also returns false if $path and $container are the same directory
     *
     * @param string $path
     * @param string $container
     * @return bool
     */
    public function isInPath($path, $container)
    {
        $path = fullpath($path) . '/';
        $container = fullpath($container) . '/';
        if ($path === $container) return false;
        return (str_starts_with($path, $container));
    }

    /**
     * Check if the farm is correctly configured for this farmer plugin
     *
     * @return bool
     */
    public function checkFarmSetup()
    {
        return defined('DOKU_FARMDIR') && isset($GLOBALS['FARMCORE']);
    }

    /**
     * @param string $animalname
     *
     * @return bool
     */
    public function validateAnimalName($animalname)
    {
        return preg_match("/^[a-z0-9]+([\\.\\-][a-z0-9]+)*$/i", $animalname) === 1;
    }

    /**
     * Copy a file, or recursively copy a folder and its contents. Adapted for DokuWiki.
     *
     * @todo: needs tests
     *
     * @author      Aidan Lister <aidan@php.net>
     * @author      Michael Große <grosse@cosmocode.de>
     * @author      Andreas Gohr <gohr@cosmocode.de>
     * @link        http://aidanlister.com/2004/04/recursively-copying-directories-in-php/
     *
     * @param string $source Source path
     * @param string $destination Destination path
     * @param string $exclude Regular expression to exclude files or directories (complete with delimiters)
     * @return bool Returns TRUE on success, FALSE on failure
     */
    public function copyDir($source, $destination, $exclude = '')
    {
        if ($exclude && preg_match($exclude, $source)) {
            return true;
        }

        if (is_link($source)) {
            io_lock($destination);
            $result = symlink(readlink($source), $destination);
            io_unlock($destination);
            return $result;
        }

        if (is_file($source)) {
            io_lock($destination);
            $result = copy($source, $destination);
            io_unlock($destination);
            return $result;
        }

        if (!is_dir($destination)) {
            io_mkdir_p($destination);
        }

        $dir = @dir($source);
        if ($dir === false) return false;
        while (false !== ($entry = $dir->read())) {
            if ($entry == '.' || $entry == '..') {
                continue;
            }

            // recurse into directories
            $this->copyDir("$source/$entry", "$destination/$entry", $exclude);
        }

        $dir->close();
        return true;
    }

    /**
     * get a list of all Plugins installed in the farmer wiki, regardless whether they are active or not.
     *
     * @param bool $all get all plugins, even disabled ones
     * @return array
     */
    public function getAllPlugins($all = true)
    {

        /** @var Doku_Plugin_Controller $plugin_controller */
        global $plugin_controller;

        $plugins = $plugin_controller->getList('', $all);

        // filter out a few plugins
        $plugins = array_filter(
            $plugins,
            function ($item) {
                if ($item == 'farmer') return false;
                if ($item == 'extension') return false;
                if ($item == 'upgrade') return false;
                if ($item == 'testing') return false;
                return true;
            }
        );

        sort($plugins);
        return $plugins;
    }

    /**
     * Get the plugin states configured locally in the given animal
     *
     * Response is cached
     *
     * @param $animal
     * @return array
     */
    public function getAnimalPluginLocalStates($animal)
    {
        if (isset($this->animalPluginState[$animal])) return $this->animalPluginState[$animal];

        $localfile = DOKU_FARMDIR . $animal . '/conf/plugins.local.php';
        $plugins = [];
        if (file_exists($localfile)) {
            include($localfile);
        }

        $this->animalPluginState[$animal] = $plugins;
        return $plugins;
    }

    /**
     * Return the default state plugins would have in animals
     *
     * Response is cached
     *
     * @return array
     */
    public function getDefaultPluginStates()
    {
        if (!is_null($this->defaultPluginState)) return $this->defaultPluginState;

        $farmconf = $this->getConfig();
        $all = $this->getAllPlugins();

        $plugins = [];
        foreach ($all as $one) {
            if ($farmconf['inherit']['plugins']) {
                $plugins[$one] = !plugin_isdisabled($one);
            } else {
                $plugins[$one] = true; // default state is enabled
            }
        }

        ksort($plugins);
        $this->defaultPluginState = $plugins;
        return $plugins;
    }

    /**
     * Return a structure giving detailed info about the state of all plugins in an animal
     *
     * @param $animal
     * @return array
     */
    public function getAnimalPluginRealState($animal)
    {
        $info = [];

        $defaults = $this->getDefaultPluginStates();
        $local = $this->getAnimalPluginLocalStates($animal);

        foreach ($defaults as $plugin => $set) {
            $current = ['name' => $plugin, 'default' => $set, 'actual' => $set, 'isdefault' => true];

            if (isset($local[$plugin])) {
                $current['actual'] = (bool) $local[$plugin];
                $current['isdefault'] = false;
            }

            $info[$plugin] = $current;
        }

        ksort($info);
        return $info;
    }

    /**
     * Set the state of a plugin in an animal
     *
     * @param string $plugin
     * @param string $animal
     * @param int $state -1 = default, 1 = enabled, 0 = disabled
     */
    public function setPluginState($plugin, $animal, $state)
    {
        $state = (int) $state;

        $plugins = $this->getAnimalPluginLocalStates($animal);
        if ($state < 0) {
            if (isset($plugins[$plugin])) unset($plugins[$plugin]);
        } else {
            $plugins[$plugin] = $state;
        }

        $this->writePluginConf($plugins, $animal);

        // clear state cache
        if (isset($this->animalPluginState[$animal])) unset($this->animalPluginState[$animal]);
    }

    /**
     * Write the list of (deactivated) plugins as plugin configuration of an animal to file
     *
     * updates the plugin state cache
     *
     * @param array $plugins associative array with the key being the plugin name and the value 0 or 1
     * @param string $animal Directory of the animal within DOKU_FARMDIR
     */
    public function writePluginConf($plugins, $animal)
    {
        $pluginConf = '<?php' . "\n# plugins enabled and disabled by the farmer plugin\n";
        foreach ($plugins as $plugin => $status) {
            $pluginConf .= '$plugins[\'' . $plugin . '\'] = ' . $status . ";\n";
        }
        io_saveFile(DOKU_FARMDIR . $animal . '/conf/plugins.local.php', $pluginConf);
        touch(DOKU_FARMDIR . $animal . '/conf/local.php');

        if (function_exists('opcache_invalidate')) {
            opcache_invalidate(DOKU_FARMDIR . $animal . '/conf/plugins.local.php');
            opcache_invalidate(DOKU_FARMDIR . $animal . '/conf/local.php');
        }

        $this->animalPluginState[$animal] = $plugins;
    }
}