wab/src/main/java/org/apache/unomi/web/EventsCollectorServlet.java - unomi - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
  * The ASF licenses this file to You under the Apache License, Version 2.0
  * (the "License"); you may not use this file except in compliance with
  * the License.  You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 package org.apache.unomi.web;

 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.unomi.api.*;
 import org.apache.unomi.api.services.EventService;
 import org.apache.unomi.api.services.PrivacyService;
 import org.apache.unomi.api.services.ProfileService;
 import org.apache.unomi.persistence.spi.CustomObjectMapper;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

 import javax.servlet.ServletConfig;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
 import java.io.PrintWriter;
 import java.util.Date;
 import java.util.UUID;

 public class EventsCollectorServlet extends HttpServlet {
     private static final long serialVersionUID = 2008054804885122957L;
     private static final Logger logger = LoggerFactory.getLogger(EventsCollectorServlet.class.getName());

     private String profileIdCookieName = "context-profile-id";

     private EventService eventService;
     private ProfileService profileService;
     private PrivacyService privacyService;

     @Override
     public void init(ServletConfig config) throws ServletException {
         super.init(config);
         logger.info("Event collector servlet initialized.");
     }

     @Override
     public void destroy() {
         super.destroy();
         logger.info("Event collector servlet shutdown.");
     }

     @Override
     protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
         try {
             doEvent(req, resp);
         } catch (Throwable t) { // Here in order to return generic message instead of the whole stack trace in case of not caught exception
             logger.error("EventsCollectorServlet failed to execute get", t);
             resp.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "Internal server error");
         }
     }

     @Override
     protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
         try {
             doEvent(req, resp);
         } catch (Throwable t) { // Here in order to return generic message instead of the whole stack trace in case of not caught exception
             logger.error("EventsCollectorServlet failed to execute post", t);
             resp.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "Internal server error");
         }
     }

     @Override
     protected void doOptions(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
 //        logger.debug(HttpUtils.dumpRequestInfo(request));
         try {
             HttpUtils.setupCORSHeaders(request, response);
             response.flushBuffer();
         }
         catch (Throwable t) { // Here in order to return generic message instead of the whole stack trace in case of not caught exception
             logger.error("EventsCollectorServlet failed to execute doOptions request", t);
             response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "Internal server error");
         }
     }

     private void doEvent(HttpServletRequest request, HttpServletResponse response) throws IOException {
         Date timestamp = new Date();
         if (request.getParameter("timestamp") != null) {
             timestamp.setTime(Long.parseLong(request.getParameter("timestamp")));
         }

         HttpUtils.setupCORSHeaders(request, response);

         String payload = HttpUtils.getPayload(request);
         if (payload == null) {
             response.sendError(HttpServletResponse.SC_BAD_REQUEST, "Check logs for more details");
             logger.error("No event payload found for request, aborting !");
             return;
         }

         ObjectMapper mapper = CustomObjectMapper.getObjectMapper();
         JsonFactory factory = mapper.getFactory();
         EventsCollectorRequest eventsCollectorRequest;
         try {
             eventsCollectorRequest = mapper.readValue(factory.createParser(payload), EventsCollectorRequest.class);
         } catch (Exception e) {
             response.sendError(HttpServletResponse.SC_BAD_REQUEST, "Check logs for more details");
             logger.error("Cannot read payload " + payload, e);
             return;
         }
         if (eventsCollectorRequest == null || eventsCollectorRequest.getEvents() == null) {
             response.sendError(HttpServletResponse.SC_BAD_REQUEST, "Check logs for more details");
             logger.error("No events found in payload");
             return;
         }

         String sessionId = eventsCollectorRequest.getSessionId();
         if (sessionId == null) {
             sessionId = request.getParameter("sessionId");
         }
         Session session = null;
         if (sessionId != null) {
             session = profileService.loadSession(sessionId, timestamp);
         }
         Profile profile = null;
         if (session == null) {
             String scope = "systemscope";
             // Get the first available scope that is not equal to systemscope to create the session otherwise systemscope will be used
             for (Event event : eventsCollectorRequest.getEvents()) {
                 if (StringUtils.isNotBlank(event.getEventType())) {
                     if (StringUtils.isNotBlank(event.getSourceId()) && !event.getSourceId().equals("systemscope")) {
                         scope = event.getSourceId();
                         break;
                     } else if (event.getSource() != null && StringUtils.isNotBlank(event.getSource().getScope()) && !event.getSource().getScope().equals("systemscope")) {
                         scope = event.getSource().getScope();
                         break;
                     }
                 }
             }
             String cookieProfileId = ServletCommon.getProfileIdCookieValue(request, profileIdCookieName);
             if (StringUtils.isNotBlank(cookieProfileId)) {
                 profile = profileService.load(cookieProfileId);
             }
             if (profile == null) {
                 // Create non persisted profile to create the session
                 profile = new Profile("temp_" + UUID.randomUUID().toString());
                 profile.setProperty("firstVisit", timestamp);
             }
             /*
             // Create anonymous profile so we don't keep track of the temp profile anywhere
             Profile anonymousProfile = privacyService.getAnonymousProfile(profile);
             // Create new session which should not be persisted as well as the temp profile
             session = new Session(sessionId, anonymousProfile, timestamp, scope);
             if (logger.isDebugEnabled()) {
                 logger.debug("No session found for sessionId={}, creating new session!", sessionId);
             }
             */
         } else {
             Profile sessionProfile = session.getProfile();
             if (sessionProfile.getItemId() != null) {
                 // Reload up-to-date profile
                 profile = profileService.load(sessionProfile.getItemId());
                 if (profile == null || profile instanceof Persona) {
                     response.sendError(HttpServletResponse.SC_BAD_REQUEST, "Check logs for more details");
                     logger.error("No valid profile found or persona found for profileId={}, aborting request !", session.getProfileId());
                     return;
                 }
             } else {
                 // Session uses anonymous profile, try to find profile from cookie
                 String cookieProfileId = ServletCommon.getProfileIdCookieValue(request, profileIdCookieName);
                 if (StringUtils.isNotBlank(cookieProfileId)) {
                     profile = profileService.load(cookieProfileId);
                 }

                 if (profile == null) {
                     response.sendError(HttpServletResponse.SC_BAD_REQUEST, "Check logs for more details");
                     logger.error("No valid profile found or persona found for profileId={}, aborting request !", session.getProfileId());
                     return;
                 }
             }
         }

         Changes changesObject = ServletCommon.handleEvents(eventsCollectorRequest.getEvents(), session, profile, request, response,
                 timestamp, privacyService, eventService);
         int changes = changesObject.getChangeType();
         profile = changesObject.getProfile();

         if ((changes & EventService.PROFILE_UPDATED) == EventService.PROFILE_UPDATED) {
             profileService.save(profile);
         }
         if ((changes & EventService.SESSION_UPDATED) == EventService.SESSION_UPDATED) {
             if (session != null) {
                 profileService.saveSession(session);
             }
         }
         if ((changes & EventService.ERROR) == EventService.ERROR) {
             String errorMessage = "Error processing events. Total number of processed events: " + changesObject.getProcessedItems() + "/" + eventsCollectorRequest.getEvents().size();
             response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, errorMessage);
             return;
         }

         response.setContentType("application/json");
         PrintWriter responseWriter = response.getWriter();
         responseWriter.append("{\"updated\":" + changes + "}");
         responseWriter.flush();
     }

     public void setEventService(EventService eventService) {
         this.eventService = eventService;
     }

     public void setProfileService(ProfileService profileService) {
         this.profileService = profileService;
     }

     public void setPrivacyService(PrivacyService privacyService) {
         this.privacyService = privacyService;
     }

     public void setProfileIdCookieName(String profileIdCookieName) {
         this.profileIdCookieName = profileIdCookieName;
     }
 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one or more
	* contributor license agreements. See the NOTICE file distributed with
	* this work for additional information regarding copyright ownership.
	* The ASF licenses this file to You under the Apache License, Version 2.0
	* (the "License"); you may not use this file except in compliance with
	* the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	package org.apache.unomi.web;

	import com.fasterxml.jackson.core.JsonFactory;
	import com.fasterxml.jackson.databind.ObjectMapper;
	import org.apache.commons.lang3.StringUtils;
	import org.apache.unomi.api.*;
	import org.apache.unomi.api.services.EventService;
	import org.apache.unomi.api.services.PrivacyService;
	import org.apache.unomi.api.services.ProfileService;
	import org.apache.unomi.persistence.spi.CustomObjectMapper;
	import org.slf4j.Logger;
	import org.slf4j.LoggerFactory;

	import javax.servlet.ServletConfig;
	import javax.servlet.ServletException;
	import javax.servlet.http.HttpServlet;
	import javax.servlet.http.HttpServletRequest;
	import javax.servlet.http.HttpServletResponse;
	import java.io.IOException;
	import java.io.PrintWriter;
	import java.util.Date;
	import java.util.UUID;

	public class EventsCollectorServlet extends HttpServlet {
	private static final long serialVersionUID = 2008054804885122957L;
	private static final Logger logger = LoggerFactory.getLogger(EventsCollectorServlet.class.getName());

	private String profileIdCookieName = "context-profile-id";

	private EventService eventService;
	private ProfileService profileService;
	private PrivacyService privacyService;

	@Override
	public void init(ServletConfig config) throws ServletException {
	super.init(config);
	logger.info("Event collector servlet initialized.");
	}

	@Override
	public void destroy() {
	super.destroy();
	logger.info("Event collector servlet shutdown.");
	}

	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
	try {
	doEvent(req, resp);
	} catch (Throwable t) { // Here in order to return generic message instead of the whole stack trace in case of not caught exception
	logger.error("EventsCollectorServlet failed to execute get", t);
	resp.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "Internal server error");
	}
	}

	@Override
	protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
	try {
	doEvent(req, resp);
	} catch (Throwable t) { // Here in order to return generic message instead of the whole stack trace in case of not caught exception
	logger.error("EventsCollectorServlet failed to execute post", t);
	resp.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "Internal server error");
	}
	}

	@Override
	protected void doOptions(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
	// logger.debug(HttpUtils.dumpRequestInfo(request));
	try {
	HttpUtils.setupCORSHeaders(request, response);
	response.flushBuffer();
	}
	catch (Throwable t) { // Here in order to return generic message instead of the whole stack trace in case of not caught exception
	logger.error("EventsCollectorServlet failed to execute doOptions request", t);
	response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "Internal server error");
	}
	}

	private void doEvent(HttpServletRequest request, HttpServletResponse response) throws IOException {
	Date timestamp = new Date();
	if (request.getParameter("timestamp") != null) {
	timestamp.setTime(Long.parseLong(request.getParameter("timestamp")));
	}

	HttpUtils.setupCORSHeaders(request, response);

	String payload = HttpUtils.getPayload(request);
	if (payload == null) {
	response.sendError(HttpServletResponse.SC_BAD_REQUEST, "Check logs for more details");
	logger.error("No event payload found for request, aborting !");
	return;
	}

	ObjectMapper mapper = CustomObjectMapper.getObjectMapper();
	JsonFactory factory = mapper.getFactory();
	EventsCollectorRequest eventsCollectorRequest;
	try {
	eventsCollectorRequest = mapper.readValue(factory.createParser(payload), EventsCollectorRequest.class);
	} catch (Exception e) {
	response.sendError(HttpServletResponse.SC_BAD_REQUEST, "Check logs for more details");
	logger.error("Cannot read payload " + payload, e);
	return;
	}
	if (eventsCollectorRequest == null \|\| eventsCollectorRequest.getEvents() == null) {
	response.sendError(HttpServletResponse.SC_BAD_REQUEST, "Check logs for more details");
	logger.error("No events found in payload");
	return;
	}

	String sessionId = eventsCollectorRequest.getSessionId();
	if (sessionId == null) {
	sessionId = request.getParameter("sessionId");
	}
	Session session = null;
	if (sessionId != null) {
	session = profileService.loadSession(sessionId, timestamp);
	}
	Profile profile = null;
	if (session == null) {
	String scope = "systemscope";
	// Get the first available scope that is not equal to systemscope to create the session otherwise systemscope will be used
	for (Event event : eventsCollectorRequest.getEvents()) {
	if (StringUtils.isNotBlank(event.getEventType())) {
	if (StringUtils.isNotBlank(event.getSourceId()) && !event.getSourceId().equals("systemscope")) {
	scope = event.getSourceId();
	break;
	} else if (event.getSource() != null && StringUtils.isNotBlank(event.getSource().getScope()) && !event.getSource().getScope().equals("systemscope")) {
	scope = event.getSource().getScope();
	break;
	}
	}
	}
	String cookieProfileId = ServletCommon.getProfileIdCookieValue(request, profileIdCookieName);
	if (StringUtils.isNotBlank(cookieProfileId)) {
	profile = profileService.load(cookieProfileId);
	}
	if (profile == null) {
	// Create non persisted profile to create the session
	profile = new Profile("temp_" + UUID.randomUUID().toString());
	profile.setProperty("firstVisit", timestamp);
	}
	/*
	// Create anonymous profile so we don't keep track of the temp profile anywhere
	Profile anonymousProfile = privacyService.getAnonymousProfile(profile);
	// Create new session which should not be persisted as well as the temp profile
	session = new Session(sessionId, anonymousProfile, timestamp, scope);
	if (logger.isDebugEnabled()) {
	logger.debug("No session found for sessionId={}, creating new session!", sessionId);
	}
	*/
	} else {
	Profile sessionProfile = session.getProfile();
	if (sessionProfile.getItemId() != null) {
	// Reload up-to-date profile
	profile = profileService.load(sessionProfile.getItemId());
	if (profile == null \|\| profile instanceof Persona) {
	response.sendError(HttpServletResponse.SC_BAD_REQUEST, "Check logs for more details");
	logger.error("No valid profile found or persona found for profileId={}, aborting request !", session.getProfileId());
	return;
	}
	} else {
	// Session uses anonymous profile, try to find profile from cookie
	String cookieProfileId = ServletCommon.getProfileIdCookieValue(request, profileIdCookieName);
	if (StringUtils.isNotBlank(cookieProfileId)) {
	profile = profileService.load(cookieProfileId);
	}

	if (profile == null) {
	response.sendError(HttpServletResponse.SC_BAD_REQUEST, "Check logs for more details");
	logger.error("No valid profile found or persona found for profileId={}, aborting request !", session.getProfileId());
	return;
	}
	}
	}

	Changes changesObject = ServletCommon.handleEvents(eventsCollectorRequest.getEvents(), session, profile, request, response,
	timestamp, privacyService, eventService);
	int changes = changesObject.getChangeType();
	profile = changesObject.getProfile();

	if ((changes & EventService.PROFILE_UPDATED) == EventService.PROFILE_UPDATED) {
	profileService.save(profile);
	}
	if ((changes & EventService.SESSION_UPDATED) == EventService.SESSION_UPDATED) {
	if (session != null) {
	profileService.saveSession(session);
	}
	}
	if ((changes & EventService.ERROR) == EventService.ERROR) {
	String errorMessage = "Error processing events. Total number of processed events: " + changesObject.getProcessedItems() + "/" + eventsCollectorRequest.getEvents().size();
	response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, errorMessage);
	return;
	}

	response.setContentType("application/json");
	PrintWriter responseWriter = response.getWriter();
	responseWriter.append("{\"updated\":" + changes + "}");
	responseWriter.flush();
	}

	public void setEventService(EventService eventService) {
	this.eventService = eventService;
	}

	public void setProfileService(ProfileService profileService) {
	this.profileService = profileService;
	}

	public void setPrivacyService(PrivacyService privacyService) {
	this.privacyService = privacyService;
	}

	public void setProfileIdCookieName(String profileIdCookieName) {
	this.profileIdCookieName = profileIdCookieName;
	}
	}