/*
Copyright (C) 2005-2012, by the President and Fellows of Harvard College.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dataverse Network - A web application to share, preserve and analyze research data.
Developed at the Institute for Quantitative Social Science, Harvard University.
Version 3.0.
*/
/*
* AddCollectionsPage.java
*
* Created on September 15, 2006, 1:33 PM
*/
package edu.harvard.iq.dvn.core.web.collection;
import com.icesoft.faces.component.datapaginator.DataPaginator;
import com.icesoft.faces.component.ext.RowSelectorEvent;
import edu.harvard.iq.dvn.core.admin.UserGroup;
import edu.harvard.iq.dvn.core.admin.VDCUser;
import edu.harvard.iq.dvn.core.index.IndexServiceLocal;
import edu.harvard.iq.dvn.core.index.SearchTerm;
import edu.harvard.iq.dvn.core.study.Study;
import edu.harvard.iq.dvn.core.study.StudyServiceLocal;
import edu.harvard.iq.dvn.core.util.StringUtil;
import edu.harvard.iq.dvn.core.vdc.VDC;
import edu.harvard.iq.dvn.core.vdc.VDCCollection;
import edu.harvard.iq.dvn.core.vdc.VDCCollectionServiceLocal;
import edu.harvard.iq.dvn.core.vdc.VDCServiceLocal;
import edu.harvard.iq.dvn.core.web.common.VDCBaseBean;
import edu.harvard.iq.dvn.core.web.study.StudyUI;
import java.util.ArrayList;
import java.util.List;
import javax.ejb.EJB;
import javax.faces.application.FacesMessage;
import javax.faces.bean.ViewScoped;
import javax.faces.component.UIComponent;
import javax.faces.component.UIInput;
import javax.faces.context.FacesContext;
import javax.faces.model.SelectItem;
import javax.faces.event.ActionEvent;
import javax.inject.Named;
/**
* <p>Page bean that corresponds to a similarly named JSP page. This
* class contains component definitions (and initialization code) for
* all components that you have defined on this page, as well as
* lifecycle methods and event handlers where you may add behavior
* to respond to incoming events.</p>
*/
@Named("EditCollectionPage")
@ViewScoped
public class EditCollectionPage extends VDCBaseBean implements java.io.Serializable {
@EJB
VDCServiceLocal vdcService;
@EJB
VDCCollectionServiceLocal vdcCollectionService;
@EJB
StudyServiceLocal studyService;
@EJB
IndexServiceLocal indexService;
public EditCollectionPage() {
}
private VDCCollection collection;
private Long collId;
private Long parentId;
public VDCCollection getCollection() {
return collection;
}
public CollectionUI getCollUI() {
return new CollectionUI(collection);
}
public void setCollection(VDCCollection collection) {
this.collection = collection;
}
public Long getCollId() {
return collId;
}
public void setCollId(Long collId) {
this.collId = collId;
}
public Long getParentId() {
return parentId;
}
public void setParentId(Long parentId) {
this.parentId = parentId;
}
public void init() {
super.init();
String collIdStr = getRequestParam("collectionId");
if (collIdStr != null) {
collId = Long.parseLong(collIdStr);
collection = vdcCollectionService.find(collId);
if ( !isCollectionInCurrentVDC() ) {
collId = null;
collection = null;
return;
}
if (collection.getParentCollection() != null) {
parentId = collection.getParentCollection().getId();
}
} else {
collection = new VDCCollection();
collection.setStudies(new ArrayList());
collection.setOwner(getVDCRequestBean().getCurrentVDC());
collection.setLocalScope();
String parentIdStr = getRequestParam("parentId");
if (parentIdStr != null) {
parentId = Long.parseLong(parentIdStr);
} else {
parentId = getVDCRequestBean().getCurrentVDC().getRootCollection().getId();
}
collection.setParentCollection( vdcCollectionService.find(parentId) );
}
browseDVId = getVDCRequestBean().getCurrentVDC().getId();
browseCollectionId = getVDCRequestBean().getCurrentVDC().getRootCollection().getId();
setAvailableStudies(browseCollectionId);
}
// this metho checks to see if the collection the user is attempting to edit is in the current vdc;
// if not redirect
private boolean isCollectionInCurrentVDC() {
if (!collection.getOwner().getId().equals(getVDCRequestBean().getCurrentVDCId()) ) {
//redirect("/faces/collection/ManageCollectionsPage.xhtml");
//SEK 8/27/12 what should the re-direct do here?
return false;
}
return true;
}
public List<SelectItem> getParentCollectionItems() {
List collSelectItems = new ArrayList<SelectItem>();
List<VDCCollection> collList = vdcCollectionService.getCollectionList(getVDCRequestBean().getCurrentVDC(), collection);
for (VDCCollection coll : collList) {
collSelectItems.add(new SelectItem(coll.getId(), coll.getName()));
}
return collSelectItems;
}
private List<StudyUI> availableStudies;
private DataPaginator availableStudiesPaginator;
private String availableStudiesMethod = "browse";
public List<StudyUI> getAvailableStudies() {
return availableStudies;
}
private void setAvailableStudies(Long collectionId) {
setAvailableStudies( vdcCollectionService.getStudyIds( vdcCollectionService.find(collectionId) ));
}
private void setAvailableStudies(List<Long> studyIds) {
Long vdcId = getVDCRequestBean().getCurrentVDCId();
VDCUser user = getVDCSessionBean().getUser();
UserGroup ipUserGroup = getVDCSessionBean().getIpUserGroup();
List ownedStudyIds = new ArrayList();
if (collection.isRootCollection()) {
ownedStudyIds = vdcService.getOwnedStudyIds( collection.getOwner().getId() );
}
// filter out studies that are not released or in (other) restricted vdcs
studyIds.retainAll( studyService.getVisibleStudies( studyIds, vdcId ) );
availableStudies = new ArrayList();
for (Long sid : studyIds) {
StudyUI studyUI = new StudyUI(sid, user, ipUserGroup, StudyUI.isStudyInList(sid, collection.getStudies()));
if (collection.isRootCollection() && ownedStudyIds.contains(sid) ) {
studyUI.setSelected(true);
studyUI.setSelectable(false);
}
availableStudies.add(studyUI);
}
resetAvailableStudiesPaginator();
}
public DataPaginator getAvailableStudiesPaginator() {
return availableStudiesPaginator;
}
public void setAvailableStudiesPaginator(DataPaginator availableStudiesPaginator) {
this.availableStudiesPaginator = availableStudiesPaginator;
}
private void resetAvailableStudiesPaginator() {
if (availableStudiesPaginator != null) {
availableStudiesPaginator.gotoFirstPage();
}
}
public String getAvailableStudiesMethod() {
return availableStudiesMethod;
}
public void setAvailableStudiesMethod(String availableStudiesMethod) {
if (!availableStudiesMethod.equals(this.availableStudiesMethod)) {
this.availableStudiesMethod = availableStudiesMethod;
if (availableStudiesMethod.equals("browse") && browseCollectionId != null ) {
setAvailableStudies(browseCollectionId);
} else {
availableStudies = new ArrayList();
}
}
}
// browse functionality
private Long browseDVId;
private Long browseCollectionId;
private Long tempCollId;
public Long getBrowseDVId() {
return browseDVId;
}
public void setBrowseDVId(Long browseDVId) {
if (!browseDVId.equals(this.browseDVId)) {
this.browseDVId = browseDVId;
tempCollId = vdcService.find(browseDVId).getRootCollection().getId();
setAvailableStudies(tempCollId);
}
}
public Long getBrowseCollectionId() {
return browseCollectionId;
}
public void setBrowseCollectionId(Long browseCollectionId) {
if (tempCollId != null) {
this.browseCollectionId = tempCollId;
tempCollId = null;
} else if (!browseCollectionId.equals(this.browseCollectionId)) {
this.browseCollectionId = browseCollectionId;
setAvailableStudies(browseCollectionId);
}
}
private List<SelectItem> browseDVItems;
public List<SelectItem> getBrowseDVItems() {
if (browseDVItems == null) {
browseDVItems = new ArrayList<SelectItem>();
// first add current
VDC currentVDC = getVDCRequestBean().getCurrentVDC();
browseDVItems.add(new SelectItem(currentVDC.getId(), currentVDC.getName()));
browseDVItems.add(new SelectItem("", "-----", null, true));
browseDVItems.addAll(createSelectItemList( vdcService.findInfoAllPublic(), currentVDC.getId() ));
}
return browseDVItems;
}
public List<SelectItem> getBrowseCollectionItems() {
List collSelectItems = new ArrayList<SelectItem>();
if (browseDVId != null) {
List<VDCCollection> collList = vdcCollectionService.getCollectionList(vdcService.find(browseDVId));
for (VDCCollection coll : collList) {
collSelectItems.add(new SelectItem(coll.getId(), coll.getName()));
}
}
return collSelectItems;
}
// search functionality
private String searchField;
private String searchValue;
public String getSearchField() {
return searchField;
}
public void setSearchField(String searchField) {
this.searchField = searchField;
}
public String getSearchValue() {
return searchValue;
}
public void setSearchValue(String searchValue) {
this.searchValue = searchValue;
}
public void searchStudies(ActionEvent e) {
List searchTerms = new ArrayList();
SearchTerm st = new SearchTerm();
st.setFieldName(searchField);
st.setValue(searchValue);
searchTerms.add(st);
setAvailableStudies(indexService.search( (VDC) null, searchTerms) );
}
// actions
public String save_action() {
// first set parent, if needed
if (parentId != null &&
(collId == null || !parentId.equals(collection.getParentCollection().getId() ) ) ) {
if (collId != null) {
collection.removeParentRelationship();
}
VDCCollection parentColl = vdcCollectionService.find(parentId);
collection.setParentRelationship(parentColl);
}
// now save collection
if (collId == null) {
vdcCollectionService.create(collection);
} else {
vdcCollectionService.edit(collection);
}
if (getVDCRequestBean().getCurrentVDC() != null) {
getVDCRenderBean().getFlash().put("successMessage", "Successfully updated collection.");
return "/admin/OptionsPage?faces-redirect=true" + getContextSuffix() + "&tab=collections";
} else {
return "/networkAdmin/NetworkOptionsPage.xhtml?faces-redirect=true&tab=collections";
}
}
public String cancel_action() {
if (getVDCRequestBean().getCurrentVDC() != null) {
getVDCRenderBean().getFlash().put("successMessage", "Successfully updated collection.");
return "/admin/OptionsPage?faces-redirect=true" + getContextSuffix() + "&tab=collections" ;
} else {
return "/networkAdmin/NetworkOptionsPage.xhtml?faces-redirect=true&tab=collections";
}
}
public void addRemoveStudyListener(RowSelectorEvent event) {
StudyUI studyUI = (StudyUI) availableStudies.get(event.getRow());
if (studyUI.isSelectable() ) {
if (studyUI.isSelected()) {
if (!StudyUI.isStudyInList(studyUI.getStudy(), collection.getStudies())) {
collection.getStudies().add(studyUI.getStudy());
}
} else {
collection.getStudies().remove(studyUI.getStudy());
}
} else {
// revert back to what it was before the user clicked
studyUI.setSelected( !studyUI.isSelected() );
}
}
public void removeStudyListener(RowSelectorEvent event) {
Study study = collection.getStudies().get(event.getRow());
collection.getStudies().remove(study);
// deselect from availableStudies
for (StudyUI studyUI : availableStudies) {
if (study.getId().equals( studyUI.getStudyId() ) ) {
studyUI.setSelected(false);
break;
}
}
}
public List<StudyUI> getStudies() {
List studyUIs = new ArrayList();
VDCUser user = getVDCSessionBean().getUser();
UserGroup ipUserGroup = getVDCSessionBean().getIpUserGroup();
if (collection != null) {
for (Study study : collection.getStudies()) {
studyUIs.add( new StudyUI(study, user, ipUserGroup, false) );
}
}
return studyUIs;
}
public void validateCollectionName(FacesContext context,
UIComponent toValidate,
Object value) {
String saveButtonAttr = (String) toValidate.getAttributes().get("saveButton");
String saveButton = getRequestParam(saveButtonAttr);
if ( StringUtil.isEmpty(saveButton) ) {
return; // as this was the result of a partial submit, do not do validation
}
if (collection.isRootCollection()) {
return; // no parent, so no need to check
}
// to validate we need to know the parent collection
String parentIdAttr = (String) toValidate.getAttributes().get("parentId");
UIInput parentIdInput = (UIInput) context.getViewRoot().findComponent(parentIdAttr);
Long parentId = new Long( (String) parentIdInput.getSubmittedValue() );
VDCCollection parentColl = vdcCollectionService.find(parentId);
String collectionName = (String) value;
for (VDCCollection subColl : parentColl.getSubCollections()) {
if ( !subColl.getId().equals(collId) && subColl.getName().trim().equals( collectionName.trim() ) ) {
((UIInput)toValidate).setValid(false);
FacesMessage message = new FacesMessage("This name is already in use (in this parent).");
context.addMessage(toValidate.getClientId(context), message);
break;
}
}
}
}