Newer
Older
<?php
/**
* @file
*
* This module gives developers feedback as to what their
* node_access table contains, and which nodes are protected or
* visible to the public.
*/
define('DNA_ACCESS_VIEW', 'view devel_node_access information');
Hans Salvisberg
committed
function devel_node_access_permission() {
return array(
'view devel_node_access information' => array(
'description' => t('View the node access information blocks on node pages and the summary page.'),
'title' => t('Access DNA information'),
'restrict access' => TRUE,
Hans Salvisberg
committed
),
);
}
/**
Hans Salvisberg
committed
* Implements hook_help().
*/
function devel_node_access_help($path, $arg) {
switch ($path) {
case 'admin/settings/modules#description':
return t('Development helper for node_access table');
break;
case 'admin/help#devel_node_access':
Hans Salvisberg
committed
$output = '<p>' . t('This module helps in site development. Specifically, when an access control module is used to limit access to some or all nodes, this module provides some feedback showing the node_access table in the database.') . "</p>\n";
$output .= '<p>' . t('The node_access table is one method Drupal provides to hide content from some users while displaying it to others. By default, Drupal shows all nodes to all users. There are a number of optional modules which may be installed to hide content from some users.') . "</p>\n";
$output .= '<p>' . t('If you have not installed any of these modules, you really have no need for the devel_node_access module. This module is intended for use during development, so that developers and admins can confirm that the node_access table is working as expected. You probably do not want this module enabled on a production site.') . "</p>\n";
$output .= '<p>' . t('This module provides two blocks. One called Devel Node Access by User is visible when a single node is shown on a page. This block shows which users can view, update or delete the node shown. Note that this block uses an inefficient algorithm to produce its output. You should only enable this block on sites with very few user accounts.') . "</p>\n";
$output .= '<p>' . t('The second block provided by this module shows the entries in the node_access table for any nodes shown on the current page. You can enable the debug mode on the <a href="@settings_page">settings page</a> to display much more information, but this can cause considerable overhead. Because the tables shown are wide, it is recommended to enable the blocks in the page footer rather than a sidebar.',
array('@settings_page' => url('admin/config/development/devel', array('fragment' => 'edit-devel-node-access')))
Hans Salvisberg
committed
) . "</p>\n";
$output .= '<p>' . t('This module also provides a <a href="@summary_page">summary page</a> which shows general information about your node_access table. If you have installed the Views module, you may browse node_access by realm.',
array('@summary_page' => url('devel/node_access/summary'))
Hans Salvisberg
committed
) . "</p>\n";
}
}
Hans Salvisberg
committed
/**
* Implements hook_menu().
*/
Moshe Weitzman
committed
function devel_node_access_menu() {
$items = array();
Moshe Weitzman
committed
if (!module_exists('devel')) {
if (!menu_load('devel')) {
// we have to create the 'devel' menu ourselves
$menu = array(
'menu_name' => 'devel',
'title' => 'Development',
'description' => 'Development link',
);
menu_save($menu);
}
Hans Salvisberg
committed
// we have to create the 'Devel settings' menu item ourselves
Hans Salvisberg
committed
$items['admin/config/development/devel'] = array(
'title' => 'Devel settings',
'description' => 'Helper pages and blocks to assist Drupal developers and admins with node_access. The devel blocks can be managed via the <a href="' . url('admin/structure/block') . '">block administration</a> page.',
'page callback' => 'drupal_get_form',
'page arguments' => array('devel_node_access_admin_settings'),
'access arguments' => array('administer site configuration'),
);
$items['devel/settings'] = $items['admin/config/development/devel'] + array(
'menu_name' => 'devel',
);
Hans Salvisberg
committed
// create a callback for use by devel_node_access_user_ajax().
$items['devel/node_access/by_user/%/%'] = array(
'page callback' => 'devel_node_access_user_ajax',
'page arguments' => array(3, 4),
'access arguments' => array(DNA_ACCESS_VIEW),
'type' => MENU_CALLBACK,
);
// add this to the custom menu 'devel' created by the devel module.
$items['devel/node_access/summary'] = array(
'title' => 'Node_access summary',
'page callback' => 'dna_summary',
'access arguments' => array(DNA_ACCESS_VIEW),
'menu_name' => 'devel',
);
return $items;
}
function devel_node_access_admin_settings() {
$form = array();
return system_settings_form($form);
}
function devel_node_access_form_alter(&$form, $form_state, $form_id) {
if ($form_id == 'devel_admin_settings' || $form_id == 'devel_node_access_admin_settings') {
$form['devel_node_access'] = array(
'#type' => 'fieldset',
'#title' => t('Devel Node Access'),
'#collapsible' => TRUE,
);
$form['devel_node_access']['devel_node_access_debug_mode'] = array(
'#type' => 'checkbox',
'#title' => t('Debug mode'),
'#default_value' => variable_get('devel_node_access_debug_mode', FALSE),
Hans Salvisberg
committed
'#description' => t('Debug mode verifies the grant records in the node_access table against those that would be set by running !Rebuild_permissions, and displays them all; this can cause considerable overhead.<br />For even more information enable the <a href="@link">%DNAbU block</a>, too.', array(
'!Rebuild_permissions' => l('[' . $tr('Rebuild permissions') . ']', 'admin/reports/status/rebuild'),
'%DNAbU' => t('Devel Node Access by User'),
'@link' => url('admin/structure/block/list'),
)),
Hans Salvisberg
committed
$form['devel_node_access']['devel_node_access_user_ajax'] = array(
'#type' => 'checkbox',
'#title' => t('Asynchronously populate the <em>Devel Node Access by User</em> block'),
'#default_value' => variable_get('devel_node_access_user_ajax', FALSE),
'#description' => t("Use Ajax to populate the second DNA block. This loads the initial page faster and uses dynamic calls to build the data in the table, one request at a time. It's especially useful during development, if some of the calls are failing.") . '<br />' . t('JavaScript must be enabled in your browser.'),
);
// push the Save button down
$form['actions']['#weight'] = 10;
}
}
function dna_summary() {
// warn user if they have any entries that could grant access to all nodes
Hans Salvisberg
committed
$result = db_query('SELECT DISTINCT realm FROM {node_access} WHERE nid = 0 AND gid = 0');
Moshe Weitzman
committed
$rows = array();
Hans Salvisberg
committed
foreach ($result as $row) {
Moshe Weitzman
committed
$rows[] = array($row->realm);
}
Hans Salvisberg
committed
$output .= '<h3>' . t('Access Granted to All Nodes (All Users)') . "</h3>\n";
$output .= '<p>' . t('Your node_access table contains entries that may be granting all users access to all nodes. Depending on which access control module(s) you use, you may want to delete these entries. If you are not using an access control module, you should probably leave these entries as is.') . "</p>\n";
$headers = array(t('realm'));
Hans Salvisberg
committed
$output .= theme('table', array('header' => $headers, 'rows' => $rows));
$access_granted_to_all_nodes = TRUE;
}
// how many nodes are not represented in the node_access table
Hans Salvisberg
committed
$num = db_query('SELECT COUNT(n.nid) AS num_nodes FROM {node} n LEFT JOIN {node_access} na ON n.nid = na.nid WHERE na.nid IS NULL')->fetchField();
if ($num) {
$output .= '<h3>' . t('Legacy Nodes') . "</h3>\n";
$output .= '<p>' .
Hans Salvisberg
committed
t('You have !num nodes in your node table which are not represented in your node_access table. If you have an access control module installed, these nodes may be hidden from all users. This could be caused by publishing nodes before enabling the access control module. If this is the case, manually updating each node should add it to the node_access table and fix the problem.', array('!num' => l($num, 'devel/node_access/view/NULL')))
Hans Salvisberg
committed
. "</p>\n";
if (!empty($access_granted_to_all_nodes)) {
Hans Salvisberg
committed
$output .= '<p>' .
t('This issue may be masked by the one above, so look into the former first.')
Hans Salvisberg
committed
. "</p>\n";
}
else {
Hans Salvisberg
committed
$output .= '<h3>' . t('All Nodes Represented') . "</h3>\n";
$output .= '<p>' . t('All nodes are represented in the node_access table.') . "</p>\n";
}
// a similar warning to the one above, but slightly more specific
Hans Salvisberg
committed
$result = db_query('SELECT DISTINCT realm FROM {node_access} WHERE nid = 0 AND gid <> 0');
Moshe Weitzman
committed
$rows = array();
Hans Salvisberg
committed
foreach ($result as $row) {
Moshe Weitzman
committed
$rows[] = array($row->realm);
}
Hans Salvisberg
committed
$output .= '<h3>' . t('Access Granted to All Nodes (Some Users)') . "</h3>\n";
$output .= '<p>' . t('Your node_access table contains entries that may be granting some users access to all nodes. This may be perfectly normal, depending on which access control module(s) you use.') . "</p>\n";
$headers = array(t('realm'));
Hans Salvisberg
committed
$output .= theme('table', array('header' => $headers, 'rows' => $rows));
}
// find specific nodes which may be visible to all users
Hans Salvisberg
committed
$result = db_query('SELECT DISTINCT realm, COUNT(DISTINCT nid) as node_count FROM {node_access} WHERE gid = 0 AND nid > 0 GROUP BY realm');
Moshe Weitzman
committed
$rows = array();
Hans Salvisberg
committed
foreach ($result as $row) {
$rows[] = array(
$row->realm,
array(
'data' => $row->node_count,
'align' => 'center',
),
);
Moshe Weitzman
committed
}
Hans Salvisberg
committed
$output .= '<h3>' . t('Access Granted to Some Nodes') . "</h3>\n";
$output .= '<p>' .
t('The following realms appear to grant all users access to some specific nodes. This may be perfectly normal, if some of your content is available to the public.')
Hans Salvisberg
committed
. "</p>\n";
$headers = array(t('realm'), t('public nodes'));
Hans Salvisberg
committed
$output .= theme('table', array('header' => $headers, 'rows' => $rows, 'caption' => t('Public Nodes')));
}
// find specific nodes protected by node_access table
Hans Salvisberg
committed
$result = db_query('SELECT DISTINCT realm, COUNT(DISTINCT nid) as node_count FROM {node_access} WHERE gid <> 0 AND nid > 0 GROUP BY realm');
Moshe Weitzman
committed
$rows = array();
Hans Salvisberg
committed
foreach ($result as $row) {
// no Views yet:
//$rows[] = array(l($row->realm, "devel/node_access/view/$row->realm"),
$rows[] = array(
$row->realm,
array(
'data' => $row->node_count,
'align' => 'center',
),
);
Moshe Weitzman
committed
}
Hans Salvisberg
committed
$output .= '<h3>' . t('Summary by Realm') . "</h3>\n";
$output .= '<p>' . t('The following realms grant limited access to some specific nodes.') . "</p>\n";
$headers = array(t('realm'), t('private nodes'));
Hans Salvisberg
committed
$output .= theme('table', array('header' => $headers, 'rows' => $rows, 'caption' => t('Protected Nodes')));
}
return $output;
}
function dna_visible_nodes($nid = NULL) {
static $nids = array();
if ($nid) {
Hans Salvisberg
committed
$nids[$nid] = $nid;
}
elseif (empty($nids) && arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == NULL) {
// show DNA information on node/NID even if access is denied (IF the user has the 'view devel_node_access information' permission)!
return array(arg(1));
}
return $nids;
}
function devel_node_access_node_view($node, $build_mode) {
// remember this node, for display in our block
dna_visible_nodes($node->nid);
}
Hans Salvisberg
committed
function _devel_node_access_module_invoke_all() { // array and scalar returns
Hans Salvisberg
committed
$args = func_get_args();
Hans Salvisberg
committed
$hook = $args[0];
unset($args[0]);
Hans Salvisberg
committed
$return = array();
foreach (module_implements($hook) as $module) {
Hans Salvisberg
committed
$function = $module . '_' . $hook;
if (function_exists($function)) {
$result = call_user_func_array($function, $args);
if (isset($result)) {
if (is_array($result)) {
foreach ($result as $key => $value) {
// add name of module that returned the value:
$result[$key]['#module'] = $module;
}
}
else {
// build array with result keyed by $module:
$result = array($module => $result);
}
$return = array_merge_recursive($return, $result);
Hans Salvisberg
committed
}
}
}
return $return;
}
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
/**
* Helper function to build an associative array of grant records and their
* history. If there are duplicate records, display an error message.
*
* @param $grants
* An indexed array of grant records, augmented by the '#module' key,
* as created by _devel_node_access_module_invoke_all('node_access_records').
*
* @param $node
* The node that the grant records belong to.
*
* @param $function
* The name of the hook that produced the grants array, in case we need to
* display an error message.
*
* @return
* See _devel_node_access_nar_alter() for the description of the result.
*/
function _devel_node_access_build_nar_data($grants, $node, $function) {
$data = array();
$duplicates = array();
foreach ($grants as $grant) {
if (empty($data[$grant['realm']][$grant['gid']])) {
$data[$grant['realm']][$grant['gid']] = array('original' => $grant, 'current' => $grant, 'changes' => array());
}
else {
if (empty($duplicates[$grant['realm']][$grant['gid']])) {
$duplicates[$grant['realm']][$grant['gid']][] = $data[$grant['realm']][$grant['gid']]['original'];
}
$duplicates[$grant['realm']][$grant['gid']][] = $grant;
}
}
if (!empty($duplicates)) {
// generate an error message
$msg = t('Devel Node Access has detected duplicate records returned from %function:', array('%function' => $function));
$msg .= '<ul>';
foreach ($duplicates as $realm => $data_by_realm) {
foreach ($data_by_realm as $gid => $data_by_realm_gid) {
$msg .= '<li><ul>';
foreach ($data_by_realm_gid as $grant) {
$msg .= "<li>$node->nid/$realm/$gid/" . ($grant['grant_view'] ? 1 : 0) . ($grant['grant_update'] ? 1 : 0) . ($grant['grant_delete'] ? 1 : 0) . ' by ' . $grant['#module'] . '</li>';
}
$msg .= '</ul></li>';
}
}
$msg .= '</ul>';
drupal_set_message($msg, 'error', FALSE);
}
return $data;
}
/**
* Helper function to mimic hook_node_access_records_alter() and trace what
* each module does with it.
*
* @param object $grants
* An indexed array of grant records, augmented by the '#module' key,
* as created by _devel_node_access_module_invoke_all('node_access_records').
* This array is updated by the hook_node_access_records_alter()
* implementations.
*
* @param $node
* The node that the grant records belong to.
*
* @return
* A tree representation of the grant records in $grants including their
* history:
* $data[$realm][$gid]
* ['original'] - grant record before processing
* ['current'] - grant record after processing (if still present)
* ['changes'][]['op'] - change message (add/change/delete by $module)
* ['grant'] - grant record after change (unless deleted)
*/
function _devel_node_access_nar_alter(&$grants, $node) {
//dpm($grants, '_devel_node_access_nar_alter(): grants IN');
$dummy = array();
drupal_alter('node_access_records', $dummy, $node);
static $drupal_static = array();
isset($drupal_static['drupal_alter']) || ($drupal_static['drupal_alter'] = &drupal_static('drupal_alter'));
$functions = $drupal_static['drupal_alter'];
// build the initial tree (and check for duplicates)
$data = _devel_node_access_build_nar_data($grants, $node, 'hook_node_access_records()');
// simulate drupal_alter('node_access_records', $grants, $node);
foreach ($functions['node_access_records'] as $function) {
// call hook_node_access_records_alter() for one module at a time and analyze
$function($grants, $node); // <==
$module = substr($function, 0, strlen($function) - 26);
foreach ($grants as $i => $grant) {
if (empty($data[$grant['realm']][$grant['gid']]['current'])) {
// it's an added grant
$data[$grant['realm']][$grant['gid']]['current'] = $grant;
$data[$grant['realm']][$grant['gid']]['current']['#module'] = $module;
$data[$grant['realm']][$grant['gid']]['changes'][] = array(
'op' => 'added by ' . $module,
'grant' => $grant,
);
$grants[$i]['#module'] = $module;
}
else {
// it's an existing grant, check for changes
foreach (array('view', 'update', 'delete') as $op) {
$$op = $grant["grant_$op"] - $data[$grant['realm']][$grant['gid']]['current']["grant_$op"];
}
$priority = $grant['priority'] - $data[$grant['realm']][$grant['gid']]['current']['priority'];
if ($view || $update || $delete || $priority) {
// it was changed
$data[$grant['realm']][$grant['gid']]['current'] = $grant;
$data[$grant['realm']][$grant['gid']]['current']['#module'] = $module;
$data[$grant['realm']][$grant['gid']]['changes'][] = array(
'op' => 'altered by ' . $module,
'grant' => $grant,
);
$grants[$i]['#module'] = $module;
}
}
$data[$grant['realm']][$grant['gid']]['found'] = TRUE;
}
// check for newly introduced duplicates
_devel_node_access_build_nar_data($grants, $node, 'hook_node_access_records_alter()');
// look for grant records that have disappeared
foreach ($data as $realm => $data2) {
foreach ($data2 as $gid => $data3) {
if (empty($data[$realm][$gid]['found']) && isset($data[$realm][$gid]['current'])) {
unset($data[$realm][$gid]['current']);
$data[$realm][$gid]['changes'][] = array('op' => 'removed by ' . $module);
}
else {
unset($data[$realm][$gid]['found']);
}
}
}
}
//dpm($data, '_devel_node_access_nar_alter() returns');
//dpm($grants, '_devel_node_access_nar_alter(): grants OUT');
return $data;
}
/**
* Helper function to mimic hook_node_grants_alter() and trace what
* each module does with it.
*
* @param object $grants
* An indexed array of grant records, augmented by the '#module' key,
* as created by _devel_node_access_module_invoke_all('node_grants').
* This array is updated by the hook_node_grants_alter()
* implementations.
*
* @param $node
* The node that the grant records belong to.
*
* @return
* A tree representation of the grant records in $grants including their
* history:
* $data[$realm][$gid]
* ['cur'] - TRUE or FALSE whether the gid is present or not
* ['ori'][] - array of module names that contributed this grant (if any)
* ['chg'][] - array of changes, such as
* - 'added' if module name is a prefix if the $realm,
* - 'added by module' otherwise, or
* - 'removed by module'
*/
function _devel_node_access_ng_alter(&$grants, $account, $op) {
//dpm($grants, '_devel_node_access_ng_alter(): grants IN');
$dummy = array();
drupal_alter('node_grants', $dummy, $account, $op);
static $drupal_static = array();
isset($drupal_static['drupal_alter']) || ($drupal_static['drupal_alter'] = &drupal_static('drupal_alter'));
$functions = $drupal_static['drupal_alter'];
// build the initial structure
$data = array();
foreach ($grants as $realm => $gids) {
foreach ($gids as $i => $gid) {
if ($i !== '#module') {
$data[$realm][$gid]['cur'] = TRUE;
$data[$realm][$gid]['ori'][] = $gids['#module'];
}
}
unset($grants[$realm]['#module']);
}
// simulate drupal_alter('node_grants', $grants, $account, $op);
foreach ($functions['node_grants'] as $function) {
// call hook_node_grants_alter() for one module at a time and analyze
$function($grants, $account, $op); // <==
$module = substr($function, 0, strlen($function) - 18);
// check for new gids
foreach ($grants as $realm => $gids) {
foreach ($gids as $i => $gid) {
if (empty($data[$realm][$gid]['cur'])) {
$data[$realm][$gid]['cur'] = TRUE;
$data[$realm][$gid]['chg'][] = 'added by ' . $module;
}
}
}
// check for removed gids
foreach ($data as $realm => $gids) {
foreach ($gids as $gid => $history) {
if ($history['cur'] && array_search($gid, $grants[$realm]) === FALSE) {
$data[$realm][$gid]['cur'] = FALSE;
$data[$realm][$gid]['chg'][] = 'removed by ' . $module;
}
}
}
}
//dpm($data, '_devel_node_access_ng_alter() returns');
//dpm($grants, '_devel_node_access_ng_alter(): grants OUT');
return $data;
}
/**
* Implements hook_block_info().
*/
function devel_node_access_block_info() {
$blocks['dna_node'] = array(
'info' => t('Devel Node Access'),
'region' => 'footer',
'status' => 1,
'cache' => DRUPAL_NO_CACHE,
);
$blocks['dna_user'] = array(
'info' => t('Devel Node Access by User'),
'region' => 'footer',
'cache' => DRUPAL_NO_CACHE,
);
return $blocks;
}
/**
* Implements hook_block_view().
*/
function devel_node_access_block_view($delta) {
Hans Salvisberg
committed
global $user;
Hans Salvisberg
committed
global $theme_key;
static $block1_visible, $hint = '';
if (!isset($block1_visible)) {
$block1_visible = db_query("SELECT status FROM {block} WHERE module = 'devel_node_access' AND delta = 'dna_user' AND theme = :theme", array(
':theme' => $theme_key,
))->fetchField();
Hans Salvisberg
committed
if (!$block1_visible) {
Hans Salvisberg
committed
$hint = t('For per-user access permissions enable the <a href="@link">%DNAbU block</a>.', array('@link' => url('admin/structure/block'), '%DNAbU' => t('Devel Node Access by User')));
Hans Salvisberg
committed
}
}
if (!user_access(DNA_ACCESS_VIEW)) {
return;
}
Hans Salvisberg
committed
$output = array();
switch ($delta) {
case 'dna_node':
if (!count(dna_visible_nodes())) {
Hans Salvisberg
committed
return;
}
// include rows where nid == 0
$nids = array_merge(array(0 => 0), dna_visible_nodes());
Hans Salvisberg
committed
$query = db_select('node_access', 'na');
$query
->fields('na')
->condition('na.nid', $nids, 'IN')
->orderBy('na.nid')
->orderBy('na.realm')
->orderBy('na.gid');
$nodes = node_load_multiple($nids);
if (!variable_get('devel_node_access_debug_mode', FALSE)) {
$headers = array(t('node'), t('realm'), t('gid'), t('view'), t('update'), t('delete'), t('explained'));
$rows = array();
Hans Salvisberg
committed
foreach ($query->execute() as $row) {
$explained = module_invoke_all('node_access_explain', $row);
$rows[] = array(
(empty($row->nid) ? '0' : '<a href="#node-' . $row->nid . '">' . _devel_node_access_get_node_title($nodes[$row->nid], TRUE) . '</a>'),
$row->realm,
$row->gid,
$row->grant_view,
$row->grant_update,
$row->grant_delete,
implode('<br />', $explained),
);
Hans Salvisberg
committed
$output[] = array(
'#theme' => 'table',
'#header' => $headers,
'#rows' => $rows,
'#attributes' => array('style' => 'text-align: left')
);
$hint = t('To see more details enable <a href="@debug_mode">debug mode</a>.', array('@debug_mode' => url('admin/config/development/devel', array('fragment' => 'edit-devel-node-access')))) . (empty($hint) ? '' : ' ' . $hint);
}
else {
$tr = 't';
Hans Salvisberg
committed
$variables = array('!na' => '{node_access}');
$states = array(
'default' => array(t('default'), 'ok', t('Default grant supplied by core in the absence of any other non-empty grants; in !na.', $variables)),
'ok' => array(t('ok'), 'ok', t('Highest priority grant; in !na.', $variables)),
'removed' => array(t('removed'), '', t('Was removed in @func; not in !na.', $variables + array('@func' => 'hook_node_access_records_alter()'))),
Hans Salvisberg
committed
'static' => array(t('static'), 'ok', t('Non-standard grant in !na.', $variables)),
'unexpected' => array(t('unexpected'), 'warning', t('The 0/all/0/... grant applies to all nodes and all users -- usually it should not be present in !na if any node access module is active!')),
'ignored' => array(t('ignored'), 'warning', t('Lower priority grant; not in !na and thus ignored.', $variables)),
Hans Salvisberg
committed
'empty' => array(t('empty'), 'warning', t('Does not grant any access, but could block lower priority grants; not in !na.', $variables)),
'wrong' => array(t('wrong'), 'error', t('Is rightfully in !na but at least one access flag is wrong!', $variables)),
Hans Salvisberg
committed
'missing' => array(t('missing'), 'error', t("Should be in !na but isn't!", $variables)),
'removed!' => array(t('removed!'), 'error', t('Was removed in @func; should NOT be in !na!', $variables + array('@func' => 'hook_node_access_records_alter()'))),
Hans Salvisberg
committed
'illegitimate' => array(t('illegitimate'), 'error', t('Should NOT be in !na because of lower priority!', $variables)),
'alien' => array(t('alien'), 'error', t('Should NOT be in !na because of unknown origin!', $variables)),
);
$active_states = array('default', 'ok', 'static', 'unexpected', 'wrong', 'illegitimate', 'alien');
$headers = array(t('node'), t('prio'), t('status'), t('realm'), t('gid'), t('view'), t('update'), t('delete'), t('explained'));
$headers = _devel_node_access_format_row($headers);
$active_grants = array();
Hans Salvisberg
committed
foreach ($query->execute() as $active_grant) {
$active_grants[$active_grant->nid][$active_grant->realm][$active_grant->gid] = $active_grant;
}
$all_grants = $checked_grants = $published_nid = array();
foreach ($nids as $nid) {
$acquired_grants_nid = array();
Hans Salvisberg
committed
if ($node = node_load($nid)) {
// check node_access_acquire_grants()
$grants = _devel_node_access_module_invoke_all('node_access_records', $node);
// check drupal_alter('node_access_records')
$data = _devel_node_access_nar_alter($grants, $node);
/* (This was the D6 implementation that didn't analyze the hook_node_access_records_alter() details.)
if (!empty($grants)) {
$top_priority = NULL;
foreach ($grants as $grant) {
$priority = intval($grant['priority']);
$top_priority = (isset($top_priority) ? max($top_priority, $priority) : $priority);
$grant['priority'] = (isset($grant['priority']) ? $priority : '– ');
$acquired_grants_nid[$priority][$grant['realm']][$grant['gid']] = $grant + array(
'#title' => _devel_node_access_get_node_title($node, TRUE),
'#module' => (isset($grant['#module']) ? $grant['#module'] : ''),
);
}
krsort($acquired_grants_nid);
Hans Salvisberg
committed
}
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
/*/
// (This is the new D7 implementation; it retains backward compatibility.)
if (!empty($data)) {
foreach ($data as $data_by_realm) {
foreach ($data_by_realm as $data_by_realm_gid) { // by gid
if (isset($data_by_realm_gid['current'])) {
$grant = $data_by_realm_gid['current'];
}
elseif (isset($data_by_realm_gid['original'])) {
$grant = $data_by_realm_gid['original'];
$grant['#removed'] = 1;
}
else {
continue;
}
$priority = intval($grant['priority']);
$top_priority = (isset($top_priority) ? max($top_priority, $priority) : $priority);
$grant['priority'] = (isset($grant['priority']) ? $priority : '– ');
$grant['history'] = $data_by_realm_gid;
$acquired_grants_nid[$priority][$grant['realm']][$grant['gid']] = $grant + array(
'#title' => _devel_node_access_get_node_title($node),
'#module' => (isset($grant['#module']) ? $grant['#module'] : ''),
);
}
}
krsort($acquired_grants_nid);
}
/**/
//dpm($acquired_grants_nid, "acquired_grants_nid =");
// check node_access_grants()
$published_nid[$nid] = $node->status;
if ($node->nid) {
foreach (array('view', 'update', 'delete') as $op) {
$grants = _devel_node_access_module_invoke_all('node_grants', $user, $op);
// call all hook_node_grants_alter() implementations
$ng_alter_data = _devel_node_access_ng_alter($grants, $user, $op);
$checked_grants[$nid][$op] = array_merge(array('all' => array(0)), $grants);
Hans Salvisberg
committed
}
// check for grants in the node_access table that aren't returned by node_access_acquire_grants()
Hans Salvisberg
committed
if (isset($active_grants[$nid])) {
foreach ($active_grants[$nid] as $realm => $active_grants_realm) {
foreach ($active_grants_realm as $gid => $active_grant) {
Hans Salvisberg
committed
$found = FALSE;
$count_nonempty_grants = 0;
foreach ($acquired_grants_nid as $priority => $acquired_grants_nid_priority) {
if (isset($acquired_grants_nid_priority[$realm][$gid])) {
$found = TRUE;
Hans Salvisberg
committed
}
}
if ($acquired_grants_nid_priority = reset($acquired_grants_nid)) { // highest priority only
foreach ($acquired_grants_nid_priority as $acquired_grants_nid_priority_realm) {
foreach ($acquired_grants_nid_priority_realm as $acquired_grants_nid_priority_realm_gid) {
$count_nonempty_grants += (!empty($acquired_grants_nid_priority_realm_gid['grant_view']) || !empty($acquired_grants_nid_priority_realm_gid['grant_update']) || !empty($acquired_grants_nid_priority_realm_gid['grant_delete']));
Hans Salvisberg
committed
}
}
}
Hans Salvisberg
committed
$fixed_grant = (array) $active_grant;
if ($count_nonempty_grants == 0 && $realm == 'all' && $gid == 0) {
Hans Salvisberg
committed
$fixed_grant += array(
'priority' => '–',
'state' => 'default',
);
}
elseif (!$found) {
Hans Salvisberg
committed
$acknowledged = _devel_node_access_module_invoke_all('node_access_acknowledge', $fixed_grant);
if (empty($acknowledged)) {
// no module acknowledged this record, mark it as alien
Hans Salvisberg
committed
$fixed_grant += array(
'priority' => '?',
'state' => 'alien',
);
}
else {
// at least one module acknowledged the record, attribute it to the first one
Hans Salvisberg
committed
$fixed_grant += array(
'priority' => '–',
'state' => 'static',
'#module' => reset(array_keys($acknowledged)),
Hans Salvisberg
committed
);
}
}
else {
continue;
}
$fixed_grant += array(
'nid' => $nid,
'#title' => _devel_node_access_get_node_title($node),
);
$all_grants[] = $fixed_grant;
Hans Salvisberg
committed
}
}
}
// order grants and evaluate their status
foreach ($acquired_grants_nid as $priority => $acquired_grants_priority) {
ksort($acquired_grants_priority);
foreach ($acquired_grants_priority as $realm => $acquired_grants_realm) {
ksort($acquired_grants_realm);
foreach ($acquired_grants_realm as $gid => $acquired_grant) {
if ($priority == $top_priority) {
if (empty($acquired_grant['grant_view']) && empty($acquired_grant['grant_update']) && empty($acquired_grant['grant_delete'])) {
$acquired_grant['state'] = 'empty';
}
else {
if (isset($active_grants[$nid][$realm][$gid])) {
$acquired_grant['state'] = (isset($acquired_grant['#removed']) ? 'removed!' : 'ok');
}
else {
$acquired_grant['state'] = (isset($acquired_grant['#removed']) ? 'removed' : 'missing');
}
if ($acquired_grant['state'] == 'ok') {
foreach (array('view', 'update', 'delete') as $op) {
$active_grant = (array) $active_grants[$nid][$realm][$gid];
if (empty($acquired_grant["grant_$op"]) != empty($active_grant["grant_$op"])) {
$acquired_grant["grant_$op!"] = $active_grant["grant_$op"];
Hans Salvisberg
committed
}
}
}
}
}
else {
$acquired_grant['state'] = (isset($active_grants[$nid][$realm][$gid]) ? 'illegitimate' : 'ignored');
Hans Salvisberg
committed
}
$all_grants[] = $acquired_grant + array('nid' => $nid);
Hans Salvisberg
committed
}
}
}
}
// fill in the table rows
$rows = array();
$error_count = 0;
foreach ($all_grants as $grant) {
$row = new stdClass();
$row->nid = $grant['nid'];
$row->title = $grant['#title'];
$row->priority = $grant['priority'];
$row->state = array('data' => $states[$grant['state']][0], 'title' => $states[$grant['state']][2]);
$row->realm = $grant['realm'];
$row->gid = $grant['gid'];
$row->grant_view = $grant['grant_view'];
$row->grant_update = $grant['grant_update'];
$row->grant_delete = $grant['grant_delete'];
Hans Salvisberg
committed
$row->explained = implode('<br />', module_invoke_all('node_access_explain', $row));
Hans Salvisberg
committed
unset($row->title); // possibly needed above
if ($row->nid == 0 && $row->gid == 0 && $row->realm == 'all' && count($all_grants) > 1) {
$row->state = array('data' => $states['unexpected'][0], 'title' => $states['unexpected'][2]);
$class = $states['unexpected'][1];
}
else {
$class = $states[$grant['state']][1];
}
$row = (array) $row;
foreach (array('view', 'update', 'delete') as $op) {
$row["grant_$op"] = array('data' => $row["grant_$op"]);
if ((isset($checked_grants[$grant['nid']][$op][$grant['realm']]) && in_array($grant['gid'], $checked_grants[$grant['nid']][$op][$grant['realm']]) || ($row['nid'] == 0 && $row['gid'] == 0 && $row['realm'] == 'all')) && !empty($row["grant_$op"]['data']) && in_array($grant['state'], $active_states)) {
$row["grant_$op"]['data'] .= '′';
$row["grant_$op"]['title'] = t('This entry grants access to this node to this user.');
Hans Salvisberg
committed
}
if (isset($grant["grant_$op!"])) {
$row["grant_$op"]['data'] = $grant["grant_$op!"] . '>' . (!$row["grant_$op"]['data'] ? 0 : $row["grant_$op"]['data']);
Hans Salvisberg
committed
$row["grant_$op"]['class'][] = 'error';
if ($class == 'ok') {
$row['state'] = array('data' => $states['wrong'][0], 'title' => $states['wrong'][2]);
$class = $states['wrong'][1];
}
Hans Salvisberg
committed
}
$error_count += ($class == 'error');
$row['nid'] = array(
'data' => '<a href="#node-' . $grant['nid'] . '">' . $row['nid'] . '</a>',
'title' => $grant['#title'],
);
Hans Salvisberg
committed
$row['realm'] = (empty($grant['#module']) || strpos($grant['realm'], $grant['#module']) === 0 ? '' : $grant['#module'] . ':<br />') . $grant['realm'];
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
// prepend information from the D7 hook_node_access_records_alter()
$next_style = array();
if (isset($grant['history'])) {
$history = $grant['history'];
if (($num_changes = count($history['changes']) - empty($history['current'])) > 0) {
$first_row = TRUE;
while (isset($history['original']) || $num_changes--) {
if (isset($history['original'])) {
$this_grant = $history['original'];
$this_action = '[ Original by ' . $this_grant['#module'] . ':';
unset($history['original']);
}
else {
$change = $history['changes'][0];
$this_grant = $change['grant'];
$this_action = ($first_row ? '[ ' : '') . $change['op'] . ':';
array_shift($history['changes']);
}
$rows[] = array(
'data' => array(
'data' => array(
'data' => $this_action,
'style' => array('padding-bottom: 0;'),
),
),
'style' => array_merge(($first_row ? array() : array('border-top-style: dashed;', 'border-top-width: 1px;')), array('border-bottom-style: none;')),
);
$next_style = array('border-top-style: none;');
if (count($history['changes'])) {
$g = $this_grant;
$rows[] = array(
'data' => array('v', $g['priority'], '', $g['realm'], $g['gid'], $g['grant_view'], $g['grant_update'], $g['grant_delete'], 'v'),
'style' => array('border-top-style: none;', 'border-bottom-style: dashed;'),
);
$next_style = array('border-top-style: dashed;');
}
$first_row = FALSE;
}
}
}
Hans Salvisberg
committed
// fix up the main row cells with the proper class (needed for Bartik)
foreach ($row as $key => $value) {
if (!is_array($value)) {
$row[$key] = array('data' => $value);
}
$row[$key]['class'] = array($class);
}
// add the main row
$will_append = empty($history['current']) && !empty($history['changes']);
$rows[] = array(
'data' => array_values($row),
'class' => array($class),
'style' => array_merge($next_style, ($will_append ? array('border-bottom-style: none;') : array())),
);
// append information from the D7 hook_node_access_records_alter()
if ($will_append) {
$last_change = end($history['changes']);
$rows[] = array(
'data' => array(
'data' => array(
'data' => $last_change['op'] . ' ]',
'style' => array('padding-top: 0;'),
),
),
'style' => array('border-top-style: none;'),
);
}
}
foreach ($rows as $i => $row) {
$rows[$i] = _devel_node_access_format_row($row);
Hans Salvisberg
committed
$output[] = array(
'#theme' => 'table',
'#header' => $headers,
'#rows' => $rows,
'#attributes' => array(
'class' => array('system-status-report'),
'style' => 'text-align: left;',
Hans Salvisberg
committed
);
Hans Salvisberg
committed
$output[] = array(
'#theme' => 'form_element',
'#description' => t('(Some of the table elements provide additional information if you hover your mouse over them.)'),
Hans Salvisberg
committed
);
if ($error_count > 0) {
Hans Salvisberg
committed
$variables['!Rebuild_permissions'] = '<a href="' . url('admin/reports/status/rebuild') . '">' . $tr('Rebuild permissions') . '</a>';
Hans Salvisberg
committed
$output[] = array(
'#prefix' => "\n<div class=\"error\">",
'#markup' => t("You have errors in your !na table! You may be able to fix these for now by running !Rebuild_permissions, but this is likely to destroy the evidence and make it impossible to identify the underlying issues. If you don't fix those, the errors will probably come back again. <br /> DON'T do this just yet if you intend to ask for help with this situation.", $variables),
'#suffix' => "</div><br />\n",
);
}
Hans Salvisberg
committed
// Explain whether access is granted or denied, and why (using code from node_access()).
Hans Salvisberg
committed
array_shift($nids); // remove the 0
$accounts = array();
$variables += array(
'!username' => '<em class="placeholder">' . theme('username', array('account' => $user)) . '</em>',
'%uid' => $user->uid,
Hans Salvisberg
committed
);
if (user_access('bypass node access')) {
$variables['%bypass_node_access'] = $tr('bypass node access');
Hans Salvisberg
committed
$output[] = array(
'#markup' => t('!username has the %bypass_node_access permission and thus full access to all nodes.', $variables),
'#suffix' => '<br /> ',
);
}
else {
$variables['!list'] = '<div style="margin-left: 2em">' . _devel_node_access_get_grant_list($nid, $ng_alter_data) . '</div>';
Hans Salvisberg
committed
$variables['%access'] = 'view';
Hans Salvisberg
committed
$output[] = array(
'#prefix' => "\n<div style='text-align: left' title='" . t('These are the grants returned by hook_node_grants() for this user.') . "'>",
'#markup' => t('!username (user %uid) can use these grants (if they are present above) for %access access: !list', $variables),
'#suffix' => "</div>\n",
);
Hans Salvisberg
committed
$accounts[] = $user;
}
if (arg(0) == 'node' && is_numeric(arg(1)) && !$block1_visible) { // only for single nodes
if (user_is_logged_in()) {
$accounts[] = user_load(0); // Anonymous, too
Hans Salvisberg
committed
foreach ($accounts as $account) {
Hans Salvisberg
committed
$account_items = array();
Hans Salvisberg
committed
$nid_items = array();
foreach ($nids as $nid) {
$op_items = array();
foreach (array('create', 'view', 'update', 'delete') as $op) {
$explain = _devel_node_access_explain_access($op, $nid, $account);
$op_items[] = "<div style='width: 5em; display: inline-block'>" . t('%op:', array('%op' => $op)) . ' </div>' . $explain[2];
Hans Salvisberg
committed
}
Hans Salvisberg
committed
$nid_items[] = array(
'#theme' => 'item_list',
'#items' => $op_items,
'#type' => 'ul',
'#prefix' => t('to node !nid:', array('!nid' => l($nid, 'node/' . $nid))) . "\n<div style='margin-left: 2em'>",
'#suffix' => '</div>',
);
Hans Salvisberg
committed
}
Hans Salvisberg
committed
if (count($nid_items) == 1) {
Hans Salvisberg
committed
$account_items = $nid_items[0];
Hans Salvisberg
committed
}
else {
Hans Salvisberg
committed
$account_items = array(
'#theme' => 'item_list',
'#items' => $nid_items,
'#type' => 'ul',
'#prefix' => "\n<div style='margin-left: 2em'>",
'#suffix' => '</div>',
);
Hans Salvisberg
committed
}
Hans Salvisberg
committed
$variables['!username'] = theme('username', array('account' => $account));
$output[] = array(
'#prefix' => "\n<div style='text-align: left'>",
'#markup' => t("!username has the following access", $variables),
'items' => $account_items,
'#suffix' => "\n</div>\n",
);
Hans Salvisberg
committed
}
}
}
Hans Salvisberg
committed
Hans Salvisberg
committed
if (!empty($hint)) {
Hans Salvisberg
committed
$output[] = array(
'#theme' => 'form_element',
'#description' => '(' . $hint . ')',
);
Hans Salvisberg
committed
}
Hans Salvisberg
committed
$output[]['#markup'] = '<br /><br />';
$subject = t('node_access entries for nodes shown on this page');
Hans Salvisberg
committed
return array('subject' => $subject, 'content' => $output);
case 'dna_user':
// show which users can access this node
Hans Salvisberg
committed
if (arg(0) == 'node' && is_numeric($nid = arg(1)) && arg(2) == NULL && $node = node_load($nid)) {
Hans Salvisberg
committed
$node_type = node_type_get_type($node);
$headers = array(t('username'), '<span title="' . t("Create nodes of the '@Node_type' type.", array('@Node_type' => $node_type->name)) . '">' . t('create') . '</span>', t('view'), t('update'), t('delete'));
$rows = array();
Hans Salvisberg
committed
// Determine whether to use Ajax or prepopulate the tables.
if ($ajax = variable_get('devel_node_access_user_ajax', FALSE)) {
drupal_add_js(drupal_get_path('module', 'devel_node_access') . '/devel_node_access.js');
}
// Find all users. The following operations are very inefficient, so we
// limit the number of users returned. It would be better to make a
// pager query, or at least make the number of users configurable. If
// anyone is up for that please submit a patch.
$query = db_select('users', 'u')
->fields('u', array('uid'))
Hans Salvisberg
committed
->orderBy('access', 'DESC')
->range(0, 9);
$uids = $query->execute()->fetchCol();
array_unshift($uids, 0);
$accounts = user_load_multiple($uids);
foreach ($accounts as $account) {
$username = theme('username', array('account' => $account));
if ($account->uid == $user->uid) {
$username = '<strong>' . $username . '</strong>';
}
$rows[] = array(
Hans Salvisberg
committed
array(
'id' => 'create-' . $nid . '-' . $account->uid,