',
);
break;
case VIEWS_BULK_OPS_STEP_CONFIG:
$operation = $plugin->get_operation_info($form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['operation']);
$form['operation'] = array('#type' => 'value', '#value' => $operation);
$form += _views_bulk_operations_action_form(
$operation,
$plugin->view,
array_filter($form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['objects']['selection']),
$plugin->get_operation_settings($operation)
);
$form['execute'] = array(
'#type' => 'submit',
'#value' => t('Next'),
'#weight' => 98,
);
$query = drupal_query_string_encode($form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['exposed_input']);
$form['cancel'] = array(
'#type' => 'markup',
'#value' => t('Cancel', array('@view' => url($_GET['q'], array('query' => $query)))),
'#weight' => 99,
);
drupal_set_title(t('Set parameters for %action', array('%action' => $operation['label'])));
break;
case VIEWS_BULK_OPS_STEP_CONFIRM:
$operation = $plugin->get_operation_info($form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['operation']);
$query = drupal_query_string_encode($form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['exposed_input']);
$objects = $form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['objects']['selection'];
$form = confirm_form($form,
t('Are you sure you want to perform %action on selected rows?', array('%action' => strtolower($operation['label']))),
array('path' => $_GET['q'], 'query' => $query),
theme('views_bulk_operations_confirmation', $objects, $plugin->view)
);
break;
}
// Use views_bulk_operations_form_submit() for form submit, regardless of form_id.
$form['#submit'][] = 'views_bulk_operations_form_submit';
$form['#validate'][] = 'views_bulk_operations_form_validate';
$form['#cache'] = TRUE;
return $form;
}
/**
* Form validate function for views_bulk_operations_form().
*/
function views_bulk_operations_form_validate($form, &$form_state) {
switch ($form_state['values']['step']) {
case VIEWS_BULK_OPS_STEP_VIEW:
$_SESSION['vbo_values'][url($_GET['q'])] = $form_state['values'];
if (!array_filter($form_state['values']['objects']['selection'])) { // If all 0, no row selected
form_set_error('objects', t('No row selected. Please select one or more rows.'));
}
if (!empty($form_state['clicked_button']['#hash'])) {
$form_state['values']['operation'] = $form_state['clicked_button']['#hash'];
}
if (!$form_state['values']['operation']) { // No action selected
form_set_error('operation', t('No operation selected. Please select an operation to perform.'));
}
break;
case VIEWS_BULK_OPS_STEP_SINGLE:
$_SESSION['vbo_values'][url($_GET['q'])] = $form_state['values'];
if (!array_filter($form_state['values']['objects']['selection'])) { // If all 0, no row selected
form_set_error('objects', t('No row selected. Please select one or more rows.'));
}
$plugin = $form['#plugin'];
$operation = $plugin->get_operation_info($form_state['values']['operation']);
if ($operation['configurable']) {
_views_bulk_operations_action_validate($operation, $form, $form_state);
}
break;
case VIEWS_BULK_OPS_STEP_CONFIG:
$plugin = $form['#plugin'];
$operation = $plugin->get_operation_info($form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['operation']);
_views_bulk_operations_action_validate($operation, $form, $form_state);
break;
}
}
/**
* Form submit function for views_bulk_operations_form().
*/
function views_bulk_operations_form_submit($form, &$form_state) {
$plugin = $form['#plugin'];
switch ($form_state['values']['step']) {
case VIEWS_BULK_OPS_STEP_VIEW:
$form_state['storage']['step'] = $form_state['values']['step'];
$form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW] = $form_state['values'];
_views_bulk_operations_adjust_selection(
$form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['objects']['selection'],
$form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['objects']['select_all'],
$form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['exposed_input'],
$form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['arguments'],
$plugin
);
$operation = $plugin->get_operation_info($form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['operation']);
if (!$operation['configurable'] && $plugin->options['skip_confirmation']) {
break; // Go directly to execution
}
return;
case VIEWS_BULK_OPS_STEP_SINGLE:
$form_state['storage']['step'] = $form_state['values']['step'];
$form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW] = $form_state['values'];
$form_state['storage'][VIEWS_BULK_OPS_STEP_CONFIG] = $form_state['values']; // we're not taking any chances
_views_bulk_operations_adjust_selection(
$form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['objects']['selection'],
$form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['objects']['select_all'],
$form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['exposed_input'],
$form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['arguments'],
$plugin
);
$operation = $plugin->get_operation_info($form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['operation']);
if ($operation['configurable']) {
$form_state['storage']['operation_arguments'] = _views_bulk_operations_action_submit($operation, $form, $form_state);
}
if ($plugin->options['skip_confirmation']) {
break; // Go directly to execution
}
return;
case VIEWS_BULK_OPS_STEP_CONFIG:
$form_state['storage']['step'] = $form_state['values']['step'];
$form_state['storage'][VIEWS_BULK_OPS_STEP_CONFIG] = $form_state['values'];
$operation = $plugin->get_operation_info($form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['operation']);
$form_state['storage']['operation_arguments'] = _views_bulk_operations_action_submit($operation, $form, $form_state);
if ($plugin->options['skip_confirmation']) {
break; // Go directly to execution
}
return;
case VIEWS_BULK_OPS_STEP_CONFIRM:
break;
}
// Clean up unneeded SESSION variables.
unset($_SESSION['vbo_values'][url($_GET['q'])]);
// Execute the VBO.
$operation = $plugin->get_operation_info($form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['operation']);
$operation_arguments = array();
if ($operation['configurable']) {
$form_state['values'] += $form_state['storage'][VIEWS_BULK_OPS_STEP_CONFIG];
$operation_arguments = $form_state['storage']['operation_arguments'];
}
_views_bulk_operations_execute(
$plugin->view,
$form_state['storage'][VIEWS_BULK_OPS_STEP_VIEW]['objects']['selection'],
$operation,
$operation_arguments,
array('execution_type' => $plugin->options['execution_type'], 'display_result' => $plugin->options['display_result'], 'settings' => $plugin->get_operation_settings($operation))
);
// Clean up the form.
unset($form_state['storage']);
$form_state['redirect'] = isset($form_state['values']['exposed_input']['destination']) ? $form_state['values']['exposed_input']['destination'] : $_GET['q'];
}
/**
* Theme function to show the confirmation page before executing the action.
*/
function theme_views_bulk_operations_confirmation($objects, $view) {
$object_info = _views_bulk_operations_object_info_for_view($view);
$items = array();
$items_per_page = isset($view->pager_original) ? (method_exists($view->pager_original, 'get_items_per_page') ? $view->pager_original->get_items_per_page() : $view->pager_original['items_per_page']) : 0;
foreach ($objects as $num => $row) {
$oid = $row->{$view->base_field};
if ($items_per_page && count($items) >= $items_per_page) {
$items[] = t('...and !count more.', array('!count' => count($objects) - count($items)));
break;
}
if ($object = call_user_func($object_info['load'], $oid)) {
$items[] = check_plain((string)$object->{$object_info['title']});
}
}
$count = count($objects);
$output = theme('item_list', $items,
format_plural(
$count,
'You selected the following 1 row:',
'You selected the following @count rows:'
)
);
return $output;
}
/**
* Implementation of hook_forms().
*
* Force each instance of function to use the same callback.
*/
function views_bulk_operations_forms() {
// Get the form ID.
$args = func_get_args();
$form_id = $args[0];
// Ensure we map a callback for our form and not something else.
$forms = array();
if (strpos($form_id, 'views_bulk_operations_form') === 0) {
// Let the forms API know where to get the form data corresponding
// to this form id.
$forms[$form_id] = array('callback' => 'views_bulk_operations_form');
}
return $forms;
}
/**
* Implementation of hook_views_bulk_operations_object_info()
*
* Hook used by VBO to be able to handle different objects as does Views 2 and the Drupal core action system.
*
* The array returned for each object type contains:
* 'type' (required) => the object type name, should be the same as 'type' field in hook_action_info().
* 'context' (optional) => the context name that should receive the object, defaults to the value of 'type' above.
* 'base_table' (required) => the Views 2 table name corresponding to that object type, should be the same as the $view->base_table attribute.
* 'oid' (currently unused) => an attribute on the object that returns the unique object identifier (should be the same as $view->base_field).
* 'load' (required) => a function($oid) that returns the corresponding object.
* 'title' (required) => an attribute on the object that returns a human-friendly identifier of the object.
* 'access' (optional) => a function($op, $node, $account = NULL) that behaves like node_access().
*
* The following attributes allow VBO to show actions on view types different than the action's type:
* 'hook' (optional) => the name of the hook supported by this object type, as defined in the 'hooks' attribute of hook_action_info().
* 'normalize' (optional) => a function($type, $object) that takes an object type and the object instance, returning additional context information for cross-type
*
* e.g., an action declaring hooks => array('user') while of type 'system' will be shown on user views, and VBO will call the user's 'normalize' function to
* prepare the action to fit the user context.
*/
function views_bulk_operations_views_bulk_operations_object_info() {
$object_info = array(
'node' => array(
'type' => 'node',
'base_table' => 'node',
'load' => 'views_bulk_operations_node_load',
'oid' => 'nid',
'title' => 'title',
'access' => 'node_access',
'hook' => 'nodeapi',
'normalize' => 'views_bulk_operations_normalize_node_context',
),
'user' => array(
'type' => 'user',
'base_table' => 'users',
'load' => 'user_load',
'oid' => 'uid',
'title' => 'name',
'context' => 'account',
'hook' => 'user',
'normalize' => 'views_bulk_operations_normalize_user_context',
),
'comment' => array(
'type' => 'comment',
'base_table' => 'comments',
'load' => '_comment_load',
'oid' => 'cid',
'title' => 'subject',
'hook' => 'comment',
'normalize' => 'views_bulk_operations_normalize_comment_context',
),
'term' => array(
'type' => 'term',
'base_table' => 'term_data',
'load' => 'taxonomy_get_term',
'oid' => 'tid',
'title' => 'name',
'hook' => 'taxonomy',
),
'node_revision' => array(
'type' => 'node_revision',
'base_table' => 'node_revisions',
'load' => 'views_bulk_operations_node_revision_load',
'title' => 'name',
),
'file' => array(
'type' => 'file',
'base_table' => 'files',
'load' => 'views_bulk_operations_file_load',
'oid' => 'fid',
'title' => 'filename',
),
);
return $object_info;
}
/**
* Load function for objects of type 'node'.
*/
function views_bulk_operations_node_load($nid) {
return node_load($nid, NULL, TRUE);
}
/**
* Load function for objects of type 'file'.
*/
function views_bulk_operations_file_load($fid) {
return db_fetch_object(db_query("SELECT * FROM {files} WHERE fid = %d", $fid));
}
/**
* Load function for node revisions.
*/
function views_bulk_operations_node_revision_load($vid) {
$nid = db_result(db_query("SELECT nid FROM {node_revisions} WHERE vid = %d", $vid));
return node_load($nid, $vid, TRUE);
}
/**
* Normalize function for node context.
*
* @see _trigger_normalize_node_context()
*/
function views_bulk_operations_normalize_node_context($type, $node) {
switch ($type) {
// If an action that works on comments is being called in a node context,
// the action is expecting a comment object. But we do not know which comment
// to give it. The first? The most recent? All of them? So comment actions
// in a node context are not supported.
// An action that works on users is being called in a node context.
// Load the user object of the node's author.
case 'user':
return user_load(array('uid' => $node->uid));
}
}
/**
* Normalize function for comment context.
*
* @see _trigger_normalize_comment_context()
*/
function views_bulk_operations_normalize_comment_context($type, $comment) {
switch ($type) {
// An action that works with nodes is being called in a comment context.
case 'node':
return node_load(is_array($comment) ? $comment['nid'] : $comment->nid);
// An action that works on users is being called in a comment context.
case 'user':
return user_load(array('uid' => is_array($comment) ? $comment['uid'] : $comment->uid));
}
}
/**
* Normalize function for user context.
*
* @see _trigger_normalize_user_context()
*/
function views_bulk_operations_normalize_user_context($type, $account) {
switch ($type) {
// If an action that works on comments is being called in a user context,
// the action is expecting a comment object. But we have no way of
// determining the appropriate comment object to pass. So comment
// actions in a user context are not supported.
// An action that works with nodes is being called in a user context.
// If a single node is being viewed, return the node.
case 'node':
// If we are viewing an individual node, return the node.
if ((arg(0) == 'node') && is_numeric(arg(1)) && (arg(2) == NULL)) {
return node_load(array('nid' => arg(1)));
}
}
}
/**
* Implementation of hook_action_info().
*/
function views_bulk_operations_action_info() {
$actions = array();
foreach (_views_bulk_operations_load_actions() as $file) {
$action_info_fn = 'views_bulk_operations_'. $file .'_action_info';
$action_info = call_user_func($action_info_fn);
if (is_array($action_info)) $actions += $action_info;
}
// Add VBO's own programmatic action.
$actions['views_bulk_operations_action'] = array(
'description' => t('Execute a VBO programmatically'),
'type' => 'system',
'configurable' => TRUE,
'rules_ignore' => TRUE,
);
return $actions;
}
/**
* Implementation of hook_menu().
*/
function views_bulk_operations_menu() {
$items['views-bulk-operations/js/action'] = array(
'title' => 'VBO action form',
'description' => 'AHAH callback to display action form on VBO action page.',
'page callback' => 'views_bulk_operations_form_ahah',
'page arguments' => array('views_bulk_operations_action_form_operation'),
'access arguments' => array('access content'),
'type' => MENU_CALLBACK,
);
$items['views-bulk-operations/js/select'] = array(
'title' => 'VBO select handler',
'description' => 'AJAX callback to update selection.',
'page callback' => 'views_bulk_operations_select',
'access arguments' => array('access content'),
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* AJAX callback to update selection.
*/
function views_bulk_operations_select() {
$url = $_REQUEST['url'];
foreach (json_decode($_REQUEST['selection'], TRUE) as $selection => $selected) {
if ($selection == 'select_all') {
$_SESSION['vbo_values'][$url]['objects']['select_all'] = (bool)$selected;
if ($selected) {
$_SESSION['vbo_values'][$url]['objects']['selection'] = array();
}
}
else {
if ($selected) {
$_SESSION['vbo_values'][$url]['objects']['selection'][$selection] = TRUE;
}
else {
unset($_SESSION['vbo_values'][$url]['objects']['selection'][$selection]);
}
}
}
exit;
}
/**
* Form function for views_bulk_operations_action action.
*/
function views_bulk_operations_action_form($context) {
// Some views choke on being rebuilt at this moment because of validation errors in the action form.
// So we save the error state, reset it, build the views, then reinstate the errors.
// Also unset the error messages because they'll be displayed again after the loop.
$errors = form_get_errors();
if (!empty($errors)) foreach ($errors as $message) {
unset($_SESSION['messages']['error'][array_search($message, $_SESSION['messages']['error'])]);
}
form_set_error(NULL, '', TRUE);
// Look for all views with VBO styles, and for each find the operations they use.
// Distinguish between overridden and default views to simplify export.
$views[0] = t('- Choose a view -');
$operations[0] = t('- Choose an operation -');
$all_views = array();
foreach (views_get_all_views() as $name => $view) {
$all_views[$name] = $view;
$default_view = views_get_default_view($name);
if (!empty($default_view)) {
$default_view->type = t('Default');
$all_views[$name . '_default'] = $default_view;
}
}
foreach ($all_views as $name => $view) {
foreach (array_keys($view->display) as $display) {
$display_options = &$view->display[$display]->display_options;
if (isset($display_options['style_plugin']) && $display_options['style_plugin'] == 'bulk') {
$vid = empty($view->vid) ? $view->name : $view->vid;
$views[$vid] = $view->name . ' (' . $view->type . ')' . (!empty($view->description) ? ': ' . $view->description : '');
$style_plugin = views_get_plugin('style', $display_options['style_plugin']);
$style_plugin->init($view, $view->display[$display], $display_options['style_options']);
if (isset($context['view_vid']) && $vid == $context['view_vid']) {
$form['#plugin'] = $style_plugin;
}
foreach (array_filter($display_options['style_options']['selected_operations']) as $key) {
$operations[$key] = $views_operations[$vid][$key] = $style_plugin->all_operations[$key]['label'];
if ($key == @$context['operation_key'] && $vid == @$context['view_vid']) {
$form['#operation'] = $style_plugin->all_operations[$key];
}
}
}
}
}
if (!empty($errors)) foreach ($errors as $name => $message) {
form_set_error($name, $message);
}
drupal_add_js(array('vbo' => array('action' => array('views_operations' => $views_operations))), 'setting');
drupal_add_js(drupal_get_path('module', 'views_bulk_operations') . '/views_bulk_operations.action.js');
$form['view_vid'] = array(
'#type' => 'select',
'#title' => t('View'),
'#description' => t('Select the VBO to be executed.'),
'#options' => $views,
'#default_value' => @$context['view_vid'],
'#attributes' => array('onchange' => 'Drupal.vbo.action.updateOperations(this.options[this.selectedIndex].value, true);'),
);
$form['operation_key'] = array(
'#type' => 'select',
'#title' => t('Operation'),
'#description' => t('Select the operation to be executed.'),
'#options' => $operations,
'#default_value' => @$context['operation_key'],
'#ahah' => array(
'path' => 'views-bulk-operations/js/action',
'wrapper' => 'vbo-operation-wrapper',
'method' => 'replace',
),
);
$form['operation_arguments'] = array(
'#type' => 'fieldset',
'#title' => t('Operation arguments'),
'#description' => t('If the selected action is configurable, this section will show the action\'s arguments form,
followed by a text field where a PHP script can be entered to programmatically assemble the arguments.
'),
);
$form['operation_arguments']['wrapper'] = array(
'#type' => 'markup',
'#value' => '',
'#prefix' => '
',
'#suffix' => '
',
);
if (isset($form['#operation']) && $form['#operation']['configurable'] && isset($form['#plugin'])) {
$form['operation_arguments']['wrapper']['operation_form'] = _views_bulk_operations_action_form(
$form['#operation'],
$form['#plugin']->view,
NULL,
$form['#plugin']->get_operation_settings($form['#operation']),
$context
);
if (!empty($form['#operation']['form properties'])) foreach ($form['#operation']['form properties'] as $property) {
if (isset($form['operation_arguments']['wrapper']['operation_form'][$property])) {
$form[$property] = $form['operation_arguments']['wrapper']['operation_form'][$property];
}
}
$form['operation_arguments']['wrapper']['operation_arguments'] = array(
'#type' => 'textarea',
'#title' => t('Operation arguments'),
'#description' => t('Enter PHP script that will assemble the operation arguments (and will override the arguments above).
These arguments should be of the form: return array(\'argument1\' => \'value1\', ...);
and they should correspond to the values returned by the action\'s form submit function.
The variables &$object and $context are available to this script.
'),
'#default_value' => @$context['operation_arguments'],
);
}
else {
$form['operation_arguments']['wrapper']['operation_form'] = array(
'#type' => 'markup',
'#value' => t('This operation is not configurable.'),
);
$form['operation_arguments']['wrapper']['operation_arguments'] = array('#type' => 'value', '#value' => '');
}
$form['view_exposed_input'] = array(
'#type' => 'textarea',
'#title' => t('View exposed input'),
'#description' => t('Enter PHP script that will assemble the view exposed input (if the view accepts exposed input).
These inputs should be of the form: return array(\'input1\' => \'value1\', ...);
and they should correspond to the query values used on the view URL when exposed filters are applied.
The variables &$object and $context are available to this script.
'),
'#default_value' => @$context['view_exposed_input'],
);
$form['view_arguments'] = array(
'#type' => 'textarea',
'#title' => t('View arguments'),
'#description' => t('Enter PHP script that will assemble the view arguments (if the view accepts arguments).
These arguments should be of the form: return array(\'value1\', ...);
and they should correspond to the arguments defined in the view.
The variables &$object and $context are available to this script.
'),
'#default_value' => @$context['view_arguments'],
);
return $form;
}
/**
* Generic AHAH callback to manipulate a form.
*/
function views_bulk_operations_form_ahah($callback) {
$form_state = array('submitted' => FALSE);
$form_build_id = $_POST['form_build_id'];
// Add the new element to the stored form. Without adding the element to the
// form, Drupal is not aware of this new elements existence and will not
// process it. We retreive the cached form, add the element, and resave.
$form = form_get_cache($form_build_id, $form_state);
// Invoke the callback that will populate the form.
$render =& $callback($form, array('values' => $_POST));
form_set_cache($form_build_id, $form, $form_state);
$form += array(
'#post' => $_POST,
'#programmed' => FALSE,
);
// Rebuild the form.
$form = form_builder($_POST['form_id'], $form, $form_state);
// Render the new output.
$output_html = drupal_render($render);
$output_js = drupal_get_js();
print drupal_to_js(array('data' => theme('status_messages') . $output_html . $output_js, 'status' => TRUE));
exit();
}
/**
* Form callback to update an action form when a new action is selected in views_bulk_operations_action form.
*/
function& views_bulk_operations_action_form_operation(&$form, $form_state) {
// TODO: Replace this with autoloading of style plugin and view definitions to use $form['#plugin'].
$view = views_get_view($form_state['values']['view_vid']);
foreach (array_keys($view->display) as $display) {
$display_options = &$view->display[$display]->display_options;
if (isset($display_options['style_plugin']) && $display_options['style_plugin'] == 'bulk') {
$plugin = views_get_plugin('style', $display_options['style_plugin']);
$plugin->init($view, $view->display[$display], $display_options['style_options']);
break;
}
}
$form['#operation'] = $plugin->get_operation_info($form_state['values']['operation_key']);
if ($form['#operation']['configurable']) {
$form['operation_arguments']['wrapper'] = array(
'#type' => 'markup',
'#value' => '',
'#prefix' => '
',
'#suffix' => '
',
);
$form['operation_arguments']['wrapper']['operation_form'] = _views_bulk_operations_action_form(
$form['#operation'],
$plugin->view,
NULL,
$plugin->get_operation_settings($form['#operation'])
);
if (!empty($form['#operation']['form properties'])) foreach ($form['#operation']['form properties'] as $property) {
if (isset($form['operation_arguments']['wrapper']['operation_form'][$property])) {
$form[$property] = $form['operation_arguments']['wrapper']['operation_form'][$property];
}
}
$form['operation_arguments']['wrapper']['operation_arguments'] = array(
'#type' => 'textarea',
'#title' => t('Operation arguments'),
'#description' => t('Enter PHP script that will assemble the operation arguments (and will override the operation form above).
These arguments should be of the form: return array(\'argument1\' => \'value1\', ...);
and they should correspond to the values returned by the action\'s form submit function.
The variables &$object and $context are available to this script.
'),
);
}
else {
$form['operation_arguments']['wrapper']['operation_form'] = array(
'#type' => 'markup',
'#value' => t('This operation is not configurable.'),
);
$form['operation_arguments']['wrapper']['operation_arguments'] = array('#type' => 'value', '#value' => '');
}
return $form['operation_arguments']['wrapper'];
}
/**
* Form validate function for views_bulk_operations_action action.
*/
function views_bulk_operations_action_validate($form, $form_state) {
if (empty($form_state['values']['view_vid'])) {
form_set_error('view_vid', t('You must choose a view to be executed.'));
}
if (empty($form_state['values']['operation_key'])) {
form_set_error('operation_callback', t('You must choose an operation to be executed.'));
}
if ($form['#operation']) {
module_invoke_all('action_info'); // some validate functions are created dynamically...
_views_bulk_operations_action_validate($form['#operation'], $form, $form_state);
}
}
/**
* Form submit function for views_bulk_operations_action action.
*/
function views_bulk_operations_action_submit($form, $form_state) {
$submit = array(
'view_vid' => $form_state['values']['view_vid'],
'operation_key' => $form_state['values']['operation_key'],
'operation_arguments' => $form_state['values']['operation_arguments'],
'view_exposed_input' => $form_state['values']['view_exposed_input'],
'view_arguments' => $form_state['values']['view_arguments'],
);
if ($form['#operation'] && function_exists($form['#operation']['callback'] . '_submit')) {
module_invoke_all('action_info'); // some submit functions are created dynamically...
$submit = array_merge($submit, _views_bulk_operations_action_submit($form['#operation'], $form, $form_state));
}
return $submit;
}
/**
* Execution function for views_bulk_operations_action action.
*/
function views_bulk_operations_action(&$object, $context) {
$view_exposed_input = array();
if (!empty($context['view_exposed_input'])) {
$view_exposed_input = eval($context['view_exposed_input']);
}
$view_arguments = array();
if (!empty($context['view_arguments'])) {
$view_arguments = eval($context['view_arguments']);
}
if (!empty($context['operation_arguments'])) {
$operation_arguments = eval($context['operation_arguments']);
}
else {
$operation_arguments = $context;
foreach (array('operation_key', 'operation_arguments', 'views_vid', 'view_exposed_input', 'view_arguments') as $key) {
unset($operation_arguments[$key]);
}
}
views_bulk_operations_execute($context['view_vid'], $context['operation_key'], $operation_arguments, $view_exposed_input, $view_arguments);
}
/**
* Helper function to execute the chosen action upon selected objects.
*/
function _views_bulk_operations_execute($view, $objects, $operation, $operation_arguments, $options) {
// Get the object info we're dealing with.
$object_info = _views_bulk_operations_object_info_for_view($view);
if (!$object_info) return;
// Add action arguments.
$params = array();
if ($operation['configurable'] && is_array($operation_arguments)) {
$params += $operation_arguments;
}
// Add static callback arguments. Note that in the case of actions, static arguments
// are picked up from the database in actions_do().
if (isset($operation['callback arguments'])) {
$params += $operation['callback arguments'];
}
// Add this view as parameter.
$params['view'] = array(
'vid' => !empty($view->vid) ? $view->vid : $view->name,
'exposed_input' => $view->get_exposed_input(),
'arguments' => $view->args,
);
// Add static settings to the params.
if (!empty($options['settings'])) {
$params['settings'] = $options['settings'];
}
// Add object info to the params.
$params['object_info'] = $object_info;
if (version_compare(VERSION, '6.10', '<')) {
// Hack to force actions_do() to process any number of invocations.
// Check http://drupal.org/node/290282 to understand more.
// This was fixed as of D6.10: http://cvs.drupal.org/viewvc.py/drupal/drupal/includes/actions.inc?view=log&pathrev=DRUPAL-6-10
variable_set('actions_max_stack', 10000000);
}
if ($operation['aggregate'] != VBO_AGGREGATE_FORCED && $options['execution_type'] == VBO_EXECUTION_BATCH) {
$operations = array();
foreach ($objects as $num => $row) {
$oid = $row->{$view->base_field};
$operations[] = array('_views_bulk_operations_batch_process', array($oid, $row));
}
// Save the options in the session because Batch API doesn't give a way to
// send a parameter to the finished callback.
$_SESSION['vbo_options']['display_result'] = $options['display_result'];
$_SESSION['vbo_options']['operation'] = $operation;
$_SESSION['vbo_options']['params'] = $params;
$_SESSION['vbo_options']['object_info'] = $object_info;
$batch = array(
'operations' => $operations,
'finished' => '_views_bulk_operations_batch_finished',
'title' => t('Performing %action on selected rows...', array('%action' => $operation['label'])),
);
batch_set($batch);
}
else if ($operation['aggregate'] != VBO_AGGREGATE_FORCED && module_exists('job_queue') && $options['execution_type'] == VBO_EXECUTION_QUEUE) {
global $user;
foreach ($objects as $row) {
$oid = $row->{$view->base_field};
job_queue_add('_views_bulk_operations_queue_process',
t('Perform %action on @type %oid.', array(
'%action' => $operation['label'],
'@type' => t($object_info['type']),
'%oid' => $oid
)),
array($oid, $row, $operation, $params, $user->uid, $options['display_result'], $object_info)
);
$oids[] = $oid;
}
if ($options['display_result']) {
drupal_set_message(t('Enqueued %action on @types %oid. Check the queued jobs page.', array(
'%action' => $operation['label'],
'@types' => format_plural(count($objects), $object_info['type'], $object_info['type'] . 's'),
'%oid' => implode(', ', $oids),
'@queue' => url('admin/reports/job_queue')
)));
}
}
else /*if ($options['execution_type'] == VBO_EXECUTION_DIRECT)*/ {
@set_time_limit(0);
$context['results']['rows'] = 0;
$context['results']['time'] = microtime(TRUE);
_views_bulk_operations_direct_process($view, $operation, $objects, $params, $object_info, $context);
_views_bulk_operations_direct_finished(TRUE, $context['results'], array(), $options['display_result']);
}
}
/**
* Helper function to handle Job queue operations.
*/
function _views_bulk_operations_queue_process($oid, $row, $operation, $params, $uid, $display_result, $object_info) {
module_load_include('inc', 'node', 'node.admin');
$object = call_user_func($object_info['load'], $oid);
if (!$object) {
watchdog('views bulk operations', 'Skipped %action on @type id %oid.', array(
'%action' => $operation['label'],
'@type' => t($operation['type']),
'%oid' => $oid,
), WATCHDOG_ALERT);
return;
}
$account = user_load(array('uid' => $uid));
if (!_views_bulk_operations_object_permission($operation, $object, $object_info, $account)) {
watchdog('views bulk operations', 'Skipped %action on @type %title due to insufficient permissions.', array(
'%action' => $operation['label'],
'@type' => t($object_info['type']),
'%title' => $object->{$object_info['title']},
), WATCHDOG_ALERT);
return;
}
_views_bulk_operations_action_do($operation, $oid, $object, $row, $params, $object_info, $account);
if ($display_result) {
watchdog('views bulk operations', 'Performed %action on @type %title.', array(
'%action' => $operation['label'],
'@type' => t($object_info['type']),
'%title' => $object->{$object_info['title']},
), WATCHDOG_INFO);
}
}
/**
* Helper function to handle Batch API operations.
*/
function _views_bulk_operations_batch_process($oid, $row, &$context) {
module_load_include('inc', 'node', 'node.admin');
$operation = $_SESSION['vbo_options']['operation'];
$params = $_SESSION['vbo_options']['params'];
$object_info = $_SESSION['vbo_options']['object_info'];
if (!isset($context['results']['time'])) {
$context['results']['time'] = microtime(TRUE);
}
$object = call_user_func($object_info['load'], $oid);
if (!$object) {
$context['results']['log'][] = t('Skipped %action on @type id %oid.', array(
'%action' => $operation['label'],
'@type' => t($operation['type']),
'%oid' => $oid,
));
continue;
}
if (!_views_bulk_operations_object_permission($operation, $object, $object_info)) {
$context['results']['log'][] = t('Skipped %action on @type %title due to insufficient permissions.', array(
'%action' => $operation['label'],
'@type' => t($object_info['type']),
'%title' => $object->{$object_info['title']},
));
return;
}
_views_bulk_operations_action_do($operation, $oid, $object, $row, $params, $object_info);
$context['results']['log'][] = t('Performed %action on @type %title.', array(
'%action' => $operation['label'],
'@type' => t($object_info['type']),
'%title' => $object->{$object_info['title']},
));
if (isset($context['results']['rows'])) {
$context['results']['rows'] += 1;
}
else {
$context['results']['rows'] = 1;
}
}
/**
* Helper function to cleanup Batch API operations.
*/
function _views_bulk_operations_batch_finished($success, $results, $operations, $display_result = NULL) {
if ($success) {
if ($results['rows'] > 0) {
$message = t('!results rows processed in about !time ms:', array('!results' => $results['rows'], '!time' => round((microtime(TRUE) - $results['time']) * 1000)));
}
else {
$message = t('No rows were processed:');
}
$message .= "\n". theme('item_list', $results['log']);
}
else {
// An error occurred.
// $operations contains the operations that remained unprocessed.
$error_operation = reset($operations);
$message = t('An error occurred while processing @operation with arguments: @arguments',
array('@operation' => $error_operation[0], '@arguments' => print_r($error_operation[0], TRUE)));
}
if (version_compare(VERSION, '6.10', '<')) {
// See http://cvs.drupal.org/viewvc.py/drupal/drupal/includes/actions.inc?view=log&pathrev=DRUPAL-6-10
variable_set('actions_max_stack', 35);
}
if ($display_result || @$_SESSION['vbo_options']['display_result']) {
drupal_set_message($message);
}
unset($_SESSION['vbo_options']); // unset the options which were used for just one invocation
}
/**
* Helper function for direct execution operations.
*/
function _views_bulk_operations_direct_process($view, $operation, $objects, $params, $object_info, &$context) {
if ($operation['aggregate'] != VBO_AGGREGATE_FORBIDDEN) {
foreach ($objects as $num => $row) {
$oid = $row->{$view->base_field};
if (isset($object_info['access'])) {
$object = call_user_func($object_info['load'], $oid);
if (!$object) {
unset($objects[$num]);
$context['results']['log'][] = t('Skipped %action on @type id %oid.', array(
'%action' => $operation['label'],
'@type' => t($operation['type']),
'%oid' => $oid,
));
continue;
}
if (!_views_bulk_operations_object_permission($operation, $object, $object_info)) {
unset($objects[$num]);
$context['results']['log'][] = t('Skipped %action on @type %title due to insufficient permissions.', array(
'%action' => $operation['label'],
'@type' => t($object_info['type']),
'%title' => $object->{$object_info['title']},
));
continue;
}
}
$oids[] = $oid;
}
if (!empty($objects)) {
_views_bulk_operations_action_aggregate_do($operation, $oids, $objects, $params, $object_info);
$context['results']['log'][] = t('Performed aggregate %action on @types %oids.', array(
'%action' => $operation['label'],
'@types' => format_plural(count($objects), $object_info['type'], $object_info['type'] . 's'),
'%oids' => implode(',', $oids),
));
$context['results']['rows'] += count($objects);
}
}
else foreach ($objects as $num => $row) {
$oid = $row->{$view->base_field};
$object = call_user_func($object_info['load'], $oid);
if (!$object) {
$context['results']['log'][] = t('Skipped %action on @type id %oid.', array(
'%action' => $operation['label'],
'@type' => t($operation['type']),
'%oid' => $oid,
));
continue;
}
if (!_views_bulk_operations_object_permission($operation, $object, $object_info)) {
$context['results']['log'][] = t('Skipped %action on @type %title due to insufficient permissions.', array(
'%action' => $operation['label'],
'@type' => t($object_info['type']),
'%title' => $object->{$object_info['title']},
));
continue;
}
_views_bulk_operations_action_do($operation, $oid, $object, $row, $params, $object_info);
$context['results']['log'][] = t('Performed %action on @type %title.', array(
'%action' => $operation['label'],
'@type' => t($object_info['type']),
'%title' => $object->{$object_info['title']},
));
$context['results']['rows'] += 1;
}
}
/**
* Helper function to cleanup direct execution operations.
*/
function _views_bulk_operations_direct_finished($success, $results, $operations, $display_result) {
_views_bulk_operations_batch_finished($success, $results, $operations, $display_result);
}
/**
* Helper function to execute one operation.
*/
function _views_bulk_operations_action_do($operation, $oid, $object, $row, $params, $object_info, $account = NULL) {
_views_bulk_operations_action_permission($operation, $account);
// Add the object to the context.
if (isset($object_info['context'])) {
$params[$object_info['context']] = $object;
}
else {
$params[$object_info['type']] = $object;
}
// If the operation type is different from the view type, normalize the context first.
$actual_object = $object;
if ($object_info['type'] != $operation['type']) {
if (isset($object_info['normalize']) && function_exists($object_info['normalize'])) {
$actual_object = call_user_func($object_info['normalize'], $operation['type'], $object);
}
$params['hook'] = $object_info['hook'];
}
if (is_null($actual_object)) { // Normalize function can return NULL: we don't want that
$actual_object = $object;
}
$params['row'] = $row; // Expose the original view row to the action
if ($operation['source'] == 'action') {
actions_do($operation['callback'], $actual_object, $params);
if ($operation['type'] == 'node' && ($operation['access op'] & VBO_ACCESS_OP_UPDATE)) { // Save nodes explicitly if needed
$node_options = variable_get('node_options_'. $actual_object->type, array('status', 'promote'));
if (in_array('revision', $node_options) && !isset($actual_object->revision)) {
$actual_object->revision = TRUE;
$actual_object->log = '';
}
node_save($actual_object);
}
}
else { // source == 'operation'
$args = array_merge(array(array($oid)), $params);
call_user_func_array($operation['callback'], $args);
}
}
/**
* Helper function to execute an aggregate operation.
*/
function _views_bulk_operations_action_aggregate_do($operation, $oids, $objects, $params, $object_info) {
_views_bulk_operations_action_permission($operation);
$params[$operation['type']] = $objects;
if ($operation['source'] == 'action') {
actions_do($operation['callback'], $oids, $params);
}
else {
$args = array_merge(array($oids), $params);
call_user_func_array($operation['callback'], $args);
}
}
/**
* Helper function to verify access permission to execute operation.
*/
function _views_bulk_operations_action_permission($operation, $account = NULL) {
if (module_exists('actions_permissions')) {
$perm = actions_permissions_get_perm($operation['perm label'], $operation['callback']);
if (!user_access($perm, $account)) {
global $user;
watchdog('actions permissions', 'An attempt by user %user to !perm was blocked due to insufficient permissions.',
array('!perm' => $perm, '%user' => isset($account) ? $account->name : $user->name), WATCHDOG_ALERT);
drupal_access_denied();
exit();
}
}
// Check against additional permissions.
if (!empty($operation['permissions'])) foreach ($operation['permissions'] as $perm) {
if (!user_access($perm, $account)) {
global $user;
watchdog('actions permissions', 'An attempt by user %user to !perm was blocked due to insufficient permissions.',
array('!perm' => $perm, '%user' => isset($account) ? $account->name : $user->name), WATCHDOG_ALERT);
drupal_access_denied();
exit();
}
}
}
/**
* Helper function to verify access permission to operate on object.
*/
function _views_bulk_operations_object_permission($operation, $object, $object_info, $account = NULL) {
// Check against object access permissions.
if (!isset($object_info['access'])) return TRUE;
$access_ops = array(
VBO_ACCESS_OP_VIEW => 'view',
VBO_ACCESS_OP_UPDATE => 'update',
VBO_ACCESS_OP_CREATE => 'create',
VBO_ACCESS_OP_DELETE => 'delete',
);
foreach ($access_ops as $bit => $op) {
if ($operation['access op'] & $bit) {
if (!call_user_func($object_info['access'], $op, $object, $account)) {
return FALSE;
}
}
}
return TRUE;
}
/**
* Helper function to let the configurable action provide its configuration form.
*/
function _views_bulk_operations_action_form($action, $view, $selection, $settings, $context = array()) {
$action_form = $action['callback'] . '_form';
$context = array_merge($context, array('view' => $view, 'selection' => $selection, 'settings' => $settings, 'object_info' => _views_bulk_operations_object_info_for_view($view)));
if (isset($action['callback arguments'])) {
$context = array_merge($context, $action['callback arguments']);
}
$form = call_user_func($action_form, $context);
return is_array($form) ? $form : array();
}
/**
* Helper function to let the configurable action validate the form if it provides a validator.
*/
function _views_bulk_operations_action_validate($action, $form, $form_values) {
$action_validate = $action['callback'] . '_validate';
if (function_exists($action_validate)) {
call_user_func($action_validate, $form, $form_values);
}
}
/**
* Helper function to let the configurable action process the configuration form.
*/
function _views_bulk_operations_action_submit($action, $form, &$form_state) {
$action_submit = $action['callback'] . '_submit';
return call_user_func($action_submit, $form, $form_state);
}
/**
* Helper function to return all object info.
*/
function _views_bulk_operations_get_object_info($reset = FALSE) {
static $object_info = array();
if ($reset || empty($object_info)) {
$object_info = module_invoke_all('views_bulk_operations_object_info');
}
drupal_alter('views_bulk_operations_object_info', $object_info);
return $object_info;
}
/**
* Helper function to return object info for a given view.
*/
function _views_bulk_operations_object_info_for_view($view) {
foreach (_views_bulk_operations_get_object_info() as $object_info) {
if ($object_info['base_table'] == $view->base_table) {
return $object_info;
}
}
watchdog('views bulk operations', 'Could not find object info for view table @table.', array('@table' => $view->base_table), WATCHDOG_ERROR);
return NULL;
}
/**
* Helper to include all action files.
*/
function _views_bulk_operations_load_actions() {
$files = array(
'archive',
'argument_selector',
'delete',
'fields',
'profile',
'ruleset',
'script',
'taxonomy',
'user_roles',
);
foreach ($files as $file) {
module_load_include('inc', 'views_bulk_operations', "$file.action");
}
return $files;
}
/**
* Helper function to adjust the selected set of nodes based on different situations.
*/
function _views_bulk_operations_adjust_selection(&$selection, $select_all, $exposed_input, $arguments, $plugin) {
$url = url($_GET['q']);
// Adjust selection to select all nodes across pages.
$view = views_get_view($plugin->view->vid ? $plugin->view->vid : $plugin->view->name);
$view->set_items_per_page(0);
$view->set_exposed_input($exposed_input);
$view->set_arguments($arguments);
// HACK for date_api_filter_handler: set $_GET with the exposed_input.
$_GET += $exposed_input;
$view->execute($plugin->view->current_display);
if ($select_all) {
$selection = array();
foreach ($view->result as $num => $result) {
$selection[md5(serialize($result))] = $result;
}
}
else {
// Adjust selection to filter out previous selections.
$results = array();
foreach ($view->result as $num => $result) {
$md5 = md5(serialize($result));
if (!empty($selection[$md5]) || !empty($_SESSION['vbo_values'][$url]['objects']['selection'][$md5])) {
$results[$md5] = $result;
}
}
$selection = $results;
}
// Adjust sticky selection accordingly.
$_SESSION['vbo_values'][$url]['objects'] = array('selection' => $selection, 'select_all' => $select_all);
}
/**
* Helper callback for array_walk().
*/
function _views_bulk_operations_get_oid($row, $base_field) {
return $row->$base_field;
}