File: TestWebServer.m

package info (click to toggle)
gnustep-base 1.24.9-3.1%2Bdeb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 26,844 kB
  • sloc: objc: 975,047; ansic: 31,533; makefile: 135; cpp: 122; sh: 102; xml: 32
file content (468 lines) | stat: -rw-r--r-- 10,938 bytes parent folder | download | duplicates (3)
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
/*
 *  Author: Sergei Golovin <Golovin.SV@gmail.com>
 */

#import "TestWebServer.h"
#import "RequestHandler.h"

@interface TestWebServer (Private)

/**
 *  Starts the detached thread. It is the entry point of the thread.
 */ 
- (void)_startDetached:(id)extra;

/**
 *  Starts the SimpleWebServer.
 */
- (void)_startHTTPServer:(id)extra;

/**
 *  Stops the SimpleWebServer.
 */
- (void)_stopHTTPServer;


@end 

/* default 'constants' */
#define DEFAULTADDRESS @"127.0.0.1"
#define DEFAULTPORT @"1234"
#define DEFAULTMODE NO
#define DEFAULTLOGIN @"login"
#define DEFAULTPASSWORD @"password"

/* lock's conditions */
#define READY   0 /* the initial condition */
#define STARTED 1 /* the SimpleWebServer has been started */
#define STOPPED 2 /* the SimpleWebServer has been stopped */

/* the time step for the runloop */
#define TIMING 0.1
/* the maximum duration of running of the SimpleWebServer instance
   after which the server must be shut down */
#define MAXDURATION 5.0

@implementation TestWebServer

- (id)init
{
  return [self initWithAddress: DEFAULTADDRESS
			  port: DEFAULTPORT
			  mode: DEFAULTMODE
			 extra: nil];
}

- (id)initWithAddress:(NSString *)address
		 port:(NSString *)port
		 mode:(BOOL)detached
		extra:(id)extra
{
  if ((self = [super init]) != nil)
    {
      _debug = NO;
      _address = [[NSHost hostWithName: address] address];
      RETAIN(_address);
      ASSIGN(_port, port);
      ASSIGN(_extra, extra);
      _password = nil;
      _login = nil;
      _isSecure = NO;
      
      if ([extra isKindOfClass: [NSDictionary class]])
	{
	  NSDictionary *d = extra;
	  NSString *proto;

	  if ((_password = [d objectForKey: @"Password"]) != nil)
	    {
	      RETAIN(_password);
	    }
	  if ((_login = [d objectForKey: @"Login"]) != nil)
	    {
	      RETAIN(_login);
	    }
	  if ((proto = [d objectForKey: @"Protocol"]) != nil &&
	     [[proto lowercaseString] isEqualToString: @"https"])
	    {
	      _isSecure = YES;
	    }
	}

      if (nil == _login)
	{
	  _login = DEFAULTLOGIN; RETAIN(_login);
	}
      if (nil == _password)
	{
	  _password = DEFAULTPASSWORD; RETAIN(_password);
	}

      _traversalMap = [[NSMutableDictionary alloc]
			initWithObjectsAndKeys:
			  [Handler200 class], @"200",
			[Handler204 class], @"204",
			[Handler301 class], @"301",
			[Handler400 class], @"400",
			[Handler401 class], @"401",
			[Handler402 class], @"402",
			[Handler404 class], @"404",
			[Handler405 class], @"405",
			[Handler409 class], @"409",
			[Handler500 class], @"500",
			[Handler505 class], @"505",
			[Handler507 class], @"507",
			[HandlerIndex class], @"index",
			nil];

      _lock = [[NSConditionLock alloc] initWithCondition: READY];
      _threadToQuit = NO;
      if (detached)
	{
	  _serverThread = [[NSThread alloc] initWithTarget: self
						  selector: @selector(_startDetached:)
						    object: extra];
	}
      else 
	{
	  _serverThread = nil;
	}
    }

  return self;
}

- (void)dealloc
{
  DESTROY(_lock);
  DESTROY(_address);
  DESTROY(_port);
  DESTROY(_extra);
  DESTROY(_login);
  DESTROY(_password);
  _delegate = nil;
  DESTROY(_traversalMap);
  [super dealloc];
}

- (void)start:(id)extra
{
  if ([_server port] != nil)                                                                                                           
    {                                                                                                                                 
      if (YES == _debug)                                                                                                               
	{
	  NSWarnMLog(@"SimpleWebServer already started");
	}
      return;                                                                                                                         
    }

  if (nil != _serverThread)
    {
      if (![_serverThread isExecuting])
	{
	  NSTimeInterval duration = 0.0;
	  [_serverThread start];

	  // wait for the SimpleWebServer is started
	  while(![_lock tryLockWhenCondition: STARTED] &&
		duration < MAXDURATION)
	    {
	      [[NSRunLoop currentRunLoop]
		runUntilDate: [NSDate dateWithTimeIntervalSinceNow: TIMING]];
	      duration += TIMING;
	    }
	  [_lock unlock];
	  if (duration >= MAXDURATION &&
	     nil != _delegate &&
	     [_delegate respondsToSelector: @selector(timeoutExceededByHandler:)])
	    {
	      [_delegate timeoutExceededByHandler: self];
	      [self stop];
	    }
	}
      else
	{
	  NSWarnMLog(@"the detached thread is already started");
	}
    }
  else
    {
      [self _startHTTPServer: extra];
    }
}

- (void)stop
{
  if ([_server port] == nil)
    {
      if (YES == _debug)
	{
	  NSWarnMLog(@"SimpleWebServer already stopped");
	}
      return;
    }
  if (nil != _serverThread)
    {
      if ([_serverThread isExecuting])
	{
	  NSTimeInterval duration = 0.0;
	  _threadToQuit = YES; // this makes the detached thread quiting from it's runloop

	  // wait for the SimpleWebServer is stopped
	  while(![_lock tryLockWhenCondition: STOPPED] &&
		duration < MAXDURATION)
	    {
	      [[NSRunLoop currentRunLoop]
		runUntilDate: [NSDate dateWithTimeIntervalSinceNow: TIMING]];
	      duration += TIMING;
	    }
	  [_lock unlockWithCondition: READY];
	  if (duration >= MAXDURATION &&
	     nil != _delegate &&
	     [_delegate respondsToSelector: @selector(timeoutExceededByHandler:)])
	    {
	      [_delegate timeoutExceededByHandler: self];
	    }
	}
    }
  else
    {
      [self _stopHTTPServer];
    }
}

- (BOOL) processRequest:(GSMimeDocument *)request
               response:(GSMimeDocument *)response
		    for:(SimpleWebServer *)server
{
  NSString *path;
  NSString *component;
  NSEnumerator *en;
  BOOL ret = NO;
  id handler;

  // analyze the path to infer what the client wants
  path = [[request headerNamed:@"x-http-path"] value];

  // traverse over the path to search the right handler
  en = [[path pathComponents] objectEnumerator];
  while((component = [en nextObject]) != nil)
    {
      if ((handler = [_traversalMap objectForKey: component]) != nil)
	{
	  // the handler has been found
	  break; // while
	}
    }

  if (nil == component)
    {
      // no component found... default 204
      component = @"204";
      handler = [_traversalMap objectForKey: component];
    }

  if (handler == [handler class])
    {
      // it is a Class not an instance... instantiate and substitute
      // instead of the Class
      Class cls = (Class)handler;
      handler = [[cls alloc] init];
      [_traversalMap setObject: handler forKey: component];
    }

  // set the handler
  [handler setDelegate: _delegate];
  [handler setLogin: _login];
  [handler setPassword: _password];
  if ([handler respondsToSelector: @selector(setURLString:)])
    {
      if ([handler isKindOfClass: [HandlerIndex class]])
	{
	  NSString *urlString = [NSString stringWithFormat: @"%@://%@:%@/",
				     _isSecure ? @"https" : @"http",
					  _address,
					  _port];
	  
	  [(HandlerIndex *)handler setURLString: urlString];
	}
      else if ([handler isKindOfClass: [Handler301 class]])
	{
	  // by default http://127.0.0.1:1235/
	  NSString *port = [NSString stringWithFormat: @"%u", [_port intValue] + 1]; // the TestWebServer's port + 1
	  NSString *urlString = [NSString stringWithFormat: @"%@://%@:%@/",
				     _isSecure ? @"https" : @"http",
					  _address,
					  port];
      
	  [(Handler301 *)handler setURLString: urlString];
	}
    }

  // TODO: add session-related conditions here
  [handler prehandleRequest: request
		   response: response
			for: self];

  // the main job
  ret = [handler handleRequest: request
		      response: response
			   for: self];
  // TODO: analyze 'ret'... if NO a default handler must be called

  // TODO: add session-related conditions here
  [handler posthandleRequest: request
		    response: response
			 for: self];
  

  return ret;
}

/* end of SimpleWebServer delegate */


/* getters */

- (NSString *)address
{
  return _address;
}

- (NSString *)port
{
  return _port;
}

- (NSString *)login
{
  return _login;
}

- (NSString *)password
{
  return _password;
}

- (BOOL)isSecure
{
  return _isSecure;
}

/* end of getters */

/* setters */
- (void)setDelegate:(id)delegate
{
  _delegate = delegate;
}

- (void)setDebug:(BOOL)mode
{
  _debug = mode;
}

/* end of setters */

@end /* TestWebServer */


@implementation TestWebServer (Private)

- (void)_startHTTPServer:(id)extra
{
  NSString *certPath;
  NSString *keyPath;
  NSDictionary *secure = nil;
  BOOL status;

  _server = [SimpleWebServer new];
  [_server setDebug: _debug];
  [_server setDelegate: self];
  if (_isSecure)
    {
      if ([_address isEqualToString: @"127.0.0.1"] ||
	 [_address isEqualToString: @"localhost"])
	{
	  certPath = [[NSBundle bundleForClass: [self class]]
		       pathForResource: @"testCert"
				ofType: @"pem"];
	  keyPath = [[NSBundle bundleForClass: [self class]]
		      pathForResource: @"testKey"
			       ofType: @"pem"];
	  secure = [NSDictionary dictionaryWithObjectsAndKeys:
				   certPath, @"CertificateFile",
				 keyPath, @"KeyFile",
				 nil];
	}
      else
	{
	  // NOTE: generate corresponding certificates for any address differing
	  //       from 127.0.0.1
	}
    }

  status = [_server setAddress: _address port: _port secure: secure]; // run the server
  if (!status)                                                                                                                         
    {
      [NSException raise: NSInternalInconsistencyException
		  format: @"The server hasn't run. Perhaps the port %@ is invalid", DEFAULTPORT];
    }
}

- (void)_stopHTTPServer
{
  if (nil != _server && [_server port] != nil)                                                                                         
    {
      [_server stop]; // shut down the server
      if (YES == _debug)
	{
	  NSLog(@"%@: stopped SimpleWebServer %@", self, _server);
	}
      DESTROY(_server);
    }
}

- (void)_startDetached:(id)extra
{
  CREATE_AUTORELEASE_POOL(arp);
  NSTimeInterval duration = 0.0;

  [_lock lockWhenCondition: READY];
  [self _startHTTPServer: extra];
  [_lock unlockWithCondition: STARTED];

  if (YES == _debug)
    {
      NSLog(@"%@: enter into runloop in detached thread %@", self, [NSThread currentThread]);
    }

  while(!_threadToQuit && duration < MAXDURATION)
    {
      [[NSRunLoop currentRunLoop]
	runUntilDate: [NSDate dateWithTimeIntervalSinceNow: TIMING]];
      duration += TIMING;
    }

  if (YES == _debug)
    {
      NSLog(@"%@: exit from runloop in detached thread %@", self, [NSThread currentThread]);
    }

  if (duration >= MAXDURATION &&
     nil != _delegate &&
     [_delegate respondsToSelector: @selector(timeoutExceededByHandler:)])
    {
      [_delegate timeoutExceededByHandler: self];
    }

  [_lock lockWhenCondition: STARTED];
  [self _stopHTTPServer];
  [_lock unlockWithCondition: STOPPED];

  DESTROY(arp);
}



@end /* TestWebServer (Private) */