node.pages.inc 12.8 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5 6 7 8 9
 * Callbacks for adding, editing, and deleting content and managing revisions.
 *
 * Also includes validation, submission and other helper functions.
 *
 * @see node_menu()
10 11
 */

12
use Drupal\node\Plugin\Core\Entity\Node;
13 14

/**
15 16
 * Page callback: Presents the node editing form.
 *
17 18 19 20 21 22
 * @param object $node
 *   A node object.
 *
 * @return array
 *   A form array as expected by drupal_render().
 *
23
 * @see node_menu()
24
 */
25
function node_page_edit($node) {
26
  drupal_set_title(t('<em>Edit @type</em> @title', array('@type' => node_get_type_label($node), '@title' => $node->label())), PASS_THROUGH);
27
  return entity_get_form($node);
28 29
}

30
/**
31 32 33
 * Page callback: Displays add content links for available content types.
 *
 * Redirects to node/add/[type] if only one content type is available.
34
 *
35 36 37 38 39
 * @return array
 *   A render array for a list of the node types that can be added; however, if
 *   there is only one node type defined for the site, the function redirects
 *   to the node add page for that one node type and does not return at all.
 *
40 41
 * @see node_menu()
 */
42
function node_add_page() {
43 44 45 46 47 48 49
  $content = array();
  // Only use node types the user has access to.
  foreach (node_type_get_types() as $type) {
    if (node_hook($type->type, 'form') && node_access('create', $type->type)) {
      $content[$type->type] = $type;
    }
  }
50 51
  // Bypass the node/add listing if only one content type is available.
  if (count($content) == 1) {
52 53
    $type = array_shift($content);
    drupal_goto('node/add/' . $type->type);
54
  }
55
  return array('#theme' => 'node_add_list', '#content' => $content);
56 57
}

58
/**
59 60 61 62 63
 * Returns HTML for a list of available node types for node creation.
 *
 * @param $variables
 *   An associative array containing:
 *   - content: An array of content types.
64
 *
65 66 67
 * @return string
 *   An HTML-formatted string.
 *
68
 * @see node_add_page()
69
 *
70 71
 * @ingroup themeable
 */
72 73
function theme_node_add_list($variables) {
  $content = $variables['content'];
74 75 76 77
  $output = '';

  if ($content) {
    $output = '<dl class="node-type-list">';
78 79 80
    foreach ($content as $type) {
      $output .= '<dt>' . l($type->name, 'node/add/' . $type->type) . '</dt>';
      $output .= '<dd>' . filter_xss_admin($type->description) . '</dd>';
81 82 83
    }
    $output .= '</dl>';
  }
84
  else {
85
    $output = '<p>' . t('You have not created any content types yet. Go to the <a href="@create-content">content type creation page</a> to add a new content type.', array('@create-content' => url('admin/structure/types/add'))) . '</p>';
86
  }
87 88 89 90 91
  return $output;
}


/**
92 93
 * Page callback: Provides the node submission form.
 *
94 95
 * @param $node_type
 *   The node type object for the submitted node.
96
 *
97 98
 * @return array
 *   A node submission form.
99 100
 *
 * @see node_menu()
101
 */
102
function node_add($node_type) {
103 104
  global $user;

105
  $type = $node_type->type;
106
  $langcode = module_invoke('language', 'get_default_langcode', 'node', $type);
107 108 109 110
  $node = entity_create('node', array(
    'uid' => $user->uid,
    'name' => (isset($user->name) ? $user->name : ''),
    'type' => $type,
111
    'langcode' => $langcode ? $langcode : language_default()->langcode,
112
  ));
113
  drupal_set_title(t('Create @name', array('@name' => $node_type->name)), PASS_THROUGH);
114
  $output = entity_get_form($node);
115 116 117 118 119

  return $output;
}

/**
120 121
 * Generates a node preview.
 *
122
 * @param Drupal\node\Node $node
123 124 125
 *   The node to preview.
 *
 * @return
126
 *   An HTML-formatted string of a node preview.
127 128
 *
 * @see node_form_build_preview()
129
 */
130
function node_preview(Node $node) {
131
  if (node_access('create', $node) || node_access('update', $node)) {
132
    _field_invoke_multiple('load', 'node', array($node->nid => $node));
133
    // Load the user's name when needed.
134 135 136
    if (isset($node->name)) {
      // The use of isset() is mandatory in the context of user IDs, because
      // user ID 0 denotes the anonymous user.
137
      if ($user = user_load_by_name($node->name)) {
138 139 140 141 142 143 144
        $node->uid = $user->uid;
        $node->picture = $user->picture;
      }
      else {
        $node->uid = 0; // anonymous user
      }
    }
145
    elseif ($node->uid) {
146
      $user = user_load($node->uid);
147 148 149 150
      $node->name = $user->name;
      $node->picture = $user->picture;
    }

151
    $node->changed = REQUEST_TIME;
152 153
    $nodes = array($node->nid => $node);
    field_attach_prepare_view('node', $nodes, 'full');
154

155
    // Display a preview of the node.
156
    if (!form_get_errors()) {
157 158 159
      $node->in_preview = TRUE;
      $output = theme('node_preview', array('node' => $node));
      unset($node->in_preview);
160 161 162 163 164 165 166
    }

    return $output;
  }
}

/**
167
 * Returns HTML for a node preview for display during node creation and editing.
168
 *
169 170
 * @param $variables
 *   An associative array containing:
171
 *   - node: The node entity which is being previewed.
172
 *
173
 * @see NodeFormController::preview()
174
 *
175
 * @ingroup themeable
176
 */
177 178 179
function theme_node_preview($variables) {
  $node = $variables['node'];

180
  $output = '';
181

182
  $preview_trimmed_version = FALSE;
183

184
  $elements = node_view(clone $node, 'teaser');
185
  $elements['#attached']['library'][] = array('node', 'drupal.node.preview');
186 187 188
  $trimmed = drupal_render($elements);
  $elements = node_view($node, 'full');
  $full = drupal_render($elements);
189 190 191

  // Do we need to preview trimmed version of post as well as full version?
  if ($trimmed != $full) {
192
    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>'));
193
    $output .= '<h3>' . t('Preview trimmed version') . '</h3>';
194
    $output .= $trimmed;
195
    $output .= '<h3>' . t('Preview full version') . '</h3>';
196
    $output .= $full;
197 198
  }
  else {
199
    $output .= $full;
200 201 202 203 204 205
  }

  return $output;
}

/**
206 207
 * Page callback: Form constructor for node deletion confirmation form.
 *
208 209 210 211 212 213
 * @param object $node
 *   A node object.
 *
 * @return array
 *   A form array.
 *
214
 * @see node_menu()
215
 */
216
function node_delete_confirm($form, &$form_state, $node) {
217 218
  // Always provide entity id in the same form key as in the entity edit form.
  $form['nid'] = array('#type' => 'value', '#value' => $node->nid);
219
  return confirm_form($form,
220
    t('Are you sure you want to delete %title?', array('%title' => $node->label())),
221
    'node/' . $node->nid,
222
    t('This action cannot be undone.'),
223
    t('Delete'),
224 225
    t('Cancel')
  );
226 227 228
}

/**
229
 * Form submission handler for node_delete_confirm().
230 231 232
 */
function node_delete_confirm_submit($form, &$form_state) {
  if ($form_state['values']['confirm']) {
233
    $node = node_load($form_state['values']['nid']);
234
    node_delete($form_state['values']['nid']);
235
    watchdog('content', '@type: deleted %title.', array('@type' => $node->type, '%title' => $node->label()));
236
    drupal_set_message(t('@type %title has been deleted.', array('@type' => node_get_type_label($node), '%title' => $node->label())));
237 238 239 240 241 242
  }

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

/**
243 244
 * Page callback: Generates an overview table of older revisions of a node.
 *
245 246 247 248 249 250
 * @param object $node
 *   A node object.
 *
 * @return array
 *   An array as expected by drupal_render().
 *
251
 * @see node_menu()
252
 */
253
function node_revision_overview($node) {
254
  drupal_set_title(t('Revisions for %title', array('%title' => $node->label())), PASS_THROUGH);
255

256
  $header = array(t('Revision'), t('Operations'));
257 258 259 260 261 262 263 264 265

  $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;
266
  if ((user_access('delete revisions') || user_access('administer nodes')) && node_access('delete', $node)) {
267 268 269 270 271
    $delete_permission = TRUE;
  }
  foreach ($revisions as $revision) {
    $row = array();
    if ($revision->current_vid > 0) {
272
      $row[] = array('data' => t('!date by !username', array('!date' => l(format_date($revision->timestamp, 'short'), "node/$node->nid"), '!username' => theme('username', array('account' => $revision))))
273
                               . (($revision->log != '') ? '<p class="revision-log">' . filter_xss($revision->log) . '</p>' : ''),
274
                     'class' => array('revision-current'));
275
      $row[] = array('data' => drupal_placeholder(t('current revision')), 'class' => array('revision-current'));
276 277
    }
    else {
278
      $row[] = t('!date by !username', array('!date' => l(format_date($revision->timestamp, 'short'), "node/$node->nid/revisions/$revision->vid/view"), '!username' => theme('username', array('account' => $revision))))
279
               . (($revision->log != '') ? '<p class="revision-log">' . filter_xss($revision->log) . '</p>' : '');
280
      if ($revert_permission) {
281 282 283 284
        $links['revert'] = array(
          'title' => t('revert'),
          'href' => "node/$node->nid/revisions/$revision->vid/revert",
        );
285 286
      }
      if ($delete_permission) {
287 288 289 290
        $links['delete'] = array(
          'title' => t('delete'),
          'href' => "node/$node->nid/revisions/$revision->vid/delete",
        );
291
      }
292 293 294 295 296 297
      $row[] = array(
        'data' => array(
          '#type' => 'operations',
          '#links' => $links,
        ),
      );
298
    }
299
    $rows[] = $row;
300
  }
301

302 303 304 305
  $build['node_revisions_table'] = array(
    '#theme' => 'table',
    '#rows' => $rows,
    '#header' => $header,
306 307 308
    '#attached' => array (
      'css' => array(drupal_get_path('module', 'node') . '/node.admin.css'),
    ),
309
  );
310

311
  return $build;
312 313
}

314
/**
315 316 317 318
 * Page callback: Form constructor for the reversion confirmation form.
 *
 * This form prevents against CSRF attacks.
 *
319 320 321 322 323 324
 * @param int $node_revision
 *   The node revision ID.
 *
 * @return array
 *   An array as expected by drupal_render().
 *
325 326
 * @see node_menu()
 * @see node_revision_revert_confirm_submit()
327
 */
328
function node_revision_revert_confirm($form, $form_state, $node_revision) {
329
  $form['#node_revision'] = $node_revision;
330
  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'));
331 332
}

333 334 335
/**
 * Form submission handler for node_revision_revert_confirm().
 */
336 337
function node_revision_revert_confirm_submit($form, &$form_state) {
  $node_revision = $form['#node_revision'];
338
  $node_revision->setNewRevision();
339
  // Make this the new default revision for the node.
340
  $node_revision->isDefaultRevision(TRUE);
341 342 343 344 345 346

  // The revision timestamp will be updated when the revision is saved. Keep the
  // original one for the confirmation message.
  $original_revision_timestamp = $node_revision->revision_timestamp;

  $node_revision->log = t('Copy of the revision from %date.', array('%date' => format_date($original_revision_timestamp)));
347

348
  $node_revision->save();
349

350
  watchdog('content', '@type: reverted %title revision %revision.', array('@type' => $node_revision->type, '%title' => $node_revision->label(), '%revision' => $node_revision->vid));
351
  drupal_set_message(t('@type %title has been reverted back to the revision from %revision-date.', array('@type' => node_get_type_label($node_revision), '%title' => $node_revision->label(), '%revision-date' => format_date($original_revision_timestamp))));
352
  $form_state['redirect'] = 'node/' . $node_revision->nid . '/revisions';
353
}
354

355 356 357 358 359
/**
 * Page callback: Form constructor for the revision deletion confirmation form.
 *
 * This form prevents against CSRF attacks.
 *
360 361 362 363 364 365
 * @param $node_revision
 *   The node revision ID.
 *
 * @return
 *   An array as expected by drupal_render().
 *
366 367 368
 * @see node_menu()
 * @see node_revision_delete_confirm_submit()
 */
369
function node_revision_delete_confirm($form, $form_state, $node_revision) {
370
  $form['#node_revision'] = $node_revision;
371
  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'));
372 373
}

374 375 376
/**
 * Form submission handler for node_revision_delete_confirm().
 */
377 378
function node_revision_delete_confirm_submit($form, &$form_state) {
  $node_revision = $form['#node_revision'];
379 380
  node_revision_delete($node_revision->vid);

381
  watchdog('content', '@type: deleted %title revision %revision.', array('@type' => $node_revision->type, '%title' => $node_revision->label(), '%revision' => $node_revision->vid));
382
  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_type_label($node_revision), '%title' => $node_revision->label())));
383
  $form_state['redirect'] = 'node/' . $node_revision->nid;
384
  if (db_query('SELECT COUNT(vid) FROM {node_revision} WHERE nid = :nid', array(':nid' => $node_revision->nid))->fetchField() > 1) {
385 386 387
    $form_state['redirect'] .= '/revisions';
  }
}