2 * ============LICENSE_START==========================================
4 * ===================================================================
5 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
6 * ===================================================================
7 * Modifications Copyright (c) 2020 IBM
8 * ===================================================================
10 * Unless otherwise specified, all software contained herein is licensed
11 * under the Apache License, Version 2.0 (the "License");
12 * you may not use this software except in compliance with the License.
13 * You may obtain a copy of the License at
15 * http://www.apache.org/licenses/LICENSE-2.0
17 * Unless required by applicable law or agreed to in writing, software
18 * distributed under the License is distributed on an "AS IS" BASIS,
19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 * See the License for the specific language governing permissions and
21 * limitations under the License.
23 * Unless otherwise specified, all documentation contained herein is licensed
24 * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
25 * you may not use this documentation except in compliance with the License.
26 * You may obtain a copy of the License at
28 * https://creativecommons.org/licenses/by/4.0/
30 * Unless required by applicable law or agreed to in writing, documentation
31 * distributed under the License is distributed on an "AS IS" BASIS,
32 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
33 * See the License for the specific language governing permissions and
34 * limitations under the License.
36 * ============LICENSE_END============================================
40 package org.onap.portalapp.portal.controller;
42 import io.swagger.annotations.ApiOperation;
43 import java.io.IOException;
44 import java.io.InputStream;
45 import java.nio.charset.StandardCharsets;
46 import java.util.HashMap;
48 import java.util.Objects;
49 import javax.servlet.http.HttpServletRequest;
50 import lombok.NoArgsConstructor;
51 import org.apache.commons.io.IOUtils;
52 import org.apache.commons.lang.StringUtils;
53 import org.onap.portalapp.controller.EPRestrictedRESTfulBaseController;
54 import org.onap.portalapp.portal.domain.EPApp;
55 import org.onap.portalapp.portal.domain.EcompAuditLog;
56 import org.onap.portalapp.portal.logging.aop.EPAuditLog;
57 import org.onap.portalapp.portal.logging.aop.EPEELFLoggerAdvice;
58 import org.onap.portalapp.portal.logging.logic.EPLogUtil;
59 import org.onap.portalapp.portal.service.AppsCacheService;
60 import org.onap.portalapp.portal.service.WidgetMService;
61 import org.onap.portalapp.portal.transport.Analytics;
62 import org.onap.portalapp.portal.utils.EPCommonSystemProperties;
63 import org.onap.portalapp.portal.utils.EcompPortalUtils;
64 import org.onap.portalapp.portal.utils.PortalConstants;
65 import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
66 import org.onap.portalsdk.core.onboarding.crossapi.PortalAPIResponse;
67 import org.onap.portalsdk.core.util.SystemProperties;
69 import org.springframework.beans.factory.annotation.Autowired;
70 import org.springframework.context.annotation.Configuration;
71 import org.springframework.context.annotation.EnableAspectJAutoProxy;
72 import org.springframework.http.HttpEntity;
73 import org.springframework.http.HttpHeaders;
74 import org.springframework.http.HttpMethod;
75 import org.springframework.http.MediaType;
76 import org.springframework.http.ResponseEntity;
77 import org.springframework.util.concurrent.FailureCallback;
78 import org.springframework.util.concurrent.ListenableFuture;
79 import org.springframework.util.concurrent.SuccessCallback;
80 import org.springframework.web.bind.annotation.RequestBody;
81 import org.springframework.web.bind.annotation.RequestMapping;
82 import org.springframework.web.bind.annotation.PostMapping;
83 import org.springframework.web.bind.annotation.GetMapping;
84 import org.springframework.web.bind.annotation.RequestMethod;
85 import org.springframework.web.bind.annotation.ResponseBody;
86 import org.springframework.web.bind.annotation.RestController;
87 import org.springframework.web.client.AsyncRestTemplate;
90 @RequestMapping(PortalConstants.REST_AUX_API)
92 @EnableAspectJAutoProxy
95 public class WebAnalyticsExtAppController extends EPRestrictedRESTfulBaseController {
96 public static final String FEED_ML = "feed.ml";
97 private WidgetMService widgetMService;
98 private AppsCacheService appCacheService;
100 private static final String MACHINE_LEARNING_SERVICE_CTX = "/ml_api";
101 private static final String REGISTER_ACTION = MACHINE_LEARNING_SERVICE_CTX + "/" + "registerAction";
102 private static final String APP_KEY = "uebkey";
103 private static final String ERROR_MSG = " Error retrieving Application to capture app name for analytics; Proceeding with empty app name";
104 private final EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(WebAnalyticsExtAppController.class);
105 private final AsyncRestTemplate restTemplate = new AsyncRestTemplate();
106 private final SuccessCallback<ResponseEntity<String>> successCallback = arg -> logger.info(EELFLoggerDelegate.debugLogger, arg.getBody());
107 private final FailureCallback failureCallback = arg -> logger.error(EELFLoggerDelegate.errorLogger, "storeAuxAnalytics failed", arg);
110 public WebAnalyticsExtAppController(AppsCacheService appCacheService, WidgetMService consulHealthService) {
111 this.appCacheService = appCacheService;
112 this.widgetMService = consulHealthService;
116 * Answers requests from partner applications for a file that is expected to
117 * contain javascript to support web analytics.
123 @ApiOperation(value = "Gets javascript with functions that support gathering and reporting web analytics.", response = String.class)
124 @GetMapping(value = { "/analytics" }, produces = "application/javascript")
125 public String getAnalyticsScript(HttpServletRequest request) {
126 String responseText = "";
130 app = getApp(request);
131 } catch (Exception e) {
132 logger.error(EELFLoggerDelegate.errorLogger,
136 String restEndPoint = app.getAppRestEndpoint();
137 if(restEndPoint.indexOf("/api")!=-1) {
138 version = restEndPoint.substring(restEndPoint.indexOf("api"));
141 String endPoint = "/storeAnalytics";
142 if(StringUtils.isNotBlank(version)) {
143 endPoint = version + "/storeAnalytics";
146 final String fileName = "analytics.txt";
147 try (InputStream analyticsFileStream = this.getClass().getClassLoader().getResourceAsStream(fileName)) {
148 responseText = IOUtils.toString(Objects.requireNonNull(analyticsFileStream), StandardCharsets.UTF_8.name());
149 } catch (IOException e) {
150 logger.error(EELFLoggerDelegate.errorLogger, "Error reading contents of the file " + fileName, e);
153 String feURLContext = SystemProperties.getProperty("frontend_url");
154 String feURL = feURLContext.substring(0, feURLContext.lastIndexOf('/'));
155 responseText = responseText.replace("PORTAL_ENV_URL", feURL);
156 responseText = responseText.replace("$END_POINT", endPoint);
161 * Accepts data from partner applications with web analytics data.
165 * @param analyticsMap
167 * @return PortalAPIResponse
169 @PostMapping(value = { "/storeAnalytics" }, produces = "application/json")
171 @ApiOperation(value = "Accepts data from partner applications with web analytics data.", response = PortalAPIResponse.class)
172 public PortalAPIResponse storeAnalyticsScript(HttpServletRequest request, @RequestBody Analytics analyticsMap) {
174 MDC.put(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP, EPEELFLoggerAdvice.getCurrentDateTimeUTC());
177 appName = getAppName(request, appName);
178 } catch (Exception e) {
179 logger.error(EELFLoggerDelegate.errorLogger,
184 if(SystemProperties.containsProperty(FEED_ML) &&
185 SystemProperties.getProperty(FEED_ML).equals("true")) {
186 storeAuxAnalytics(analyticsMap, appName);
189 } catch (Exception e) {
190 logger.error(EELFLoggerDelegate.errorLogger,
194 MDC.put(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP, EPEELFLoggerAdvice.getCurrentDateTimeUTC());
196 EcompPortalUtils.calculateDateTimeDifferenceForLog(
197 MDC.get(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP),
198 MDC.get(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP));
199 logger.info(EELFLoggerDelegate.auditLogger,
200 EPLogUtil.formatStoreAnalyticsAuditLogMessage(analyticsMap.getUserid(), appName,
201 "WebAnalyticsExtAppController.postWebAnalyticsData",
202 EcompAuditLog.CD_ACTIVITY_STORE_ANALYTICS, analyticsMap.getAction(), analyticsMap.getPage(),
203 analyticsMap.getFunction(), analyticsMap.getType()));
205 MDC.remove(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP);
206 MDC.remove(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP);
207 MDC.remove(SystemProperties.MDC_TIMER);
209 return new PortalAPIResponse(true, "success");
210 } catch (Exception e) {
211 logger.error(EELFLoggerDelegate.errorLogger, "storeAnalytics failed", e);
212 return new PortalAPIResponse(true, "error");
216 private String getAppName(HttpServletRequest request, String appName) {
218 EPApp appRecord = getApp(request);
219 if (appRecord != null) {
220 appName = appRecord.getName();
225 private EPApp getApp(HttpServletRequest request) {
226 String appKeyValue = request.getHeader(APP_KEY);
227 EPApp appRecord = null;
228 if (appKeyValue == null || appKeyValue.equals("")) {
229 logger.error(EELFLoggerDelegate.errorLogger, " App Key unavailable; Proceeding with null app name");
231 appRecord = appCacheService.getAppFromUeb(appKeyValue);
236 protected void storeAuxAnalytics(Analytics analyticsMap, String appName) {
237 logger.info(EELFLoggerDelegate.debugLogger,
238 " Registering an action for recommendation: AppName/Function/UserId " + appName + "/"
239 + analyticsMap.getFunction() + "/" + analyticsMap.getUserid());
242 Map<String, String> requestMapping = new HashMap<>();
243 requestMapping.put("id", analyticsMap.getUserid());
244 requestMapping.put("action", appName + "|" + analyticsMap.getFunction());
246 HttpHeaders headers = new HttpHeaders();
247 headers.setContentType(MediaType.APPLICATION_JSON);
249 // set your entity to send
250 HttpEntity<Map<String, String>> entity = new HttpEntity<>(requestMapping, headers);
253 ListenableFuture<ResponseEntity<String>> out = restTemplate.exchange(
254 EcompPortalUtils.widgetMLProtocol() + "://"
255 + widgetMService.getMLServiceLocation()
257 HttpMethod.POST, entity, String.class);
258 out.addCallback(successCallback, failureCallback);