Skip to content

Adding formatting and updating text for publish message #7734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kcondon merged 4 commits into from
Mar 31, 2021
Merged

Adding formatting and updating text for publish message #7734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7946f18
add period, add formatting to messages
djbrooke Mar 29, 2021
5db7871
Merge branch 'develop' into 7675-revisit-publish-messaging
djbrooke Mar 29, 2021
7acb506
#7675 add remind to file upload
sekmiller Mar 30, 2021
a2ed1f2
#7675 remove unnecessary null check
sekmiller Mar 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 7 additions & 30 deletions src/main/java/edu/harvard/iq/dataverse/DatasetPage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1109,29 +1109,6 @@ public String getComputeUrl() throws IOException {

}


//get a string to add to save success message
//depends on dataset state and user privleges
private String getReminderString(Dataset dataset) {

//dataset id is null before first save -- needed for create mode
if( dataset.getId() == null || !dataset.isReleased() ){
//messages for draft state.
if (canPublishDataset()){
return BundleUtil.getStringFromBundle("dataset.message.publish.remind.draft");
} else {
return BundleUtil.getStringFromBundle("dataset.message.submit.remind.draft");
}
} else{
//messages for new version - post-publish
if (canPublishDataset()){
return BundleUtil.getStringFromBundle("dataset.message.publish.remind.version");
} else {
return BundleUtil.getStringFromBundle("dataset.message.submit.remind.version");
}
}
}

//For a single file
public String getComputeUrl(FileMetadata metadata) {
SwiftAccessIO swiftObject = null;
Expand Down Expand Up @@ -3499,7 +3476,7 @@ public String save() {
}
if (addFilesSuccess && dataset.getFiles().size() > 0) {
if (nNewFiles == dataset.getFiles().size()) {
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.createSuccess").concat(" ").concat(getReminderString(dataset)));
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.createSuccess").concat(" ").concat(datasetService.getReminderString(dataset, canPublishDataset())));
} else {
String partialSuccessMessage = BundleUtil.getStringFromBundle("dataset.message.createSuccess.partialSuccessSavingFiles");
partialSuccessMessage = partialSuccessMessage.replace("{0}", "" + dataset.getFiles().size() + "");
Expand All @@ -3510,25 +3487,25 @@ public String save() {
JsfHelper.addWarningMessage(BundleUtil.getStringFromBundle("dataset.message.createSuccess.failedToSaveFiles"));
}
} else {
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.createSuccess").concat(" ").concat(getReminderString(dataset)));
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.createSuccess").concat(" ").concat(datasetService.getReminderString(dataset, canPublishDataset())));
}
}
if (editMode.equals(EditMode.METADATA)) {
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.metadataSuccess").concat(" ").concat(getReminderString(dataset)));
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.metadataSuccess").concat(" ").concat(datasetService.getReminderString(dataset, canPublishDataset())));
}
if (editMode.equals(EditMode.LICENSE)) {
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.termsSuccess").concat(" ").concat(getReminderString(dataset)));
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.termsSuccess").concat(" ").concat(datasetService.getReminderString(dataset, canPublishDataset())));
}
if (editMode.equals(EditMode.FILE)) {
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.filesSuccess").concat(" ").concat(getReminderString(dataset)));
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.filesSuccess").concat(" ").concat(datasetService.getReminderString(dataset, canPublishDataset())));
}

} else {
// must have been a bulk file update or delete:
if (bulkFileDeleteInProgress) {
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.bulkFileDeleteSuccess").concat(" ").concat(getReminderString(dataset)));
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.bulkFileDeleteSuccess").concat(" ").concat(datasetService.getReminderString(dataset, canPublishDataset())));
} else {
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.bulkFileUpdateSuccess").concat(" ").concat(getReminderString(dataset)));
JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("dataset.message.bulkFileUpdateSuccess").concat(" ").concat(datasetService.getReminderString(dataset, canPublishDataset())));
}
}

Expand Down
22 changes: 22 additions & 0 deletions src/main/java/edu/harvard/iq/dataverse/DatasetServiceBean.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import edu.harvard.iq.dataverse.harvest.server.OAIRecordServiceBean;
import edu.harvard.iq.dataverse.search.IndexServiceBean;
import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
import edu.harvard.iq.dataverse.util.BundleUtil;
import edu.harvard.iq.dataverse.util.SystemConfig;
import edu.harvard.iq.dataverse.workflows.WorkflowComment;
import java.io.File;
Expand Down Expand Up @@ -727,6 +728,27 @@ public void exportAllDatasets(boolean forceReExport) {

}

//get a string to add to save success message
//depends on dataset state and user privleges
public String getReminderString(Dataset dataset, boolean canPublishDataset) {

if(!dataset.isReleased() ){
//messages for draft state.
if (canPublishDataset){
return BundleUtil.getStringFromBundle("dataset.message.publish.remind.draft");
} else {
return BundleUtil.getStringFromBundle("dataset.message.submit.remind.draft");
}
} else{
//messages for new version - post-publish
if (canPublishDataset){
return BundleUtil.getStringFromBundle("dataset.message.publish.remind.version");
} else {
return BundleUtil.getStringFromBundle("dataset.message.submit.remind.version");
}
}
}

public void updateLastExportTimeStamp(Long datasetId) {
Date now = new Date();
em.createNativeQuery("UPDATE Dataset SET lastExportTime='"+now.toString()+"' WHERE id="+datasetId).executeUpdate();
Expand Down
6 changes: 5 additions & 1 deletion src/main/java/edu/harvard/iq/dataverse/EditDatafilesPage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1120,7 +1120,7 @@ public String save() {
} else {
int nFilesTotal = workingVersion.getFileMetadatas().size();
if (nNewFiles == 0 || nFilesTotal == nExpectedFilesTotal) {
JsfHelper.addSuccessMessage(getBundleString("dataset.message.filesSuccess"));
JsfHelper.addSuccessMessage(getBundleString("dataset.message.filesSuccess").concat(" ").concat(datasetService.getReminderString(dataset, canPublishDataset())));
} else if (nFilesTotal == nOldFiles) {
JsfHelper.addErrorMessage(getBundleString("dataset.message.addFiles.Failure"));
} else {
Expand Down Expand Up @@ -1150,6 +1150,10 @@ public String save() {
return returnToDraftVersion();
}

public boolean canPublishDataset(){
return permissionsWrapper.canIssuePublishDatasetCommand(dataset);
}

private void populateDatasetUpdateFailureMessage(){

JH.addMessage(FacesMessage.SEVERITY_FATAL, getBundleString("dataset.message.filesFailure"));
Expand Down
10 changes: 5 additions & 5 deletions src/main/java/propertyFiles/Bundle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1412,7 +1412,7 @@ dataset.message.locked.downloadNotAllowedInReview=Dataset file(s) may not be dow
dataset.message.locked.downloadNotAllowed=Dataset file(s) may not be downloaded due to dataset lock.
dataset.message.locked.editNotAllowed=Dataset cannot be edited due to dataset lock.
dataset.message.locked.publishNotAllowed=Dataset cannot be published due to dataset lock.
dataset.message.createSuccess=This dataset has been created
dataset.message.createSuccess=This dataset has been created.
dataset.message.createSuccess.failedToSaveFiles=Partial Success: The dataset has been created. But the file(s) could not be saved. Please try uploading the file(s) again.
dataset.message.createSuccess.partialSuccessSavingFiles=Partial Success: The dataset has been created. But only {0} out of {1} files have been saved. Please try uploading the missing file(s) again.
dataset.message.linkSuccess= {0} has been successfully linked to {1}.
Expand All @@ -1421,10 +1421,10 @@ dataset.message.termsSuccess=The terms for this dataset have been updated.
dataset.message.filesSuccess=The files for this dataset have been updated.
dataset.message.addFiles.Failure=Failed to add files to the dataset. Please try uploading the file(s) again.
dataset.message.addFiles.partialSuccess=Partial success: only {0} files out of {1} have been saved. Please try uploading the missing file(s) again.
dataset.message.publish.remind.draft=If it's ready for sharing, please publish it.
dataset.message.submit.remind.draft=If it's ready for sharing, please submit it for review.
dataset.message.publish.remind.version=If it's ready for sharing, please publish it so that others can see these changes.
dataset.message.submit.remind.version=If it's ready for sharing, please submit it for review so that others can see these changes.
dataset.message.publish.remind.draft=If it's ready for sharing, please <b>publish</b> it.
dataset.message.submit.remind.draft=If it's ready for sharing, please <b>submit it for review</b>.
dataset.message.publish.remind.version=If it's ready for sharing, please <b>publish</b> it so that others can see these changes.
dataset.message.submit.remind.version=If it's ready for sharing, please <b>submit it for review</b> so that others can see these changes.
dataset.message.publishSuccess=This dataset has been published.
dataset.message.only.authenticatedUsers=Only authenticated users may release Datasets.
dataset.message.deleteSuccess=This dataset has been deleted.
Expand Down