Merge pull request #352 from sw360/fix/singleProjectSpreadsheetExport#325

Added Download Spreadsheet button to project's Clearing Status tab
review-by:[email protected]
tested-by:[email protected]

Author: mcjaeger

frontend/sw360-portlet/src/main/java/org/eclipse/sw360/portal/common/PortalConstants.java

@@ -275,6 +275,7 @@ public class PortalConstants {
 
     // Excel export
     public static final String EXPORT_TO_EXCEL = "export_to_excel";
+    public static final String EXPORT_CLEARING_TO_EXCEL = "export_clearing_to_excel";
     public static final String EXPORT_ID = "export_id";
 
     // Import Projects

frontend/sw360-portlet/src/main/java/org/eclipse/sw360/portal/portlets/admin/VendorPortlet.java

@@ -36,6 +36,7 @@
 import java.util.Map;
 
 import static com.google.common.base.Strings.isNullOrEmpty;
+import static org.eclipse.sw360.datahandler.common.SW360Constants.CONTENT_TYPE_OPENXML_SPREADSHEET;
 import static org.eclipse.sw360.portal.common.PortalConstants.*;
 
 /**
@@ -75,7 +76,7 @@ private void exportExcel(ResourceRequest request, ResourceResponse response) {
             VendorService.Iface client = thriftClients.makeVendorClient();
             List<Vendor> vendors = client.getAllVendors();
 
-            PortletResponseUtil.sendFile(request, response, "Vendors.xlsx", exporter.makeExcelExport(vendors), "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
+            PortletResponseUtil.sendFile(request, response, "Vendors.xlsx", exporter.makeExcelExport(vendors), CONTENT_TYPE_OPENXML_SPREADSHEET);
         } catch (IOException | TException e) {
             log.error("An error occured while generating the Excel export", e);
         }

frontend/sw360-portlet/src/main/java/org/eclipse/sw360/portal/portlets/components/ComponentPortlet.java

@@ -51,6 +51,7 @@
 import static com.google.common.base.Strings.isNullOrEmpty;
 import static com.google.common.base.Strings.nullToEmpty;
 import static org.eclipse.sw360.datahandler.common.CommonUtils.nullToEmptyList;
+import static org.eclipse.sw360.datahandler.common.SW360Constants.CONTENT_TYPE_OPENXML_SPREADSHEET;
 import static org.eclipse.sw360.datahandler.common.SW360Utils.printName;
 import static org.eclipse.sw360.portal.common.PortalConstants.*;
 import static org.eclipse.sw360.portal.common.PortletUtils.addToMatchedByHistogram;
@@ -232,7 +233,7 @@ private void exportExcel(ResourceRequest request, ResourceResponse response) {
             List<Component> components = getFilteredComponentList(request);
             ComponentExporter exporter = new ComponentExporter(thriftClients.makeComponentClient(), extendedByReleases);
             PortletResponseUtil.sendFile(request, response, "Components.xlsx", exporter.makeExcelExport(components),
-                    "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
+                    CONTENT_TYPE_OPENXML_SPREADSHEET);
         } catch (IOException | SW360Exception e) {
             log.error("An error occurred while generating the Excel export", e);
         }

frontend/sw360-portlet/src/main/java/org/eclipse/sw360/portal/portlets/licenses/LicensesPortlet.java

@@ -38,6 +38,7 @@
 import static com.google.common.base.Strings.isNullOrEmpty;
 import static org.eclipse.sw360.datahandler.common.CommonUtils.TMP_TODO_ID_PREFIX;
 import static org.eclipse.sw360.datahandler.common.CommonUtils.nullToEmptyList;
+import static org.eclipse.sw360.datahandler.common.SW360Constants.CONTENT_TYPE_OPENXML_SPREADSHEET;
 import static org.eclipse.sw360.portal.common.PortalConstants.*;
 
 /**
@@ -83,7 +84,7 @@ private void exportExcel(ResourceRequest request, ResourceResponse response) {
             LicenseService.Iface client = thriftClients.makeLicenseClient();
             List<License> licenses = client.getLicenseSummaryForExport();
 
-            PortletResponseUtil.sendFile(request, response, "Licenses.xlsx", exporter.makeExcelExport(licenses), "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
+            PortletResponseUtil.sendFile(request, response, "Licenses.xlsx", exporter.makeExcelExport(licenses), CONTENT_TYPE_OPENXML_SPREADSHEET);
         } catch (IOException | TException e) {
             log.error("An error occurred while generating the Excel export", e);
         }

frontend/sw360-portlet/src/main/java/org/eclipse/sw360/portal/portlets/projects/ProjectPortlet.java

@@ -43,6 +43,7 @@
 import org.eclipse.sw360.datahandler.thrift.vendors.VendorService;
 import org.eclipse.sw360.datahandler.thrift.vulnerabilities.*;
 import org.eclipse.sw360.exporter.ProjectExporter;
+import org.eclipse.sw360.exporter.ReleaseExporter;
 import org.eclipse.sw360.portal.common.*;
 import org.eclipse.sw360.portal.portlets.FossologyAwarePortlet;
 import org.eclipse.sw360.portal.users.LifeRayUserSession;
@@ -67,6 +68,7 @@
 import static com.liferay.portal.kernel.json.JSONFactoryUtil.createJSONObject;
 import static org.eclipse.sw360.datahandler.common.CommonUtils.nullToEmptyList;
 import static org.eclipse.sw360.datahandler.common.CommonUtils.wrapThriftOptionalReplacement;
+import static org.eclipse.sw360.datahandler.common.SW360Constants.CONTENT_TYPE_OPENXML_SPREADSHEET;
 import static org.eclipse.sw360.datahandler.common.SW360Utils.printName;
 import static org.eclipse.sw360.portal.common.PortalConstants.*;
 import static org.eclipse.sw360.portal.common.PortletUtils.addToMatchedByHistogram;
@@ -135,6 +137,8 @@ public void serveResource(ResourceRequest request, ResourceResponse response) th
             updateVulnerabilityRating(request, response);
         } else if (PortalConstants.EXPORT_TO_EXCEL.equals(action)) {
             exportExcel(request, response);
+        } else if (PortalConstants.EXPORT_CLEARING_TO_EXCEL.equals(action)) {
+            exportReleasesSpreadsheet(request, response);
         } else if (PortalConstants.DOWNLOAD_LICENSE_INFO.equals(action)) {
             downloadLicenseInfo(request, response);
         } else if (PortalConstants.DOWNLOAD_SOURCE_CODE_BUNDLE.equals(action)) {
@@ -256,12 +260,33 @@ private void exportExcel(ResourceRequest request, ResourceResponse response) {
                     thriftClients.makeProjectClient(),
                     user,
                     extendedByReleases);
-            PortletResponseUtil.sendFile(request, response, "Projects.xlsx", exporter.makeExcelExport(projects), "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
+            PortletResponseUtil.sendFile(request, response, "Projects.xlsx", exporter.makeExcelExport(projects), CONTENT_TYPE_OPENXML_SPREADSHEET);
         } catch (IOException | SW360Exception e) {
             log.error("An error occurred while generating the Excel export", e);
         }
     }
 
+    private void exportReleasesSpreadsheet(ResourceRequest request, ResourceResponse response) {
+        final User user = UserCacheHolder.getUserFromRequest(request);
+        try {
+            String id = request.getParameter(PROJECT_ID);
+            Project project = null;
+            if (!isNullOrEmpty(id)) {
+                project = thriftClients.makeProjectClient().getProjectById(id, user);
+            }
+            if (project != null) {
+                Map<Release, String> releaseStringMap = getReleaseStringMap(id, user);
+                List<Release> releases = releaseStringMap.keySet().stream().sorted(Comparator.comparing(SW360Utils::printFullname)).collect(Collectors.toList());
+                ReleaseExporter exporter = new ReleaseExporter(thriftClients.makeComponentClient());
+                PortletResponseUtil.sendFile(request, response,
+                        String.format("releases-%s-%s-%s.xlsx", project.getName(), project.getVersion(), SW360Utils.getCreatedOn()),
+                        exporter.makeExcelExport(releases), CONTENT_TYPE_OPENXML_SPREADSHEET);
+            }
+        } catch (IOException | TException e) {
+            log.error("An error occurred while generating the Excel export", e);
+        }
+    }
+
     private RequestStatus removeProject(PortletRequest request) {
         String projectId = request.getParameter(PortalConstants.PROJECT_ID);
         final User user = UserCacheHolder.getUserFromRequest(request);

frontend/sw360-portlet/src/main/webapp/html/projects/includes/projects/clearingStatus.jspf

@@ -30,6 +30,12 @@
             </tr>
             </tfoot>
         </table>
+        <core_rt:if test="${inProjectDetailsContext}">
+            <div class="clear-float"></div>
+            <span class="pull-right">
+                <input type="button" class="addButton" id="exportReleasesSpreadsheetButton" value="Export Spreadsheet" class="addButton" onclick="exportReleasesSpreadsheet()"/>
+            </span>
+        </core_rt:if>
     </div>
 </core_rt:if>
 
@@ -77,6 +83,13 @@
 
     }
 
+    function exportReleasesSpreadsheet() {
+        var portletURL = Liferay.PortletURL.createURL('<%= PortletURLFactoryUtil.create(request, portletDisplay.getId(), themeDisplay.getPlid(), PortletRequest.RESOURCE_PHASE) %>')
+            .setParameter('<%=PortalConstants.ACTION%>', '<%=PortalConstants.EXPORT_CLEARING_TO_EXCEL%>');
+        portletURL.setParameter('<%=PortalConstants.PROJECT_ID%>','${project.id}');
+        window.location.href = portletURL.toString();
+    }
+
     //This can not be document ready function as liferay definitions need to be loaded first
     $(window).load(function () {
         createClearingTable();

libraries/lib-datahandler/src/main/java/org/eclipse/sw360/datahandler/common/SW360Constants.java

@@ -66,6 +66,7 @@ public class SW360Constants {
 
     public static final Collection<AttachmentType> LICENSE_INFO_ATTACHMENT_TYPES = Arrays.asList(AttachmentType.COMPONENT_LICENSE_INFO_XML, AttachmentType.COMPONENT_LICENSE_INFO_COMBINED);
     public static final Collection<AttachmentType> SOURCE_CODE_ATTACHMENT_TYPES = Arrays.asList(AttachmentType.SOURCE, AttachmentType.SOURCE_SELF);
+    public static final String CONTENT_TYPE_OPENXML_SPREADSHEET = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
 
     public static Collection<AttachmentType> allowedAttachmentTypes(String documentType) {
         Set<AttachmentType> types = newHashSet(AttachmentType.values());