aboutsummaryrefslogtreecommitdiff
path: root/src/uk/org/ury/server/Server.java
blob: 697476e5eec0449b2a597cc0613fa14cc7fae014 (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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
/**
 * 
 */
package uk.org.ury.server;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;

import java.net.MalformedURLException;
import java.net.ServerSocket;
import java.net.Socket;
import java.net.URL;
import java.net.URLDecoder;

import java.util.ArrayList;
import java.util.List;
import java.util.HashMap;
import java.util.Map;

import org.apache.http.Header;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.HttpVersion;
import org.apache.http.ParseException;
import org.apache.http.entity.StringEntity;
import org.apache.http.message.BasicHttpResponse;
import org.apache.http.protocol.HTTP;
import org.apache.http.util.EntityUtils;
import org.json.simple.JSONValue;

import uk.org.ury.config.ConfigReader;
import uk.org.ury.database.DatabaseDriver;
import uk.org.ury.database.UserClass;
import uk.org.ury.database.exceptions.ConnectionFailureException;
import uk.org.ury.database.exceptions.MissingCredentialsException;
import uk.org.ury.server.exceptions.BadRequestException;
import uk.org.ury.server.exceptions.HandleFailureException;
import uk.org.ury.server.exceptions.HandlerNotFoundException;
import uk.org.ury.server.exceptions.HandlerSetupFailureException;
import uk.org.ury.server.exceptions.HandlingException;
import uk.org.ury.server.exceptions.NotAHandlerException;
import uk.org.ury.server.protocol.Directive;
import uk.org.ury.server.protocol.Status;

/**
 * The unified URY server, accepting requests over HTTP.
 * 
 * @author  Matt Windsor
 */

public class Server
{

  private ServerSocket serverSocket;
  
  private static final String SERVER_VERSION = "SLUT 0.0";
  private static final String DOCTYPE        = 
      "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\""
    + "\"http://www.w3.org/TR/html4/strict.dtd\">";
  private static final String INDEX_HTML     =
      "\n<html>"
    + "\n  <head>"
    + "\n    <title>" + SERVER_VERSION + "</title>"
    + "\n  </head>"
    + "\n  <body>"
    + "\n    <h1>Welcome to the " + SERVER_VERSION + " server</h1>"
    + "\n    <p>This server exposes a class-based API for accessing"
    + "\n    the internals of the " + SERVER_VERSION + " system.</p>"
    + "\n    <p>See the documentation for details.</p>"
    + "\n  </body>"
    + "\n</html>";
  
  
  /**
   * The main method, which serves to create a server.
   * 
   * @param args  The argument vector.
   */
  
  public static void
  main (String[] args)
  {
    Server srv = new Server ();
    srv.run ();
  }

  
  /**
   * Run the server.
   */
  
  private void
  run ()
  {
    try
      {
        serverSocket = new ServerSocket (8000);
      }
    catch (IOException e)
      {
        // TODO Auto-generated catch block
        e.printStackTrace ();
      }
    
    Socket clientSocket = null;
    
    while (true)
    {
      System.out.println ("Accepting connections... bring 'em on!");
      
      try
      {
        clientSocket = serverSocket.accept ();
      }
      catch (IOException e)
      {
        System.out.println ("SLUT: Accept failed on port 8000.  I'm bailing.");
        System.exit (-1);
      }
    
      try
        {
          doConnection (clientSocket);
        }
      catch (IOException e)
        {
          e.printStackTrace ();
        }
      finally
        {
          try
            {
              clientSocket.close ();
            }
          catch (IOException e)
            {
              // TODO Auto-generated catch block
              e.printStackTrace();
            }
        }
    }
  }

  
  public void
  doConnection (Socket clientSocket)
  throws IOException
  {
    PrintWriter out = new PrintWriter (clientSocket.getOutputStream(), true);
    BufferedReader in = new BufferedReader (new InputStreamReader (
                                            clientSocket.getInputStream()));
    String inputLine;

    //initiate conversation with client
    
    List<String> buffer = new ArrayList<String> ();
    
    
    for (inputLine = in.readLine (); inputLine != null; inputLine = in.readLine ())
      {
        if (inputLine.equals (""))
          break;
        
        buffer.add (inputLine);

        if (inputLine.startsWith ("Expect:") 
            && inputLine.split (":")[1].startsWith ("100-continue"))
          out.print ("HTTP/1.1 100 Continue\n\r\n");

        out.flush ();
      }
    
    processBuffer (buffer, out);
    
    out.flush ();
    out.close ();
    in.close ();
    
    System.out.println ("Just finished with this one...");
  }
  
  
  public void
  processBuffer (List<String> buffer, PrintWriter out)
  { 
    String requestStart = buffer.get (0);
    
    System.out.println (requestStart);
    
    HttpResponse response;
    
    if (requestStart.startsWith ("GET"))
      {
        System.out.println ("That was a GET..."); 
        try
          {
            response = handleGet (buffer);
          }
        catch (HandlerNotFoundException e)
          {
            // TODO: log
            response = serveError (HttpStatus.SC_NOT_FOUND,
                                   e.getMessage ());
          }
        catch (BadRequestException e)
          {
            // TODO: log
            response = serveError (HttpStatus.SC_BAD_REQUEST,
                                   e.getMessage ());
          }
        catch (HandlingException e)
          {
            response = serveError (HttpStatus.SC_INTERNAL_SERVER_ERROR,
                e.getMessage ());
          }
      }
    else
      {
        System.out.println ("Uh-oh! I don't know what to do!");
        response = serveError (HttpStatus.SC_NOT_IMPLEMENTED, 
                               "Feature not implemented yet.");
      }
    
    
    // Now send the response.
    
    for (Header h : response.getAllHeaders ())
      {
        out.println (h);
      }
    
    try
      {
        out.print (EntityUtils.toString (response.getEntity ()));
      }
    catch (ParseException e)
      {
        // TODO Auto-generated catch block
        e.printStackTrace ();
      }
    catch (IOException e)
      {
        // TODO Auto-generated catch block
        e.printStackTrace ();
      }
  }
  
  
  /**
   * Handle a HTTP GET request.
   * 
   * @param buffer  The HTTP request as a list of strings.
   * 
   * @return        The HTTP response.
   * 
   * @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.
   */
  
  public HttpResponse
  handleGet (List<String> buffer)
  throws HandlerNotFoundException, HandlerSetupFailureException,
    HandleFailureException, BadRequestException, NotAHandlerException
  {
    HttpResponse response = null;
    
    String[] getsplit = buffer.get (0).split (" ");
    String   path     = getsplit[1];
    
    if (path.equals ("/index.html")
        || path.equals ("/"))
      {
        // Someone's trying to get the index page!
        // Humour them.
        
        response = new BasicHttpResponse (HttpVersion.HTTP_1_1,
                                          HttpStatus.SC_OK,
                                          "OK");
        
        StringEntity entity = null;
        
        try
          {
            entity = new StringEntity (DOCTYPE + INDEX_HTML);
          }
        catch (UnsupportedEncodingException e)
          {
            throw new HandlerSetupFailureException ("(Index page)", e);
          }

        response.setEntity (entity);
      }
    else
      {
        // Convert this into a URL and fan out the various parts of it.
        
        URL pathURL = null;
        
        try
          {
            pathURL = new URL ("http://localhost" + path);
          }
        catch (MalformedURLException e)
          {
            throw new BadRequestException (e);
          }

        String className    = "uk.org.ury" + pathURL.getPath ().replace ('/', '.');
        System.out.println (className);
        Class<?> newClass   = null;
     
        
        try
          {
            newClass = Class.forName (className);
          }
        catch (ClassNotFoundException e)
          {
            throw new HandlerNotFoundException (className, e);
          }
        
        
        // Check for error (response set) here.
        
        if (response == null
            && RequestHandler.class.isAssignableFrom (newClass))
          {
            String queryString = pathURL.getQuery ();
            Map<String, String> parameters;
            
            try
              {
                parameters = parseQueryString (queryString);
              }
            catch (UnsupportedEncodingException e)
              {
                throw new HandlerSetupFailureException (className, e);
              }
            
            Map<String, Object> content = null;
                
            try
              {
                RequestHandler srh = ((RequestHandler) newClass.newInstance ());
                content = srh.handleGetRequest (parameters, this);
              }
            catch (InstantiationException e)
              {
                throw new HandlerSetupFailureException (className, e);
              }
            catch (IllegalAccessException e)
              {
                throw new HandlerSetupFailureException (className, e);
              }
            
            
            // Everything seems OK, so make the response.
            
            response = new BasicHttpResponse (HttpVersion.HTTP_1_1, 
                                                  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 (className, e);
              }
                
            entity.setContentType (HTTP.PLAIN_TEXT_TYPE);
            response.setEntity (entity);
          }
        else
          throw new NotAHandlerException (className);
      }
    
    return response;
  }
  
  
  /**
   * Serve a HTTP plain-text error as a HTTP response.
   * 
   * @param code    HTTP status code to use.
   * @param reason  The reason to display to the client.
   * 
   * @return        the HTTP response for the error.
   */
  
  private HttpResponse
  serveError (int code, String reason)
  {  
    // Get the reason string to put in the error response.
    
    String statusReason = "";
    
    switch (code)
      {
      case HttpStatus.SC_BAD_REQUEST:
        statusReason = "Bad Request";
        break;
      case HttpStatus.SC_NOT_FOUND:
        statusReason = "Not Found";
        break;
      default:
      case HttpStatus.SC_INTERNAL_SERVER_ERROR:
        statusReason = "Internal Server Error";
        break;
      }
    
    HttpResponse response = new BasicHttpResponse (HttpVersion.HTTP_1_1,
                                                   code, statusReason);
    StringEntity entity = null;
    
    try
      {
        Map<String, Object> content = new HashMap<String, Object> ();
        
        content.put (Directive.STATUS.toString (),
                     Status.ERROR.toString ());
        content.put (Directive.REASON.toString (),
                     reason);
        
        entity = new StringEntity (JSONValue.toJSONString (content));
      }
    catch (UnsupportedEncodingException e)
      {
        // TODO Auto-generated catch block
        e.printStackTrace ();
      }
    
    if (entity != null)
      {
        entity.setContentType (HTTP.PLAIN_TEXT_TYPE);
        response.setEntity (entity);
      }
    
    return response;
  }
  
  
  /**
   * Parse a query string, populating a key-value map of the 
   * URL-unescaped results.
   * 
   * @param query  The query string to parse.
   * 
   * @return       A map associating parameter keys and values.
   * 
   * @throws       UnsupportedEncodingException if the URL decoder
   *               fails.
   */
  
  public Map<String, String>
  parseQueryString (String query)
  throws UnsupportedEncodingException
  {
    Map<String, String> params = new HashMap<String, String> ();
    
    // At least one parameter
    if (query != null
        && query.endsWith ("&") == false)
      {
        String[] qsplit = {query};
        
        // More than one parameter - split the query.
        if (query.contains ("&"))
          qsplit = query.split ("&");

        
        for (String param : qsplit)
          {
            // Has a value
            if (param.contains ("=")
                && param.endsWith ("=") == false)
              {
                String[] paramsplit = param.split ("=");
                params.put (URLDecoder.decode (paramsplit[0], "UTF-8"), 
                            URLDecoder.decode (paramsplit[1], "UTF-8"));
              }
            // Doesn't have a value
            else if (param.contains ("=") == false)
              {
                params.put (URLDecoder.decode (param, "UTF-8"), null);
              }
          }
      }
    
    return params;
  }
  
  
  /**
   * Get a database connection using the given user class.
   * 
   * @param  userClass  The user class to get a connection for.
   * 
   * @return            a database connection, which may or may not 
   *                    have been created on this call.
   *                    
   * @throw             MissingCredentialsException if the credentials
   *                    for the given userclass are missing.
   * 
   * @throw             ConnectionFailureException if the connection 
   *                    failed.
   */
  
  public DatabaseDriver
  getDatabaseConnection (UserClass userClass)
  throws MissingCredentialsException, ConnectionFailureException
  {
    // TODO: Singleton
  
    ConfigReader config = new ConfigReader ("res/conf.xml");
    
    return new DatabaseDriver (config, UserClass.READ_ONLY);
  }


  /**
   * @return  the version string of the server.
   */
  
  public String
  getVersion ()
  {
    return SERVER_VERSION;
  }
}