function _jsonlog_form_system_logging_settings_alter in JSONlog 3.x

Same name and namespace in other branches

1. 8.2 jsonlog.inc \_jsonlog_form_system_logging_settings_alter()
2. 8 jsonlog.inc \_jsonlog_form_system_logging_settings_alter()
3. 7.2 jsonlog.inc \_jsonlog_form_system_logging_settings_alter()

Adds this module's setting fields to the system logging settings form.

Parameters

array &$form:

FormStateInterface &$form_state:

See also

jsonlog_form_system_logging_settings_alter()

1 call to _jsonlog_form_system_logging_settings_alter()

jsonlog_form_system_logging_settings_alter in ./jsonlog.module

Adds this module's setting fields to the system logging settings form. Implements hook_form_FORM_ID_alter().

File

./jsonlog.inc, line 21

JSONlog module helper functions.

Code

function _jsonlog_form_system_logging_settings_alter(&$form, FormStateInterface $form_state) {
  $config = \Drupal::configFactory()
    ->getEditable('jsonlog.settings');
  $form['#attributes']['autocomplete'] = 'off';

  // These translations are used a lot.
  $t_overridden = t('overridden', [], [
    'context' => 'module:jsonlog',
  ]);

  // Using 'emergency' as threshold is simply not an option; because it's falsy
  // (expensive type checks, FALSE), and wouldn't make sense anyway.
  $severity_levels = RfcLogLevel::getLevels();
  unset($severity_levels[0]);
  $form['jsonlog'] = [
    '#type' => 'details',
    '#title' => 'JSON Log',
    '#open' => TRUE,
  ];
  $form['jsonlog']['description'] = [
    '#type' => 'markup',
    '#markup' => '<p>' . t('Any server variable \'drupal_[jsonlog_variable_name]\' will override \'[jsonlog_variable_name]\' drupal conf. variable, except for tags (will be combined).', [], [
      'context' => 'module:jsonlog',
    ]) . '<br/>' . t('Tip: Server environment variables set in virtual host or .htaccess won\'t be visible by drush/CLI; /etc/environment might be your friend instead.', [], [
      'context' => 'module:jsonlog',
    ]) . '</p>',
  ];

  // Severity threshold.
  if ($severity_threshold = getenv('drupal_jsonlog_severity_threshold')) {
    $overridden = TRUE;
  }
  else {
    $severity_threshold = $config
      ->get('jsonlog_severity_threshold');
    $overridden = FALSE;
  }
  $form['jsonlog']['jsonlog_severity_threshold'] = [
    '#type' => 'select',
    '#title' => t('Don\'t log events that are less severe than [jsonlog_severity_threshold] @overridden', [
      '@overridden' => $overridden ? $t_overridden : '',
    ], [
      'context' => 'module:jsonlog',
    ]),
    '#description' => t('Emergency is not an option.', [], [
      'context' => 'module:jsonlog',
    ]),
    '#options' => $severity_levels,
    '#default_value' => $severity_threshold,
  ];
  if ($overridden) {
    $form['jsonlog']['jsonlog_severity_threshold']['#attributes'] = [
      'disabled' => 'disabled',
    ];
  }

  // Truncation.
  if (($truncate = getenv('drupal_jsonlog_truncate')) !== FALSE) {
    $overridden = TRUE;
  }
  else {
    $truncate = $config
      ->get('jsonlog_truncate');
    $overridden = FALSE;
  }
  $form['jsonlog']['jsonlog_truncate'] = [
    '#type' => 'textfield',
    '#title' => t('Truncate events to [jsonlog_truncate] @overridden', [
      '@overridden' => $overridden ? $t_overridden : '',
    ], [
      'context' => 'module:jsonlog',
    ]),
    '#description' => t('Zero means no truncation. Log entries longer than the file system\'s block size (typically 4 Kb) should not result in garbled logs (due to concurrent file writes), because the logger uses write locking. Defaults to @default (Kb).', [
      '@default' => $truncate,
    ], [
      'context' => 'module:jsonlog',
    ]),
    '#default_value' => $truncate,
    '#size' => 5,
    '#field_suffix' => t('Kb', [], [
      'context' => 'module:jsonlog',
    ]),
  ];
  if ($overridden) {
    $form['jsonlog']['jsonlog_truncate']['#attributes'] = [
      'disabled' => 'disabled',
    ];
  }

  // Site ID.
  $siteid_default = jsonlog_default_site_id();
  if ($site_id = getenv('drupal_jsonlog_siteid')) {
    $overridden = TRUE;
  }
  else {
    if (!($site_id = $config
      ->get('jsonlog_siteid'))) {
      $site_id = $siteid_default;
    }
    $overridden = FALSE;
  }
  $form['jsonlog']['jsonlog_siteid'] = [
    '#type' => 'textfield',
    '#title' => t('Site ID [jsonlog_siteid] @overridden', [
      '@overridden' => $overridden ? $t_overridden : '',
    ], [
      'context' => 'module:jsonlog',
    ]),
    '#description' => t('Spaces and quotes get replaced by hyphens. Defaults to the server\'s hostname and the site\'s database name and prefix (if any): @default', [
      '@default' => $siteid_default,
    ], [
      'context' => 'module:jsonlog',
    ]),
    '#required' => TRUE,
    '#default_value' => $site_id,
  ];
  if ($overridden) {
    $form['jsonlog']['jsonlog_siteid']['#attributes'] = [
      'disabled' => 'disabled',
    ];
  }

  // Canonical site identifier across site instances.
  if ($canonical = getenv('drupal_jsonlog_canonical')) {
    $overridden = TRUE;
  }
  else {
    $canonical = $config
      ->get('jsonlog_canonical');
    $overridden = FALSE;
  }
  $form['jsonlog']['jsonlog_canonical'] = [
    '#type' => 'textfield',
    '#title' => t('Canonical site name [jsonlog_canonical] @overridden', [
      '@overridden' => $overridden ? $t_overridden : '',
    ], [
      'context' => 'module:jsonlog',
    ]),
    '#description' => t('For simpler identification across load balanced site instances.', [], [
      'context' => 'module:jsonlog',
    ]),
    '#required' => FALSE,
    '#default_value' => $canonical,
  ];
  if ($overridden) {
    $form['jsonlog']['jsonlog_canonical']['#attributes'] = [
      'disabled' => 'disabled',
    ];
  }

  // STDOUT.
  if ($stdout = getenv('drupal_jsonlog_stdout')) {
    $overridden = TRUE;
  }
  else {
    $stdout = $config
      ->get('jsonlog_stdout') ?? FALSE;
    $overridden = FALSE;
  }
  $form['jsonlog']['jsonlog_stdout'] = [
    '#type' => 'checkbox',
    '#title' => t('Output to stdout [jsonlog_stdout] @overridden', [
      '@overridden' => $overridden ? $t_overridden : '',
    ], [
      'context' => 'module:jsonlog',
    ]),
    '#title_display' => 'before',
    '#description' => t('In containerized environments like Docker it is way more convenient to send your logs to container stdout and let platform do the rest for you.', [], [
      'context' => 'module:jsonlog',
    ]),
    '#required' => FALSE,
    '#default_value' => $stdout,
  ];
  if ($overridden) {
    $form['jsonlog']['jsonlog_stdout']['#attributes'] = [
      'disabled' => 'disabled',
    ];
  }
  $form['jsonlog']['filing'] = [
    '#type' => 'details',
    '#title' => t('Output to file', [], [
      'context' => 'module:jsonlog',
    ]),
    '#open' => !$stdout,
    '#states' => [
      'open' => [
        ':input[name="jsonlog_stdout"]' => [
          'checked' => FALSE,
        ],
      ],
    ],
  ];

  // Timestamped file; default 'Ymd',
  // values: 'Ymd' (~ YYYYMMDD)|'YW' (~ YYYYWW)|'Ym' (~ YYYYMM)|'none'.
  if ($file_time = getenv('drupal_jsonlog_file_time')) {
    $overridden = TRUE;
  }
  else {
    if (!($file_time = $config
      ->get('jsonlog_file_time'))) {
      $file_time = 'Ymd';
    }
    $overridden = FALSE;
  }
  $form['jsonlog']['filing']['jsonlog_file_time'] = [
    '#type' => 'select',
    '#title' => t('Timestamped log file name [jsonlog_file_time] @overridden', [
      '@overridden' => $overridden ? $t_overridden : '',
    ], [
      'context' => 'module:jsonlog',
    ]),
    '#description' => t('Default: Day (\'Ymd\' ~ YYYYMMDD)', [], [
      'context' => 'module:jsonlog',
    ]),
    '#options' => [
      // Deliberaterately not '_none'.
      'none' => t('None - use the same file forever', [], [
        'context' => 'module:jsonlog',
      ]),
      'Ymd' => t('Day (\'Ymd\' ~ YYYYMMDD)', [], [
        'context' => 'module:jsonlog',
      ]),
      'YW' => t('Week (\'YW\' ~ YYYYWW)', [], [
        'context' => 'module:jsonlog',
      ]),
      'Ym' => t('Month (\'Ym\' ~ YYYYMM)', [], [
        'context' => 'module:jsonlog',
      ]),
    ],
    '#default_value' => $file_time,
  ];
  if ($overridden) {
    $form['jsonlog']['filing']['jsonlog_file_time']['#attributes'] = [
      'disabled' => 'disabled',
    ];
  }

  // Dir.
  if (!($dir_default = jsonlog_default_dir()) && !$stdout) {
    \Drupal::messenger()
      ->addMessage(t('Failed to establish the server\'s default logging directory.', [], [
      'context' => 'module:jsonlog',
    ]), 'warning');
  }
  if ($dir = getenv('drupal_jsonlog_dir')) {
    $overridden = TRUE;
  }
  else {
    if (!($dir = $config
      ->get('jsonlog_dir'))) {
      $dir = $dir_default;
    }
    $overridden = FALSE;
  }
  $form['jsonlog']['filing']['jsonlog_dir'] = [
    '#type' => 'textfield',
    '#title' => t('Log directory [jsonlog_dir] @overridden', [
      '@overridden' => $overridden ? $t_overridden : '',
    ], [
      'context' => 'module:jsonlog',
    ]),
    '#description' => t('Defaults to PHP ini \'error_log\' path + /drupal-jsonlog: @default! NB: The web server user (www-data|apache) probably isn\'t allowed to write to a file in the \'error_log\' path - create a sub dir (like \'drupal-jsonlog\') as root user, and do a chown or chmod on that sub dir to make it writable (and executable) by the web server user.', [
      '@default' => $dir_default,
    ], [
      'context' => 'module:jsonlog',
    ]),
    '#required' => FALSE,
    '#default_value' => $dir,
    '#size' => 80,
    '#field_suffix' => '/' . $site_id . ($file_time == 'none' ? '' : '.' . date($file_time)) . '.json.log',
  ];
  if ($overridden) {
    $form['jsonlog']['filing']['jsonlog_dir']['#attributes'] = [
      'disabled' => 'disabled',
    ];
  }

  // Newline prepend.
  if (($newline_prepend = getenv('drupal_jsonlog_newline_prepend')) !== FALSE) {
    $newline_prepend = (bool) $newline_prepend;
    $overridden = TRUE;
  }
  else {
    $newline_prepend = $config
      ->get('jsonlog_newline_prepend') ?? JsonLog::JSONLOG_NEWLINE_PREPEND;
    $overridden = FALSE;
  }
  $form['jsonlog']['filing']['jsonlog_newline_prepend'] = [
    '#type' => 'checkbox',
    '#title_display' => 'before',
    '#title' => t('Prepend newline when filing log entry [jsonlog_newline_prepend] @overridden', [
      '@overridden' => $overridden ? $t_overridden : '',
    ], [
      'context' => 'module:jsonlog',
    ]),
    '#description' => t('Not recommended for new installation. For historical reasons JsonLog supports prepending instead of appending newline to an entry when filing. Default: @default.', [
      '@default' => !JsonLog::JSONLOG_NEWLINE_PREPEND ? 'false' : 'true',
    ], [
      'context' => 'module:jsonlog',
    ]),
    '#required' => FALSE,
    '#default_value' => (int) $newline_prepend,
    '#attributes' => [
      'autocomplete' => 'off',
    ],
  ];
  if ($overridden) {
    $form['jsonlog']['filing']['jsonlog_newline_prepend']['#attributes'] = [
      'disabled' => 'disabled',
    ];
  }

  // Tags.
  $tags_server = ($tags = getenv('drupal_jsonlog_tags')) !== FALSE ? $tags : '';
  $form['jsonlog']['jsonlog_tags'] = [
    '#type' => 'textfield',
    '#title' => t('Tags [jsonlog_tags]', [], [
      'context' => 'module:jsonlog',
    ]),
    '#description' => t('Comma-separated list of tags. Tags set by server environment variable will be combined with tags set here.', [], [
      'context' => 'module:jsonlog',
    ]),
    '#default_value' => $tags_site = $config
      ->get('jsonlog_tags'),
    '#size' => 100,
    '#field_prefix' => $tags_server !== '' ? $tags_server . ', ' : '',
  ];
  $form['jsonlog']['examples'] = [
    '#type' => 'details',
    '#title' => t('JSONlog entry example', [], [
      'context' => 'module:jsonlog',
    ]),
    '#open' => FALSE,
  ];

  // Create a dummy entry as an example.
  $entry = new JsonLogData($site_id, $canonical);
  $entry
    ->setTags($tags_server, $tags_site);
  $entry
    ->setMessage('Dummy message', $truncate);
  $entry
    ->setSeverity($severity_threshold);
  $entry
    ->setSubType('200 - TEST entry');
  $entry
    ->setMethod('POST');
  $entry
    ->setRequest_uri($GLOBALS['base_root'] . Drupal::request()
    ->getRequestUri());
  $entry
    ->setReferer('');
  $entry
    ->setUid(Drupal::currentUser()
    ->id());
  $entry
    ->setClient_ip(Drupal::request()
    ->getClientIp());
  $entry
    ->setLink('');
  $example_data = jsonlog_example_entry($entry);
  $form['jsonlog']['examples']['example_entry'] = [
    '#type' => 'table',
    '#id' => 'jsonlog-examples',
    '#sticky' => TRUE,
    '#attributes' => [
      'class' => [
        'jsonlog-entry-example',
      ],
    ],
    '#header' => $example_data['#header'],
    '#rows' => $example_data['#rows'],
  ];

  // Data used during submit if we need to write a test-entry to log.
  $entry_flat = $entry
    ->getData();
  if (is_array($entry_flat['tags'])) {

    // Array bucket is incompatible with rendering engine.
    $entry_flat['tags'] = join(',', $entry_flat['tags']);
  }
  $form['jsonlog']['examples']['example_entry_data'] = [
    '#type' => 'hidden',
    '#value' => $entry_flat,
  ];
  unset($entry_flat);
  $form['jsonlog']['test_entry'] = [
    '#type' => 'checkbox',
    '#title' => t('Log test entry', [], [
      'context' => 'module:jsonlog',
    ]),
    '#title_display' => 'before',
    '#description' => t('Saves and then performs a test to make sure your settings are applied.', [], [
      'context' => 'module:jsonlog',
    ]),
  ];
  $form['#validate'][] = 'jsonlog_form_system_logging_settings_validate';

  // Prepend our submit handler; we need to get in first, otherwise our changes
  // to form values amounts to nothing.
  array_unshift($form['#submit'], 'jsonlog_form_system_logging_settings_submit');
}