forked from IQSS/dataverse
-
Notifications
You must be signed in to change notification settings - Fork 1
/
DataverseHeaderFragment.java
384 lines (304 loc) · 12.8 KB
/
DataverseHeaderFragment.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
/*
* 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;
import edu.harvard.iq.dataverse.authorization.groups.GroupServiceBean;
import edu.harvard.iq.dataverse.authorization.users.AuthenticatedUser;
import edu.harvard.iq.dataverse.authorization.users.User;
import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
import static edu.harvard.iq.dataverse.util.JsfHelper.JH;
import edu.harvard.iq.dataverse.util.BundleUtil;
import edu.harvard.iq.dataverse.util.config.SystemConfig;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.ejb.EJB;
import javax.faces.context.FacesContext;
import javax.faces.view.ViewScoped;
import javax.inject.Inject;
import javax.inject.Named;
import org.apache.commons.lang.StringUtils;
/**
*
* @author gdurand
*/
@ViewScoped
@Named
public class DataverseHeaderFragment implements java.io.Serializable {
private static final Logger logger = Logger.getLogger(DataverseHeaderFragment.class.getName());
@EJB
DataverseServiceBean dataverseService;
@EJB
SettingsServiceBean settingsService;
@EJB
GroupServiceBean groupService;
@EJB
PermissionServiceBean permissionService;
@EJB
SystemConfig systemConfig;
@EJB
DatasetVersionServiceBean datasetVersionService;
@EJB
DataFileServiceBean datafileService;
@EJB
BannerMessageServiceBean bannerMessageService;
@Inject
DataverseSession dataverseSession;
@Inject
SettingsWrapper settingsWrapper;
@Inject
NavigationWrapper navigationWrapper;
@EJB
UserNotificationServiceBean userNotificationService;
List<Breadcrumb> breadcrumbs = new ArrayList<>();
private List<BannerMessage> bannerMessages = new ArrayList<>();
private Long unreadNotificationCount = null;
public List<Breadcrumb> getBreadcrumbs() {
return breadcrumbs;
}
public void setBreadcrumbs(List<Breadcrumb> breadcrumbs) {
this.breadcrumbs = breadcrumbs;
}
public void initBreadcrumbs(DvObject dvObject) {
if (dvObject == null) {
return;
}
if (dvObject.getId() != null) {
initBreadcrumbs(dvObject, null);
} else {
initBreadcrumbs(dvObject.getOwner(), dvObject instanceof Dataverse ? BundleUtil.getStringFromBundle("newDataverse") :
dvObject instanceof Dataset ? BundleUtil.getStringFromBundle("newDataset") : null );
}
}
public void initBreadcrumbsForFileMetadata(FileMetadata fmd) {
initBreadcrumbsForFileMetadata(fmd, null, null);
}
public void initBreadcrumbsForFileMetadata(DataFile datafile, String subPage) {
initBreadcrumbsForFileMetadata(null, datafile, subPage);
}
public void initBreadcrumbsForFileMetadata(FileMetadata fmd, DataFile datafile, String subPage) {
if (fmd == null ){
Dataset dataset = datafile.getOwner();
Long getDatasetVersionID = dataset.getLatestVersion().getId();
fmd = datafileService.findFileMetadataByDatasetVersionIdAndDataFileId(getDatasetVersionID, datafile.getId());
}
if (fmd == null) {
return;
}
breadcrumbs.clear();
String optionalUrlExtension = "&version=" + fmd.getDatasetVersion().getSemanticVersion();
//First Add regular breadcrumb for the data file
DvObject dvObject = fmd.getDataFile();
breadcrumbs.add(0, new Breadcrumb(dvObject, dvObject.getDisplayName(), optionalUrlExtension));
//Get the Dataset Owning the Datafile and add version to the breadcrumb
dvObject = dvObject.getOwner();
breadcrumbs.add(0, new Breadcrumb(dvObject, dvObject.getDisplayName(), optionalUrlExtension));
// now get Dataverse Owner of the dataset and proceed as usual
dvObject = dvObject.getOwner();
while (dvObject != null) {
breadcrumbs.add(0, new Breadcrumb(dvObject, dvObject.getDisplayName()));
dvObject = dvObject.getOwner();
}
if (subPage != null) {
breadcrumbs.add(new Breadcrumb(subPage));
}
}
public Long getUnreadNotificationCount(Long userId){
if (userId == null){
return new Long("0");
}
if (this.unreadNotificationCount != null){
return this.unreadNotificationCount;
}
try{
this.unreadNotificationCount = userNotificationService.getUnreadNotificationCountByUser(userId);
}catch (Exception e){
logger.warning("Error trying to retrieve unread notification count for user." + e.getMessage());
this.unreadNotificationCount = new Long("0");
}
return this.unreadNotificationCount;
}
public void initBreadcrumbs(DvObject dvObject, String subPage) {
breadcrumbs.clear();
while (dvObject != null) {
breadcrumbs.add(0, new Breadcrumb(dvObject, dvObject.getDisplayName()));
dvObject = dvObject.getOwner();
}
if (subPage != null) {
breadcrumbs.add(new Breadcrumb(subPage));
}
}
/* Old methods for breadcrumb and trees - currently disabled and deferred
public List<Dataverse> getDataverses(Dataverse dataverse) {
List dataverses = new ArrayList();
if (dataverse != null) {
dataverses.addAll(dataverse.getOwners());
dataverses.add(dataverse);
} else {
dataverses.add(dataverseService.findRootDataverse());
}
return dataverses;
}
// @todo right now we just check on if published or if you are the creator; need full permission support
public boolean hasVisibleChildren(Dataverse dataverse) {
for (Dataverse dv : dataverseService.findByOwnerId(dataverse.getId())) {
if (dv.isReleased() || dv.getCreator().equals(dataverseSession.getUser())) {
return true;
}
}
return false;
}
public TreeNode getDataverseTree(Dataverse dataverse) {
if (dataverse == null) { // the primefaces component seems to call this with dataverse == null for some reason
return null;
}
return getDataverseNode(dataverse, null, true);
}
private TreeNode getDataverseNode(Dataverse dataverse, TreeNode root, boolean expand) {
// @todo right now we just check on if published or if you are the creator; need full permission support
if (dataverse.isReleased() || dataverse.getCreator().equals(dataverseSession.getUser())) {
TreeNode dataverseNode = new DefaultTreeNode(dataverse, root);
dataverseNode.setExpanded(expand);
List<Dataverse> childDataversesOfCurrentDataverse = dataverseService.findByOwnerId(dataverse.getId());
for (Dataverse child : childDataversesOfCurrentDataverse) {
getDataverseNode(child, dataverseNode, false);
}
return dataverseNode;
}
return null;
}
*/
public String logout() {
dataverseSession.setUser(null);
dataverseSession.setStatusDismissed(false);
// Important part of completing a logout - kill the existing HTTP session:
// from the ExternalContext.invalidateSession doc page:
// "Invalidates this session then unbinds any objects bound to it."
// - this means whatever allocated SessionScoped classes associated
// with this session may currently be on the heap will become
// garbage-collectable after we log the user out.
FacesContext.getCurrentInstance().getExternalContext().invalidateSession();
// Note that the HTTP session no longer exists -
// .getExternalContext().getSession(false) will return null at this point!
// so it is important to redirect the user to the next page, where a new
// session is going to be issued to them.
String redirectPage = navigationWrapper.getPageFromContext();
try {
redirectPage = URLDecoder.decode(redirectPage, "UTF-8");
} catch (UnsupportedEncodingException ex) {
Logger.getLogger(LoginPage.class.getName()).log(Level.SEVERE, null, ex);
redirectPage = redirectToRoot();
}
if (StringUtils.isEmpty(redirectPage)) {
redirectPage = redirectToRoot();
}
logger.log(Level.INFO, "Sending user to = " + redirectPage);
return redirectPage + (!redirectPage.contains("?") ? "?" : "&") + "faces-redirect=true";
}
private Boolean signupAllowed = null;
private String redirectToRoot(){
return "dataverse.xhtml?alias=" + dataverseService.findRootDataverse().getAlias();
}
public boolean isSignupAllowed() {
if (signupAllowed != null) {
return signupAllowed;
}
boolean safeDefaultIfKeyNotFound = false;
signupAllowed = settingsWrapper.isTrueForKey(SettingsServiceBean.Key.AllowSignUp, safeDefaultIfKeyNotFound);
return signupAllowed;
}
public boolean isRootDataverseThemeDisabled(Dataverse dataverse) {
if (dataverse == null) {
return false;
}
if (dataverse.getOwner() == null) {
// We're operating on the root dataverse.
return settingsWrapper.isRootDataverseThemeDisabled();
} else {
return false;
}
}
public List<BannerMessage> getBannerMessages() {
User user = dataverseSession.getUser();
AuthenticatedUser au = null;
if (user.isAuthenticated()) {
au = (AuthenticatedUser) user;
}
if(au == null){
bannerMessages = bannerMessageService.findBannerMessages();
} else{
bannerMessages = bannerMessageService.findBannerMessages(au.getId());
}
if (!dataverseSession.getDismissedMessages().isEmpty()) {
for (BannerMessage dismissed : dataverseSession.getDismissedMessages()) {
Iterator<BannerMessage> itr = bannerMessages.iterator();
while (itr.hasNext()) {
BannerMessage test = itr.next();
if (test.equals(dismissed)) {
itr.remove();
}
}
}
}
return bannerMessages;
}
public void setBannerMessages(List<BannerMessage> bannerMessages) {
this.bannerMessages = bannerMessages;
}
public String getSignupUrl(String loginRedirect) {
String nonNullDefaultIfKeyNotFound = "";
String signUpUrl = settingsWrapper.getValueForKey(SettingsServiceBean.Key.SignUpUrl, nonNullDefaultIfKeyNotFound);
return signUpUrl + (!signUpUrl.contains("?") ? loginRedirect : loginRedirect.replace("?", "&"));
}
public String getLoginRedirectPage() {
System.out.println("DEPRECATED call to getLoginRedirectPage method in DataverseHeaderfragment: " + navigationWrapper.getRedirectPage());
return navigationWrapper.getRedirectPage();
}
public void addBreadcrumb (String url, String linkString){
breadcrumbs.add(new Breadcrumb(url, linkString));
}
public void addBreadcrumb (String linkString){
breadcrumbs.add(new Breadcrumb(linkString));
}
// inner class used for breadcrumbs
public static class Breadcrumb {
private final String breadcrumbText;
private DvObject dvObject = null;
private String url = null;
private String optionalUrlExtension = null;
public Breadcrumb( DvObject dvObject, String breadcrumbText, String optionalUrlExtension ) {
this.breadcrumbText = breadcrumbText;
this.dvObject = dvObject;
this.optionalUrlExtension = optionalUrlExtension;
}
public Breadcrumb( DvObject dvObject, String breadcrumbText) {
this.breadcrumbText = breadcrumbText;
this.dvObject = dvObject;
}
public Breadcrumb( String url, String breadcrumbText) {
this.breadcrumbText = breadcrumbText;
this.url = url;
}
public Breadcrumb(String breadcrumbText){
this.breadcrumbText = breadcrumbText;
}
public String getBreadcrumbText() {
return breadcrumbText;
}
public DvObject getDvObject() {
return dvObject;
}
public String getUrl() {
return url;
}
public String getOptionalUrlExtension() {
return optionalUrlExtension;
}
}
}