notepermissions.php

<?php

require_once 'notepermissions.civix.php';
use CRM_Notepermissions_ExtensionUtil as E;

/**
 * Implements hook_civicrm_selectWhereClause().
 */
function notepermissions_civicrm_selectWhereClause($entityName, &$clauses, $userId = NULL, $conditions = []) {
  if ($userId === NULL) {
    $userId = CRM_Core_Session::getLoggedInContactID();
  }

  // Amend note privacy clause (only relevant if user lacks 'view all notes' permission)
  if ($entityName === 'Note' && !CRM_Core_Permission::check('view all notes', $userId)) {
    $options = \Civi\Api4\OptionValue::get(FALSE)
      ->addSelect('value')
      ->addWhere('option_group_id:name', '=', 'note_privacy')
      ->addWhere('value', '>', 1)
      ->execute()
      ->column('value');

    foreach ($options as $optionValue) {
      if (CRM_Core_Permission::check("access_privacy_type_$optionValue", $userId)) {
        // What's going on here is that `$clauses['privacy']` already contains an array of arrays
        // (which means OR).
        // @see CRM_Core_BAO_Note::addSelectWhereClause()
        // The existing values are `"= 0" OR "= 1 AND {contact_id} = $currentUser"`
        // So here we are adding a condition to the OR group IF the above permission check passes,
        // to allow privileged users to see this privacy type.
        $clauses['privacy'][0][] = "= $optionValue";
      }
    }
  }
}

function notepermissions_civicrm_postProcess($formName, $form) {
  // when a note privacy is added or edited, we clean up the permissions (will trigger our hook: notepermissions_civicrm_permission)
  if ($formName == 'CRM_Admin_Form_Options' && $form->getVar('_gName') == 'note_privacy') {
    $config = CRM_Core_Config::singleton();
    $config->cleanupPermissions();
  }
}

function notepermissions_civicrm_permission(&$permissions) {
  // get all options in the option group "note_privacy"
  $result = civicrm_api3('OptionValue', 'get', [
    'sequential' => 1,
    'option_group_id' => "note_privacy",
  ]);

  // skip the first two (i.e. None, Author only)
  for ($i = 2; $i < $result['count']; $i++) {
    // get key, name, and description based on the id and label
    list($permissionKey, $permissionName, $permissionDescription) = notepermissions_civicrm_getPermissionNameAndDescription($result['values'][$i]['value'], $result['values'][$i]['label']);

    // check if the permission exists
    if (!array_key_exists($permissionName, $permissions)) {
      // permission does not exist, add it
      $permissions[$permissionKey] = ['label' => $permissionName, 'description' => $permissionDescription];
    }
  }
}

function notepermissions_civicrm_getPermissionNameAndDescription($id, $label) {
  $key = "access_privacy_type_$id";
  $name = E::ts('CiviCRM: access notes with privacy type ID = ') . ' ' . $id;
  $description = E::ts("Access notes with privacy type:") . ' ' . E::ts($label);

  return [$key, $name, $description];
}

/**
 * Implements hook_civicrm_config().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/
 */
function notepermissions_civicrm_config(&$config) {
  _notepermissions_civix_civicrm_config($config);
}

/**
 * Implements hook_civicrm_install().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
 */
function notepermissions_civicrm_install() {
  _notepermissions_civix_civicrm_install();
}

/**
 * Implements hook_civicrm_enable().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
 */
function notepermissions_civicrm_enable() {
  _notepermissions_civix_civicrm_enable();
}

// --- Functions below this ship commented out. Uncomment as required. ---

/**
 * Implements hook_civicrm_preProcess().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_preProcess
 *

 // */

/**
 * Implements hook_civicrm_navigationMenu().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_navigationMenu
 *
function notepermissions_civicrm_navigationMenu(&$menu) {
  _notepermissions_civix_insert_navigation_menu($menu, 'Mailings', array(
    'label' => E::ts('New subliminal message'),
    'name' => 'mailing_subliminal_message',
    'url' => 'civicrm/mailing/subliminal',
    'permission' => 'access CiviMail',
    'operator' => 'OR',
    'separator' => 0,
  ));
  _notepermissions_civix_navigationMenu($menu);
} // */