Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use available_channel_type table data to create channelForm #143

Merged
merged 9 commits into from
Dec 19, 2023
Merged

Use available_channel_type table data to create channelForm #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6dabb0a
Use plugin table data to create channelForm
sukhwinder33445 Oct 12, 2023
08a52dd
HasAddress: Remove rocketchat support
sukhwinder33445 Oct 25, 2023
df2978d
Channel: Fetch channel name instead of type
sukhwinder33445 Oct 25, 2023
ce23a3e
ContactForm: Add address elements based on existing plugins
sukhwinder33445 Oct 25, 2023
70b7f8b
ContactListItem: Change mail icon to `at`
sukhwinder33445 Dec 4, 2023
e985e7d
ChannelForm: Fix code style
sukhwinder33445 Nov 28, 2023
26601ae
Fix phpstan issues and update baseline files
sukhwinder33445 Nov 30, 2023
35decad
ChannelForm: Use configOptions:default as placeholder/value
sukhwinder33445 Dec 12, 2023
d2da6e4
ChannelForm: Use translator's default locale as default
sukhwinder33445 Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions application/controllers/ContactsController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,8 @@ public function init()

public function indexAction()
{
$contacts = Contact::on($this->db);

$contacts->withColumns(
[
'has_email',
'has_rc'
]
);
$contacts = Contact::on($this->db)
->withColumns('has_email');

$limitControl = $this->createLimitControl();
$paginationControl = $this->createPaginationControl($contacts);
Expand Down
310 changes: 179 additions & 131 deletions application/forms/ChannelForm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,18 @@
namespace Icinga\Module\Notifications\Forms;

use Icinga\Module\Notifications\Model\Channel;
use Icinga\Module\Notifications\Model\AvailableChannelType;
use Icinga\Web\Session;
use ipl\Html\Contract\FormSubmitElement;
use ipl\Html\FormElement\BaseFormElement;
use ipl\Html\FormElement\FieldsetElement;
use ipl\I18n\GettextTranslator;
use ipl\I18n\StaticTranslator;
use ipl\Sql\Connection;
use ipl\Validator\EmailAddressValidator;
use ipl\Web\Common\CsrfCounterMeasure;
use ipl\Web\Compat\CompatForm;
use stdClass;

class ChannelForm extends CompatForm
{
Expand Down Expand Up @@ -41,115 +48,41 @@ protected function assemble()
]
);

$type = [
'' => sprintf(' - %s - ', $this->translate('Please choose')),
'email' => $this->translate('Email'),
'rocketchat' => 'Rocket.Chat'
];
$query = AvailableChannelType::on($this->db)->columns(['type', 'name', 'config_attrs']);

/** @var string[] $typesConfig */
$typesConfig = [];

/** @var string[] $typeNamePair */
$typeNamePair = [];

$defaultType = null;
/** @var Channel $channel */
foreach ($query as $channel) {
if ($defaultType === null) {
$defaultType = $channel->type;
}

$typesConfig[$channel->type] = $channel->config_attrs;
$typeNamePair[$channel->type] = $channel->name;
}

$this->addElement(
'select',
'type',
[
'label' => $this->translate('Type'),
'class' => 'autosubmit',
'required' => true,
'disable' => [''],
'options' => $type
'label' => $this->translate('Type'),
'class' => 'autosubmit',
'required' => true,
'disabledOptions' => [''],
'value' => $defaultType,
'options' => $typeNamePair
]
);

/** @var string $selectedType */
$selectedType = $this->getValue('type');

if ($selectedType === 'email') {
$this->addElement(
'text',
'host',
[
'label' => $this->translate('SMTP Host'),
'autocomplete' => 'off',
'placeholder' => 'localhost'
]
)->addElement(
'select',
'port',
[
'label' => $this->translate('SMTP Port'),
'options' => [
25 => 25,
465 => 465,
587 => 587,
2525 => 2525
]
]
)->addElement(
'text',
'from',
[
'label' => $this->translate('From'),
'autocomplete' => 'off',
'placeholder' => 'notifications@icinga'
]
)->addElement(
'password',
'password',
[
'label' => $this->translate('Password'),
'autocomplete' => 'off',
]
);

$this->addElement(
'checkbox',
'tls',
[
'label' => 'TLS / SSL',
'class' => 'autosubmit',
'checkedValue' => '1',
'uncheckedValue' => '0',
'value' => '1'
]
);

if ($this->getElement('tls')->getValue() === '1') {
$this->addElement(
'checkbox',
'tls_certcheck',
[
'label' => $this->translate('Certificate Check'),
'class' => 'autosubmit',
'checkedValue' => '1',
'uncheckedValue' => '0',
'value' => '0'
]
);
}
} elseif ($selectedType === 'rocketchat') {
$this->addElement(
'text',
'url',
[
'label' => $this->translate('Rocket.Chat URL'),
'required' => true
]
)->addElement(
'text',
'user_id',
[
'autocomplete' => 'off',
'label' => $this->translate('User ID'),
'required' => true
]
)->addElement(
'password',
'token',
[
'autocomplete' => 'off',
'label' => $this->translate('Personal Access Token'),
'required' => true
]
);
}
$this->createConfigElements($selectedType, $typesConfig[$selectedType]);

$this->addElement(
'submit',
Expand Down Expand Up @@ -207,13 +140,11 @@ public function hasBeenSubmitted()
public function populate($values)
{
if ($values instanceof Channel) {
$values = array_merge(
[
'name' => $values->name,
'type' => $values->type
],
json_decode($values->config, JSON_OBJECT_AS_ARRAY) ?? []
);
$values = [
'name' => $values->name,
'type' => $values->type,
'config' => json_decode($values->config, true) ?? []
];
}

parent::populate($values);
Expand All @@ -229,35 +160,152 @@ protected function onSuccess()
return;
}

$channel = [
'name' => $this->getValue('name'),
'type' => $this->getValue('type')
];

if ($this->getValue('type') === 'email') {
$channel['config'] = [
'host' => $this->getValue('host'),
'port' => $this->getValue('port'),
'from' => $this->getValue('from'),
'password' => $this->getValue('password')
];
if ($this->getElement('tls')->isChecked()) {
$channel['config']['tls'] = true;
$channel['config']['tls_certcheck'] = $this->getValue('tls_certcheck');
}
} else {
$channel['config'] = [
'url' => $this->getValue('url'),
'user_id' => $this->getValue('user_id'),
'token' => $this->getValue('token')
];
}

$channel = $this->getValues();
$channel['config'] = json_encode($channel['config']);
if ($this->channelId === null) {
$this->db->insert('channel', $channel);
} else {
$this->db->update('channel', $channel, ['id = ?' => $this->channelId]);
}
}

/**
* Create config elements for the given channel type
*
* @param string $type The channel type
* @param string $config The channel type config
*/
protected function createConfigElements(string $type, string $config): void
{
/** @var array<int, stdClass> $elementsConfig */
$elementsConfig = json_decode($config, false);

if (empty($elementsConfig)) {
return;
}

$configFieldset = new FieldsetElement('config');
$this->addElement($configFieldset);

foreach ($elementsConfig as $elementConfig) {
/** @var BaseFormElement $elem */
$elem = $this->createElement(
$this->getElementType($elementConfig),
$elementConfig->name,
$this->getElementOptions($elementConfig)
);

if ($type === "email" && $elem->getName() === "sender_mail") {
$elem->getValidators()->add(new EmailAddressValidator());
}

$configFieldset->addElement($elem);
}
}

/**
* Get the element type from given element config
*
* @param stdClass $elementConfig The config object of an element
*
* @return string
*/
protected function getElementType(stdClass $elementConfig): string
{
switch ($elementConfig->type) {
case 'string':
$elementType = 'text';
break;
case 'number':
$elementType = 'number';
break;
case 'text':
$elementType = 'textarea';
break;
case 'bool':
$elementType = 'checkbox';
break;
case 'option':
case 'options':
$elementType = 'select';
break;
case 'secret':
$elementType = 'password';
break;
default:
$elementType = 'text';
}

return $elementType;
}

/**
* Get the element options from the given element config
*
* @param stdClass $elementConfig
*
* @return string[]
*/
protected function getElementOptions(stdClass $elementConfig): array
{
$options = [
'label' => $this->fromCurrentLocale($elementConfig->label)
];

if (isset($elementConfig->help)) {
$options['description'] = $this->fromCurrentLocale($elementConfig->help);
}

if (isset($elementConfig->required)) {
$options['required'] = $elementConfig->required;
}

$isSelectElement = isset($elementConfig->options)
&& ($elementConfig->type === 'option' || $elementConfig->type === 'options');
if ($isSelectElement) {
$options['options'] = (array) $elementConfig->options;
if ($elementConfig->type === 'options') {
$options['multiple'] = true;
}
}

if (isset($elementConfig->default)) {
if ($isSelectElement || $elementConfig->type === 'bool') {
$options['value'] = $elementConfig->default;
} else {
$options['placeholder'] = $elementConfig->default;
}
}

if ($elementConfig->type === "number") {
if (isset($elementConfig->min)) {
$options['min'] = $elementConfig->min;
}

if (isset($elementConfig->max)) {
$options['max'] = $elementConfig->max;
}
}

return $options;
}

/**
* Get the current locale based string from given locale map
*
* Fallback to locale `en_US` if the current locale isn't provided
*
* @param stdClass $localeMap
*
* @return ?string Only returns null if the fallback locale is also not specified
*/
protected function fromCurrentLocale(stdClass $localeMap): ?string
{
/** @var GettextTranslator $translator */
$translator = StaticTranslator::$instance;
$default = $translator->getDefaultLocale();
$locale = $translator->getLocale();

return $localeMap->$locale ?? $localeMap->$default ?? null;
}
}
2 changes: 1 addition & 1 deletion application/forms/EscalationRecipientForm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ protected function assembleElements(): void
$this->registerElement($col);

$options = ['' => sprintf(' - %s - ', $this->translate('Please choose'))];
$options += Channel::fetchChannelTypes(Database::get());
$options += Channel::fetchChannelNames(Database::get());

$val = $this->createElement(
'select',
Expand Down
Loading