CRM/Core/Permission/Joomla.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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
  44    *   The permission to check.
  45    *
  46    * @return bool
  47    *   true if yes, else false
  48    */
  49   public function check($str) {
  50     $config = CRM_Core_Config::singleton();
  51
  52     $translated = $this->translateJoomlaPermission($str);
  53     if ($translated === CRM_Core_Permission::ALWAYS_DENY_PERMISSION) {
  54       return FALSE;
  55     }
  56     if ($translated === CRM_Core_Permission::ALWAYS_ALLOW_PERMISSION) {
  57       return TRUE;
  58     }
  59
  60     // ensure that we are running in a joomla context
  61     // we've not yet figured out how to bootstrap joomla, so we should
  62     // not execute hooks if joomla is not loaded
  63     if (defined('_JEXEC')) {
  64       $permission = JFactory::getUser()->authorise($translated[0], $translated[1]);
  65       return $permission;
  66     }
  67     else {
  68       // This function is supposed to return a boolean. What does '(1)' mean?
  69       return '(1)';
  70     }
  71   }
  72
  73   /**
  74    * @param $perm
  75    *
  76    * @internal param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:example.action:com_some_asset"
  77    * @return ALWAYS_DENY_PERMISSION|ALWAYS_ALLOW_PERMISSION|array(0 => $joomlaAction, 1 => $joomlaAsset)
  78    */
  79   public function translateJoomlaPermission($perm) {
  80     if ($perm === CRM_Core_Permission::ALWAYS_DENY_PERMISSION || $perm === CRM_Core_Permission::ALWAYS_ALLOW_PERMISSION) {
  81       return $perm;
  82     }
  83
  84     list ($civiPrefix, $name) = CRM_Utils_String::parsePrefix(':', $perm, NULL);
  85     switch ($civiPrefix) {
  86       case 'Joomla':
  87         return explode(':', $name);
  88
  89       case 'cms':
  90         // FIXME: This needn't be DENY, but we don't currently have any translations.
  91         return CRM_Core_Permission::ALWAYS_DENY_PERMISSION;
  92
  93       case NULL:
  94         return array('civicrm.' . CRM_Utils_String::munge(strtolower($name)), 'com_civicrm');
  95
  96       default:
  97         return CRM_Core_Permission::ALWAYS_DENY_PERMISSION;
  98     }
  99   }
 100
 101   /**
 102    * Given a roles array, check for access requirements
 103    *
 104    * @param array $array
 105    *   The roles to check.
 106    *
 107    * @return bool
 108    *   true if yes, else false
 109    */
 110   public function checkGroupRole($array) {
 111     return FALSE;
 112   }
 113
 114 }