node.pages.inc 20.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
<?php
// $Id$

/**
 * @file
 * Page callbacks for adding, editing, deleting, and revisions management for content.
 */


/**
 * Menu callback; presents the node editing form, or redirects to delete confirmation.
 */
function node_page_edit($node) {
14
  drupal_set_title($node->title);
15
  return drupal_get_form($node->type . '_node_form', $node);
16 17 18 19
}

function node_add_page() {
  $item = menu_get_item();
20
  $content = system_admin_menu_block($item);
21 22 23 24 25
  // Bypass the node/add listing if only one content type is available.
  if (count($content) == 1) {
    $item = array_shift($content);
    drupal_goto($item['href']);
  }
26 27 28
  return theme('node_add_list', $content);
}

29 30 31 32 33
/**
 * Display the list of available node types for node creation.
 *
 * @ingroup themeable
 */
34 35 36 37 38 39
function theme_node_add_list($content) {
  $output = '';

  if ($content) {
    $output = '<dl class="node-type-list">';
    foreach ($content as $item) {
40
      $output .= '<dt>' . l($item['title'], $item['href'], $item['localized_options']) . '</dt>';
41
      $output .= '<dd>' . filter_xss_admin($item['description']) . '</dd>';
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
    }
    $output .= '</dl>';
  }
  return $output;
}


/**
 * Present a node submission form or a set of links to such forms.
 */
function node_add($type) {
  global $user;

  $types = node_get_types();
  $type = isset($type) ? str_replace('-', '_', $type) : NULL;
  // If a node type has been specified, validate its existence.
  if (isset($types[$type]) && node_access('create', $type)) {
    // Initialize settings:
60
    $node = array('uid' => $user->uid, 'name' => (isset($user->name) ? $user->name : ''), 'type' => $type, 'language' => '');
61 62

    drupal_set_title(t('Create @name', array('@name' => $types[$type]->name)));
63
    $output = drupal_get_form($type . '_node_form', $node);
64 65 66 67 68 69 70 71 72 73
  }

  return $output;
}

function node_form_validate($form, &$form_state) {
  node_validate($form_state['values'], $form);
}

function node_object_prepare(&$node) {
74
  // Set up default values, if required.
75
  $node_options = variable_get('node_options_' . $node->type, array('status', 'promote'));
76 77 78 79 80 81 82
  // If this is a new node, fill in the default values.
  if (!isset($node->nid)) {
    foreach (array('status', 'promote', 'sticky') as $key) {
      $node->$key = in_array($key, $node_options);
    }
    global $user;
    $node->uid = $user->uid;
83 84 85 86
    $node->created = time();
  }
  else {
    $node->date = format_date($node->created, 'custom', 'Y-m-d H:i:s O');
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
  }
  // Always use the default revision setting.
  $node->revision = in_array('revision', $node_options);

  node_invoke($node, 'prepare');
  node_invoke_nodeapi($node, 'prepare');
}

/**
 * Generate the node add/edit form array.
 */
function node_form(&$form_state, $node) {
  global $user;

  if (isset($form_state['node'])) {
    $node = $form_state['node'] + (array)$node;
  }
  if (isset($form_state['node_preview'])) {
    $form['#prefix'] = $form_state['node_preview'];
  }
  $node = (object)$node;
  foreach (array('body', 'title', 'format') as $key) {
    if (!isset($node->$key)) {
      $node->$key = NULL;
    }
  }
113 114 115
  if (!isset($form_state['node_preview'])) {
    node_object_prepare($node);
  }
116 117 118
  else {
    $node->build_mode = NODE_BUILD_PREVIEW;
  }
119 120 121 122

  // Set the id of the top-level form tag
  $form['#id'] = 'node-form';

123 124
  // Basic node information.
  // These elements are just values so they are not even sent to the client.
125
  foreach (array('nid', 'vid', 'uid', 'created', 'type', 'language') as $key) {
126
    $form[$key] = array(
127
      '#type' => 'value',
128 129
      '#value' => isset($node->$key) ? $node->$key : NULL,
    );
130 131 132
  }

  // Changed must be sent to the client, for later overwrite error checking.
133
  $form['changed'] = array(
134
    '#type' => 'hidden',
135 136
    '#default_value' => isset($node->changed) ? $node->changed : NULL,
  );
137 138 139 140 141 142 143 144 145 146 147 148
  // Get the node-specific bits.
  if ($extra = node_invoke($node, 'form', $form_state)) {
    $form = array_merge_recursive($form, $extra);
  }
  if (!isset($form['title']['#weight'])) {
    $form['title']['#weight'] = -5;
  }

  $form['#node'] = $node;

  // Add a log field if the "Create new revision" option is checked, or if the
  // current user has the ability to check that option.
149
  if (!empty($node->revision) || user_access('administer nodes')) {
150 151 152 153 154 155 156 157 158
    $form['revision_information'] = array(
      '#type' => 'fieldset',
      '#title' => t('Revision information'),
      '#collapsible' => TRUE,
      // Collapsed by default when "Create new revision" is unchecked
      '#collapsed' => !$node->revision,
      '#weight' => 20,
    );
    $form['revision_information']['revision'] = array(
159
      '#access' => user_access('administer nodes'),
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
      '#type' => 'checkbox',
      '#title' => t('Create new revision'),
      '#default_value' => $node->revision,
    );
    $form['revision_information']['log'] = array(
      '#type' => 'textarea',
      '#title' => t('Log message'),
      '#rows' => 2,
      '#description' => t('An explanation of the additions or updates being made to help other authors understand your motivations.'),
    );
  }

  // Node author information for administrators
  $form['author'] = array(
    '#type' => 'fieldset',
    '#access' => user_access('administer nodes'),
    '#title' => t('Authoring information'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#weight' => 20,
  );
181
  $form['author']['name'] = array(
182 183 184 185 186 187
    '#type' => 'textfield',
    '#title' => t('Authored by'),
    '#maxlength' => 60,
    '#autocomplete_path' => 'user/autocomplete',
    '#default_value' => $node->name ? $node->name : '',
    '#weight' => -1,
188 189 190
    '#description' => t('Leave blank for %anonymous.', array('%anonymous' => variable_get('anonymous', t('Anonymous')))),
  );
  $form['author']['date'] = array(
191 192 193
    '#type' => 'textfield',
    '#title' => t('Authored on'),
    '#maxlength' => 25,
194 195
    '#description' => t('Format: %time. Leave blank to use the time of form submission.', array('%time' => !empty($node->date) ? $node->date : format_date($node->created, 'custom', 'Y-m-d H:i:s O'))),
  );
196

197
  if (isset($node->date)) {
198 199 200 201 202 203 204 205 206 207 208 209
    $form['author']['date']['#default_value'] = $node->date;
  }

  // Node options for administrators
  $form['options'] = array(
    '#type' => 'fieldset',
    '#access' => user_access('administer nodes'),
    '#title' => t('Publishing options'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#weight' => 25,
  );
210
  $form['options']['status'] = array(
211 212
    '#type' => 'checkbox',
    '#title' => t('Published'),
213 214 215
    '#default_value' => $node->status,
  );
  $form['options']['promote'] = array(
216 217
    '#type' => 'checkbox',
    '#title' => t('Promoted to front page'),
218 219 220
    '#default_value' => $node->promote,
  );
  $form['options']['sticky'] = array(
221 222
    '#type' => 'checkbox',
    '#title' => t('Sticky at top of lists'),
223 224
    '#default_value' => $node->sticky,
  );
225 226 227

  // These values are used when the user has no administrator access.
  foreach (array('uid', 'created') as $key) {
228
    $form[$key] = array(
229
      '#type' => 'value',
230 231
      '#value' => $node->$key,
    );
232 233 234 235
  }

  // Add the buttons.
  $form['buttons'] = array();
236
  $form['buttons']['submit'] = array(
237
    '#type' => 'submit',
238
    '#value' => t('Save'),
239
    '#weight' => 5,
240
    '#submit' => array('node_form_submit'),
241
  );
242
  $form['buttons']['preview'] = array(
243
    '#type' => 'submit',
244
    '#value' => t('Preview'),
245
    '#weight' => 10,
246
    '#submit' => array('node_form_build_preview'),
247 248 249 250 251 252 253 254 255 256
  );
  if (!empty($node->nid) && node_access('delete', $node)) {
    $form['buttons']['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete'),
      '#weight' => 15,
      '#submit' => array('node_form_delete_submit'),
    );
  }
  $form['#validate'][] = 'node_form_validate';
257
  $form['#theme'] = array($node->type . '_node_form', 'node_form');
258 259 260 261 262 263 264 265 266 267 268 269
  return $form;
}

/**
 * Return a node body field, with format and teaser.
 */
function node_body_field(&$node, $label, $word_count) {

  // Check if we need to restore the teaser at the beginning of the body.
  $include = !isset($node->teaser) || ($node->teaser == substr($node->body, 0, strlen($node->teaser)));

  $form = array(
270
    '#after_build' => array('node_teaser_js', 'node_teaser_include_verify'));
271

272 273 274
  $form['#prefix'] = '<div class="body-field-wrapper">';
  $form['#suffix'] = '</div>';

275 276 277 278 279
  $form['teaser_js'] = array(
    '#type' => 'textarea',
    '#rows' => 10,
    '#teaser' => 'edit-body',
    '#teaser_checkbox' => 'edit-teaser-include',
280 281
    '#disabled' => TRUE,
  );
282 283 284 285 286 287 288 289 290 291 292 293 294 295

  $form['teaser_include'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show summary in full view'),
    '#default_value' => $include,
    '#prefix' => '<div class="teaser-checkbox">',
    '#suffix' => '</div>',
  );

  $form['body'] = array(
    '#type' => 'textarea',
    '#title' => check_plain($label),
    '#default_value' => $include ? $node->body : ($node->teaser . $node->body),
    '#rows' => 20,
296 297
    '#required' => ($word_count > 0),
  );
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313

  $form['format'] = filter_form($node->format);

  return $form;
}

/**
 * Button sumit function: handle the 'Delete' button on the node form.
 */
function node_form_delete_submit($form, &$form_state) {
  $destination = '';
  if (isset($_REQUEST['destination'])) {
    $destination = drupal_get_destination();
    unset($_REQUEST['destination']);
  }
  $node = $form['#node'];
314
  $form_state['redirect'] = array('node/' . $node->nid . '/delete', $destination);
315 316 317 318 319 320 321 322
}


function node_form_build_preview($form, &$form_state) {
  $node = node_form_submit_build_node($form, $form_state);
  $form_state['node_preview'] = node_preview($node);
}

323 324 325 326 327
/**
 * Present a node submission form.
 *
 * @ingroup themeable
 */
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
function theme_node_form($form) {
  $output = "\n<div class=\"node-form\">\n";

  // Admin form fields and submit buttons must be rendered first, because
  // they need to go to the bottom of the form, and so should not be part of
  // the catch-all call to drupal_render().
  $admin = '';
  if (isset($form['author'])) {
    $admin .= "    <div class=\"authored\">\n";
    $admin .= drupal_render($form['author']);
    $admin .= "    </div>\n";
  }
  if (isset($form['options'])) {
    $admin .= "    <div class=\"options\">\n";
    $admin .= drupal_render($form['options']);
    $admin .= "    </div>\n";
  }
  $buttons = drupal_render($form['buttons']);

  // Everything else gets rendered here, and is displayed before the admin form
  // field and the submit buttons.
  $output .= "  <div class=\"standard\">\n";
  $output .= drupal_render($form);
  $output .= "  </div>\n";

  if (!empty($admin)) {
    $output .= "  <div class=\"admin\">\n";
    $output .= $admin;
    $output .= "  </div>\n";
  }
  $output .= $buttons;
  $output .= "</div>\n";

  return $output;
}

/**
 * Generate a node preview.
 */
function node_preview($node) {
  if (node_access('create', $node) || node_access('update', $node)) {
369
    // Load the user's name when needed.
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
    if (isset($node->name)) {
      // The use of isset() is mandatory in the context of user IDs, because
      // user ID 0 denotes the anonymous user.
      if ($user = user_load(array('name' => $node->name))) {
        $node->uid = $user->uid;
        $node->picture = $user->picture;
      }
      else {
        $node->uid = 0; // anonymous user
      }
    }
    else if ($node->uid) {
      $user = user_load(array('uid' => $node->uid));
      $node->name = $user->name;
      $node->picture = $user->picture;
    }

    $node->changed = time();

    // Extract a teaser, if it hasn't been set (e.g. by a module-provided
    // 'teaser' form item).
    if (!isset($node->teaser)) {
      $node->teaser = empty($node->body) ? '' : node_teaser($node->body, $node->format);
393 394 395 396
      // Chop off the teaser from the body if needed.
      if (!$node->teaser_include && $node->teaser == substr($node->body, 0, strlen($node->teaser))) {
        $node->body = substr($node->body, strlen($node->teaser));
      }
397 398
    }

399
    // Display a preview of the node.
400 401
    // Previewing alters $node so it needs to be cloned.
    if (!form_get_errors()) {
402
      $cloned_node = clone $node;
403 404 405 406 407 408 409 410 411 412 413 414 415 416
      $cloned_node->build_mode = NODE_BUILD_PREVIEW;
      $output = theme('node_preview', $cloned_node);
    }
    drupal_set_title(t('Preview'));

    return $output;
  }
}

/**
 * Display a node preview for display during node creation and editing.
 *
 * @param $node
 *   The node object which is being previewed.
417 418
 *
 * @ingroup themeable
419 420 421
 */
function theme_node_preview($node) {
  $output = '<div class="preview">';
422

423 424 425 426 427 428 429 430 431 432 433 434 435
  $preview_trimmed_version = FALSE;
  // Do we need to preview trimmed version of post as well as full version?
  if (isset($node->teaser) && isset($node->body)) {
    $teaser = trim($node->teaser);
    $body = trim(str_replace('<!--break-->', '', $node->body));

    // Preview trimmed version if teaser and body will appear different;
    // also (edge case) if both teaser and body have been specified by the user
    // and are actually the same.
    if ($teaser != $body || ($body && strpos($node->body, '<!--break-->') === 0)) {
      $preview_trimmed_version = TRUE;
    }
  }
436

437
  if ($preview_trimmed_version) {
438
    drupal_set_message(t('The trimmed version of your post shows what your post looks like when promoted to the main page or when exported for syndication.<span class="no-js"> You can insert the delimiter "&lt;!--break--&gt;" (without the quotes) to fine-tune where your post gets split.</span>'));
439
    $output .= '<h3>' . t('Preview trimmed version') . '</h3>';
440
    $output .= node_view(clone $node, 1, FALSE, 0);
441
    $output .= '<h3>' . t('Preview full version') . '</h3>';
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
    $output .= node_view($node, 0, FALSE, 0);
  }
  else {
    $output .= node_view($node, 0, FALSE, 0);
  }
  $output .= "</div>\n";

  return $output;
}

function node_form_submit($form, &$form_state) {
  global $user;

  $node = node_form_submit_build_node($form, $form_state);
  $insert = empty($node->nid);
  node_save($node);
458
  $node_link = l(t('view'), 'node/' . $node->nid);
459
  $watchdog_args = array('@type' => $node->type, '%title' => $node->title);
460
  $t_args = array('@type' => node_get_types('name', $node), '%title' => $node->title);
461 462 463

  if ($insert) {
    watchdog('content', '@type: added %title.', $watchdog_args, WATCHDOG_NOTICE, $node_link);
464
    drupal_set_message(t('@type %title has been created.', $t_args));
465 466 467
  }
  else {
    watchdog('content', '@type: updated %title.', $watchdog_args, WATCHDOG_NOTICE, $node_link);
468
    drupal_set_message(t('@type %title has been updated.', $t_args));
469 470 471
  }
  if ($node->nid) {
    unset($form_state['rebuild']);
472
    $form_state['nid'] = $node->nid;
473
    $form_state['redirect'] = 'node/' . $node->nid;
474 475 476 477
  }
  else {
    // In the unlikely case something went wrong on save, the node will be
    // rebuilt and node form redisplayed the same way as in preview.
478
    drupal_set_message(t('The post could not be saved.'), 'error');
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
  }
}

/**
 * Build a node by processing submitted form values and prepare for a form rebuild.
 */
function node_form_submit_build_node($form, &$form_state) {
  // Unset any button-level handlers, execute all the form-level submit
  // functions to process the form values into an updated node.
  unset($form_state['submit_handlers']);
  form_execute_handlers('submit', $form, $form_state);
  $node = node_submit($form_state['values']);
  $form_state['node'] = (array)$node;
  $form_state['rebuild'] = TRUE;
  return $node;
}

/**
 * Menu callback -- ask for confirmation of node deletion
 */
function node_delete_confirm(&$form_state, $node) {
500
  $form['nid'] = array(
501
    '#type' => 'value',
502 503
    '#value' => $node->nid,
  );
504 505 506

  return confirm_form($form,
    t('Are you sure you want to delete %title?', array('%title' => $node->title)),
507
    isset($_GET['destination']) ? $_GET['destination'] : 'node/' . $node->nid,
508
    t('This action cannot be undone.'),
509
    t('Delete'),
510 511
    t('Cancel')
  );
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
}

/**
 * Execute node deletion
 */
function node_delete_confirm_submit($form, &$form_state) {
  if ($form_state['values']['confirm']) {
    node_delete($form_state['values']['nid']);
  }

  $form_state['redirect'] = '<front>';
}

/**
 * Generate an overview table of older revisions of a node.
 */
function node_revision_overview($node) {
  drupal_set_title(t('Revisions for %title', array('%title' => $node->title)));

  $header = array(t('Revision'), array('data' => t('Operations'), 'colspan' => 2));

  $revisions = node_revision_list($node);

  $rows = array();
  $revert_permission = FALSE;
  if ((user_access('revert revisions') || user_access('administer nodes')) && node_access('update', $node)) {
    $revert_permission = TRUE;
  }
  $delete_permission = FALSE;
541
  if ((user_access('delete revisions') || user_access('administer nodes')) && node_access('delete', $node)) {
542 543 544 545 546 547 548 549
    $delete_permission = TRUE;
  }
  foreach ($revisions as $revision) {
    $row = array();
    $operations = array();

    if ($revision->current_vid > 0) {
      $row[] = array('data' => t('!date by !username', array('!date' => l(format_date($revision->timestamp, 'small'), "node/$node->nid"), '!username' => theme('username', $revision)))
550
                               . (($revision->log != '') ? '<p class="revision-log">' . filter_xss($revision->log) . '</p>' : ''),
551 552 553 554 555
                     'class' => 'revision-current');
      $operations[] = array('data' => theme('placeholder', t('current revision')), 'class' => 'revision-current', 'colspan' => 2);
    }
    else {
      $row[] = t('!date by !username', array('!date' => l(format_date($revision->timestamp, 'small'), "node/$node->nid/revisions/$revision->vid/view"), '!username' => theme('username', $revision)))
556
               . (($revision->log != '') ? '<p class="revision-log">' . filter_xss($revision->log) . '</p>' : '');
557 558 559 560 561 562 563 564 565 566 567 568 569
      if ($revert_permission) {
        $operations[] = l(t('revert'), "node/$node->nid/revisions/$revision->vid/revert");
      }
      if ($delete_permission) {
        $operations[] = l(t('delete'), "node/$node->nid/revisions/$revision->vid/delete");
      }
    }
    $rows[] = array_merge($row, $operations);
  }

  return theme('table', $header, $rows);
}

570 571 572 573 574
/**
 * Ask for confirmation of the reversion to prevent against CSRF attacks.
 */
function node_revision_revert_confirm($form_state, $node_revision) {
  $form['#node_revision'] = $node_revision;
575
  return confirm_form($form, t('Are you sure you want to revert to the revision from %revision-date?', array('%revision-date' => format_date($node_revision->revision_timestamp))), 'node/' . $node_revision->nid . '/revisions', '', t('Revert'), t('Cancel'));
576 577 578 579 580 581 582 583 584 585 586 587 588
}

function node_revision_revert_confirm_submit($form, &$form_state) {
  $node_revision = $form['#node_revision'];
  $node_revision->revision = 1;
  $node_revision->log = t('Copy of the revision from %date.', array('%date' => format_date($node_revision->revision_timestamp)));
  if (module_exists('taxonomy')) {
    $node_revision->taxonomy = array_keys($node_revision->taxonomy);
  }

  node_save($node_revision);

  watchdog('content', '@type: reverted %title revision %revision.', array('@type' => $node_revision->type, '%title' => $node_revision->title, '%revision' => $node_revision->vid));
589
  drupal_set_message(t('@type %title has been reverted back to the revision from %revision-date.', array('@type' => node_get_types('name', $node_revision), '%title' => $node_revision->title, '%revision-date' => format_date($node_revision->revision_timestamp))));
590
  $form_state['redirect'] = 'node/' . $node_revision->nid . '/revisions';
591
}
592

593 594
function node_revision_delete_confirm($form_state, $node_revision) {
  $form['#node_revision'] = $node_revision;
595
  return confirm_form($form, t('Are you sure you want to delete the revision from %revision-date?', array('%revision-date' => format_date($node_revision->revision_timestamp))), 'node/' . $node_revision->nid . '/revisions', t('This action cannot be undone.'), t('Delete'), t('Cancel'));
596 597 598 599 600 601 602
}

function node_revision_delete_confirm_submit($form, &$form_state) {
  $node_revision = $form['#node_revision'];
  db_query("DELETE FROM {node_revisions} WHERE nid = %d AND vid = %d", $node_revision->nid, $node_revision->vid);
  node_invoke_nodeapi($node_revision, 'delete revision');
  watchdog('content', '@type: deleted %title revision %revision.', array('@type' => $node_revision->type, '%title' => $node_revision->title, '%revision' => $node_revision->vid));
603
  drupal_set_message(t('Revision from %revision-date of @type %title has been deleted.', array('%revision-date' => format_date($node_revision->revision_timestamp), '@type' => node_get_types('name', $node_revision), '%title' => $node_revision->title)));
604
  $form_state['redirect'] = 'node/' . $node_revision->nid;
605 606 607 608
  if (db_result(db_query('SELECT COUNT(vid) FROM {node_revisions} WHERE nid = %d', $node_revision->nid)) > 1) {
    $form_state['redirect'] .= '/revisions';
  }
}