io.imunity.furms.ui.views.site.settings.SettingsView Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of furms-web-ui Show documentation
There is a newer version: 4.3.1
/*
 * Copyright (c) 2020 Bixbit s.c. All rights reserved.
 *  See LICENSE file for licensing information.
 */

package io.imunity.furms.ui.views.site.settings;

import com.vaadin.flow.component.Component;
import com.vaadin.flow.component.UI;
import com.vaadin.flow.component.button.Button;
import com.vaadin.flow.component.checkbox.Checkbox;
import com.vaadin.flow.component.combobox.ComboBox;
import com.vaadin.flow.component.dependency.CssImport;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;
import com.vaadin.flow.server.StreamResource;
import io.imunity.furms.api.policy_documents.PolicyDocumentService;
import io.imunity.furms.api.sites.SiteService;
import io.imunity.furms.api.validation.exceptions.DuplicatedNameValidationError;
import io.imunity.furms.domain.constant.SSHKeysConst;
import io.imunity.furms.domain.images.FurmsImage;
import io.imunity.furms.domain.policy_documents.PolicyId;
import io.imunity.furms.domain.sites.Site;
import io.imunity.furms.domain.sites.SiteId;
import io.imunity.furms.ui.components.FormButtons;
import io.imunity.furms.ui.components.FurmsFormLayout;
import io.imunity.furms.ui.components.FurmsImageUpload;
import io.imunity.furms.ui.components.FurmsViewComponent;
import io.imunity.furms.ui.components.IdFormItem;
import io.imunity.furms.ui.components.PageTitle;
import io.imunity.furms.ui.user_context.FurmsViewUserContext;
import io.imunity.furms.ui.views.site.PolicyDto;
import io.imunity.furms.ui.views.site.SiteAdminMenu;
import io.imunity.furms.ui.views.site.policy_documents.PolicyDocumentsView;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.vaadin.pekka.WysiwygE;

import java.io.IOException;
import java.lang.invoke.MethodHandles;
import java.util.Arrays;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Collectors;

import static com.vaadin.flow.component.button.ButtonVariant.LUMO_PRIMARY;
import static com.vaadin.flow.component.button.ButtonVariant.LUMO_TERTIARY;
import static com.vaadin.flow.data.value.ValueChangeMode.EAGER;
import static io.imunity.furms.ui.components.layout.FurmsAppLayoutUtils.callReloadLogo;
import static io.imunity.furms.ui.utils.FormSettings.NAME_MAX_LENGTH;
import static io.imunity.furms.ui.utils.NotificationUtils.showErrorNotification;
import static io.imunity.furms.ui.utils.NotificationUtils.showSuccessNotification;

@Route(value = "site/admin/settings", layout = SiteAdminMenu.class)
@PageTitle(key = "view.site-admin.settings.page.title")
@CssImport("./styles/views/site/settings/site-settings.css")
public class SettingsView extends FurmsViewComponent {

	private final static Logger LOG = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

	private final static String NAME_FIELD_ID = "name";

	private final SiteService siteService;

	private final Map policyDocuments;

	private final TextField name;

	private final ComboBox policies;

	private final Div externalId;

	private SiteSettingsDto bufferedSettings;

	SettingsView(SiteService siteService, PolicyDocumentService policyDocumentService) {
		this.siteService = siteService;
		SiteSettingsDto siteSettingsDto = loadSite();
		this.policyDocuments = policyDocumentService.findAllBySiteId(siteSettingsDto.getId())
			.stream()
			.map(policyDocument -> new PolicyDto(policyDocument.id, policyDocument.name))
			.collect(Collectors.toMap(x -> x.id, Function.identity()));

		this.name = new TextField();
		this.externalId = new Div();
		policies = new ComboBox<>();

		addForm(siteSettingsDto);
	}

	private void addForm(SiteSettingsDto dto) {
		FormLayout formLayout = new FurmsFormLayout();

		Binder binder = new Binder<>(SiteSettingsDto.class);
		binder.setBean(dto);

		formLayout.add(furmsIdRow(binder.getBean().getId(), getTranslation("view.site-admin.settings.form.furms-id")));
		formLayout.addFormItem(externalIdRow(binder), getTranslation("view.site-admin.settings.form.external-id"));
		formLayout.addFormItem(nameRow(binder), getTranslation("view.site-admin.settings.form.name"));
		formLayout.addFormItem(oauthClientIdRow(binder), getTranslation("view.site-admin.settings.form.oauth-client"));
		formLayout.addFormItem(connectionInfoRow(binder), getTranslation("view.site-admin.settings.form.info"));
		formLayout.addFormItem(sshKeyFromMandatory(binder), "");
		formLayout.addFormItem(prohibitOldSSHKey(binder), "");
		formLayout.addFormItem(uploadRow(binder), getTranslation("view.site-admin.settings.form.logo"));
		formLayout.addFormItem(policyRow(binder), getTranslation("view.site-admin.settings.form.policy"));
		formLayout.add(buttonsRow(binder));

		getContent().add(formLayout);
	}

	private Component furmsIdRow(SiteId id, String textLabel) {
		return new IdFormItem(id.id.toString(), textLabel);
	}

	private Component externalIdRow(Binder binder) {
		externalId.setText(binder.getBean().getExternalId().id);
		return externalId;
	}

	private TextField nameRow(Binder binder) {
		name.setPlaceholder(getTranslation("view.site-admin.settings.form.name.placeholder"));
		name.setRequiredIndicatorVisible(true);
		name.setValueChangeMode(EAGER);
		name.setMaxLength(NAME_MAX_LENGTH);
		name.setId(NAME_FIELD_ID);

		binder.forField(name)
				.withValidator(getNotEmptyStringValidator(),
						getTranslation("view.site-admin.settings.form.name.validation.required"))
				.bind(SiteSettingsDto::getName, SiteSettingsDto::setName);

		return name;
	}

	private TextField oauthClientIdRow(Binder binder) {
		final TextField oauthClientId = new TextField();
		oauthClientId.setPlaceholder(getTranslation("view.site-admin.settings.form.oauth-client.placeholder"));
		oauthClientId.setValueChangeMode(EAGER);
		oauthClientId.setMaxLength(100);

		binder.forField(oauthClientId)
				.bind(SiteSettingsDto::getOauthClientId, SiteSettingsDto::setOauthClientId);

		return oauthClientId;
	}

	private ComboBox policyRow(Binder binder) {
		policies.setItemLabelGenerator(policy -> policy.name);
		policies.setItems(policyDocuments.values());

		binder.forField(policies)
			.bind(site -> policyDocuments.get(site.getPolicyId()),
				(site, policy) -> site.setPolicyId(Optional.ofNullable(policy)
					.map(p -> p.id)
					.orElse(PolicyId.empty()))
			);
		return policies;
	}

	private FurmsImageUpload uploadRow(Binder binder) {
		FurmsImageUpload upload = new FurmsImageUpload();

		upload.addFinishedListener(event -> {
			try {
				binder.getBean().setLogo(upload.loadFile(event.getMIMEType()));
				StreamResource streamResource = new StreamResource(event.getFileName(), upload.getMemoryBuffer()::getInputStream);
				upload.getImage().setSrc(streamResource);
				upload.getImage().setVisible(true);
			} catch (IOException e) {
				showErrorNotification(getTranslation("view.site-admin.settings.form.logo.error"));
				LOG.debug("Could not load Image", e);
			}
		});

		upload.addFileRejectedListener(event -> showErrorNotification(event.getErrorMessage()));

		upload.addFileRemovedListener(event -> {
			binder.getBean().setLogo(FurmsImage.empty());
			upload.getImage().setVisible(false);
		});

		binder.forField(upload)
				.bind(SiteSettingsDto::getLogo, SiteSettingsDto::setLogo);

		return upload;
	}

	private Component connectionInfoRow(Binder binder) {
		WysiwygE textArea = new WysiwygE();
		textArea.setValueChangeMode(EAGER);
		textArea.setPlaceholder(getTranslation("view.site-admin.settings.form.info.placeholder"));
		binder.forField(textArea)
				.bind(SiteSettingsDto::getConnectionInfo, SiteSettingsDto::setConnectionInfo);

		return textArea;
	}
	
	private Checkbox sshKeyFromMandatory(Binder binder) {
		Checkbox sshKeyFromMandatoryCheckbox = new Checkbox(getTranslation("view.site-admin.settings.form.sshKeyFromOptionMandatory"));
		binder.forField(sshKeyFromMandatoryCheckbox).bind(SiteSettingsDto::isSshKeyFromOptionMandatory, SiteSettingsDto::setSshKeyFromOptionMandatory);
		return sshKeyFromMandatoryCheckbox;
	}

	private Checkbox prohibitOldSSHKey(Binder binder) {
		Checkbox prohibitOldSSHkeys = new Checkbox(
				getTranslation("view.site-admin.settings.form.prohibitOldSSHkeys"));
		binder.forField(prohibitOldSSHkeys)
				.bind(SiteSettingsDto::isProhibitOldsshKeys, SiteSettingsDto::setProhibitOldsshKeys);
		return prohibitOldSSHkeys;
	}
	
	private Component buttonsRow(Binder binder) {
		
		Button cancel = new Button(getTranslation("view.site-admin.settings.form.button.cancel"));
		cancel.addThemeVariants(LUMO_TERTIARY);
		Button save = new Button(getTranslation("view.site-admin.settings.form.button.save"));
		save.addThemeVariants(LUMO_PRIMARY);
		FormButtons formButtons = new FormButtons(cancel, save);
		formButtons.setVisible(false);
		
		cancel.addClickListener(event -> {
			refreshBinder(binder);
			formButtons.setVisible(false);
		});
		save.addClickListener(event -> doSaveAction(binder, formButtons));

		binder.addValueChangeListener(value -> {
			if (isChanged(binder.getBean())) {
				formButtons.setVisible(true);
				formButtons.setEnabled(binder.isValid());
			}
			else {
				formButtons.setVisible(false);
			}
		});

		return formButtons;
	}

	private void doSaveAction(Binder binder, FormButtons formButtons) {
		binder.validate();
		if (binder.isValid()) {
			try {
				SiteSettingsDto settings = binder.getBean();
				siteService.update(Site.builder()
						.id(settings.getId())
						.name(settings.getName())
						.oauthClientId(settings.getOauthClientId())
						.connectionInfo(settings.getConnectionInfo())
						.logo(settings.getLogo())
						.sshKeyFromOptionMandatory(settings.isSshKeyFromOptionMandatory())
						.sshKeyHistoryLength(settings.isProhibitOldsshKeys()? SSHKeysConst.MAX_HISTORY_SIZE : 0)
						.policyId(settings.getPolicyId())
						.build());
				if (isLogoChange(bufferedSettings, settings)) {
					callReloadLogo(this.getClass());
				}
				refreshBinder(binder);
				showSuccessNotification(getTranslation("view.sites.form.save.success"));
				formButtons.setVisible(false);
			} catch (DuplicatedNameValidationError e) {
				name.setErrorMessage(getTranslation("view.site-admin.settings.form.name.validation.unique"));
				name.setInvalid(true);
			} catch (RuntimeException e) {
				LOG.warn("Error during update Site settings.", e);
				showErrorNotification(getTranslation("view.site-admin.settings.form.error.unexpected"));
			}
		}
	}

	private SiteSettingsDto loadSite() {
		try {
			FurmsViewUserContext context = FurmsViewUserContext.getCurrent();
			bufferedSettings = siteService.findById(new SiteId(context.id))
					.map(SiteSettingsDto::new)
					.orElseThrow(IllegalArgumentException::new);
			return bufferedSettings.clone();
		} catch (IllegalArgumentException e) {
			UI.getCurrent().navigate(PolicyDocumentsView.class);
			showErrorNotification(getTranslation("view.site-admin.settings.page.error.not-found"));
			return null;
		}
	}

	private boolean isChanged(SiteSettingsDto bean) {
		return !Objects.equals(bufferedSettings.getName(), bean.getName())
				|| !Objects.equals(bufferedSettings.getLogo(), bean.getLogo())
				|| !Objects.equals(bufferedSettings.getOauthClientId(), bean.getOauthClientId())
				|| !Objects.equals(bufferedSettings.getConnectionInfo(), bean.getConnectionInfo())
				|| !Objects.equals(bufferedSettings.isSshKeyFromOptionMandatory(), bean.isSshKeyFromOptionMandatory())
				|| !Objects.equals(bufferedSettings.isProhibitOldsshKeys(), bean.isProhibitOldsshKeys())
				|| !Objects.equals(bufferedSettings.getPolicyId(), bean.getPolicyId());
	}

	private void refreshBinder(Binder binder) {
		binder.setBean(loadSite());
	}

	private boolean isLogoChange(SiteSettingsDto oldSettings, SiteSettingsDto settings) {
		return !Arrays.equals(oldSettings.getLogo().getImage(), settings.getLogo().getImage());
	}
}