1 /*****************************************************************************
5 * Creation date 06.10.2012
8 *****************************************************************************/
10 package org.splat.service;
12 import java.text.DecimalFormat;
13 import java.text.SimpleDateFormat;
14 import java.util.Calendar;
15 import java.util.Iterator;
16 import java.util.List;
18 import org.hibernate.criterion.Criterion;
19 import org.hibernate.criterion.Restrictions;
20 import org.splat.dal.bo.kernel.Relation;
21 import org.splat.dal.bo.som.ConvertsRelation;
22 import org.splat.dal.bo.som.Document;
23 import org.splat.dal.bo.som.DocumentType;
24 import org.splat.dal.bo.som.File;
25 import org.splat.dal.bo.som.ProgressState;
26 import org.splat.dal.bo.som.ProjectElement;
27 import org.splat.dal.bo.som.Scenario;
28 import org.splat.dal.bo.som.StampRelation;
29 import org.splat.dal.bo.som.Study;
30 import org.splat.dal.bo.som.Timestamp;
31 import org.splat.dal.bo.som.ValidationStep;
32 import org.splat.dal.bo.som.Document.Properties;
33 import org.splat.dal.dao.kernel.RelationDAO;
34 import org.splat.dal.dao.som.DocumentDAO;
35 import org.splat.dal.dao.som.DocumentTypeDAO;
36 import org.splat.dal.dao.som.FileDAO;
37 import org.splat.dal.dao.som.StudyDAO;
38 import org.splat.kernel.InvalidPropertyException;
39 import org.splat.kernel.MissedPropertyException;
40 import org.splat.kernel.NotApplicableException;
41 import org.splat.log.AppLogger;
42 import org.splat.manox.Reader;
43 import org.splat.manox.Toolbox;
44 import org.splat.service.technical.ProjectSettingsService;
45 import org.splat.service.technical.RepositoryService;
46 import org.splat.service.technical.ProjectSettingsServiceImpl.FileNaming;
47 import org.splat.som.Revision;
48 import org.springframework.transaction.annotation.Transactional;
51 * Document service implementation.
53 * @author <a href="mailto:roman.kozlov@opencascade.com">Roman Kozlov (RKV)</a>
56 public class DocumentServiceImpl implements DocumentService {
59 * The logger for the service.
61 public final static AppLogger LOG = AppLogger
62 .getLogger(DocumentServiceImpl.class);
65 * Injected study service.
67 private StudyService _studyService;
69 * Injected project settings service.
71 private ProjectSettingsService _projectSettings;
73 * Injected repository service.
75 private RepositoryService _repositoryService;
77 * Injected document DAO.
79 private DocumentDAO _documentDAO;
81 * Injected relation DAO.
83 private RelationDAO _relationDAO;
85 * Injected document type DAO.
87 private DocumentTypeDAO _documentTypeDAO;
91 private FileDAO _fileDAO;
95 private StudyDAO _studyDAO;
100 * @see org.splat.service.DocumentService#selectDocument(long)
102 @Transactional(readOnly = true)
103 public Document selectDocument(final long index) {
104 return getDocumentDAO().get(index);
110 * @see org.splat.service.DocumentService#selectDocument(java.lang.String, java.lang.String)
112 @Transactional(readOnly = true)
113 public Document selectDocument(final String refid, final String version) {
114 Criterion aCondition = Restrictions.and(Restrictions.eq("did", refid),
115 Restrictions.eq("version", version));
116 return getDocumentDAO().findByCriteria(aCondition);
122 * @see org.splat.service.DocumentService#generateDocumentId(org.splat.dal.bo.som.Document, org.splat.dal.bo.som.Document.Properties)
125 public void generateDocumentId(final Document aDoc, final Properties dprop) {
126 Study owner = dprop.getOwner().getOwnerStudy();
128 // Synchronize the object with the current Hibernate session.
129 owner.setLastLocalIndex(getStudyDAO().get(owner.getIndex())
130 .getLastLocalIndex());
132 SimpleDateFormat tostring = new SimpleDateFormat("yyyy"); // RKV: NOPMD: TODO: Use locale here?
133 String year = tostring.format(owner.getDate());
134 String filename = generateEncodedName(aDoc, owner);
135 String path = owner.getReference();
136 ProjectSettingsService.Step step = getProjectSettings().getStep(
138 aDoc.setDid(new StringBuffer(path).append(".%").append(
139 Document.suformat).toString()); // Document reference
140 StringBuffer pathBuf = new StringBuffer(year).append("/").append(path)
141 .append("/").append(step.getPath())
142 // File path relative to the repository vault
144 if (!FileNaming.asis.equals(getProjectSettings().getFileNamingScheme())) {
145 // Use format as extension if file naming strategy is not "asis".
146 pathBuf.append(".").append(aDoc.getFile().getFormat()); // File name and extension
148 aDoc.getFile().changePath(pathBuf.toString());
149 owner = getStudyDAO().merge(owner);
153 * Generate encoded document file name according to the naming scheme from project settings.
159 * @return document reference name
161 private String generateEncodedName(final Document aDoc, final Study scope) {
162 StringBuffer encoding = new StringBuffer();
163 FileNaming scheme = getProjectSettings().getFileNamingScheme();
164 DecimalFormat tostring = new DecimalFormat(Document.suformat);
166 int number = getStudyService().generateLocalIndex(scope);
168 if (scheme == FileNaming.encoded) {
169 encoding.append(scope.getReference()).append("_").append(
170 tostring.format(number));
171 } else { // title and (temporarily) asis
172 encoding.append(tostring.format(number)).append("_").append(
173 aDoc.getFile().getName());
175 return encoding.toString();
179 * Get encoded root name for a document file.
187 private String getEncodedRootName(final Document aDoc, final Study scope) {
188 FileNaming scheme = getProjectSettings().getFileNamingScheme();
190 if (scheme == FileNaming.encoded) {
191 res = scope.getReference();
192 } else if (scheme == FileNaming.asis) {
193 res = aDoc.getFile().getName();
195 res = aDoc.getTitle();
203 * @see org.splat.service.DocumentService#initialize(org.splat.dal.bo.som.Document, org.splat.dal.bo.som.Document.Properties)
206 public void initialize(final Document aDoc, final Properties dprop)
207 throws MissedPropertyException, InvalidPropertyException,
208 NotApplicableException {
209 if (!aDoc.isUndefined()) {
210 throw new NotApplicableException(
211 "Cannot initialize an existing Document");
213 if (dprop.getName() == null) {
214 throw new MissedPropertyException("name");
216 if (dprop.getName().length() == 0) {
217 throw new InvalidPropertyException("name");
219 if (dprop.getOwner() == null) {
220 throw new MissedPropertyException("owner");
222 // if (dprop.owner instanceof Study && !ProjectSettings.getStep(step).appliesTo(Study.class)) {
223 // throw new InvalidPropertyException("step");
225 aDoc.setTitle(dprop.getName());
226 aDoc.getFile().changePath(
227 aDoc.getFile().getRelativePath().replace("%n",
228 getEncodedRootName(aDoc, (Study) dprop.getOwner())));
229 if (aDoc.getHistory() == -1) {
232 if (dprop.getDate() == null) {
233 Calendar current = Calendar.getInstance();
234 aDoc.setLastModificationDate(current.getTime()); // Today
236 aDoc.setLastModificationDate(dprop.getDate());
238 getDocumentDAO().update(aDoc);
244 * @see org.splat.service.DocumentService#getSaveDirectory(org.splat.dal.bo.som.Document)
246 public java.io.File getSaveDirectory(final Document aDoc) {
247 String mypath = getRepositoryService().getRepositoryVaultPath()
248 + aDoc.getSourceFile().getRelativePath();
249 String[] table = mypath.split("/");
251 // Cutting the filename
252 StringBuffer path = new StringBuffer(table[0]);
253 for (int i = 1; i < table.length - 1; i++) {
254 path = path.append("/").append(table[i]);
256 return new java.io.File(path.append("/").toString());
260 * Extract title and reference properties from the given file.
264 * @return the extracted properties
266 public Properties extractProperties(final java.io.File file) {
267 Properties fprop = new Properties();
268 Reader tool = Toolbox.getReader(file);
272 value = tool.extractProperty("title");
274 fprop.setName(value);
277 value = tool.extractProperty("reference");
279 fprop.setReference(value);
281 } catch (Exception e) {
282 LOG.debug(e.getMessage(), e);
289 * Create "Converts" relation for the given document and the given format.
295 * @return the created "Converts" relation
298 public ConvertsRelation attach(final Document aDoc, final String format) {
299 return attach(aDoc, format, null);
303 * Create "Converts" relation for the given document, format and description.
310 * the description of the relation
311 * @return the created "Converts" relation
314 public ConvertsRelation attach(final Document aDoc, final String format,
315 final String description) {
316 String path = aDoc.getRelativePath();
317 File export = new File(path + "." + format);
318 ConvertsRelation attach = new ConvertsRelation(aDoc, export,
321 getFileDAO().create(export);
322 getRelationDAO().create(attach);
324 aDoc.getAllRelations().add(attach);
325 getDocumentDAO().merge(aDoc);
331 * Build a reference (document id) for the given document in the given study basing on the given original document.
334 * the document to set set the new reference to
338 * the original document
339 * @return true if the new reference is set
342 public boolean buildReferenceFrom(final Document aDoc,
343 final ProjectElement scope, final Document lineage) {
344 boolean res = (aDoc.getProgressState() == ProgressState.inWORK);
346 Study owner = scope.getOwnerStudy();
347 Scenario context = null;
348 if (scope instanceof Scenario) {
349 context = ((Scenario) scope);
351 aDoc.setDid(lineage.getDid());
353 && (lineage.isVersioned() || owner.shares(lineage))) {
354 aDoc.setVersion(new Revision(aDoc.getVersion()).setBranch(
355 context.getReference()).toString());
362 * Build a reference (document id) for the given document in the given study.
365 * the document to set set the new reference to
368 * @return true if the new reference is set
371 public boolean buildReferenceFrom(final Document aDoc, final Study scope) {
372 if (aDoc.getProgressState() != ProgressState.inWORK
373 && aDoc.getProgressState() != ProgressState.EXTERN) {
376 DecimalFormat tostring = new DecimalFormat(Document.suformat);
378 aDoc.setDid(aDoc.getDid().replace("%" + Document.suformat,
379 tostring.format(scope.getLastLocalIndex())));
387 * the document to demote
388 * @return true if demoting succeeded
391 public boolean demote(final Document aDoc) {
392 ValidationStep torem;
394 if (aDoc.getProgressState() == ProgressState.inCHECK) {
395 aDoc.setProgressState(ProgressState.inDRAFT);
396 torem = ValidationStep.REVIEW;
397 // This operation must not change the version number of documents.
398 // Consequently, inDRAFT documents may have a minor version number equal to zero.
399 } else if (aDoc.getProgressState() == ProgressState.inDRAFT) {
400 aDoc.setProgressState(ProgressState.inWORK);
401 torem = ValidationStep.PROMOTION;
405 for (Iterator<Relation> i = aDoc.getAllRelations().iterator(); i
407 Relation link = i.next();
408 if (!(link instanceof StampRelation)) {
411 if (((StampRelation) link).getStampType() != torem) {
417 getDocumentDAO().update(aDoc);
422 * Promote a document.
425 * the document to promote
427 * the timestamp of the promotion
428 * @return true if promotion succeeded
431 public boolean promote(final Document aDoc, final Timestamp stamp) {
432 ProgressState newstate = null;
434 if (aDoc.getProgressState() == ProgressState.inWORK) {
435 newstate = ProgressState.inDRAFT; // Promotion to being reviewed
436 } else if (aDoc.getProgressState() == ProgressState.inDRAFT) {
437 newstate = ProgressState.inCHECK; // Promotion to approval
438 Revision myvers = new Revision(aDoc.getVersion());
439 if (myvers.isMinor()) {
440 aDoc.setVersion(myvers.incrementAs(newstate).toString());
441 // TODO: If my physical file is programatically editable, update its (property) version number
442 // ISSUE: What about attached files such as PDF if exist, should we remove them ?
444 } else if (aDoc.getProgressState() == ProgressState.inCHECK) {
445 newstate = ProgressState.APPROVED;
447 aDoc.setProgressState(newstate);
449 // RKV: aDoc.addRelation(stamp.getContext());
450 aDoc.getAllRelations().add(stamp.getContext());
452 getDocumentDAO().update(aDoc);
457 * Increments the reference count of this document following its publication in a Study step.
460 * the document to hold
464 public void hold(final Document aDoc) {
465 aDoc.setCountag(aDoc.getCountag() + 1);
466 if (aDoc.isSaved()) {
467 getDocumentDAO().merge(aDoc);
472 * Decrements the reference count of this document following the removal of a Publication from a Study step.
475 * the document to release
479 public void release(final Document aDoc) {
480 aDoc.setCountag(aDoc.getCountag() - 1);
481 if (aDoc.isSaved()) {
482 getDocumentDAO().merge(aDoc);
490 * the document to rename
492 * the new document title
493 * @throws InvalidPropertyException
494 * if the new title is empty
497 public void rename(final Document aDoc, final String title)
498 throws InvalidPropertyException {
499 if (title.length() == 0) {
500 throw new InvalidPropertyException("name");
503 Calendar current = Calendar.getInstance();
504 aDoc.setTitle(title);
505 aDoc.setLastModificationDate(current.getTime()); // Today
506 getDocumentDAO().update(aDoc);
510 * Update a version of the given document.
517 public void updateAs(final Document aDoc, final Revision newvers) {
518 aDoc.setVersion(newvers.setBranch(aDoc.getVersion()).toString()); // Branch names are propagated by the versionning
519 ProgressState newstate = ProgressState.inCHECK;
520 if (newvers.isMinor()) {
521 newstate = ProgressState.inWORK;
523 aDoc.setProgressState(null); // Just to tell updateAs(state) to not increment the version number
524 updateAs(aDoc, newstate);
528 * Update a state of the given document.
536 public void updateAs(final Document aDoc, final ProgressState state) {
537 Document previous = null;
539 // Set of version number
540 Revision myvers = new Revision(aDoc.getVersion());
541 if (!myvers.isNull()) { // Versionning context
542 previous = aDoc.getPreviousVersion();
544 if (aDoc.getProgressState() != null) {
545 myvers.incrementAs(state); // Incrementation if the reversion number is not imposed
547 aDoc.setVersion(myvers.toString());
549 // Update this document and the previous version, if exist
550 if (previous != null) {
551 previous.setHistory(previous.getHistory() + 1);
552 getDocumentDAO().merge(previous);
554 aDoc.setProgressState(state);
555 // RKV: getDocumentDAO().update(aDoc);
558 // protected void upgrade () {
559 // -------------------------
560 // if (this.state != ProgressState.inWORK) return;
562 // Calendar current = Calendar.getInstance();
563 // for (Iterator<Relation> i=getAllRelations().iterator(); i.hasNext();) {
564 // Relation link = i.next();
565 // if (!link.getClass().equals(UsesRelation.class)) continue;
567 // Document used = (Document)link.getTo();
568 // if (!used.isVersioned()) continue;
569 // TODO: Update the uses relation
572 // this.lasdate = current.getTime(); // Today
573 // Database.getSession().update(this);
575 // TODO: Promote documents using this one
579 * Checks if documents of this type are result of a study. A document is the result of a study when it is the result of the last step of
584 * @return true if documents of this type are result of a study.
585 * @see #isStepResult()
586 * @see #isResultOf(org.splat.service.technical.ProjectSettingsServiceImpl.Step)
588 public boolean isStudyResult(final DocumentType aType) {
589 List<ProjectSettingsService.Step> step = getProjectSettings()
591 ProjectSettingsService.Step lastep = step.get(step.size() - 1);
592 return (aType.isResultOf(lastep));
596 * Get document by its path.
600 * @return the document if found or null
602 @Transactional(readOnly = true)
603 public Document getDocumentByPath(String path) {
604 String[] parse = path.split("'");
607 for (int i = 1; i < parse.length; i++) {
608 path = path + "''" + parse[i];
610 Criterion aCondition = Restrictions.eq("path", path);
611 return getDocumentDAO().findByCriteria(aCondition);
615 * Get the studyService.
617 * @return the studyService
619 public StudyService getStudyService() {
620 return _studyService;
624 * Set the studyService.
626 * @param studyService
627 * the studyService to set
629 public void setStudyService(final StudyService studyService) {
630 _studyService = studyService;
634 * Get project settings.
636 * @return Project settings service
638 private ProjectSettingsService getProjectSettings() {
639 return _projectSettings;
643 * Set project settings service.
645 * @param projectSettingsService
646 * project settings service
648 public void setProjectSettings(
649 final ProjectSettingsService projectSettingsService) {
650 _projectSettings = projectSettingsService;
654 * Get the documentDAO.
656 * @return the documentDAO
658 public DocumentDAO getDocumentDAO() {
663 * Set the documentDAO.
666 * the documentDAO to set
668 public void setDocumentDAO(final DocumentDAO documentDAO) {
669 _documentDAO = documentDAO;
673 * Get the repositoryService.
675 * @return the repositoryService
677 public RepositoryService getRepositoryService() {
678 return _repositoryService;
682 * Set the repositoryService.
684 * @param repositoryService
685 * the repositoryService to set
687 public void setRepositoryService(final RepositoryService repositoryService) {
688 _repositoryService = repositoryService;
692 * Get the documentTypeDAO.
694 * @return the documentTypeDAO
696 public DocumentTypeDAO getDocumentTypeDAO() {
697 return _documentTypeDAO;
701 * Set the documentTypeDAO.
703 * @param documentTypeDAO
704 * the documentTypeDAO to set
706 public void setDocumentTypeDAO(final DocumentTypeDAO documentTypeDAO) {
707 _documentTypeDAO = documentTypeDAO;
713 * @return the fileDAO
715 public FileDAO getFileDAO() {
725 public void setFileDAO(final FileDAO fileDAO) {
732 * @return the studyDAO
734 public StudyDAO getStudyDAO() {
742 * the studyDAO to set
744 public void setStudyDAO(final StudyDAO studyDAO) {
745 _studyDAO = studyDAO;
749 * Get the relationDAO.
751 * @return the relationDAO
753 public RelationDAO getRelationDAO() {
758 * Set the relationDAO.
761 * the relationDAO to set
763 public void setRelationDAO(final RelationDAO relationDAO) {
764 _relationDAO = relationDAO;