node.api.php 22.2 KB
Newer Older
1 2
<?php

3
use Drupal\node\NodeInterface;
4 5
use Drupal\Component\Utility\String;
use Drupal\Component\Utility\Xss;
6

7 8
/**
 * @file
9
 * Hooks specific to the Node module.
10 11
 */

12 13 14 15 16 17 18 19
/**
 * @addtogroup hooks
 * @{
 */

/**
 * Inform the node access system what permissions the user has.
 *
20 21 22 23
 * This hook is for implementation by node access modules. In this hook,
 * the module grants a user different "grant IDs" within one or more
 * "realms". In hook_node_access_records(), the realms and grant IDs are
 * associated with permission to view, edit, and delete individual nodes.
24
 *
25
 * The realms and grant IDs can be arbitrarily defined by your node access
26 27 28 29
 * module; it is common to use role IDs as grant IDs, but that is not required.
 * Your module could instead maintain its own list of users, where each list has
 * an ID. In that case, the return value of this hook would be an array of the
 * list IDs that this user is a member of.
30
 *
31 32 33 34 35
 * A node access module may implement as many realms as necessary to properly
 * define the access privileges for the nodes. Note that the system makes no
 * distinction between published and unpublished nodes. It is the module's
 * responsibility to provide appropriate realms to limit access to unpublished
 * content.
36
 *
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
 * Node access records are stored in the {node_access} table and define which
 * grants are required to access a node. There is a special case for the view
 * operation -- a record with node ID 0 corresponds to a "view all" grant for
 * the realm and grant ID of that record. If there are no node access modules
 * enabled, the core node module adds a node ID 0 record for realm 'all'. Node
 * access modules can also grant "view all" permission on their custom realms;
 * for example, a module could create a record in {node_access} with:
 * @code
 * $record = array(
 *   'nid' => 0,
 *   'gid' => 888,
 *   'realm' => 'example_realm',
 *   'grant_view' => 1,
 *   'grant_update' => 0,
 *   'grant_delete' => 0,
 * );
53
 * db_insert('node_access')->fields($record)->execute();
54 55 56 57 58 59 60 61 62 63 64 65
 * @endcode
 * And then in its hook_node_grants() implementation, it would need to return:
 * @code
 * if ($op == 'view') {
 *   $grants['example_realm'] = array(888);
 * }
 * @endcode
 * If you decide to do this, be aware that the node_access_rebuild() function
 * will erase any node ID 0 entry when it is called, so you will need to make
 * sure to restore your {node_access} record after node_access_rebuild() is
 * called.
 *
66 67 68
 * @param \Drupal\Core\Session\AccountInterface $account
 *   The acccount object whose grants are requested.
 * @param string $op
69
 *   The node operation to be performed, such as 'view', 'update', or 'delete'.
70
 *
71
 * @return array
72 73
 *   An array whose keys are "realms" of grants, and whose values are arrays of
 *   the grant IDs within this realm that this user is being granted.
74 75 76
 *
 * For a detailed example, see node_access_example.module.
 *
77 78
 * @see node_access_view_all_nodes()
 * @see node_access_rebuild()
79 80
 * @ingroup node_access
 */
81
function hook_node_grants(\Drupal\Core\Session\AccountInterface $account, $op) {
82
  if (user_access('access private content', $account)) {
83 84
    $grants['example'] = array(1);
  }
85
  $grants['example_owner'] = array($account->id());
86 87 88 89 90 91
  return $grants;
}

/**
 * Set permissions for a node to be written to the database.
 *
92 93 94
 * When a node is saved, a module implementing hook_node_access_records() will
 * be asked if it is interested in the access permissions for a node. If it is
 * interested, it must respond with an array of permissions arrays for that
95 96
 * node.
 *
97 98 99 100 101 102
 * Node access grants apply regardless of the published or unpublished status
 * of the node. Implementations must make sure not to grant access to
 * unpublished nodes if they don't want to change the standard access control
 * behavior. Your module may need to create a separate access realm to handle
 * access to unpublished nodes.
 *
103 104 105
 * Note that the grant values in the return value from your hook must be
 * integers and not boolean TRUE and FALSE.
 *
106 107 108 109
 * Each permissions item in the array is an array with the following elements:
 * - 'realm': The name of a realm that the module has defined in
 *   hook_node_grants().
 * - 'gid': A 'grant ID' from hook_node_grants().
110
 * - 'grant_view': If set to 1 a user that has been identified as a member
111
 *   of this gid within this realm can view this node. This should usually be
112
 *   set to $node->isPublished(). Failure to do so may expose unpublished content
113
 *   to some users.
114
 * - 'grant_update': If set to 1 a user that has been identified as a member
115
 *   of this gid within this realm can edit this node.
116
 * - 'grant_delete': If set to 1 a user that has been identified as a member
117
 *   of this gid within this realm can delete this node.
118 119 120 121 122 123 124 125
 * - langcode: (optional) The language code of a specific translation of the
 *   node, if any. Modules may add this key to grant different access to
 *   different translations of a node, such that (e.g.) a particular group is
 *   granted access to edit the Catalan version of the node, but not the
 *   Hungarian version. If no value is provided, the langcode is set
 *   automatically from the $node parameter and the node's original language (if
 *   specified) is used as a fallback. Only specify multiple grant records with
 *   different languages for a node if the site has those languages configured.
126
 *
127 128
 * A "deny all" grant may be used to deny all access to a particular node or
 * node translation:
129 130 131 132 133 134 135
 * @code
 * $grants[] = array(
 *   'realm' => 'all',
 *   'gid' => 0,
 *   'grant_view' => 0,
 *   'grant_update' => 0,
 *   'grant_delete' => 0,
136
 *   'langcode' => 'ca',
137 138
 * );
 * @endcode
139 140 141 142 143
 * Note that another module node access module could override this by granting
 * access to one or more nodes, since grants are additive. To enforce that
 * access is denied in a particular case, use hook_node_access_records_alter().
 * Also note that a deny all is not written to the database; denies are
 * implicit.
144
 *
145
 * @param \Drupal\node\NodeInterface $node
146 147 148 149 150
 *   The node that has just been saved.
 *
 * @return
 *   An array of grants as defined above.
 *
151
 * @see node_access_write_grants()
152
 * @see hook_node_access_records_alter()
153 154
 * @ingroup node_access
 */
155
function hook_node_access_records(\Drupal\node\NodeInterface $node) {
156
  // We only care about the node if it has been marked private. If not, it is
157
  // treated just like any other node and we completely ignore it.
158
  if ($node->private->value) {
159
    $grants = array();
160
    // Only published Catalan translations of private nodes should be viewable
161
    // to all users. If we fail to check $node->isPublished(), all users would be able
162
    // to view an unpublished node.
163
    if ($node->isPublished()) {
164 165 166 167 168 169
      $grants[] = array(
        'realm' => 'example',
        'gid' => 1,
        'grant_view' => 1,
        'grant_update' => 0,
        'grant_delete' => 0,
170
        'langcode' => 'ca'
171 172
      );
    }
173
    // For the example_author array, the GID is equivalent to a UID, which
174 175 176
    // means there are many groups of just 1 user.
    // Note that an author can always view his or her nodes, even if they
    // have status unpublished.
177 178
    $grants[] = array(
      'realm' => 'example_author',
179
      'gid' => $node->getOwnerId(),
180 181 182
      'grant_view' => 1,
      'grant_update' => 1,
      'grant_delete' => 1,
183
      'langcode' => 'ca'
184
    );
185

186 187 188 189
    return $grants;
  }
}

190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
/**
 * Alter permissions for a node before it is written to the database.
 *
 * Node access modules establish rules for user access to content. Node access
 * records are stored in the {node_access} table and define which permissions
 * are required to access a node. This hook is invoked after node access modules
 * returned their requirements via hook_node_access_records(); doing so allows
 * modules to modify the $grants array by reference before it is stored, so
 * custom or advanced business logic can be applied.
 *
 * Upon viewing, editing or deleting a node, hook_node_grants() builds a
 * permissions array that is compared against the stored access records. The
 * user must have one or more matching permissions in order to complete the
 * requested operation.
 *
205 206
 * A module may deny all access to a node by setting $grants to an empty array.
 *
207
 * @param $grants
208
 *   The $grants array returned by hook_node_access_records().
209
 * @param \Drupal\node\NodeInterface $node
210 211 212
 *   The node for which the grants were acquired.
 *
 * The preferred use of this hook is in a module that bridges multiple node
213 214
 * access modules with a configurable behavior, as shown in the example with the
 * 'is_preview' field.
215
 *
216 217 218
 * @see hook_node_access_records()
 * @see hook_node_grants()
 * @see hook_node_grants_alter()
219 220
 * @ingroup node_access
 */
221
function hook_node_access_records_alter(&$grants, Drupal\node\NodeInterface $node) {
222 223 224 225 226 227 228 229 230
  // Our module allows editors to mark specific articles with the 'is_preview'
  // field. If the node being saved has a TRUE value for that field, then only
  // our grants are retained, and other grants are removed. Doing so ensures
  // that our rules are enforced no matter what priority other grants are given.
  if ($node->is_preview) {
    // Our module grants are set in $grants['example'].
    $temp = $grants['example'];
    // Now remove all module grants but our own.
    $grants = array('example' => $temp);
231 232 233 234 235 236 237
  }
}

/**
 * Alter user access rules when trying to view, edit or delete a node.
 *
 * Node access modules establish rules for user access to content.
238 239 240 241 242
 * hook_node_grants() defines permissions for a user to view, edit or delete
 * nodes by building a $grants array that indicates the permissions assigned to
 * the user by each node access module. This hook is called to allow modules to
 * modify the $grants array by reference, so the interaction of multiple node
 * access modules can be altered or advanced business logic can be applied.
243 244 245 246
 *
 * The resulting grants are then checked against the records stored in the
 * {node_access} table to determine if the operation may be completed.
 *
247 248
 * A module may deny all access to a user by setting $grants to an empty array.
 *
249 250
 * Developers may use this hook to either add additional grants to a user or to
 * remove existing grants. These rules are typically based on either the
251 252
 * permissions assigned to a user role, or specific attributes of a user
 * account.
253
 *
254
 * @param array $grants
255
 *   The $grants array returned by hook_node_grants().
256 257 258
 * @param \Drupal\Core\Session\AccountInterface $account
 *   The account requesting access to content.
 * @param string $op
259 260
 *   The operation being performed, 'view', 'update' or 'delete'.
 *
261 262 263
 * @see hook_node_grants()
 * @see hook_node_access_records()
 * @see hook_node_access_records_alter()
264 265
 * @ingroup node_access
 */
266
function hook_node_grants_alter(&$grants, \Drupal\Core\Session\AccountInterface $account, $op) {
267 268 269 270 271 272
  // Our sample module never allows certain roles to edit or delete
  // content. Since some other node access modules might allow this
  // permission, we expressly remove it by returning an empty $grants
  // array for roles specified in our variable setting.

  // Get our list of banned roles.
273
  $restricted = \Drupal::config('example.settings')->get('restricted_roles');
274

275 276
  if ($op != 'view' && !empty($restricted)) {
    // Now check the roles for this account against the restrictions.
277
    foreach ($account->getRoles() as $rid) {
278
      if (in_array($rid, $restricted)) {
279 280 281 282 283 284
        $grants = array();
      }
    }
  }
}

285
/**
286
 * Controls access to a node.
287 288 289 290
 *
 * Modules may implement this hook if they want to have a say in whether or not
 * a given user has access to perform a given operation on a node.
 *
291 292
 * The administrative account (user ID #1) always passes any access check, so
 * this hook is not called in that case. Users with the "bypass node access"
293 294 295
 * permission may always view and edit content through the administrative
 * interface.
 *
296 297 298 299
 * Note that not all modules will want to influence access on all node types. If
 * your module does not want to actively grant or block access, return
 * NODE_ACCESS_IGNORE or simply return nothing. Blindly returning FALSE will
 * break other node access modules.
300
 *
301 302 303 304
 * Also note that this function isn't called for node listings (e.g., RSS feeds,
 * the default home page at path 'node', a recent content block, etc.) See
 * @link node_access Node access rights @endlink for a full explanation.
 *
305
 * @param \Drupal\node\NodeInterface|string $node
306
 *   Either a node entity or the machine name of the content type on which to
307
 *   perform the access check.
308
 * @param string $op
309 310 311 312 313
 *   The operation to be performed. Possible values:
 *   - "create"
 *   - "delete"
 *   - "update"
 *   - "view"
314
 * @param object $account
315
 *   The user object to perform the access check operation on.
316 317
 * @param object $langcode
 *   The language code to perform the access check operation on.
318
 *
319
 * @return string
320 321 322
 *   - NODE_ACCESS_ALLOW: if the operation is to be allowed.
 *   - NODE_ACCESS_DENY: if the operation is to be denied.
 *   - NODE_ACCESS_IGNORE: to not affect this operation at all.
323 324
 *
 * @ingroup node_access
325
 */
326
function hook_node_access(\Drupal\node\NodeInterface $node, $op, $account, $langcode) {
327
  $type = is_string($node) ? $node : $node->getType();
328

329 330
  $configured_types = node_permissions_get_configured_types();
  if (isset($configured_types[$type])) {
331
    if ($op == 'create' && user_access('create ' . $type . ' content', $account)) {
332 333 334 335
      return NODE_ACCESS_ALLOW;
    }

    if ($op == 'update') {
336
      if (user_access('edit any ' . $type . ' content', $account) || (user_access('edit own ' . $type . ' content', $account) && ($account->id() == $node->getOwnerId()))) {
337 338 339 340 341
        return NODE_ACCESS_ALLOW;
      }
    }

    if ($op == 'delete') {
342
      if (user_access('delete any ' . $type . ' content', $account) || (user_access('delete own ' . $type . ' content', $account) && ($account->id() == $node->getOwnerId()))) {
343 344 345 346 347 348 349 350 351
        return NODE_ACCESS_ALLOW;
      }
    }
  }

  // Returning nothing from this function would have the same effect.
  return NODE_ACCESS_IGNORE;
}

352
/**
353
 * Act on a node being displayed as a search result.
354
 *
355 356
 * This hook is invoked from the node search plugin during search execution,
 * after loading and rendering the node.
357
 *
358
 * @param \Drupal\node\NodeInterface $node
359
 *   The node being displayed in a search result.
360 361
 * @param $langcode
 *   Language code of result being displayed.
362
 *
363 364
 * @return array
 *   Extra information to be displayed with search result. This information
365 366 367
 *   should be presented as an associative array. It will be concatenated with
 *   the post information (last updated, author) in the default search result
 *   theming.
368 369
 *
 * @see template_preprocess_search_result()
370
 * @see search-result.html.twig
371
 *
372
 * @ingroup entity_crud
373
 */
374
function hook_node_search_result(\Drupal\node\NodeInterface $node, $langcode) {
375 376
  $rating = db_query('SELECT SUM(points) FROM {my_rating} WHERE nid = :nid', array('nid' => $node->id()))->fetchField();
  return array('rating' => format_plural($rating, '1 point', '@count points'));
377 378 379
}

/**
380
 * Act on a node being indexed for searching.
381
 *
382 383
 * This hook is invoked during search indexing, after loading, and after the
 * result of rendering is added as $node->rendered to the node object.
384
 *
385
 * @param \Drupal\node\NodeInterface $node
386
 *   The node being indexed.
387 388
 * @param $langcode
 *   Language code of the variant of the node being indexed.
389
 *
390 391
 * @return string
 *   Additional node information to be indexed.
392
 *
393
 * @ingroup entity_crud
394
 */
395
function hook_node_update_index(\Drupal\node\NodeInterface $node, $langcode) {
396
  $text = '';
397 398 399
  $ratings = db_query('SELECT title, description FROM {my_ratings} WHERE nid = :nid', array(':nid' => $node->id()));
  foreach ($ratings as $rating) {
    $text .= '<h2>' . String::checkPlain($rating->title) . '</h2>' . Xss::filter($rating->description);
400 401 402 403 404
  }
  return $text;
}

/**
405 406
 * Perform node validation before a node is created or updated.
 *
407
 * This hook is invoked from NodeForm::validate(), after a user has
408
 * finished editing the node and is previewing or submitting it. It is invoked
409
 * at the end of all the standard validation steps.
410
 *
411 412 413 414
 * To indicate a validation error, use form_set_error().
 *
 * Note: Changes made to the $node object within your hook implementation will
 * have no effect.  The preferred method to change a node's content is to use
415 416
 * hook_node_presave() instead. If it is really necessary to change the node at
 * the validate stage, you can use form_set_value().
417
 *
418
 * @param \Drupal\node\NodeInterface $node
419
 *   The node being validated.
420
 * @param $form
421
 *   The form being used to edit the node.
422 423
 * @param $form_state
 *   The form state array.
424
 *
425
 * @ingroup entity_crud
426
 */
427
function hook_node_validate(\Drupal\node\NodeInterface $node, $form, &$form_state) {
428 429
  if (isset($node->end) && isset($node->start)) {
    if ($node->start > $node->end) {
430
      form_set_error('time', $form_state, t('An event may not end before it starts.'));
431 432 433 434
    }
  }
}

435 436 437 438 439 440 441 442
/**
 * Act on a node after validated form values have been copied to it.
 *
 * This hook is invoked when a node form is submitted with either the "Save" or
 * "Preview" button, after form values have been copied to the form state's node
 * object, but before the node is saved or previewed. It is a chance for modules
 * to adjust the node's properties from what they are simply after a copy from
 * $form_state['values']. This hook is intended for adjusting non-field-related
443
 * properties.
444
 *
445
 * @param \Drupal\node\NodeInterface $node
446
 *   The node entity being updated in response to a form submission.
447 448 449 450 451
 * @param $form
 *   The form being used to edit the node.
 * @param $form_state
 *   The form state array.
 *
452
 * @ingroup entity_crud
453
 */
454
function hook_node_submit(\Drupal\node\NodeInterface $node, $form, &$form_state) {
455 456 457 458 459 460 461
  // Decompose the selected menu parent option into 'menu_name' and 'plid', if
  // the form used the default parent selection widget.
  if (!empty($form_state['values']['menu']['parent'])) {
    list($node->menu['menu_name'], $node->menu['plid']) = explode(':', $form_state['values']['menu']['parent']);
  }
}

462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
/**
 * Provide additional methods of scoring for core search results for nodes.
 *
 * A node's search score is used to rank it among other nodes matched by the
 * search, with the highest-ranked nodes appearing first in the search listing.
 *
 * For example, a module allowing users to vote on content could expose an
 * option to allow search results' rankings to be influenced by the average
 * voting score of a node.
 *
 * All scoring mechanisms are provided as options to site administrators, and
 * may be tweaked based on individual sites or disabled altogether if they do
 * not make sense. Individual scoring mechanisms, if enabled, are assigned a
 * weight from 1 to 10. The weight represents the factor of magnification of
 * the ranking mechanism, with higher-weighted ranking mechanisms having more
 * influence. In order for the weight system to work, each scoring mechanism
 * must return a value between 0 and 1 for every node. That value is then
 * multiplied by the administrator-assigned weight for the ranking mechanism,
 * and then the weighted scores from all ranking mechanisms are added, which
 * brings about the same result as a weighted average.
 *
 * @return
 *   An associative array of ranking data. The keys should be strings,
 *   corresponding to the internal name of the ranking mechanism, such as
 *   'recent', or 'comments'. The values should be arrays themselves, with the
 *   following keys available:
488 489 490 491 492 493 494 495 496 497
 *   - title: (required) The human readable name of the ranking mechanism.
 *   - join: (optional) The part of a query string to join to any additional
 *     necessary table. This is not necessary if the table required is already
 *     joined to by the base query, such as for the {node} table. Other tables
 *     should use the full table name as an alias to avoid naming collisions.
 *   - score: (required) The part of a query string to calculate the score for
 *     the ranking mechanism based on values in the database. This does not need
 *     to be wrapped in parentheses, as it will be done automatically; it also
 *     does not need to take the weighted system into account, as it will be
 *     done automatically. It does, however, need to calculate a decimal between
498
 *     0 and 1; be careful not to cast the entire score to an integer by
499 500 501
 *     inadvertently introducing a variable argument.
 *   - arguments: (optional) If any arguments are required for the score, they
 *     can be specified in an array here.
502
 *
503
 * @ingroup entity_crud
504 505 506
 */
function hook_ranking() {
  // If voting is disabled, we can avoid returning the array, no hard feelings.
507
  if (\Drupal::config('vote.settings')->get('node_enabled')) {
508 509 510 511 512 513 514 515 516 517
    return array(
      'vote_average' => array(
        'title' => t('Average vote'),
        // Note that we use i.sid, the search index's search item id, rather than
        // n.nid.
        'join' => 'LEFT JOIN {vote_node_data} vote_node_data ON vote_node_data.nid = i.sid',
        // The highest possible score should be 1, and the lowest possible score,
        // always 0, should be 0.
        'score' => 'vote_node_data.average / CAST(%f AS DECIMAL)',
        // Pass in the highest possible voting score as a decimal argument.
518
        'arguments' => array(\Drupal::config('vote.settings')->get('score_max')),
519 520 521 522 523
      ),
    );
  }
}

524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
/**
 * Alter the links of a node.
 *
 * @param array &$links
 *   A renderable array representing the node links.
 * @param \Drupal\node\NodeInterface $entity
 *   The node being rendered.
 * @param array &$context
 *   Various aspects of the context in which the node links are going to be
 *   displayed, with the following keys:
 *   - 'view_mode': the view mode in which the comment is being viewed
 *   - 'langcode': the language in which the comment is being viewed
 *
 * @see \Drupal\node\NodeViewBuilder::renderLinks()
 * @see \Drupal\node\NodeViewBuilder::buildLinks()
539
 * @see entity_crud
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
 */
function hook_node_links_alter(array &$links, NodeInterface $entity, array &$context) {
  $links['mymodule'] = array(
    '#theme' => 'links__node__mymodule',
    '#attributes' => array('class' => array('links', 'inline')),
    '#links' => array(
      'node-report' => array(
        'title' => t('Report'),
        'href' => "node/{$entity->id()}/report",
        'html' => TRUE,
        'query' => array('token' => \Drupal::getContainer()->get('csrf_token')->get("node/{$entity->id()}/report")),
      ),
    ),
  );
}

556 557 558
/**
 * @} End of "addtogroup hooks".
 */