Issues in BaseConnection.php (develop) - Issues in develop - gamernetwork/yolk-database - Measure and Improve Code Quality continuously with Scrutinizer

Issues (42)

Security Analysis no request data

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

src/BaseConnection.php (13 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/*
 * This file is part of Yolk - Gamer Network's PHP Framework.
 *
 * Copyright (c) 2014 Gamer Network Ltd.
 * 
 * Distributed under the MIT License, a copy of which is available in the
 * LICENSE file that was bundled with this package, or online at:
 * https://github.com/gamernetwork/yolk-database
 */

namespace yolk\database;

use yolk\contracts\database\DatabaseConnection;
use yolk\contracts\profiler\ProfilerAwareTrait;
use yolk\contracts\profiler\ProfilerAware;
use yolk\contracts\support\Dumpable;

use yolk\database\exceptions\DatabaseException;
use yolk\database\exceptions\ConnectionException;
use yolk\database\exceptions\NotConnectedException;
use yolk\database\exceptions\QueryException;
use yolk\database\exceptions\TransactionException;

/**
 * A wrapper for PDO that provides some handy extra functions and streamlines everything else.
 */
abstract class BaseConnection implements DatabaseConnection, ProfilerAware, Dumpable {

	use ProfilerAwareTrait;

	/**
	 * Connection details.
	 * @var DSN
	 */
	protected $dsn = null;

	/**
	 * Underlying PDO object.
	 * @var \PDO
	 */
	protected $pdo = null;

	/**
	 * Prepared statement cache.
	 * @var array
	 */
	protected $statements = [];

	/**
	 * Create a new database connection.
	 *
	 * @param DSN $dsn a DSN instance describing the database connection details
	 */
	public function __construct( DSN $dsn ) {

		$this->dsn = $dsn;

		// check for PDO extension
		if( !extension_loaded('pdo') )
			throw new DatabaseException('The PDO extension is required but the extension is not loaded');

		// check the PDO driver is available
		elseif( !in_array($this->dsn->type, \PDO::getAvailableDrivers()) )
			throw new DatabaseException("The {$this->dsn->type} PDO driver is not currently installed");

	}

	public function connect() {

		if( $this->pdo instanceof \PDO )
			return true;

		try {

			$this->pdo = new \PDO(
				$this->dsn->getConnectionString(),
				$this->dsn->user,
				$this->dsn->pass,
				$this->dsn->options
			);

			$this->pdo->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_ASSOC);
			$this->pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);           // always use exceptions

			$this->setCharacterSet(
				$this->getOption('charset', 'UTF8'),
				$this->getOption('collation')
			);

		}
		catch( \PDOException $e ) {
			throw new ConnectionException($e->getMessage(), $e->getCode(), $e);
		}

		return true;

	}

	public function disconnect() {
		$this->pdo = null;
		return true;
	}

	public function isConnected() {
		return $this->pdo instanceof \PDO;
	}

	public function select() {
		return new query\Select($this);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	public function insert() {
		return new query\Insert($this);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	public function update() {
		return new query\Update($this);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	public function replace() {
		return new query\Replace($this);
	}

	public function delete() {
		return new query\Delete($this);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	public function prepare( $statement ) {

		if( ! $statement instanceof \PDOStatement  ) {

			$this->connect();

			$statement = trim($statement);

			if( !isset($this->statements[$statement]) )
				$this->statements[$statement] = $this->pdo->prepare($statement);

			$statement = $this->statements[$statement];

		}

		return $statement;

	}

	public function query( $statement, $params = [] ) {

		$this->connect();

		// TODO: profiler start
		$this->profiler && $this->profiler->start('Query');

		try {

			$statement = $this->prepare($statement);

			// single parameters don't have to be passed in an array - do that here
			if( !is_array($params) )
				$params = array($params);

			$this->bindParams($statement, $params);

			$start = microtime(true);
			$statement->execute();
			$duration = microtime(true) - $start;
			
		}
		catch( \PDOException $e ) {
			throw new QueryException($e->getMessage(), $e->getCode(), $e);
		}

		// TODO: profiler stop + record
		if( $this->profiler ) {
			$this->profiler->stop('Query');
			// remove all whitespace at start of lines
			$this->profiler->query(preg_replace("/^\s*/m", "", trim($statement->queryString)), $params, $duration);
		}

		return $statement;

	}

	public function execute( $statement, $params = [] ) {
		$statement = $this->query($statement, $params);
		return $statement->rowCount();
	}

	public function getAll( $statement, $params = [], $expires = 0, $key = '' ) {

		return $this->getResult(
			$statement,
			$params,
			$expires,
			$key,
			function( \PDOStatement $statement ) {
				$result = $statement->fetchAll();
				if( $result === false )
					$result = [];
				return $result;
			}
		);
	}

	public function getAssoc( $statement, $params = [], $expires = 0, $key = '' ) {
		return $this->getResult(
			$statement,
			$params,
			$expires,
			$key,
			function( \PDOStatement $statement ) {
				$result = [];
				while( $row = $statement->fetch() ) {
					$key = array_shift($row);
					$result[$key] = count($row) == 1 ? array_shift($row) : $row;
				}
				return $result;
			}
		);
	}

	public function getAssocMulti( $statement, $params = [], $expires = 0, $key = '' ) {
		return $this->getResult(
			$statement,
			$params,
			$expires,
			$key,
			function( \PDOStatement $statement ) {
				$result = [];
				while( $row = $statement->fetch() ) {
					$k1 = array_shift($row);
					$k2 = array_shift($row);
					$v  = count($row) == 1 ? array_shift($row) : $row;
					if( !isset($result[$k1]) )
						$result[$k1] = [];
					$result[$k1][$k2] = $v;
				}
				return $result;
			}
		);
	}

	public function getRow( $statement, $params = [], $expires = 0, $key = '' ) {

		return $this->getResult(
			$statement,
			$params,
			$expires,
			$key,
			function( \PDOStatement $statement ) {
				$result = $statement->fetch();
				if( $result === false )
					$result = [];
				return $result;
			}
		);
	}

	public function getCol( $statement, $params = [], $expires = 0, $key = '' ) {

		return $this->getResult(
			$statement,
			$params,
			$expires,
			$key,
			function( \PDOStatement $statement ) {
				$result = [];
				while( $row = $statement->fetch() ) {
					$result[] = array_shift($row);
				}
				return $result;
			}
		);
	}

	public function getOne( $statement, $params = [], $expires = 0, $key = '' ) {

		return $this->getResult(
			$statement,
			$params,
			$expires,
			$key,
			function( \PDOStatement $statement ) {
				$result = $statement->fetchColumn();
				if( $result === false )
					$result = null;
				return $result;
			}
		);
	}

	public function begin() {

		$this->connect();

		try {
			return $this->pdo->beginTransaction();
		}
		catch( \PDOException $e ) {
			throw new TransactionException($e->getMessage(), $e->getCode(), $e);
		}

	}

	public function commit() {


		if( !$this->isConnected() )
			throw new NotConnectedException();

		try {
			return $this->pdo->commit();
		}
		catch( \PDOException $e ) {
			throw new TransactionException($e->getMessage(), $e->getCode(), $e);
		}

	}

	public function rollback() {


		if( !$this->isConnected() )
			throw new NotConnectedException();

		try {
			return $this->pdo->rollBack();
		}
		catch( \PDOException $e ) {
			throw new TransactionException($e->getMessage(), $e->getCode(), $e);
		}

	}

	public function inTransaction() {
		return $this->isConnected() ? $this->pdo->inTransaction() : false;
	}

	public function insertId( $name = '' ) {
		if( !$this->isConnected() )
			throw new NotConnectedException();
		return $this->pdo->lastInsertId($name);
	}

	public function quote( $value, $type = \PDO::PARAM_STR ) {
		$this->connect();
		return $this->pdo->quote($value, $type);
	}

	public function quoteIdentifier( $name ) {

		$name = trim($name);

        if( $name == '*' )
            return $name;

		// ANSI-SQL (everything else) says to use double quotes to quote identifiers
        $char = '"';

		// MySQL uses backticks cos it's special
		if( $this->dsn->isMySQL() )
        	$char = '`';

		return $char. $name. $char;

	}

	/**
	 * Execute a raw SQL string and return the number of affected rows.
	 * Primarily used for DDL queries. Do not use this with:
	 * - Anything (data/parameters/etc) that comes from userland
	 * - Select queries - the answer will always be 0 as no rows are affected.
	 * - Everyday queries - use query() or execute()
	 * @param  string $sql  the SQL statement to exexcute
	 * @return integer   the number of rows affected by the statement
	 */
	public function rawExec( $sql ) {

		$this->connect();

		try {
			return $this->pdo->exec($sql);
		}
		catch( \PDOException $e ) {
			throw new QueryException($e->getMessage(), $e->getCode(), $e);
		}

	}

	public function dump( $dumper = '\\yolk\\debug\\TextDumper', $depth = 1 ) {
		if( $depth > 1 )
			return $this->dsn->toString();
	}

	/**
	 * Bind named and positional parameters to a PDOStatement.
	 * @param  PDOStatement $statement
	 * @param  array        $params
	 * @return void
	 */
	protected function bindParams( \PDOStatement $statement, array $params ) {
		foreach( $params as $name => $value ) {

			if( is_int($value) ) {
				$type = \PDO::PARAM_INT;
			}
			else {
				$type = \PDO::PARAM_STR;
			}

			// handle positional (?) and named (:name) parameters

			$name = is_numeric($name) ? (int) $name + 1 : ":{$name}";

			$statement->bindValue($name, $value, $type);

		}
	}

	/**
	 * Perform a select query and use a callback to extract a result.
	 * @param  \PDOStatement|string $statement   an existing PDOStatement object or a SQL string.
	 * @param  array $params        an array of parameters to pass into the query.
	 * @param  integer $expires     number of seconds to cache the result for if caching is enabled
	 * @param  string  $key         cache key used to store the result
	 * @param  \Closure $callback   function to yield a result from the executed statement
	 * @return array
	 */
	protected function getResult( $statement, $params, $expires, $key, \Closure $callback ) {


		// TODO: check cache

		$statement = $this->query($statement, $params);

		$result = $callback($statement);

		// TODO: store in cache

		return $result;

	}

	protected function getOption( $option, $default = null ) {
		return isset($this->dsn->options[$option]) ? $this->dsn->options[$option] : $default;
	}

	/**
	 * Make sure the connection is using the correct character set
	 * 
	 * @param string $charset   the character set to use for the connection
	 * @param string $collation the collation method to use for the connection
	 * @return self
	 */
	protected function setCharacterSet( $charset, $collation = '' ) {

		if( !$charset ) 
			throw new DatabaseException('No character set specified');

		$sql = 'SET NAMES '. $this->pdo->quote($charset);

		if( $collation )
			$sql .= ' COLLATE '. $this->pdo->quote($collation);

		$this->pdo->exec($sql);

		return $this;

	}

}

// EOF

gamernetwork / yolk-database

Issues (42)

Security Analysis no request data

src/BaseConnection.php (13 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like