1370

Committed 26 Jun 2024 06:59AM UTC coverage: 25.503% (-0.004%) from 25.507%

Build # 1370

Build Type

push

jenkins

Committed by

web-flow

Commit Message

Closes #2496: Make the banner link optional (#2503)

Run Details

17782 of 69725 relevant lines covered (25.5%)

0.26 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

1.11

/dataverse-webapp/src/main/java/edu/harvard/iq/dataverse/datafile/page/FileDownloadHelper.java

/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */
package edu.harvard.iq.dataverse.datafile.page;

import edu.harvard.iq.dataverse.DataverseSession;
import edu.harvard.iq.dataverse.PermissionsWrapper;
import edu.harvard.iq.dataverse.datafile.FileDownloadServiceBean;
import edu.harvard.iq.dataverse.guestbook.GuestbookResponseServiceBean;
import edu.harvard.iq.dataverse.persistence.datafile.DataFile;
import edu.harvard.iq.dataverse.persistence.datafile.ExternalTool;
import edu.harvard.iq.dataverse.persistence.datafile.FileMetadata;
import edu.harvard.iq.dataverse.persistence.datafile.license.FileTermsOfUse.TermsOfUseType;
import edu.harvard.iq.dataverse.persistence.dataset.DatasetVersion;
import edu.harvard.iq.dataverse.persistence.guestbook.GuestbookResponse;
import edu.harvard.iq.dataverse.util.FileUtil;
import edu.harvard.iq.dataverse.util.PrimefacesUtil;
import org.apache.commons.lang3.StringUtils;
import org.omnifaces.cdi.ViewScoped;
import org.primefaces.PrimeFaces;

import javax.inject.Inject;
import javax.inject.Named;
import java.util.List;
import java.util.logging.Logger;

import static java.util.stream.Collectors.toList;

/**
 * Class joining downloads and guestbook response writing on UI
 * <p>
 * Note that following dialogs must be defined on page for proper functioning:
 * <ul>
 * <li>downloadPopup</li>
 * <li>downloadPackagePopup</li>
 * </ul>
 *
 * @author skraffmi
 */
@ViewScoped
@Named
public class FileDownloadHelper implements java.io.Serializable {

    private static final Logger logger = Logger.getLogger(FileDownloadHelper.class.getCanonicalName());

    private DataverseSession session;

    private PermissionsWrapper permissionsWrapper;

    private FileDownloadServiceBean fileDownloadService;

    private GuestbookResponseServiceBean guestbookResponseService;

    private RequestedDownloadType requestedDownloadType;

    // -------------------- CONSTRUCTORS --------------------

    @Deprecated
    public FileDownloadHelper() {

    }

    @Inject
    public FileDownloadHelper(DataverseSession session, PermissionsWrapper permissionsWrapper,
                              FileDownloadServiceBean fileDownloadService, GuestbookResponseServiceBean guestbookResponseService,
                              RequestedDownloadType requestedDownloadType) {
        this.session = session;
        this.permissionsWrapper = permissionsWrapper;
        this.fileDownloadService = fileDownloadService;
        this.guestbookResponseService = guestbookResponseService;
        this.requestedDownloadType = requestedDownloadType;
    }

    // -------------------- LOGIC --------------------

    /**
     * Writes guestbook response and start download
     *
     * @param userProvidedGuestbookResponse - guestbook response with values
     * that should be provided by user (already validated) (that is name, email, custom question responses, etc.)
     */
    public void writeGuestbookAndStartDownloadAccordingToType(GuestbookResponse userProvidedGuestbookResponse) {

        DownloadType fileFormat = requestedDownloadType.getFileFormat();
        List<FileMetadata> fileMetadatas = requestedDownloadType.getFileMetadatas();

        userProvidedGuestbookResponse.setDownloadtype(buildGuestbookResponseDownloadType(fileFormat, requestedDownloadType.getTool()));

        for (FileMetadata fileMetadata : fileMetadatas) {
            DataFile dataFile = fileMetadata.getDataFile();

            if (dataFile.isReleased()) {
                userProvidedGuestbookResponse.setDataFile(fileMetadata.getDataFile());
                fileDownloadService.writeGuestbookResponseRecord(userProvidedGuestbookResponse);
            }
        }

        startDownloadAccordingToType(fileMetadatas, fileFormat, requestedDownloadType.getTool(), true);
    }

    public void writeGuestbookResponseForPreview(GuestbookResponse guestbookResponse, FileMetadata fileMetadata, ExternalTool previewer) {
        guestbookResponse.setDownloadtype(buildGuestbookResponseDownloadType(DownloadType.PREVIEW, previewer));
        DataFile dataFile = fileMetadata.getDataFile();
        if (dataFile.isReleased()) {
            guestbookResponse.setDataFile(dataFile);
            fileDownloadService.writeGuestbookResponseRecord(guestbookResponse);
        }
    }

    /**
     * Initializes {@link RequestedDownloadType} object and start
     * downloading process using {@link #requestDownload()}.
     *
     * @param fileMetadatas - files to download
     * @param requestedOriginalDownload - true if should download original format of files
     * or false for default download
     */
    public void requestDownloadWithFiles(List<FileMetadata> fileMetadatas, boolean requestedOriginalDownload) {

        if (requestedOriginalDownload) {
            requestedDownloadType.initMultiOriginalDownloadType(fileMetadatas);
        } else {
            requestedDownloadType.initMultiDownloadType(fileMetadatas);
        }

        requestDownload();
    }

    public String requestDownloadOfWholeDataset(DatasetVersion dsv, boolean requestedOriginalDownload) {

        DownloadType downloadType = requestedOriginalDownload ? DownloadType.ORIGINAL : DownloadType.DOWNLOAD;

        String filesDownloadUrl = FileUtil.getDownloadWholeDatasetUrlPath(dsv, false, downloadType.getApiBatchDownloadEquivalent());
        PrimeFaces.current().ajax().addCallbackParam("apiDownloadLink", filesDownloadUrl);

        return StringUtils.EMPTY;
    }

    public void requestDownloadOfWholeDatasetAsCSV(DatasetVersion dsv) {
        PrimeFaces.current().ajax().addCallbackParam("apiDownloadLink", FileUtil.getDownloadWholeDatasetAsCSVUrlPath(dsv));
    }

    /**
     * Starts downloading process according on values stored in {@link RequestedDownloadType}.
     * <p>
     * If guestbook fill is required then it shows proper dialog or handles download
     * directly otherwise.
     */
    public String requestDownload() {

        List<FileMetadata> fileMetadatas = requestedDownloadType.getFileMetadatas();
        DownloadType fileFormat = requestedDownloadType.getFileFormat();

        if (FileUtil.isDownloadPopupRequired(fileMetadatas.get(0).getDatasetVersion())) {
            PrimefacesUtil.showDialog("downloadPopup");
            return StringUtils.EMPTY;
        }

        startDownloadAccordingToType(fileMetadatas, fileFormat, requestedDownloadType.getTool(), false);
        return StringUtils.EMPTY;
    }

    public boolean canUserDownloadFile(FileMetadata fileMetadata) {
        if (fileMetadata == null) {
            return false;
        }

        if ((fileMetadata.getId() == null) || (fileMetadata.getDataFile().getId() == null)) {
            return false;
        }

        if (fileMetadata.getDatasetVersion().isDeaccessioned()) {
            return permissionsWrapper.canCurrentUserUpdateDataset(fileMetadata.getDatasetVersion().getDataset());
        }


        boolean isRestrictedFile = fileMetadata.getTermsOfUse().getTermsOfUseType() == TermsOfUseType.RESTRICTED;
        if (!isRestrictedFile) {
            return true;
        }

        // See if the DataverseRequest, which contains IP Groups, has permission to download the file.
        if (permissionsWrapper.hasDownloadFilePermission(fileMetadata.getDataFile())) {
            logger.fine("The DataverseRequest (User plus IP address) has access to download the file.");
            return true;
        }

        return false;
    }


    // -------------------- PRIVATE --------------------

    private void startDownloadAccordingToType(List<FileMetadata> fileMetadatas, DownloadType fileFormat, ExternalTool tool, boolean guestbookRecordsAlreadyWritten) {
        if (fileMetadatas.size() > 1) {
            String filesDownloadUrl = FileUtil.getBatchFilesDownloadUrlPath(
                    fileMetadatas.stream().map(x -> x.getDataFile().getId()).collect(toList()), guestbookRecordsAlreadyWritten,
                    fileFormat.getApiBatchDownloadEquivalent());
            PrimeFaces.current().ajax().addCallbackParam("apiDownloadLink", filesDownloadUrl);

            return;
        }

        DataFile dataFile = fileMetadatas.get(0).getDataFile();

        if (fileFormat.isCompatibleWithApiDownload()) {
            String fileDownloadUrl = FileUtil.getFileDownloadUrlPath(
                        fileFormat.getApiDownloadEquivalent(),
                        dataFile.getId(),
                        guestbookRecordsAlreadyWritten);
            PrimeFaces.current().ajax().addCallbackParam("apiDownloadLink", fileDownloadUrl);

        } else if (fileFormat == DownloadType.WORLDMAP) {
            writeGuestbookResponseIfReleased(dataFile, DownloadType.WORLDMAP, null, guestbookRecordsAlreadyWritten);
            fileDownloadService.startWorldMapDownloadLink(dataFile);

        } else if (fileFormat == DownloadType.EXTERNALTOOL) {
            writeGuestbookResponseIfReleased(dataFile, DownloadType.EXTERNALTOOL, tool, guestbookRecordsAlreadyWritten);
            fileDownloadService.explore(dataFile, tool);

        } else if (fileFormat == DownloadType.PACKAGE) {
            PrimefacesUtil.showDialogAndResize("downloadPackagePopup");
        }
    }

    private void writeGuestbookResponseIfReleased(DataFile dataFile, DownloadType fileFormat, ExternalTool tool, boolean guestbookRecordsAlreadyWritten) {
        if (!guestbookRecordsAlreadyWritten && dataFile.isReleased()) {

            GuestbookResponse downloadOnlyGuestbook = guestbookResponseService.initUIGuestbookResponseWithoutFile(
                    dataFile.getOwner(), session);
            downloadOnlyGuestbook.setDownloadtype(buildGuestbookResponseDownloadType(fileFormat, tool));
            downloadOnlyGuestbook.setDataFile(dataFile);
            fileDownloadService.writeGuestbookResponseRecord(downloadOnlyGuestbook);
        }
    }

    private String buildGuestbookResponseDownloadType(DownloadType fileFormat, ExternalTool tool) {
        switch (fileFormat) {
            case WORLDMAP:
                return "WorldMap";
            case EXTERNALTOOL:
            case PREVIEW:
                return tool.getDisplayName();
            default:
                return "Download";
        }
    }
}

1	/*
2	* To change this license header, choose License Headers in Project Properties.
3	* To change this template file, choose Tools \| Templates
4	* and open the template in the editor.
5	*/
6	package edu.harvard.iq.dataverse.datafile.page;
7
8	import edu.harvard.iq.dataverse.DataverseSession;
9	import edu.harvard.iq.dataverse.PermissionsWrapper;
10	import edu.harvard.iq.dataverse.datafile.FileDownloadServiceBean;
11	import edu.harvard.iq.dataverse.guestbook.GuestbookResponseServiceBean;
12	import edu.harvard.iq.dataverse.persistence.datafile.DataFile;
13	import edu.harvard.iq.dataverse.persistence.datafile.ExternalTool;
14	import edu.harvard.iq.dataverse.persistence.datafile.FileMetadata;
15	import edu.harvard.iq.dataverse.persistence.datafile.license.FileTermsOfUse.TermsOfUseType;
16	import edu.harvard.iq.dataverse.persistence.dataset.DatasetVersion;
17	import edu.harvard.iq.dataverse.persistence.guestbook.GuestbookResponse;
18	import edu.harvard.iq.dataverse.util.FileUtil;
19	import edu.harvard.iq.dataverse.util.PrimefacesUtil;
20	import org.apache.commons.lang3.StringUtils;
21	import org.omnifaces.cdi.ViewScoped;
22	import org.primefaces.PrimeFaces;
23
24	import javax.inject.Inject;
25	import javax.inject.Named;
26	import java.util.List;
27	import java.util.logging.Logger;
28
29	import static java.util.stream.Collectors.toList;
30
31	/**
32	* Class joining downloads and guestbook response writing on UI
33	* <p>
34	* Note that following dialogs must be defined on page for proper functioning:
35	* <ul>
36	* <li>downloadPopup</li>
37	* <li>downloadPackagePopup</li>
38	* </ul>
39	*
40	* @author skraffmi
41	*/
42	@ViewScoped
43	@Named
44	public class FileDownloadHelper implements java.io.Serializable {
45
46	private static final Logger logger = Logger.getLogger(FileDownloadHelper.class.getCanonicalName());	1✔
47
48	private DataverseSession session;
49
50	private PermissionsWrapper permissionsWrapper;
51
52	private FileDownloadServiceBean fileDownloadService;
53
54	private GuestbookResponseServiceBean guestbookResponseService;
55
56	private RequestedDownloadType requestedDownloadType;
57
58	// -------------------- CONSTRUCTORS --------------------
59
60	@Deprecated
61	public FileDownloadHelper() {	×
62
63	}	×
64
65	@Inject
66	public FileDownloadHelper(DataverseSession session, PermissionsWrapper permissionsWrapper,
67	FileDownloadServiceBean fileDownloadService, GuestbookResponseServiceBean guestbookResponseService,
68	RequestedDownloadType requestedDownloadType) {	×
69	this.session = session;	×
70	this.permissionsWrapper = permissionsWrapper;	×
71	this.fileDownloadService = fileDownloadService;	×
72	this.guestbookResponseService = guestbookResponseService;	×
73	this.requestedDownloadType = requestedDownloadType;	×
74	}	×
75
76	// -------------------- LOGIC --------------------
77
78	/**
79	* Writes guestbook response and start download
80	*
81	* @param userProvidedGuestbookResponse - guestbook response with values
82	* that should be provided by user (already validated) (that is name, email, custom question responses, etc.)
83	*/
84	public void writeGuestbookAndStartDownloadAccordingToType(GuestbookResponse userProvidedGuestbookResponse) {
85
86	DownloadType fileFormat = requestedDownloadType.getFileFormat();	×
87	List<FileMetadata> fileMetadatas = requestedDownloadType.getFileMetadatas();	×
88
89	userProvidedGuestbookResponse.setDownloadtype(buildGuestbookResponseDownloadType(fileFormat, requestedDownloadType.getTool()));	×
90
91	for (FileMetadata fileMetadata : fileMetadatas) {	×
92	DataFile dataFile = fileMetadata.getDataFile();	×
93
94	if (dataFile.isReleased()) {	×
95	userProvidedGuestbookResponse.setDataFile(fileMetadata.getDataFile());	×
96	fileDownloadService.writeGuestbookResponseRecord(userProvidedGuestbookResponse);	×
97	}
98	}	×
99
100	startDownloadAccordingToType(fileMetadatas, fileFormat, requestedDownloadType.getTool(), true);	×
101	}	×
102
103	public void writeGuestbookResponseForPreview(GuestbookResponse guestbookResponse, FileMetadata fileMetadata, ExternalTool previewer) {
104	guestbookResponse.setDownloadtype(buildGuestbookResponseDownloadType(DownloadType.PREVIEW, previewer));	×
105	DataFile dataFile = fileMetadata.getDataFile();	×
106	if (dataFile.isReleased()) {	×
107	guestbookResponse.setDataFile(dataFile);	×
108	fileDownloadService.writeGuestbookResponseRecord(guestbookResponse);	×
109	}
110	}	×
111
112	/**
113	* Initializes {@link RequestedDownloadType} object and start
114	* downloading process using {@link #requestDownload()}.
115	*
116	* @param fileMetadatas - files to download
117	* @param requestedOriginalDownload - true if should download original format of files
118	* or false for default download
119	*/
120	public void requestDownloadWithFiles(List<FileMetadata> fileMetadatas, boolean requestedOriginalDownload) {
121
122	if (requestedOriginalDownload) {	×
123	requestedDownloadType.initMultiOriginalDownloadType(fileMetadatas);	×
124	} else {
125	requestedDownloadType.initMultiDownloadType(fileMetadatas);	×
126	}
127
128	requestDownload();	×
129	}	×
130
131	public String requestDownloadOfWholeDataset(DatasetVersion dsv, boolean requestedOriginalDownload) {
132
133	DownloadType downloadType = requestedOriginalDownload ? DownloadType.ORIGINAL : DownloadType.DOWNLOAD;	×
134
135	String filesDownloadUrl = FileUtil.getDownloadWholeDatasetUrlPath(dsv, false, downloadType.getApiBatchDownloadEquivalent());	×
136	PrimeFaces.current().ajax().addCallbackParam("apiDownloadLink", filesDownloadUrl);	×
137
138	return StringUtils.EMPTY;	×
139	}
140
141	public void requestDownloadOfWholeDatasetAsCSV(DatasetVersion dsv) {
142	PrimeFaces.current().ajax().addCallbackParam("apiDownloadLink", FileUtil.getDownloadWholeDatasetAsCSVUrlPath(dsv));	×
143	}	×
144
145	/**
146	* Starts downloading process according on values stored in {@link RequestedDownloadType}.
147	* <p>
148	* If guestbook fill is required then it shows proper dialog or handles download
149	* directly otherwise.
150	*/
151	public String requestDownload() {
152
153	List<FileMetadata> fileMetadatas = requestedDownloadType.getFileMetadatas();	×
154	DownloadType fileFormat = requestedDownloadType.getFileFormat();	×
155
156	if (FileUtil.isDownloadPopupRequired(fileMetadatas.get(0).getDatasetVersion())) {	×
157	PrimefacesUtil.showDialog("downloadPopup");	×
158	return StringUtils.EMPTY;	×
159	}
160
161	startDownloadAccordingToType(fileMetadatas, fileFormat, requestedDownloadType.getTool(), false);	×
162	return StringUtils.EMPTY;	×
163	}
164
165	public boolean canUserDownloadFile(FileMetadata fileMetadata) {
166	if (fileMetadata == null) {	×
167	return false;	×
168	}
169
170	if ((fileMetadata.getId() == null) \|\| (fileMetadata.getDataFile().getId() == null)) {	×
171	return false;	×
172	}
173
174	if (fileMetadata.getDatasetVersion().isDeaccessioned()) {	×
175	return permissionsWrapper.canCurrentUserUpdateDataset(fileMetadata.getDatasetVersion().getDataset());	×
176	}
177
178
179	boolean isRestrictedFile = fileMetadata.getTermsOfUse().getTermsOfUseType() == TermsOfUseType.RESTRICTED;	×
180	if (!isRestrictedFile) {	×
181	return true;	×
182	}
183
184	// See if the DataverseRequest, which contains IP Groups, has permission to download the file.
185	if (permissionsWrapper.hasDownloadFilePermission(fileMetadata.getDataFile())) {	×
186	logger.fine("The DataverseRequest (User plus IP address) has access to download the file.");	×
187	return true;	×
188	}
189
190	return false;	×
191	}
192
193
194	// -------------------- PRIVATE --------------------
195
196	private void startDownloadAccordingToType(List<FileMetadata> fileMetadatas, DownloadType fileFormat, ExternalTool tool, boolean guestbookRecordsAlreadyWritten) {
197	if (fileMetadatas.size() > 1) {	×
198	String filesDownloadUrl = FileUtil.getBatchFilesDownloadUrlPath(	×
199	fileMetadatas.stream().map(x -> x.getDataFile().getId()).collect(toList()), guestbookRecordsAlreadyWritten,	×
200	fileFormat.getApiBatchDownloadEquivalent());	×
201	PrimeFaces.current().ajax().addCallbackParam("apiDownloadLink", filesDownloadUrl);	×
202
203	return;	×
204	}
205
206	DataFile dataFile = fileMetadatas.get(0).getDataFile();	×
207
208	if (fileFormat.isCompatibleWithApiDownload()) {	×
209	String fileDownloadUrl = FileUtil.getFileDownloadUrlPath(	×
210	fileFormat.getApiDownloadEquivalent(),	×
211	dataFile.getId(),	×
212	guestbookRecordsAlreadyWritten);
213	PrimeFaces.current().ajax().addCallbackParam("apiDownloadLink", fileDownloadUrl);	×
214
215	} else if (fileFormat == DownloadType.WORLDMAP) {	×
216	writeGuestbookResponseIfReleased(dataFile, DownloadType.WORLDMAP, null, guestbookRecordsAlreadyWritten);	×
217	fileDownloadService.startWorldMapDownloadLink(dataFile);	×
218
219	} else if (fileFormat == DownloadType.EXTERNALTOOL) {	×
220	writeGuestbookResponseIfReleased(dataFile, DownloadType.EXTERNALTOOL, tool, guestbookRecordsAlreadyWritten);	×
221	fileDownloadService.explore(dataFile, tool);	×
222
223	} else if (fileFormat == DownloadType.PACKAGE) {	×
224	PrimefacesUtil.showDialogAndResize("downloadPackagePopup");	×
225	}
226	}	×
227
228	private void writeGuestbookResponseIfReleased(DataFile dataFile, DownloadType fileFormat, ExternalTool tool, boolean guestbookRecordsAlreadyWritten) {
229	if (!guestbookRecordsAlreadyWritten && dataFile.isReleased()) {	×
230
231	GuestbookResponse downloadOnlyGuestbook = guestbookResponseService.initUIGuestbookResponseWithoutFile(	×
232	dataFile.getOwner(), session);	×
233	downloadOnlyGuestbook.setDownloadtype(buildGuestbookResponseDownloadType(fileFormat, tool));	×
234	downloadOnlyGuestbook.setDataFile(dataFile);	×
235	fileDownloadService.writeGuestbookResponseRecord(downloadOnlyGuestbook);	×
236	}
237	}	×
238
239	private String buildGuestbookResponseDownloadType(DownloadType fileFormat, ExternalTool tool) {
240	switch (fileFormat) {	×
241	case WORLDMAP:
242	return "WorldMap";	×
243	case EXTERNALTOOL:
244	case PREVIEW:
245	return tool.getDisplayName();	×
246	default:
247	return "Download";	×
248	}
249	}
250	}

CeON / dataverse / 1370

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous