',',
'excel' => FALSE,
];
}
/**
* {@inheritdoc}
*/
public function setConfiguration(array $configuration) {
parent::setConfiguration($configuration);
$this->configuration['delimiter'] = ($this->configuration['delimiter'] === '\t') ? "\t" : $this->configuration['delimiter'];
return $this;
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form = parent::buildConfigurationForm($form, $form_state);
$t_args = [
'%type' => $this->label(),
':injection_href' => 'https://www.google.com/search?q=spreadsheet+formula+injection',
':excel_href' => 'https://www.drupal.org/project/webform_xlsx_export',
];
// Alter the warning if the safer format is already available.
if (\Drupal::moduleHandler()->moduleExists('webform_xlsx_export')) {
$warning = $this->t('Warning: Opening %type files with spreadsheet applications may expose you to formula injection or other security vulnerabilities. When the submissions contain data from untrusted users and the downloaded file will be used with Microsoft Excel, use the XLSX export format.', $t_args);
}
else {
$warning = $this->t('Warning: Opening %type files with spreadsheet applications may expose you to formula injection or other security vulnerabilities. When the submissions contain data from untrusted users and the downloaded file will be used with Microsoft Excel, use the Webform XLSX export module.', $t_args);
}
$form['warning'] = [
'#type' => 'webform_message',
'#message_type' => 'warning',
'#message_message' => $warning,
];
$form['delimiter'] = [
'#type' => 'select',
'#title' => $this->t('Delimiter text format'),
'#description' => $this->t('This is the delimiter used in the CSV/TSV file when downloading webform results. Using tabs in the export is the most reliable method for preserving non-latin characters. You may want to change this to another character depending on the program with which you anticipate importing results.'),
'#required' => TRUE,
'#options' => [
',' => $this->t('Comma (,)'),
'\t' => $this->t('Tab (\t)'),
';' => $this->t('Semicolon (;)'),
':' => $this->t('Colon (:)'),
'|' => $this->t('Pipe (|)'),
'.' => $this->t('Period (.)'),
' ' => $this->t('Space ( )'),
],
'#default_value' => ($this->configuration['delimiter'] === "\t") ? '\t' : $this->configuration['delimiter'],
];
$form['excel'] = [
'#type' => 'checkbox',
'#title' => $this->t('Generate Excel compatible file'),
'#description' => $this->t("If checked, the generated file's carriage returns will be compatible with Excel and a marker flagging the data as UTF-8 will be added at the beginning."),
'#return_value' => TRUE,
'#default_value' => $this->configuration['excel'],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function getFileExtension() {
switch ($this->configuration['delimiter']) {
case "\t":
return 'tsv';
default:
return 'csv';
}
}
/**
* {@inheritdoc}
*/
public function writeHeader() {
if ($this->configuration['excel']) {
fwrite($this->fileHandle, "\xEF\xBB\xBF");
}
$header = $this->buildHeader();
fputcsv($this->fileHandle, $header, $this->configuration['delimiter'], escape: '\\');
}
/**
* {@inheritdoc}
*/
public function writeSubmission(WebformSubmissionInterface $webform_submission) {
$record = $this->buildRecord($webform_submission);
fputcsv($this->fileHandle, $record, $this->configuration['delimiter'], escape: '\\');
}
/**
* {@inheritdoc}
*/
protected function buildRecord(WebformSubmissionInterface $webform_submission) {
$record = parent::buildRecord($webform_submission);
if ($this->configuration['excel']) {
foreach ($record as $index => $value) {
if (is_string($value)) {
$record[$index] = str_replace(PHP_EOL, "\r\n", $value);
}
}
}
return $record;
}
}