dblog.module 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  1. <?php
  2. /**
  3. * @file
  4. * System monitoring and logging for administrators.
  5. *
  6. * The Database Logging module monitors your site and keeps a list of recorded
  7. * events containing usage and performance data, errors, warnings, and similar
  8. * operational information.
  9. */
  10. use Drupal\Core\Form\FormStateInterface;
  11. use Drupal\Core\Routing\RouteMatchInterface;
  12. use Drupal\Core\StringTranslation\TranslatableMarkup;
  13. use Drupal\views\ViewEntityInterface;
  14. use Drupal\views\ViewExecutable;
  15. /**
  16. * Implements hook_help().
  17. */
  18. function dblog_help($route_name, RouteMatchInterface $route_match) {
  19. switch ($route_name) {
  20. case 'help.page.dblog':
  21. $output = '';
  22. $output .= '<h3>' . t('About') . '</h3>';
  23. $output .= '<p>' . t('The Database Logging module logs system events in the Drupal database. For more information, see the <a href=":dblog">online documentation for the Database Logging module</a>.', [':dblog' => 'https://www.drupal.org/documentation/modules/dblog']) . '</p>';
  24. $output .= '<h3>' . t('Uses') . '</h3>';
  25. $output .= '<dl>';
  26. $output .= '<dt>' . t('Monitoring your site') . '</dt>';
  27. $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.', [':dblog' => \Drupal::url('dblog.overview')]) . '</dd>';
  28. $output .= '<dt>' . t('Debugging site problems') . '</dt>';
  29. $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.', [':dblog' => \Drupal::url('dblog.overview')]) . '</dd>';
  30. $output .= '</dl>';
  31. return $output;
  32. case 'dblog.overview':
  33. return '<p>' . t('The Database Logging module logs system events in the Drupal database. Monitor your site or debug site problems on this page.') . '</p>';
  34. }
  35. }
  36. /**
  37. * Implements hook_menu_links_discovered_alter().
  38. */
  39. function dblog_menu_links_discovered_alter(&$links) {
  40. if (\Drupal::moduleHandler()->moduleExists('search')) {
  41. $links['dblog.search'] = [
  42. 'title' => new TranslatableMarkup('Top search phrases'),
  43. 'route_name' => 'dblog.search',
  44. 'description' => new TranslatableMarkup('View most popular search phrases.'),
  45. 'parent' => 'system.admin_reports',
  46. ];
  47. }
  48. return $links;
  49. }
  50. /**
  51. * Implements hook_cron().
  52. *
  53. * Controls the size of the log table, paring it to 'dblog_row_limit' messages.
  54. */
  55. function dblog_cron() {
  56. // Cleanup the watchdog table.
  57. $row_limit = \Drupal::config('dblog.settings')->get('row_limit');
  58. // For row limit n, get the wid of the nth row in descending wid order.
  59. // Counting the most recent n rows avoids issues with wid number sequences,
  60. // e.g. auto_increment value > 1 or rows deleted directly from the table.
  61. if ($row_limit > 0) {
  62. $min_row = db_select('watchdog', 'w')
  63. ->fields('w', ['wid'])
  64. ->orderBy('wid', 'DESC')
  65. ->range($row_limit - 1, 1)
  66. ->execute()->fetchField();
  67. // Delete all table entries older than the nth row, if nth row was found.
  68. if ($min_row) {
  69. db_delete('watchdog')
  70. ->condition('wid', $min_row, '<')
  71. ->execute();
  72. }
  73. }
  74. }
  75. /**
  76. * Gathers a list of uniquely defined database log message types.
  77. *
  78. * @return array
  79. * List of uniquely defined database log message types.
  80. */
  81. function _dblog_get_message_types() {
  82. return db_query('SELECT DISTINCT(type) FROM {watchdog} ORDER BY type')
  83. ->fetchAllKeyed(0, 0);
  84. }
  85. /**
  86. * Implements hook_form_FORM_ID_alter() for system_logging_settings().
  87. */
  88. function dblog_form_system_logging_settings_alter(&$form, FormStateInterface $form_state) {
  89. $row_limits = [100, 1000, 10000, 100000, 1000000];
  90. $form['dblog_row_limit'] = [
  91. '#type' => 'select',
  92. '#title' => t('Database log messages to keep'),
  93. '#default_value' => \Drupal::configFactory()->getEditable('dblog.settings')->get('row_limit'),
  94. '#options' => [0 => t('All')] + array_combine($row_limits, $row_limits),
  95. '#description' => t('The maximum number of messages to keep in the database log. Requires a <a href=":cron">cron maintenance task</a>.', [':cron' => \Drupal::url('system.status')]),
  96. ];
  97. $form['#submit'][] = 'dblog_logging_settings_submit';
  98. }
  99. /**
  100. * Form submission handler for system_logging_settings().
  101. *
  102. * @see dblog_form_system_logging_settings_alter()
  103. */
  104. function dblog_logging_settings_submit($form, FormStateInterface $form_state) {
  105. \Drupal::configFactory()->getEditable('dblog.settings')->set('row_limit', $form_state->getValue('dblog_row_limit'))->save();
  106. }
  107. /**
  108. * Implements hook_ENTITY_TYPE_presave() for views entities.
  109. *
  110. * This hook ensures there are no views based that are using a wrong plugin for
  111. * wid and uid fields on views that use watchdog as base table.
  112. *
  113. * @deprecated in Drupal 8.4.x and will be removed before 9.0.0.
  114. *
  115. * @see https://www.drupal.org/node/2876378
  116. */
  117. function dblog_view_presave(ViewEntityInterface $view) {
  118. // Only interested in watchdog based views.
  119. if ($view->get('base_table') != 'watchdog') {
  120. return;
  121. }
  122. $displays = $view->get('display');
  123. $update = FALSE;
  124. foreach ($displays as $display_name => $display) {
  125. // Iterate through all the fields of watchdog views based tables.
  126. if (isset($display['display_options']['fields'])) {
  127. foreach ($display['display_options']['fields'] as $field_name => $field) {
  128. // We are only interested in wid and uid fields from the watchdog table
  129. // that still use the numeric id.
  130. if (isset($field['table']) &&
  131. $field['table'] === 'watchdog' &&
  132. $field['plugin_id'] == 'numeric' &&
  133. in_array($field['field'], ['wid', 'uid'], TRUE)) {
  134. $displays[$display_name]['display_options']['fields'][$field_name]['plugin_id'] = 'standard';
  135. // Delete all the attributes related to numeric fields.
  136. unset(
  137. $displays[$display_name]['display_options']['fields'][$field_name]['set_precision'],
  138. $displays[$display_name]['display_options']['fields'][$field_name]['precision'],
  139. $displays[$display_name]['display_options']['fields'][$field_name]['decimal'],
  140. $displays[$display_name]['display_options']['fields'][$field_name]['separator'],
  141. $displays[$display_name]['display_options']['fields'][$field_name]['format_plural'],
  142. $displays[$display_name]['display_options']['fields'][$field_name]['format_plural_string'],
  143. $displays[$display_name]['display_options']['fields'][$field_name]['prefix'],
  144. $displays[$display_name]['display_options']['fields'][$field_name]['suffix']
  145. );
  146. $update = TRUE;
  147. @trigger_error("The numeric plugin for watchdog.$field_name field is deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Must use standard plugin instead. See https://www.drupal.org/node/2876378.", E_USER_DEPRECATED);
  148. }
  149. }
  150. }
  151. // Iterate all filters looking for type filters to update.
  152. if (isset($display['display_options']['filters'])) {
  153. foreach ($display['display_options']['filters'] as $filter_name => $filter) {
  154. if (isset($filter['table']) &&
  155. $filter['table'] === 'watchdog' &&
  156. $filter['plugin_id'] == 'in_operator' &&
  157. $filter['field'] == 'type') {
  158. $displays[$display_name]['display_options']['filters'][$filter_name]['plugin_id'] = 'dblog_types';
  159. $update = TRUE;
  160. @trigger_error("The in_operator plugin for watchdog.type filter is deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Must use dblog_types plugin instead. See https://www.drupal.org/node/2876378.", E_USER_DEPRECATED);
  161. }
  162. }
  163. }
  164. }
  165. if ($update) {
  166. $view->set('display', $displays);
  167. }
  168. }
  169. /**
  170. * Implements hook_views_pre_render().
  171. */
  172. function dblog_views_pre_render(ViewExecutable $view) {
  173. if (isset($view) && ($view->storage->get('base_table') == 'watchdog')) {
  174. $view->element['#attached']['library'][] = 'dblog/drupal.dblog';
  175. }
  176. }