From d2195ee45281d74241f9cd1362d79e2dd24c0ad2 Mon Sep 17 00:00:00 2001
From: mka <mka@opencascade.com>
Date: Thu, 19 Sep 2013 07:33:59 +0000
Subject: [PATCH] Remove the scenario functionality is implemented

---
 .../org/splat/service/ScenarioService.java    |  8 +++
 .../splat/service/ScenarioServiceImpl.java    | 70 +++++++++++++++++++
 .../src/org/splat/som/StudyRights.java        | 11 +++
 .../src/spring/businessServiceContext.xml     |  1 +
 .../org/splat/simer/ApplicationSettings.java  | 54 ++++++++++++--
 .../splat/simer/DisplayStudyStepAction.java   |  1 +
 .../simer/EditScenarioPropertiesAction.java   | 23 ++++++
 .../Siman/src/org/splat/simer/OpenStudy.java  | 38 ++++++----
 Workspace/Siman/src/struts.xml                | 13 +++-
 9 files changed, 196 insertions(+), 23 deletions(-)

diff --git a/Workspace/Siman-Common/src/org/splat/service/ScenarioService.java b/Workspace/Siman-Common/src/org/splat/service/ScenarioService.java
index 4012fa9..bb37542 100644
--- a/Workspace/Siman-Common/src/org/splat/service/ScenarioService.java
+++ b/Workspace/Siman-Common/src/org/splat/service/ScenarioService.java
@@ -293,4 +293,12 @@ public interface ScenarioService {
 	 *            the scenario with a new title.
 	 */
 	void renameScenario(final Scenario scenario);
+
+	/**
+	 * Remove the scenario.
+	 * 
+	 * @param scenarioId -
+	 *            the id of the scenario to remove.
+	 */
+	void removeScenario(final long scenarioId);
 }
diff --git a/Workspace/Siman-Common/src/org/splat/service/ScenarioServiceImpl.java b/Workspace/Siman-Common/src/org/splat/service/ScenarioServiceImpl.java
index d1a7f1b..f75f2d7 100644
--- a/Workspace/Siman-Common/src/org/splat/service/ScenarioServiceImpl.java
+++ b/Workspace/Siman-Common/src/org/splat/service/ScenarioServiceImpl.java
@@ -14,6 +14,7 @@ import java.util.ArrayList;
 import java.util.Calendar;
 import java.util.Date;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
@@ -47,6 +48,7 @@ import org.splat.dal.bo.som.ValidationCycle;
 import org.splat.dal.bo.som.Document.Properties;
 import org.splat.dal.dao.kernel.RoleDAO;
 import org.splat.dal.dao.kernel.UserDAO;
+import org.splat.dal.dao.som.DocumentDAO;
 import org.splat.dal.dao.som.KnowledgeElementDAO;
 import org.splat.dal.dao.som.KnowledgeElementTypeDAO;
 import org.splat.dal.dao.som.ScenarioDAO;
@@ -148,6 +150,11 @@ public class ScenarioServiceImpl implements ScenarioService {
 	 * Injected knowledge element type DAO.
 	 */
 	private KnowledgeElementTypeDAO _knowledgeElementTypeDAO;
+	
+	/**
+	 * Injected document DAO.
+	 */
+	private DocumentDAO _documentDAO;
 
 	/**
 	 * Injected simulation context service.
@@ -1375,6 +1382,53 @@ public class ScenarioServiceImpl implements ScenarioService {
 	public void renameScenario(final Scenario scenario) {
 		getScenarioDAO().merge(scenario);
 	}
+	
+	/** 
+	 * {@inheritDoc}
+	 * @see org.splat.service.ScenarioService#removeScenario(long)
+	 */
+	@Transactional
+	public void removeScenario(final long scenarioId) {
+		Scenario scenario = getScenarioDAO().get(scenarioId);
+		Study study = scenario.getOwnerStudy();
+		
+		if (scenario != null && study != null) {
+			getScenarioDAO().delete(scenario);
+			
+			// Collect all documents which are published in another scenario
+			// or are previous versions of documents published in another scenario
+			Set<Document> untouched = new HashSet<Document>();
+		
+			List<Scenario> otherScenarios = study.getScenariiList();
+			otherScenarios.remove(scenario);
+			
+			for (Scenario otherScenario : otherScenarios) {
+				for (Publication publication : otherScenario.getDocums()) {
+					for (Document document = publication.value(); document != null;
+							document = document.getPreviousVersion()) {
+						untouched.add(document);
+					}
+				}
+			}
+	
+			// Collect all documents which are published in this scenario
+			// or are previous versions of documents published in this scenario
+			Set<Document> toRemove = new HashSet<Document>();
+			for (Publication publication : scenario.getDocums()) {
+				for (Document document = publication.value(); document != null; 
+						document = document.getPreviousVersion()) {
+					toRemove.add(document);
+				}
+			}
+			
+			toRemove.removeAll(untouched);
+			
+			// Delete all necessary documents
+			for (Document document : toRemove) {
+				_documentDAO.delete(document);
+			}
+		}
+	}
 
 	/**
 	 * Get the knowledgeElementDAO.
@@ -1549,6 +1603,22 @@ public class ScenarioServiceImpl implements ScenarioService {
 			final KnowledgeElementTypeDAO knowledgeElementTypeDAO) {
 		_knowledgeElementTypeDAO = knowledgeElementTypeDAO;
 	}
+	
+	/**
+	 * Get the documentDAO.
+	 * @return the documentDAO
+	 */
+	public DocumentDAO getDocumentDAO() {
+		return _documentDAO;
+	}
+
+	/**
+	 * Set the documentDAO.
+	 * @param documentDAO the documentDAO to set
+	 */
+	public void setDocumentDAO(final DocumentDAO documentDAO) {
+		_documentDAO = documentDAO;
+	}
 
 	/**
 	 * Get the simulationContextService.
diff --git a/Workspace/Siman-Common/src/org/splat/som/StudyRights.java b/Workspace/Siman-Common/src/org/splat/som/StudyRights.java
index 62c0a1e..e869784 100644
--- a/Workspace/Siman-Common/src/org/splat/som/StudyRights.java
+++ b/Workspace/Siman-Common/src/org/splat/som/StudyRights.java
@@ -152,6 +152,17 @@ public class StudyRights {
 				.getProgressState() == ProgressState.inDRAFT)
 				&& _isauthor;
 	}
+	
+	/**
+	 * Check if the user can remove the selected scenario.
+	 * 
+	 * @return true if the user can remove the scenario
+	 */
+	public boolean canRemoveScenario() {
+		return (_operand.getProgressState() == ProgressState.inWORK 
+			|| _operand.getProgressState() == ProgressState.inDRAFT)
+			&& _isauthor && _operand.getScenariiList().size() > 1;
+	}
 
 	/**
 	 * Check if the user can version the study.
diff --git a/Workspace/Siman-Common/src/spring/businessServiceContext.xml b/Workspace/Siman-Common/src/spring/businessServiceContext.xml
index 7f911ca..c38f3d4 100644
--- a/Workspace/Siman-Common/src/spring/businessServiceContext.xml
+++ b/Workspace/Siman-Common/src/spring/businessServiceContext.xml
@@ -100,6 +100,7 @@ http://www.springframework.org/schema/tx/spring-tx-3.0.xsd">
 		<property name="userService" ref="userService" />
         <property name="userDAO" ref="userDAO" />
         <property name="roleDAO" ref="roleDAO" />
+        <property name="documentDAO" ref="documentDAO" />
 		<property name="knowledgeElementTypeDAO"
 			ref="knowledgeElementTypeDAO" />
         <property name="simulationContextService"
diff --git a/Workspace/Siman/src/org/splat/simer/ApplicationSettings.java b/Workspace/Siman/src/org/splat/simer/ApplicationSettings.java
index e489c5d..c9a84a2 100644
--- a/Workspace/Siman/src/org/splat/simer/ApplicationSettings.java
+++ b/Workspace/Siman/src/org/splat/simer/ApplicationSettings.java
@@ -250,6 +250,10 @@ public class ApplicationSettings {
 	 * Remove menu item name.
 	 */
 	private static final String MNU_NAME_REMOVE_VERSION = "menu.remove.version";
+	/**
+	 * Remove scenario menu item name.
+	 */
+	private static final String MNU_NAME_REMOVE_SCENARIO = "menu.remove.scenario";
 	/**
 	 * Rename menu item name.
 	 */
@@ -290,6 +294,10 @@ public class ApplicationSettings {
 	 * Remove as reference action name.
 	 */
 	private static final String ACT_REMOVE_AS_REFERENCE = "removeasref-study";
+	/**
+	 * Remove scenario action name.
+	 */
+	private static final String ACT_REMOVE_SCENARIO = "remove-study";
 	/**
 	 * Promote the study action name.
 	 */
@@ -529,7 +537,11 @@ public class ApplicationSettings {
 		/**
 		 * Mark the study as reference.
 		 */
-		markasreference
+		markasreference,
+		/**
+		 * Remove selected scenario.
+		 */
+		removescenario
 	};
 
 	// Resources relative to studies
@@ -542,6 +554,11 @@ public class ApplicationSettings {
 		 */
 		protected transient StudyRights _user = null;
 
+		/**
+		 * Specifies if a scenario is selected, hence the "remove scenario" menu item can be enabled.
+		 */
+		private boolean _scenarioSlected = false;
+
 		/**
 		 * Add items which are common for all study popup menus.
 		 */
@@ -555,13 +572,16 @@ public class ApplicationSettings {
 					.action("add-scenario"));
 			/*
 			 * addItem(MNU_VERSION, new PopupItem(MNU_NAME_VERSION).icon( IMG_VERSION).action(ACT_NOT_YET_IMPLEMENTED));
-			 */
-			addSeparator();
-			/*
 			 * addItem(MNU_PURGE, new PopupItem(MNU_NAME_PURGE) .confirmation("message.purge.study")); addItem("export", new
 			 * PopupItem("menu.export") .icon("image.export.png")); // For future needs
-			 */addItem(MNU_REMOVE, new PopupItem(MNU_NAME_REMOVE_VERSION).icon(
-					IMG_DELETE).action("remove-study").confirmation(
+			 */
+			addItem(Item.removescenario.toString(),
+					new PopupItem(MNU_NAME_REMOVE_SCENARIO)
+					.icon(IMG_DELETE).action("remove-scenario"/*"ACT_REMOVE_SCENARIO"*/)
+					.confirmation("message.delete.scenario"));
+			addSeparator();
+			addItem(MNU_REMOVE, new PopupItem(MNU_NAME_REMOVE_VERSION).icon(
+					IMG_DELETE).action(ACT_REMOVE_SCENARIO).confirmation(
 					"message.delete.study"));
 		}
 
@@ -611,6 +631,13 @@ public class ApplicationSettings {
 							res = _user.canRemoveStudyAsReference();
 						}
 						break;
+					case removescenario:
+						if(_scenarioSlected) {
+							res = _user.canRemoveScenario();
+						} else {
+							res =false;
+						}
+						break;
 					default:
 						res = false;
 				}
@@ -636,6 +663,15 @@ public class ApplicationSettings {
 				}
 			}
 		}
+
+		/**
+		 * Set the scenarioSlected.
+		 * @param scenarioSlected the scenarioSlected to set
+		 */
+		public StudyPopup setScenarioSlected(final boolean scenarioSlected) {
+			_scenarioSlected = scenarioSlected;
+			return this;
+		}
 	}
 
 	/**
@@ -1330,6 +1366,12 @@ public class ApplicationSettings {
 		_popups.put("streviewable", new ReviewableStudyPopup());
 		_popups.put("stapprovable", new ApprovableStudyPopup());
 
+		_popups.put("steditablemarkpublicScenarioSelected",
+				new EditableMarkedStudyPopup(false, false).setScenarioSlected(true));
+		_popups.put("steditableScenarioSelected", new EditableStudyPopup().setScenarioSlected(true));
+		_popups.put("streviewableScenarioSelected", new ReviewableStudyPopup().setScenarioSlected(true));
+		_popups.put("stapprovableScenarioSelected", new ApprovableStudyPopup().setScenarioSlected(true));
+
 		_popups.put("editable", new EditableDocumentPopup());
 		_popups.put("notresult", new NotResultDocumentPopupAuthor());
 		_popups.put("reviewable", new ReviewableDocumentPopupAuthor());
diff --git a/Workspace/Siman/src/org/splat/simer/DisplayStudyStepAction.java b/Workspace/Siman/src/org/splat/simer/DisplayStudyStepAction.java
index 8aa9106..cec8daa 100644
--- a/Workspace/Siman/src/org/splat/simer/DisplayStudyStepAction.java
+++ b/Workspace/Siman/src/org/splat/simer/DisplayStudyStepAction.java
@@ -121,6 +121,7 @@ public class DisplayStudyStepAction extends AbstractDisplayAction {
 			_selection = _openStudy.getSelection();
 		} else { // Selection of a step of current study
 			_openStudy.setSelection(_selection);
+			_openStudy.open(getConnectedUser(), _openStudy.getStudyObject());	//needed to refresh pop-up menu
 		}
 		// Re-initialization of the properties menu according to the selected step
 		ProjectElement owner = _openStudy.getSelectedStep().getOwner();
diff --git a/Workspace/Siman/src/org/splat/simer/EditScenarioPropertiesAction.java b/Workspace/Siman/src/org/splat/simer/EditScenarioPropertiesAction.java
index 2743e79..ea60834 100644
--- a/Workspace/Siman/src/org/splat/simer/EditScenarioPropertiesAction.java
+++ b/Workspace/Siman/src/org/splat/simer/EditScenarioPropertiesAction.java
@@ -130,6 +130,29 @@ public class EditScenarioPropertiesAction extends DisplayStudyStepAction {
 		doOpen();
 		return SUCCESS;
 	}
+	
+	/**
+	 * Remove the scenario functionality.
+	 * 
+	 * @return SUCCESS
+	 * 			if the scenario has been successfully removed
+	 *  	   ERROR
+	 * 			if the user can not delete the scenario
+	 */
+	public String doRemoveScenario() {
+		String res = ERROR;
+		List<Scenario> scenarios = getOpenStudy().getStudyObject().getScenariiList();
+		if (_openStudy.getStudyRights().canRemoveScenario()) {
+			for (Scenario scenario : scenarios) {
+				if (scenario.getIndex() == Long.valueOf(getOpenStudy().getSelectedScenarioId())) {
+					_scenarioService.removeScenario(scenario.getIndex());
+					res = SUCCESS;
+				}
+			}
+		}
+		_openStudy.setSelection("0.1");	// Default selection
+		return res;
+	}
 
 	// ==============================================================================================================================
 	// Getters
diff --git a/Workspace/Siman/src/org/splat/simer/OpenStudy.java b/Workspace/Siman/src/org/splat/simer/OpenStudy.java
index cad212a..946317d 100644
--- a/Workspace/Siman/src/org/splat/simer/OpenStudy.java
+++ b/Workspace/Siman/src/org/splat/simer/OpenStudy.java
@@ -124,8 +124,10 @@ public class OpenStudy extends AbstractOpenObject implements OpenStudyServices {
 				.getRevisionPattern());
 
 		_cuser = user; // May be null if nobody connected
+		if(!study.equals(_mystudy)) {
+			_selection = "0.1"; // Default selection
+		}
 		_mystudy = study;
-		_selection = "0.1"; // Default selection
 		_selecdoc = null;
 
 		// Preparation of the display
@@ -135,7 +137,9 @@ public class OpenStudy extends AbstractOpenObject implements OpenStudyServices {
 		_description = _mystudy.getDescription();
 		_involving = new ArrayList<Step>(1);
 		_context = new ArrayList<SimulationContextFacade>();
-		_ustep = getProjectElementService().getFirstStep(_mystudy);
+		if (_selection.equals("0.1")) {
+			_ustep = getProjectElementService().getFirstStep(_mystudy);
+		}
 		_ustep.setActor(_cuser);
 		_involving.add(_ustep);
 		for (Iterator<SimulationContext> i = _ustep.getAllSimulationContexts()
@@ -165,19 +169,25 @@ public class OpenStudy extends AbstractOpenObject implements OpenStudyServices {
 					_popup = getApplicationSettings().getPopupMenu(
 							"steditablemarkprivate");
 				} else {
-					if (_mystudy.getProgressState() == ProgressState.inWORK) {
-						_popup = getApplicationSettings().getPopupMenu(
-								"steditable");
-					} else if (_mystudy.getProgressState() == ProgressState.inDRAFT) {
-						_popup = getApplicationSettings().getPopupMenu(
-								"streviewable");
-					} else if (_mystudy.getProgressState() == ProgressState.inCHECK) {
-						_popup = getApplicationSettings().getPopupMenu(
-								"stapprovable");
-					} else { // APPROVED
-						_popup = getApplicationSettings().getPopupMenu(
-								"steditablemarkpublic");
+					String key = null;
+					switch(_mystudy.getProgressState()) {
+						case inWORK:
+							key = "steditable";
+							break;
+						case inDRAFT:
+							key = "streviewable";
+							break;
+						case inCHECK:
+							key = "stapprovable";
+							break;
+						default: // APPROVED
+							key = "steditablemarkpublic";
+							break;
+					}
+					if(Long.valueOf(getSelectedScenarioId()) != 0) {
+						key += "ScenarioSelected";
 					}
+					_popup = getApplicationSettings().getPopupMenu(key);
 				}
 
 			}
diff --git a/Workspace/Siman/src/struts.xml b/Workspace/Siman/src/struts.xml
index 172b88f..250e023 100644
--- a/Workspace/Siman/src/struts.xml
+++ b/Workspace/Siman/src/struts.xml
@@ -364,7 +364,6 @@
 				page.displaystudy
 			</result>
 		</action>
-		
 		<action name="valid-rename" class="editScenarioPropertiesAction"
 			method="editScenarioTitle">
 			<interceptor-ref name="simanBasicStack" />
@@ -373,7 +372,15 @@
 				open-study
 			</result>
 		</action>
-		
+		<action name="remove-scenario" class="editScenarioPropertiesAction"
+            method="removeScenario">
+            <result name="success" type="redirectAction">
+                open-study
+            </result>
+            <result name="error" type="redirectAction">
+                step-study
+            </result>
+        </action>	
 		<action name="add-scenario" class="newScenarioAction"
 			method="initialize">
 			<result name="success" type="tiles">
@@ -412,7 +419,7 @@
 				step-study
 			</result>
 			<result name="success" type="redirectAction">
-				step-study
+				open-study
 			</result>
 			<result name="error" type="tiles">page.displaystudy</result>
 		</action>
-- 
2.39.2