You are here

Home » API reference » Content Synchronization 8 » ContentLogController.php

class ContentLogController in Content Synchronization 8

Same name and namespace in other branches
  1. 8.2 src/Controller/ContentLogController.php \Drupal\content_sync\Controller\ContentLogController
  2. 3.0.x src/Controller/ContentLogController.php \Drupal\content_sync\Controller\ContentLogController

Returns responses for content_sync routes.

Hierarchy

Expanded class hierarchy of ContentLogController

File

src/Controller/ContentLogController.php, line 21

Namespace

Drupal\content_sync\Controller
View source 
class ContentLogController extends ControllerBase {

  /**
   * The database service.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * The form builder service.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * The user storage.
   *
   * @var \Drupal\user\UserStorageInterface
   */
  protected $userStorage;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('database'), $container
      ->get('module_handler'), $container
      ->get('date.formatter'), $container
      ->get('form_builder'));
  }

  /**
   * Constructs a LogController object.
   *
   * @param \Drupal\Core\Database\Connection $database
   *   A database connection.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   A module handler.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder service.
   */
  public function __construct(Connection $database, ModuleHandlerInterface $module_handler, DateFormatterInterface $date_formatter, FormBuilderInterface $form_builder) {
    $this->database = $database;
    $this->moduleHandler = $module_handler;
    $this->dateFormatter = $date_formatter;
    $this->formBuilder = $form_builder;
    $this->userStorage = $this
      ->entityManager()
      ->getStorage('user');
  }

  /**
   * Gets an array of log level classes.
   *
   * @return array
   *   An array of log level classes.
   */
  public static function getLogLevelClassMap() {
    return [
      RfcLogLevel::DEBUG => 'cslog-debug',
      RfcLogLevel::INFO => 'cslog-info',
      RfcLogLevel::NOTICE => 'cslog-notice',
      RfcLogLevel::WARNING => 'cslog-warning',
      RfcLogLevel::ERROR => 'cslog-error',
      RfcLogLevel::CRITICAL => 'cslog-critical',
      RfcLogLevel::ALERT => 'cslog-alert',
      RfcLogLevel::EMERGENCY => 'cslog-emergency',
    ];
  }

  /**
   * Displays a listing of database log messages.
   *
   * Messages are truncated at 56 chars.
   * Full-length messages can be viewed on the message details page.
   *
   * @return array
   *   A render array as expected by drupal_render().
   *
   * @see Drupal\content_sync\Form\logClearLogConfirmForm
   * @see Drupal\content_sync\Controller\LogController::eventDetails()
   */
  public function overview() {
    $filter = $this
      ->buildFilterQuery();
    $rows = [];
    $classes = static::getLogLevelClassMap();
    $this->moduleHandler
      ->loadInclude('module_sync', 'admin.inc');

    //$build['admin_filter_form'] = $this->formBuilder->getForm('Drupal\content_sync\Form\ContentLogFilterForm');
    $header = [
      // Icon column.
      '',
      /*  [
          'data' => $this->t('Type'),
          'field' => 'w.type',
          'class' => [RESPONSIVE_PRIORITY_MEDIUM]], */
      [
        'data' => $this
          ->t('Date'),
        'field' => 'w.csid',
        'sort' => 'desc',
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
      $this
        ->t('Message'),
      [
        'data' => $this
          ->t('User'),
        'field' => 'ufd.name',
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ],
      [
        'data' => $this
          ->t('Operations'),
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
    ];
    $query = $this->database
      ->select('cs_logs', 'w')
      ->extend('\\Drupal\\Core\\Database\\Query\\PagerSelectExtender')
      ->extend('\\Drupal\\Core\\Database\\Query\\TableSortExtender');
    $query
      ->fields('w', [
      'csid',
      'uid',
      'severity',
      'type',
      'timestamp',
      'message',
      'variables',
      'link',
    ]);
    $query
      ->leftJoin('users_field_data', 'ufd', 'w.uid = ufd.uid');
    if (!empty($filter['where'])) {
      $query
        ->where($filter['where'], $filter['args']);
    }
    $result = $query
      ->limit(50)
      ->orderByHeader($header)
      ->execute();
    foreach ($result as $log) {
      $message = $this
        ->formatMessage($log);
      if ($message && isset($log->csid)) {
        $title = Unicode::truncate(Html::decodeEntities(strip_tags($message)), 256, TRUE, TRUE);
        $log_text = Unicode::truncate($title, 56, TRUE, TRUE);

        // The link generator will escape any unsafe HTML entities in the final
        // text.

        /*$message = $this->l($log_text, new Url('log.event', ['event_id' => $log->csid], [
            'attributes' => [
              // Provide a title for the link for useful hover hints. The
              // Attribute object will escape any unsafe HTML entities in the
              // final text.
              'title' => $title,
            ],
          ]));*/
      }
      $username = [
        '#theme' => 'username',
        '#account' => $this->userStorage
          ->load($log->uid),
      ];
      $rows[] = [
        'data' => [
          // Cells.
          [
            'class' => [
              'icon',
            ],
          ],
          // $this->t($log->type),
          $this->dateFormatter
            ->format($log->timestamp, 'short'),
          $message,
          [
            'data' => $username,
          ],
          [
            'data' => [
              '#markup' => $log->link,
            ],
          ],
        ],
        // Attributes for table row.
        'class' => [
          Html::getClass('cslog-' . $log->type),
          $classes[$log->severity],
        ],
      ];
    }
    $build['log_table'] = [
      '#type' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#attributes' => [
        'id' => 'admin-cslog',
        'class' => [
          'admin-cslog',
        ],
      ],
      '#empty' => $this
        ->t('No log messages available.'),
      '#attached' => [
        'library' => [
          'cslog/drupal.cslog',
        ],
      ],
    ];
    $build['log_pager'] = [
      '#type' => 'pager',
    ];
    return $build;
  }

  /**
   * Displays details about a specific database log message.
   *
   * @param int $event_id
   *   Unique ID of the database log message.
   *
   * @return array
   *   If the ID is located in the Database Logging table, a build array in the
   *   format expected by drupal_render();
   */
  public function eventDetails($event_id) {
    $build = [];
    if ($cslog = $this->database
      ->query('SELECT w.*, u.uid FROM {cs_logs} w LEFT JOIN {users} u ON u.uid = w.uid WHERE w.csid = :id', [
      ':id' => $event_id,
    ])
      ->fetchObject()) {
      $severity = RfcLogLevel::getLevels();
      $message = $this
        ->formatMessage($cslog);
      $username = [
        '#theme' => 'username',
        '#account' => $cslog->uid ? $this->userStorage
          ->load($cslog->uid) : User::getAnonymousUser(),
      ];
      $rows = [
        [
          [
            'data' => $this
              ->t('Type'),
            'header' => TRUE,
          ],
          $this
            ->t($cslog->type),
        ],
        [
          [
            'data' => $this
              ->t('Date'),
            'header' => TRUE,
          ],
          $this->dateFormatter
            ->format($cslog->timestamp, 'long'),
        ],
        [
          [
            'data' => $this
              ->t('User'),
            'header' => TRUE,
          ],
          [
            'data' => $username,
          ],
        ],
        [
          [
            'data' => $this
              ->t('Location'),
            'header' => TRUE,
          ],
          $this
            ->l($cslog->location, $cslog->location ? Url::fromUri($cslog->location) : Url::fromRoute('<none>')),
        ],
        [
          [
            'data' => $this
              ->t('Referrer'),
            'header' => TRUE,
          ],
          $this
            ->l($cslog->referer, $cslog->referer ? Url::fromUri($cslog->referer) : Url::fromRoute('<none>')),
        ],
        [
          [
            'data' => $this
              ->t('Message'),
            'header' => TRUE,
          ],
          $message,
        ],
        [
          [
            'data' => $this
              ->t('Severity'),
            'header' => TRUE,
          ],
          $severity[$cslog->severity],
        ],
        [
          [
            'data' => $this
              ->t('Hostname'),
            'header' => TRUE,
          ],
          $cslog->hostname,
        ],
        [
          [
            'data' => $this
              ->t('Operations'),
            'header' => TRUE,
          ],
          [
            'data' => [
              '#markup' => $cslog->link,
            ],
          ],
        ],
      ];
      $build['cslog_table'] = [
        '#type' => 'table',
        '#rows' => $rows,
        '#attributes' => [
          'class' => [
            'cslog-event',
          ],
        ],
        '#attached' => [
          'library' => [
            'cslog/drupal.cslog',
          ],
        ],
      ];
    }
    return $build;
  }

  /**
   * Builds a query for database log administration filters based on session.
   *
   * @return array
   *   An associative array with keys 'where' and 'args'.
   */
  protected function buildFilterQuery() {
    if (empty($_SESSION['cslog_overview_filter'])) {
      return;
    }
    $this->moduleHandler
      ->loadInclude('content_sync', 'admin.inc');
    $filters = cs_log_filters();

    // Build query.
    $where = $args = [];
    foreach ($_SESSION['cslog_overview_filter'] as $key => $filter) {
      $filter_where = [];
      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 [
      'where' => $where,
      'args' => $args,
    ];
  }

  /**
   * Formats a database log message.
   *
   * @param object $row
   *   The record from the cs_logs table. The object properties are: csid, uid,
   *   severity, type, timestamp, message, variables, link, name.
   *
   * @return string|\Drupal\Core\StringTranslation\TranslatableMarkup|false
   *   The formatted log message or FALSE if the message or variables properties
   *   are not set.
   */
  public function formatMessage($row) {

    // Check for required properties.
    if (isset($row->message, $row->variables)) {
      $variables = @unserialize($row->variables);

      // Messages without variables or user specified text.
      if ($variables === NULL) {
        $message = Xss::filterAdmin($row->message);
      }
      elseif (!is_array($variables)) {
        $message = $this
          ->t('Log data is corrupted and cannot be unserialized: @message', [
          '@message' => Xss::filterAdmin($row->message),
        ]);
      }
      else {
        $message = $this
          ->t(Xss::filterAdmin($row->message), $variables);
      }
    }
    else {
      $message = FALSE;
    }
    return $message;
  }

  /**
   * Shows the most frequent log messages of a given event type.
   *
   * Messages are not truncated on this page because events detailed herein do
   * not have links to a detailed view.
   *
   * @param string $type
   *   Type of database log events to display (e.g., 'search').
   *
   * @return array
   *   A build array in the format expected by drupal_render().
   */
  public function topLogMessages($type) {
    $header = [
      [
        'data' => $this
          ->t('Count'),
        'field' => 'count',
        'sort' => 'desc',
      ],
      [
        'data' => $this
          ->t('Message'),
        'field' => 'message',
      ],
    ];
    $count_query = $this->database
      ->select('cs_logs');
    $count_query
      ->addExpression('COUNT(DISTINCT(message))');
    $count_query
      ->condition('type', $type);
    $query = $this->database
      ->select('cs_logs', 'w')
      ->extend('\\Drupal\\Core\\Database\\Query\\PagerSelectExtender')
      ->extend('\\Drupal\\Core\\Database\\Query\\TableSortExtender');
    $query
      ->addExpression('COUNT(csid)', 'count');
    $query = $query
      ->fields('w', [
      'message',
      'variables',
    ])
      ->condition('w.type', $type)
      ->groupBy('message')
      ->groupBy('variables')
      ->limit(30)
      ->orderByHeader($header);
    $query
      ->setCountQuery($count_query);
    $result = $query
      ->execute();
    $rows = [];
    foreach ($result as $cs_log) {
      if ($message = $this
        ->formatMessage($cs_log)) {
        $rows[] = [
          $cs_log->count,
          $message,
        ];
      }
    }
    $build['cs_log_top_table'] = [
      '#type' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No log messages available.'),
      '#attached' => [
        'library' => [
          'cs_log/drupal.cslog',
        ],
      ],
    ];
    $build['cs_log_top_pager'] = [
      '#type' => 'pager',
    ];
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContentLogController::$database protected property The database service.
ContentLogController::$dateFormatter protected property The date formatter service.
ContentLogController::$formBuilder protected property The form builder service. Overrides ControllerBase::$formBuilder
ContentLogController::$moduleHandler protected property The module handler service. Overrides ControllerBase::$moduleHandler
ContentLogController::$userStorage protected property The user storage.
ContentLogController::buildFilterQuery protected function Builds a query for database log administration filters based on session.
ContentLogController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ContentLogController::eventDetails public function Displays details about a specific database log message.
ContentLogController::formatMessage public function Formats a database log message.
ContentLogController::getLogLevelClassMap public static function Gets an array of log level classes.
ContentLogController::overview public function Displays a listing of database log messages.
ContentLogController::topLogMessages public function Shows the most frequent log messages of a given event type.
ContentLogController::__construct public function Constructs a LogController object.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.