[PORTAL-7] Rebase
[portal.git] / ecomp-portal-BE-common / src / main / java / org / openecomp / portalapp / portal / controller / WebAnalyticsExtAppController.java
diff --git a/ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/controller/WebAnalyticsExtAppController.java b/ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/controller/WebAnalyticsExtAppController.java
new file mode 100644 (file)
index 0000000..f1d77a3
--- /dev/null
@@ -0,0 +1,157 @@
+/*-\r
+ * ================================================================================\r
+ * ECOMP Portal\r
+ * ================================================================================\r
+ * Copyright (C) 2017 AT&T Intellectual Property\r
+ * ================================================================================\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ * \r
+ *      http://www.apache.org/licenses/LICENSE-2.0\r
+ * \r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ * ================================================================================\r
+ */\r
+package org.openecomp.portalapp.portal.controller;\r
+\r
+import java.io.InputStream;\r
+import java.nio.charset.StandardCharsets;\r
+\r
+import javax.servlet.http.HttpServletRequest;\r
+\r
+import org.apache.commons.io.IOUtils;\r
+import org.openecomp.portalapp.controller.EPRestrictedRESTfulBaseController;\r
+import org.openecomp.portalapp.portal.domain.EPApp;\r
+import org.openecomp.portalapp.portal.domain.EcompAuditLog;\r
+import org.openecomp.portalapp.portal.logging.aop.EPAuditLog;\r
+import org.openecomp.portalapp.portal.logging.aop.EPEELFLoggerAdvice;\r
+import org.openecomp.portalapp.portal.logging.logic.EPLogUtil;\r
+import org.openecomp.portalapp.portal.service.AppsCacheService;\r
+import org.openecomp.portalapp.portal.transport.Analytics;\r
+import org.openecomp.portalapp.portal.utils.EPCommonSystemProperties;\r
+import org.openecomp.portalapp.portal.utils.PortalConstants;\r
+import org.openecomp.portalsdk.core.logging.logic.EELFLoggerDelegate;\r
+import org.openecomp.portalsdk.core.onboarding.crossapi.PortalAPIResponse;\r
+import org.openecomp.portalsdk.core.service.AuditService;\r
+import org.openecomp.portalsdk.core.util.SystemProperties;\r
+import org.slf4j.MDC;\r
+import org.springframework.beans.factory.annotation.Autowired;\r
+import org.springframework.context.annotation.Configuration;\r
+import org.springframework.context.annotation.EnableAspectJAutoProxy;\r
+import org.springframework.web.bind.annotation.RequestBody;\r
+import org.springframework.web.bind.annotation.RequestMapping;\r
+import org.springframework.web.bind.annotation.RequestMethod;\r
+import org.springframework.web.bind.annotation.ResponseBody;\r
+import org.springframework.web.bind.annotation.RestController;\r
+\r
+import io.swagger.annotations.ApiOperation;\r
+\r
+@RestController\r
+@RequestMapping(PortalConstants.REST_AUX_API)\r
+@Configuration\r
+@EnableAspectJAutoProxy\r
+@EPAuditLog\r
+public class WebAnalyticsExtAppController extends EPRestrictedRESTfulBaseController{\r
+       \r
+       private static final String APP_KEY = "uebkey";\r
+       \r
+       @Autowired\r
+       AuditService auditService;\r
+       \r
+       @Autowired\r
+       AppsCacheService appCacheService;\r
+       \r
+       EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(WebAnalyticsExtAppController.class);\r
+\r
+       protected boolean isAuxRESTfulCall() {\r
+               return true;\r
+       }\r
+\r
+       /*\r
+        * Answers requests from partner applications for a file that is expected to\r
+        * contain javascript to support web analytics.\r
+        * \r
+        * @param request\r
+        * @return\r
+        * @throws Exception\r
+        */\r
+       @ApiOperation(value = "Gets javascript with functions that support gathering and reporting web analytics.", response = String.class)\r
+       @RequestMapping(value = { "/analytics" }, method = RequestMethod.GET, produces = "application/javascript")\r
+       public String getAnalyticsScript(HttpServletRequest request) throws Exception {\r
+               String responseText = "";\r
+               final String fileName = "analytics.txt";\r
+               InputStream analyticsFileStream = null;\r
+               try {\r
+                       analyticsFileStream = this.getClass().getClassLoader().getResourceAsStream(fileName);\r
+                       responseText = IOUtils.toString(analyticsFileStream, StandardCharsets.UTF_8.name());\r
+               } catch (Exception e) {\r
+                       logger.error(EELFLoggerDelegate.errorLogger, "Error reading contents of the file " + fileName, e);\r
+               } finally {\r
+                       if (analyticsFileStream != null)\r
+                               analyticsFileStream.close();\r
+               }\r
+\r
+               String feURLContext = SystemProperties.getProperty("frontend_url");\r
+               String feURL = feURLContext.substring(0, feURLContext.lastIndexOf('/'));\r
+\r
+               responseText = responseText.replace("PORTAL_ENV_URL", feURL);\r
+               return responseText;\r
+       }\r
+\r
+       /**\r
+        * Accepts data from partner applications with web analytics data.\r
+        * \r
+        * @param request\r
+        * @param analyticsMap\r
+        * @param response\r
+        * @return\r
+        * @throws Exception\r
+        */\r
+       @RequestMapping(value = { "/storeAnalytics" }, method = RequestMethod.POST, produces = "application/json")\r
+       @ResponseBody\r
+       @ApiOperation(value = "Accepts data from partner applications with web analytics data.", response = PortalAPIResponse.class)\r
+       public PortalAPIResponse storeAnalyticsScript(HttpServletRequest request, @RequestBody Analytics analyticsMap) throws Exception {       \r
+               try{\r
+               MDC.put(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP,EPEELFLoggerAdvice.getCurrentDateTimeUTC());          \r
+               MDC.put(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP,EPEELFLoggerAdvice.getCurrentDateTimeUTC());\r
+               String appName = "";\r
+               try {\r
+                       \r
+                       String appKeyValue = request.getHeader(APP_KEY);\r
+                       if(appKeyValue == null || appKeyValue.equals("")) {\r
+                               logger.error(EELFLoggerDelegate.errorLogger, " App Key unavailable; Proceeding with null app name");\r
+                       } else {        \r
+                               EPApp appRecord = appCacheService.getAppForAnalytics(appKeyValue); \r
+                               if(appRecord == null){\r
+                                       logger.error(EELFLoggerDelegate.errorLogger, " App could not be found for the key "+ appKeyValue);\r
+                               }\r
+                               else appName = appRecord.getName();\r
+                               \r
+                       }\r
+               \r
+               } catch(Exception e) {\r
+                       logger.error(EELFLoggerDelegate.errorLogger, " Error retrieving Application to capture app name for analytics; Proceeding with empty app name");\r
+               }\r
+               \r
+               \r
+               \r
+               logger.info(EELFLoggerDelegate.auditLogger, EPLogUtil.formatStoreAnalyticsAuditLogMessage(analyticsMap.getUserId(),appName, "WebAnalyticsExtAppController.postWebAnalyticsData", \r
+                               EcompAuditLog.CD_ACTIVITY_STORE_ANALYTICS, analyticsMap.getAction(),analyticsMap.getPage(),analyticsMap.getFunction(),analyticsMap.getType()));                 \r
+               MDC.remove(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP);\r
+               MDC.remove(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP);\r
+               \r
+               PortalAPIResponse response = new PortalAPIResponse(true, "success");\r
+               return response;\r
+               } catch (Exception e) {\r
+                       logger.error(EELFLoggerDelegate.errorLogger, "storeAnalytics failed", e);\r
+                       PortalAPIResponse response = new PortalAPIResponse(true, "error");\r
+                       return response;\r
+               }\r
+       }\r
+\r
+}\r