summaryrefslogtreecommitdiffstatshomepage
path: root/core/modules/dblog
diff options
context:
space:
mode:
Diffstat (limited to 'core/modules/dblog')
-rw-r--r--core/modules/dblog/dblog-rtl.css7
-rw-r--r--core/modules/dblog/dblog.admin.inc381
-rw-r--r--core/modules/dblog/dblog.css59
-rw-r--r--core/modules/dblog/dblog.info6
-rw-r--r--core/modules/dblog/dblog.install99
-rw-r--r--core/modules/dblog/dblog.module184
-rw-r--r--core/modules/dblog/dblog.test588
7 files changed, 1324 insertions, 0 deletions
diff --git a/core/modules/dblog/dblog-rtl.css b/core/modules/dblog/dblog-rtl.css
new file mode 100644
index 00000000000..282fe971ddc
--- /dev/null
+++ b/core/modules/dblog/dblog-rtl.css
@@ -0,0 +1,7 @@
+
+.form-item-type,
+.form-item-severity {
+ float: right;
+ padding-right: 0;
+ padding-left: .8em;
+}
diff --git a/core/modules/dblog/dblog.admin.inc b/core/modules/dblog/dblog.admin.inc
new file mode 100644
index 00000000000..b2da7eddf2d
--- /dev/null
+++ b/core/modules/dblog/dblog.admin.inc
@@ -0,0 +1,381 @@
+<?php
+
+/**
+ * @file
+ * Administrative page callbacks for the dblog module.
+ */
+
+/**
+ * Menu callback; displays a listing of log messages.
+ *
+ * Messages are truncated at 56 chars. Full-length message could be viewed at
+ * the message details page.
+ */
+function dblog_overview() {
+ $filter = dblog_build_filter_query();
+ $rows = array();
+ $classes = array(
+ WATCHDOG_DEBUG => 'dblog-debug',
+ WATCHDOG_INFO => 'dblog-info',
+ WATCHDOG_NOTICE => 'dblog-notice',
+ WATCHDOG_WARNING => 'dblog-warning',
+ WATCHDOG_ERROR => 'dblog-error',
+ WATCHDOG_CRITICAL => 'dblog-critical',
+ WATCHDOG_ALERT => 'dblog-alert',
+ WATCHDOG_EMERGENCY => 'dblog-emerg',
+ );
+
+ $build['dblog_filter_form'] = drupal_get_form('dblog_filter_form');
+ $build['dblog_clear_log_form'] = drupal_get_form('dblog_clear_log_form');
+
+ $header = array(
+ '', // Icon column.
+ array('data' => t('Type'), 'field' => 'w.type'),
+ array('data' => t('Date'), 'field' => 'w.wid', 'sort' => 'desc'),
+ t('Message'),
+ array('data' => t('User'), 'field' => 'u.name'),
+ array('data' => t('Operations')),
+ );
+
+ $query = db_select('watchdog', 'w')->extend('PagerDefault')->extend('TableSort');
+ $query->leftJoin('users', 'u', 'w.uid = u.uid');
+ $query
+ ->fields('w', array('wid', 'uid', 'severity', 'type', 'timestamp', 'message', 'variables', 'link'))
+ ->addField('u', 'name');
+ if (!empty($filter['where'])) {
+ $query->where($filter['where'], $filter['args']);
+ }
+ $result = $query
+ ->limit(50)
+ ->orderByHeader($header)
+ ->execute();
+
+ foreach ($result as $dblog) {
+ $rows[] = array('data' =>
+ array(
+ // Cells
+ array('class' => 'icon'),
+ t($dblog->type),
+ format_date($dblog->timestamp, 'short'),
+ theme('dblog_message', array('event' => $dblog, 'link' => TRUE)),
+ theme('username', array('account' => $dblog)),
+ filter_xss($dblog->link),
+ ),
+ // Attributes for tr
+ 'class' => array(drupal_html_class('dblog-' . $dblog->type), $classes[$dblog->severity]),
+ );
+ }
+
+ $build['dblog_table'] = array(
+ '#theme' => 'table',
+ '#header' => $header,
+ '#rows' => $rows,
+ '#attributes' => array('id' => 'admin-dblog'),
+ '#empty' => t('No log messages available.'),
+ );
+ $build['dblog_pager'] = array('#theme' => 'pager');
+
+ return $build;
+}
+
+/**
+ * Menu callback; generic function to display a page of the most frequent events.
+ *
+ * Messages are not truncated because events from this page have no detail view.
+ *
+ * @param $type
+ * type of dblog events to display.
+ */
+function dblog_top($type) {
+
+ $header = array(
+ array('data' => t('Count'), 'field' => 'count', 'sort' => 'desc'),
+ array('data' => t('Message'), 'field' => 'message')
+ );
+ $count_query = db_select('watchdog');
+ $count_query->addExpression('COUNT(DISTINCT(message))');
+ $count_query->condition('type', $type);
+
+ $query = db_select('watchdog', 'w')->extend('PagerDefault')->extend('TableSort');
+ $query->addExpression('COUNT(wid)', 'count');
+ $query = $query
+ ->fields('w', array('message', 'variables'))
+ ->condition('w.type', $type)
+ ->groupBy('message')
+ ->groupBy('variables')
+ ->limit(30)
+ ->orderByHeader($header);
+ $query->setCountQuery($count_query);
+ $result = $query->execute();
+
+ $rows = array();
+ foreach ($result as $dblog) {
+ $rows[] = array($dblog->count, theme('dblog_message', array('event' => $dblog)));
+ }
+
+ $build['dblog_top_table'] = array(
+ '#theme' => 'table',
+ '#header' => $header,
+ '#rows' => $rows,
+ '#empty' => t('No log messages available.'),
+ );
+ $build['dblog_top_pager'] = array('#theme' => 'pager');
+
+ return $build;
+}
+
+/**
+ * Menu callback; displays details about a log message.
+ */
+function dblog_event($id) {
+ $severity = watchdog_severity_levels();
+ $result = db_query('SELECT w.*, u.name, u.uid FROM {watchdog} w INNER JOIN {users} u ON w.uid = u.uid WHERE w.wid = :id', array(':id' => $id))->fetchObject();
+ if ($dblog = $result) {
+ $rows = array(
+ array(
+ array('data' => t('Type'), 'header' => TRUE),
+ t($dblog->type),
+ ),
+ array(
+ array('data' => t('Date'), 'header' => TRUE),
+ format_date($dblog->timestamp, 'long'),
+ ),
+ array(
+ array('data' => t('User'), 'header' => TRUE),
+ theme('username', array('account' => $dblog)),
+ ),
+ array(
+ array('data' => t('Location'), 'header' => TRUE),
+ l($dblog->location, $dblog->location),
+ ),
+ array(
+ array('data' => t('Referrer'), 'header' => TRUE),
+ l($dblog->referer, $dblog->referer),
+ ),
+ array(
+ array('data' => t('Message'), 'header' => TRUE),
+ theme('dblog_message', array('event' => $dblog)),
+ ),
+ array(
+ array('data' => t('Severity'), 'header' => TRUE),
+ $severity[$dblog->severity],
+ ),
+ array(
+ array('data' => t('Hostname'), 'header' => TRUE),
+ check_plain($dblog->hostname),
+ ),
+ array(
+ array('data' => t('Operations'), 'header' => TRUE),
+ $dblog->link,
+ ),
+ );
+ $build['dblog_table'] = array(
+ '#theme' => 'table',
+ '#rows' => $rows,
+ '#attributes' => array('class' => array('dblog-event')),
+ );
+ return $build;
+ }
+ else {
+ return '';
+ }
+}
+
+/**
+ * Build query for dblog administration filters based on session.
+ */
+function dblog_build_filter_query() {
+ if (empty($_SESSION['dblog_overview_filter'])) {
+ return;
+ }
+
+ $filters = dblog_filters();
+
+ // Build query
+ $where = $args = array();
+ foreach ($_SESSION['dblog_overview_filter'] as $key => $filter) {
+ $filter_where = array();
+ foreach ($filter as $value) {
+ $filter_where[] = $filters[$key]['where'];
+ $args[] = $value;
+ }
+ if (!empty($filter_where)) {
+ $where[] = '(' . implode(' OR ', $filter_where) . ')';
+ }
+ }
+ $where = !empty($where) ? implode(' AND ', $where) : '';
+
+ return array(
+ 'where' => $where,
+ 'args' => $args,
+ );
+}
+
+
+/**
+ * List dblog administration filters that can be applied.
+ */
+function dblog_filters() {
+ $filters = array();
+
+ foreach (_dblog_get_message_types() as $type) {
+ $types[$type] = t($type);
+ }
+
+ if (!empty($types)) {
+ $filters['type'] = array(
+ 'title' => t('Type'),
+ 'where' => "w.type = ?",
+ 'options' => $types,
+ );
+ }
+
+ $filters['severity'] = array(
+ 'title' => t('Severity'),
+ 'where' => 'w.severity = ?',
+ 'options' => watchdog_severity_levels(),
+ );
+
+ return $filters;
+}
+
+/**
+ * Returns HTML for a log message.
+ *
+ * @param $variables
+ * An associative array containing:
+ * - event: An object with at least the message and variables properties.
+ * - link: (optional) Format message as link, event->wid is required.
+ *
+ * @ingroup themeable
+ */
+function theme_dblog_message($variables) {
+ $output = '';
+ $event = $variables['event'];
+ // Check for required properties.
+ if (isset($event->message) && isset($event->variables)) {
+ // Messages without variables or user specified text.
+ if ($event->variables === 'N;') {
+ $output = $event->message;
+ }
+ // Message to translate with injected variables.
+ else {
+ $output = t($event->message, unserialize($event->variables));
+ }
+ if ($variables['link'] && isset($event->wid)) {
+ // Truncate message to 56 chars.
+ $output = truncate_utf8(filter_xss($output, array()), 56, TRUE, TRUE);
+ $output = l($output, 'admin/reports/event/' . $event->wid, array('html' => TRUE));
+ }
+ }
+ return $output;
+}
+
+/**
+ * Return form for dblog administration filters.
+ *
+ * @ingroup forms
+ * @see dblog_filter_form_submit()
+ * @see dblog_filter_form_validate()
+ */
+function dblog_filter_form($form) {
+ $filters = dblog_filters();
+
+ $form['filters'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Filter log messages'),
+ '#collapsible' => TRUE,
+ '#collapsed' => empty($_SESSION['dblog_overview_filter']),
+ );
+ foreach ($filters as $key => $filter) {
+ $form['filters']['status'][$key] = array(
+ '#title' => $filter['title'],
+ '#type' => 'select',
+ '#multiple' => TRUE,
+ '#size' => 8,
+ '#options' => $filter['options'],
+ );
+ if (!empty($_SESSION['dblog_overview_filter'][$key])) {
+ $form['filters']['status'][$key]['#default_value'] = $_SESSION['dblog_overview_filter'][$key];
+ }
+ }
+
+ $form['filters']['actions'] = array(
+ '#type' => 'actions',
+ '#attributes' => array('class' => array('container-inline')),
+ );
+ $form['filters']['actions']['submit'] = array(
+ '#type' => 'submit',
+ '#value' => t('Filter'),
+ );
+ if (!empty($_SESSION['dblog_overview_filter'])) {
+ $form['filters']['actions']['reset'] = array(
+ '#type' => 'submit',
+ '#value' => t('Reset')
+ );
+ }
+
+ return $form;
+}
+
+/**
+ * Validate result from dblog administration filter form.
+ */
+function dblog_filter_form_validate($form, &$form_state) {
+ if ($form_state['values']['op'] == t('Filter') && empty($form_state['values']['type']) && empty($form_state['values']['severity'])) {
+ form_set_error('type', t('You must select something to filter by.'));
+ }
+}
+
+/**
+ * Process result from dblog administration filter form.
+ */
+function dblog_filter_form_submit($form, &$form_state) {
+ $op = $form_state['values']['op'];
+ $filters = dblog_filters();
+ switch ($op) {
+ case t('Filter'):
+ foreach ($filters as $name => $filter) {
+ if (isset($form_state['values'][$name])) {
+ $_SESSION['dblog_overview_filter'][$name] = $form_state['values'][$name];
+ }
+ }
+ break;
+ case t('Reset'):
+ $_SESSION['dblog_overview_filter'] = array();
+ break;
+ }
+ return 'admin/reports/dblog';
+}
+
+/**
+ * Return form for dblog clear button.
+ *
+ * @ingroup forms
+ * @see dblog_clear_log_submit()
+ */
+function dblog_clear_log_form($form) {
+ $form['dblog_clear'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Clear log messages'),
+ '#description' => t('This will permanently remove the log messages from the database.'),
+ '#collapsible' => TRUE,
+ '#collapsed' => TRUE,
+ );
+ $form['dblog_clear']['clear'] = array(
+ '#type' => 'submit',
+ '#value' => t('Clear log messages'),
+ '#submit' => array('dblog_clear_log_submit'),
+ );
+
+ return $form;
+}
+
+/**
+ * Submit callback: clear database with log messages.
+ */
+function dblog_clear_log_submit() {
+ $_SESSION['dblog_overview_filter'] = array();
+ db_delete('watchdog')->execute();
+ drupal_set_message(t('Database log cleared.'));
+}
diff --git a/core/modules/dblog/dblog.css b/core/modules/dblog/dblog.css
new file mode 100644
index 00000000000..88f4ba01b8a
--- /dev/null
+++ b/core/modules/dblog/dblog.css
@@ -0,0 +1,59 @@
+.form-item-type,
+.form-item-severity {
+ float: left; /* LTR */
+ padding-right: .8em; /* LTR */
+ margin: 0.1em;
+ /**
+ * In Opera 9, DOM elements with the property of "overflow: auto"
+ * will partially hide its contents with unnecessary scrollbars when
+ * its immediate child is floated without an explicit width set.
+ */
+ width: 15em;
+}
+#dblog-filter-form .form-type-select select {
+ width: 100%;
+}
+#dblog-filter-form .form-actions {
+ float: left;
+ padding: 3ex 0 0 1em;
+}
+
+tr.dblog-user {
+ background: #ffd;
+}
+tr.dblog-user .active {
+ background: #eed;
+}
+tr.dblog-content {
+ background: #ddf;
+}
+tr.dblog-content .active {
+ background: #cce;
+}
+tr.dblog-page-not-found,
+tr.dblog-access-denied {
+ background: #dfd;
+}
+tr.dblog-page-not-found .active,
+tr.dblog-access-denied .active {
+ background: #cec;
+}
+tr.dblog-error {
+ background: #ffc9c9;
+}
+tr.dblog-error .active {
+ background: #eeb9b9;
+}
+table#admin-dblog td.icon {
+ background: no-repeat center;
+ width: 16px;
+}
+table#admin-dblog tr.dblog-warning td.icon {
+ background-image: url(../../misc/message-16-warning.png);
+}
+table#admin-dblog tr.dblog-error td.icon,
+table#admin-dblog tr.dblog-critical td.icon,
+table#admin-dblog tr.dblog-alert td.icon,
+table#admin-dblog tr.dblog-emerg td.icon {
+ background-image: url(../../misc/message-16-error.png);
+}
diff --git a/core/modules/dblog/dblog.info b/core/modules/dblog/dblog.info
new file mode 100644
index 00000000000..2aa61fc0e59
--- /dev/null
+++ b/core/modules/dblog/dblog.info
@@ -0,0 +1,6 @@
+name = Database logging
+description = Logs and records system events to the database.
+package = Core
+version = VERSION
+core = 8.x
+files[] = dblog.test
diff --git a/core/modules/dblog/dblog.install b/core/modules/dblog/dblog.install
new file mode 100644
index 00000000000..23f85ba2594
--- /dev/null
+++ b/core/modules/dblog/dblog.install
@@ -0,0 +1,99 @@
+<?php
+
+/**
+ * @file
+ * Install, update and uninstall functions for the dblog module.
+ */
+
+/**
+ * Implements hook_schema().
+ */
+function dblog_schema() {
+ $schema['watchdog'] = array(
+ 'description' => 'Table that contains logs of all system events.',
+ 'fields' => array(
+ 'wid' => array(
+ 'type' => 'serial',
+ 'not null' => TRUE,
+ 'description' => 'Primary Key: Unique watchdog event ID.',
+ ),
+ 'uid' => array(
+ 'type' => 'int',
+ 'not null' => TRUE,
+ 'default' => 0,
+ 'description' => 'The {users}.uid of the user who triggered the event.',
+ ),
+ 'type' => array(
+ 'type' => 'varchar',
+ 'length' => 64,
+ 'not null' => TRUE,
+ 'default' => '',
+ 'description' => 'Type of log message, for example "user" or "page not found."',
+ ),
+ 'message' => array(
+ 'type' => 'text',
+ 'not null' => TRUE,
+ 'size' => 'big',
+ 'description' => 'Text of log message to be passed into the t() function.',
+ ),
+ 'variables' => array(
+ 'type' => 'blob',
+ 'not null' => TRUE,
+ 'size' => 'big',
+ 'description' => 'Serialized array of variables that match the message string and that is passed into the t() function.',
+ ),
+ 'severity' => array(
+ 'type' => 'int',
+ 'unsigned' => TRUE,
+ 'not null' => TRUE,
+ 'default' => 0,
+ 'size' => 'tiny',
+ 'description' => 'The severity level of the event; ranges from 0 (Emergency) to 7 (Debug)',
+ ),
+ 'link' => array(
+ 'type' => 'varchar',
+ 'length' => 255,
+ 'not null' => FALSE,
+ 'default' => '',
+ 'description' => 'Link to view the result of the event.',
+ ),
+ 'location' => array(
+ 'type' => 'text',
+ 'not null' => TRUE,
+ 'description' => 'URL of the origin of the event.',
+ ),
+ 'referer' => array(
+ 'type' => 'text',
+ 'not null' => FALSE,
+ 'description' => 'URL of referring page.',
+ ),
+ 'hostname' => array(
+ 'type' => 'varchar',
+ 'length' => 128,
+ 'not null' => TRUE,
+ 'default' => '',
+ 'description' => 'Hostname of the user who triggered the event.',
+ ),
+ 'timestamp' => array(
+ 'type' => 'int',
+ 'not null' => TRUE,
+ 'default' => 0,
+ 'description' => 'Unix timestamp of when event occurred.',
+ ),
+ ),
+ 'primary key' => array('wid'),
+ 'indexes' => array(
+ 'type' => array('type'),
+ 'uid' => array('uid'),
+ ),
+ );
+
+ return $schema;
+}
+
+/**
+ * Implements hook_uninstall().
+ */
+function dblog_uninstall() {
+ variable_del('dblog_row_limit');
+}
diff --git a/core/modules/dblog/dblog.module b/core/modules/dblog/dblog.module
new file mode 100644
index 00000000000..496a043a76a
--- /dev/null
+++ b/core/modules/dblog/dblog.module
@@ -0,0 +1,184 @@
+<?php
+
+/**
+ * @file
+ * System monitoring and logging for administrators.
+ *
+ * The dblog module monitors your site and keeps a list of
+ * recorded events containing usage and performance data, errors,
+ * warnings, and similar operational information.
+ *
+ * @see watchdog()
+ */
+
+/**
+ * Implements hook_help().
+ */
+function dblog_help($path, $arg) {
+ switch ($path) {
+ case 'admin/help#dblog':
+ $output = '';
+ $output .= '<h3>' . t('About') . '</h3>';
+ $output .= '<p>' . t('The Database logging module logs system events in the Drupal database. For more information, see the online handbook entry for the <a href="@dblog">Database logging module</a>.', array('@dblog' => 'http://drupal.org/handbook/modules/dblog')) . '</p>';
+ $output .= '<h3>' . t('Uses') . '</h3>';
+ $output .= '<dl>';
+ $output .= '<dt>' . t('Monitoring your site') . '</dt>';
+ $output .= '<dd>' . t('The Database logging module allows you to view an event log on the <a href="@dblog">Recent log messages</a> page. The log is a chronological list of recorded events containing usage data, performance data, errors, warnings and operational information. Administrators should check the log on a regular basis to ensure their site is working properly.', array('@dblog' => url('admin/reports/dblog'))) . '</dd>';
+ $output .= '<dt>' . t('Debugging site problems') . '</dt>';
+ $output .= '<dd>' . t('In case of errors or problems with the site, the <a href="@dblog">Recent log messages</a> page can be useful for debugging, since it shows the sequence of events. The log messages include usage information, warnings, and errors.', array('@dblog' => url('admin/reports/dblog'))) . '</dd>';
+ $output .= '</dl>';
+ return $output;
+ case 'admin/reports/dblog':
+ return '<p>' . t('The Database logging module monitors your website, capturing system events in a log (shown here) to be reviewed by an authorized individual at a later time. This log is a list of recorded events containing usage data, performance data, errors, warnings and operational information. It is vital to check the Recent log messages report on a regular basis, as it is often the only way to tell what is going on.') . '</p>';
+ }
+}
+
+/**
+ * Implements hook_menu().
+ */
+function dblog_menu() {
+ $items['admin/reports/dblog'] = array(
+ 'title' => 'Recent log messages',
+ 'description' => 'View events that have recently been logged.',
+ 'page callback' => 'dblog_overview',
+ 'access arguments' => array('access site reports'),
+ 'weight' => -1,
+ 'file' => 'dblog.admin.inc',
+ );
+ $items['admin/reports/page-not-found'] = array(
+ 'title' => "Top 'page not found' errors",
+ 'description' => "View 'page not found' errors (404s).",
+ 'page callback' => 'dblog_top',
+ 'page arguments' => array('page not found'),
+ 'access arguments' => array('access site reports'),
+ 'file' => 'dblog.admin.inc',
+ );
+ $items['admin/reports/access-denied'] = array(
+ 'title' => "Top 'access denied' errors",
+ 'description' => "View 'access denied' errors (403s).",
+ 'page callback' => 'dblog_top',
+ 'page arguments' => array('access denied'),
+ 'access arguments' => array('access site reports'),
+ 'file' => 'dblog.admin.inc',
+ );
+ $items['admin/reports/event/%'] = array(
+ 'title' => 'Details',
+ 'page callback' => 'dblog_event',
+ 'page arguments' => array(3),
+ 'access arguments' => array('access site reports'),
+ 'file' => 'dblog.admin.inc',
+ );
+
+ if (module_exists('search')) {
+ $items['admin/reports/search'] = array(
+ 'title' => 'Top search phrases',
+ 'description' => 'View most popular search phrases.',
+ 'page callback' => 'dblog_top',
+ 'page arguments' => array('search'),
+ 'access arguments' => array('access site reports'),
+ 'file' => 'dblog.admin.inc',
+ );
+ }
+
+ return $items;
+}
+
+/**
+ * Implements hook_init().
+ */
+function dblog_init() {
+ if (arg(0) == 'admin' && arg(1) == 'reports') {
+ // Add the CSS for this module
+ drupal_add_css(drupal_get_path('module', 'dblog') . '/dblog.css');
+ }
+}
+
+/**
+ * Implements hook_cron().
+ *
+ * Remove expired log messages and flood control events.
+ */
+function dblog_cron() {
+ // Cleanup the watchdog table.
+ $row_limit = variable_get('dblog_row_limit', 1000);
+
+ // For row limit n, get the wid of the nth row in descending wid order.
+ // Counting the most recent n rows avoids issues with wid number sequences,
+ // e.g. auto_increment value > 1 or rows deleted directly from the table.
+ if ($row_limit > 0) {
+ $min_row = db_select('watchdog', 'w')
+ ->fields('w', array('wid'))
+ ->orderBy('wid', 'DESC')
+ ->range($row_limit - 1, 1)
+ ->execute()->fetchField();
+
+ // Delete all table entries older than the nth row, if nth row was found.
+ if ($min_row) {
+ db_delete('watchdog')
+ ->condition('wid', $min_row, '<')
+ ->execute();
+ }
+ }
+}
+
+function _dblog_get_message_types() {
+ $types = array();
+
+ $result = db_query('SELECT DISTINCT(type) FROM {watchdog} ORDER BY type');
+ foreach ($result as $object) {
+ $types[] = $object->type;
+ }
+
+ return $types;
+}
+
+/**
+ * Implements hook_watchdog().
+ *
+ * Note some values may be truncated for database column size restrictions.
+ */
+function dblog_watchdog(array $log_entry) {
+ // The user object may not exist in all conditions, so 0 is substituted if needed.
+ $user_uid = isset($log_entry['user']->uid) ? $log_entry['user']->uid : 0;
+
+ Database::getConnection('default', 'default')->insert('watchdog')
+ ->fields(array(
+ 'uid' => $user_uid,
+ 'type' => substr($log_entry['type'], 0, 64),
+ 'message' => $log_entry['message'],
+ 'variables' => serialize($log_entry['variables']),
+ 'severity' => $log_entry['severity'],
+ 'link' => substr($log_entry['link'], 0, 255),
+ 'location' => $log_entry['request_uri'],
+ 'referer' => $log_entry['referer'],
+ 'hostname' => substr($log_entry['ip'], 0, 128),
+ 'timestamp' => $log_entry['timestamp'],
+ ))
+ ->execute();
+}
+
+/**
+ * Implements hook_form_FORM_ID_alter().
+ */
+function dblog_form_system_logging_settings_alter(&$form, $form_state) {
+ $form['dblog_row_limit'] = array(
+ '#type' => 'select',
+ '#title' => t('Database log messages to keep'),
+ '#default_value' => variable_get('dblog_row_limit', 1000),
+ '#options' => array(0 => t('All')) + drupal_map_assoc(array(100, 1000, 10000, 100000, 1000000)),
+ '#description' => t('The maximum number of messages to keep in the database log. Requires a <a href="@cron">cron maintenance task</a>.', array('@cron' => url('admin/reports/status')))
+ );
+ $form['actions']['#weight'] = 1;
+}
+
+/**
+ * Implements hook_theme().
+ */
+function dblog_theme() {
+ return array(
+ 'dblog_message' => array(
+ 'variables' => array('event' => NULL, 'link' => FALSE),
+ 'file' => 'dblog.admin.inc',
+ ),
+ );
+}
diff --git a/core/modules/dblog/dblog.test b/core/modules/dblog/dblog.test
new file mode 100644
index 00000000000..ffd3e8a5653
--- /dev/null
+++ b/core/modules/dblog/dblog.test
@@ -0,0 +1,588 @@
+<?php
+
+/**
+ * @file
+ * Tests for dblog.module.
+ */
+
+class DBLogTestCase extends DrupalWebTestCase {
+ protected $big_user;
+ protected $any_user;
+
+ public static function getInfo() {
+ return array(
+ 'name' => 'DBLog functionality',
+ 'description' => 'Generate events and verify dblog entries; verify user access to log reports based on persmissions.',
+ 'group' => 'DBLog',
+ );
+ }
+
+ /**
+ * Enable modules and create users with specific permissions.
+ */
+ function setUp() {
+ parent::setUp('dblog', 'poll');
+ // Create users.
+ $this->big_user = $this->drupalCreateUser(array('administer site configuration', 'access administration pages', 'access site reports', 'administer users'));
+ $this->any_user = $this->drupalCreateUser(array());
+ }
+
+ /**
+ * Login users, create dblog events, and test dblog functionality through the admin and user interfaces.
+ */
+ function testDBLog() {
+ // Login the admin user.
+ $this->drupalLogin($this->big_user);
+
+ $row_limit = 100;
+ $this->verifyRowLimit($row_limit);
+ $this->verifyCron($row_limit);
+ $this->verifyEvents();
+ $this->verifyReports();
+
+ // Login the regular user.
+ $this->drupalLogin($this->any_user);
+ $this->verifyReports(403);
+ }
+
+ /**
+ * Verify setting of the dblog row limit.
+ *
+ * @param integer $count Log row limit.
+ */
+ private function verifyRowLimit($row_limit) {
+ // Change the dblog row limit.
+ $edit = array();
+ $edit['dblog_row_limit'] = $row_limit;
+ $this->drupalPost('admin/config/development/logging', $edit, t('Save configuration'));
+ $this->assertResponse(200);
+
+ // Check row limit variable.
+ $current_limit = variable_get('dblog_row_limit', 1000);
+ $this->assertTrue($current_limit == $row_limit, t('[Cache] Row limit variable of @count equals row limit of @limit', array('@count' => $current_limit, '@limit' => $row_limit)));
+ // Verify dblog row limit equals specified row limit.
+ $current_limit = unserialize(db_query("SELECT value FROM {variable} WHERE name = :dblog_limit", array(':dblog_limit' => 'dblog_row_limit'))->fetchField());
+ $this->assertTrue($current_limit == $row_limit, t('[Variable table] Row limit variable of @count equals row limit of @limit', array('@count' => $current_limit, '@limit' => $row_limit)));
+ }
+
+ /**
+ * Verify cron applies the dblog row limit.
+ *
+ * @param integer $count Log row limit.
+ */
+ private function verifyCron($row_limit) {
+ // Generate additional log entries.
+ $this->generateLogEntries($row_limit + 10);
+ // Verify dblog row count exceeds row limit.
+ $count = db_query('SELECT COUNT(wid) FROM {watchdog}')->fetchField();
+ $this->assertTrue($count > $row_limit, t('Dblog row count of @count exceeds row limit of @limit', array('@count' => $count, '@limit' => $row_limit)));
+
+ // Run cron job.
+ $this->cronRun();
+ // Verify dblog row count equals row limit plus one because cron adds a record after it runs.
+ $count = db_query('SELECT COUNT(wid) FROM {watchdog}')->fetchField();
+ $this->assertTrue($count == $row_limit + 1, t('Dblog row count of @count equals row limit of @limit plus one', array('@count' => $count, '@limit' => $row_limit)));
+ }
+
+ /**
+ * Generate dblog entries.
+ *
+ * @param integer $count
+ * Number of log entries to generate.
+ * @param $type
+ * The type of watchdog entry.
+ * @param $severity
+ * The severity of the watchdog entry.
+ */
+ private function generateLogEntries($count, $type = 'custom', $severity = WATCHDOG_NOTICE) {
+ global $base_root;
+
+ // Prepare the fields to be logged
+ $log = array(
+ 'type' => $type,
+ 'message' => 'Log entry added to test the dblog row limit.',
+ 'variables' => array(),
+ 'severity' => $severity,
+ 'link' => NULL,
+ 'user' => $this->big_user,
+ 'request_uri' => $base_root . request_uri(),
+ 'referer' => $_SERVER['HTTP_REFERER'],
+ 'ip' => ip_address(),
+ 'timestamp' => REQUEST_TIME,
+ );
+ $message = 'Log entry added to test the dblog row limit. Entry #';
+ for ($i = 0; $i < $count; $i++) {
+ $log['message'] = $message . $i;
+ dblog_watchdog($log);
+ }
+ }
+
+ /**
+ * Verify the logged in user has the desired access to the various dblog nodes.
+ *
+ * @param integer $response HTTP response code.
+ */
+ private function verifyReports($response = 200) {
+ $quote = '&#039;';
+
+ // View dblog help node.
+ $this->drupalGet('admin/help/dblog');
+ $this->assertResponse($response);
+ if ($response == 200) {
+ $this->assertText(t('Database logging'), t('DBLog help was displayed'));
+ }
+
+ // View dblog report node.
+ $this->drupalGet('admin/reports/dblog');
+ $this->assertResponse($response);
+ if ($response == 200) {
+ $this->assertText(t('Recent log messages'), t('DBLog report was displayed'));
+ }
+
+ // View dblog page-not-found report node.
+ $this->drupalGet('admin/reports/page-not-found');
+ $this->assertResponse($response);
+ if ($response == 200) {
+ $this->assertText(t('Top ' . $quote . 'page not found' . $quote . ' errors'), t('DBLog page-not-found report was displayed'));
+ }
+
+ // View dblog access-denied report node.
+ $this->drupalGet('admin/reports/access-denied');
+ $this->assertResponse($response);
+ if ($response == 200) {
+ $this->assertText(t('Top ' . $quote . 'access denied' . $quote . ' errors'), t('DBLog access-denied report was displayed'));
+ }
+
+ // View dblog event node.
+ $this->drupalGet('admin/reports/event/1');
+ $this->assertResponse($response);
+ if ($response == 200) {
+ $this->assertText(t('Details'), t('DBLog event node was displayed'));
+ }
+ }
+
+ /**
+ * Verify events.
+ */
+ private function verifyEvents() {
+ // Invoke events.
+ $this->doUser();
+ $this->doNode('article');
+ $this->doNode('page');
+ $this->doNode('poll');
+
+ // When a user account is canceled, any content they created remains but the
+ // uid = 0. Records in the watchdog table related to that user have the uid
+ // set to zero.
+ }
+
+ /**
+ * Generate and verify user events.
+ *
+ */
+ private function doUser() {
+ // Set user variables.
+ $name = $this->randomName();
+ $pass = user_password();
+ // Add user using form to generate add user event (which is not triggered by drupalCreateUser).
+ $edit = array();
+ $edit['name'] = $name;
+ $edit['mail'] = $name . '@example.com';
+ $edit['pass[pass1]'] = $pass;
+ $edit['pass[pass2]'] = $pass;
+ $edit['status'] = 1;
+ $this->drupalPost('admin/people/create', $edit, t('Create new account'));
+ $this->assertResponse(200);
+ // Retrieve user object.
+ $user = user_load_by_name($name);
+ $this->assertTrue($user != NULL, t('User @name was loaded', array('@name' => $name)));
+ $user->pass_raw = $pass; // Needed by drupalLogin.
+ // Login user.
+ $this->drupalLogin($user);
+ // Logout user.
+ $this->drupalLogout();
+ // Fetch row ids in watchdog that relate to the user.
+ $result = db_query('SELECT wid FROM {watchdog} WHERE uid = :uid', array(':uid' => $user->uid));
+ foreach ($result as $row) {
+ $ids[] = $row->wid;
+ }
+ $count_before = (isset($ids)) ? count($ids) : 0;
+ $this->assertTrue($count_before > 0, t('DBLog contains @count records for @name', array('@count' => $count_before, '@name' => $user->name)));
+
+ // Login the admin user.
+ $this->drupalLogin($this->big_user);
+ // Delete user.
+ // We need to POST here to invoke batch_process() in the internal browser.
+ $this->drupalPost('user/' . $user->uid . '/cancel', array('user_cancel_method' => 'user_cancel_reassign'), t('Cancel account'));
+
+ // View the dblog report.
+ $this->drupalGet('admin/reports/dblog');
+ $this->assertResponse(200);
+
+ // Verify events were recorded.
+ // Add user.
+ // Default display includes name and email address; if too long then email is replaced by three periods.
+ $this->assertLogMessage(t('New user: %name (%email).', array('%name' => $name, '%email' => $user->mail)), t('DBLog event was recorded: [add user]'));
+ // Login user.
+ $this->assertLogMessage(t('Session opened for %name.', array('%name' => $name)), t('DBLog event was recorded: [login user]'));
+ // Logout user.
+ $this->assertLogMessage(t('Session closed for %name.', array('%name' => $name)), t('DBLog event was recorded: [logout user]'));
+ // Delete user.
+ $message = t('Deleted user: %name %email.', array('%name' => $name, '%email' => '<' . $user->mail . '>'));
+ $message_text = truncate_utf8(filter_xss($message, array()), 56, TRUE, TRUE);
+ // Verify full message on details page.
+ $link = FALSE;
+ if ($links = $this->xpath('//a[text()="' . html_entity_decode($message_text) . '"]')) {
+ // Found link with the message text.
+ $links = array_shift($links);
+ foreach ($links->attributes() as $attr => $value) {
+ if ($attr == 'href') {
+ // Extract link to details page.
+ $link = drupal_substr($value, strpos($value, 'admin/reports/event/'));
+ $this->drupalGet($link);
+ // Check for full message text on the details page.
+ $this->assertRaw($message, t('DBLog event details was found: [delete user]'));
+ break;
+ }
+ }
+ }
+ $this->assertTrue($link, t('DBLog event was recorded: [delete user]'));
+ // Visit random URL (to generate page not found event).
+ $not_found_url = $this->randomName(60);
+ $this->drupalGet($not_found_url);
+ $this->assertResponse(404);
+ // View dblog page-not-found report page.
+ $this->drupalGet('admin/reports/page-not-found');
+ $this->assertResponse(200);
+ // Check that full-length url displayed.
+ $this->assertText($not_found_url, t('DBLog event was recorded: [page not found]'));
+ }
+
+ /**
+ * Generate and verify node events.
+ *
+ * @param string $type Content type.
+ */
+ private function doNode($type) {
+ // Create user.
+ $perm = array('create ' . $type . ' content', 'edit own ' . $type . ' content', 'delete own ' . $type . ' content');
+ $user = $this->drupalCreateUser($perm);
+ // Login user.
+ $this->drupalLogin($user);
+
+ // Create node using form to generate add content event (which is not triggered by drupalCreateNode).
+ $edit = $this->getContent($type);
+ $langcode = LANGUAGE_NONE;
+ $title = $edit["title"];
+ $this->drupalPost('node/add/' . $type, $edit, t('Save'));
+ $this->assertResponse(200);
+ // Retrieve node object.
+ $node = $this->drupalGetNodeByTitle($title);
+ $this->assertTrue($node != NULL, t('Node @title was loaded', array('@title' => $title)));
+ // Edit node.
+ $edit = $this->getContentUpdate($type);
+ $this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
+ $this->assertResponse(200);
+ // Delete node.
+ $this->drupalPost('node/' . $node->nid . '/delete', array(), t('Delete'));
+ $this->assertResponse(200);
+ // View node (to generate page not found event).
+ $this->drupalGet('node/' . $node->nid);
+ $this->assertResponse(404);
+ // View the dblog report (to generate access denied event).
+ $this->drupalGet('admin/reports/dblog');
+ $this->assertResponse(403);
+
+ // Login the admin user.
+ $this->drupalLogin($this->big_user);
+ // View the dblog report.
+ $this->drupalGet('admin/reports/dblog');
+ $this->assertResponse(200);
+
+ // Verify events were recorded.
+ // Content added.
+ $this->assertLogMessage(t('@type: added %title.', array('@type' => $type, '%title' => $title)), t('DBLog event was recorded: [content added]'));
+ // Content updated.
+ $this->assertLogMessage(t('@type: updated %title.', array('@type' => $type, '%title' => $title)), t('DBLog event was recorded: [content updated]'));
+ // Content deleted.
+ $this->assertLogMessage(t('@type: deleted %title.', array('@type' => $type, '%title' => $title)), t('DBLog event was recorded: [content deleted]'));
+
+ // View dblog access-denied report node.
+ $this->drupalGet('admin/reports/access-denied');
+ $this->assertResponse(200);
+ // Access denied.
+ $this->assertText(t('admin/reports/dblog'), t('DBLog event was recorded: [access denied]'));
+
+ // View dblog page-not-found report node.
+ $this->drupalGet('admin/reports/page-not-found');
+ $this->assertResponse(200);
+ // Page not found.
+ $this->assertText(t('node/@nid', array('@nid' => $node->nid)), t('DBLog event was recorded: [page not found]'));
+ }
+
+ /**
+ * Create content based on content type.
+ *
+ * @param string $type Content type.
+ * @return array Content.
+ */
+ private function getContent($type) {
+ $langcode = LANGUAGE_NONE;
+ switch ($type) {
+ case 'poll':
+ $content = array(
+ "title" => $this->randomName(8),
+ 'choice[new:0][chtext]' => $this->randomName(32),
+ 'choice[new:1][chtext]' => $this->randomName(32),
+ );
+ break;
+
+ default:
+ $content = array(
+ "title" => $this->randomName(8),
+ "body[$langcode][0][value]" => $this->randomName(32),
+ );
+ break;
+ }
+ return $content;
+ }
+
+ /**
+ * Create content update based on content type.
+ *
+ * @param string $type Content type.
+ * @return array Content.
+ */
+ private function getContentUpdate($type) {
+ switch ($type) {
+ case 'poll':
+ $content = array(
+ 'choice[chid:1][chtext]' => $this->randomName(32),
+ 'choice[chid:2][chtext]' => $this->randomName(32),
+ );
+ break;
+
+ default:
+ $langcode = LANGUAGE_NONE;
+ $content = array(
+ "body[$langcode][0][value]" => $this->randomName(32),
+ );
+ break;
+ }
+ return $content;
+ }
+
+ /**
+ * Login an admin user, create dblog event, and test clearing dblog functionality through the admin interface.
+ */
+ protected function testDBLogAddAndClear() {
+ global $base_root;
+ // Get a count of how many watchdog entries there are.
+ $count = db_query('SELECT COUNT(*) FROM {watchdog}')->fetchField();
+ $log = array(
+ 'type' => 'custom',
+ 'message' => 'Log entry added to test the doClearTest clear down.',
+ 'variables' => array(),
+ 'severity' => WATCHDOG_NOTICE,
+ 'link' => NULL,
+ 'user' => $this->big_user,
+ 'request_uri' => $base_root . request_uri(),
+ 'referer' => $_SERVER['HTTP_REFERER'],
+ 'ip' => ip_address(),
+ 'timestamp' => REQUEST_TIME,
+ );
+ // Add a watchdog entry.
+ dblog_watchdog($log);
+ // Make sure the table count has actually incremented.
+ $this->assertEqual($count + 1, db_query('SELECT COUNT(*) FROM {watchdog}')->fetchField(), t('dblog_watchdog() added an entry to the dblog :count', array(':count' => $count)));
+ // Login the admin user.
+ $this->drupalLogin($this->big_user);
+ // Now post to clear the db table.
+ $this->drupalPost('admin/reports/dblog', array(), t('Clear log messages'));
+ // Count rows in watchdog that previously related to the deleted user.
+ $count = db_query('SELECT COUNT(*) FROM {watchdog}')->fetchField();
+ $this->assertEqual($count, 0, t('DBLog contains :count records after a clear.', array(':count' => $count)));
+ }
+
+ /**
+ * Test the dblog filter on admin/reports/dblog.
+ */
+ protected function testFilter() {
+ $this->drupalLogin($this->big_user);
+
+ // Clear log to ensure that only generated entries are found.
+ db_delete('watchdog')->execute();
+
+ // Generate watchdog entries.
+ $type_names = array();
+ $types = array();
+ for ($i = 0; $i < 3; $i++) {
+ $type_names[] = $type_name = $this->randomName();
+ $severity = WATCHDOG_EMERGENCY;
+ for ($j = 0; $j < 3; $j++) {
+ $types[] = $type = array(
+ 'count' => mt_rand(1, 5),
+ 'type' => $type_name,
+ 'severity' => $severity++,
+ );
+ $this->generateLogEntries($type['count'], $type['type'], $type['severity']);
+ }
+ }
+
+ // View the dblog.
+ $this->drupalGet('admin/reports/dblog');
+
+ // Confirm all the entries are displayed.
+ $count = $this->getTypeCount($types);
+ foreach ($types as $key => $type) {
+ $this->assertEqual($count[$key], $type['count'], 'Count matched');
+ }
+
+ // Filter by each type and confirm that entries with various severities are
+ // displayed.
+ foreach ($type_names as $type_name) {
+ $edit = array(
+ 'type[]' => array($type_name),
+ );
+ $this->drupalPost(NULL, $edit, t('Filter'));
+
+ // Count the number of entries of this type.
+ $type_count = 0;
+ foreach ($types as $type) {
+ if ($type['type'] == $type_name) {
+ $type_count += $type['count'];
+ }
+ }
+
+ $count = $this->getTypeCount($types);
+ $this->assertEqual(array_sum($count), $type_count, 'Count matched');
+ }
+
+ // Set filter to match each of the three type attributes and confirm the
+ // number of entries displayed.
+ foreach ($types as $key => $type) {
+ $edit = array(
+ 'type[]' => array($type['type']),
+ 'severity[]' => array($type['severity']),
+ );
+ $this->drupalPost(NULL, $edit, t('Filter'));
+
+ $count = $this->getTypeCount($types);
+ $this->assertEqual(array_sum($count), $type['count'], 'Count matched');
+ }
+
+ // Clear all logs and make sure the confirmation message is found.
+ $this->drupalPost('admin/reports/dblog', array(), t('Clear log messages'));
+ $this->assertText(t('Database log cleared.'), t('Confirmation message found'));
+ }
+
+ /**
+ * Get the log entry information form the page.
+ *
+ * @return
+ * List of entries and their information.
+ */
+ protected function getLogEntries() {
+ $entries = array();
+ if ($table = $this->xpath('.//table[@id="admin-dblog"]')) {
+ $table = array_shift($table);
+ foreach ($table->tbody->tr as $row) {
+ $entries[] = array(
+ 'severity' => $this->getSeverityConstant($row['class']),
+ 'type' => $this->asText($row->td[1]),
+ 'message' => $this->asText($row->td[3]),
+ 'user' => $this->asText($row->td[4]),
+ );
+ }
+ }
+ return $entries;
+ }
+
+ /**
+ * Get the count of entries per type.
+ *
+ * @param $types
+ * The type information to compare against.
+ * @return
+ * The count of each type keyed by the key of the $types array.
+ */
+ protected function getTypeCount(array $types) {
+ $entries = $this->getLogEntries();
+ $count = array_fill(0, count($types), 0);
+ foreach ($entries as $entry) {
+ foreach ($types as $key => $type) {
+ if ($entry['type'] == $type['type'] && $entry['severity'] == $type['severity']) {
+ $count[$key]++;
+ break;
+ }
+ }
+ }
+ return $count;
+ }
+
+ /**
+ * Get the watchdog severity constant corresponding to the CSS class.
+ *
+ * @param $class
+ * CSS class attribute.
+ * @return
+ * The watchdog severity constant or NULL if not found.
+ */
+ protected function getSeverityConstant($class) {
+ // Reversed array from dblog_overview().
+ $map = array(
+ 'dblog-debug' => WATCHDOG_DEBUG,
+ 'dblog-info' => WATCHDOG_INFO,
+ 'dblog-notice' => WATCHDOG_NOTICE,
+ 'dblog-warning' => WATCHDOG_WARNING,
+ 'dblog-error' => WATCHDOG_ERROR,
+ 'dblog-critical' => WATCHDOG_CRITICAL,
+ 'dblog-alert' => WATCHDOG_ALERT,
+ 'dblog-emerg' => WATCHDOG_EMERGENCY,
+ );
+
+ // Find the class that contains the severity.
+ $classes = explode(' ', $class);
+ foreach ($classes as $class) {
+ if (isset($map[$class])) {
+ return $map[$class];
+ }
+ }
+ return NULL;
+ }
+
+ /**
+ * Extract the text contained by the element.
+ *
+ * @param $element
+ * Element to extract text from.
+ * @return
+ * Extracted text.
+ */
+ protected function asText(SimpleXMLElement $element) {
+ if (!is_object($element)) {
+ return $this->fail('The element is not an element.');
+ }
+ return trim(html_entity_decode(strip_tags($element->asXML())));
+ }
+
+ /**
+ * Assert messages appear on the log overview screen.
+ *
+ * This function should be used only for admin/reports/dblog page, because it
+ * check for the message link text truncated to 56 characters. Other dblog
+ * pages have no detail links so contains a full message text.
+ *
+ * @param $log_message
+ * The message to check.
+ * @param $message
+ * The message to pass to simpletest.
+ */
+ protected function assertLogMessage($log_message, $message) {
+ $message_text = truncate_utf8(filter_xss($log_message, array()), 56, TRUE, TRUE);
+ // After filter_xss() HTML entities should be converted to their characters
+ // because assertLink() uses this string in xpath() to query DOM.
+ $this->assertLink(html_entity_decode($message_text), 0, $message);
+ }
+}
+
generated by cgit v1.2.3 (git 2.39.1) at 2025-04-30 17:43:02 +0000