node.admin.inc

<?php


/**
 * @file
 * Content administration and module settings UI.
 */

/**
 * Menu callback: confirm rebuilding of permissions.
 *
 * @see node_configure_rebuild_confirm_submit()
 * @see node_menu()
 * @ingroup forms
 */
function node_configure_rebuild_confirm() {
    return confirm_form(array(), t('Are you sure you want to rebuild the permissions on site content?'), 'admin/reports/status', t('This action rebuilds all permissions on site content, and may be a lengthy process. This action cannot be undone.'), t('Rebuild permissions'), t('Cancel'));
}

/**
 * Handler for wipe confirmation
 *
 * @see node_configure_rebuild_confirm()
 */
function node_configure_rebuild_confirm_submit($form, &$form_state) {
    node_access_rebuild(TRUE);
    $form_state['redirect'] = 'admin/reports/status';
}

/**
 * Implements hook_node_operations().
 */
function node_node_operations() {
    $operations = array(
        'publish' => array(
            'label' => t('Publish selected content'),
            'callback' => 'node_mass_update',
            'callback arguments' => array(
                'updates' => array(
                    'status' => NODE_PUBLISHED,
                ),
            ),
        ),
        'unpublish' => array(
            'label' => t('Unpublish selected content'),
            'callback' => 'node_mass_update',
            'callback arguments' => array(
                'updates' => array(
                    'status' => NODE_NOT_PUBLISHED,
                ),
            ),
        ),
        'promote' => array(
            'label' => t('Promote selected content to front page'),
            'callback' => 'node_mass_update',
            'callback arguments' => array(
                'updates' => array(
                    'status' => NODE_PUBLISHED,
                    'promote' => NODE_PROMOTED,
                ),
            ),
        ),
        'demote' => array(
            'label' => t('Demote selected content from front page'),
            'callback' => 'node_mass_update',
            'callback arguments' => array(
                'updates' => array(
                    'promote' => NODE_NOT_PROMOTED,
                ),
            ),
        ),
        'sticky' => array(
            'label' => t('Make selected content sticky'),
            'callback' => 'node_mass_update',
            'callback arguments' => array(
                'updates' => array(
                    'status' => NODE_PUBLISHED,
                    'sticky' => NODE_STICKY,
                ),
            ),
        ),
        'unsticky' => array(
            'label' => t('Make selected content not sticky'),
            'callback' => 'node_mass_update',
            'callback arguments' => array(
                'updates' => array(
                    'sticky' => NODE_NOT_STICKY,
                ),
            ),
        ),
        'delete' => array(
            'label' => t('Delete selected content'),
            'callback' => NULL,
        ),
    );
    return $operations;
}

/**
 * List node administration filters that can be applied.
 *
 * @return
 *   An associative array of filters.
 */
function node_filters() {
    // Regular filters
    $filters['status'] = array(
        'title' => t('status'),
        'options' => array(
            '[any]' => t('any'),
            'status-1' => t('published'),
            'status-0' => t('not published'),
            'promote-1' => t('promoted'),
            'promote-0' => t('not promoted'),
            'sticky-1' => t('sticky'),
            'sticky-0' => t('not sticky'),
        ),
    );
    // Include translation states if we have this module enabled
    if (module_exists('translation')) {
        $filters['status']['options'] += array(
            'translate-0' => t('Up to date translation'),
            'translate-1' => t('Outdated translation'),
        );
    }
    $filters['type'] = array(
        'title' => t('type'),
        'options' => array(
            '[any]' => t('any'),
        ) + node_type_get_names(),
    );
    // Language filter if there is a list of languages
    if ($languages = module_invoke('locale', 'language_list')) {
        $languages = array(
            LANGUAGE_NONE => t('Language neutral'),
        ) + $languages;
        $filters['language'] = array(
            'title' => t('language'),
            'options' => array(
                '[any]' => t('any'),
            ) + $languages,
        );
    }
    return $filters;
}

/**
 * Applies filters for node administration filters based on session.
 *
 * @param $query
 *   A SelectQuery to which the filters should be applied.
 */
function node_build_filter_query(SelectQueryInterface $query) {
    // Build query
    $filter_data = isset($_SESSION['node_overview_filter']) ? $_SESSION['node_overview_filter'] : array();
    foreach ($filter_data as $index => $filter) {
        list($key, $value) = $filter;
        switch ($key) {
            case 'status':
                // Note: no exploitable hole as $key/$value have already been checked when submitted
                list($key, $value) = explode('-', $value, 2);
            case 'type':
            case 'language':
                $query->condition('n.' . $key, $value);
                break;
        }
    }
}

/**
 * Returns the node administration filters form array to node_admin_content().
 *
 * @see node_admin_nodes()
 * @see node_admin_nodes_submit()
 * @see node_admin_nodes_validate()
 * @see node_filter_form_submit()
 * @see node_multiple_delete_confirm()
 * @see node_multiple_delete_confirm_submit()
 *
 * @ingroup forms
 */
function node_filter_form() {
    $session = isset($_SESSION['node_overview_filter']) ? $_SESSION['node_overview_filter'] : array();
    $filters = node_filters();
    $i = 0;
    $form['filters'] = array(
        '#type' => 'fieldset',
        '#title' => t('Show only items where'),
        '#theme' => 'exposed_filters__node',
    );
    foreach ($session as $filter) {
        list($type, $value) = $filter;
        if ($type == 'term') {
            // Load term name from DB rather than search and parse options array.
            $value = module_invoke('taxonomy', 'term_load', $value);
            $value = $value->name;
        }
        elseif ($type == 'language') {
            $value = $value == LANGUAGE_NONE ? t('Language neutral') : module_invoke('locale', 'language_name', $value);
        }
        else {
            $value = $filters[$type]['options'][$value];
        }
        $t_args = array(
            '%property' => $filters[$type]['title'],
            '%value' => $value,
        );
        if ($i++) {
            $form['filters']['current'][] = array(
                '#markup' => t('and where %property is %value', $t_args),
            );
        }
        else {
            $form['filters']['current'][] = array(
                '#markup' => t('where %property is %value', $t_args),
            );
        }
        if (in_array($type, array(
            'type',
            'language',
        ))) {
            // Remove the option if it is already being filtered on.
            unset($filters[$type]);
        }
    }
    $form['filters']['status'] = array(
        '#type' => 'container',
        '#attributes' => array(
            'class' => array(
                'clearfix',
            ),
        ),
        '#prefix' => $i ? '<div class="additional-filters">' . t('and where') . '</div>' : '',
    );
    $form['filters']['status']['filters'] = array(
        '#type' => 'container',
        '#attributes' => array(
            'class' => array(
                'filters',
            ),
        ),
    );
    foreach ($filters as $key => $filter) {
        $form['filters']['status']['filters'][$key] = array(
            '#type' => 'select',
            '#options' => $filter['options'],
            '#title' => $filter['title'],
            '#default_value' => '[any]',
        );
    }
    $form['filters']['status']['actions'] = array(
        '#type' => 'actions',
        '#attributes' => array(
            'class' => array(
                'container-inline',
            ),
        ),
    );
    $form['filters']['status']['actions']['submit'] = array(
        '#type' => 'submit',
        '#value' => count($session) ? t('Refine') : t('Filter'),
    );
    if (count($session)) {
        $form['filters']['status']['actions']['undo'] = array(
            '#type' => 'submit',
            '#value' => t('Undo'),
        );
        $form['filters']['status']['actions']['reset'] = array(
            '#type' => 'submit',
            '#value' => t('Reset'),
        );
    }
    drupal_add_js('misc/form.js');
    return $form;
}

/**
 * Form submission handler for node_filter_form().
 *
 * @see node_admin_content()
 * @see node_admin_nodes()
 * @see node_admin_nodes_submit()
 * @see node_admin_nodes_validate()
 * @see node_filter_form()
 * @see node_multiple_delete_confirm()
 * @see node_multiple_delete_confirm_submit()
 */
function node_filter_form_submit($form, &$form_state) {
    $filters = node_filters();
    switch ($form_state['values']['op']) {
        case t('Filter'):
        case t('Refine'):
            // Apply every filter that has a choice selected other than 'any'.
            foreach ($filters as $filter => $options) {
                if (isset($form_state['values'][$filter]) && $form_state['values'][$filter] != '[any]') {
                    // Flatten the options array to accommodate hierarchical/nested options.
                    $flat_options = form_options_flatten($filters[$filter]['options']);
                    // Only accept valid selections offered on the dropdown, block bad input.
                    if (isset($flat_options[$form_state['values'][$filter]])) {
                        $_SESSION['node_overview_filter'][] = array(
                            $filter,
                            $form_state['values'][$filter],
                        );
                    }
                }
            }
            break;
        case t('Undo'):
            array_pop($_SESSION['node_overview_filter']);
            break;
        case t('Reset'):
            $_SESSION['node_overview_filter'] = array();
            break;
    }
}

/**
 * Make mass update of nodes, changing all nodes in the $nodes array
 * to update them with the field values in $updates.
 *
 * IMPORTANT NOTE: This function is intended to work when called from a form
 * submission handler. Calling it outside of the form submission process may not
 * work correctly.
 *
 * @param array $nodes
 *   Array of node nids to update.
 * @param array $updates
 *   Array of key/value pairs with node field names and the value to update that
 *   field to.
 */
function node_mass_update($nodes, $updates) {
    // We use batch processing to prevent timeout when updating a large number
    // of nodes.
    if (count($nodes) > 10) {
        $batch = array(
            'operations' => array(
                array(
                    '_node_mass_update_batch_process',
                    array(
                        $nodes,
                        $updates,
                    ),
                ),
            ),
            'finished' => '_node_mass_update_batch_finished',
            'title' => t('Processing'),
            // We use a single multi-pass operation, so the default
            // 'Remaining x of y operations' message will be confusing here.
'progress_message' => '',
            'error_message' => t('The update has encountered an error.'),
            // The operations do not live in the .module file, so we need to
            // tell the batch engine which file to load before calling them.
'file' => drupal_get_path('module', 'node') . '/node.admin.inc',
        );
        batch_set($batch);
    }
    else {
        foreach ($nodes as $nid) {
            _node_mass_update_helper($nid, $updates);
        }
        drupal_set_message(t('The update has been performed.'));
    }
}

/**
 * Updates individual nodes when fewer than 10 are queued.
 *
 * @param $nid
 *   ID of node to update.
 * @param $updates
 *   Associative array of updates.
 *
 * @return object
 *   An updated node object.
 *
 * @see node_mass_update()
 */
function _node_mass_update_helper($nid, $updates) {
    $node = node_load($nid, NULL, TRUE);
    // For efficiency manually save the original node before applying any changes.
    $node->original = clone $node;
    foreach ($updates as $name => $value) {
        $node->{$name} = $value;
    }
    node_save($node);
    return $node;
}

/**
 * Implements callback_batch_operation().
 *
 * Executes a batch operation for node_mass_update().
 *
 * @param array $nodes
 *   An array of node IDs.
 * @param array $updates
 *   Associative array of updates.
 * @param array $context
 *   An array of contextual key/values.
 */
function _node_mass_update_batch_process($nodes, $updates, &$context) {
    if (!isset($context['sandbox']['progress'])) {
        $context['sandbox']['progress'] = 0;
        $context['sandbox']['max'] = count($nodes);
        $context['sandbox']['nodes'] = $nodes;
    }
    // Process nodes by groups of 5.
    $count = min(5, count($context['sandbox']['nodes']));
    for ($i = 1; $i <= $count; $i++) {
        // For each nid, load the node, reset the values, and save it.
        $nid = array_shift($context['sandbox']['nodes']);
        $node = _node_mass_update_helper($nid, $updates);
        // Store result for post-processing in the finished callback.
        $context['results'][] = l($node->title, 'node/' . $node->nid);
        // Update our progress information.
        $context['sandbox']['progress']++;
    }
    // Inform the batch engine that we are not finished,
    // and provide an estimation of the completion level we reached.
    if ($context['sandbox']['progress'] != $context['sandbox']['max']) {
        $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
    }
}

/**
 * Implements callback_batch_finished().
 *
 * Reports the status of batch operation for node_mass_update().
 *
 * @param bool $success
 *   A boolean indicating whether the batch mass update operation successfully
 *   concluded.
 * @param int $results
 *   The number of nodes updated via the batch mode process.
 * @param array $operations
 *   An array of function calls (not used in this function).
 */
function _node_mass_update_batch_finished($success, $results, $operations) {
    if ($success) {
        drupal_set_message(t('The update has been performed.'));
    }
    else {
        drupal_set_message(t('An error occurred and processing did not complete.'), 'error');
        $message = format_plural(count($results), '1 item successfully processed:', '@count items successfully processed:');
        $message .= theme('item_list', array(
            'items' => $results,
        ));
        drupal_set_message($message);
    }
}

/**
 * Page callback: Form constructor for the content administration form.
 *
 * @see node_admin_nodes()
 * @see node_admin_nodes_submit()
 * @see node_admin_nodes_validate()
 * @see node_filter_form()
 * @see node_filter_form_submit()
 * @see node_menu()
 * @see node_multiple_delete_confirm()
 * @see node_multiple_delete_confirm_submit()
 * @ingroup forms
 */
function node_admin_content($form, $form_state) {
    if (isset($form_state['values']['operation']) && $form_state['values']['operation'] == 'delete') {
        return node_multiple_delete_confirm($form, $form_state, array_filter($form_state['values']['nodes']));
    }
    $form['filter'] = node_filter_form();
    $form['#submit'][] = 'node_filter_form_submit';
    $form['admin'] = node_admin_nodes();
    return $form;
}

/**
 * Form builder: Builds the node administration overview.
 *
 * @see node_admin_nodes_submit()
 * @see node_admin_nodes_validate()
 * @see node_filter_form()
 * @see node_filter_form_submit()
 * @see node_multiple_delete_confirm()
 * @see node_multiple_delete_confirm_submit()
 *
 * @ingroup forms
 */
function node_admin_nodes() {
    $admin_access = user_access('administer nodes');
    // Build the 'Update options' form.
    $form['options'] = array(
        '#type' => 'fieldset',
        '#title' => t('Update options'),
        '#attributes' => array(
            'class' => array(
                'container-inline',
            ),
        ),
        '#access' => $admin_access,
    );
    $options = array();
    foreach (module_invoke_all('node_operations') as $operation => $array) {
        $options[$operation] = $array['label'];
    }
    $form['options']['operation'] = array(
        '#type' => 'select',
        '#title' => t('Operation'),
        '#title_display' => 'invisible',
        '#options' => $options,
        '#default_value' => 'approve',
    );
    $form['options']['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Update'),
        '#validate' => array(
            'node_admin_nodes_validate',
        ),
        '#submit' => array(
            'node_admin_nodes_submit',
        ),
    );
    // Enable language column if translation module is enabled or if we have any
    // node with language.
    $multilanguage = module_exists('translation') || db_query_range("SELECT 1 FROM {node} WHERE language <> :language", 0, 1, array(
        ':language' => LANGUAGE_NONE,
    ))->fetchField();
    // Build the sortable table header.
    $header = array(
        'title' => array(
            'data' => t('Title'),
            'field' => 'n.title',
        ),
        'type' => array(
            'data' => t('Type'),
            'field' => 'n.type',
        ),
        'author' => t('Author'),
        'status' => array(
            'data' => t('Status'),
            'field' => 'n.status',
        ),
        'changed' => array(
            'data' => t('Updated'),
            'field' => 'n.changed',
            'sort' => 'desc',
        ),
    );
    if ($multilanguage) {
        $header['language'] = array(
            'data' => t('Language'),
            'field' => 'n.language',
        );
    }
    $header['operations'] = array(
        'data' => t('Operations'),
    );
    $query = db_select('node', 'n')->extend('PagerDefault')
        ->extend('TableSort');
    $query->addTag('node_admin_filter');
    node_build_filter_query($query);
    if (!user_access('bypass node access')) {
        // If the user is able to view their own unpublished nodes, allow them
        // to see these in addition to published nodes. Check that they actually
        // have some unpublished nodes to view before adding the condition.
        if (user_access('view own unpublished content') && ($own_unpublished = db_query('SELECT nid FROM {node} WHERE uid = :uid AND status = :status', array(
            ':uid' => $GLOBALS['user']->uid,
            ':status' => 0,
        ))
            ->fetchCol())) {
            $query->condition(db_or()->condition('n.status', 1)
                ->condition('n.nid', $own_unpublished, 'IN'));
        }
        else {
            // If not, restrict the query to published nodes.
            $query->condition('n.status', 1);
        }
    }
    $nids = $query->fields('n', array(
        'nid',
    ))
        ->limit(50)
        ->orderByHeader($header)
        ->addTag('node_access')
        ->execute()
        ->fetchCol();
    $nodes = node_load_multiple($nids);
    // Prepare the list of nodes.
    $languages = language_list();
    $destination = drupal_get_destination();
    $options = array();
    foreach ($nodes as $node) {
        $langcode = entity_language('node', $node);
        $uri = entity_uri('node', $node);
        if ($langcode != LANGUAGE_NONE && isset($languages[$langcode])) {
            $uri['options']['language'] = $languages[$langcode];
        }
        $options[$node->nid] = array(
            'title' => array(
                'data' => array(
                    '#type' => 'link',
                    '#title' => $node->title,
                    '#href' => $uri['path'],
                    '#options' => $uri['options'],
                    '#suffix' => ' ' . theme('mark', array(
                        'type' => node_mark($node->nid, $node->changed),
                    )),
                ),
            ),
            'type' => check_plain(node_type_get_name($node)),
            'author' => theme('username', array(
                'account' => $node,
            )),
            'status' => $node->status ? t('published') : t('not published'),
            'changed' => format_date($node->changed, 'short'),
        );
        if ($multilanguage) {
            if ($langcode == LANGUAGE_NONE || isset($languages[$langcode])) {
                $options[$node->nid]['language'] = $langcode == LANGUAGE_NONE ? t('Language neutral') : t($languages[$langcode]->name);
            }
            else {
                $options[$node->nid]['language'] = t('Undefined language (@langcode)', array(
                    '@langcode' => $langcode,
                ));
            }
        }
        // Build a list of all the accessible operations for the current node.
        $operations = array();
        if (node_access('update', $node)) {
            $operations['edit'] = array(
                'title' => t('edit'),
                'href' => 'node/' . $node->nid . '/edit',
                'query' => $destination,
            );
        }
        if (node_access('delete', $node)) {
            $operations['delete'] = array(
                'title' => t('delete'),
                'href' => 'node/' . $node->nid . '/delete',
                'query' => $destination,
            );
        }
        $options[$node->nid]['operations'] = array();
        if (count($operations) > 1) {
            // Render an unordered list of operations links.
            $options[$node->nid]['operations'] = array(
                'data' => array(
                    '#theme' => 'links__node_operations',
                    '#links' => $operations,
                    '#attributes' => array(
                        'class' => array(
                            'links',
                            'inline',
                        ),
                    ),
                ),
            );
        }
        elseif (!empty($operations)) {
            // Render the first and only operation as a link.
            $link = reset($operations);
            $options[$node->nid]['operations'] = array(
                'data' => array(
                    '#type' => 'link',
                    '#title' => $link['title'],
                    '#href' => $link['href'],
                    '#options' => array(
                        'query' => $link['query'],
                    ),
                ),
            );
        }
    }
    // Only use a tableselect when the current user is able to perform any
    // operations.
    if ($admin_access) {
        $form['nodes'] = array(
            '#type' => 'tableselect',
            '#header' => $header,
            '#options' => $options,
            '#empty' => t('No content available.'),
        );
    }
    else {
        $form['nodes'] = array(
            '#theme' => 'table',
            '#header' => $header,
            '#rows' => $options,
            '#empty' => t('No content available.'),
        );
    }
    $form['pager'] = array(
        '#markup' => theme('pager'),
    );
    return $form;
}

/**
 * Validate node_admin_nodes form submissions.
 *
 * Checks whether any nodes have been selected to perform the chosen 'Update
 * option' on.
 *
 * @see node_admin_nodes()
 * @see node_admin_nodes_submit()
 * @see node_filter_form()
 * @see node_filter_form_submit()
 * @see node_multiple_delete_confirm()
 * @see node_multiple_delete_confirm_submit()
 */
function node_admin_nodes_validate($form, &$form_state) {
    // Error if there are no items to select.
    if (!is_array($form_state['values']['nodes']) || !count(array_filter($form_state['values']['nodes']))) {
        form_set_error('', t('No items selected.'));
    }
}

/**
 * Process node_admin_nodes form submissions.
 *
 * Executes the chosen 'Update option' on the selected nodes.
 *
 * @see node_admin_nodes()
 * @see node_admin_nodes_validate()
 * @see node_filter_form()
 * @see node_filter_form_submit()
 * @see node_multiple_delete_confirm()
 * @see node_multiple_delete_confirm_submit()
 */
function node_admin_nodes_submit($form, &$form_state) {
    $operations = module_invoke_all('node_operations');
    $operation = $operations[$form_state['values']['operation']];
    // Filter out unchecked nodes
    $nodes = array_filter($form_state['values']['nodes']);
    if ($function = $operation['callback']) {
        // Add in callback arguments if present.
        if (isset($operation['callback arguments'])) {
            $args = array_merge(array(
                $nodes,
            ), $operation['callback arguments']);
        }
        else {
            $args = array(
                $nodes,
            );
        }
        call_user_func_array($function, $args);
        cache_clear_all();
    }
    else {
        // We need to rebuild the form to go to a second step. For example, to
        // show the confirmation form for the deletion of nodes.
        $form_state['rebuild'] = TRUE;
    }
}

/**
 * Multiple node deletion confirmation form for node_admin_content().
 *
 * @see node_admin_nodes()
 * @see node_admin_nodes_submit()
 * @see node_admin_nodes_validate()
 * @see node_filter_form()
 * @see node_filter_form_submit()
 * @see node_multiple_delete_confirm_submit()
 * @ingroup forms
 */
function node_multiple_delete_confirm($form, &$form_state, $nodes) {
    $form['nodes'] = array(
        '#prefix' => '<ul>',
        '#suffix' => '</ul>',
        '#tree' => TRUE,
    );
    // array_filter returns only elements with TRUE values
    foreach ($nodes as $nid => $value) {
        $title = db_query('SELECT title FROM {node} WHERE nid = :nid', array(
            ':nid' => $nid,
        ))->fetchField();
        $form['nodes'][$nid] = array(
            '#type' => 'hidden',
            '#value' => $nid,
            '#prefix' => '<li>',
            '#suffix' => check_plain($title) . "</li>\n",
        );
    }
    $form['operation'] = array(
        '#type' => 'hidden',
        '#value' => 'delete',
    );
    $form['#submit'][] = 'node_multiple_delete_confirm_submit';
    $confirm_question = format_plural(count($nodes), 'Are you sure you want to delete this item?', 'Are you sure you want to delete these items?');
    return confirm_form($form, $confirm_question, 'admin/content', t('This action cannot be undone.'), t('Delete'), t('Cancel'));
}

/**
 * Form submission handler for node_multiple_delete_confirm().
 *
 * @see node_admin_nodes()
 * @see node_admin_nodes_submit()
 * @see node_admin_nodes_validate()
 * @see node_filter_form()
 * @see node_filter_form_submit()
 * @see node_multiple_delete_confirm()
 */
function node_multiple_delete_confirm_submit($form, &$form_state) {
    if ($form_state['values']['confirm']) {
        node_delete_multiple(array_keys($form_state['values']['nodes']));
        cache_clear_all();
        $count = count($form_state['values']['nodes']);
        watchdog('content', 'Deleted @count posts.', array(
            '@count' => $count,
        ));
        drupal_set_message(format_plural($count, 'Deleted 1 post.', 'Deleted @count posts.'));
    }
    $form_state['redirect'] = 'admin/content';
}