gcdwebserver

Overview
========


GCDWebServer is a modern and lightweight GCD based HTTP 1.1 server designed to be embedded in iOS, macOS & tvOS apps. It was written from scratch with the following goals in mind:
* Elegant and easy to use architecture with only 4 core classes: server, connection, request and response (see "Understanding GCDWebServer's Architecture" below)
* Well designed API with fully documented headers for easy integration and customization
* Entirely built with an event-driven design using Grand Central Dispatch for best performance and concurrency
* No dependencies on third-party source code
* Available under a friendly New BSD License

Extra built-in features:
* Allow implementation of fully asynchronous handlers of incoming HTTP requests
* Minimize memory usage with disk streaming of large HTTP request or response bodies
* Parser for web forms submitted using "application/x-www-form-urlencoded" or "multipart/form-data" encodings (including file uploads)
* JSON parsing and serialization for request and response HTTP bodies
* Chunked transfer encoding for request and response HTTP bodies
* HTTP compression with gzip for request and response HTTP bodies
* HTTP range support for requests of local files
* Basic and Digest Access authentications for password protection
* Automatically handle transitions between foreground, background and suspended modes in iOS apps
* Full support for both IPv4 and IPv6
* NAT port mapping (IPv4 only)

Included extensions:
* GCDWebUploader: subclass of ``GCDWebServer` that implements an interface for uploading and downloading files using a web browser
* GCDWebDAVServer: subclass of `GCDWebServer` that implements a class 1 WebDAV server (with partial class 2 support for macOS Finder)

What's not supported (but not really required from an embedded HTTP server):
* Keep-alive connections
* HTTPS

Requirements:
* macOS 10.7 or later (x86_64)
* iOS 8.0 or later (armv7, armv7s or arm64)
* tvOS 9.0 or later (arm64)
* ARC memory management only (if you need MRC support use GCDWebServer 3.1 or earlier)

Getting Started
===============

Download or check out the latest release of GCDWebServer then add the entire "GCDWebServer" subfolder to your Xcode project. If you intend to use one of the extensions like GCDWebDAVServer or GCDWebUploader, add these subfolders as well. Finally link to libz (via Target > Build Phases > Link Binary With Libraries) and add $(SDKROOT)/usr/include/libxml2 to your header search paths (via Target > Build Settings > HEADER_SEARCH_PATHS).

Alternatively, you can install GCDWebServer using CocoaPods by simply adding this line to your Podfile:
`
pod "GCDWebServer", "~> 3.0"
`
If you want to use GCDWebUploader, use this line instead:
`
pod "GCDWebServer/WebUploader", "~> 3.0"
`
Or this line for GCDWebDAVServer:
`
pod "GCDWebServer/WebDAV", "~> 3.0"
`

And finally run $ pod install.

You can also use Carthage by adding this line to your Cartfile (3.2.5 is the first release with Carthage support):
`
github "swisspol/GCDWebServer" ~> 3.2.5
`

Then run $ carthage update and add the generated frameworks to your Xcode projects (see Carthage instructions).

Help & Support
==============

For help with using GCDWebServer, it's best to ask your question on Stack Overflow with the gcdwebserver tag. For bug reports and enhancement requests you can use issues in this project.

Be sure to read this entire README first though!

Hello World
===========

These code snippets show how to implement a custom HTTP server that runs on port 8080 and returns a "Hello World" HTML page to any request. Since GCDWebServer uses GCD blocks to handle requests, no subclassing or delegates are needed, which results in very clean code.

IMPORTANT: If not using CocoaPods, be sure to add the libz shared system library to the Xcode target for your app.

macOS version (command line tool):
`objectivec
#import "GCDWebServer.h"
#import "GCDWebServerDataResponse.h"

int main(int argc, const char* argv[]) {
@autoreleasepool {

// Create server
GCDWebServer* webServer = [[GCDWebServer alloc] init];

// Add a handler to respond to GET requests on any URL
[webServer addDefaultHandlerForMethod:@"GET"
requestClass:[GCDWebServerRequest class]
processBlock:^GCDWebServerResponse (GCDWebServerRequest request) {

return [GCDWebServerDataResponse responseWithHTML:@"

Hello World

"];

}];

// Use convenience method that runs server on port 8080
// until SIGINT (Ctrl-C in Terminal) or SIGTERM is received
[webServer runWithPort:8080 bonjourName:nil];
NSLog(@"Visit %@ in your web browser", webServer.serverURL);

}
return 0;
}
`

iOS version:
`objectivec
#import "GCDWebServer.h"
#import "GCDWebServerDataResponse.h"

@interface AppDelegate : NSObject {
GCDWebServer* _webServer;
}
@end

@implementation AppDelegate

- (BOOL)application:(UIApplication)application didFinishLaunchingWithOptions:(NSDictionary)launchOptions {

// Create server
_webServer = [[GCDWebServer alloc] init];

// Add a handler to respond to GET requests on any URL
[_webServer addDefaultHandlerForMethod:@"GET"
requestClass:[GCDWebServerRequest class]
processBlock:^GCDWebServerResponse (GCDWebServerRequest request) {

return [GCDWebServerDataResponse responseWithHTML:@"

Hello World

"];

}];

// Start server on port 8080
[_webServer startWithPort:8080 bonjourName:nil];
NSLog(@"Visit %@ in your web browser", _webServer.serverURL);

return YES;
}

@end
`

macOS Swift version (command line tool):

webServer.swift
`swift
import Foundation
import GCDWebServer

func initWebServer() {

let webServer = GCDWebServer()

webServer.addDefaultHandler(forMethod: "GET", request: GCDWebServerRequest.self, processBlock: {request in
return GCDWebServerDataResponse(html:"

Hello World

")

})

webServer.start(withPort: 8080, bonjourName: "GCD Web Server")

print("Visit \(webServer.serverURL) in your web browser")
}
`

WebServer-Bridging-Header.h
`objectivec
#import
#import
`

Web Based Uploads in iOS Apps
=============================

GCDWebUploader is a subclass of `GCDWebServer` that provides a ready-to-use HTML 5 file uploader & downloader. This lets users upload, download, delete files and create directories from a directory inside your iOS app's sandbox using a clean user interface in their web browser.

Simply instantiate and run a `GCDWebUploader` instance then visit `http://{YOUR-IOS-DEVICE-IP-ADDRESS}/` from your web browser:

`objectivec
#import "GCDWebUploader.h"

@interface AppDelegate : NSObject {
GCDWebUploader* _webUploader;
}
@end

@implementation AppDelegate

- (BOOL)application:(UIApplication)application didFinishLaunchingWithOptions:(NSDictionary)launchOptions {
NSString* documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
_webUploader = [[GCDWebUploader alloc] initWithUploadDirectory:documentsPath];
[_webUploader start];
NSLog(@"Visit %@ in your web browser", _webUploader.serverURL);
return YES;
}

@end
`

WebDAV Server in iOS Apps
=========================

GCDWebDAVServer is a subclass of `GCDWebServer` that provides a class 1 compliant WebDAV server. This lets users upload, download, delete files and create directories from a directory inside your iOS app's sandbox using any WebDAV client like Transmit (Mac), ForkLift (Mac) or CyberDuck (Mac / Windows).

GCDWebDAVServer should also work with the macOS Finder as it is partially class 2 compliant (but only when the client is the macOS WebDAV implementation).

Simply instantiate and run a `GCDWebDAVServer` instance then connect to `http://{YOUR-IOS-DEVICE-IP-ADDRESS}/` using a WebDAV client:

`objectivec
#import "GCDWebDAVServer.h"

@interface AppDelegate : NSObject {
GCDWebDAVServer* _davServer;
}
@end

@implementation AppDelegate

- (BOOL)application:(UIApplication)application didFinishLaunchingWithOptions:(NSDictionary)launchOptions {
NSString* documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
_davServer = [[GCDWebDAVServer alloc] initWithUploadDirectory:documentsPath];
[_davServer start];
NSLog(@"Visit %@ in your WebDAV client", _davServer.serverURL);
return YES;
}

@end
`

Serving a Static Website
========================

GCDWebServer includes a built-in handler that can recursively serve a directory (it also lets you control how the "Cache-Control" header should be set):

macOS version (command line tool):
`objectivec
#import "GCDWebServer.h"

int main(int argc, const char* argv[]) {
@autoreleasepool {

GCDWebServer* webServer = [[GCDWebServer alloc] init];
[webServer addGETHandlerForBasePath:@"/" directoryPath:NSHomeDirectory() indexFilename:nil cacheAge:3600 allowRangeRequests:YES];
[webServer runWithPort:8080];

}
return 0;
}
`

Using GCDWebServer
==================

You start by creating an instance of the `GCDWebServer` class. Note that you can have multiple web servers running in the same app as long as they listen on different ports.

Then you add one or more "handlers" to the server: each handler gets a chance to handle an incoming web request and provide a response. Handlers are called in a LIFO queue, so the latest added handler overrides any previously added ones.

Finally you start the server on a given port.

Understanding GCDWebServer's Architecture
=========================================

GCDWebServer's architecture consists of only 4 core classes:
* GCDWebServer manages the socket that listens for new HTTP connections and the list of handlers used by the server.
* GCDWebServerConnection is instantiated by `GCDWebServer` to handle each new HTTP connection. Each instance stays alive until the connection is closed. You cannot use this class directly, but it is exposed so you can subclass it to override some hooks.
* GCDWebServerRequest is created by the `GCDWebServerConnection` instance after HTTP headers have been received. It wraps the request and handles the HTTP body if any. GCDWebServer comes with several subclasses of `GCDWebServerRequest` to handle common cases like storing the body in memory or stream it to a file on disk.
* GCDWebServerResponse is created by the request handler and wraps the response HTTP headers and optional body. GCDWebServer comes with several subclasses of `GCDWebServerResponse` to handle common cases like HTML text in memory or streaming a file from disk.

Implementing Handlers
=====================

GCDWebServer relies on "handlers" to process incoming web requests and generating responses. Handlers are implemented with GCD blocks which makes it very easy to provide your own. However, they are executed on arbitrary threads within GCD so __special attention must be paid to thread-safety and re-entrancy__.

Handlers require 2 GCD blocks:
* The `GCDWebServerMatchBlock` is called on every handler added to the `GCDWebServer` instance whenever a web request has started (i.e. HTTP headers have been received). It is passed the basic info for the web request (HTTP method, URL, headers...) and must decide if it wants to handle it or not. If yes, it must return a new `GCDWebServerRequest` instance (see above) created with this info. Otherwise, it simply returns nil.
* The `GCDWebServerProcessBlock` or `GCDWebServerAsyncProcessBlock` is called after the web request has been fully received and is passed the `GCDWebServerRequest` instance created at the previous step. It must return synchronously (if using `GCDWebServerProcessBlock`) or asynchronously (if using `GCDWebServerAsyncProcessBlock`) a `GCDWebServerResponse` instance (see above) or nil on error, which will result in a 500 HTTP status code returned to the client. It's however recommended to return an instance of GCDWebServerErrorResponse on error so more useful information can be returned to the client.

Note that most methods on `GCDWebServer` to add handlers only require the `GCDWebServerProcessBlock` or `GCDWebServerAsyncProcessBlock` as they already provide a built-in `GCDWebServerMatchBlock` e.g. to match a URL path with a Regex.

Asynchronous HTTP Responses
===========================

New in GCDWebServer 3.0 is the ability to process HTTP requests asynchronously i.e. add handlers to the server which generate their `GCDWebServerResponse` asynchronously. This is achieved by adding handlers that use a `GCDWebServerAsyncProcessBlock` instead of a `GCDWebServerProcessBlock`. Here's an example:

(Synchronous version) The handler blocks while generating the HTTP response:
`objectivec
[webServer addDefaultHandlerForMethod:@"GET"
requestClass:[GCDWebServerRequest class]
processBlock:^GCDWebServerResponse (GCDWebServerRequest request) {

GCDWebServerDataResponse* response = [GCDWebServerDataResponse responseWithHTML:@"

Hello World

"];
return response;

}];
`

(Asynchronous version) The handler returns immediately and calls back GCDWebServer later with the generated HTTP response:
`objectivec
[webServer addDefaultHandlerForMethod:@"GET"
requestClass:[GCDWebServerRequest class]
asyncProcessBlock:^(GCDWebServerRequest* request, GCDWebServerCompletionBlock completionBlock) {

// Do some async operation like network access or file I/O (simulated here using dispatch_after())
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(3 * NSEC_PER_SEC)), dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
GCDWebServerDataResponse* response = [GCDWebServerDataResponse responseWithHTML:@"

Hello World

"];
completionBlock(response);
});

}];
`

(Advanced asynchronous version) The handler returns immediately a streamed HTTP response which itself generates its contents asynchronously:
`objectivec
[webServer addDefaultHandlerForMethod:@"GET"
requestClass:[GCDWebServerRequest class]
processBlock:^GCDWebServerResponse (GCDWebServerRequest request) {

NSMutableArray* contents = [NSMutableArray arrayWithObjects:@"

\n", @"Hello World!\n", @"

\n", nil]; // Fake data source we are reading from
GCDWebServerStreamedResponse* response = [GCDWebServerStreamedResponse responseWithContentType:@"text/html" asyncStreamBlock:^(GCDWebServerBodyReaderCompletionBlock completionBlock) {

// Simulate a delay reading from the fake data source
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(1 * NSEC_PER_SEC)), dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
NSString* string = contents.firstObject;
if (string) {
[contents removeObjectAtIndex:0];
completionBlock([string dataUsingEncoding:NSUTF8StringEncoding], nil); // Generate the 2nd part of the stream data
} else {
completionBlock([NSData data], nil); // Must pass an empty NSData to signal the end of the stream
}
});

}];
return response;

}];
`

Note that you can even combine both the asynchronous and advanced asynchronous versions to return asynchronously an asynchronous HTTP response!

GCDWebServer & Background Mode for iOS Apps
===========================================

When doing networking operations in iOS apps, you must handle carefully what happens when iOS puts the app in the background. Typically you must stop any network servers while the app is in the background and restart them when the app comes back to the foreground. This can become quite complex considering servers might have ongoing connections when they need to be stopped.

Fortunately, GCDWebServer does all of this automatically for you:
- GCDWebServer begins a background task whenever the first HTTP connection is opened and ends it only when the last one is closed. This prevents iOS from suspending the app after it goes in the background, which would immediately kill HTTP connections to the client.
- While the app is in the background, as long as new HTTP connections keep being initiated, the background task will continue to exist and iOS will not suspend the app for up to 10 minutes (unless under sudden and unexpected memory pressure).
- If the app is still in the background when the last HTTP connection is closed, GCDWebServer will suspend itself and stop accepting new connections as if you had called `-stop` (this behavior can be disabled with the `GCDWebServerOption_AutomaticallySuspendInBackground` option).
- If the app goes in the background while no HTTP connections are opened, GCDWebServer will immediately suspend itself and stop accepting new connections as if you had called `-stop` (this behavior can be disabled with the `GCDWebServerOption_AutomaticallySuspendInBackground` option).
- If the app comes back to the foreground and GCDWebServer had been suspended, it will automatically resume itself and start accepting again new HTTP connections as if you had called `-start`.

HTTP connections are often initiated in batches (or bursts), for instance when loading a web page with multiple resources. This makes it difficult to accurately detect when the very last HTTP connection has been closed: it's possible 2 consecutive HTTP connections part of the same batch would be separated by a small delay instead of overlapping. It would be bad for the client if GCDWebServer suspended itself right in between. The `GCDWebServerOption_ConnectedStateCoalescingInterval` option solves this problem elegantly by forcing GCDWebServer to wait some extra delay before performing any action after the last HTTP connection has been closed, just in case a new HTTP connection is initiated within this delay.

Logging in GCDWebServer
=======================

Both for debugging and informational purpose, GCDWebServer logs messages extensively whenever something happens. Furthermore, when building GCDWebServer in "Debug" mode versus "Release" mode, it logs even more information but also performs a number of internal consistency checks. To enable this behavior, define the preprocessor constant `DEBUG=1` when compiling GCDWebServer. In Xcode target settings, this can be done by adding `DEBUG=1` to the build setting `GCC_PREPROCESSOR_DEFINITIONS` when building in "Debug" configuration. Finally, you can also control the logging verbosity at run time by calling `+[GCDWebServer setLogLevel:]`.

By default, all messages logged by GCDWebServer are sent to its built-in logging facility, which simply outputs to `stderr` (assuming a terminal type device is connected). In order to better integrate with the rest of your app or because of the amount of information logged, you might want to use another logging facility.

GCDWebServer has automatic support for XLFacility (by the same author as GCDWebServer and also open-source): if it is in the same Xcode project, GCDWebServer should use it automatically instead of the built-in logging facility (see GCDWebServerPrivate.h for the implementation details).

It's also possible to use a custom logging facility - see GCDWebServer.h for more information.

Advanced Example 1: Implementing HTTP Redirects
===============================================

Here's an example handler that redirects "/" to "/index.html" using the convenience method on `GCDWebServerResponse` (it sets the HTTP status code and "Location" header automatically):

`objectivec
[self addHandlerForMethod:@"GET"
path:@"/"
requestClass:[GCDWebServerRequest class]
processBlock:^GCDWebServerResponse (GCDWebServerRequest request) {

return [GCDWebServerResponse responseWithRedirect:[NSURL URLWithString:@"index.html" relativeToURL:request.URL]
permanent:NO];

}];
`

Advanced Example 2: Implementing Forms
======================================

To implement an HTTP form, you need a pair of handlers:
* The GET handler does not expect any body in the HTTP request and therefore uses the `GCDWebServerRequest` class. The handler generates a response containing a simple HTML form.
* The POST handler expects the form values to be in the body of the HTTP request and percent-encoded. Fortunately, GCDWebServer provides the request class `GCDWebServerURLEncodedFormRequest` which can automatically parse such bodies. The handler simply echoes back the value from the user submitted form.

`objectivec
[webServer addHandlerForMethod:@"GET"
path:@"/"
requestClass:[GCDWebServerRequest class]
processBlock:^GCDWebServerResponse (GCDWebServerRequest request) {

NSString* html = @" \
\


\
Value: \
\
\
\
";
return [GCDWebServerDataResponse responseWithHTML:html];

}];

[webServer addHandlerForMethod:@"POST"
path:@"/"
requestClass:[GCDWebServerURLEncodedFormRequest class]
processBlock:^GCDWebServerResponse (GCDWebServerRequest request) {

NSString value = [[(GCDWebServerURLEncodedFormRequest)request arguments] objectForKey:@"value"];
NSString* html = [NSString stringWithFormat:@"

%@

", value];
return [GCDWebServerDataResponse responseWithHTML:html];

}];

`

Advanced Example 3: Serving a Dynamic Website
=============================================

GCDWebServer provides an extension to the `GCDWebServerDataResponse` class that can return HTML content generated from a template and a set of variables (using the format `%variable%`). It is a very basic template system and is really intended as a starting point to building more advanced template systems by subclassing `GCDWebServerResponse`.

Assuming you have a website directory in your app containing HTML template files along with the corresponding CSS, scripts and images, it's pretty easy to turn it into a dynamic website:

`objectivec
// Get the path to the website directory
NSString* websitePath = [[NSBundle mainBundle] pathForResource:@"Website" ofType:nil];

// Add a default handler to serve static files (i.e. anything other than HTML files)
[self addGETHandlerForBasePath:@"/" directoryPath:websitePath indexFilename:nil cacheAge:3600 allowRangeRequests:YES];

// Add an override handler for all requests to "*.html" URLs to do the special HTML templatization
[self addHandlerForMethod:@"GET"
pathRegex:@"/.*\.html"
requestClass:[GCDWebServerRequest class]
processBlock:^GCDWebServerResponse (GCDWebServerRequest request) {

NSDictionary* variables = [NSDictionary dictionaryWithObjectsAndKeys:@"value", @"variable", nil];
return [GCDWebServerDataResponse responseWithHTMLTemplate:[websitePath stringByAppendingPathComponent:request.path]
variables:variables];

}];

// Add an override handler to redirect "/" URL to "/index.html"
[self addHandlerForMethod:@"GET"
path:@"/"
requestClass:[GCDWebServerRequest class]
processBlock:^GCDWebServerResponse (GCDWebServerRequest request) {

return [GCDWebServerResponse responseWithRedirect:[NSURL URLWithString:@"index.html" relativeToURL:request.URL]
permanent:NO];

];

``

Final Example: File Downloads and Uploads From iOS App
======================================================

GCDWebServer was originally written for the ComicFlow comic reader app for iPad. It allow users to connect to their iPad with their web browser over WiFi and then upload, download and organize comic files inside the app.

ComicFlow is entirely open-source and you can see how it uses GCDWebServer in the WebServer.h and WebServer.m files.