CRM/Core/Permission/Joomla.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  *
  38  */
  39 class CRM_Core_Permission_Joomla extends CRM_Core_Permission_Base {
  40   /**
  41    * given a permission string, check for access requirements
  42    *
  43    * @param string $str the permission to check
  44    *
  45    * @return boolean true if yes, else false
  46    * @access public
  47    */
  48   function check($str) {
  49     $config = CRM_Core_Config::singleton();
  50
  51     $translated = $this->translateJoomlaPermission($str);
  52     if ($translated === CRM_Core_Permission::ALWAYS_DENY_PERMISSION) {
  53       return FALSE;
  54     }
  55     if ($translated === CRM_Core_Permission::ALWAYS_ALLOW_PERMISSION) {
  56       return TRUE;
  57     }
  58
  59     // ensure that we are running in a joomla context
  60     // we've not yet figured out how to bootstrap joomla, so we should
  61     // not execute hooks if joomla is not loaded
  62     if (defined('_JEXEC')) {
  63       $permission = JFactory::getUser()->authorise($translated[0], $translated[1]);
  64       return $permission;
  65     }
  66     else {
  67       // This function is supposed to return a boolean. What does '(1)' mean?
  68       return '(1)';
  69     }
  70   }
  71
  72   /**
  73    * @param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:example.action:com_some_asset"
  74    * @return ALWAYS_DENY_PERMISSION|ALWAYS_ALLOW_PERMISSION|array(0 => $joomlaAction, 1 => $joomlaAsset)
  75    */
  76   function translateJoomlaPermission($perm) {
  77     if ($perm === CRM_Core_Permission::ALWAYS_DENY_PERMISSION || $perm === CRM_Core_Permission::ALWAYS_ALLOW_PERMISSION) {
  78       return $perm;
  79     }
  80
  81     list ($civiPrefix, $name) = CRM_Utils_String::parsePrefix(':', $perm, NULL);
  82     switch($civiPrefix) {
  83       case 'Joomla':
  84         return explode(':', $name);
  85       case 'cms':
  86         // FIXME: This needn't be DENY, but we don't currently have any translations.
  87         return CRM_Core_Permission::ALWAYS_DENY_PERMISSION;
  88       case NULL:
  89         return array('civicrm.' . CRM_Utils_String::munge(strtolower($name)), 'com_civicrm');
  90       default:
  91         return CRM_Core_Permission::ALWAYS_DENY_PERMISSION;
  92     }
  93   }
  94
  95   /**
  96    * Given a roles array, check for access requirements
  97    *
  98    * @param array $array the roles to check
  99    *
 100    * @return boolean true if yes, else false
 101    * @static
 102    * @access public
 103    */
 104   function checkGroupRole($array) {
 105     return FALSE;
 106   }
 107 }
 108