Xoops\Core\Database\Connection

Complexity

Total Complexity

33

Size/Duplication

Total Lines	348
Duplicated Lines	5.46 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

53.13%

Importance

Changes	4
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	setSafe()	0	4	1
A	getSafe()	0	4	1
A	setForce()	0	4	1
A	getForce()	0	4	1
A	__construct()	0	19	2
A	prefix()	0	9	2
A	insertPrefix()	0	5	1
A	updatePrefix()	0	5	1
A	deletePrefix()	0	5	1
A	executeQuery()	0	8	1
B	executeUpdate()	0	27	6
A	beginTransaction()	0	5	1
A	commit()	0	6	1
A	rollBack()	0	6	1
C	query()	4	27	7
A	queryFromFile()	15	15	4
A	createXoopsQueryBuilder()	0	4	1

<?php
/**
 * 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.
 */

namespace Xoops\Core\Database;

use Doctrine\DBAL\Configuration;
use Doctrine\DBAL\Driver;
use Doctrine\DBAL\Cache\QueryCacheProfile;
use Doctrine\Common\EventManager;

/**
 * Connection wrapper for Doctrine DBAL Connection
 *
 * @category  Xoops\Core\Database\Connection
 * @package   Connection
 * @author    readheadedrod <redheadedrod@hotmail.com>
 * @author    Richard Griffith <richard@geekwright.com>
 * @copyright 2013-2015 XOOPS Project (http://xoops.org)
 * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @version   Release: 2.6
 * @link      http://xoops.org
 * @since     2.6.0
 */
class Connection extends \Doctrine\DBAL\Connection
{
    /**
     * @var bool $safe true means it is safe to write to database
     * removed allowedWebChanges as unnecessary. Using this instead.
     */
    protected $safe;


    /**
     * @var bool $force true means force writing to database even if safe is not true.
     */
    protected $force;

    /**
     * @var bool $transactionActive true means a transaction is in process.
     */
    protected $transactionActive;


    /**
     * this is a public setter for the safe variable
     *
     * @param bool $safe set safe to true if safe to write data to database
     *
     * @return void
     */
    public function setSafe($safe = true)
    {
        $this->safe = (bool)$safe;
    }

    /**
     * this is a public getter for the safe variable
     *
     * @return boolean
     */
    public function getSafe()
    {
        return $this->safe;
    }

    /**
     * this is a public setter for the $force variable
     *
     * @param bool $force when true will force a write to database when safe is false.
     *
     * @return void
     */
    public function setForce($force = false)
    {
        $this->force = (bool) $force;
    }

    /**
     * this is a public getter for the $force variable
     *
     * @return boolean
     */
    public function getForce()
    {
        return $this->force;
    }

    /**
     * Initializes a new instance of the Connection class.
     *
     * This sets up necessary variables before calling parent constructor
     *
     * @param array         $params       Parameters for the driver
     * @param Driver        $driver       The driver to use
     * @param Configuration $config       The connection configuration
     * @param EventManager  $eventManager Event manager to use
     */
    public function __construct(
        array $params,
        Driver $driver,
        Configuration $config = null,
        EventManager $eventManager = null
    ) {
        $this->safe = false;
        $this->force = false;
        $this->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.
            //\Xoops::getInstance()->events()->triggerEvent('core.exception', $e);
            trigger_error("Cannot get database connection", E_USER_ERROR);
        }
    }

    /**
     * Prepend the prefix.'_' to the given tablename
     * If tablename is empty, just return the prefix.
     *
     * @param string $tablename tablename
     *
     * @return string prefixed tablename, or prefix if tablename is empty
     */
    public function prefix($tablename = '')
    {
        $prefix = \XoopsBaseConfig::get('db-prefix');
        if ($tablename != '') {
            return $prefix . '_' . $tablename;
        } else {
            return $prefix;
        }
    }

    /**
     * Inserts a table row with specified data.
     *
     * Adds prefix to the name of the table then passes to normal function.
     *
     * @param string $tableName The name of the table to insert data into.
     * @param array  $data      An associative array containing column-value pairs.
     * @param array  $types     Types of the inserted data.
     *
     * @return integer The number of affected rows.
     */
    public function insertPrefix($tableName, array $data, array $types = array())
    {
        $tableName = $this->prefix($tableName);
        return $this->insert($tableName, $data, $types);
    }


    /**
     * Executes an SQL UPDATE statement on a table.
     *
     * Adds prefix to the name of the table then passes to normal function.
     *
     * @param string $tableName  The name of the table to update.
     * @param array  $data       The data to update
     * @param array  $identifier The update criteria.
     * An associative array containing column-value pairs.
     * @param array  $types      Types of the merged $data and
     * $identifier arrays in that order.
     *
     * @return integer The number of affected rows.
     */
    public function updatePrefix($tableName, array $data, array $identifier, array $types = array())
    {
        $tableName = $this->prefix($tableName);
        return $this->update($tableName, $data, $identifier, $types);
    }

    /**
     * Executes an SQL DELETE statement on a table.
     *
     * Adds prefix to the name of the table then passes to delete function.
     *
     * @param string $tableName  The name of the table on which to delete.
     * @param array  $identifier The deletion criteria.
     * An associative array containing column-value pairs.
     *
     * @return integer The number of affected rows.
     *
     */
    public function deletePrefix($tableName, array $identifier)
    {
        $tableName = $this->prefix($tableName);
        return $this->delete($tableName, $identifier);
    }

    /**
     * Executes an, optionally parametrized, SQL query.
     *
     * If the query is parametrized, a prepared statement is used.
     * If an SQLLogger is configured, the execution is logged.
     *
     * @param string            $query  The SQL query to execute.
     * @param array             $params The parameters to bind to the query, if any.
     * @param array             $types  The types the previous parameters are in.
     * @param QueryCacheProfile $qcp    The query Cache profile
     *
     * @return \Doctrine\DBAL\Driver\Statement The executed statement.
     *
     * @internal PERF: Directly prepares a driver statement, not a wrapper.
     */
    public function executeQuery(
        $query,
        array $params = array(),
        $types = array(),
        QueryCacheProfile $qcp = null
    ) {
        return parent::executeQuery($query, $params, $types, $qcp);
    }

    /**
     * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
     * and returns the number of affected rows.
     *
     * This method supports PDO binding types as well as DBAL mapping types.
     *
     * This over ridding process checks to make sure it is safe to do these.
     * If force is active then it will over ride the safe setting.
     *
     * @param string $query  The SQL query.
     * @param array  $params The query parameters.
     * @param array  $types  The parameter types.
     *
     * @return integer The number of affected rows.
     *
     * @internal PERF: Directly prepares a driver statement, not a wrapper.
     *
     * @todo build a better exception catching system.
     */
    public function executeUpdate($query, array $params = array(), array $types = array())
    {
        $events = \Xoops::getInstance()->events();
        if ($this->safe || $this->force) {
            if (!$this->transactionActive) {
                $this->force = false;
            };
            $events->triggerEvent('core.database.query.start');
            try {
                $result = parent::executeUpdate($query, $params, $types);
            } catch (\Exception $e) {
                $events->triggerEvent('core.exception', $e);
                $result = 0;
            }
            $events->triggerEvent('core.database.query.end');
        } else {
            //$events->triggerEvent('core.database.query.failure', (array('Not safe:')));
            return (int) 0;
        }
        if ($result != 0) {
            //$events->triggerEvent('core.database.query.success', (array($query)));
            return (int) $result;
        } else {
            //$events->triggerEvent('core.database.query.failure', (array($query)));
            return (int) 0;
        }
    }

    /**
     * Starts a transaction by suspending auto-commit mode.
     *
     * @return void
     */
    public function beginTransaction()
    {
        $this->transactionActive = true;
        parent::beginTransaction();
    }

    /**
     * Commits the current transaction.
     *
     * @return void
     */
    public function commit()
    {
        $this->transactionActive = false;
        $this->force = false;
        parent::commit();
    }

    /**
     * rolls back the current transaction.
     *
     * @return void
     */
    public function rollBack()
    {
        $this->transactionActive = false;
        $this->force = false;
        parent::rollBack();
    }

    /**
     * perform a safe query if allowed
     * can receive variable number of arguments
     *
     * @return mixed returns the value received or null if nothing received.
     *
     * @todo add error report for using non select while not safe.
     * @todo need to check if doctrine allows more than one query to be sent.
     * This code assumes only one query is sent and anything else sent is not
     * a query. This will have to be readdressed if this is wrong.
     *
     */
    public function query()
    {
        $events = \Xoops::getInstance()->events();
        if (!$this->safe && !$this->force) {
            $sql = ltrim(func_get_arg(0));
            if (!$this->safe && strtolower(substr($sql, 0, 6)) !== 'select') {
                // $events->triggerEvent('core.database.query.failure', (array('Not safe:')));
                return null;
            }
        }
        $this->force = false; // resets $force back to false
        $events->triggerEvent('core.database.query.start');
        try {
            $result = call_user_func_array(array('parent', 'query'), func_get_args());
        } catch (\Exception $e) {
            $events->triggerEvent('core.exception', $e);
            $result=null;
        }
        $events->triggerEvent('core.database.query.end');
        if ($result) {
            //$events->triggerEvent('core.database.query.success', (array('')));
            return $result;
        } else {
            //$events->triggerEvent('core.database.query.failure', (array('')));
            return null;
        }
    }

    /**
     * perform queries from SQL dump file in a batch
     *
     * @param string $file file path to an SQL dump file
     *
     * @return bool FALSE if failed reading SQL file or
     * TRUE if the file has been read and queries executed
     */
    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;
    }

    /**
     * Create a new instance of a SQL query builder.
     *
     * @return QueryBuilder
     */
    public function createXoopsQueryBuilder()
    {
        return new QueryBuilder($this);
    }
}