kumbia-enterprise /Library/Kumbia/Acl/Adapters/Model.php

Language PHP Lines 510
MD5 Hash 2c4819c1a303c95ba5283661c9faed7a Estimated Cost $6,593 (why?)
Repository http://kumbia-enterprise.googlecode.com/svn/trunk/ View Raw File
  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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
<?php

/**
 * Kumbia Enterprise Framework
 *
 * LICENSE
 *
 * This source file is subject to the New BSD License that is bundled
 * with this package in the file docs/LICENSE.txt.
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@loudertechnology.com so we can send you a copy immediately.
 *
 * @category	Kumbia
 * @package		Acl
 * @subpackage	Adapters
 * @copyright	Copyright (c) 2008-2009 Louder Technology COL. (http://www.loudertechnology.com)
 * @copyright	Copyright (c) 2005-2009 Andres Felipe Gutierrez (gutierrezandresfelipe@gmail.com)
 * @license		New BSD License
 * @version 	$Id: Model.php 82 2009-09-13 21:06:31Z gutierrezandresfelipe $
 */

/**
 * AclModel
 *
 * Permite administrar listas ACL usando entidades de un gestor relacional
 *
 * @category	Kumbia
 * @package		Acl
 * @subpackage	Adapters
 * @copyright 	Copyright (c) 2008-2009 Louder Technology COL. (http://www.loudertechnology.com)
 * @copyright	Copyright (c) 2005-2009 Andres Felipe Gutierrez (gutierrezandresfelipe@gmail.com)
 * @license		New BSD License
 */
class AclModel implements AclAdapter {

	/**
	 * Nombre de la clase que administra los accesos
	 *
	 * @var string
	 */
	private $_modelName;

	/**
	 * Nombre de la clase que administra los roles
	 *
	 * @var string
	 */
	private $_modelRolesName;

	/**
	 * Nombre de la clase que administra los recursos
	 *
	 * @var string
	 */
	private $_modelResourcesName;

	/**
	 * Nombre de la clase que relaciona los recursos con sus operaciones
	 *
	 * @var string
	 */
	private $_modelAccessResourcesName;

	/**
	 * Nombre de la clase que administra la herencia entre roles
	 *
	 * @var string
	 */
	private $_modelInheritsName;

	/**
	 * Objeto ActiveRecordTransaction
	 *
	 * @var ActiveRecordTransaction
	 */
	private $_transaction;

	/**
	 * Constructor de la Clase AclModel
	 *
	 * @param array $params
	 */
	public function __construct($params){
		if(!isset($params['className'])){
			/**
			 * Debe indicar el nombre del modelo que administra la lista de Acceso
			 */
			$message = CoreLocale::getErrorMessage(-20);
			throw new AclException($message, -20);
		}
		if(!EntityManager::isModel($params['className'])){
			/**
			 * La clase no es un modelo valido
			 */
			$message = CoreLocale::getErrorMessage(-21, $params['className']);
			throw new AclException($message, -21);
		}
		$this->_modelName = $params['className'];
		if(isset($params['rolesClassName'])){
			if(!EntityManager::isModel($params['rolesClassName'])){
				$message = CoreLocale::getErrorMessage(-21, $params['rolesClassName']);
				throw new AclException($message, -21);
			}
			$this->_modelRolesName = $params['rolesClassName'];
		}
		if(isset($params['resourcesClassName'])){
			if(!EntityManager::isModel($params['resourcesClassName'])){
				$message = CoreLocale::getErrorMessage(-21, $params['resourcesClassName']);
				throw new AclException($message, -21);
			}
			$this->_modelResourcesName = $params['resourcesClassName'];
		}
		if(isset($params['accessResourcesClassName'])){
			if(!EntityManager::isModel($params['accessResourcesClassName'])){
				$message = CoreLocale::getErrorMessage(-21, $params['accessResourcesClassName']);
				throw new AclException($message, -21);
			}
			$this->_modelAccessResourcesName = $params['accessResourcesClassName'];
		}
	}

	/**
	 * Agrega un Rol a la Lista ACL
	 *
	 * $roleObject = Objeto de la clase AclRole para agregar a la lista
	 * $accessInherits = Nombre del Role del cual hereda permisos o array del grupo
	 * de perfiles del cual hereda permisos
	 *
	 * Ej:
	 * <code>$acl->addRole(new Acl_Role('administrador'), 'consultor');</code>
	 *
	 * @param AclRole $roleObject
	 * @param array $accessInherits
	 * @return boolean
	 */
	public function addRole(AclRole $roleObject, $accessInherits=''){
		if(!$this->_modelRolesName){
			//No se ha definido el modelo que administra los roles
			$message = CoreLocale::getErrorMessage(-22);
			throw new AclException($message, -22);
		}
		$role = EntityManager::getEntityInstance($this->_modelRolesName);
		if(method_exists($role, "setName")){
			$role->setName($roleObject->getName());
		} else {
			$role->name = $roleObject->getName();
		}
		if($role->hasField('description')){
			$role->description = $roleObject->getDescription();
		}
		if(!$this->isRole($roleObject->getName())){
			if($role->save()==false){
				//No se pudo crear el rol
				foreach($role->getMessages() as $message){
					$message = CoreLocale::getErrorMessage(-23, $message->getMessage());
					throw new AclException($message, -23);
				}
			}
		} else {
			//El role ya se ha creado en la lista de acceso
			$message = CoreLocale::getErrorMessage(-24);
			throw new AclException($message, -24);
		}
		if($accessInherits!=''){

		}
		return true;
	}

	/**
	 * Hace que un rol herede los accesos de otro rol
	 *
	 * @param string $role
	 * @param string $roleToInherit
	 */
	public function addInherit($role, $roleToInherit){

	}

	/**
	 *
	 * Verifica si un rol existe en la lista o no
	 *
	 * @param string $roleName
	 * @return boolean
	 */
	public function isRole($roleName){
		if(!$this->_modelRolesName){
			//No se ha definido el modelo que administra los Roles
			$message = CoreLocale::getErrorMessage(-22);
			throw new AclException($message, -22);
		}
		$roles = EntityManager::getEntityInstance($this->_modelRolesName);
		return $roles->count("name = '$roleName'") > 0 ? true : false;
	}

	/**
	 *
	 * Verifica si un resource existe en la lista o no
	 *
	 * @param string $resourceName
	 * @return boolean
	 */
	public function isResource($resourceName){
		if(!$this->_modelResourcesName){
			//No se ha definido el modelo que administra los Resources
			$message = CoreLocale::getErrorMessage(-25);
			throw new AclException($message, -25);
		}
		$resource = EntityManager::getEntityInstance($this->_modelResourcesName());
		return $resource->count("name = '$resourceName'") > 0 ? true : false;
	}

	/**
	 * Agrega un recurso a la Lista ACL
	 *
	 * Resource_name puede ser el nombre de un objeto concreo, por ejemplo
	 * consulta, buscar, insertar, valida etc ó una lista de ellos
	 *
	 * Ej:
	 * <code>
	 * //Agregar un resource a la lista:
	 * $acl->addResource(new AclResource('clientes'), 'consulta');
	 *
	 * //Agregar Varios resources a la lista:
	 * $acl->addResource(new AclResource('clientes'), array('consulta', 'buscar', 'insertar'));
	 * </code>
	 *
	 * @param AclResource $resourceObject
	 * @param array $operationsList
	 * @return boolean
	 */
	public function addResource(AclResource $resourceObject, $operationsList=''){
		if($operationsList==''){
			return $this->_createResource($resourceObject);
		} else {
			return $this->addResourceAccess($resourceObject, $operationsList);
		}
	}

	/**
	 * Crea un recurso en el Modelo definido
	 *
	 * @param AclResource $resourceObject
	 */
	private function _createResource(AclResource $resourceObject){
		if(!$this->_modelResourcesName){
			//No se ha definido el modelo que administra los Resources
			$message = CoreLocale::getErrorMessage(-25);
			throw new AclException($message, -25);
		}
		$resource = EntityManager::getEntityInstance($this->_modelResourcesName);
		if($this->_transaction){
			$resource->setTransaction($this->_transaction);
		}
		if(method_exists($resource, "setName")){
			$resource->setName($resourceObject->getName());
		} else {
			$resource->name = $resourceObject->getName();
		}
		if($resource->hasField('description')){
			if(method_exists($resource, "setDescription")){
				$resource->setDescription($resourceObject->getDescription());
			} else {
				$resource->description = $resourceObject->getDescription();
			}
		}
		if(!$this->isResource($resourceObject->getName())){
			if($resource->save()==false){
				//No se pudo crear el recurso
				foreach($resource->getMessages() as $message){
					$message = CoreLocale::getErrorMessage(-26, $message->getMessage());
					throw new AclException($message, -26);
				}
			}
		} else {
			//El resource ya se ha creado en la lista de acceso
			$message = CoreLocale::getErrorMessage(-27);
			throw new AclException($message, -27);
		}
		return true;
	}

	/**
	 * Agrega accesos a un Resource
	 *
	 * @param AclResource $resourceObject
	 * @param array $operationsList
	 */
	public function addResourceAccess($resourceObject, $operationsList){
		if(!$this->_modelAccessResourcesName){
			//No se ha definido el modelo que relaciona los Resources con sus operaciones
			$message = CoreLocale::getErrorMessage(-28);
			throw new AclException($message, -28);
		}
		$createdResource = false;
		$this->_transaction = TransactionManager::getUserTransaction();
		if(!is_array($operationsList)){
			$operationsList = array($operationsList);
		}
		$numberList = count($operationsList);
		for($i=0;$i<$numberList;++$i){
			if(is_string($operationsList[$i])==false){
				$this->_transaction->rollback();
				$this->_transaction = null;
				//Nombre de operación invalido
				$message = CoreLocale::getErrorMessage(-29, $operationsList[$i]);
				throw new AclException($message, -29);
			}
			if($createdResource==false){
				if(!$this->isResource($resourceObject->getName())){
					$this->_createResource($resourceObject);
				} else {
				}
				$createdResource = true;
			}
			$accessResources = EntityManager::getEntityInstance($this->_modelAccessResourcesName);
			if(method_exists($accessResources, "setResource")){
				$accessResources->setResource($resourceObject->getName());
			} else {
				$accessResources->resource = $resourceObject->getName();
			}
			if(method_exists($accessResources, "setAction")){
				$accessResources->setAction($operationsList[$i]);
			} else {
				$accessResources->action = $operationsList[$i];
			}
			if($accessResources->save()==false){
				foreach($accessResources->getMessages() as $message){
					$this->_transaction->rollback();
					$this->_transaction = null;
					throw new AclException($accessResources->getMessage());
				}
			}
		}
		$this->_transaction->commit();
		$this->_transaction = null;
		return true;
	}

	/**
	 * Elimina un acceso del resorce
	 *
	 * @param string $resource
	 * @param mixed $accessList
	 */
	public function dropResourceAccess($resource, $accessList){

	}

	/**
	 * Agrega un acceso de la lista de resources a un rol
	 *
	 * Utilizar '*' como comodín
	 *
	 * Ej:
	 * <code>
	 * //Acceso para invitados a consultar en clientes
	 * $acl->allow('invitados', 'clientes', 'consulta');
	 *
	 * //Acceso para invitados a consultar e insertar en clientes
	 * $acl->allow('invitados', 'clientes', array('consulta', 'insertar'));
	 *
	 * //Acceso para cualquiera a visualizar en productos
	 * $acl->allow('*', 'productos', 'visualiza');
	 *
	 * //Acceso para cualquiera a visualizar en cualquier resource
	 * $acl->allow('*', '*', 'visualiza');
	 * </code>
	 *
	 * @param string $role
	 * @param string $resource
	 * @param mixed $access
	 * @return boolean
	 */
	public function allow($role, $resource, $access){
		$model = EntityManager::getEntityInstance($this->modelName());
		$conditions = "role='$role' AND resource='$resource' AND action = '$access'";
		$access = $model->findFirst($conditions);
		if(!$access){
			if(method_exists($access, "setRole")){
				$access->setRole($role);
			} else {
				$access->role = $role;
			}
			if(method_exists($access, "setResource")){
				$access->setResource($resource);
			} else {
				$access->resource = $resource;
			}
			if(method_exists($access, "setAction")){
				$access->setAction($action);
			} else {
				$access->action = $action;
			}
		}
		$access->allow = 'Y';
		if($access->save()==false){
			//No se pudo guardar el acceso
			foreach($access->getMessages() as $message){
				$message = CoreLocale::getErrorMessage(-30, $message->getMessage());
				throw new AclException($message, -30);
			}
		}
		return true;
	}

	/**
	 * Denegar un acceso de la lista de resources a un rol
	 *
	 * Utilizar '*' como comod?n
	 *
	 * Ej:
	 * <code>
	 * //Denega acceso para invitados a consultar en clientes
	 * $acl->deny('invitados', 'clientes', 'consulta');
	 *
	 * //Denega acceso para invitados a consultar e insertar en clientes
	 * $acl->deny('invitados', 'clientes', array('consulta', 'insertar'));
	 *
	 * //Denega acceso para cualquiera a visualizar en productos
	 * $acl->deny('*', 'productos', 'visualiza');
	 *
	 * //Denega acceso para cualquiera a visualizar en cualquier resource
	 * $acl->deny('*', '*', 'visualiza');
	 * </code>
	 *
	 * @param string $role
	 * @param string $resource
	 * @param mixed $access
	 * @return boolean
	 */
	public function deny($role, $resource, $access){
		$model = EntityManager::getEntityInstance($this->modelName);
		$conditions = "role='$role' AND resource='$resource' AND action = '$access'";
		$access = $model->findFirst($conditions);
		if(!$access){
			if(method_exists($access, "setRole")){
				$access->setRole($role);
			} else {
				$access->role = $role;
			}
			if(method_exists($access, "setResource")){
				$access->setResource($resource);
			} else {
				$access->resource = $resource;
			}
			if(method_exists($access, "setAction")){
				$access->setAction($action);
			} else {
				$access->action = $action;
			}
		}
		$access->allow = 'N';
		if($access->save()==false){
			//No se pudo guardar el acceso
			foreach($access->getMessages() as $message){
				$message = CoreLocale::getErrorMessage(-30, $message->getMessage());
				throw new AclException($message, -30);
			}
		}
		return true;
	}

	/**
	 * Devuelve true si un $role, tiene acceso en un resource
	 *
	 * <code>
	 * //Andres tiene acceso a insertar en el resource productos
	 * $acl->isAllowed('andres', 'productos', 'insertar');
	 *
	 * //Invitado tiene acceso a editar en cualquier resource?
	 * $acl->isAllowed('invitado', '*', 'editar');
	 *
	 * //Invitado tiene acceso a editar en cualquier resource?
	 * $acl->isAllowed('invitado', '*', 'editar');
	 * </code>
	 *
	 * @param string $role
	 * @param string $resource
	 * @param mixed $accessList
	 * @return boolean
	 */
	public function isAllowed($role, $resource, $accessList){
		$model = EntityManager::getEntityInstance($this->_modelName);
		$conditions = "role='$role' AND resource='*' AND action = '*'";
		$access = $model->findFirst($conditions);
		if($access){
			if($access->getAllow()=='N'){
				return false;
			}
		}
		$conditions = "role='$role' AND resource='$resource' AND action = '*'";
		$access = $model->findFirst($conditions);
		if($access){
			if($access->getAllow()=='N'){
				return false;
			}
		}
		$conditions = "resource='$resource' AND role='$role' AND action = '$accessList' AND allow='N'";
		$deny = $model->count($conditions);
		if($deny){
			return false;
		}
		return true;
	}

}
Back to Top