-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
BaseAuthorize.php
175 lines (163 loc) · 5.08 KB
/
BaseAuthorize.php
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 2.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Auth;
use Cake\Controller\ComponentRegistry;
use Cake\Controller\Controller;
use Cake\Core\Exception\Exception;
use Cake\Core\InstanceConfigTrait;
use Cake\Network\Request;
use Cake\Utility\Inflector;
/**
* Abstract base authorization adapter for AuthComponent.
*
* @see AuthComponent::$authenticate
*/
abstract class BaseAuthorize {
use InstanceConfigTrait;
/**
* Controller for the request.
*
* @var Controller
*/
protected $_Controller = null;
/**
* ComponentRegistry instance for getting more components.
*
* @var ComponentRegistry
*/
protected $_registry;
/**
* Default config for authorize objects.
*
* - `actionPath` - The path to ACO nodes that contains the nodes for controllers. Used as a prefix
* when calling $this->action();
* - `actionMap` - Action -> crud mappings. Used by authorization objects that want to map actions to CRUD roles.
* - `userModel` - Model name that ARO records can be found under. Defaults to 'User'.
*
* @var array
*/
protected $_defaultConfig = [
'actionPath' => null,
'actionMap' => [
'index' => 'read',
'add' => 'create',
'edit' => 'update',
'view' => 'read',
'delete' => 'delete',
'remove' => 'delete'
],
'userModel' => 'Users'
];
/**
* Constructor
*
* @param ComponentRegistry $registry The controller for this request.
* @param array $config An array of config. This class does not use any config.
*/
public function __construct(ComponentRegistry $registry, array $config = array()) {
$this->_registry = $registry;
$controller = $registry->getController();
$this->controller($controller);
$this->config($config);
}
/**
* Checks user authorization.
*
* @param array $user Active user data
* @param \Cake\Network\Request $request Request instance.
* @return bool
*/
abstract public function authorize($user, Request $request);
/**
* Accessor to the controller object.
*
* @param Controller $controller null to get, a controller to set.
* @return mixed
* @throws \Cake\Core\Exception\Exception
*/
public function controller(Controller $controller = null) {
if ($controller) {
if (!$controller instanceof Controller) {
throw new Exception('$controller needs to be an instance of Controller');
}
$this->_Controller = $controller;
return true;
}
return $this->_Controller;
}
/**
* Get the action path for a given request. Primarily used by authorize objects
* that need to get information about the plugin, controller, and action being invoked.
*
* @param \Cake\Network\Request $request The request a path is needed for.
* @param string $path Path
* @return string The action path for the given request.
*/
public function action(Request $request, $path = '/:plugin/:controller/:action') {
$plugin = empty($request['plugin']) ? null : Inflector::camelize($request['plugin']) . '/';
$path = str_replace(
array(':controller', ':action', ':plugin/'),
array(Inflector::camelize($request['controller']), $request['action'], $plugin),
$this->_config['actionPath'] . $path
);
$path = str_replace('//', '/', $path);
return trim($path, '/');
}
/**
* Maps crud actions to actual action names. Used to modify or get the current mapped actions.
*
* Create additional mappings for a standard CRUD operation:
*
* {{{
* $this->Auth->mapActions(array('create' => array('add', 'register'));
* }}}
*
* Or equivalently:
*
* {{{
* $this->Auth->mapActions(array('register' => 'create', 'add' => 'create'));
* }}}
*
* Create mappings for custom CRUD operations:
*
* {{{
* $this->Auth->mapActions(array('range' => 'search'));
* }}}
*
* You can use the custom CRUD operations to create additional generic permissions
* that behave like CRUD operations. Doing this will require additional columns on the
* permissions lookup. For example if one wanted an additional search CRUD operation
* one would create and additional column '_search' in the aros_acos table. One could
* create a custom admin CRUD operation for administration functions similarly if needed.
*
* @param array $map Either an array of mappings, or undefined to get current values.
* @return mixed Either the current mappings or null when setting.
* @see AuthComponent::mapActions()
*/
public function mapActions(array $map = array()) {
if (empty($map)) {
return $this->_config['actionMap'];
}
foreach ($map as $action => $type) {
if (is_array($type)) {
foreach ($type as $typedAction) {
$this->_config['actionMap'][$typedAction] = $action;
}
} else {
$this->_config['actionMap'][$action] = $type;
}
}
}
}