Workspace/Siman/src/org/splat/simer/ImportDocumentAction.java

   1 package org.splat.simer;
   2
   3 import java.io.File;
   4 import java.io.FileNotFoundException;
   5 import java.text.SimpleDateFormat;
   6 import java.util.ArrayList;
   7 import java.util.Arrays;
   8 import java.util.Date;
   9 import java.util.List;
  10 import java.util.ResourceBundle;
  11
  12 import org.splat.dal.bo.kernel.User;
  13 import org.splat.dal.bo.som.Document;
  14 import org.splat.dal.bo.som.DocumentType;
  15 import org.splat.dal.bo.som.ProgressState;
  16 import org.splat.dal.bo.som.Publication;
  17 import org.splat.dal.bo.som.ValidationCycle;
  18 import org.splat.dal.bo.som.ValidationStep;
  19 import org.splat.manox.Reader;
  20 import org.splat.manox.Toolbox;
  21 import org.splat.service.DocumentService;
  22 import org.splat.service.DocumentTypeService;
  23 import org.splat.som.Revision;
  24 import org.splat.som.Step;
  25 import org.splat.wapp.Constants;
  26
  27 /**
  28  * Action for adding a document into a study step.
  29  */
  30 public class ImportDocumentAction extends BaseUploadDocumentAction {
  31
  32         /**
  33          * Serial version ID.
  34          */
  35         private static final long serialVersionUID = 2587822564883588556L;
  36
  37         /**
  38          * Sorted list of document types for the selected study step.
  39          */
  40         private transient List<DocumentType> _documentTypes = null;
  41         /**
  42          * Sorted list of document types for the selected study step.
  43          */
  44         private transient final List<Boolean> _reviewable = new ArrayList<Boolean>();
  45         /**
  46          * The selected document type.
  47          */
  48         private long _documentType = 0;
  49         /**
  50          * Reference extracted from the imported file, if exist.
  51          */
  52         private String _reference = null;
  53         /**
  54          * Injected document service.
  55          */
  56         private DocumentService _documentService;
  57         /**
  58          * Injected document type service.
  59          */
  60         private DocumentTypeService _documentTypeService;
  61
  62         /**
  63          * Initialize the operation.
  64          *
  65          * @return SUCCESS in success, otherwise - ERROR
  66          */
  67         public String doInitialize() {
  68
  69                 File upfile = commonInitialize(Constants.FALSE);
  70                 String[] table = _fileName.split("\\x2E");
  71                 String filext = table[table.length - 1].toLowerCase();
  72
  73                 _mystudy = getOpenStudy();
  74                 Step step = _mystudy.getSelectedStep();
  75                 _documentTypes = getStepService().getValidDocumentTypes(step);
  76                 // Set the document type by default
  77                 _deftype = getApplicationSettings()
  78                                 .getDefaultDocumentType(step, filext);
  79                 if (_deftype != null) {
  80                         setDefaultDocumentType(_deftype.getIndex());
  81                 }
  82                 _defuses = new ArrayList<Document>();
  83                 _state = ProgressState.inWORK;
  84
  85                 String res = ERROR;
  86                 if (extractProperties(upfile, filext)) {
  87                         if (_docname == null) {
  88                                 _docname = table[0];
  89                                 for (int i = 1; i < table.length - 1; i++) {
  90                                         _docname = _docname + "." + table[i];
  91                                 }
  92                         }
  93                         if (_deftype != null) {
  94                                 setupDefaultUses(_deftype);
  95                         }
  96
  97                         DocumentType[] types = _documentTypes
  98                                         .toArray(new DocumentType[_documentTypes.size()]);
  99                         DocumentTypeComparator compare = new DocumentTypeComparator();
 100                         Arrays.sort(types, compare);
 101                         _documentTypes = Arrays.asList(types);
 102                         res = SUCCESS;
 103                 }
 104
 105                 // Initialize isReviewable: if a type has review state or not
 106                 ValidationCycle cycle;
 107                 boolean hasReview;
 108                 for (DocumentType dtype : _documentTypes) {
 109                         cycle = getStudyService().getValidationCycleOf(
 110                                         _mystudy.getMystudy(), dtype);
 111                         hasReview = (cycle != null) && cycle.enables(ValidationStep.REVIEW);
 112                         _reviewable.add(hasReview);
 113                 }
 114                 return res;
 115         }
 116
 117         /**
 118          * Extract properties from the uploaded file.
 119          *
 120          * @param upfile
 121          *            the file to parse
 122          * @param filext
 123          *            the file extension
 124          * @return true if succeeded, false if error
 125          */
 126         private boolean extractProperties(final File upfile, final String filext) {
 127                 boolean isOk = true;
 128                 Reader tool = Toolbox.getReader(upfile);
 129                 if (tool == null) {
 130                         if ("pdf".equals(filext)) {
 131                                 _state = ProgressState.EXTERN; // TODO: Should external extensions be configurable ?
 132                         }
 133                 } else {
 134                         // String fileref = tool.extractProperty("reference");
 135                         // String filever = tool.extractProperty("version"); // Property kept even if the file is not referenced
 136                         // String filetype = tool.extractProperty("type"); // Property kept even if the file is not referenced
 137                         // for (Iterator<DocumentType> i = _documentTypes.iterator(); i
 138                         // .hasNext();) {
 139                         // DocumentType type = i.next();
 140                         // if (type.getName().equals(filetype)) {
 141                         // _deftype = type;
 142                         // _documentType = type.getIndex(); // Disables the document type field
 143                         // break;
 144                         // }
 145                         // }
 146                         // if (fileref != null) {
 147                         // isOk = findTypeByDocRef(fileref);
 148                         // }
 149                         // if (isOk) {
 150                         // if (filever != null) {
 151                         // try {
 152                         // Revision.Format get = new Revision.Format(
 153                         // getProjectSettings().getRevisionPattern());
 154                         // Revision version = get.parse(filever);
 155                         // if (version.isNull()) {
 156                         // throw new ParseException(filever,
 157                         // filever.length() - 1);
 158                         // }
 159                         // if (!version.isMinor()) {
 160                         // _state = ProgressState.inCHECK;
 161                         // }
 162                         // setVersion(version.toString());
 163                         // } catch (ParseException e) {
 164                         // setErrorCode("message.error.format.version");
 165                         // isOk = false;
 166                         // }
 167                         // }
 168                         // if (isOk) {
 169                         // _docname = tool.extractProperty("title"); // Property kept even if the file is not referenced
 170                         // isOk = extractDate(tool);
 171                         // }
 172                         // }
 173                 }
 174                 return isOk;
 175         }
 176
 177         /**
 178          * Find document type by document reference.
 179          *
 180          * @param fileref
 181          *            the document reference
 182          * @return true if succeeded, false if error
 183          */
 184         private boolean findTypeByDocRef(final String fileref) {
 185                 boolean isOk = true;
 186                 Document slot = getDocumentService().selectDocument(fileref,
 187                                 new Revision().toString());
 188                 if (slot == null) {
 189                         setError("message.error.reference.undefined");
 190                         isOk = false;
 191                 } else {
 192                         if (slot.isUndefined()) {
 193                                 _reference = fileref; // Disables document name and state fields
 194                                 _deftype = slot.getType(); // Just in case
 195                                 _documentType = _deftype.getIndex(); // Disables the document type field
 196                         } else {
 197                                 setError("message.error.reference.duplicate");
 198                                 isOk = false;
 199                         }
 200                 }
 201                 return isOk;
 202         }
 203
 204         /**
 205          * Perform import of a document.
 206          *
 207          * @return SUCCESS if ok, "cancel" - if canceled, ERROR - if error
 208          */
 209         public String doImport() {
 210                 String res = ERROR;
 211
 212                 initializationScreenContext(Constants.STUDY_MENU, Constants.STUDY_MENU,
 213                                 Constants.TRUE);
 214
 215                 if (_documentType == 0) {
 216                         setErrorCode("message.error.import.type");
 217
 218                         initializationFullScreenContext(Constants.STUDY_MENU,
 219                                         Constants.STUDY_MENU, Constants.TRUE, Constants.NONE,
 220                                         Constants.STUDY_MENU);
 221                 } else {
 222                         try {
 223                                 // Getting user inputs
 224                                 _mystudy = getOpenStudy();
 225                                 User user = getConnectedUser();
 226                                 Step step = _mystudy.getSelectedStep();
 227                                 Date aDate = null;
 228                                 if (getDocumentDate().length() > 0) {
 229                                         ResourceBundle locale = ResourceBundle.getBundle("som",
 230                                                         getApplicationSettings().getCurrentLocale());
 231                                         SimpleDateFormat get = new SimpleDateFormat(locale
 232                                                         .getString("date.format"), getApplicationSettings()
 233                                                         .getCurrentLocale());
 234                                         aDate = get.parse(getDocumentDate());
 235                                 }
 236                                 // Creation of uses relations
 237                                 List<Long> uses = new ArrayList<Long>();
 238                                 if (_docuses != null) {
 239                                         String[] list = _docuses.split(",");
 240                                         for (int i = 0; i < list.length; i++) {
 241                                                 uses.add(Long.valueOf(list[i].trim()));
 242                                         }
 243                                 }
 244                                 if (LOG.isDebugEnabled()) {
 245                                         LOG
 246                                                         .debug("Document to be imported uses documents with following ids:");
 247                                         for (Long usesId : uses) {
 248                                                 LOG.debug("#" + usesId);
 249                                         }
 250                                 }
 251                                 Publication addoc = getPublicationService().createDoc(
 252                                                 _mystudy.getIndex(), step, _documentType,
 253                                                 user.getIndex(), _fileName, _docname, _state,
 254                                                 _reference, getVersion(), aDate, uses);
 255
 256                                 if (_reference.length() > 0) { // Importation of a not foreign document
 257                                         _mystudy.updateSimulationContexts(); // In case of simulation contexts extracted from the imported document
 258                                 }
 259
 260                                 // Creation of derived the document formats
 261                                 // Document ndoc = addoc.value();
 262                                 // Converter send = getApplicationSettings().getConverter(ndoc.getType(), ndoc.getFormat());
 263                                 //
 264                                 // if (send != null) send.converts(addoc); // Asynchronous process
 265
 266                                 if (uses.isEmpty()) {
 267                                         _mystudy.add(addoc); // Updates the presentation
 268                                 } else {
 269                                         // Re-opening (refreshing) the currently open study
 270                                         refreshStudy();
 271                                 }
 272                                 res = SUCCESS;
 273                         } catch (FileNotFoundException error) {
 274                                 LOG.error("Reason:", error);
 275                                 setErrorCode("message.error.import.file");
 276                         } catch (Exception error) {
 277                                 LOG.error("Reason:", error);
 278                                 setErrorCode("message.error.internal");
 279                         }
 280
 281                         if (!SUCCESS.equals(res)) {
 282                                 initializationFullScreenContext(Constants.STUDY_MENU,
 283                                                 Constants.STUDY_MENU, Constants.TRUE, Constants.NONE,
 284                                                 Constants.STUDY_MENU);
 285                         }
 286                 }
 287
 288                 return res;
 289         }
 290
 291         // ==============================================================================================================================
 292         // Getters and setters
 293         // ==============================================================================================================================
 294
 295         /**
 296          * Get sorted list of document types valid for the selected study step.
 297          *
 298          * @return sorted list of document types
 299          */
 300         public List<DocumentType> getDocumentTypes() {
 301                 return _documentTypes;
 302         }
 303
 304         /**
 305          * Get document type id.
 306          *
 307          * @return document type id
 308          */
 309         public long getDocumentType() {
 310                 return _documentType;
 311         }
 312
 313         /**
 314          * Get reference extracted from the imported file, if exist.
 315          *
 316          * @return the document reference
 317          */
 318         public String getReference() {
 319                 return _reference;
 320         }
 321
 322         /**
 323          * Set document name entered by the user if enabled.
 324          *
 325          * @param name
 326          *            the document name
 327          */
 328         public void setDocumentName(final String name) {
 329                 this._docname = name; // Name entered by the user if enabled
 330         }
 331
 332         /**
 333          * Set the default title if no title was defined.
 334          *
 335          * @param name
 336          *            the default document title
 337          */
 338         public void setDocumentTitle(final String name) { // Called even if DocumentName is enabled
 339                 if (this._docname == null) {
 340                         this._docname = name;
 341                 }
 342         }
 343
 344         /**
 345          * Set document type id.
 346          *
 347          * @param value
 348          *            the id as string
 349          */
 350         public void setDocumentType(final Long value) {
 351                 this._documentType = value;
 352         }
 353
 354         /**
 355          * Set the default state if no state was selected.
 356          *
 357          * @param state
 358          *            the default state
 359          */
 360         public void setDefaultDocumentState(final String state) { // Called even if DocumentState is enabled
 361                 if (this._state == null) {
 362                         this._state = ProgressState.valueOf(state);
 363                 }
 364         }
 365
 366         /**
 367          * Set the default type if no type was selected.
 368          *
 369          * @param value
 370          *            the default document type id
 371          */
 372         public void setDefaultDocumentType(final Long value) { // Called even if DocumentType is enabled
 373                 if (this._documentType == 0) {
 374                         this._documentType = value;
 375                 }
 376         }
 377
 378         /**
 379          * Set document reference extracted from the imported file, if exist.
 380          *
 381          * @param value
 382          *            the reference
 383          */
 384         public void setReference(final String value) {
 385                 this._reference = value;
 386         }
 387
 388         /**
 389          * Get the documentService.
 390          *
 391          * @return the documentService
 392          */
 393         public DocumentService getDocumentService() {
 394                 return _documentService;
 395         }
 396
 397         /**
 398          * Set the documentService.
 399          *
 400          * @param documentService
 401          *            the documentService to set
 402          */
 403         public void setDocumentService(final DocumentService documentService) {
 404                 _documentService = documentService;
 405         }
 406
 407         /**
 408          * Get the documentTypeService.
 409          *
 410          * @return the documentTypeService
 411          */
 412         public DocumentTypeService getDocumentTypeService() {
 413                 return _documentTypeService;
 414         }
 415
 416         /**
 417          * Set the documentTypeService.
 418          *
 419          * @param documentTypeService
 420          *            the documentTypeService to set
 421          */
 422         public void setDocumentTypeService(
 423                         final DocumentTypeService documentTypeService) {
 424                 _documentTypeService = documentTypeService;
 425         }
 426
 427         /**
 428          * Get sorted list of available document states.
 429          *
 430          * @return the documentStates
 431          */
 432         public List<ProgressState> getDocumentStates() {
 433                 List<ProgressState> states = new ArrayList<ProgressState>();
 434                 states.add(ProgressState.inWORK);
 435                 states.add(ProgressState.inDRAFT);
 436                 states.add(ProgressState.EXTERN);
 437                 return states;
 438         }
 439
 440         /**
 441          * Get the isReviewable.
 442          *
 443          * @return the isReviewable
 444          */
 445         public List<Boolean> getReviewable() {
 446                 return _reviewable;
 447         }
 448 }