-
Notifications
You must be signed in to change notification settings - Fork 476
/
DatasetPage.java
5260 lines (4369 loc) · 206 KB
/
DatasetPage.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package edu.harvard.iq.dataverse;
import edu.harvard.iq.dataverse.provenance.ProvPopupFragmentBean;
import edu.harvard.iq.dataverse.api.AbstractApiBean;
import edu.harvard.iq.dataverse.authorization.AuthenticationServiceBean;
import edu.harvard.iq.dataverse.authorization.Permission;
import edu.harvard.iq.dataverse.authorization.providers.builtin.BuiltinUserServiceBean;
import edu.harvard.iq.dataverse.authorization.users.ApiToken;
import edu.harvard.iq.dataverse.authorization.users.AuthenticatedUser;
import edu.harvard.iq.dataverse.authorization.users.PrivateUrlUser;
import edu.harvard.iq.dataverse.authorization.users.User;
import edu.harvard.iq.dataverse.branding.BrandingUtil;
import edu.harvard.iq.dataverse.dataaccess.StorageIO;
import edu.harvard.iq.dataverse.dataaccess.ImageThumbConverter;
import edu.harvard.iq.dataverse.dataaccess.SwiftAccessIO;
import edu.harvard.iq.dataverse.datacapturemodule.DataCaptureModuleUtil;
import edu.harvard.iq.dataverse.datacapturemodule.ScriptRequestResponse;
import edu.harvard.iq.dataverse.dataset.DatasetThumbnail;
import edu.harvard.iq.dataverse.dataset.DatasetUtil;
import edu.harvard.iq.dataverse.datavariable.VariableServiceBean;
import edu.harvard.iq.dataverse.engine.command.Command;
import edu.harvard.iq.dataverse.engine.command.exception.CommandException;
import edu.harvard.iq.dataverse.engine.command.impl.CreatePrivateUrlCommand;
import edu.harvard.iq.dataverse.engine.command.impl.CuratePublishedDatasetVersionCommand;
import edu.harvard.iq.dataverse.engine.command.impl.DeaccessionDatasetVersionCommand;
import edu.harvard.iq.dataverse.engine.command.impl.DeleteDatasetVersionCommand;
import edu.harvard.iq.dataverse.engine.command.impl.DeletePrivateUrlCommand;
import edu.harvard.iq.dataverse.engine.command.impl.DestroyDatasetCommand;
import edu.harvard.iq.dataverse.engine.command.impl.GetPrivateUrlCommand;
import edu.harvard.iq.dataverse.engine.command.impl.LinkDatasetCommand;
import edu.harvard.iq.dataverse.engine.command.impl.PublishDatasetCommand;
import edu.harvard.iq.dataverse.engine.command.impl.PublishDataverseCommand;
import edu.harvard.iq.dataverse.engine.command.impl.UpdateDatasetVersionCommand;
import edu.harvard.iq.dataverse.export.ExportException;
import edu.harvard.iq.dataverse.export.ExportService;
import edu.harvard.iq.dataverse.export.spi.Exporter;
import edu.harvard.iq.dataverse.ingest.IngestRequest;
import edu.harvard.iq.dataverse.ingest.IngestServiceBean;
import edu.harvard.iq.dataverse.metadataimport.ForeignMetadataImportServiceBean;
import edu.harvard.iq.dataverse.privateurl.PrivateUrl;
import edu.harvard.iq.dataverse.privateurl.PrivateUrlServiceBean;
import edu.harvard.iq.dataverse.privateurl.PrivateUrlUtil;
import edu.harvard.iq.dataverse.search.SearchFilesServiceBean;
import edu.harvard.iq.dataverse.search.SortBy;
import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
import edu.harvard.iq.dataverse.util.ArchiverUtil;
import edu.harvard.iq.dataverse.util.BundleUtil;
import edu.harvard.iq.dataverse.util.FileSortFieldAndOrder;
import edu.harvard.iq.dataverse.util.FileUtil;
import edu.harvard.iq.dataverse.util.JsfHelper;
import static edu.harvard.iq.dataverse.util.JsfHelper.JH;
import edu.harvard.iq.dataverse.util.StringUtil;
import edu.harvard.iq.dataverse.util.SystemConfig;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.sql.Timestamp;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.Collection;
import java.util.logging.Logger;
import javax.ejb.EJB;
import javax.ejb.EJBException;
import javax.faces.application.FacesMessage;
import javax.faces.context.FacesContext;
import javax.faces.event.ActionEvent;
import javax.faces.event.ValueChangeEvent;
import javax.faces.view.ViewScoped;
import javax.inject.Inject;
import javax.inject.Named;
import org.primefaces.event.FileUploadEvent;
import org.primefaces.model.file.UploadedFile;
import javax.validation.ConstraintViolation;
import org.apache.commons.httpclient.HttpClient;
//import org.primefaces.context.RequestContext;
import java.util.Arrays;
import java.util.HashSet;
import javax.faces.model.SelectItem;
import java.util.logging.Level;
import edu.harvard.iq.dataverse.datasetutility.WorldMapPermissionHelper;
import edu.harvard.iq.dataverse.engine.command.exception.IllegalCommandException;
import edu.harvard.iq.dataverse.engine.command.impl.AbstractSubmitToArchiveCommand;
import edu.harvard.iq.dataverse.engine.command.impl.CreateNewDatasetCommand;
import edu.harvard.iq.dataverse.engine.command.impl.GetLatestPublishedDatasetVersionCommand;
import edu.harvard.iq.dataverse.engine.command.impl.RequestRsyncScriptCommand;
import edu.harvard.iq.dataverse.engine.command.impl.PublishDatasetResult;
import edu.harvard.iq.dataverse.engine.command.impl.RestrictFileCommand;
import edu.harvard.iq.dataverse.engine.command.impl.ReturnDatasetToAuthorCommand;
import edu.harvard.iq.dataverse.engine.command.impl.SubmitDatasetForReviewCommand;
import edu.harvard.iq.dataverse.externaltools.ExternalTool;
import edu.harvard.iq.dataverse.externaltools.ExternalToolServiceBean;
import edu.harvard.iq.dataverse.export.SchemaDotOrgExporter;
import edu.harvard.iq.dataverse.externaltools.ExternalToolHandler;
import edu.harvard.iq.dataverse.makedatacount.MakeDataCountLoggingServiceBean;
import edu.harvard.iq.dataverse.makedatacount.MakeDataCountLoggingServiceBean.MakeDataCountEntry;
import java.util.Collections;
import javax.faces.component.UIComponent;
import javax.faces.component.UIInput;
import javax.faces.event.AjaxBehaviorEvent;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.lang.StringEscapeUtils;
import org.apache.commons.io.IOUtils;
import org.primefaces.component.tabview.TabView;
import org.primefaces.event.CloseEvent;
import org.primefaces.event.TabChangeEvent;
import org.primefaces.event.data.PageEvent;
import edu.harvard.iq.dataverse.search.FacetLabel;
import edu.harvard.iq.dataverse.search.SearchConstants;
import edu.harvard.iq.dataverse.search.SearchFields;
import edu.harvard.iq.dataverse.search.SearchServiceBean;
import edu.harvard.iq.dataverse.search.SearchUtil;
import edu.harvard.iq.dataverse.search.SolrClientService;
import java.util.Comparator;
import org.apache.solr.client.solrj.SolrQuery;
import org.apache.solr.client.solrj.impl.HttpSolrClient;
import org.apache.solr.client.solrj.response.FacetField;
import org.apache.solr.client.solrj.response.QueryResponse;
import org.apache.solr.common.SolrDocument;
import org.apache.solr.common.SolrDocumentList;
import org.primefaces.PrimeFaces;
import org.primefaces.model.DefaultTreeNode;
import org.primefaces.model.TreeNode;
/**
*
* @author gdurand
*/
@ViewScoped
@Named("DatasetPage")
public class DatasetPage implements java.io.Serializable {
private static final Logger logger = Logger.getLogger(DatasetPage.class.getCanonicalName());
public enum EditMode {
CREATE, INFO, FILE, METADATA, LICENSE
};
public enum DisplayMode {
INIT, SAVE
};
@EJB
DatasetServiceBean datasetService;
@EJB
DatasetVersionServiceBean datasetVersionService;
@EJB
DataFileServiceBean datafileService;
@EJB
PermissionServiceBean permissionService;
@EJB
DataverseServiceBean dataverseService;
@EJB
DatasetFieldServiceBean fieldService;
@EJB
VariableServiceBean variableService;
@EJB
IngestServiceBean ingestService;
@EJB
ForeignMetadataImportServiceBean metadataImportService;
@EJB
EjbDataverseEngine commandEngine;
@Inject
DataverseSession session;
@EJB
UserNotificationServiceBean userNotificationService;
@EJB
MapLayerMetadataServiceBean mapLayerMetadataService;
@EJB
BuiltinUserServiceBean builtinUserService;
@EJB
DataverseFieldTypeInputLevelServiceBean dataverseFieldTypeInputLevelService;
@EJB
SettingsServiceBean settingsService;
@EJB
SearchServiceBean searchService;
@EJB
AuthenticationServiceBean authService;
@EJB
SystemConfig systemConfig;
@EJB
GuestbookResponseServiceBean guestbookResponseService;
@EJB
FileDownloadServiceBean fileDownloadService;
@EJB
DataverseLinkingServiceBean dvLinkingService;
@EJB
DatasetLinkingServiceBean dsLinkingService;
@EJB
SearchFilesServiceBean searchFilesService;
@EJB
DataverseRoleServiceBean dataverseRoleService;
@EJB
PrivateUrlServiceBean privateUrlService;
@EJB
ExternalToolServiceBean externalToolService;
@EJB
SolrClientService solrClientService;
@Inject
DataverseRequestServiceBean dvRequestService;
@Inject
DatasetVersionUI datasetVersionUI;
@Inject
PermissionsWrapper permissionsWrapper;
@Inject
FileDownloadHelper fileDownloadHelper;
@Inject
WorldMapPermissionHelper worldMapPermissionHelper;
@Inject
ThumbnailServiceWrapper thumbnailServiceWrapper;
@Inject
SettingsWrapper settingsWrapper;
@Inject
ProvPopupFragmentBean provPopupFragmentBean;
@Inject
MakeDataCountLoggingServiceBean mdcLogService;
@Inject DataverseHeaderFragment dataverseHeaderFragment;
private Dataset dataset = new Dataset();
private Long id = null;
private EditMode editMode;
private boolean bulkFileDeleteInProgress = false;
private Long ownerId;
private Long versionId;
private int selectedTabIndex;
private List<DataFile> newFiles = new ArrayList<>();
private DatasetVersion workingVersion;
private DatasetVersion clone;
private int releaseRadio = 1;
private int deaccessionRadio = 0;
private int deaccessionReasonRadio = 0;
private String datasetNextMajorVersion = "1.0";
private String datasetNextMinorVersion = "";
private String dropBoxSelection = "";
private String deaccessionReasonText = "";
private String displayCitation;
private String deaccessionForwardURLFor = "";
private String showVersionList = "false";
private List<Template> dataverseTemplates = new ArrayList<>();
private Template defaultTemplate;
private Template selectedTemplate;
/**
* In the file listing, the page the user is on. This is zero-indexed so if
* the user clicks page 2 in the UI, this will be 1.
*/
private int filePaginatorPage;
private int rowsPerPage;
private String persistentId;
private String version;
private String protocol = "";
private String authority = "";
private String customFields="";
private boolean noDVsAtAll = false;
private boolean noDVsRemaining = false;
private boolean stateChanged = false;
private Long linkingDataverseId;
private List<SelectItem> linkingDVSelectItems;
private Dataverse linkingDataverse;
// Version tab lists
private List<DatasetVersion> versionTabList = new ArrayList<>();
private List<DatasetVersion> versionTabListForPostLoad = new ArrayList<>();
// Used to store results of permissions checks
private final Map<String, Boolean> datasetPermissionMap = new HashMap<>(); // { Permission human_name : Boolean }
private DataFile selectedDownloadFile;
private Long maxFileUploadSizeInBytes = null;
private String dataverseSiteUrl = "";
private boolean removeUnusedTags;
private Boolean hasRsyncScript = false;
private Boolean hasTabular = false;
private boolean showIngestSuccess;
public boolean isShowIngestSuccess() {
return showIngestSuccess;
}
public void setShowIngestSuccess(boolean showIngestSuccess) {
this.showIngestSuccess = showIngestSuccess;
}
// TODO: Consider renaming "configureTools" to "fileConfigureTools".
List<ExternalTool> configureTools = new ArrayList<>();
// TODO: Consider renaming "exploreTools" to "fileExploreTools".
List<ExternalTool> exploreTools = new ArrayList<>();
// TODO: Consider renaming "configureToolsByFileId" to "fileConfigureToolsByFileId".
Map<Long, List<ExternalTool>> configureToolsByFileId = new HashMap<>();
// TODO: Consider renaming "exploreToolsByFileId" to "fileExploreToolsByFileId".
Map<Long, List<ExternalTool>> exploreToolsByFileId = new HashMap<>();
private List<ExternalTool> datasetExploreTools;
public Boolean isHasRsyncScript() {
return hasRsyncScript;
}
public void setHasRsyncScript(Boolean hasRsyncScript) {
this.hasRsyncScript = hasRsyncScript;
}
/**
* The contents of the script.
*/
private String rsyncScript = "";
public String getRsyncScript() {
return rsyncScript;
}
public void setRsyncScript(String rsyncScript) {
this.rsyncScript = rsyncScript;
}
private String rsyncScriptFilename;
public String getRsyncScriptFilename() {
return rsyncScriptFilename;
}
private String thumbnailString = null;
// This is the Dataset-level thumbnail;
// it's either the thumbnail of the designated datafile,
// or scaled down uploaded "logo" file, or randomly selected
// image datafile from this dataset.
public String getThumbnailString() {
// This method gets called 30 (!) times, just to load the page!
// - so let's cache that string the first time it's called.
if (thumbnailString != null) {
if ("".equals(thumbnailString)) {
return null;
}
return thumbnailString;
}
if (!readOnly) {
DatasetThumbnail datasetThumbnail = dataset.getDatasetThumbnail();
if (datasetThumbnail == null) {
thumbnailString = "";
return null;
}
if (datasetThumbnail.isFromDataFile()) {
if (!datasetThumbnail.getDataFile().equals(dataset.getThumbnailFile())) {
datasetService.assignDatasetThumbnailByNativeQuery(dataset, datasetThumbnail.getDataFile());
// refresh the dataset:
dataset = datasetService.find(dataset.getId());
}
}
thumbnailString = datasetThumbnail.getBase64image();
} else {
thumbnailString = thumbnailServiceWrapper.getDatasetCardImageAsBase64Url(dataset, workingVersion.getId(),!workingVersion.isDraft());
if (thumbnailString == null) {
thumbnailString = "";
return null;
}
}
return thumbnailString;
}
public void setThumbnailString(String thumbnailString) {
//Dummy method
}
public boolean isRemoveUnusedTags() {
return removeUnusedTags;
}
public void setRemoveUnusedTags(boolean removeUnusedTags) {
this.removeUnusedTags = removeUnusedTags;
}
private List<FileMetadata> fileMetadatas;
private String fileSortField;
private String fileSortOrder;
private LazyFileMetadataDataModel lazyModel;
public LazyFileMetadataDataModel getLazyModel() {
return lazyModel;
}
public void setLazyModel(LazyFileMetadataDataModel lazyModel) {
this.lazyModel = lazyModel;
}
public List<Entry<String,String>> getCartList() {
if (session.getUser() instanceof AuthenticatedUser) {
return ((AuthenticatedUser) session.getUser()).getCart().getContents();
}
return null;
}
public boolean checkCartForItem(String title, String persistentId) {
if (session.getUser() instanceof AuthenticatedUser) {
return ((AuthenticatedUser) session.getUser()).getCart().checkCartForItem(title, persistentId);
}
return false;
}
public void addItemtoCart(String title, String persistentId) throws Exception{
if (canComputeAllFiles(true)) {
if (session.getUser() instanceof AuthenticatedUser) {
AuthenticatedUser authUser = (AuthenticatedUser) session.getUser();
try {
authUser.getCart().addItem(title, persistentId);
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.compute.computeBatch.success"));
} catch (Exception ex){
JsfHelper.addErrorMessage(BundleUtil.getStringFromBundle("dataset.compute.computeBatch.failure"));
}
}
}
}
public void removeCartItem(String title, String persistentId) throws Exception {
if (session.getUser() instanceof AuthenticatedUser) {
AuthenticatedUser authUser = (AuthenticatedUser) session.getUser();
try {
authUser.getCart().removeItem(title, persistentId);
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.compute.computeBatch.success"));
} catch (Exception ex){
JsfHelper.addErrorMessage(BundleUtil.getStringFromBundle("dataset.compute.computeBatch.failure"));
}
}
}
public void clearCart() throws Exception {
if (session.getUser() instanceof AuthenticatedUser) {
AuthenticatedUser authUser = (AuthenticatedUser) session.getUser();
try {
authUser.getCart().clear();
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.compute.computeBatch.success"));
} catch (Exception ex){
JsfHelper.addErrorMessage(BundleUtil.getStringFromBundle("dataset.compute.computeBatch.failure"));
}
}
}
public boolean isCartEmpty() {
if (session.getUser() instanceof AuthenticatedUser) {
AuthenticatedUser authUser = (AuthenticatedUser) session.getUser();
return authUser.getCart().getContents().isEmpty();
}
return true;
}
public String getCartComputeUrl() {
if (session.getUser() instanceof AuthenticatedUser) {
AuthenticatedUser authUser = (AuthenticatedUser) session.getUser();
String url = settingsWrapper.getValueForKey(SettingsServiceBean.Key.ComputeBaseUrl);
if (url == null) {
return "";
}
// url indicates that you are computing with multiple datasets
url += "/multiparty?";
List<Entry<String,String>> contents = authUser.getCart().getContents();
for (Entry<String,String> entry : contents) {
String persistentIdUrl = entry.getValue();
url += persistentIdUrl + "&";
}
return url.substring(0, url.length() - 1);
}
return "";
}
private String fileLabelSearchTerm;
public String getFileLabelSearchTerm() {
return fileLabelSearchTerm;
}
public void setFileLabelSearchTerm(String fileLabelSearchTerm) {
if (fileLabelSearchTerm != null) {
this.fileLabelSearchTerm = fileLabelSearchTerm.trim();
} else {
this.fileLabelSearchTerm="";
}
}
private String fileTypeFacet;
public String getFileTypeFacet() {
return fileTypeFacet;
}
public void setFileTypeFacet(String fileTypeFacet) {
if (fileTypeFacet != null) {
this.fileTypeFacet = fileTypeFacet.trim();
}
}
private String fileAccessFacet;
public String getFileAccessFacet() {
return fileAccessFacet;
}
public void setFileAccessFacet(String fileAccessFacet) {
if (fileAccessFacet != null) {
this.fileAccessFacet = fileAccessFacet.trim();
}
}
private String fileTagsFacet;
public String getFileTagsFacet() {
return fileTagsFacet;
}
public void setFileTagsFacet(String fileTagsFacet) {
if (fileTagsFacet != null) {
this.fileTagsFacet = fileTagsFacet.trim();
}
}
private List<FileMetadata> fileMetadatasSearch;
public List<FileMetadata> getFileMetadatasSearch() {
return fileMetadatasSearch;
}
public void setFileMetadatasSearch(List<FileMetadata> fileMetadatasSearch) {
this.fileMetadatasSearch = fileMetadatasSearch;
}
public void updateFileSearch(){
logger.fine("updating file search list");
this.fileMetadatasSearch = selectFileMetadatasForDisplay();
}
private Long numberOfFilesToShow = (long) 25;
public Long getNumberOfFilesToShow() {
return numberOfFilesToShow;
}
public void setNumberOfFilesToShow(Long numberOfFilesToShow) {
this.numberOfFilesToShow = numberOfFilesToShow;
}
public void showAll(){
setNumberOfFilesToShow(new Long(fileMetadatasSearch.size()));
}
private List<FileMetadata> selectFileMetadatasForDisplay() {
Set<Long> searchResultsIdSet = null;
if (isIndexedVersion()) {
// We run the search even if no search term and/or facets are
// specified - to generate the facet labels list:
searchResultsIdSet = getFileIdsInVersionFromSolr(workingVersion.getId(), this.fileLabelSearchTerm);
// But, if no search terms were specified, we can immediately return the full
// list of the files in the version:
if (StringUtil.isEmpty(fileLabelSearchTerm)
&& StringUtil.isEmpty(fileTypeFacet)
&& StringUtil.isEmpty(fileAccessFacet)
&& StringUtil.isEmpty(fileTagsFacet)) {
if ((StringUtil.isEmpty(fileSortField) || fileSortField.equals("name")) && StringUtil.isEmpty(fileSortOrder)) {
return workingVersion.getFileMetadatasSorted();
} else {
searchResultsIdSet = null;
}
}
} else {
// No, this is not an indexed version.
// If the search term was specified, we'll run a search in the db;
// if not - return the full list of files in the version.
// (no facets without solr!)
if (StringUtil.isEmpty(this.fileLabelSearchTerm)) {
if ((StringUtil.isEmpty(fileSortField) || fileSortField.equals("name")) && StringUtil.isEmpty(fileSortOrder)) {
return workingVersion.getFileMetadatasSorted();
}
} else {
searchResultsIdSet = getFileIdsInVersionFromDb(workingVersion.getId(), this.fileLabelSearchTerm);
}
}
List<FileMetadata> retList = new ArrayList<>();
for (FileMetadata fileMetadata : workingVersion.getFileMetadatasSorted()) {
if (searchResultsIdSet == null || searchResultsIdSet.contains(fileMetadata.getDataFile().getId())) {
retList.add(fileMetadata);
}
}
if ((StringUtil.isEmpty(fileSortOrder) && !("name".equals(fileSortField)))
|| ("desc".equals(fileSortOrder) || !("name".equals(fileSortField)))) {
sortFileMetadatas(retList);
}
return retList;
}
private void sortFileMetadatas(List<FileMetadata> fileList) {
if ("name".equals(fileSortField) && "desc".equals(fileSortOrder)) {
Collections.sort(fileList, compareByLabelZtoA);
} else if ("date".equals(fileSortField)) {
if ("desc".equals(fileSortOrder)) {
Collections.sort(fileList, compareByOldest);
} else {
Collections.sort(fileList, compareByNewest);
}
} else if ("type".equals(fileSortField)) {
Collections.sort(fileList, compareByType);
} else if ("size".equals(fileSortField)) {
Collections.sort(fileList, compareBySize);
}
}
private Boolean isIndexedVersion = null;
public boolean isIndexedVersion() {
if (isIndexedVersion != null) {
return isIndexedVersion;
}
// The version is SUPPOSED to be indexed if it's the latest published version, or a
// draft. So if none of the above is true, we return false right away:
if (!(workingVersion.isDraft() || isThisLatestReleasedVersion())) {
return isIndexedVersion = false;
}
// ... but if it is the latest published version or a draft, we want to test
// and confirm that this version *has* actually been indexed and is searchable
// (and that solr is actually up and running!), by running a quick solr search:
return isIndexedVersion = isThisVersionSearchable();
}
/**
* Finds the list of numeric datafile ids in the Version specified, by running
* a database query.
*
* @param datasetVersionId numeric version id
* @param pattern string keyword
* @return set of numeric ids
*
*/
public Set<Long> getFileIdsInVersionFromDb(Long datasetVersionId, String pattern) {
logger.fine("searching for file ids, in the database");
List<Long> searchResultsIdList = datafileService.findDataFileIdsByDatasetVersionIdLabelSearchTerm(datasetVersionId, pattern, "", "");
Set<Long> ret = new HashSet<>();
for (Long id : searchResultsIdList) {
ret.add(id);
}
return ret;
}
private Map<String, List<FacetLabel>> facetLabelsMap;
public Map<String, List<FacetLabel>> getFacetLabelsMap() {
return facetLabelsMap;
}
public List<FacetLabel> getFileTypeFacetLabels() {
if (facetLabelsMap != null) {
return facetLabelsMap.get("fileTypeGroupFacet");
}
return null;
}
public List<FacetLabel> getFileAccessFacetLabels() {
if (facetLabelsMap != null) {
return facetLabelsMap.get("fileAccess");
}
return null;
}
public List<FacetLabel> getFileTagsFacetLabels() {
if (facetLabelsMap != null) {
return facetLabelsMap.get("fileTag");
}
return null;
}
/**
* Verifies that solr is running and that the version is indexed and searchable
* @return boolean
*/
public boolean isThisVersionSearchable() {
SolrQuery solrQuery = new SolrQuery();
solrQuery.setQuery(SearchUtil.constructQuery(SearchFields.ENTITY_ID, workingVersion.getDataset().getId().toString()));
solrQuery.addFilterQuery(SearchUtil.constructQuery(SearchFields.TYPE, SearchConstants.DATASETS));
solrQuery.addFilterQuery(SearchUtil.constructQuery(SearchFields.DATASET_VERSION_ID, workingVersion.getId().toString()));
logger.fine("Solr query (testing if searchable): " + solrQuery);
QueryResponse queryResponse = null;
try {
queryResponse = solrClientService.getSolrClient().query(solrQuery);
} catch (Exception ex) {
logger.fine("Solr exception: " + ex.getLocalizedMessage());
// solr maybe down/some error may have occurred...
return false;
}
SolrDocumentList docs = queryResponse.getResults();
Iterator<SolrDocument> iter = docs.iterator();
// there should be only 1 result, really...
while (iter.hasNext()) {
SolrDocument solrDocument = iter.next();
Long entityid = (Long) solrDocument.getFieldValue(SearchFields.ENTITY_ID);
logger.fine("solr result id: "+entityid);
if (entityid.equals(workingVersion.getDataset().getId())) {
return true;
}
}
return false;
}
/**
* Finds the list of numeric datafile ids in the Version specified, by running
* a direct solr search query.
*
* @param datasetVersionId numeric version id
* @param pattern string keyword
* @return set of numeric ids
*
*/
public Set<Long> getFileIdsInVersionFromSolr(Long datasetVersionId, String pattern) {
logger.fine("searching for file ids, in solr");
SolrQuery solrQuery = new SolrQuery();
List<String> queryStrings = new ArrayList<>();
// Main query:
if (!StringUtil.isEmpty(pattern)) {
// searching on the file name ("label") and description:
queryStrings.add(SearchUtil.constructQuery(SearchFields.FILE_NAME, pattern + "*"));
queryStrings.add(SearchUtil.constructQuery(SearchFields.FILE_DESCRIPTION, pattern + "*"));
solrQuery.setQuery(SearchUtil.constructQuery(queryStrings, false));
} else {
// ... or "everything", if no search pattern is supplied:
// (presumably, one or more facet fields is supplied, below)
solrQuery.setQuery("*");
}
// ask for facets:
solrQuery.setParam("facet", "true");
/**
* @todo: do we need facet.query?
*/
solrQuery.setParam("facet.query", "*");
solrQuery.addFacetField(SearchFields.FILE_TYPE);
solrQuery.addFacetField(SearchFields.ACCESS);
solrQuery.addFacetField(SearchFields.FILE_TAG);
// Extra filter queries from the facets, if specified:
if (!StringUtil.isEmpty(fileTypeFacet)) {
solrQuery.addFilterQuery(SearchFields.FILE_TYPE + ":" + fileTypeFacet);
}
if (!StringUtil.isEmpty(fileAccessFacet)) {
solrQuery.addFilterQuery(SearchFields.ACCESS + ":" + fileAccessFacet);
}
if (!StringUtil.isEmpty(fileTagsFacet)) {
solrQuery.addFilterQuery(SearchFields.FILE_TAG + ":" + fileTagsFacet);
}
// Additional filter queries, to restrict the results to files in this version only:
solrQuery.addFilterQuery(SearchFields.TYPE + ":" + SearchConstants.FILES);
if (!workingVersion.isDraft()) {
solrQuery.addFilterQuery(SearchFields.DATASET_VERSION_ID + ":" + datasetVersionId);
} else {
// To avoid indexing duplicate solr documents, we don't index ALL of the files
// in a draft version - only the new files added to the draft and/or the
// files for which the metadata have been changed.
// So, in order to find all the files in the draft version, we can't just
// run a query with the dataset version id, like with the published version,
// above. Instead we are searching for all the indexed files in the dataset,
// except the ones indexed with the "fileDeleted" flag - that indicates that
// they are no longer in the draft:
solrQuery.addFilterQuery(SearchFields.PARENT_ID + ":" + workingVersion.getDataset().getId());
// Note that we don't want to use the query "fileDeleted: false" - that
// would only find the documents in which the fileDeleted boolean field
// is actually present, AND set to false. Instead we are searching with
// "!(fileDeleted: true)" - that will find ALL the records, except for
// the ones where the value is explicitly set to true.
solrQuery.addFilterQuery("!(" + SearchFields.FILE_DELETED + ":" + true + ")");
}
// Unlimited number of search results:
// (but we are searching within one dataset(version), so it should be manageable)
solrQuery.setRows(Integer.MAX_VALUE);
logger.fine("Solr query (file search): " + solrQuery);
QueryResponse queryResponse = null;
boolean fileDeletedFlagNotIndexed = false;
Set<Long> resultIds = new HashSet<>();
try {
queryResponse = solrClientService.getSolrClient().query(solrQuery);
} catch (HttpSolrClient.RemoteSolrException ex) {
logger.fine("Remote Solr Exception: " + ex.getLocalizedMessage());
String msg = ex.getLocalizedMessage();
if (msg.contains(SearchFields.FILE_DELETED)) {
fileDeletedFlagNotIndexed = true;
}
} catch (Exception ex) {
logger.warning("Solr exception: " + ex.getLocalizedMessage());
return resultIds;
}
if (fileDeletedFlagNotIndexed) {
// try again, without the flag:
solrQuery.removeFilterQuery("!(" + SearchFields.FILE_DELETED + ":" + true + ")");
logger.fine("Solr query (trying again): " + solrQuery);
try {
queryResponse = solrClientService.getSolrClient().query(solrQuery);
} catch (Exception ex) {
logger.warning("Caught a Solr exception (again!): " + ex.getLocalizedMessage());
return resultIds;
}
}
// Process the facets:
facetLabelsMap = new HashMap<>();
for (FacetField facetField : queryResponse.getFacetFields()) {
List<FacetLabel> facetLabelList = new ArrayList<>();
int count = 0;
for (FacetField.Count facetFieldCount : facetField.getValues()) {
logger.fine("facet field value: " + facetField.getName() + " " + facetFieldCount.getName() + " (" + facetFieldCount.getCount() + ")");
if (facetFieldCount.getCount() > 0) {
FacetLabel facetLabel = new FacetLabel(facetFieldCount.getName(), facetFieldCount.getCount());
// quote facets arguments, just in case:
facetLabel.setFilterQuery(facetField.getName() + ":\"" + facetFieldCount.getName() + "\"");
facetLabelList.add(facetLabel);
count += facetFieldCount.getCount();
}
}
if (count > 0) {
facetLabelsMap.put(facetField.getName(), facetLabelList);
}
}
SolrDocumentList docs = queryResponse.getResults();
Iterator<SolrDocument> iter = docs.iterator();
while (iter.hasNext()) {
SolrDocument solrDocument = iter.next();
Long entityid = (Long) solrDocument.getFieldValue(SearchFields.ENTITY_ID);
logger.fine("solr result id: "+entityid);
resultIds.add(entityid);
}
return resultIds;
}
/*
Save the setting locally so db isn't hit repeatedly
This may be "null", signifying unlimited download size
*/
public Long getMaxFileUploadSizeInBytes(){
return this.maxFileUploadSizeInBytes;
}
public boolean isUnlimitedUploadFileSize(){
if (this.maxFileUploadSizeInBytes == null){
return true;
}
return false;
}
public String getDataverseSiteUrl() {
return this.dataverseSiteUrl;
}
public void setDataverseSiteUrl(String dataverseSiteUrl) {
this.dataverseSiteUrl = dataverseSiteUrl;
}
public DataFile getInitialDataFile() {
if (workingVersion.getFileMetadatas() != null && workingVersion.getFileMetadatas().size() > 0) {
return workingVersion.getFileMetadatas().get(0).getDataFile();
}
return null;
}
public SwiftAccessIO getSwiftObject() {
try {
StorageIO<DataFile> storageIO = getInitialDataFile() == null ? null : getInitialDataFile().getStorageIO();
if (storageIO != null && storageIO instanceof SwiftAccessIO) {
return (SwiftAccessIO)storageIO;
} else {
logger.fine("DatasetPage: Failed to cast storageIO as SwiftAccessIO (most likely because storageIO is a FileAccessIO)");
}
} catch (IOException e) {
logger.fine("DatasetPage: Failed to get storageIO");
}
return null;
}
public String getSwiftContainerName() throws IOException {
SwiftAccessIO swiftObject = getSwiftObject();
try {
swiftObject.open();
return swiftObject.getSwiftContainerName();
} catch (Exception e){
logger.info("DatasetPage: Failed to open swift object");
}
return "";
}
public void setSwiftContainerName(String name){
}
//This function applies to an entire dataset
private boolean isSwiftStorage() {
//containers without datafiles will not be stored in swift storage
if (getInitialDataFile() != null){
for (FileMetadata fmd : workingVersion.getFileMetadatas()) {
//if any of the datafiles are stored in swift
if (fmd.getDataFile().getStorageIdentifier().startsWith("swift://")) {
return true;
}
}
}
return false;
}
//This function applies to a single datafile
private boolean isSwiftStorage(FileMetadata metadata){
if (metadata.getDataFile().getStorageIdentifier().startsWith("swift://")) {
return true;
}
return false;
}
private Boolean showComputeButtonForDataset = null;