secure_permissions.drush.inc in Secure Permissions 6

Drush commands for Secure Permissions.

File

includes/secure_permissions.drush.inc

<?php

// $Id: $

/**
 * @file
 * Drush commands for Secure Permissions.
 */

/**
 * Implementation of hook_drush_command().
 */
function secure_permissions_drush_command() {
  $items['rebuild-perms'] = array(
    'callback' => 'secure_permissions_drush_rebuild',
    'description' => dt('Rebuild the site\'s roles and permissions with Secure Permissions.'),
    'examples' => array(
      'drush rebuild-roles' => 'Rebuilds site roles and permissions from code using available hook_secure_permissions_roles() implementations.',
    ),
    'arguments' => array(),
    'drupal dependencies' => array(
      'secure_permissions',
    ),
  );
  $items['sec-perms'] = array(
    'callback' => 'secure_permissions_drush_toggle_active',
    'description' => dt('Control the settings of the Secure Permissions module from the command line.'),
    'examples' => array(
      'drush sec-perms on' => 'Activates the Secure Permissions module from the command line, note this is distinct and different from enabling the module.',
      'drush sec-perms off' => 'Deactivates the Secure Permissions module from the command line, note this is distinct and different from disabling the module.',
    ),
    'arguments' => array(
      'action' => "Required. Currently has two states - set to 'on' to activate Secure Permissions and 'off' to deactivate.",
    ),
    'drupal dependencies' => array(
      'secure_permissions',
    ),
  );
  return $items;
}

/**
 * Implementation of hook_drush_help().
 */
function secure_permissions_drush_help($section) {
  switch ($section) {
    case 'drush:rebuild-perms':
      return dt("Rebuild the site's roles and permissions with Secure Permissions.");
    case 'drush:sec-perms':
      return dt("Configure settings for the Secure Permissions module from the command line.");
  }
}

/**
 * Callback function for drush rebuild-perms.
 *
 * Calls the default rebuild function and also records the event in the system
 * logs for drush and Drupal.
 */
function secure_permissions_drush_rebuild() {
  $active = variable_get('secure_permissions_active', 0);
  if ($active) {
    secure_permissions_rebuild();
    _secure_permissions_message_drush('Roles and permissions rebuilt.', array(), 'success');
  }
  else {
    _secure_permissions_message_drush('Could not rebuild roles and permissions because Secure Permissions is not active. Use "drush sec-perms on" to activate the module from the command line.', array(), 'error');
  }
}

/**
 * Callback function for drush sec-perms.
 *
 * Currently activates/deactivates the Secure Permissions module.
 * Is also a placeholder for general settings controls from the command line.
 *
 * @param $action
 *   (string) so far 'on' means activate, 'off' means deactivate.
 */
function secure_permissions_drush_toggle_active($action) {
  if ($action == 'on') {
    variable_set('secure_permissions_active', 1);
    _secure_permissions_message_drush('Secure Permissions module has been activated.', array(), 'success');
  }
  elseif ($action == 'off') {
    variable_set('secure_permissions_active', 0);
    _secure_permissions_message_drush('Secure Permissions module has been deactivated.', array(), 'success');
  }
  else {
    _secure_permissions_message_drush('Could not understand the response !active. Doing nothing.', array(
      '!active' => $active,
    ), 'error');
  }
}

/**
 * Send a message to the drush log.
 * Taken from the Backup And Migrate module.
 */
function _secure_permissions_message_drush($message, $replace, $type) {

  // Use drush_log to display to the user.
  drush_log($message, str_replace('status', 'notice', $type));

  // Watchdog log the message as well for admins.
  watchdog('sec_perms', $message, $replace, $type == 'error' ? WATCHDOG_ERROR : WATCHDOG_NOTICE);
}

Functions

Name	Description
secure_permissions_drush_command	Implementation of hook_drush_command().
secure_permissions_drush_help	Implementation of hook_drush_help().
secure_permissions_drush_rebuild	Callback function for drush rebuild-perms.
secure_permissions_drush_toggle_active	Callback function for drush sec-perms.
_secure_permissions_message_drush	Send a message to the drush log. Taken from the Backup And Migrate module.