summaryrefslogtreecommitdiffstats
path: root/application/libraries/Duser/Duser.php
blob: 0007fabd84ff8c330e4891e830305c3e186700d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<?php
/*
 * Copyright 2013 Florian "Bluewind" Pritz <bluewind@server-speed.net>
 *
 * Licensed under AGPLv3
 * (see COPYING for full license text)
 *
 */

abstract class Duser_Driver extends CI_Driver {

	// List of optional functions that are implemented
	//
	// Possible values are:
	//  - can_register_new_users (only supported with the DB driver!)
	//  - can_reset_password (only supported with the DB driver!)
	//  - can_change_email (only supported with the DB driver!)
	public $optional_functions = array();

	/*
	 * The returned array should contain the following keys:
	 *  - username string
	 *  - userid INT > 0
	 *
	 * @param username
	 * @param password
	 * @return mixed array on success, false on failure
	 */
	abstract public function login($username, $password);

	/*
	 * @param username
	 * @return boolean true is username exists, false otherwise
	 */
	public function username_exists($username) {
		return null;
	}

	/*
	 * @param userid
	 * @return string email address of the user
	 */
	public function get_email($userid) {
		return null;
	}
}

class Duser extends CI_Driver_Library {

	protected $_adapter = null;

	protected $valid_drivers = array(
		'db', 'ldap', 'fluxbb'
	);

	function __construct()
	{
		$CI =& get_instance();

		$this->_adapter = $CI->config->item("authentication_driver");
	}

	// require an optional function to be implemented
	public function require_implemented($function) {
		if (!$this->is_implemented($function)) {
			throw new \exceptions\PublicApiException("libraries/duser/optional-function-not-implemented", ""
				."Optional function '".$function."' not implemented in user adapter '".$this->_adapter."'. "
				."Requested functionally unavailable.");
		}
	}

	// check if an optional function is implemented
	public function is_implemented($function) {
		if (in_array($function, $this->{$this->_adapter}->optional_functions)) {
			return true;
		}

		return false;
	}

	public function login($username, $password)
	{
		$login_info = $this->{$this->_adapter}->login($username, $password);
		if ($login_info === false) {
			return false;
		}

		$CI =& get_instance();

		$CI->session->set_userdata(array(
			'logged_in' => true,
			'username' => $login_info["username"],
			'userid' => $login_info["userid"],
			'access_level' => 'full',
		));

		return true;
	}

	public function username_exists($username)
	{
		if ($username === false) {
			return false;
		}

		return $this->{$this->_adapter}->username_exists($username);
	}

	public function get_email($userid)
	{
		return $this->{$this->_adapter}->get_email($userid);
	}

	public function test_login_credentials($username, $password)
	{
		$login_info = $this->{$this->_adapter}->login($username, $password);

		if (isset($login_info['username']) && $login_info['username'] === $username) {
			return true;
		}

		return false;
	}
}