GuiFragmentAction.java example

Explorer
entando-core-master
/*
 * Copyright 2015-Present Entando Inc. (http://www.entando.com) All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */
package org.entando.entando.apsadmin.portal.guifragment;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.commons.lang.StringUtils;
import org.entando.entando.aps.system.services.guifragment.GuiFragment;
import org.entando.entando.aps.system.services.guifragment.IGuiFragmentManager;
import org.entando.entando.aps.system.services.widgettype.IWidgetTypeManager;
import org.entando.entando.aps.system.services.widgettype.WidgetType;
import org.entando.entando.apsadmin.portal.guifragment.helper.IGuiFragmentActionHelper;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.agiletec.apsadmin.system.ApsAdminSystemConstants;
import com.agiletec.apsadmin.system.BaseAction;

/**
 * @author E.Santoboni
 */
public class GuiFragmentAction extends BaseAction {

	private static final Logger _logger =  LoggerFactory.getLogger(GuiFragmentAction.class);
	
	@Override
	public void validate() {
		super.validate();
		try {
			boolean isGuiEmpty = StringUtils.isEmpty(this.getGui());
			if (this.getStrutsAction() == ApsAdminSystemConstants.EDIT) {
				GuiFragment guiFragment = this.getGuiFragmentManager().getGuiFragment(this.getCode());
				if (null != guiFragment) {
					if (isGuiEmpty && StringUtils.isBlank(guiFragment.getDefaultGui())) {
						this.addFieldError("gui", this.getText("requiredstring", new String[]{"gui"}));
					}
				} else {
					_logger.error("Null widget type - code '{}'", this.getWidgetTypeCode());
					throw new RuntimeException("Null widget type - code " + this.getWidgetTypeCode());
				}
			} else {
				if (null != this.getGuiFragmentManager().getGuiFragment(this.getCode())) {
					String[] args = {this.getCode()};
					this.addFieldError("code", this.getText("error.guiFragment.duplicateCode", args));
				}
				if (isGuiEmpty) {
					this.addFieldError("gui", this.getText("requiredstring", new String[]{"gui"}));
				}
			}
		} catch (Throwable t) {
			_logger.error("error in validate", t);
			throw new RuntimeException(t);
		}
	}
	
	public String newGuiFragment() {
		try {
			this.setStrutsAction(ApsAdminSystemConstants.ADD);
		} catch (Throwable t) {
			_logger.error("error in newGuiFragment", t);
			return FAILURE;
		}
		return SUCCESS;
	}

	public String edit() {
		try {
			GuiFragment guiFragment = this.getGuiFragmentManager().getGuiFragment(this.getCode());
			if (null == guiFragment) {
				this.addActionError(this.getText("error.guiFragment.null"));
				return INPUT;
			}
			this.populateForm(guiFragment);
			this.setStrutsAction(ApsAdminSystemConstants.EDIT);
		} catch (Throwable t) {
			_logger.error("error in edit", t);
			return FAILURE;
		}
		return SUCCESS;
	}

	public String save() {
		try {
			int strutsAction = this.getStrutsAction();
			GuiFragment guiFragment = this.createGuiFragment();
			if (ApsAdminSystemConstants.ADD == strutsAction) {
				this.getGuiFragmentManager().addGuiFragment(guiFragment);
			} else if (ApsAdminSystemConstants.EDIT == strutsAction) {
				this.getGuiFragmentManager().updateGuiFragment(guiFragment);
			}
		} catch (Throwable t) {
			_logger.error("error in save", t);
			return FAILURE;
		}
		return SUCCESS;
	}

	public String trash() {
		try {
			GuiFragment guiFragment = this.getGuiFragmentManager().getGuiFragment(this.getCode());
			if (null == guiFragment) {
				this.addActionError(this.getText("error.guiFragment.null"));
				return INPUT;
			}
			String check = this.checkDelete(this.getCode());
			if (StringUtils.isNotBlank(check)) return check;
			
			this.populateForm(guiFragment);
			this.setStrutsAction(ApsAdminSystemConstants.DELETE);
		} catch (Throwable t) {
			_logger.error("error in trash", t);
			return FAILURE;
		}
		return SUCCESS;
	}

	public String delete() {
		try {
			String check = this.checkDelete(this.getCode());
			if (StringUtils.isNotBlank(check)) return check;
			if (this.getStrutsAction() == ApsAdminSystemConstants.DELETE) {
				this.getGuiFragmentManager().deleteGuiFragment(this.getCode());
			}
		} catch (Throwable t) {
			_logger.error("error in delete", t);
			return FAILURE;
		}
		return SUCCESS;
	}

	public String view() {
		try {
			GuiFragment guiFragment = this.getGuiFragmentManager().getGuiFragment(this.getCode());
			if (null == guiFragment) {
				this.addActionError(this.getText("error.guiFragment.null"));
				return INPUT;
			}
			this.populateForm(guiFragment);
		} catch (Throwable t) {
			_logger.error("error in view", t);
			return FAILURE;
		}
		return SUCCESS;
	}


	public String showDetail() {
		try {
			if (null == this.getCode()) {
				this.addActionError(this.getText("error.guiFragment.null"));
				return "guiFragmentsList";				
			}
			GuiFragment guiFragment = this.getGuiFragmentManager().getGuiFragment(this.getCode());
			if (null == guiFragment) {
				this.addActionError(this.getText("error.guiFragment.null"));
				return "guiFragmentsList";
			}
			this.populateForm(guiFragment);
			this.extractReferencingObjects(this.getCode());
		} catch (Throwable t) {
			_logger.error("error in showDetail", t);
			return FAILURE;
		}
		return SUCCESS;
	}

	private String checkDelete(String code) throws Throwable {
		GuiFragment guiFragment = this.getGuiFragmentManager().getGuiFragment(code);
		if (null == guiFragment) {
			this.addActionError(this.getText("error.guiFragment.null"));
			return INPUT;
		}
		if (guiFragment.isLocked()) {
			this.addActionError(this.getText("error.guiFragment.locked"));
			return INPUT;			
		}
		this.extractReferencingObjects(code);
		if (null != this.getReferences() && this.getReferences().size() > 0) {
			return "references";
		}
		return null;
	}
	
	protected void extractReferencingObjects(String fragmentCode) {
		try {
			GuiFragment fragment = this.getGuiFragmentManager().getGuiFragment(fragmentCode);
			if (null != fragment) {
				Map references = this.getActionHelper().getReferencingObjects(fragment, this.getRequest());
				if (references.size() > 0) {
					this.setReferences(references);
				}
			}
		} catch (Throwable t) {
			_logger.error("Error extracting referenced objects by guiFragment '{}'", fragmentCode, t);
		}
	}

	private void populateForm(GuiFragment guiFragment) throws Throwable {
		this.setCode(guiFragment.getCode());
		this.setWidgetTypeCode(guiFragment.getWidgetTypeCode());
		this.setPluginCode(guiFragment.getPluginCode());
		this.setGui(guiFragment.getGui());
		this.setDefaultGui(guiFragment.getDefaultGui());
	}

	private GuiFragment createGuiFragment() throws Throwable {
		GuiFragment guiFragment = null;
		int strutsAction = this.getStrutsAction();
		if (ApsAdminSystemConstants.ADD == strutsAction) {
			guiFragment = new GuiFragment();
			guiFragment.setCode(this.getCode());
		} else {
			guiFragment = this.getGuiFragmentManager().getGuiFragment(this.getCode());
		}
		//GuiFragment guiFragment = new GuiFragment();
		//guiFragment.setWidgetTypeCode(this.getWidgetTypeCode());
		//guiFragment.setPluginCode(this.getPluginCode());
		guiFragment.setGui(this.getGui());
		return guiFragment;
	}

	public WidgetType getWidgetType(String widgetTypeCode) {
		return this.getWidgetTypeManager().getWidgetType(widgetTypeCode);
	}

	public int getStrutsAction() {
		return _strutsAction;
	}
	public void setStrutsAction(int strutsAction) {
		this._strutsAction = strutsAction;
	}

	public String getCode() {
		return _code;
	}
	public void setCode(String code) {
		this._code = code;
	}

	@Deprecated
	public String getWidgetCode() {
		return this.getWidgetTypeCode();
	}
	@Deprecated
	public void setWidgetCode(String widgetCode) {
		this.setWidgetTypeCode(widgetCode);
	}

	public String getWidgetTypeCode() {
		return _widgetTypeCode;
	}
	public void setWidgetTypeCode(String widgetTypeCode) {
		this._widgetTypeCode = widgetTypeCode;
	}

	public String getPluginCode() {
		return _pluginCode;
	}
	public void setPluginCode(String pluginCode) {
		this._pluginCode = pluginCode;
	}

	public String getGui() {
		return _gui;
	}
	public void setGui(String gui) {
		this._gui = gui;
	}

	public String getDefaultGui() {
		return _defaultGui;
	}
	public void setDefaultGui(String defaultGui) {
		this._defaultGui = defaultGui;
	}

	protected IGuiFragmentManager getGuiFragmentManager() {
		return _guiFragmentManager;
	}
	public void setGuiFragmentManager(IGuiFragmentManager guiFragmentManager) {
		this._guiFragmentManager = guiFragmentManager;
	}

	protected IWidgetTypeManager getWidgetTypeManager() {
		return _widgetTypeManager;
	}
	public void setWidgetTypeManager(IWidgetTypeManager widgetTypeManager) {
		this._widgetTypeManager = widgetTypeManager;
	}

	public Map<String, List<Object>> getReferences() {
		return _references;
	}
	public void setReferences(Map<String, List<Object>> references) {
		this._references = references;
	}

	protected IGuiFragmentActionHelper getActionHelper() {
		return _actionHelper;
	}
	public void setActionHelper(IGuiFragmentActionHelper actionHelper) {
		this._actionHelper = actionHelper;
	}

	private int _strutsAction;
	private String _code;
	private String _widgetTypeCode;
	private String _pluginCode;
	private String _gui;
	private String _defaultGui;

	private IGuiFragmentManager _guiFragmentManager;
	private IWidgetTypeManager _widgetTypeManager;

	private Map<String, List<Object>> _references = new HashMap<String, List<Object>>();
	private IGuiFragmentActionHelper _actionHelper;
}