aboutsummaryrefslogtreecommitdiff
path: root/src/uk/org/ury/backend/handlers/LibraryRequestHandler.java
blob: 25423f651d4621f6dc387e8c95f9ea797136a609 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/**
 * 
 */
package uk.org.ury.backend.handlers;

import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;

import org.apache.http.HttpRequest;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.entity.StringEntity;
import org.apache.http.protocol.HTTP;
import org.apache.http.protocol.HttpContext;
import org.json.simple.JSONValue;

import uk.org.ury.backend.database.DatabaseDriver;
import uk.org.ury.backend.database.UserClass;
import uk.org.ury.backend.database.exceptions.ConnectionFailureException;
import uk.org.ury.backend.database.exceptions.MissingCredentialsException;
import uk.org.ury.backend.database.exceptions.QueryFailureException;
import uk.org.ury.backend.server.AbstractRequestHandler;
import uk.org.ury.backend.server.Server;
import uk.org.ury.backend.server.exceptions.BadRequestException;
import uk.org.ury.backend.server.exceptions.HandleFailureException;
import uk.org.ury.backend.server.exceptions.HandlerNotFoundException;
import uk.org.ury.backend.server.exceptions.HandlerSetupFailureException;
import uk.org.ury.backend.server.exceptions.NotAHandlerException;
import uk.org.ury.backend.server.exceptions.UnknownFunctionException;
import uk.org.ury.common.library.LibraryUtils;
import uk.org.ury.common.library.exceptions.EmptySearchException;
import uk.org.ury.common.library.item.LibraryItem;
import uk.org.ury.common.protocol.Directive;
import uk.org.ury.common.protocol.Status;

/**
 * A request handler for library queries.
 * 
 * @author Matt Windsor
 */
public class LibraryRequestHandler extends AbstractRequestHandler {
    /**
     * Construct a new LibraryRequestHandler.
     * 
     * @param server
     *            The instance of the URY server responsible for the request.
     * 
     * @param mount
     *            The directory to which this handler is to be mounted.
     */
    public LibraryRequestHandler(Server server, String mount) {
	super(server, mount);
    }

    /**
     * Perform a library search, populating the response list.
     * 
     * @param parameters
     *            A key-value map of parameters supplied with the server
     *            request. Typically, the function parameter will detail the
     *            function that the request handler is expected to perform.
     * 
     * @param response
     *            The response list to populate.
     * 
     * @param server
     *            The server providing database resources.
     * 
     * @throws HandleFailureException
     *             if an error occurs that thwarts the handling of the request.
     */

    private void doSearch(Map<String, String> parameters,
	    Map<String, Object> response, Server server)
	    throws HandleFailureException {
	if (parameters.containsKey("search") == false)
	    throw new HandleFailureException("Search term is missing.");
	else if (parameters.get("search") == null)
	    throw new HandleFailureException("Search term is null.");

	String search = parameters.get("search");
	DatabaseDriver dd = null;

	try {
	    dd = server.getDatabaseConnection(UserClass.READ_ONLY);
	} catch (MissingCredentialsException e) {
	    throw new HandleFailureException(e.getMessage());
	} catch (ConnectionFailureException e) {
	    throw new HandleFailureException(e.getMessage());
	}

	try {
	    List<Map<String, String>> itemArray = new ArrayList<Map<String, String>>();

	    for (LibraryItem li : LibraryUtils.search(dd, search)) {
		itemArray.add(li.asResponse());
	    }

	    response.put(Directive.ITEMS.toString(), itemArray);
	} catch (QueryFailureException e) {
	    throw new HandleFailureException(e.getMessage());
	} catch (EmptySearchException e) {
	    throw new HandleFailureException(e.getMessage());
	}
    }

    /**
     * Handle a HTTP GET request.
     * 
     * @param request
     *            The HTTP request.
     * 
     * @param response
     *            The response that the handler will populate during the
     *            handling of the request.
     * 
     * @param context
     *            The HTTP context.
     * 
     * @throws HandlerNotFoundException
     *             if the client requested a request handler that could not be
     *             found on the class path.
     * 
     * @throws HandlerSetupFailureException
     *             if the handler was found but could not be set up (eg does not
     *             implement appropriate interface or cannot be instantiated).
     * 
     * @throws HandleFailureException
     *             if an appropriate handler was contacted, but it failed to
     *             process the request.
     * 
     * @throws BadRequestException
     *             if the request was malformed or invalid.
     * 
     * @throws NotAHandlerException
     *             if the class requested to handle the request is not a
     *             handler.
     * 
     * @throws UnknownFunctionException
     *             if the request is for a path that does not correspond to one
     *             of this handler's functions.
     */
    @Override
    public void handleGet(HttpRequest request, HttpResponse response,
	    HttpContext context) throws HandlerNotFoundException,
	    HandlerSetupFailureException, HandleFailureException,
	    BadRequestException, NotAHandlerException, UnknownFunctionException {
	String path;
	String uri = request.getRequestLine().getUri();
	String query = getQueryString(uri);

	if (query == null)
	    path = uri.toLowerCase(Locale.ENGLISH);
	else
	    path = uri.split("\\?" + query)[0].toLowerCase(Locale.ENGLISH);

	Map<String, Object> content = new HashMap<String, Object>();

	if (path.equals("/library/tracks")) {
	    try {
		doSearch(parseQueryString(query), content, server);
	    } catch (UnsupportedEncodingException e) {
		throw new HandleFailureException(e.getMessage());
	    }
	} else {
	    throw new UnknownFunctionException(path);
	}

	response.setStatusLine(request.getProtocolVersion(), HttpStatus.SC_OK,
		"OK");

	content.put(Directive.STATUS.toString(), Status.OK.toString());

	StringEntity entity = null;

	try {
	    entity = new StringEntity(JSONValue.toJSONString(content));
	} catch (UnsupportedEncodingException e) {
	    throw new HandlerSetupFailureException(getClass().getName(), e);
	}

	entity.setContentType(HTTP.PLAIN_TEXT_TYPE);
	response.setEntity(entity);
    }
}