Connection.php

Go to the documentation of this file.

<?php
namespace Xoops\Core\Database;

class Connection extends \Doctrine\DBAL\Connection
{
    protected static $safe;


    protected static $force;

    protected static $transactionActive;


    public static function setSafe($safe = true)
    {
        if (is_bool($safe)) {
            self::$safe = $safe;
        }
    }

    public static function getSafe()
    {
        return self::$safe;
    }

    public static function setForce($force = false)
    {
        if (is_bool($force)) {
            self::$force = $force;
        }
    }

    public static function getForce()
    {
        return self::$force;
    }

    public function __construct(
        array $params,
        \Doctrine\DBAL\Driver $driver,
        \Doctrine\DBAL\Configuration $config = null,
        \Doctrine\Common\EventManager $eventManager = null
    ) {
        if (!defined('XOOPS_DB_PROXY') || ($_SERVER['REQUEST_METHOD'] != 'GET')) {
            self::setSafe(true);
        } else {
            self::setSafe(false);
        }
        self::setForce(false);
        self::$transactionActive = false;
        try {
            parent::__construct($params, $driver, $config, $eventManager);
        } catch (\Exception $e) {
            // We are dead in the water. This exception may contain very sensitive
            // information and cannot be allowed to be displayed as is.
            //$xoopsPreload->triggerEvent('core.exception', $e);
            trigger_error("Cannot get database connection", E_USER_ERROR);
        }

    }

    public static function prefix($tablename = '')
    {
        static $prefix;
        
        $prefix = \XoopsBaseConfig::get('db-prefix');
        if ($tablename != '') {
            return $prefix . '_' . $tablename;
        } else {
            return $prefix;
        }
    }

    public function insertPrefix($tableName, array $data, array $types = array())
    {
        $tableName = $this->prefix($tableName);
        return $this->insert($tableName, $data, $types);
    }


    public function updatePrefix($tableName, array $data, array $identifier, array $types = array())
    {
        $tableName = $this->prefix($tableName);
        return $this->update($tableName, $data, $identifier, $types);
    }

    public function deletePrefix($tableName, array $identifier)
    {
        $tableName = $this->prefix($tableName);
        return $this->delete($tableName, $identifier);
    }

    public function executeQuery(
        $query,
        array $params = array(),
        $types = array(),
        \Doctrine\DBAL\Cache\QueryCacheProfile $qcp = null
    ) {
        return parent::executeQuery($query, $params, $types, $qcp);
    }

    public function executeUpdate($query, array $params = array(), array $types = array())
    {
        $result = 0;
        $xoopsPreload = \Xoops::getInstance()->events();
        if (self::getSafe() || self::getForce()) {
            if (!self::$transactionActive) {
                self::setForce(false);
            };
            $xoopsPreload->triggerEvent('core.database.query.start');
            try {
                $result = parent::executeUpdate($query, $params, $types);
            } catch (\Exception $e) {
                $xoopsPreload->triggerEvent('core.exception', $e);
                $result = 0;
            }
            $xoopsPreload->triggerEvent('core.database.query.end');
        } else {
            //$xoopsPreload->triggerEvent('core.database.query.failure', (array('Not safe:')));
            return (int) 0;
        }
        if ($result != 0) {
            //$xoopsPreload->triggerEvent('core.database.query.success', (array($query)));
            return (int) $result;
        } else {
            //$xoopsPreload->triggerEvent('core.database.query.failure', (array($query)));
            return (int) 0;
        }
    }

    public function beginTransaction()
    {
        self::$transactionActive = true;
        parent::beginTransaction();
    }

    public function commit()
    {
        self::$transactionActive = false;
        self::setForce(false);
        parent::commit();
    }

    public function rollBack()
    {
        self::$transactionActive = false;
        self::setForce(false);
        parent::rollBack();
    }

    public function query()
    {
        $xoopsPreload = \Xoops::getInstance()->events();
        if (!self::getSafe() && !self::getForce()) {
            $sql = ltrim(func_get_arg(0));
            if (!self::getSafe() && strtolower(substr($sql, 0, 6))!= 'select') {
                // $xoopsPreload->triggerEvent('core.database.query.failure', (array('Not safe:')));
                return null;
            }
        }
        self::setForce(false); // resets $force back to false
        $xoopsPreload->triggerEvent('core.database.query.start');
        try {
            $result = call_user_func_array(array('parent', 'query'), func_get_args());
        } catch (\Exception $e) {
            $xoopsPreload->triggerEvent('core.exception', $e);
            $result=null;
        }
        $xoopsPreload->triggerEvent('core.database.query.end');
        if ($result) {
            //$xoopsPreload->triggerEvent('core.database.query.success', (array('')));
            return $result;
        } else {
            //$xoopsPreload->triggerEvent('core.database.query.failure', (array('')));
            return null;
        }
    }

    public function queryFromFile($file)
    {
        if (false !== ($fp = fopen($file, 'r'))) {
            $sql_queries = trim(fread($fp, filesize($file)));
            \SqlUtility::splitMySqlFile($pieces, $sql_queries);
            foreach ($pieces as $query) {
                $prefixed_query = \SqlUtility::prefixQuery(trim($query), $this->prefix());
                if ($prefixed_query != false) {
                    $this->query($prefixed_query[0]);
                }
            }
            return true;
        }
        return false;
    }

    public function quoteSlash($input)
    {
        return $this->quote($input);
    }


    public function createXoopsQueryBuilder()
    {
        return new QueryBuilder($this);
    }
}