GD-18 adding watchog logging settings

stankut · stankut · commit c739d2c148b6 · 2021-06-01T14:16:38.000+03:00
diff --git a/README.md b/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
 
diff --git a/config/install/views.view.os2web_logging_access_logs.yml b/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: ''
diff --git a/os2web_logging.install b/os2web_logging.install
@@ -1,5 +1,20 @@
 <?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.
  */
@@ -17,3 +32,11 @@ function os2web_logging_update_8801() {
 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');
+}
diff --git a/src/Controller/LoggingController.php b/src/Controller/LoggingController.php
@@ -209,26 +209,26 @@ public static function getCheckedRequirements() {
    *
    * @param string $filename
    *   The filename.
+   *
+   * @return \Symfony\Component\HttpFoundation\BinaryFileResponse
+   *   File ready to be downloaded.
    */
   public function logfileExport($filename) {
     $config = $this->config(SettingsForm::$configName);
 
-    // Do some file validation here, like checking for extension.
-
     // File lives in /files/downloads.
     $logPath = $config->get('files_log_path');
 
-    $uri = $logPath . '/'. $filename;
+    $uri = $logPath . '/' . $filename;
 
     $headers = [
-      'Content-Type' => 'text/csv', // Would want a condition to check for extension and set Content-Type dynamically
+      'Content-Type' => 'text/plain',
       'Content-Description' => 'File Download',
-      'Content-Disposition' => 'attachment; filename=' . $filename
+      'Content-Disposition' => 'attachment; filename=' . $filename,
     ];
 
     // Return and trigger file donwload.
-    return new BinaryFileResponse($uri, 200, $headers, true );
-
+    return new BinaryFileResponse($uri, 200, $headers, TRUE);
   }
 
 }
diff --git a/src/Form/SettingsForm.php b/src/Form/SettingsForm.php
@@ -134,6 +134,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
       '#title' => $this->t('Store log files directory'),
       '#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'] = [
@@ -144,9 +145,9 @@ public function buildForm(array $form, FormStateInterface $form_state) {
 
     $options = [];
     if ($config->get('files_log_path')) {
-      /** @var FileSystemInterface $fileSystem */
+      /** @var Drupal\Core\File\FileSystemInterface $fileSystem */
       $fileSystem = \Drupal::service('file_system');
-      $storedLogFiles = $fileSystem->scanDirectory($config->get('files_log_path'), '/os2web_logging_node_access-\d{4}-\d{2}-\d{2}\.(log|gz)/');
+      $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) {
         $url = Url::fromRoute('os2web_logging.logfile.download', ['filename' => $file->filename]);
diff --git a/src/Form/WatchdogSettingsForm.php b/src/Form/WatchdogSettingsForm.php
@@ -86,6 +86,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
       '#title' => $this->t('Store log files directory'),
       '#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') ?? '../logs',
+      '#field_suffix' => '<em>/os2web_logging_watchdog-YYYY-MM-DD.log</em>',
     ];
 
     $options = [];
@@ -110,7 +111,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     $watchlog_logs_rendered = \Drupal::service('renderer')->renderPlain($watchdog_logs_build);
 
     $form['watchdog_files_details'][] = [
-      '#markup' => $watchlog_logs_rendered
+      '#markup' => $watchlog_logs_rendered,
     ];
 
     return parent::buildForm($form, $form_state);
