WebSVN – Applications.papyrus – Diff – /trunk/api/pear/Auth/Container/Multiple.php


<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 foldmethod=marker: */
 
/**
 * Storage driver for using multiple storage drivers in a fall through fashion
 *
 * PHP versions 4 and 5
 *
 * LICENSE: This source file is subject to version 3.01 of the PHP license
 * that is available through the world-wide-web at the following URI:
 * http://www.php.net/license/3_01.txt.  If you did not receive a copy of
 * the PHP License and are unable to obtain it through the web, please
 * send a note to license@php.net so we can mail you a copy immediately.
 *
 * @category   Authentication
 * @package    Auth
 * @author     Adam Ashley <aashley@php.net>
 * @copyright  2001-2006 The PHP Group
 * @license    http://www.php.net/license/3_01.txt  PHP License 3.01
 * @version    CVS: $Id: Multiple.php,v 1.4 2007/06/12 03:11:26 aashley Exp $
 * @since      File available since Release 1.5.0
 */
 
/**
 * Include Auth_Container base class
 */
require_once "Auth/Container.php";
/**
 * Include PEAR package for error handling
 */
require_once "PEAR.php";
 
/**
 * Storage driver for using multiple storage drivers in a fall through fashion
 *
 * This storage driver provides a mechanism for working through multiple
 * storage drivers until either one allows successful login or the list is
 * exhausted.
 *
 * This container takes an array of options of the following form:
 *
 * array(
 *   array(
 *     'type'    => <standard container type name>,
 *     'options' => <normal array of options for container>,
 *   ),
 * );
 *
 * Full example:
 *
 * $options = array(
 *   array(
 *     'type'    => 'DB',
 *     'options' => array(
 *       'dsn' => "mysql://user:password@localhost/database",
 *     ),
 *   ),
 *   array(
 *     'type'    => 'Array',
 *     'options' => array(
 *       'cryptType' => 'md5',
 *       'users'     => array(
 *         'admin' => md5('password'),
 *       ),
 *     ),
 *   ),
 * );
 *
 * $auth = new Auth('Multiple', $options);
 *
 * @category   Authentication
 * @package    Auth
 * @author     Adam Ashley <aashley@php.net>
 * @copyright  2001-2006 The PHP Group
 * @license    http://www.php.net/license/3_01.txt  PHP License 3.01
 * @version    Release: 1.5.4  File: $Revision: 1.4 $
 * @since      File available since Release 1.5.0
 */
 
class Auth_Container_Multiple extends Auth_Container {
 
    // {{{ properties
 
    /**
     * The options for each container
     *
     * @var array $options
     */
    var $options = array();
 
    /**
     * The instanciated containers
     *
     * @var array $containers
     */
    var $containers = array();
 
    // }}}
    // {{{ Auth_Container_Multiple()
 
    /**
     * Constructor for Array Container
     *
     * @param array $data Options for the container
     * @return void
     */
    function Auth_Container_Multiple($options)
    {
        if (!is_array($options)) {
            PEAR::raiseError('The options for Auth_Container_Multiple must be an array');
        }
        if (count($options) < 1) {
            PEAR::raiseError('You must define at least one sub container to use in Auth_Container_Multiple');
        }
        foreach ($options as $option) {
            if (!isset($option['type'])) {
                PEAR::raiseError('No type defined for sub container');
            }
        }
        $this->options = $options;
    }
 
    // }}}
    // {{{ fetchData()
 
    /**
     * Get user information from array
     *
     * This function uses the given username to fetch the corresponding
     * login data from the array. If an account that matches the passed
     * username and password is found, the function returns true.
     * Otherwise it returns false.
     *
     * @param  string Username
     * @param  string Password
     * @return boolean|PEAR_Error Error object or boolean
     */
    function fetchData($user, $pass)
    {
        $this->log('Auth_Container_Multiple::fetchData() called.', AUTH_LOG_DEBUG);
 
        foreach ($this->options as $key => $options) {
 
            $this->log('Using Container '.$key.' of type '.$options['type'].'.', AUTH_LOG_DEBUG);
 
            if (isset($this->containers[$key]) && is_a($this->containers[$key], 'Auth_Container')) {
 
                $container = &$this->containers[$key];
 
            } else {
 
                $this->containers[$key] = &$this->_auth_obj->_factory($options['type'], $options['options']);
                $this->containers[$key]->_auth_obj = &$this->_auth_obj;
                $container = &$this->containers[$key];
 
            }
 
            $result = $container->fetchData($user, $pass);
 
            if (PEAR::isError($result)) {
 
                $this->log('Container '.$key.': '.$result->getMessage(), AUTH_LOG_ERR);
                return $result;
 
            } elseif ($result == true) {
 
                $this->log('Container '.$key.': Authentication successful.', AUTH_LOG_DEBUG);
                return true;
 
            } else {
 
                $this->log('Container '.$key.': Authentication failed.', AUTH_LOG_DEBUG);
 
            }
 
        }
 
        $this->log('Auth_Container_Multiple: All containers rejected user credentials.', AUTH_LOG_DEBUG);
 
        return false;
 
    }
 
    // }}}
 
}
 
?>

Rev 1713	Rev 2150
1	`<?php`	1	`<?php`
2	`/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 foldmethod=marker: */`	2	`/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 foldmethod=marker: */`
3		3
4	`/**`	4	`/**`
5	`* Storage driver for using multiple storage drivers in a fall through fashion`	5	`* Storage driver for using multiple storage drivers in a fall through fashion`
6	`*`	6	`*`
7	`* PHP versions 4 and 5`	7	`* PHP versions 4 and 5`
8	`*`	8	`*`
9	`* LICENSE: This source file is subject to version 3.01 of the PHP license`	9	`* LICENSE: This source file is subject to version 3.01 of the PHP license`
10	`* that is available through the world-wide-web at the following URI:`	10	`* that is available through the world-wide-web at the following URI:`
11	`* http://www.php.net/license/3_01.txt. If you did not receive a copy of`	11	`* http://www.php.net/license/3_01.txt. If you did not receive a copy of`
12	`* the PHP License and are unable to obtain it through the web, please`	12	`* the PHP License and are unable to obtain it through the web, please`
13	`* send a note to license@php.net so we can mail you a copy immediately.`	13	`* send a note to license@php.net so we can mail you a copy immediately.`
14	`*`	14	`*`
15	`* @category Authentication`	15	`* @category Authentication`
16	`* @package Auth`	16	`* @package Auth`
17	`* @author Adam Ashley <aashley@php.net>`	17	`* @author Adam Ashley <aashley@php.net>`
18	`* @copyright 2001-2006 The PHP Group`	18	`* @copyright 2001-2006 The PHP Group`
19	`* @license http://www.php.net/license/3_01.txt PHP License 3.01`	19	`* @license http://www.php.net/license/3_01.txt PHP License 3.01`
20	`* @version CVS: $Id: Multiple.php,v 1.2 2007-11-19 15:11:00 jp_milcent Exp $`	20	`* @version CVS: $Id: Multiple.php,v 1.4 2007/06/12 03:11:26 aashley Exp $`
21	`* @since File available since Release 1.5.0`	21	`* @since File available since Release 1.5.0`
22	`*/`	22	`*/`
23		23
24	`/**`	24	`/**`
25	`* Include Auth_Container base class`	25	`* Include Auth_Container base class`
26	`*/`	26	`*/`
27	`require_once "Auth/Container.php";`	27	`require_once "Auth/Container.php";`
28	`/**`	28	`/**`
29	`* Include PEAR package for error handling`	29	`* Include PEAR package for error handling`
30	`*/`	30	`*/`
31	`require_once "PEAR.php";`	31	`require_once "PEAR.php";`
32		32
33	`/**`	33	`/**`
34	`* Storage driver for using multiple storage drivers in a fall through fashion`	34	`* Storage driver for using multiple storage drivers in a fall through fashion`
35	`*`	35	`*`
36	`* This storage driver provides a mechanism for working through multiple`	36	`* This storage driver provides a mechanism for working through multiple`
37	`* storage drivers until either one allows successful login or the list is`	37	`* storage drivers until either one allows successful login or the list is`
38	`* exhausted.`	38	`* exhausted.`
39	`*`	39	`*`
40	`* This container takes an array of options of the following form:`	40	`* This container takes an array of options of the following form:`
41	`*`	41	`*`
42	`* array(`	42	`* array(`
43	`* array(`	43	`* array(`
44	`* 'type' => <standard container type name>,`	44	`* 'type' => <standard container type name>,`
45	`* 'options' => <normal array of options for container>,`	45	`* 'options' => <normal array of options for container>,`
46	`* ),`	46	`* ),`
47	`* );`	47	`* );`
48	`*`	48	`*`
49	`* Full example:`	49	`* Full example:`
50	`*`	50	`*`
51	`* $options = array(`	51	`* $options = array(`
52	`* array(`	52	`* array(`
53	`* 'type' => 'DB',`	53	`* 'type' => 'DB',`
54	`* 'options' => array(`	54	`* 'options' => array(`
55	`* 'dsn' => "mysql://user:password@localhost/database",`	55	`* 'dsn' => "mysql://user:password@localhost/database",`
56	`* ),`	56	`* ),`
57	`* ),`	57	`* ),`
58	`* array(`	58	`* array(`
59	`* 'type' => 'Array',`	59	`* 'type' => 'Array',`
60	`* 'options' => array(`	60	`* 'options' => array(`
61	`* 'cryptType' => 'md5',`	61	`* 'cryptType' => 'md5',`
62	`* 'users' => array(`	62	`* 'users' => array(`
63	`* 'admin' => md5('password'),`	63	`* 'admin' => md5('password'),`
64	`* ),`	64	`* ),`
65	`* ),`	65	`* ),`
66	`* ),`	66	`* ),`
67	`* );`	67	`* );`
68	`*`	68	`*`
69	`* $auth = new Auth('Multiple', $options);`	69	`* $auth = new Auth('Multiple', $options);`
70	`*`	70	`*`
71	`* @category Authentication`	71	`* @category Authentication`
72	`* @package Auth`	72	`* @package Auth`
73	`* @author Adam Ashley <aashley@php.net>`	73	`* @author Adam Ashley <aashley@php.net>`
74	`* @copyright 2001-2006 The PHP Group`	74	`* @copyright 2001-2006 The PHP Group`
75	`* @license http://www.php.net/license/3_01.txt PHP License 3.01`	75	`* @license http://www.php.net/license/3_01.txt PHP License 3.01`
76	`* @version Release: 1.5.4 File: $Revision: 1.2 $`	76	`* @version Release: 1.5.4 File: $Revision: 1.4 $`
77	`* @since File available since Release 1.5.0`	77	`* @since File available since Release 1.5.0`
78	`*/`	78	`*/`
79		79
80	`class Auth_Container_Multiple extends Auth_Container {`	80	`class Auth_Container_Multiple extends Auth_Container {`
81		81
82	`// {{{ properties`	82	`// {{{ properties`
83		83
84	`/**`	84	`/**`
85	`* The options for each container`	85	`* The options for each container`
86	`*`	86	`*`
87	`* @var array $options`	87	`* @var array $options`
88	`*/`	88	`*/`
89	`var $options = array();`	89	`var $options = array();`
90		90
91	`/**`	91	`/**`
92	`* The instanciated containers`	92	`* The instanciated containers`
93	`*`	93	`*`
94	`* @var array $containers`	94	`* @var array $containers`
95	`*/`	95	`*/`
96	`var $containers = array();`	96	`var $containers = array();`
97		97
98	`// }}}`	98	`// }}}`
99	`// {{{ Auth_Container_Multiple()`	99	`// {{{ Auth_Container_Multiple()`
100		100
101	`/**`	101	`/**`
102	`* Constructor for Array Container`	102	`* Constructor for Array Container`
103	`*`	103	`*`
104	`* @param array $data Options for the container`	104	`* @param array $data Options for the container`
105	`* @return void`	105	`* @return void`
106	`*/`	106	`*/`
107	`function Auth_Container_Multiple($options)`	107	`function Auth_Container_Multiple($options)`
108	`{`	108	`{`
109	`if (!is_array($options)) {`	109	`if (!is_array($options)) {`
110	`PEAR::raiseError('The options for Auth_Container_Multiple must be an array');`	110	`PEAR::raiseError('The options for Auth_Container_Multiple must be an array');`
111	`}`	111	`}`
112	`if (count($options) < 1) {`	112	`if (count($options) < 1) {`
113	`PEAR::raiseError('You must define at least one sub container to use in Auth_Container_Multiple');`	113	`PEAR::raiseError('You must define at least one sub container to use in Auth_Container_Multiple');`
114	`}`	114	`}`
115	`foreach ($options as $option) {`	115	`foreach ($options as $option) {`
116	`if (!isset($option['type'])) {`	116	`if (!isset($option['type'])) {`
117	`PEAR::raiseError('No type defined for sub container');`	117	`PEAR::raiseError('No type defined for sub container');`
118	`}`	118	`}`
119	`}`	119	`}`
120	`$this->options = $options;`	120	`$this->options = $options;`
121	`}`	121	`}`
122		122
123	`// }}}`	123	`// }}}`
124	`// {{{ fetchData()`	124	`// {{{ fetchData()`
125		125
126	`/**`	126	`/**`
127	`* Get user information from array`	127	`* Get user information from array`
128	`*`	128	`*`
129	`* This function uses the given username to fetch the corresponding`	129	`* This function uses the given username to fetch the corresponding`
130	`* login data from the array. If an account that matches the passed`	130	`* login data from the array. If an account that matches the passed`
131	`* username and password is found, the function returns true.`	131	`* username and password is found, the function returns true.`
132	`* Otherwise it returns false.`	132	`* Otherwise it returns false.`
133	`*`	133	`*`
134	`* @param string Username`	134	`* @param string Username`
135	`* @param string Password`	135	`* @param string Password`
136	`* @return boolean\|PEAR_Error Error object or boolean`	136	`* @return boolean\|PEAR_Error Error object or boolean`
137	`*/`	137	`*/`
138	`function fetchData($user, $pass)`	138	`function fetchData($user, $pass)`
139	`{`	139	`{`
140	`$this->log('Auth_Container_Multiple::fetchData() called.', AUTH_LOG_DEBUG);`	140	`$this->log('Auth_Container_Multiple::fetchData() called.', AUTH_LOG_DEBUG);`
141		141
142	`foreach ($this->options as $key => $options) {`	142	`foreach ($this->options as $key => $options) {`
143		143
144	`$this->log('Using Container '.$key.' of type '.$options['type'].'.', AUTH_LOG_DEBUG);`	144	`$this->log('Using Container '.$key.' of type '.$options['type'].'.', AUTH_LOG_DEBUG);`
145		145
146	`if (isset($this->containers[$key]) && is_a($this->containers[$key], 'Auth_Container')) {`	146	`if (isset($this->containers[$key]) && is_a($this->containers[$key], 'Auth_Container')) {`
147		147
148	`$container = &$this->containers[$key];`	148	`$container = &$this->containers[$key];`
149		149
150	`} else {`	150	`} else {`
151		151
152	`$this->containers[$key] = &$this->_auth_obj->_factory($options['type'], $options['options']);`	152	`$this->containers[$key] = &$this->_auth_obj->_factory($options['type'], $options['options']);`
153	`$this->containers[$key]->_auth_obj = &$this->_auth_obj;`	153	`$this->containers[$key]->_auth_obj = &$this->_auth_obj;`
154	`$container = &$this->containers[$key];`	154	`$container = &$this->containers[$key];`
155		155
156	`}`	156	`}`
157		157
158	`$result = $container->fetchData($user, $pass);`	158	`$result = $container->fetchData($user, $pass);`
159		159
160	`if (PEAR::isError($result)) {`	160	`if (PEAR::isError($result)) {`
161		161
162	`$this->log('Container '.$key.': '.$result->getMessage(), AUTH_LOG_ERR);`	162	`$this->log('Container '.$key.': '.$result->getMessage(), AUTH_LOG_ERR);`
163	`return $result;`	163	`return $result;`
164		164
165	`} elseif ($result == true) {`	165	`} elseif ($result == true) {`
166		166
167	`$this->log('Container '.$key.': Authentication successful.', AUTH_LOG_DEBUG);`	167	`$this->log('Container '.$key.': Authentication successful.', AUTH_LOG_DEBUG);`
168	`return true;`	168	`return true;`
169		169
170	`} else {`	170	`} else {`
171		171
172	`$this->log('Container '.$key.': Authentication failed.', AUTH_LOG_DEBUG);`	172	`$this->log('Container '.$key.': Authentication failed.', AUTH_LOG_DEBUG);`
173		173
174	`}`	174	`}`
175		175
176	`}`	176	`}`
177		177
178	`$this->log('Auth_Container_Multiple: All containers rejected user credentials.', AUTH_LOG_DEBUG);`	178	`$this->log('Auth_Container_Multiple: All containers rejected user credentials.', AUTH_LOG_DEBUG);`
179		179
180	`return false;`	180	`return false;`
181		181
182	`}`	182	`}`
183		183
184	`// }}}`	184	`// }}}`
185		185
186	`}`	186	`}`
187		187
188	`?>`	188	`?>`

Subversion Repositories Applications.papyrus

(root)/trunk/api/pear/Auth/Container/Multiple.php – Rev 1713 → 2150