You are here

Home » API reference » Diff 7.2

diff.pages.inc in Diff 7.2

Same filename and directory in other branches
  1. 6.2 diff.pages.inc
  2. 7.3 diff.pages.inc

Menu callbacks for hook_menu().

File

diff.pages.inc
View source 
<?php

// $Id$

/**
 * @file
 * Menu callbacks for hook_menu().
 */

/**
 * Menu callback - show latest diff for a given node.
 */
function diff_latest($node) {
  $revisions = node_revision_list($node);
  $new = array_shift($revisions);
  $old = array_shift($revisions);
  drupal_goto("node/{$node->nid}/revisions/view/{$old->vid}/{$new->vid}");
}

/**
 * Generate an overview table of older revisions of a node and provide
 * an input form to select two revisions for a comparison.
 */
function diff_diffs_overview($node) {
  drupal_set_title(t('Revisions for %title', array(
    '%title' => $node->title,
  )), PASS_THROUGH);
  return drupal_get_form('diff_node_revisions', $node);
}

/**
 * Input form to select two revisions.
 *
 * @param $node
 *   Node whose revisions are displayed for selection.
 */
function diff_node_revisions($form, $form_state, $node) {
  global $form_values;

  // $form = array();
  $form['nid'] = array(
    '#type' => 'hidden',
    '#value' => $node->nid,
  );
  $revision_list = node_revision_list($node);
  if (count($revision_list) > REVISION_LIST_SIZE) {

    // If the list of revisions is longer than the number shown on one page split the array.
    $page = isset($_GET['page']) ? $_GET['page'] : '0';
    $revision_chunks = array_chunk(node_revision_list($node), REVISION_LIST_SIZE);
    $revisions = $revision_chunks[$page];

    // Set up global pager variables as would 'pager_query' do.
    // These variables are then used in the theme('pager') call later.
    global $pager_page_array, $pager_total, $pager_total_items;
    $pager_total_items[0] = count($revision_list);
    $pager_total[0] = ceil(count($revision_list) / REVISION_LIST_SIZE);
    $pager_page_array[0] = max(0, min($page, (int) $pager_total[0] - 1));
  }
  else {
    $revisions = $revision_list;
  }
  $revert_permission = FALSE;
  if ((user_access('revert revisions') || user_access('administer nodes')) && node_access('update', $node)) {
    $revert_permission = TRUE;
  }
  $delete_permission = FALSE;
  if ((user_access('delete revisions') || user_access('administer nodes')) && node_access('delete', $node)) {
    $delete_permission = TRUE;
  }
  foreach ($revisions as $revision) {
    $operations = array();
    $revision_ids[$revision->vid] = '';
    if ($revision->current_vid > 0) {
      $form['info'][$revision->vid] = array(
        '#markup' => t('!date by !username', array(
          '!date' => l(format_date($revision->timestamp, 'small'), "node/{$node->nid}"),
          '!username' => theme('username', array(
            'account' => $revision,
          )),
        )) . ($revision->log != '' ? '<p class="revision-log">' . filter_xss($revision->log) . '</p>' : ''),
      );
    }
    else {
      $form['info'][$revision->vid] = array(
        '#markup' => t('!date by !username', array(
          '!date' => l(format_date($revision->timestamp, 'small'), "node/{$node->nid}/revisions/{$revision->vid}/view"),
          '!username' => theme('username', array(
            'account' => $revision,
          )),
        )) . ($revision->log != '' ? '<p class="revision-log">' . filter_xss($revision->log) . '</p>' : ''),
      );
      if ($revert_permission) {
        $operations[] = array(
          '#markup' => l(t('revert'), "node/{$node->nid}/revisions/{$revision->vid}/revert"),
        );
      }
      if ($delete_permission) {
        $operations[] = array(
          '#markup' => l(t('delete'), "node/{$node->nid}/revisions/{$revision->vid}/delete"),
        );
      }

      // Set a dummy, even if the user has no permission for the other
      // operations, so that we can check if the operations array is
      // empty to know if the row denotes the current revision.
      $operations[] = array();
    }
    $form['operations'][$revision->vid] = $operations;
  }
  $new_vid = key($revision_ids);
  next($revision_ids);
  $old_vid = key($revision_ids);
  $form['diff']['old'] = array(
    '#type' => 'radios',
    '#options' => $revision_ids,
    '#default_value' => $old_vid,
  );
  $form['diff']['new'] = array(
    '#type' => 'radios',
    '#options' => $revision_ids,
    '#default_value' => $new_vid,
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Show diff'),
  );
  if (count($revision_list) > REVISION_LIST_SIZE) {
    $form['#suffix'] = theme('pager');
  }
  return $form;
}

/**
 * Submit code for input form to select two revisions.
 */
function diff_node_revisions_submit($form, &$form_state) {

  // the ids are ordered so the old revision is always on the left
  $old_vid = min($form_state['values']['old'], $form_state['values']['new']);
  $new_vid = max($form_state['values']['old'], $form_state['values']['new']);
  $form_state['redirect'] = 'node/' . $form_state['values']['nid'] . '/revisions/view/' . $old_vid . '/' . $new_vid;
}

/**
 * Validation for input form to select two revisions.
 */
function diff_node_revisions_validate($form, &$form_state) {
  $old_vid = $form_state['values']['old'];
  $new_vid = $form_state['values']['new'];
  if ($old_vid == $new_vid || !$old_vid || !$new_vid) {
    form_set_error('diff', t('Select different revisions to compare.'));
  }
}

/**
 * Create output string for a comparison of 'node' between
 * versions 'old_vid' and 'new_vid'.
 *
 * @param $node
 *   Node on which to perform comparison
 * @param $old_vid
 *   Version ID of the old revision.
 * @param $new_vid
 *   Version ID of the new revision.
 * @param $remove_markup
 *   Strip markup before doing the diff
 */
function diff_diffs_show($node, $old_vid, $new_vid, $remove_markup = NULL) {

  // Set same title as on the 'Revisions' tab for consistency
  drupal_set_title(t('Revisions for @title', array(
    '@title' => $node->title,
  )));
  $node_revisions = node_revision_list($node);
  $old_node = node_load($node->nid, $old_vid);
  $new_node = node_load($node->nid, $new_vid);

  // Set default for remove markup if not set
  if ($remove_markup == NULL) {
    $remove_markup = variable_get('remove_markup_default_' . $node->type, FALSE);
  }

  // Generate table header (date, username, logmessage).
  $old_header = t('!date by !username', array(
    '!date' => l(format_date($old_node->revision_timestamp), "node/{$node->nid}/revisions/{$old_node->vid}/view"),
    '!username' => theme('username', array(
      'account' => $node_revisions[$old_vid],
    )),
  ));
  $new_header = t('!date by !username', array(
    '!date' => l(format_date($new_node->revision_timestamp), "node/{$node->nid}/revisions/{$new_node->vid}/view"),
    '!username' => theme('username', array(
      'account' => $node_revisions[$new_vid],
    )),
  ));
  $old_log = $old_node->log != '' ? '<p class="revision-log">' . filter_xss($old_node->log) . '</p>' : '';
  $new_log = $new_node->log != '' ? '<p class="revision-log">' . filter_xss($new_node->log) . '</p>' : '';

  // Generate previous diff/next diff links.
  $next_vid = _diff_get_next_vid($node_revisions, $new_vid);
  if ($next_vid) {
    $next_link = l(t('next diff >'), 'node/' . $node->nid . '/revisions/view/' . $new_vid . '/' . $next_vid);
  }
  else {
    $next_link = '';
  }
  $prev_vid = _diff_get_previous_vid($node_revisions, $old_vid);
  if ($prev_vid) {
    $prev_link = l(t('< previous diff'), 'node/' . $node->nid . '/revisions/view/' . $prev_vid . '/' . $old_vid);
  }
  else {
    $prev_link = '';
  }
  $cols = _diff_default_cols();
  $header = _diff_default_header($old_header, $new_header);
  $rows = array();
  if ($old_log || $new_log) {
    $rows[] = array(
      array(
        'data' => $old_log,
        'colspan' => 2,
      ),
      array(
        'data' => $new_log,
        'colspan' => 2,
      ),
    );
  }
  $rows[] = array(
    array(
      'data' => $prev_link,
      'class' => array(
        'diff-prevlink',
      ),
      'colspan' => 2,
    ),
    array(
      'data' => $next_link,
      'class' => array(
        'diff-nextlink',
      ),
      'colspan' => 2,
    ),
  );
  if ($remove_markup) {
    $show_hide_markup_link = l(t('Show Markup'), 'node/' . $node->nid . '/revisions/view/' . $old_vid . '/' . $new_vid . '/0');
  }
  else {
    $show_hide_markup_link = l(t('Hide Markup'), 'node/' . $node->nid . '/revisions/view/' . $old_vid . '/' . $new_vid . '/1');
  }
  $rows[] = array(
    array(
      'data' => $show_hide_markup_link,
      'class' => 'diff-prevlink',
      'colspan' => 4,
    ),
  );
  $rows = array_merge($rows, _diff_body_rows($old_node, $new_node, $remove_markup));
  $output = theme('diff_table', array(
    'header' => $header,
    'rows' => $rows,
    'attributes' => array(
      'class' => array(
        'diff',
      ),
    ),
    'cols' => $cols,
  ));
  if ($node->vid == $new_vid) {
    $output .= '<div class="diff-section-title">' . t('Current revision:') . '</div>';
  }
  else {
    $output .= '<div class="diff-section-title">' . t('Revision of !new_date:', array(
      '!new_date' => format_date($new_node->revision_timestamp),
    )) . '</div>';
  }

  // Don't include node links (final argument) when viewing the diff.
  $view = node_view($new_node, 'full');
  $output .= drupal_render($view);
  return $output;
}

/**
 * Creates an array of rows which represent a diff between $old_node and $new_node.
 * The rows can be used via theme('diff_table') to be displayed.
 *
 * @param $old_node
 *   Node for comparison which will be displayed on the left side.
 * @param $new_node
 *   Node for comparison which will be displayed on the right side.
 * @param $remove_markup
 *   Strip markup before doing the diff
 */
function _diff_body_rows($old_node, $new_node, $remove_markup = FALSE) {
  drupal_add_css(drupal_get_path('module', 'diff') . '/diff.css');
  module_load_include('inc', 'diff', 'includes/node');
  $rows = array();
  $any_visible_change = FALSE;

  // @todo quick workaround for PHP >= 5.3.0 date_diff() conflict.
  $node_diffs = _diff_module_invoke_all($old_node, $new_node, $remove_markup);

  // We start off assuming all form elements are in the correct order.
  $node_diffs['#sorted'] = TRUE;

  // Recurse through all child elements.
  $count = 0;
  foreach (element_children($node_diffs) as $key) {

    // Assign a decimal placeholder weight to preserve original array order.
    if (!isset($node_diffs[$key]['#weight'])) {
      $node_diffs[$key]['#weight'] = $count / 1000;
    }
    else {

      // If one of the child elements has a weight then we will need to sort
      // later.
      unset($node_diffs['#sorted']);
    }
    $count++;
  }

  // One of the children has a #weight.
  if (!isset($node_diffs['#sorted'])) {
    uasort($node_diffs, "element_sort");
  }

  // Render diffs for each.
  foreach ($node_diffs as $node_diff) {
    $show_header = isset($node_diff['#format']['show_header']) ? $node_diff['#format']['show_header'] : FALSE;
    if ($node_diff_rows = diff_get_rows($node_diff['#old'], $node_diff['#new'], $show_header)) {
      $rows[] = array(
        array(
          'data' => t('Changes to %name', array(
            '%name' => $node_diff['#name'],
          )),
          'class' => 'diff-section-title',
          'colspan' => 4,
        ),
      );
      $rows = array_merge($rows, $node_diff_rows);
      $any_visible_change = TRUE;
    }
  }
  if (!$any_visible_change) {
    $rows[] = array(
      array(
        'data' => t('No visible changes'),
        'class' => 'diff-section-title',
        'colspan' => 4,
      ),
    );

    // Needed to keep safari happy
    $rows[] = array(
      array(
        'data' => '',
      ),
      array(
        'data' => '',
      ),
      array(
        'data' => '',
      ),
      array(
        'data' => '',
      ),
    );
  }
  return $rows;
}

/**
 * Helper function to invoke hook_diff in all enabled modules that implement it.
 *
 * Don't use module_invoke_all() since if date.module is enabled will clash with
 * PHP 5.3's date_diff() function.
 *
 * @todo figure out any else possible solution but not workaround.
 * @link http://drupal.org/node/639320
 * @see module_invoke_all()
 */
function _diff_module_invoke_all($old_node, $new_node, $remove_markup = FALSE) {
  $return = array();
  foreach (module_implements('diff') as $module) {
    if ($module == 'date') {
      continue;

      // Avoid function name collision with date_diff().
    }
    $function = "{$module}_diff";
    $result = $function($old_node, $new_node, $remove_markup);
    if (isset($result) && is_array($result)) {
      $return = array_merge_recursive($return, $result);
    }
    elseif (isset($result)) {
      $return[] = $result;
    }
  }
  return $return;
}

/**
 * Get the entry in the revisions list after $vid.
 * Returns FALSE if $vid is the last entry.
 *
 * @param $node_revisions
 *   Array of node revision IDs in descending order.
 * @param $vid
 *   Version ID to look for.
 */
function _diff_get_next_vid($node_revisions, $vid) {
  $previous = NULL;
  foreach ($node_revisions as $revision) {
    if ($revision->vid == $vid) {
      return $previous ? $previous->vid : FALSE;
    }
    $previous = $revision;
  }
  return FALSE;
}

/**
 * Get the entry in the revision list before $vid.
 * Returns FALSE if $vid is the first entry.
 *
 * @param $node_revisions
 *   Array of node revision IDs in descending order.
 * @param $vid
 *   Version ID to look for.
 */
function _diff_get_previous_vid($node_revisions, $vid) {
  $previous = NULL;
  foreach ($node_revisions as $revision) {
    if ($previous && $previous->vid == $vid) {
      return $revision->vid;
    }
    $previous = $revision;
  }
  return FALSE;
}

/**
 * Helper function to create default 'cols' array for diff table.
 */
function _diff_default_cols() {
  return array(
    array(
      array(
        'class' => 'diff-marker',
      ),
      array(
        'class' => 'diff-content',
      ),
      array(
        'class' => 'diff-marker',
      ),
      array(
        'class' => 'diff-content',
      ),
    ),
  );
}

/**
 * Helper function to create default 'header' array for diff table.
 */
function _diff_default_header($old_header = '', $new_header = '') {
  return array(
    array(
      'data' => $old_header,
      'colspan' => 2,
    ),
    array(
      'data' => $new_header,
      'colspan' => 2,
    ),
  );
}

/**
 * Show the inline diff for a given node, vid. If vid = 0 or no previous vid
 * exists for the given revision returns the normally rendered content of the
 * specified revision.
 */
function diff_inline_show($node, $vid = 0, $metadata = TRUE) {
  $new_node = $vid ? node_load($node->nid, $vid, TRUE) : clone $node;
  node_build_content($new_node);
  $new = drupal_render($new_node->content);
  $old = $vid ? _diff_get_previous_vid(node_revision_list($node), $vid) : 0;
  if ($old) {
    $old_node = node_load($node->nid, $old, TRUE);
    node_build_content($old_node);
    $old = drupal_render($old_node->content);
    $output = $metadata ? theme('diff_inline_metadata', array(
      'node' => $new_node,
    )) : '';
    $output .= diff_get_inline($old, $new);
    return $output;
  }
  return $new;
}

Functions

Namesort descending Description
diff_diffs_overview Generate an overview table of older revisions of a node and provide an input form to select two revisions for a comparison.
diff_diffs_show Create output string for a comparison of 'node' between versions 'old_vid' and 'new_vid'.
diff_inline_show Show the inline diff for a given node, vid. If vid = 0 or no previous vid exists for the given revision returns the normally rendered content of the specified revision.
diff_latest Menu callback - show latest diff for a given node.
diff_node_revisions Input form to select two revisions.
diff_node_revisions_submit Submit code for input form to select two revisions.
diff_node_revisions_validate Validation for input form to select two revisions.
_diff_body_rows Creates an array of rows which represent a diff between $old_node and $new_node. The rows can be used via theme('diff_table') to be displayed.
_diff_default_cols Helper function to create default 'cols' array for diff table.
_diff_default_header Helper function to create default 'header' array for diff table.
_diff_get_next_vid Get the entry in the revisions list after $vid. Returns FALSE if $vid is the last entry.
_diff_get_previous_vid Get the entry in the revision list before $vid. Returns FALSE if $vid is the first entry.
_diff_module_invoke_all Helper function to invoke hook_diff in all enabled modules that implement it.