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\Core\Entity\EntityInterface;
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
 * @see node_add_page()
66
 *
67 68
 * @ingroup themeable
 */
69 70
function theme_node_add_list($variables) {
  $content = $variables['content'];
71 72 73 74
  $output = '';

  if ($content) {
    $output = '<dl class="node-type-list">';
75 76 77
    foreach ($content as $type) {
      $output .= '<dt>' . l($type->name, 'node/add/' . $type->type) . '</dt>';
      $output .= '<dd>' . filter_xss_admin($type->description) . '</dd>';
78 79 80
    }
    $output .= '</dl>';
  }
81
  else {
82
    $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>';
83
  }
84 85 86 87 88
  return $output;
}


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

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

  return $output;
}

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

146
    $node->changed = REQUEST_TIME;
147

148
    // Display a preview of the node.
149
    if (!form_get_errors()) {
150 151 152
      $node->in_preview = TRUE;
      $output = theme('node_preview', array('node' => $node));
      unset($node->in_preview);
153 154 155 156 157 158 159
    }

    return $output;
  }
}

/**
160
 * Returns HTML for a node preview for display during node creation and editing.
161
 *
162 163
 * @param $variables
 *   An associative array containing:
164
 *   - node: The node entity which is being previewed.
165
 *
166
 * @see NodeFormController::preview()
167
 * @see node_preview()
168
 *
169
 * @ingroup themeable
170
 */
171 172 173
function theme_node_preview($variables) {
  $node = $variables['node'];

174
  $output = '';
175

176
  $elements = node_view($node, 'teaser');
177
  $elements['#attached']['library'][] = array('node', 'drupal.node.preview');
178 179 180
  $trimmed = drupal_render($elements);
  $elements = node_view($node, 'full');
  $full = drupal_render($elements);
181 182 183

  // Do we need to preview trimmed version of post as well as full version?
  if ($trimmed != $full) {
184
    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>'));
185
    $output .= '<h3>' . t('Preview trimmed version') . '</h3>';
186
    $output .= $trimmed;
187
    $output .= '<h3>' . t('Preview full version') . '</h3>';
188
    $output .= $full;
189 190
  }
  else {
191
    $output .= $full;
192 193 194 195 196 197
  }

  return $output;
}

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

/**
222
 * Form submission handler for node_delete_confirm().
223 224 225
 */
function node_delete_confirm_submit($form, &$form_state) {
  if ($form_state['values']['confirm']) {
226
    $node = node_load($form_state['values']['nid']);
227
    $node->delete();
228
    watchdog('content', '@type: deleted %title.', array('@type' => $node->type, '%title' => $node->label()));
229
    drupal_set_message(t('@type %title has been deleted.', array('@type' => node_get_type_label($node), '%title' => $node->label())));
230 231 232 233 234 235
  }

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

/**
236 237
 * Page callback: Generates an overview table of older revisions of a node.
 *
238 239 240 241 242 243
 * @param object $node
 *   A node object.
 *
 * @return array
 *   An array as expected by drupal_render().
 *
244
 * @see node_menu()
245
 */
246
function node_revision_overview($node) {
247
  drupal_set_title(t('Revisions for %title', array('%title' => $node->label())), PASS_THROUGH);
248

249
  $header = array(t('Revision'), t('Operations'));
250 251 252 253

  $revisions = node_revision_list($node);

  $rows = array();
254 255
  $type = $node->type;

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

298 299 300 301
  $build['node_revisions_table'] = array(
    '#theme' => 'table',
    '#rows' => $rows,
    '#header' => $header,
302 303 304
    '#attached' => array (
      'css' => array(drupal_get_path('module', 'node') . '/node.admin.css'),
    ),
305
  );
306

307
  return $build;
308 309
}

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

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

  // 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)));
344

345
  $node_revision->save();
346

347
  watchdog('content', '@type: reverted %title revision %revision.', array('@type' => $node_revision->type, '%title' => $node_revision->label(), '%revision' => $node_revision->vid));
348
  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))));
349
  $form_state['redirect'] = 'node/' . $node_revision->nid . '/revisions';
350
}
351

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

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

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