Project

General

Profile

1 4080 daigle
/**
2
 *  '$RCSfile$'
3
 *    Purpose: A Class that implements utility methods for a metadata catalog
4
 *  Copyright: 2008 Regents of the University of California and the
5
 *             National Center for Ecological Analysis and Synthesis
6
 *    Authors: Michael Daigle
7
 *
8
 *   '$Author$'
9
 *     '$Date$'
10
 * '$Revision$'
11
 *
12
 * This program is free software; you can redistribute it and/or modify
13
 * it under the terms of the GNU General Public License as published by
14
 * the Free Software Foundation; either version 2 of the License, or
15
 * (at your option) any later version.
16
 *
17
 * This program is distributed in the hope that it will be useful,
18
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
 * GNU General Public License for more details.
21
 *
22
 * You should have received a copy of the GNU General Public License
23
 * along with this program; if not, write to the Free Software
24
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
25
 */
26
27
package edu.ucsb.nceas.metacat.admin;
28
29
import java.io.IOException;
30
import java.util.Vector;
31
32
import javax.servlet.ServletConfig;
33
import javax.servlet.ServletException;
34
import javax.servlet.http.HttpServlet;
35
import javax.servlet.http.HttpServletRequest;
36
import javax.servlet.http.HttpServletResponse;
37
import javax.servlet.http.HttpSession;
38
39
import org.apache.log4j.Logger;
40
41 4200 daigle
import edu.ucsb.nceas.metacat.MetaCatServlet;
42 5030 daigle
import edu.ucsb.nceas.metacat.properties.PropertyService;
43 4080 daigle
import edu.ucsb.nceas.metacat.service.SessionService;
44 5015 daigle
import edu.ucsb.nceas.metacat.shared.MetacatUtilException;
45 4592 daigle
import edu.ucsb.nceas.metacat.util.AuthUtil;
46 5026 daigle
import edu.ucsb.nceas.metacat.util.ConfigurationUtil;
47 4080 daigle
import edu.ucsb.nceas.metacat.util.RequestUtil;
48
import edu.ucsb.nceas.metacat.util.SkinUtil;
49
import edu.ucsb.nceas.metacat.util.SystemUtil;
50 4760 daigle
import edu.ucsb.nceas.utilities.GeneralPropertyException;
51 4080 daigle
52
/**
53
 * Entry servlet for the metadata configuration utility
54
 */
55 5026 daigle
public class MetacatAdminServlet extends HttpServlet {
56 4080 daigle
57
	private static final long serialVersionUID = 1L;
58
59 5026 daigle
	private Logger logMetacat = Logger.getLogger(MetacatAdminServlet.class);
60 4080 daigle
61
    /**
62
	 * Initialize the servlet
63
	 */
64
	public void init(ServletConfig config) throws ServletException {
65
		super.init(config);
66
	}
67
68
    /** Handle "GET" method requests from HTTP clients */
69
	public void doGet(HttpServletRequest request, HttpServletResponse response)
70
			throws ServletException, IOException {
71
72
		// Process the data and send back the response
73
		handleGetOrPost(request, response);
74
	}
75
76
	/** Handle "POST" method requests from HTTP clients */
77
	public void doPost(HttpServletRequest request, HttpServletResponse response)
78
			throws ServletException, IOException {
79
80
		// Process the data and send back the response
81
		handleGetOrPost(request, response);
82
	}
83
84
    /**
85
	 * Control servlet response depending on the action parameter specified
86
	 *
87
	 * @param request
88
	 *            the http request information
89
	 * @param response
90
	 *            the http response to be sent back to the client
91
	 */
92
	private void handleGetOrPost(HttpServletRequest request,
93
			HttpServletResponse response) throws ServletException, IOException {
94
		String action = request.getParameter("configureType");
95 5030 daigle
		logMetacat.debug("MetacatAdminServlet.handleGetOrPost - Processing admin action: " + action);
96 4080 daigle
		Vector<String> processingMessage = new Vector<String>();
97
		Vector<String> processingErrors = new Vector<String>();
98
99
		try {
100
			// Update the last update time for this user if they are not new
101
			HttpSession httpSession = request.getSession(false);
102
			if (httpSession != null) {
103
				SessionService.touchSession(httpSession.getId());
104
			}
105
106 5026 daigle
			if (!ConfigurationUtil.isBackupDirConfigured()) {
107 4762 daigle
				// if the backup dir has not been configured, then show the
108
				// backup directory configuration screen.
109
				processingMessage.add("You must configure the backup directory"
110
						+ " before you can continue with Metacat configuration.");
111
				RequestUtil.setRequestMessage(request, processingMessage);
112
				action = "backup";
113 5030 daigle
				logMetacat.debug("MetacatAdminServlet.handleGetOrPost - Admin action changed to 'backup'");
114 4704 daigle
			} else if (!AuthUtil.isAuthConfigured()) {
115
				// if authentication isn't configured, change the action to auth.
116
				// Authentication needs to be set up before we do anything else
117 4592 daigle
				processingMessage.add("You must configure authentication before "
118 4080 daigle
						+ "you can continue with MetaCat configuration.");
119
				RequestUtil.setRequestMessage(request, processingMessage);
120 4592 daigle
				action = "auth";
121 5030 daigle
				logMetacat.debug("MetacatAdminServlet.handleGetOrPost - Admin action changed to 'auth'");
122 4704 daigle
			} else if (!AuthUtil.isUserLoggedInAsAdmin(request)) {
123
				// If auth is configured, see if the user is logged in
124
				// as an administrator.  If not, they need to log in before
125
				// they can continue with configuration.
126 4080 daigle
				processingMessage.add("You must log in as an administrative " + "" +
127
						"user before you can continue with MetaCat configuration.");
128
				RequestUtil.setRequestMessage(request, processingMessage);
129
				action = "login";
130 5030 daigle
				logMetacat.debug("MetacatAdminServlet.handleGetOrPost - Admin action changed to 'login'");
131 4704 daigle
			}
132 4080 daigle
133
			if (action == null || action.equals("configure")) {
134
				// Forward the request main configuration page
135
				request.setAttribute("metaCatVersion", SystemUtil.getMetacatVersion());
136
			    request.setAttribute("propsConfigured", new Boolean(PropertyService.arePropertiesConfigured()));
137 4592 daigle
			    request.setAttribute("authConfigured", new Boolean(AuthUtil.isAuthConfigured()));
138 4200 daigle
			    // TODO MCD figure out if we still need an org section
139
			    //request.setAttribute("orgsConfigured", new Boolean(OrganizationUtil.areOrganizationsConfigured()));
140 4080 daigle
			    request.setAttribute("skinsConfigured", new Boolean(SkinUtil.areSkinsConfigured()));
141 5026 daigle
			    request.setAttribute("metacatConfigured", new Boolean(ConfigurationUtil.isMetacatConfigured()));
142 4200 daigle
			    request.setAttribute("geoserverConfigured",
143
			    		PropertyService.getProperty("configutil.geoserverConfigured"));
144
			    request.setAttribute("metcatServletInitialized", MetaCatServlet.isFullyInitialized());
145 4479 daigle
			    if (PropertyService.arePropertiesConfigured()) {
146
					request.setAttribute("databaseVersion",
147
							DBAdmin.getInstance().getDBVersion());
148 5004 daigle
					request.setAttribute("contextURL", SystemUtil.getContextURL());
149 4479 daigle
				}
150 4080 daigle
				RequestUtil.forwardRequest(request, response,
151 5026 daigle
						"/admin/metacat-configuration.jsp?configureType=configure", null);
152 4080 daigle
				return;
153
			} else if (action.equals("properties")) {
154
				// process properties
155
				PropertiesAdmin.getInstance().configureProperties(request,
156
						response);
157
				return;
158
			} else if (action.equals("skins")) {
159
				// process skins
160
				SkinsAdmin.getInstance().configureSkins(request, response);
161
				return;
162
			} else if (action.equals("database")) {
163 4159 daigle
				// process database
164 4080 daigle
				DBAdmin.getInstance().configureDatabase(request, response);
165
				return;
166 4592 daigle
			} else if (action.equals("auth")) {
167
				// process authentication
168
				AuthAdmin.getInstance().configureAuth(request, response);
169 4080 daigle
				return;
170
			} else if (action.equals("login")) {
171 4159 daigle
				// process login
172 4592 daigle
				LoginAdmin.getInstance().authenticateUser(request, response);
173 4080 daigle
				return;
174 4704 daigle
			} else if (action.equals("backup")) {
175
				// process login
176
				BackupAdmin.getInstance().configureBackup(request, response);
177
				return;
178 4200 daigle
			} else if (action.equals("geoserver")) {
179
				// process geoserver password change
180
				GeoserverAdmin.getInstance().configureGeoserver(request, response);
181
				return;
182 4080 daigle
			} else {
183 5030 daigle
				String errorMessage = "MetacatAdminServlet.handleGetOrPost - Invalid action in configuration request: " + action;
184 4080 daigle
				logMetacat.error(errorMessage);
185
				processingErrors.add(errorMessage);
186 4200 daigle
			}
187 5076 daigle
188
			if (processingErrors.size() > 0) {
189
				RequestUtil.clearRequestMessages(request);
190
				RequestUtil.setRequestErrors(request,processingErrors);
191
				// if the action that threw an exception was "configure" just go straight to the metacat
192
				// configuration.  This will avoid a loop.  Otherwise, call the admin servlet with
193
				// configuration action.
194
				if (action != null && action.equals("configure")) {
195
					RequestUtil.forwardRequest(request, response, "/admin/metacat-configuration.jsp", null);
196
				} else {
197
					RequestUtil.forwardRequest(request, response, "/admin?configureType=configure", null);
198
				}
199
			}
200 4760 daigle
		} catch (GeneralPropertyException ge) {
201 4080 daigle
			String errorMessage =
202 5030 daigle
				"MetacatAdminServlet.handleGetOrPost - Property problem while handling request: " + ge.getMessage();
203 4080 daigle
			logMetacat.error(errorMessage);
204
			processingErrors.add(errorMessage);
205
		} catch (AdminException ae) {
206
			String errorMessage =
207 5030 daigle
				"MetacatAdminServlet.handleGetOrPost - Admin problem while handling request: " + ae.getMessage();
208 4080 daigle
			logMetacat.error(errorMessage);
209
			processingErrors.add(errorMessage);
210 4854 daigle
		} catch (MetacatUtilException ue) {
211 4080 daigle
			String errorMessage =
212 5030 daigle
				"MetacatAdminServlet.handleGetOrPost - Utility problem while handling request: " + ue.getMessage();
213 4080 daigle
			logMetacat.error(errorMessage);
214
			processingErrors.add(errorMessage);
215
		}
216
	}
217
}