2 * ============LICENSE_START==========================================
4 * ===================================================================
5 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
6 * ===================================================================
7 * Modifications Copyright (c) 2019 Samsung
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============================================
41 package org.onap.portal.controller;
43 import io.swagger.annotations.ApiOperation;
44 import java.io.IOException;
45 import java.io.InputStream;
46 import java.nio.charset.StandardCharsets;
47 import java.util.HashMap;
49 import java.util.Objects;
50 import javax.servlet.http.HttpServletRequest;
51 import lombok.NoArgsConstructor;
52 import org.apache.commons.io.IOUtils;
53 import org.apache.commons.lang.StringUtils;
54 import org.onap.portal.domain.db.fn.FnApp;
55 import org.onap.portal.domain.dto.ecomp.EcompAuditLog;
56 import org.onap.portal.domain.dto.transport.Analytics;
57 import org.onap.portal.logging.aop.EPAuditLog;
58 import org.onap.portal.logging.aop.EPEELFLoggerAdvice;
59 import org.onap.portal.logging.logic.EPLogUtil;
60 import org.onap.portal.service.AppsCacheService;
61 import org.onap.portal.service.WidgetMService;
62 import org.onap.portal.utils.EPCommonSystemProperties;
63 import org.onap.portal.utils.EcompPortalUtils;
64 import org.onap.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.http.HttpEntity;
72 import org.springframework.http.HttpHeaders;
73 import org.springframework.http.HttpMethod;
74 import org.springframework.http.MediaType;
75 import org.springframework.http.ResponseEntity;
76 import org.springframework.util.concurrent.FailureCallback;
77 import org.springframework.util.concurrent.ListenableFuture;
78 import org.springframework.util.concurrent.SuccessCallback;
79 import org.springframework.web.bind.annotation.RequestBody;
80 import org.springframework.web.bind.annotation.RequestMapping;
81 import org.springframework.web.bind.annotation.RequestMethod;
82 import org.springframework.web.bind.annotation.ResponseBody;
83 import org.springframework.web.bind.annotation.RestController;
84 import org.springframework.web.client.AsyncRestTemplate;
87 @RequestMapping(PortalConstants.REST_AUX_API)
91 public class WebAnalyticsExtAppController {
93 private static final String MACHINE_LEARNING_SERVICE_CTX = "/ml_api";
94 private static final String REGISTER_ACTION = MACHINE_LEARNING_SERVICE_CTX + "/" + "registerAction";
95 private static final String CONSUL_ML_SERVICE_ID = "machine-learning";
96 private static final String APP_KEY = "uebkey";
97 private final EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(WebAnalyticsExtAppController.class);
98 private final AsyncRestTemplate restTemplate = new AsyncRestTemplate();
99 private final SuccessCallback<ResponseEntity<String>> successCallback = arg -> logger.info(EELFLoggerDelegate.debugLogger, arg.getBody());
100 private final FailureCallback failureCallback = arg -> logger.error(EELFLoggerDelegate.errorLogger, "storeAuxAnalytics failed", arg);
102 private WidgetMService widgetMService;
103 private AppsCacheService appCacheService;
106 public WebAnalyticsExtAppController(final WidgetMService widgetMService,
107 final AppsCacheService appCacheService) {
108 this.widgetMService = widgetMService;
109 this.appCacheService = appCacheService;
113 * Answers requests from partner applications for a file that is expected to
114 * contain javascript to support web analytics.
120 @ApiOperation(value = "Gets javascript with functions that support gathering and reporting web analytics.", response = String.class)
121 @RequestMapping(value = { "/analytics" }, method = RequestMethod.GET, produces = "application/javascript")
122 public String getAnalyticsScript(HttpServletRequest request) {
123 String responseText = "";
127 app = getApp(request);
128 } catch (Exception e) {
129 logger.error(EELFLoggerDelegate.errorLogger,
130 " Error retrieving Application to capture app name for analytics; Proceeding with empty app name");
133 String restEndPoint = app.getAppRestEndpoint();
134 if(restEndPoint.contains("/api")) {
135 version = restEndPoint.substring(restEndPoint.indexOf("api"));
138 String endPoint = "/storeAnalytics";
139 if(StringUtils.isNotBlank(version)) {
140 endPoint = version + "/storeAnalytics";
143 final String fileName = "analytics.txt";
144 try (InputStream analyticsFileStream = this.getClass().getClassLoader().getResourceAsStream(fileName)) {
145 responseText = IOUtils.toString(Objects.requireNonNull(analyticsFileStream), StandardCharsets.UTF_8.name());
146 } catch (IOException e) {
147 logger.error(EELFLoggerDelegate.errorLogger, "Error reading contents of the file " + fileName, e);
150 String feURLContext = SystemProperties.getProperty("frontend_url");
151 String feURL = feURLContext.substring(0, feURLContext.lastIndexOf('/'));
152 responseText = responseText.replace("PORTAL_ENV_URL", feURL);
153 responseText = responseText.replace("$END_POINT", endPoint);
158 * Accepts data from partner applications with web analytics data.
162 * @param analyticsMap
164 * @return PortalAPIResponse
166 @RequestMapping(value = { "/storeAnalytics" }, method = RequestMethod.POST, produces = "application/json")
168 @ApiOperation(value = "Accepts data from partner applications with web analytics data.", response = PortalAPIResponse.class)
169 public PortalAPIResponse storeAnalyticsScript(HttpServletRequest request, @RequestBody Analytics analyticsMap) {
171 MDC.put(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP, EPEELFLoggerAdvice.getCurrentDateTimeUTC());
174 appName = getAppName(request, appName);
175 } catch (Exception e) {
176 logger.error(EELFLoggerDelegate.errorLogger,
177 " Error retrieving Application to capture app name for analytics; Proceeding with empty app name");
181 storeAuxAnalytics(analyticsMap, appName);
182 } catch (Exception e) {
183 logger.error(EELFLoggerDelegate.errorLogger,
184 " Error retrieving Application to capture app name for analytics; Proceeding with empty app name");
187 MDC.put(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP, EPEELFLoggerAdvice.getCurrentDateTimeUTC());
189 EcompPortalUtils.calculateDateTimeDifferenceForLog(
190 MDC.get(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP),
191 MDC.get(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP));
192 logger.info(EELFLoggerDelegate.auditLogger,
193 EPLogUtil.formatStoreAnalyticsAuditLogMessage(analyticsMap.getUserid(), appName,
194 "WebAnalyticsExtAppController.postWebAnalyticsData",
195 EcompAuditLog.CD_ACTIVITY_STORE_ANALYTICS, analyticsMap.getAction(), analyticsMap.getPage(),
196 analyticsMap.getFunction(), analyticsMap.getType()));
198 MDC.remove(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP);
199 MDC.remove(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP);
200 MDC.remove(SystemProperties.MDC_TIMER);
202 return new PortalAPIResponse(true, "success");
203 } catch (Exception e) {
204 logger.error(EELFLoggerDelegate.errorLogger, "storeAnalytics failed", e);
205 return new PortalAPIResponse(true, "error");
209 private String getAppName(HttpServletRequest request, String appName) {
211 FnApp appRecord = getApp(request);
212 if (appRecord != null) {
213 appName = appRecord.getAppName();
218 private FnApp getApp(HttpServletRequest request) {
219 String appKeyValue = request.getHeader(APP_KEY);
220 FnApp appRecord = null;
221 if (appKeyValue == null || appKeyValue.equals("")) {
222 logger.error(EELFLoggerDelegate.errorLogger, " App Key unavailable; Proceeding with null app name");
224 appRecord = appCacheService.getAppFromUeb(appKeyValue);
229 private void storeAuxAnalytics(Analytics analyticsMap, String appName) {
230 logger.info(EELFLoggerDelegate.debugLogger,
231 " Registering an action for recommendation: AppName/Function/UserId " + appName + "/"
232 + analyticsMap.getFunction() + "/" + analyticsMap.getUserid());
234 Map<String, String> requestMapping = new HashMap<>();
235 requestMapping.put("id", analyticsMap.getUserid());
236 requestMapping.put("action", appName + "|" + analyticsMap.getFunction());
238 HttpHeaders headers = new HttpHeaders();
239 headers.setContentType(MediaType.APPLICATION_JSON);
241 // set your entity to send
242 HttpEntity<Map<String, String>> entity = new HttpEntity<>(requestMapping, headers);
245 ListenableFuture<ResponseEntity<String>> out = restTemplate.exchange(
246 EcompPortalUtils.widgetMsProtocol() + "://"
247 + widgetMService.getServiceLocation(CONSUL_ML_SERVICE_ID,
248 SystemProperties.getProperty("microservices.m-learn.local.port"))
250 HttpMethod.POST, entity, String.class);
251 out.addCallback(successCallback, failureCallback);