1 package org.splat.simer;
5 * @author Daniel Brunier-Coulin
6 * @copyright OPEN CASCADE 2012
11 import java.text.SimpleDateFormat;
12 import java.util.ArrayList;
13 import java.util.Iterator;
14 import java.util.List;
15 import java.util.ResourceBundle;
17 import org.apache.log4j.Logger;
18 import org.splat.dal.bo.kernel.User;
19 import org.splat.dal.bo.som.Document;
20 import org.splat.dal.bo.som.DocumentType;
21 import org.splat.dal.bo.som.KnowledgeElement;
22 import org.splat.dal.bo.som.ProgressState;
23 import org.splat.dal.bo.som.Publication;
24 import org.splat.dal.bo.som.Scenario;
25 import org.splat.dal.bo.som.SimulationContext;
26 import org.splat.dal.bo.som.Study;
27 import org.splat.kernel.Do;
28 import org.splat.manox.Toolbox;
29 import org.splat.manox.Writer;
30 import org.splat.service.DocumentService;
31 import org.splat.service.DocumentTypeService;
32 import org.splat.service.StepService;
33 import org.splat.service.StudyService;
34 import org.splat.service.dto.KnowledgeElementDTO;
35 import org.splat.service.technical.RepositoryService;
36 import org.splat.som.Revision;
37 import org.splat.som.Step;
38 import org.splat.som.StepRights;
39 import org.splat.som.StudyRights;
40 import org.splat.util.BeanHelper;
41 import org.splat.wapp.ToolBar;
43 public class OpenStudy extends AbstractOpenObject implements OpenStudyServices {
48 protected final static Logger LOGGER = org.splat.simer.Action.LOG;
50 private transient Study _mystudy;
52 * User rights on the open study.
54 private transient StudyRights _urightstudy;
56 * User rights on the selected step.
58 private transient StepRights _urightstep;
59 private transient String _version;
60 private transient String _credate;
61 private transient String _lasdate;
62 private transient Publication _selecdoc;
64 * Injected step service.
66 private StepService _stepService;
68 * Injected repository service.
70 private RepositoryService _repositoryService;
72 * Injected document type service.
74 private DocumentTypeService _documentTypeService;
76 * Injected document service.
78 private DocumentService _documentService;
80 * The injected Study service.
82 private StudyService _studyService;
84 // ==============================================================================================================================
86 // ==============================================================================================================================
89 * Open the given study in the current http session.
95 * @return this open study object
97 public OpenStudy open(final User user, final Study study) {
98 ResourceBundle custom = ResourceBundle.getBundle("som",
99 getApplicationSettings().getCurrentLocale());
100 SimpleDateFormat datstring = new SimpleDateFormat(custom
101 .getString("date.format"));
102 Revision.Format verstring = new Revision.Format(getProjectSettings()
103 .getRevisionPattern());
105 _cuser = user; // May be null if nobody connected
107 _selection = "0.1"; // Default selection
110 // Preparation of the display
111 _version = verstring.format(_mystudy.getVersion());
112 _credate = datstring.format(_mystudy.getDate());
113 _lasdate = ""; // Not yet supported
114 _description = _mystudy.getDescription();
115 _involving = new ArrayList<Step>(1);
116 _context = new ArrayList<SimulationContextFacade>();
117 _ustep = getProjectElementService().getFirstStep(_mystudy);
118 _ustep.setActor(_cuser);
119 _involving.add(_ustep);
120 for (Iterator<SimulationContext> i = _ustep.getAllSimulationContexts()
121 .iterator(); i.hasNext();) {
122 _context.add(new SimulationContextFacade(i.next(),
123 getProjectSettings().getAllSteps()));
125 if (getStudyService().isStaffedBy(_mystudy, _cuser)
126 || getStudyService().hasActor(_mystudy, _cuser)) {
127 // ProgressState state = mystudy.getProgressState();
128 // if (state == ProgressState.inCHECK) popup = getApplicationSettings().getPopupMenu("stapprovable");
129 // else if (state == ProgressState.APPROVED) popup = getApplicationSettings().getPopupMenu("stapproved");
130 /* else */_popup = getApplicationSettings().getPopupMenu(
132 _popup.setContext("study", new StudyRights(_cuser, _mystudy));
134 _urightstudy = new StudyRights(_cuser, _mystudy);
135 _urightstep = new StepRights(_cuser, _ustep);
137 // RKV menu = new StudyMenu(mystudy);
138 _menu = (getMenu()).init(_mystudy); // RKV
139 _menu.selects(_selection); // Initializes menu items to be displayed
140 setupContents(); // Initializes documents and knowledge at ustep
144 // ==============================================================================================================================
146 // ==============================================================================================================================
148 public String getAuthorName() {
149 return _mystudy.getAuthor().toString();
152 public Long getIndex() {
153 return _mystudy.getIndex();
156 public String getDate() {
161 public StudyMenu getMenu() {
162 return (StudyMenu) _menu;
165 public void setMenu(final StudyMenu aMenu) {
169 public ProgressState getProgressState() {
170 return _mystudy.getProgressState();
173 public String getLastModificationDate() {
177 public ToolBar getModuleBar() {
178 return getApplicationSettings().getModuleBar(getSelectedStep());
181 public String getReference() {
182 return _mystudy.getReference();
185 public Publication getSelectedDocument() {
189 public StepRights getSelectedStepRights() {
193 public StudyRights getStudyRights() {
197 public Study getStudyObject() {
201 public String getTitle() {
202 return _mystudy.getTitle();
205 public String getType() {
206 return ResourceBundle.getBundle("labels",
207 getApplicationSettings().getCurrentLocale()).getString(
211 public String getVersion() {
215 public boolean isStepEnabled() {
216 return _urightstep.isEnabled();
219 // ==============================================================================================================================
221 // ==============================================================================================================================
223 public URL newTemplateBasedDocument(final String typename, final User author) {
224 String filename = typename + ".xml"; // Only XML templates are writeable
225 File template = new File(getRepositoryService().getTemplatePath()
227 if (!template.exists()) {
231 // Session connex = Database.getCurSession();
232 // Transaction transax = connex.beginTransaction();
234 File udir = getRepositoryService().getDownloadDirectory(author);
235 File credoc = new File(udir.getPath() + "/" + filename);
237 // Creation of the meta-document
238 Step step = getSelectedStep(); // Should we check if the given document type is compatible ?
239 DocumentType type = getDocumentTypeService().selectType(typename);
240 Document.Properties dprop = new Document.Properties();
241 Document medoc = getStepService().createDocument(step,
242 dprop.setType(type).setFormat("xml").setAuthor(author))
246 // Instantiation of the template into the user download directory
247 if (!udir.exists()) {
250 if (credoc.exists()) {
253 Do.copy(template, credoc);
255 // Transfer to the document of all known properties
256 ResourceBundle locale = ResourceBundle.getBundle("som",
257 getApplicationSettings().getCurrentLocale());
258 SimpleDateFormat get = new SimpleDateFormat(locale
259 .getString("date.format"));
260 Writer tool = Toolbox.getWriter(credoc);
261 List<Step> slist = getInvolvedSteps();
262 for (Iterator<Step> i = slist.iterator(); i.hasNext();) {
263 List<SimulationContext> clist = i.next()
264 .getAllSimulationContexts();
265 for (Iterator<SimulationContext> j = clist.iterator(); j
267 SimulationContext context = j.next();
268 tool.updateProperty(context.getType().getName(), context
272 tool.updateProperty("reference", medoc.getReference());
273 tool.updateProperty("study", _mystudy.getTitle());
274 tool.updateProperty("step", locale.getString(
275 "folder.step." + step.getNumber()).replaceAll("''", "'"));
276 tool.updateProperty("author", author.getUsername().toUpperCase());
277 tool.updateProperty("date", get.format(medoc.getCreationDate()));
278 tool.updateProperty("history", locale.getString("label.creation")
279 .replaceAll("''", "'"));
282 return new URL(getApplicationSettings().getDownloadURL(author)
284 } catch (Exception saverror) {
285 LOGGER.error("Reason:", saverror);
290 public void selectDocument(final String docurl) {
291 String prefix = getApplicationSettings().getRepositoryURL();
293 if (docurl.startsWith(prefix)) {
295 String path = docurl.substring(prefix.length());
296 Document value = getDocumentService().getDocumentByPath(path);
298 _selecdoc = _ustep.getDocument(value.getIndex());
299 } catch (Exception error) {
300 LOGGER.error("Reason:", error);
305 public void setSelection(final String step) {
306 if (!step.equals(_selection)) {
309 setupPreviousToSelectedSteps();
310 updateSimulationContexts(); // Initializes contexts according to the selected steps
312 _ustep = _involving.get(_involving.size() - 1);
313 _urightstep = new StepRights(_cuser, _ustep);
314 _ustep.setActor(_cuser);
315 _menu.selects(_selection); // Updates menu items to be displayed
316 setupContents(); // The contents may have changed even if the selection is the same
319 // ==============================================================================================================================
320 // Protected services
321 // ==============================================================================================================================
323 protected void add(final Publication doc) {
324 DocumentFacade facade = new DocumentFacade(this, doc,
325 getProjectSettings(), getPublicationService());
326 boolean first = (_contents.size() == 0);
328 docpres.put(doc.getIndex(), facade);
329 _contents.add(0, facade); // Prepend the new publication
331 this.getMenu().refreshSelectedItem();
336 protected void add(final SimulationContext contex) {
337 SimulationContextFacade facade = new SimulationContextFacade(contex,
338 getProjectSettings().getAllSteps());
340 _context.add(facade);
343 protected void add(final KnowledgeElement kelm) {
344 KnowledgeElementFacade facade = new KnowledgeElementFacade(BeanHelper
345 .copyBean(kelm, KnowledgeElementDTO.class));
346 // RKV KnowledgeIterator known = knowledge.get(kelm.getType().getIndex() - 2);
347 // Knowledges are ordered by type index, from 0 to n-1, the first one being reserved (reason for -2)
348 // RKV:Begin: Find a knowledge iterator for appropriate knowledge type
349 KnowledgeIterator known = null;
350 for (KnowledgeIterator aKnowledgeSection : _knowledge) {
351 if (aKnowledgeSection.getIndex().equals(
352 String.valueOf(kelm.getType().getIndex()))) {
353 known = aKnowledgeSection;
357 if (known != null) { // RKV:End
358 knowpres.put(kelm.getIndex(), facade);
359 known._list.add(facade); // Insert the new knowledge at the end of the corresponding knowledge type
363 protected void remove(final Publication doctag) {
364 for (Iterator<DocumentFacade> i = _contents.iterator(); i.hasNext();) {
365 DocumentFacade facade = i.next();
366 if (facade.isFacadeOf(doctag)) {
371 if (_contents.size() == 0) {
372 this.getMenu().refreshSelectedItem();
376 protected void changeUser(final User user) {
379 if (getStudyService().isStaffedBy(_mystudy, _cuser)) {
380 _popup = getApplicationSettings().getPopupMenu("steditable");
381 _popup.setContext("study", new StudyRights(_cuser, _mystudy));
383 // ustep = getProjectElementService().getFirstStep(mystudy);
384 if (_ustep != null) {
385 _ustep.setActor(_cuser);
387 _urightstudy = new StudyRights(_cuser, _mystudy);
388 _urightstep = new StepRights(_cuser, _ustep);
391 protected void remove(final SimulationContext contex) {
392 for (Iterator<SimulationContextFacade> i = _context.iterator(); i
394 SimulationContextFacade facade = i.next();
395 if (!facade.isFacadeOf(contex)) {
403 protected void remove(final KnowledgeElement kelm) {
404 KnowledgeIterator known = _knowledge.get((int) (kelm.getType()
406 // Knowledges are ordered by type index, from 0 to n-1, the first one being reserved (reason for -2)
407 knowpres.remove(kelm.getIndex());
408 for (Iterator<KnowledgeElementFacade> i = known._list.iterator(); i
410 KnowledgeElementFacade facade = i.next();
411 if (!facade.isFacadeOf(BeanHelper.copyBean(kelm,
412 KnowledgeElementDTO.class))) {
420 protected void update(final Publication doc) {
421 DocumentFacade facade = docpres.get(doc.getIndex());
422 if (facade != null) {
427 protected void update(final KnowledgeElementDTO kelm) {
428 KnowledgeElementFacade facade = knowpres.get(kelm.getIndex());
429 if (facade != null) {
430 facade.refresh(kelm);
434 protected void updateSimulationContexts() {
436 for (Iterator<Step> i = _involving.iterator(); i.hasNext();) {
437 for (Iterator<SimulationContext> j = i.next()
438 .getAllSimulationContexts().iterator(); j.hasNext();) {
439 _context.add(new SimulationContextFacade(j.next(),
440 getProjectSettings().getAllSteps()));
445 // ==============================================================================================================================
447 // ==============================================================================================================================
449 private void setupPreviousToSelectedSteps() {
450 String[] item = _selection.split("\\x2E");
451 int major = Integer.valueOf(item[0]);
452 int minor = Integer.valueOf(item[1]);
458 Scenario[] branch = _mystudy.getScenarii();
459 Scenario scenar = branch[0];
460 for (int i = 0; i < branch.length; i++) {
462 if (scenar.getIndex() == major) {
463 break; // Supposed exist
466 step = getProjectElementService().getSteps(scenar);
467 base = step[0].getNumber() - 1;
468 for (int i = 0; i + base < minor; i++) {
469 _involving.add(step[i]);
472 step = getProjectElementService().getSteps(_mystudy);
473 for (int i = step.length - 1; i > -1; i--) {
474 Step firstep = step[i];
475 if (firstep.getNumber() > base) {
478 _involving.add(0, firstep);
483 * Get the stepService.
485 * @return the stepService
487 public StepService getStepService() {
492 * Set the stepService.
495 * the stepService to set
497 public void setStepService(final StepService stepService) {
498 _stepService = stepService;
502 * Get the repositoryService.
504 * @return the repositoryService
506 public RepositoryService getRepositoryService() {
507 return _repositoryService;
511 * Set the repositoryService.
513 * @param repositoryService
514 * the repositoryService to set
516 public void setRepositoryService(final RepositoryService repositoryService) {
517 _repositoryService = repositoryService;
521 * Get the documentTypeService.
523 * @return the documentTypeService
525 public DocumentTypeService getDocumentTypeService() {
526 return _documentTypeService;
530 * Set the documentTypeService.
532 * @param documentTypeService
533 * the documentTypeService to set
535 public void setDocumentTypeService(
536 final DocumentTypeService documentTypeService) {
537 _documentTypeService = documentTypeService;
541 * Get the studyService.
543 * @return the studyService
545 public StudyService getStudyService() {
546 return _studyService;
550 * Set the studyService.
552 * @param studyService
553 * the studyService to set
555 public void setStudyService(final StudyService studyService) {
556 _studyService = studyService;
560 * Get the documentService.
562 * @return the documentService
564 public DocumentService getDocumentService() {
565 return _documentService;
569 * Set the documentService.
571 * @param documentService
572 * the documentService to set
574 public void setDocumentService(final DocumentService documentService) {
575 _documentService = documentService;
578 public Study getMystudy() {
582 public void setMystudy(final Study mystudy) {
583 this._mystudy = mystudy;