xref: /plugin/struct/helper/db.php (revision cdd16494506329e45f6f88b0a97dcfe7eec0f612)

<?php

/**
 * DokuWiki Plugin struct (Helper Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  Andreas Gohr, Michael Große <dokuwiki@cosmocode.de>
 */

use dokuwiki\Extension\Plugin;
use dokuwiki\ErrorHandler;
use dokuwiki\plugin\sqlite\SQLiteDB;
use dokuwiki\plugin\struct\meta\StructException;

class helper_plugin_struct_db extends Plugin
{
    /** @var SQLiteDB */
    protected $sqlite;

    /**
     * Initialize the database
     *
     * @throws Exception
     */
    protected function init()
    {
        $this->sqlite = new SQLiteDB('struct', DOKU_PLUGIN . 'struct/db/');

        // register our JSON function with variable parameters
        $this->sqlite->getPdo()->sqliteCreateFunction('STRUCT_JSON', [$this, 'STRUCT_JSON'], -1);

        // register our JSON decode function with variable parameters
        $this->sqlite->getPdo()->sqliteCreateFunction('STRUCT_LOOKUP', [$this, 'STRUCT_LOOKUP'], -1);

        // this function is meant to be overwritten by plugins
        $this->sqlite->getPdo()->sqliteCreateFunction('IS_PUBLISHER', [$this, 'IS_PUBLISHER'], -1);
    }

    /**
     * @param bool $throw throw an Exception when sqlite not available or fails to load
     * @return SQLiteDB|null
     * @throws Exception
     */
    public function getDB($throw = true)
    {
        if (!$this->sqlite instanceof SQLiteDB) {
            if (!class_exists(SQLiteDB::class)) {
                if ($throw || defined('DOKU_UNITTEST')) throw new StructException('no sqlite');
                return null;
            }

            try {
                $this->init();
            } catch (\Exception $exception) {
                ErrorHandler::logException($exception);
                if ($throw) throw $exception;
                return null;
            }
        }
        return $this->sqlite;
    }

    /**
     * Completely remove the database and reinitialize it
     *
     * You do not want to call this except for testing!
     */
    public function resetDB()
    {
        if (!$this->sqlite) return;
        $file = $this->sqlite->getDbFile();
        if (!$file) return;
        unlink($file);
        clearstatcache(true, $file);
        $this->sqlite = null;
    }

    /**
     * Encodes all given arguments into a JSON encoded array
     *
     * @param string ...
     * @return string
     */
    public function STRUCT_JSON(...$args) // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
    {
        return json_encode($args, JSON_THROW_ON_ERROR);
    }

    /**
     * Decodes a struct JSON structure and returns the requested value
     *
     * @param ...$args
     * @return mixed|null
     */
    public function STRUCT_LOOKUP(...$args) // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
    {
        $json = $args[0];
        $field = $args[1];

        try {
            $vals = json_decode($json, true, 512, JSON_THROW_ON_ERROR);
        } catch (\JsonException $exception) {
            return null;
        }
        return $vals[$field];
    }

    /**
     * This dummy implementation can be overwritten by a plugin
     *
     * @return int
     */
    public function IS_PUBLISHER() // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
    {
        return 1;
    }
}

// vim:ts=4:sw=4:et: