Tiqr_UserSecretStorage_Pdo

Complexity

Total Complexity

10

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

66.67%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	userExists()	0	8	2
A	log()	0	5	1
A	getUserSecret()	0	7	2
A	__construct()	0	16	2
A	setUserSecret()	0	9	3

<?php
/**
 * This file is part of the tiqr project.
 * 
 * The tiqr project aims to provide an open implementation for 
 * authentication using mobile devices. It was initiated by 
 * SURFnet and developed by Egeniq.
 *
 * More information: http://www.tiqr.org
 *
 * @author Patrick Honing <Patrick.Honing@han.nl>
 * 
 * @package tiqr
 *
 * @license New BSD License - See LICENSE file for details.
 *
 * @copyright (C) 2010-2012 SURFnet BV
 * 
 * Create SQL table (MySQL):
 * CREATE TABLE `tiqrusersecret` (`userid` varchar(10) PRIMARY KEY, `secret` varchar(100))
 * 
 */

require_once 'Tiqr/UserSecretStorage/UserSecretStorageTrait.php';

use Psr\Log\LoggerInterface;

/**
 * This user storage implementation implements a user secret storage using PDO.
 * It is usable for any database with a PDO driver
 * 
 * @author Patrick Honing <Patrick.Honing@han.nl>
 */
class Tiqr_UserSecretStorage_Pdo implements Tiqr_UserSecretStorage_Interface
{
    use UserSecretStorageTrait;

    private $tableName;

    private $handle;

    /**
     * Construct a user class
     *
     * @param array $config The configuration that a specific user class may use.
     */
    public function __construct(
        Tiqr_UserSecretStorage_Encryption_Interface $encryption,
        LoggerInterface $logger,
        string $dsn,
        string $userName,
        string $password,
        string $tableName = 'tiqrusersecret'
    ) {
        $this->encryption = $encryption;
        $this->logger = $logger;

The property logger does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->tableName = $tableName;
        try {
            $this->handle = new PDO($dsn, $userName, $password);
        } catch (PDOException $e) {
            $this->logger->error(
                sprintf('Unable to establish a PDO connection. Error message from PDO: %s', $e->getMessage())
            );
        }
    }
    private function userExists($userId)
    {
        $sth = $this->handle->prepare("SELECT userid FROM ".$this->tableName." WHERE userid = ?");
        if ($sth->execute(array($userId))) {
            return true;
        }
        $this->logger->debug('Unable fot find user in user secret storage (PDO)');
        return false;
    }

    /**
     * Get the user's secret
     *
     * @param String $userId
     *
     * @return String The user's secret
     */
    private function getUserSecret($userId)

The method getUserSecret() is not used, and could be removed.

    {
        $sth = $this->handle->prepare("SELECT secret FROM ".$this->tableName." WHERE userid = ?");
        if($sth->execute(array($userId))) {
            return $sth->fetchColumn();
        }
        $this->logger->error('Unable to retrieve user secret from user secret storage (PDO)');
    }

    /**
     * Store a secret for a user.
     *
     * @param String $userId
     * @param String $secret
     */
    private function setUserSecret($userId, $secret)

The method setUserSecret() is not used, and could be removed.

    {
        if ($this->userExists($userId)) {
            $sth = $this->handle->prepare("UPDATE ".$this->tableName." SET secret = ? WHERE userid = ?");
        } else {
            $sth = $this->handle->prepare("INSERT INTO ".$this->tableName." (secret,userid) VALUES (?,?)");
        }
        if (!$sth->execute(array($secret,$userId))) {
            $this->logger->error('Unable to persist user secret in user secret storage (PDO)');
        }
    }

    /**
     * @deprecated this log method was probably a dev left-over.
     */
    public static function log($message)
    {
        $fp = fopen('/var/www/tiqr/logs/'.date("Ymd").'.log', 'a');
        fwrite($fp, $message);
        fclose($fp);
    }
}