Skip to content

Commit

Permalink
Merge pull request #1528 from siemens/feat/releaseexportexcel
Browse files Browse the repository at this point in the history 
feat(export): Enable mailing for exported spreadsheet for components

Reviewed by: jaideep.palit@siemens.com
Tested by: anupam.ghosh@siemens.com
  • Loading branch information
@ag4ums
ag4ums authored Jun 17, 2022
2 parents 619f174 + 73fe7e6 commit 7b34492
Show file tree
Hide file tree
Showing 9 changed files with 151 additions and 18 deletions.
6 changes: 6 additions & 0 deletions ...d/src-common/src/main/java/org/eclipse/sw360/datahandler/db/ComponentDatabaseHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2502,4 +2502,10 @@ private void checkSuperAttachmentExists(Release release) {
});
}
}

public void sendExportSpreadsheetSuccessMail(String url, String recepient) throws TException {
mailUtil.sendMail(recepient, MailConstants.SUBJECT_SPREADSHEET_EXPORT_SUCCESS,
MailConstants.TEXT_SPREADSHEET_EXPORT_SUCCESS, SW360Constants.NOTIFICATION_CLASS_COMPONENT, "", false,
"component", url);
}
}
2 changes: 1 addition & 1 deletion ...end/src-common/src/main/java/org/eclipse/sw360/datahandler/db/ProjectDatabaseHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1556,7 +1556,7 @@ private void flattenlinkedReleaseOfRelease(Map<String, ReleaseRelationship> rele
public void sendExportSpreadsheetSuccessMail(String url, String recepient) throws TException {
mailUtil.sendMail(recepient, MailConstants.SUBJECT_SPREADSHEET_EXPORT_SUCCESS,
MailConstants.TEXT_SPREADSHEET_EXPORT_SUCCESS, SW360Constants.NOTIFICATION_CLASS_PROJECT, "", false,
url);
"project", url);
}

private Map<String, String> createProjectCSRow(String relation, Project prj,
Expand Down
3 changes: 2 additions & 1 deletion backend/src-common/src/main/resources/sw360.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ subjectForRejectedClearingRequest= Your clearing request <%s> has been rejected
subjectForUpdatedProjectWithClearingRequest= Project <%s> with clearing request <%s> updated
subjectForSuccessfulExport = Spreadsheet Export Successful

textForSuccessfulExport = The project spreadsheet export successfully completed. Please find the download link(%s) here.
textForSuccessfulExport = The %s spreadsheet export successfully completed. Please find the download link(%s) here.
textForNewModerationRequest= a new moderation request has been added to your SW360-account.\n\n
textForUpdateModerationRequest= \
one of the moderation requests previously added to your \
Expand All @@ -83,3 +83,4 @@ enable.sw360.change.log=false
sw360changelog.output.path=sw360changelog/sw360changelog
auto.set.ecc.status=false
send.project.spreadsheet.export.to.mail.enabled=false
send.component.spreadsheet.export.to.mail.enabled=false
5 changes: 5 additions & 0 deletions backend/src/src-components/src/main/java/org/eclipse/sw360/components/ComponentHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -643,4 +643,9 @@ public Map<PaginationData, List<Component>> getRecentComponentsSummaryWithPagina
PaginationData pageData) throws TException {
return handler.getRecentComponentsSummaryWithPagination(user, pageData);
}

@Override
public void sendExportSpreadsheetSuccessMail(String url, String recepient) throws TException {
handler.sendExportSpreadsheetSuccessMail(url, recepient);
}
}
2 changes: 2 additions & 0 deletions frontend/sw360-portlet/src/main/java/org/eclipse/sw360/portal/common/PortalConstants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ public class PortalConstants {
public static final String CLEARING_REPORT_TEMPLATE_FORMAT;
public static final String DISABLE_CLEARING_REQUEST_FOR_PROJECT_WITH_GROUPS;
public static final Boolean SEND_PROJECT_SPREADSHEET_EXPORT_TO_MAIL_ENABLED;
public static final Boolean SEND_COMPONENT_SPREADSHEET_EXPORT_TO_MAIL_ENABLED;
public static final String LOAD_OPEN_MODERATION_REQUEST = "loadOpenModerationRequest";
public static final String LOAD_CLOSED_MODERATION_REQUEST = "loadClosedModerationRequest";

Expand Down Expand Up @@ -699,6 +700,7 @@ public class PortalConstants {
System.getProperty("RunComponentVisibilityRestrictionTest", props.getProperty("component.visibility.restriction.enabled", "false")));
DISABLE_CLEARING_REQUEST_FOR_PROJECT_WITH_GROUPS = props.getProperty("org.eclipse.sw360.disable.clearing.request.for.project.group", "");
SEND_PROJECT_SPREADSHEET_EXPORT_TO_MAIL_ENABLED = Boolean.parseBoolean(props.getProperty("send.project.spreadsheet.export.to.mail.enabled", "false"));
SEND_COMPONENT_SPREADSHEET_EXPORT_TO_MAIL_ENABLED = Boolean.parseBoolean(props.getProperty("send.component.spreadsheet.export.to.mail.enabled", "false"));
}

private PortalConstants() {
Expand Down
99 changes: 95 additions & 4 deletions ...-portlet/src/main/java/org/eclipse/sw360/portal/portlets/components/ComponentPortlet.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,10 @@ public void serveResource(ResourceRequest request, ResourceResponse response) th
updateVulnerabilityVerification(request, response);
} else if (PortalConstants.EXPORT_TO_EXCEL.equals(action)) {
exportExcel(request, response);
} else if (PortalConstants.DOWNLOAD_EXCEL.equals(action)) {
downloadExcel(request, response);
} else if (PortalConstants.EMAIL_EXPORTED_EXCEL.equals(action)) {
exportExcelWithEmail(request, response);
} else if (PortalConstants.RELEASE_LINK_TO_PROJECT.equals(action)) {
linkReleaseToProject(request, response);
} else if (PortalConstants.LOAD_SPDX_LICENSE_INFO.equals(action)) {
Expand All @@ -242,6 +246,59 @@ public void serveResource(ResourceRequest request, ResourceResponse response) th
}
}

private void exportExcelWithEmail(ResourceRequest request, ResourceResponse response) {
final User user = UserCacheHolder.getUserFromRequest(request);
final String componentId = request.getParameter(Component._Fields.ID.toString());
ResourceBundle resourceBundle = ResourceBundleUtil.getBundle("content.Language", request.getLocale(), getClass());
String token = null;

try {
setSessionMessage(request, LanguageUtil.get(resourceBundle,
"excel.report.generation.has.started.we.will.send.you.an.email.with.download.link.once.completed"));
boolean extendedByReleases = Boolean.valueOf(request.getParameter(PortalConstants.EXTENDED_EXCEL_EXPORT));
ComponentService.Iface client = thriftClients.makeComponentClient();
int total = client.getTotalComponentsCount(user);
PaginationData pageData = new PaginationData();
pageData.setAscending(true);
Map<PaginationData, List<Component>> pageDtToProjects;
Set<Component> projects = new HashSet<>();
int displayStart = 0;
int rowsPerPage = 500;
while (0 < total) {
pageData.setDisplayStart(displayStart);
pageData.setRowsPerPage(rowsPerPage);
displayStart = displayStart + rowsPerPage;
pageDtToProjects = getFilteredComponentList(request, pageData);
projects.addAll(pageDtToProjects.entrySet().iterator().next().getValue());
total = total - rowsPerPage;
}
List<Component> listOfComponent = new ArrayList<Component>(projects);
ComponentExporter exporter = new ComponentExporter(thriftClients.makeComponentClient(), listOfComponent,
user, extendedByReleases);

token = exporter.makeExcelExportForProject(listOfComponent, user);

String portletId = (String) request.getAttribute(WebKeys.PORTLET_ID);
ThemeDisplay tD = (ThemeDisplay) request.getAttribute(WebKeys.THEME_DISPLAY);
long plid = tD.getPlid();

LiferayPortletURL componentUrl = PortletURLFactoryUtil.create(request, portletId, plid,
PortletRequest.RESOURCE_PHASE);
componentUrl.setParameter("action", PortalConstants.DOWNLOAD_EXCEL);
componentUrl.setParameter("token", token);
componentUrl.setParameter(PortalConstants.EXTENDED_EXCEL_EXPORT, String.valueOf(extendedByReleases));

if(!CommonUtils.isNullEmptyOrWhitespace(token)) {
client.sendExportSpreadsheetSuccessMail(componentUrl.toString(), user.getEmail());
}
} catch (IOException | TException | PortletException e) {
log.error("An error occurred while generating the Excel export", e);
response.setProperty(ResourceResponse.HTTP_STATUS_CODE,
Integer.toString(HttpServletResponse.SC_INTERNAL_SERVER_ERROR));
}

}

private void evaluateCLIAttachments(ResourceRequest request, ResourceResponse response) throws IOException {
User user = UserCacheHolder.getUserFromRequest(request);
String releaseId = request.getParameter(RELEASE_ID);
Expand Down Expand Up @@ -466,13 +523,47 @@ private void exportExcel(ResourceRequest request, ResourceResponse response) {

try {
boolean extendedByReleases = Boolean.valueOf(request.getParameter(PortalConstants.EXTENDED_EXCEL_EXPORT));
List<Component> components = getFilteredComponentList(request);
ComponentExporter exporter = new ComponentExporter(thriftClients.makeComponentClient(), components, user,
ComponentService.Iface client = thriftClients.makeComponentClient();
int total = client.getTotalComponentsCount(user);
PaginationData pageData = new PaginationData();
pageData.setAscending(true);
Map<PaginationData, List<Component>> pageDtToProjects;
Set<Component> projects = new HashSet<>();
int displayStart = 0;
int rowsPerPage = 500;
while (0 < total) {
pageData.setDisplayStart(displayStart);
pageData.setRowsPerPage(rowsPerPage);
displayStart = displayStart + rowsPerPage;
pageDtToProjects = getFilteredComponentList(request, pageData);
projects.addAll(pageDtToProjects.entrySet().iterator().next().getValue());
total = total - rowsPerPage;
}
List<Component> listOfComponent = new ArrayList<Component>(projects);
ComponentExporter exporter = new ComponentExporter(thriftClients.makeComponentClient(), listOfComponent, user,
extendedByReleases);
String filename = String.format("components-%s.xlsx", SW360Utils.getCreatedOn());
PortletResponseUtil.sendFile(request, response, filename, exporter.makeExcelExport(listOfComponent),
CONTENT_TYPE_OPENXML_SPREADSHEET);
} catch (IOException | TException e) {
log.error("An error occurred while generating the Excel export", e);
response.setProperty(ResourceResponse.HTTP_STATUS_CODE,
Integer.toString(HttpServletResponse.SC_INTERNAL_SERVER_ERROR));
}
}

private void downloadExcel(ResourceRequest request, ResourceResponse response) {
final User user = UserCacheHolder.getUserFromRequest(request);
final String token = request.getParameter("token");

try {
boolean extendedByReleases = Boolean.valueOf(request.getParameter(PortalConstants.EXTENDED_EXCEL_EXPORT));
ComponentExporter exporter = new ComponentExporter(thriftClients.makeComponentClient(), user,
extendedByReleases);
String filename = String.format("components-%s.xlsx", SW360Utils.getCreatedOn());
PortletResponseUtil.sendFile(request, response, filename, exporter.makeExcelExport(components),
PortletResponseUtil.sendFile(request, response, filename, exporter.downloadExcelSheet(token),
CONTENT_TYPE_OPENXML_SPREADSHEET);
} catch (IOException | SW360Exception e) {
} catch (IOException | TException e) {
log.error("An error occurred while generating the Excel export", e);
response.setProperty(ResourceResponse.HTTP_STATUS_CODE,
Integer.toString(HttpServletResponse.SC_INTERNAL_SERVER_ERROR));
Expand Down
42 changes: 30 additions & 12 deletions frontend/sw360-portlet/src/main/resources/META-INF/resources/html/components/view.jsp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,11 @@
<portlet:param name="<%=PortalConstants.LICENSE_ID%>" value="<%=PortalConstants.FRIENDLY_URL_PLACEHOLDER_LICENSE_ID%>"/>
</liferay-portlet:renderURL>

<portlet:resourceURL var="generateExcelReport">
<portlet:param name="<%=PortalConstants.ACTION%>" value="<%=PortalConstants.EMAIL_EXPORTED_EXCEL%>"/>
<portlet:param name="<%=PortalConstants.COMPONENT_ID%>" value="${docid}"/>
</portlet:resourceURL>

<div class="container" style="display: none;">
<div class="row">
<div class="col-3 sidebar">
Expand Down Expand Up @@ -399,19 +404,32 @@
// Export Spreadsheet action
function exportSpreadsheet(type){
var portletURL = PortletURL.createURL('<%= PortletURLFactoryUtil.create(request, portletDisplay.getId(), themeDisplay.getPlid(), PortletRequest.RESOURCE_PHASE) %>')
var isEMailEnabled = <%=PortalConstants.SEND_COMPONENT_SPREADSHEET_EXPORT_TO_MAIL_ENABLED%>;
if(isEMailEnabled){
var isWithReleases = (type === 'componentWithReleases' ? 'true' : 'false');
$.ajax({
type: 'POST',
url: '<%=generateExcelReport%>',
cache: false,
data: {
"<portlet:namespace/><%=PortalConstants.EXTENDED_EXCEL_EXPORT%>": isWithReleases,
}
});
} else {
var portletURL = PortletURL.createURL('<%= PortletURLFactoryUtil.create(request, portletDisplay.getId(), themeDisplay.getPlid(), PortletRequest.RESOURCE_PHASE) %>')
.setParameter('<%=PortalConstants.ACTION%>', '<%=PortalConstants.EXPORT_TO_EXCEL%>');
portletURL.setParameter('<%=Component._Fields.NAME%>', $('#component_name').val());
portletURL.setParameter('<%=Component._Fields.CATEGORIES%>', $('#categories').val());
portletURL.setParameter('<%=Component._Fields.LANGUAGES%>', $('#languages').val());
portletURL.setParameter('<%=Component._Fields.SOFTWARE_PLATFORMS%>', $('#software_platforms').val());
portletURL.setParameter('<%=Component._Fields.OPERATING_SYSTEMS%>', $('#operating_systems').val());
portletURL.setParameter('<%=Component._Fields.VENDOR_NAMES%>', $('#vendor_names').val());
portletURL.setParameter('<%=Component._Fields.COMPONENT_TYPE%>', $('#component_type').val());
portletURL.setParameter('<%=Component._Fields.MAIN_LICENSE_IDS%>', $('#main_licenses').val());
portletURL.setParameter('<%=PortalConstants.EXTENDED_EXCEL_EXPORT%>', type === 'componentWithReleases' ? 'true' : 'false');
window.location.href = portletURL.toString();
portletURL.setParameter('<%=Component._Fields.NAME%>', $('#component_name').val());
portletURL.setParameter('<%=Component._Fields.CATEGORIES%>', $('#categories').val());
portletURL.setParameter('<%=Component._Fields.LANGUAGES%>', $('#languages').val());
portletURL.setParameter('<%=Component._Fields.SOFTWARE_PLATFORMS%>', $('#software_platforms').val());
portletURL.setParameter('<%=Component._Fields.OPERATING_SYSTEMS%>', $('#operating_systems').val());
portletURL.setParameter('<%=Component._Fields.VENDOR_NAMES%>', $('#vendor_names').val());
portletURL.setParameter('<%=Component._Fields.COMPONENT_TYPE%>', $('#component_type').val());
portletURL.setParameter('<%=Component._Fields.MAIN_LICENSE_IDS%>', $('#main_licenses').val());
portletURL.setParameter('<%=PortalConstants.EXTENDED_EXCEL_EXPORT%>', type === 'componentWithReleases' ? 'true' : 'false');
window.location.href = portletURL.toString();
}
}
// Delete component action
Expand Down
5 changes: 5 additions & 0 deletions libraries/exporters/src/main/java/org/eclipse/sw360/exporter/ComponentExporter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,11 @@ public ComponentExporter(ComponentService.Iface componentClient, List<Component>
preloadLinkedReleasesFor(components, extendedByReleases);
}

public ComponentExporter(ComponentService.Iface componentClient, User user,
boolean extendedByReleases) throws SW360Exception {
super(new ComponentHelper(extendedByReleases, new ReleaseHelper(componentClient, user)));
}

private void preloadLinkedReleasesFor(List<Component> components, boolean extendedByReleases)
throws SW360Exception {
Set<String> linkedReleaseIds = components
Expand Down
5 changes: 5 additions & 0 deletions libraries/lib-datahandler/src/main/thrift/components.thrift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -838,4 +838,9 @@ service ComponentService {
* Gets all releases with complete details
*/
list<Release> getAllReleasesForUser(1: User user);

/**
* Send email to the user once spreadsheet export completed
*/
void sendExportSpreadsheetSuccessMail(1: string url, 2: string userEmail);
}

0 comments on commit 7b34492

Please sign in to comment.