/*
 * Copyright (c) 2005-2016 Vincent Vandenschrick. All rights reserved.
 *
 *  This file is part of the Jspresso framework.
 *
 *  Jspresso 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 3 of the License, or
 *  (at your option) any later version.
 *
 *  Jspresso 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.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with Jspresso.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.jspresso.framework.application.frontend.action.module;

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

import org.jspresso.framework.action.IActionHandler;
import org.jspresso.framework.application.frontend.action.FrontendAction;
import org.jspresso.framework.application.model.Module;
import org.jspresso.framework.application.model.Workspace;

/**
 * Displays a module, and the corresponding workspace if necessary based on
 * their names. It can be used as startup action to select and display a module
 * when the application launches.
 *
 * @param <E>
 *     the actual gui component type used.
 * @param <F>
 *     the actual icon type used.
 * @param <G>
 *     the actual action type used.
 * @author Vincent Vandenschrick
 */
public class ModuleSelectionAction<E, F, G> extends FrontendAction<E, F, G> {

  private String moduleName;
  private String workspaceName;

  /**
   * Displays the workspace and module.
   * <p/>
   * {@inheritDoc}
   */
  @Override
  public boolean execute(IActionHandler actionHandler, Map<String, Object> context) {

    String wsName = getWorkspaceName(context);
    String moName = getModuleName(context);
    if (wsName == null && moName == null) {
      Object param = getActionParameter(context);
      if (param instanceof Module) {
        getController(context).displayModule((Module) param);
      }
    } else {
      Workspace ws = getController(context).getWorkspace(wsName);
      if (ws != null && getController(context).isAccessGranted(ws)) {
        try {
          getController(context).pushToSecurityContext(ws);
          List<Module> modules = ws.getModules();
          if (modules != null) {
            for (Module m : modules) {
              if (displayModule(wsName, moName, m, context)) {
                break;
              }
            }
          }
        } finally {
          getController(context).restoreLastSecurityContextSnapshot();
        }
      }
    }
    return super.execute(actionHandler, context);
  }

  private boolean displayModule(String wsName, String moName, Module module, Map<String, Object> context) {
    try {
      getController(context).pushToSecurityContext(module);
      if (moName.equals(module.getName())) {
        if (getController(context).isAccessGranted(module)) {
          getController(context).displayModule(wsName, module);
        }
        return true;
      }
      List<Module> subModules = module.getSubModules();
      if (subModules != null) {
        for (Module m : subModules) {
          if (displayModule(wsName, moName, m, context)) {
            return true;
          }
        }
      }
    } finally {
      getController(context).restoreLastSecurityContextSnapshot();
    }
    return false;
  }

  /**
   * Configures the name (untranslated) of the module to be displayed.
   *
   * @param moduleName
   *     the moduleName to set.
   */
  public void setModuleName(String moduleName) {
    this.moduleName = moduleName;
  }

  /**
   * Configures the name (untranslated) of the workspace to be displayed.
   *
   * @param workspaceName
   *     the workspaceName to set.
   */
  public void setWorkspaceName(String workspaceName) {
    this.workspaceName = workspaceName;
  }

  /**
   * Gets the moduleName.
   *
   * @param context
   *     the action context.
   * @return the moduleName.
   */
  protected String getModuleName(Map<String, Object> context) {
    return moduleName;
  }

  /**
   * Gets the workspaceName.
   *
   * @param context
   *     the action context.
   * @return the workspaceName.
   */
  protected String getWorkspaceName(Map<String, Object> context) {
    return workspaceName;
  }

}