Merge branch 'master' into drupal9

Author: andriyun

README.md

@@ -24,6 +24,12 @@ Settings are available under `/admin/config/system/os2logging/settings`
 * **Store database logs for this period** - Database logs will be stored for the selected number of days, after that they will be automatically deleted (cleanup is done daily).
 * **Store log files for this period** - Log file will be stored for the selected number of days, after that they will be automatically deleted
 * **Store log files directory** - Logs will be saved in this path.
+* **Import logs from uploaded file** - Allows import logs into database.
+
+Settings are available under `/admin/config/system/os2logging/watchdog-settings`
+* **DB Log enabled** - If watchdog messages shall be added to the dblog.
+* **Store log files for this period**  - Log file will be stored for the selected number of days, after that they will be automatically deleted
+* **Store log files directory** - Logs will be saved in this path.
 
 ## Install
 

config/install/views.view.os2web_logging_access_logs.yml

@@ -4,7 +4,6 @@ dependencies:
   config:
     - system.menu.admin
   module:
-    - better_exposed_filters
     - node
     - os2web_logging
     - user
@@ -38,7 +37,7 @@ display:
           query_comment: ''
           query_tags: {  }
       exposed_form:
-        type: bef
+        type: basic
         options:
           submit_button: Udfør
           reset_button: false
@@ -47,47 +46,6 @@ display:
           expose_sort_order: true
           sort_asc_label: Asc
           sort_desc_label: Desc
-          text_input_required: 'Vælg et filter og klik på Anvend for at se resultater'
-          text_input_required_format: wysiwyg_tekst
-          bef:
-            general:
-              autosubmit: false
-              autosubmit_exclude_textfield: false
-              autosubmit_textfield_delay: 500
-              autosubmit_hide: false
-              input_required: false
-              allow_secondary: false
-              secondary_label: 'Avancerede indstillinger'
-              secondary_open: false
-            filter:
-              combine:
-                plugin_id: default
-                advanced:
-                  placeholder_text: ''
-                  collapsible: false
-                  is_secondary: false
-              name:
-                plugin_id: default
-                advanced:
-                  placeholder_text: ''
-                  collapsible: false
-                  is_secondary: false
-              ip:
-                plugin_id: default
-                advanced:
-                  placeholder_text: ''
-                  collapsible: false
-                  is_secondary: false
-              created:
-                plugin_id: default
-                advanced:
-                  collapsible: false
-                  is_secondary: false
-              created_1:
-                plugin_id: default
-                advanced:
-                  collapsible: false
-                  is_secondary: false
       pager:
         type: full
         options:
@@ -720,7 +678,7 @@ display:
           exposed: true
           expose:
             operator_id: created_op
-            label: From
+            label: Period
             description: ''
             use_operator: false
             operator: created_op
@@ -734,21 +692,26 @@ display:
               authenticated: authenticated
               anonymous: '0'
               administrator: '0'
+              editor: '0'
+              webmaster: '0'
             placeholder: ''
             min_placeholder: ''
             max_placeholder: ''
           is_grouped: false
           group_info:
-            label: ''
-            description: ''
-            identifier: ''
+            label: Created
+            description: null
+            identifier: created
             optional: true
             widget: select
             multiple: false
             remember: false
             default_group: All
             default_group_multiple: {  }
-            group_items: {  }
+            group_items:
+              1: {  }
+              2: {  }
+              3: {  }
           entity_type: os2web_logging_access_log
           entity_field: created
           plugin_id: date
@@ -769,7 +732,7 @@ display:
           exposed: true
           expose:
             operator_id: created_1_op
-            label: To
+            label: ''
             description: ''
             use_operator: false
             operator: created_1_op
@@ -783,6 +746,8 @@ display:
               authenticated: authenticated
               anonymous: '0'
               administrator: '0'
+              editor: '0'
+              webmaster: '0'
             placeholder: ''
             min_placeholder: ''
             max_placeholder: ''

os2web_logging.info.yml

@@ -7,4 +7,3 @@ core_version_requirement: ^8 || ^9
 configure: os2web_logging.settings
 dependencies:
   - monolog
-  - date_popup

os2web_logging.install

@@ -0,0 +1,42 @@
+<?php
+
+use Symfony\Component\Yaml\Yaml;
+
+/**
+ * Helper function to update configuration.
+ *
+ * @param $config_name
+ *   String.
+ */
+function os2web_logging_read_in_new_config($config_name) {
+  $path = drupal_get_path('module', 'os2web_logging');
+  /** @var \Drupal\Core\Config\StorageInterface $active_storage */
+  $active_storage = \Drupal::service('config.storage');
+  $active_storage->write($config_name, Yaml::parse(file_get_contents($path . '/config/install/' . $config_name . '.yml')));
+}
+
+/**
+ * Increase requiest_uri field length.
+ */
+function os2web_logging_update_8801() {
+  $field_spec = [
+    'type' => 'varchar',
+    'length' => '500',
+  ];
+  \Drupal::database()->schema()->changeField('os2web_logging_access_log','request_uri', 'request_uri', $field_spec);
+}
+
+/**
+ * Disable date_popup module.
+ */
+function os2web_logging_update_8802() {
+  \Drupal::service('module_installer')->uninstall(['date_popup']);
+}
+
+/**
+ * Updating logs search view.
+ */
+function os2web_logging_update_8803() {
+  // Updating view.
+  os2web_logging_read_in_new_config('views.view.os2web_logging_access_logs');
+}

os2web_logging.links.task.yml

@@ -2,6 +2,10 @@ os2web_logging.settings:
   title: Settings
   route_name: os2web_logging.settings
   base_route: os2web_logging.settings
+os2web_logging.watchdog_settings:
+  title: Watchdog
+  route_name: os2web_logging.watchdog_settings
+  base_route: os2web_logging.settings
 os2web_logging.status:
   title: Status
   route_name: os2web_logging.status

os2web_logging.module

@@ -214,15 +214,3 @@ function _os2web_logging_send_status_failed_email(array $errors) {
     \Drupal::logger('os2web_logging')->warning(t('There was a problem sending email to %email', ['%email' => $siteMail]));
   }
 }
-
-/**
- * Increase requiest_uri field lenght().
- */
-function os2web_logging_update_8801() {
-  $field_spec = [
-    'type' => 'varchar',
-    'length' => '500',
-  ];
-  \Drupal::database()->schema()->changeField('os2web_logging_access_log','request_uri', 'request_uri', $field_spec);
- ;
-}

os2web_logging.routing.yml

@@ -16,3 +16,18 @@ os2web_logging.settings:
     _permission: 'administer os2logging settings'
   options:
     _admin_route: TRUE
+os2web_logging.watchdog_settings:
+  path: '/admin/config/system/os2logging/watchdog-settings'
+  defaults:
+    _form: '\Drupal\os2web_logging\Form\WatchdogSettingsForm'
+    _title: 'OS2Web watchdog logging settings'
+  requirements:
+    _permission: 'administer os2logging settings'
+  options:
+    _admin_route: TRUE
+os2web_logging.logfile.download:
+  path: '/os2web_logging/log/{filename}'
+  defaults:
+    _controller: '\Drupal\os2web_logging\Controller\LoggingController::logfileExport'
+  requirements:
+    _permission: 'administer os2logging settings'

os2web_logging.services.yml

@@ -1,7 +1,7 @@
 parameters:
   monolog.channel_handlers:
     # If not specified use the default handlers.
-    default: ['os2web_logging_watchdog']
+    default: ['os2web_logging_watchdog', 'drupal.dblog']
     # Log php channel to web server's error log.
     php: ['error_log']
     os2web_logging.access_log:

src/Controller/LoggingController.php

@@ -5,6 +5,7 @@
 use Drupal\Core\Controller\ControllerBase;
 use Drupal\Core\File\FileSystemInterface;
 use Drupal\os2web_logging\Form\SettingsForm;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
 
 /**
  * Provides status page.
@@ -203,4 +204,31 @@ public static function getCheckedRequirements() {
     return $requirements;
   }
 
+  /**
+   * Download file.
+   *
+   * @param string $filename
+   *   The filename.
+   *
+   * @return \Symfony\Component\HttpFoundation\BinaryFileResponse
+   *   File ready to be downloaded.
+   */
+  public function logfileExport($filename) {
+    $config = $this->config(SettingsForm::$configName);
+
+    // File lives in /files/downloads.
+    $logPath = $config->get('files_log_path');
+
+    $uri = $logPath . '/' . $filename;
+
+    $headers = [
+      'Content-Type' => 'text/plain',
+      'Content-Description' => 'File Download',
+      'Content-Disposition' => 'attachment; filename=' . $filename,
+    ];
+
+    // Return and trigger file donwload.
+    return new BinaryFileResponse($uri, 200, $headers, TRUE);
+  }
+
 }

src/Form/SettingsForm.php

@@ -132,8 +132,9 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     $form['file_logs_detail']['files_log_path'] = [
       '#type' => 'textfield',
       '#title' => $this->t('Store log files directory'),
-      '#description' => $this->t('Logs will be saved in this path'),
+      '#description' => $this->t('Log file will be stored for the selected number of days, after that they will be automatically deleted'),
       '#default_value' => $config->get('files_log_path') ? $config->get('files_log_path') : '../logs',
+      '#field_suffix' => '<em>/os2web_logging_access_log-YYYY-MM-DD.log</em>',
     ];
 
     $form['logs_import_file_detail'] = [
@@ -142,19 +143,23 @@ public function buildForm(array $form, FormStateInterface $form_state) {
         ->t('Logs import'),
     ];
 
-    $nodeTypeOptions = [];
+    $options = [];
     if ($config->get('files_log_path')) {
-      $storedLogFiles = \Drupal::service('file_system')->scanDirectory($config->get('files_log_path'), '/os2web_logging_access_log-\d{4}-\d{2}-\d{2}\.(log|gz)/');
+      /** @var Drupal\Core\File\FileSystemInterface $fileSystem */
+      $fileSystem = \Drupal::service('file_system');
+      $storedLogFiles = $fileSystem->scanDirectory($config->get('files_log_path'), '/os2web_logging_(node_access|access_log)-\d{4}-\d{2}-\d{2}\.(log|gz)/');
 
       foreach ($storedLogFiles as $file) {
-        $nodeTypeOptions[$file->uri] = $file->filename;
+        $url = Url::fromRoute('os2web_logging.logfile.download', ['filename' => $file->filename]);
+        $link = Link::fromTextAndUrl(t('[Download]'), $url);
+        $options[$file->uri] = $file->filename . ' ' . $link->toString();
       }
-      arsort($nodeTypeOptions);
+      arsort($options);
     }
 
     $form['logs_import_file_detail']['logs_import_files_select'] = [
       '#type' => 'checkboxes',
-      '#options' => $nodeTypeOptions,
+      '#options' => $options,
       '#title' => $this->t('Import from existing files'),
       '#description' => $this->t('Archived log files will be automatically extracted'),
     ];