ConfigListController.java

/**
 * The contents of this file are subject to the OpenMRS Public License
 * Version 1.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://license.openmrs.org
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations
 * under the License.
 *
 * Copyright (C) OpenMRS, LLC.  All Rights Reserved.
 */
package org.openmrs.module.sync.web.controller;

import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import org.apache.commons.io.IOUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openmrs.api.APIAuthenticationException;
import org.openmrs.api.context.Context;
import org.openmrs.module.sync.SyncConstants;
import org.openmrs.module.sync.SyncTransmission;
import org.openmrs.module.sync.SyncUtil;
import org.openmrs.module.sync.SyncUtilTransmission;
import org.openmrs.module.sync.api.SyncService;
import org.openmrs.module.sync.serialization.TimestampNormalizer;
import org.openmrs.module.sync.server.RemoteServer;
import org.openmrs.module.sync.server.RemoteServerType;
import org.openmrs.module.sync.server.ServerConnectionState;
import org.openmrs.scheduler.TaskDefinition;
import org.openmrs.util.OpenmrsConstants;
import org.openmrs.web.WebConstants;
import org.springframework.context.support.MessageSourceAccessor;
import org.springframework.validation.BindException;
import org.springframework.validation.Errors;
import org.springframework.web.bind.ServletRequestUtils;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.SimpleFormController;
import org.springframework.web.servlet.view.RedirectView;

/**
 * Controller for page that displays all parent and child servers that are set up
 */
public class ConfigListController extends SimpleFormController {
	
	/** Logger for this class and subclasses */
	protected final Log log = LogFactory.getLog(getClass());
	
	@Override
	protected ModelAndView onSubmit(HttpServletRequest request, HttpServletResponse response, Object obj,
	                                BindException errors) throws Exception {
		
		log.debug("in onSubmit");
		
		ModelAndView result = new ModelAndView(new RedirectView(getSuccessView()));
		
		if (!Context.isAuthenticated())
			throw new APIAuthenticationException("Not authenticated!");
		
		HttpSession httpSession = request.getSession();
		String success = "";
		String error = "";
		MessageSourceAccessor msa = getMessageSourceAccessor();
		
		String action = ServletRequestUtils.getStringParameter(request, "action", "");
		
		log.debug("action is " + action);
		
		if ("deleteServer".equals(action)) {
			// check to see if the user is trying to delete a server, react accordingly
			Integer serverId = ServletRequestUtils.getIntParameter(request, "serverId", 0);
			String serverName = "Server " + serverId.toString();
			
			SyncService ss = Context.getService(SyncService.class);
			
			if (serverId > 0) {
				RemoteServer deleteServer = ss.getRemoteServer(serverId);
				serverName = deleteServer.getNickname();
				
				try {
					ss.deleteRemoteServer(deleteServer);
					Object[] args = { serverName };
					success = msa.getMessage("sync.config.server.deleted", args);
				}
				catch (Exception e) {
					Object[] args = { serverName };
					error = msa.getMessage("sync.config.server.deleteFailed", args);
				}
			} else {
				error = msa.getMessage("sync.config.server.notDeleted");
			}
			
		} else if ("manualTx".equals(action)) {
			try {
				Integer serverId = ServletRequestUtils.getIntParameter(request, "serverId", 0);
				RemoteServer server = Context.getService(SyncService.class).getRemoteServer(serverId);
				
				log.warn("IN MANUAL-TX WITH SERVERID: " + serverId);
				
				// we are creating a sync-transmission, so start by generating a SyncTransmission object
				SyncTransmission tx = SyncUtilTransmission.createSyncTransmission(server, true,
				    SyncUtil.getGlobalPropetyValueAsInteger(SyncConstants.PROPERTY_NAME_MAX_RECORDS_FILE));
				String toTransmit = tx.getFileOutput();
				
				// Record last attempt
				server.setLastSync(new Date());
				Context.getService(SyncService.class).saveRemoteServer(server);
				
				// Write sync transmission to response
				InputStream in = new ByteArrayInputStream(toTransmit.getBytes());
				response.setContentType("text/xml; charset=utf-8");
				response.setHeader("Content-Disposition", "attachment; filename=" + tx.getFileName() + ".xml");
				OutputStream out = response.getOutputStream();
				IOUtils.copy(in, out);
				out.flush();
				out.close();
				
				// don't return a model/view - we'll need to return a file instead.
				result = null;
			}
			catch (Exception e) {
				error = msa.getMessage("sync.status.createTx.error");
				e.printStackTrace();
			}
			
		}
		
		if (!success.equals(""))
			httpSession.setAttribute(WebConstants.OPENMRS_MSG_ATTR, success);
		
		if (!error.equals(""))
			httpSession.setAttribute(WebConstants.OPENMRS_ERROR_ATTR, error);
		
		return result;
	}
	
	/**
	 * This is called prior to displaying a form for the first time. It tells Spring the
	 * form/command object to load into the request
	 * 
	 * @see org.springframework.web.servlet.mvc.AbstractFormController#formBackingObject(javax.servlet.http.HttpServletRequest)
	 */
	protected Object formBackingObject(HttpServletRequest request) throws ServletException {
		Map<String, Object> obj = new HashMap<String, Object>();
		List<RemoteServer> serverList = new ArrayList<RemoteServer>();
		
		// only fill the Object if the user has authenticated properly
		if (Context.isAuthenticated()) {
			SyncService ss = Context.getService(SyncService.class);
			
			serverList.addAll(ss.getRemoteServers());
			obj.put("serverList", serverList);
		}
		
		return obj;
	}
	
	@SuppressWarnings("unchecked")
	@Override
	protected Map referenceData(HttpServletRequest request, Object obj, Errors errors) throws Exception {
		Map<String, Object> ret = new HashMap<String, Object>();
		
		if (Context.isAuthenticated()) {
			//cast
			Map<String, Object> ref = (Map<String, Object>) obj;
			
			// the parent server
			List<RemoteServer> serverList = (List<RemoteServer>) ref.get("serverList");
			RemoteServer parent = null;
			
			for (RemoteServer server : serverList) {
				if (server.getServerType().equals(RemoteServerType.PARENT)) {
					parent = server;
				}
			}
			
			// testConnection error messages
			MessageSourceAccessor msa = getMessageSourceAccessor();
			Map<String, String> connectionState = new HashMap<String, String>();
			connectionState.put(ServerConnectionState.OK.toString(),
			    msa.getMessage("sync.config.server.connection.status.ok"));
			connectionState.put(ServerConnectionState.AUTHORIZATION_FAILED.toString(),
			    msa.getMessage("sync.config.server.connection.status.noAuth"));
			connectionState.put(ServerConnectionState.CONNECTION_FAILED.toString(),
			    msa.getMessage("sync.config.server.connection.status.noConnection"));
			connectionState.put(ServerConnectionState.CERTIFICATE_FAILED.toString(),
			    msa.getMessage("sync.config.server.connection.status.noCertificate"));
			connectionState.put(ServerConnectionState.MALFORMED_URL.toString(),
			    msa.getMessage("sync.config.server.connection.status.badUrl"));
			connectionState.put(ServerConnectionState.NO_ADDRESS.toString(),
			    msa.getMessage("sync.config.server.connection.status.noAddress"));
			
			try {
				//Add privilege to enable us access the registered tasks
				Context.addProxyPrivilege(OpenmrsConstants.PRIV_MANAGE_SCHEDULER);
				
				// taskConfig for automated syncing
				TaskDefinition parentSchedule = new TaskDefinition();
				String repeatInterval = "";
				if (parent != null) {
					Collection<TaskDefinition> tasks = Context.getSchedulerService().getRegisteredTasks();
					if (tasks != null) {
						String serverId = parent.getServerId().toString();
						for (TaskDefinition task : tasks) {
							if (task.getTaskClass().equals(SyncConstants.SCHEDULED_TASK_CLASS)) {
								if (serverId.equals(task.getProperty(SyncConstants.SCHEDULED_TASK_PROPERTY_SERVER_ID))) {
									parentSchedule = task;
									Long repeat = parentSchedule.getRepeatInterval() / 60;
									repeatInterval = repeat.toString();
									if (repeatInterval.indexOf(".") > -1)
										repeatInterval = repeatInterval.substring(0, repeatInterval.indexOf("."));
								}
							}
						}
					}
				}
				
				ret.put("connectionState", connectionState.entrySet());
				ret.put("parent", parent);
				ret.put("parentSchedule", parentSchedule);
				ret.put("repeatInterval", repeatInterval);
				ret.put("syncDateDisplayFormat", TimestampNormalizer.DATETIME_DISPLAY_FORMAT);
			}
			finally {
				//We no longer need this privilege.
				Context.removeProxyPrivilege(OpenmrsConstants.PRIV_MANAGE_SCHEDULER);
			}
		}
		
		return ret;
	}
	
}