54 Commits
2.3.1 ... 2.5

Author SHA1 Message Date
Pierre-Olivier Latour
f9621c8aac Bumped version 2014-07-12 16:55:31 -07:00
Pierre-Olivier Latour
7a93b27478 Update README.md 2014-07-03 19:54:25 -07:00
Pierre-Olivier Latour
9d48f9ec12 #57 Validate paths passed to GCDWebDAVServer and GCDWebUploader to ensure they are within the upload directory 2014-06-22 15:53:03 -07:00
Pierre-Olivier Latour
7c6e85cf9a Merge pull request #60 from pvblivs/master
Adding instructions for Swift command line tool
2014-06-22 15:36:21 -07:00
pvblivs
24fbd161d8 Update README.md 2014-06-10 08:28:59 +02:00
pvblivs
0ae0d4175a Adding instructions for Swift command line tool 2014-06-06 16:34:26 +02:00
Pierre-Olivier Latour
6d550a02b7 Merge pull request #55 from mstarinteractive/fix-json-content-type
Fix content-types like "application/json; charset=utf-8"
2014-05-16 12:17:19 -07:00
Braden MacDonald
a7f46b762f Fix content-types like "application/json; charset=utf-8" 2014-05-16 11:55:20 -07:00
Pierre-Olivier Latour
d1c7f9a323 Merge pull request #56 from jaanus/customBonjourType
Can specify a custom Bonjour service type for the server.
2014-05-16 08:31:21 -07:00
jaanus
93bfe65211 Removed unneeded API. If custom Bonjour type is needed, startWithOptions should be used to specify an options dictionary with the custom type. 2014-05-16 17:12:52 +02:00
jaanus
8ab53f74d5 Can specify a custom Bonjour service type for the server. 2014-05-16 11:20:28 +02:00
Pierre-Olivier Latour
04a69787bf Update README.md 2014-05-05 13:43:38 -07:00
Pierre-Olivier Latour
dfd019de7d Update README.md 2014-05-05 13:18:04 -07:00
Pierre-Olivier Latour
4db631fa27 Fixed errno being corrupted by LOG_ERROR() 2014-05-02 22:17:25 -07:00
Pierre-Olivier Latour
ba03d756c6 Merge pull request #52 from tipbit/fix-empty-query-param
Fix GCDWebServerParseURLEncodedForm to allow empty values.
2014-04-30 17:22:56 -07:00
Ewan Mellor
04f59a9214 Fix GCDWebServerParseURLEncodedForm to allow empty values.
If the input string is something like foo=&bar= then both foo and bar
should be in the result, with the empty string as their corresponding value.

The [scanner scanUpToString:@"&" ...] call was returning failure, because
it was already positioned at the &.  In this situation, just set value to the
empty string.
2014-04-30 17:08:42 -07:00
Pierre-Olivier Latour
40ea252ad6 Ensure connected state is updated immediately after calling -stop 2014-04-30 14:04:46 -07:00
Pierre-Olivier Latour
c193860468 Fix 2014-04-30 13:59:26 -07:00
Pierre-Olivier Latour
94ad8c745e No need to call -stop from -dealloc 2014-04-30 13:36:06 -07:00
Pierre-Olivier Latour
56c096996f Fix 2014-04-30 13:06:02 -07:00
Pierre-Olivier Latour
8cbaf0f867 Added video streaming unit test 2014-04-30 11:31:20 -07:00
Pierre-Olivier Latour
295901c0b3 Reject files greater than 4 GiB in 32 bit mode 2014-04-30 09:57:12 -07:00
Pierre-Olivier Latour
2dda0c98ce #50 Use NSUIntegerMax instead of NSNotFound to indicate undefined length 2014-04-30 09:56:18 -07:00
Pierre-Olivier Latour
70a38c8b01 Fix 2014-04-30 09:15:30 -07:00
Pierre-Olivier Latour
1b12a7bd14 Ensure pending scheduled callbacks have executed in "run" APIs 2014-04-29 22:12:28 -07:00
Pierre-Olivier Latour
75e6332500 Don't delay disconnected state update if already stopped 2014-04-29 22:06:13 -07:00
Pierre-Olivier Latour
420ed719e8 Add SIGTERM support to -runWithOptions:error: 2014-04-29 16:20:03 -07:00
Pierre-Olivier Latour
3b75f9dd20 Added -rewriteRequestURL:withMethod:headers: hook 2014-04-28 14:09:15 -07:00
Pierre-Olivier Latour
f01307b2a7 Bumped version 2014-04-27 19:25:51 -07:00
Pierre-Olivier Latour
1f5e650423 Fix 2014-04-27 19:20:38 -07:00
Pierre-Olivier Latour
d404112a88 #46 Added "error" argument to -startWithOptions: 2014-04-27 19:19:55 -07:00
Pierre-Olivier Latour
dd3f539f74 #47 Ensure listening socket is closed when -stop returns 2014-04-27 19:05:34 -07:00
Pierre-Olivier Latour
0c51d09b69 Update README.md 2014-04-27 18:46:45 -07:00
Pierre-Olivier Latour
0c53c52dd4 Fix 2014-04-27 12:50:36 -07:00
Pierre-Olivier Latour
a687b52563 #39 Added support for "multipart/mixed" parts inside "multipart/form-data" 2014-04-26 19:31:11 -07:00
Pierre-Olivier Latour
c8c34aa61f Fix 2014-04-26 19:30:18 -07:00
Pierre-Olivier Latour
ed709d1476 Added HTMLFileUpload unit tests 2014-04-25 07:17:34 -07:00
Pierre-Olivier Latour
3dc7cb0ec4 Added HTMLForm unit tests 2014-04-25 07:14:40 -07:00
Pierre-Olivier Latour
142f007e58 Added "htmlFileUpload" mode 2014-04-24 19:18:13 -07:00
Pierre-Olivier Latour
c8d2b225ba Modified GCDWebServerMultiPart to allow duplicate control names 2014-04-24 19:01:46 -07:00
Pierre-Olivier Latour
f7d6da55cd Added GCDWebServerMIMEStreamParser class 2014-04-24 18:45:34 -07:00
Pierre-Olivier Latour
5a0c274807 Fix 2014-04-23 10:40:43 -07:00
Pierre-Olivier Latour
591da12aa3 Exclude GCDWebServerPrivate.h from Podspec 2014-04-23 10:39:42 -07:00
Pierre-Olivier Latour
72475429e4 Bumped version 2014-04-23 10:33:50 -07:00
Pierre-Olivier Latour
01da5969e4 Update README.md 2014-04-22 22:47:07 -07:00
Pierre-Olivier Latour
46890a0642 Merge pull request #43 from iosphere/pullrequest/unusedVar
Fixes a static analyzer warning about unused variables for disabled logging
2014-04-21 21:15:35 -03:00
Pierre-Olivier Latour
143ca5b99f Fix 2014-04-20 10:34:45 -03:00
Pierre-Olivier Latour
519866bc03 Fix 2014-04-19 23:05:13 -03:00
Pierre-Olivier Latour
a93cac5ea6 Fix 2014-04-19 22:56:45 -03:00
Pierre-Olivier Latour
43b578677f Fix 2014-04-19 22:19:47 -03:00
Pierre-Olivier Latour
10cbe27e50 Fixed open() calls 2014-04-19 22:17:17 -03:00
Pierre-Olivier Latour
b1169ce7d1 Bumped version 2014-04-19 17:48:53 -03:00
Felix Lamouroux
3e5fe3f956 Fixes logging for non-arc builds 2014-04-19 14:09:55 +02:00
Felix Lamouroux
a5208bd60f Fixes a static analyzer warning about unused variables when logging is disabled 2014-04-18 21:26:18 +02:00
47 changed files with 900 additions and 398 deletions

View File

@@ -71,8 +71,8 @@
/** /**
* The GCDWebDAVServer subclass of GCDWebServer implements a class 1 compliant * The GCDWebDAVServer subclass of GCDWebServer implements a class 1 compliant
* WebDAV server. It is also partially class 2 compliant (but only when the * WebDAV server. It is also partially class 2 compliant but only when the
* client is the OS X WebDAV implementation), so it can work with the OS X Finder. * client is the OS X WebDAV implementation (so it can work with the OS X Finder).
* *
* See the README.md file for more information about the features of GCDWebDAVServer. * See the README.md file for more information about the features of GCDWebDAVServer.
*/ */
@@ -89,16 +89,15 @@
@property(nonatomic, assign) id<GCDWebDAVServerDelegate> delegate; @property(nonatomic, assign) id<GCDWebDAVServerDelegate> delegate;
/** /**
* Restricts which files should be listed and allowed to be uploaded, downloaded, * Sets which files are allowed to be operated on depending on their extension.
* moved, copied or deleted depending on their extensions.
* *
* The default value is nil i.e. all file extensions are allowed. * The default value is nil i.e. all file extensions are allowed.
*/ */
@property(nonatomic, copy) NSArray* allowedFileExtensions; @property(nonatomic, copy) NSArray* allowedFileExtensions;
/** /**
* Sets if files and directories whose name start with a period should be * Sets if files and directories whose name start with a period are allowed to
* listed and allowed to be uploaded, downloaded, moved, copied or deleted. * be operated on.
* *
* The default value is NO. * The default value is NO.
*/ */
@@ -119,7 +118,7 @@
@interface GCDWebDAVServer (Subclassing) @interface GCDWebDAVServer (Subclassing)
/** /**
* This method is called to check if a file is allowed to be uploaded. * This method is called to check if a file upload is allowed to complete.
* The uploaded file is available for inspection at "tempPath". * The uploaded file is available for inspection at "tempPath".
* *
* The default implementation returns YES. * The default implementation returns YES.

View File

@@ -61,6 +61,11 @@ typedef NS_ENUM(NSInteger, DAVProperties) {
@implementation GCDWebDAVServer (Methods) @implementation GCDWebDAVServer (Methods)
// Must match implementation in GCDWebUploader
- (BOOL)_checkSandboxedPath:(NSString*)path {
return [[path stringByStandardizingPath] hasPrefix:_uploadDirectory];
}
- (BOOL)_checkFileExtension:(NSString*)fileName { - (BOOL)_checkFileExtension:(NSString*)fileName {
if (_allowedExtensions && ![_allowedExtensions containsObject:[[fileName pathExtension] lowercaseString]]) { if (_allowedExtensions && ![_allowedExtensions containsObject:[[fileName pathExtension] lowercaseString]]) {
return NO; return NO;
@@ -87,7 +92,7 @@ static inline BOOL _IsMacFinder(GCDWebServerRequest* request) {
NSString* relativePath = request.path; NSString* relativePath = request.path;
NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath]; NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath];
BOOL isDirectory = NO; BOOL isDirectory = NO;
if (![absolutePath hasPrefix:_uploadDirectory] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) { if (![self _checkSandboxedPath:absolutePath] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath];
} }
@@ -116,7 +121,7 @@ static inline BOOL _IsMacFinder(GCDWebServerRequest* request) {
NSString* relativePath = request.path; NSString* relativePath = request.path;
NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath]; NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath];
if (![absolutePath hasPrefix:_uploadDirectory]) { if (![self _checkSandboxedPath:absolutePath]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath];
} }
BOOL isDirectory; BOOL isDirectory;
@@ -161,7 +166,7 @@ static inline BOOL _IsMacFinder(GCDWebServerRequest* request) {
NSString* relativePath = request.path; NSString* relativePath = request.path;
NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath]; NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath];
BOOL isDirectory = NO; BOOL isDirectory = NO;
if (![absolutePath hasPrefix:_uploadDirectory] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) { if (![self _checkSandboxedPath:absolutePath] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath];
} }
@@ -194,7 +199,7 @@ static inline BOOL _IsMacFinder(GCDWebServerRequest* request) {
NSString* relativePath = request.path; NSString* relativePath = request.path;
NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath]; NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath];
if (![absolutePath hasPrefix:_uploadDirectory]) { if (![self _checkSandboxedPath:absolutePath]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath];
} }
BOOL isDirectory; BOOL isDirectory;
@@ -243,7 +248,7 @@ static inline BOOL _IsMacFinder(GCDWebServerRequest* request) {
NSString* srcRelativePath = request.path; NSString* srcRelativePath = request.path;
NSString* srcAbsolutePath = [_uploadDirectory stringByAppendingPathComponent:srcRelativePath]; NSString* srcAbsolutePath = [_uploadDirectory stringByAppendingPathComponent:srcRelativePath];
if (![srcAbsolutePath hasPrefix:_uploadDirectory]) { if (![self _checkSandboxedPath:srcAbsolutePath]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", srcRelativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", srcRelativePath];
} }
@@ -254,7 +259,7 @@ static inline BOOL _IsMacFinder(GCDWebServerRequest* request) {
} }
dstRelativePath = [[dstRelativePath substringFromIndex:(range.location + range.length)] stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding]; dstRelativePath = [[dstRelativePath substringFromIndex:(range.location + range.length)] stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
NSString* dstAbsolutePath = [_uploadDirectory stringByAppendingPathComponent:dstRelativePath]; NSString* dstAbsolutePath = [_uploadDirectory stringByAppendingPathComponent:dstRelativePath];
if (![dstAbsolutePath hasPrefix:_uploadDirectory]) { if (![self _checkSandboxedPath:dstAbsolutePath]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", srcRelativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", srcRelativePath];
} }
@@ -425,7 +430,7 @@ static inline xmlNodePtr _XMLChildWithName(xmlNodePtr child, const xmlChar* name
NSString* relativePath = request.path; NSString* relativePath = request.path;
NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath]; NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath];
BOOL isDirectory = NO; BOOL isDirectory = NO;
if (![absolutePath hasPrefix:_uploadDirectory] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) { if (![self _checkSandboxedPath:absolutePath] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath];
} }
@@ -475,7 +480,7 @@ static inline xmlNodePtr _XMLChildWithName(xmlNodePtr child, const xmlChar* name
NSString* relativePath = request.path; NSString* relativePath = request.path;
NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath]; NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath];
BOOL isDirectory = NO; BOOL isDirectory = NO;
if (![absolutePath hasPrefix:_uploadDirectory] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) { if (![self _checkSandboxedPath:absolutePath] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath];
} }
@@ -575,7 +580,7 @@ static inline xmlNodePtr _XMLChildWithName(xmlNodePtr child, const xmlChar* name
NSString* relativePath = request.path; NSString* relativePath = request.path;
NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath]; NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath];
BOOL isDirectory = NO; BOOL isDirectory = NO;
if (![absolutePath hasPrefix:_uploadDirectory] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) { if (![self _checkSandboxedPath:absolutePath] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath];
} }

View File

@@ -7,7 +7,7 @@
Pod::Spec.new do |s| Pod::Spec.new do |s|
s.name = 'GCDWebServer' s.name = 'GCDWebServer'
s.version = '2.3' s.version = '2.5'
s.author = { 'Pierre-Olivier Latour' => 'info@pol-online.net' } s.author = { 'Pierre-Olivier Latour' => 'info@pol-online.net' }
s.license = { :type => 'BSD', :file => 'LICENSE' } s.license = { :type => 'BSD', :file => 'LICENSE' }
s.homepage = 'https://github.com/swisspol/GCDWebServer' s.homepage = 'https://github.com/swisspol/GCDWebServer'
@@ -22,6 +22,7 @@ Pod::Spec.new do |s|
s.subspec 'Core' do |cs| s.subspec 'Core' do |cs|
cs.source_files = 'GCDWebServer/**/*.{h,m}' cs.source_files = 'GCDWebServer/**/*.{h,m}'
cs.private_header_files = "GCDWebServer/Core/GCDWebServerPrivate.h"
cs.requires_arc = true cs.requires_arc = true
cs.ios.library = 'z' cs.ios.library = 'z'
cs.ios.frameworks = 'MobileCoreServices', 'CFNetwork' cs.ios.frameworks = 'MobileCoreServices', 'CFNetwork'

View File

@@ -59,7 +59,7 @@ typedef GCDWebServerRequest* (^GCDWebServerMatchBlock)(NSString* requestMethod,
/** /**
* The GCDWebServerProcessBlock is called after the HTTP request has been fully * The GCDWebServerProcessBlock is called after the HTTP request has been fully
* received (i.e. the entire HTTP body has been read). THe block is passed the * received (i.e. the entire HTTP body has been read). The block is passed the
* GCDWebServerRequest created at the previous step by the GCDWebServerMatchBlock. * GCDWebServerRequest created at the previous step by the GCDWebServerMatchBlock.
* *
* The block must return a GCDWebServerResponse or nil on error, which will * The block must return a GCDWebServerResponse or nil on error, which will
@@ -72,29 +72,36 @@ typedef GCDWebServerResponse* (^GCDWebServerProcessBlock)(GCDWebServerRequest* r
/** /**
* The port used by the GCDWebServer (NSNumber / NSUInteger). * The port used by the GCDWebServer (NSNumber / NSUInteger).
* *
* Default value is 0 i.e. let the OS pick a random port. * The default value is 0 i.e. let the OS pick a random port.
*/ */
extern NSString* const GCDWebServerOption_Port; extern NSString* const GCDWebServerOption_Port;
/** /**
* The Bonjour name used by the GCDWebServer (NSString). * The Bonjour name used by the GCDWebServer (NSString).
* *
* Default value is an empty string i.e. use the computer / device name. * The default value is an empty string i.e. use the computer / device name.
*/ */
extern NSString* const GCDWebServerOption_BonjourName; extern NSString* const GCDWebServerOption_BonjourName;
/**
* The Bonjour service type used by the GCDWebServer (NSString).
*
* The default value is "_http._tcp", standard HTTP web server.
*/
extern NSString* const GCDWebServerOption_BonjourType;
/** /**
* The maximum number of incoming HTTP requests that can be queued waiting to * The maximum number of incoming HTTP requests that can be queued waiting to
* be handled before new ones are dropped (NSNumber / NSUInteger). * be handled before new ones are dropped (NSNumber / NSUInteger).
* *
* Default value is 16. * The default value is 16.
*/ */
extern NSString* const GCDWebServerOption_MaxPendingConnections; extern NSString* const GCDWebServerOption_MaxPendingConnections;
/** /**
* The value for "Server" HTTP header used by the GCDWebServer (NSString). * The value for "Server" HTTP header used by the GCDWebServer (NSString).
* *
* Default value is the GCDWebServer class name. * The default value is the GCDWebServer class name.
*/ */
extern NSString* const GCDWebServerOption_ServerName; extern NSString* const GCDWebServerOption_ServerName;
@@ -102,14 +109,14 @@ extern NSString* const GCDWebServerOption_ServerName;
* The authentication method used by the GCDWebServer * The authentication method used by the GCDWebServer
* (one of "GCDWebServerAuthenticationMethod_..."). * (one of "GCDWebServerAuthenticationMethod_...").
* *
* Default value is nil i.e. authentication disabled. * The default value is nil i.e. authentication is disabled.
*/ */
extern NSString* const GCDWebServerOption_AuthenticationMethod; extern NSString* const GCDWebServerOption_AuthenticationMethod;
/** /**
* The authentication realm used by the GCDWebServer (NSString). * The authentication realm used by the GCDWebServer (NSString).
* *
* Default value is the same as GCDWebServerOption_ServerName. * The default value is the same as the GCDWebServerOption_ServerName option.
*/ */
extern NSString* const GCDWebServerOption_AuthenticationRealm; extern NSString* const GCDWebServerOption_AuthenticationRealm;
@@ -117,7 +124,7 @@ extern NSString* const GCDWebServerOption_AuthenticationRealm;
* The authentication accounts used by the GCDWebServer * The authentication accounts used by the GCDWebServer
* (NSDictionary of username / password pairs). * (NSDictionary of username / password pairs).
* *
* Default value is nil i.e. no accounts. * The default value is nil i.e. no accounts.
*/ */
extern NSString* const GCDWebServerOption_AuthenticationAccounts; extern NSString* const GCDWebServerOption_AuthenticationAccounts;
@@ -125,7 +132,7 @@ extern NSString* const GCDWebServerOption_AuthenticationAccounts;
* The class used by the GCDWebServer when instantiating GCDWebServerConnection * The class used by the GCDWebServer when instantiating GCDWebServerConnection
* (subclass of GCDWebServerConnection). * (subclass of GCDWebServerConnection).
* *
* Default value is GCDWebServerConnection class. * The default value is the GCDWebServerConnection class.
*/ */
extern NSString* const GCDWebServerOption_ConnectionClass; extern NSString* const GCDWebServerOption_ConnectionClass;
@@ -133,7 +140,7 @@ extern NSString* const GCDWebServerOption_ConnectionClass;
* Allow the GCDWebServer to pretend "HEAD" requests are actually "GET" ones * Allow the GCDWebServer to pretend "HEAD" requests are actually "GET" ones
* and automatically discard the HTTP body of the response (NSNumber / BOOL). * and automatically discard the HTTP body of the response (NSNumber / BOOL).
* *
* Default value is YES. * The default value is YES.
*/ */
extern NSString* const GCDWebServerOption_AutomaticallyMapHEADToGET; extern NSString* const GCDWebServerOption_AutomaticallyMapHEADToGET;
@@ -142,7 +149,7 @@ extern NSString* const GCDWebServerOption_AutomaticallyMapHEADToGET;
* coalesce calls to -webServerDidConnect: and -webServerDidDisconnect: * coalesce calls to -webServerDidConnect: and -webServerDidDisconnect:
* (NSNumber / double). Coalescing will be disabled if the interval is <= 0.0. * (NSNumber / double). Coalescing will be disabled if the interval is <= 0.0.
* *
* Default value is 1.0 second. * The default value is 1.0 second.
*/ */
extern NSString* const GCDWebServerOption_ConnectedStateCoalescingInterval; extern NSString* const GCDWebServerOption_ConnectedStateCoalescingInterval;
@@ -156,7 +163,7 @@ extern NSString* const GCDWebServerOption_ConnectedStateCoalescingInterval;
* *
* See the README.md file for more information about this option. * See the README.md file for more information about this option.
* *
* Default value is YES. * The default value is YES.
* *
* @warning The running property will be NO while the GCDWebServer is suspended. * @warning The running property will be NO while the GCDWebServer is suspended.
*/ */
@@ -167,7 +174,8 @@ extern NSString* const GCDWebServerOption_AutomaticallySuspendInBackground;
/** /**
* HTTP Basic Authentication scheme (see https://tools.ietf.org/html/rfc2617). * HTTP Basic Authentication scheme (see https://tools.ietf.org/html/rfc2617).
* *
* @warning Use of this method is not recommended as the passwords are sent in clear. * @warning Use of this authentication scheme is not recommended as the
* passwords are sent in clear.
*/ */
extern NSString* const GCDWebServerAuthenticationMethod_Basic; extern NSString* const GCDWebServerAuthenticationMethod_Basic;
@@ -187,7 +195,7 @@ extern NSString* const GCDWebServerAuthenticationMethod_DigestAccess;
@optional @optional
/** /**
* This method is called after the server has succesfully started. * This method is called after the server has successfully started.
*/ */
- (void)webServerDidStart:(GCDWebServer*)server; - (void)webServerDidStart:(GCDWebServer*)server;
@@ -199,9 +207,11 @@ extern NSString* const GCDWebServerAuthenticationMethod_DigestAccess;
/** /**
* This method is called when the first GCDWebServerConnection is opened by the * This method is called when the first GCDWebServerConnection is opened by the
* server to serve a series of HTTP requests. A series is ongoing as long as * server to serve a series of HTTP requests.
* new HTTP requests keep coming (and new GCDWebServerConnection instances keep *
* being opened), before the last HTTP request has been responded to (and the * A series of HTTP requests is considered ongoing as long as new HTTP requests
* keep coming (and new GCDWebServerConnection instances keep being opened),
* until before the last HTTP request has been responded to (and the
* corresponding last GCDWebServerConnection closed). * corresponding last GCDWebServerConnection closed).
*/ */
- (void)webServerDidConnect:(GCDWebServer*)server; - (void)webServerDidConnect:(GCDWebServer*)server;
@@ -226,8 +236,13 @@ extern NSString* const GCDWebServerAuthenticationMethod_DigestAccess;
@end @end
/** /**
* The GCDWebServer class manages the socket that listens for HTTP requests and * The GCDWebServer class listens for incoming HTTP requests on a given port,
* the list of handlers used to respond to them. * then passes each one to a "handler" capable of generating an HTTP response
* for it, which is then sent back to the client.
*
* GCDWebServer instances can be created and used from any thread but it's
* recommended to have the main thread's runloop be running so internal callbacks
* can be handled e.g. for Bonjour registration.
* *
* See the README.md file for more information about the architecture of GCDWebServer. * See the README.md file for more information about the architecture of GCDWebServer.
*/ */
@@ -239,7 +254,7 @@ extern NSString* const GCDWebServerAuthenticationMethod_DigestAccess;
@property(nonatomic, assign) id<GCDWebServerDelegate> delegate; @property(nonatomic, assign) id<GCDWebServerDelegate> delegate;
/** /**
* Indicates if the server is currently running. * Returns YES if the server is currently running.
*/ */
@property(nonatomic, readonly, getter=isRunning) BOOL running; @property(nonatomic, readonly, getter=isRunning) BOOL running;
@@ -251,13 +266,21 @@ extern NSString* const GCDWebServerAuthenticationMethod_DigestAccess;
@property(nonatomic, readonly) NSUInteger port; @property(nonatomic, readonly) NSUInteger port;
/** /**
* Returns the Bonjour name in used by the server. * Returns the Bonjour name used by the server.
* *
* @warning This property is only valid if the server is running and Bonjour * @warning This property is only valid if the server is running and Bonjour
* registration has successfully completed, which can take up to a few seconds. * registration has successfully completed, which can take up to a few seconds.
*/ */
@property(nonatomic, readonly) NSString* bonjourName; @property(nonatomic, readonly) NSString* bonjourName;
/**
* Returns the Bonjour service type used by the server.
*
* @warning This property is only valid if the server is running and Bonjour
* registration has successfully completed, which can take up to a few seconds.
*/
@property(nonatomic, readonly) NSString* bonjourType;
/** /**
* This method is the designated initializer for the class. * This method is the designated initializer for the class.
*/ */
@@ -265,51 +288,35 @@ extern NSString* const GCDWebServerAuthenticationMethod_DigestAccess;
/** /**
* Adds a handler to the server to handle incoming HTTP requests. * Adds a handler to the server to handle incoming HTTP requests.
* Handlers are called in a LIFO queue, so the latest added handler overrides
* any previously added ones.
* *
* @warning Addling handlers while the GCDWebServer is running is not allowed. * Handlers are called in a LIFO queue, so if multiple handlers can potentially
* respond to a given request, the latest added one wins.
*
* @warning Addling handlers while the server is running is not allowed.
*/ */
- (void)addHandlerWithMatchBlock:(GCDWebServerMatchBlock)matchBlock processBlock:(GCDWebServerProcessBlock)processBlock; - (void)addHandlerWithMatchBlock:(GCDWebServerMatchBlock)matchBlock processBlock:(GCDWebServerProcessBlock)processBlock;
/** /**
* Removes all handlers previously added to the server. * Removes all handlers previously added to the server.
* *
* @warning Removing handlers while the GCDWebServer is running is not allowed. * @warning Removing handlers while the server is running is not allowed.
*/ */
- (void)removeAllHandlers; - (void)removeAllHandlers;
/**
* Starts the server on port 8080 (OS X & iOS Simulator) or port 80 (iOS)
* using the computer / device name for as the Bonjour name.
*
* Returns NO if the server failed to start.
*/
- (BOOL)start;
/**
* Starts the server on a given port and with a specific Bonjour name.
* Pass a nil Bonjour name to disable Bonjour entirely or an empty string to
* use the computer / device name.
*
* Returns NO if the server failed to start.
*/
- (BOOL)startWithPort:(NSUInteger)port bonjourName:(NSString*)name;
/** /**
* Starts the server with explicit options. This method is the designated way * Starts the server with explicit options. This method is the designated way
* to start the server. * to start the server.
* *
* Returns NO if the server failed to start. * Returns NO if the server failed to start and sets "error" argument if not NULL.
*/ */
- (BOOL)startWithOptions:(NSDictionary*)options; - (BOOL)startWithOptions:(NSDictionary*)options error:(NSError**)error;
/** /**
* Stops the server and prevents it to accepts new HTTP requests. * Stops the server and prevents it to accepts new HTTP requests.
* *
* @warning Stopping the server does not abort GCDWebServerConnection instances * @warning Stopping the server does not abort GCDWebServerConnection instances
* handling already received HTTP requests. These connections will continue to * currently handling already received HTTP requests. These connections will
* execute until the corresponding requests and responses are completed. * continue to execute normally until completion.
*/ */
- (void)stop; - (void)stop;
@@ -332,6 +339,23 @@ extern NSString* const GCDWebServerAuthenticationMethod_DigestAccess;
*/ */
@property(nonatomic, readonly) NSURL* bonjourServerURL; @property(nonatomic, readonly) NSURL* bonjourServerURL;
/**
* Starts the server on port 8080 (OS X & iOS Simulator) or port 80 (iOS)
* using the computer / device name for as the Bonjour name.
*
* Returns NO if the server failed to start.
*/
- (BOOL)start;
/**
* Starts the server on a given port and with a specific Bonjour name.
* Pass a nil Bonjour name to disable Bonjour entirely or an empty string to
* use the computer / device name.
*
* Returns NO if the server failed to start.
*/
- (BOOL)startWithPort:(NSUInteger)port bonjourName:(NSString*)name;
#if !TARGET_OS_IPHONE #if !TARGET_OS_IPHONE
/** /**
@@ -346,15 +370,15 @@ extern NSString* const GCDWebServerAuthenticationMethod_DigestAccess;
- (BOOL)runWithPort:(NSUInteger)port bonjourName:(NSString*)name; - (BOOL)runWithPort:(NSUInteger)port bonjourName:(NSString*)name;
/** /**
* Runs the server synchronously using -startWithOptions: until a SIGINT signal * Runs the server synchronously using -startWithOptions: until a SIGTERM or
* is received i.e. Ctrl-C. This method is intended to be used by command line * SIGINT signal is received i.e. Ctrl-C in Terminal. This method is intended to
* tools. * be used by command line tools.
* *
* Returns NO if the server failed to start. * Returns NO if the server failed to start and sets "error" argument if not NULL.
* *
* @warning This method must be used from the main thread only. * @warning This method must be used from the main thread only.
*/ */
- (BOOL)runWithOptions:(NSDictionary*)options; - (BOOL)runWithOptions:(NSDictionary*)options error:(NSError**)error;
#endif #endif

View File

@@ -43,45 +43,9 @@
#define kDefaultPort 8080 #define kDefaultPort 8080
#endif #endif
@interface GCDWebServer () {
@private
id<GCDWebServerDelegate> __unsafe_unretained _delegate;
dispatch_queue_t _syncQueue;
NSMutableArray* _handlers;
NSInteger _activeConnections; // Accessed only with _syncQueue
BOOL _connected;
CFRunLoopTimerRef _connectedTimer;
NSDictionary* _options;
NSString* _serverName;
NSString* _authenticationRealm;
NSMutableDictionary* _authenticationBasicAccounts;
NSMutableDictionary* _authenticationDigestAccounts;
Class _connectionClass;
BOOL _mapHEADToGET;
CFTimeInterval _disconnectDelay;
NSUInteger _port;
dispatch_source_t _source;
CFNetServiceRef _service;
#if TARGET_OS_IPHONE
BOOL _suspendInBackground;
UIBackgroundTaskIdentifier _backgroundTask;
#endif
#ifdef __GCDWEBSERVER_ENABLE_TESTING__
BOOL _recording;
#endif
}
@end
@interface GCDWebServerHandler () {
@private
GCDWebServerMatchBlock _matchBlock;
GCDWebServerProcessBlock _processBlock;
}
@end
NSString* const GCDWebServerOption_Port = @"Port"; NSString* const GCDWebServerOption_Port = @"Port";
NSString* const GCDWebServerOption_BonjourName = @"BonjourName"; NSString* const GCDWebServerOption_BonjourName = @"BonjourName";
NSString* const GCDWebServerOption_BonjourType = @"BonjourType";
NSString* const GCDWebServerOption_MaxPendingConnections = @"MaxPendingConnections"; NSString* const GCDWebServerOption_MaxPendingConnections = @"MaxPendingConnections";
NSString* const GCDWebServerOption_ServerName = @"ServerName"; NSString* const GCDWebServerOption_ServerName = @"ServerName";
NSString* const GCDWebServerOption_AuthenticationMethod = @"AuthenticationMethod"; NSString* const GCDWebServerOption_AuthenticationMethod = @"AuthenticationMethod";
@@ -132,6 +96,28 @@ static void _SignalHandler(int signal) {
#endif #endif
#if !TARGET_OS_IPHONE || defined(__GCDWEBSERVER_ENABLE_TESTING__)
// This utility function is used to ensure scheduled callbacks on the main thread are called when running the server synchronously
// https://developer.apple.com/library/mac/documentation/General/Conceptual/ConcurrencyProgrammingGuide/OperationQueues/OperationQueues.html
// The main queue works with the applications run loop to interleave the execution of queued tasks with the execution of other event sources attached to the run loop
// TODO: Ensure all scheduled blocks on the main queue are also executed
static void _ExecuteMainThreadRunLoopSources() {
SInt32 result;
do {
result = CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.0, true);
} while (result == kCFRunLoopRunHandledSource);
}
#endif
@interface GCDWebServerHandler () {
@private
GCDWebServerMatchBlock _matchBlock;
GCDWebServerProcessBlock _processBlock;
}
@end
@implementation GCDWebServerHandler @implementation GCDWebServerHandler
@synthesize matchBlock=_matchBlock, processBlock=_processBlock; @synthesize matchBlock=_matchBlock, processBlock=_processBlock;
@@ -153,6 +139,38 @@ static void _SignalHandler(int signal) {
@end @end
@interface GCDWebServer () {
@private
id<GCDWebServerDelegate> __unsafe_unretained _delegate;
dispatch_queue_t _syncQueue;
dispatch_semaphore_t _sourceSemaphore;
NSMutableArray* _handlers;
NSInteger _activeConnections; // Accessed through _syncQueue only
BOOL _connected; // Accessed on main thread only
BOOL _disconnecting; // Accessed on main thread only
CFRunLoopTimerRef _disconnectTimer; // Accessed on main thread only
NSDictionary* _options;
NSString* _serverName;
NSString* _authenticationRealm;
NSMutableDictionary* _authenticationBasicAccounts;
NSMutableDictionary* _authenticationDigestAccounts;
Class _connectionClass;
BOOL _mapHEADToGET;
CFTimeInterval _disconnectDelay;
NSUInteger _port;
dispatch_source_t _source;
CFNetServiceRef _service;
#if TARGET_OS_IPHONE
BOOL _suspendInBackground;
UIBackgroundTaskIdentifier _backgroundTask;
#endif
#ifdef __GCDWEBSERVER_ENABLE_TESTING__
BOOL _recording;
#endif
}
@end
@implementation GCDWebServer @implementation GCDWebServer
@synthesize delegate=_delegate, handlers=_handlers, port=_port, serverName=_serverName, authenticationRealm=_authenticationRealm, @synthesize delegate=_delegate, handlers=_handlers, port=_port, serverName=_serverName, authenticationRealm=_authenticationRealm,
@@ -174,19 +192,23 @@ static void _SignalHandler(int signal) {
GCDWebServerInitializeFunctions(); GCDWebServerInitializeFunctions();
} }
static void _ConnectedTimerCallBack(CFRunLoopTimerRef timer, void* info) { static void _DisconnectTimerCallBack(CFRunLoopTimerRef timer, void* info) {
DCHECK([NSThread isMainThread]);
GCDWebServer* server = (ARC_BRIDGE GCDWebServer*)info;
@autoreleasepool { @autoreleasepool {
[(ARC_BRIDGE GCDWebServer*)info _didDisconnect]; [server _didDisconnect];
} }
server->_disconnecting = NO;
} }
- (instancetype)init { - (instancetype)init {
if ((self = [super init])) { if ((self = [super init])) {
_syncQueue = dispatch_queue_create([NSStringFromClass([self class]) UTF8String], DISPATCH_QUEUE_SERIAL); _syncQueue = dispatch_queue_create([NSStringFromClass([self class]) UTF8String], DISPATCH_QUEUE_SERIAL);
_sourceSemaphore = dispatch_semaphore_create(0);
_handlers = [[NSMutableArray alloc] init]; _handlers = [[NSMutableArray alloc] init];
CFRunLoopTimerContext context = {0, (ARC_BRIDGE void*)self, NULL, NULL, NULL}; CFRunLoopTimerContext context = {0, (ARC_BRIDGE void*)self, NULL, NULL, NULL};
_connectedTimer = CFRunLoopTimerCreate(kCFAllocatorDefault, HUGE_VAL, HUGE_VAL, 0, 0, _ConnectedTimerCallBack, &context); _disconnectTimer = CFRunLoopTimerCreate(kCFAllocatorDefault, HUGE_VAL, HUGE_VAL, 0, 0, _DisconnectTimerCallBack, &context);
CFRunLoopAddTimer(CFRunLoopGetMain(), _connectedTimer, kCFRunLoopCommonModes); CFRunLoopAddTimer(CFRunLoopGetMain(), _disconnectTimer, kCFRunLoopCommonModes);
#if TARGET_OS_IPHONE #if TARGET_OS_IPHONE
_backgroundTask = UIBackgroundTaskInvalid; _backgroundTask = UIBackgroundTaskInvalid;
#endif #endif
@@ -197,15 +219,12 @@ static void _ConnectedTimerCallBack(CFRunLoopTimerRef timer, void* info) {
- (void)dealloc { - (void)dealloc {
DCHECK(_connected == NO); DCHECK(_connected == NO);
DCHECK(_activeConnections == 0); DCHECK(_activeConnections == 0);
DCHECK(_options == nil); // The server can never be dealloc'ed while running because of the retain-cycle with the dispatch source
_delegate = nil; CFRunLoopTimerInvalidate(_disconnectTimer);
if (_options) { CFRelease(_disconnectTimer);
[self stop];
}
CFRunLoopTimerInvalidate(_connectedTimer);
CFRelease(_connectedTimer);
ARC_RELEASE(_handlers); ARC_RELEASE(_handlers);
ARC_DISPATCH_RELEASE(_sourceSemaphore);
ARC_DISPATCH_RELEASE(_syncQueue); ARC_DISPATCH_RELEASE(_syncQueue);
ARC_DEALLOC(super); ARC_DEALLOC(super);
@@ -253,8 +272,9 @@ static void _ConnectedTimerCallBack(CFRunLoopTimerRef timer, void* info) {
DCHECK(_activeConnections >= 0); DCHECK(_activeConnections >= 0);
if (_activeConnections == 0) { if (_activeConnections == 0) {
dispatch_async(dispatch_get_main_queue(), ^{ dispatch_async(dispatch_get_main_queue(), ^{
if (_disconnectDelay > 0.0) { if (_disconnecting) {
CFRunLoopTimerSetNextFireDate(_connectedTimer, HUGE_VAL); CFRunLoopTimerSetNextFireDate(_disconnectTimer, HUGE_VAL);
_disconnecting = NO;
} }
if (_connected == NO) { if (_connected == NO) {
[self _didConnect]; [self _didConnect];
@@ -307,8 +327,9 @@ static void _ConnectedTimerCallBack(CFRunLoopTimerRef timer, void* info) {
_activeConnections -= 1; _activeConnections -= 1;
if (_activeConnections == 0) { if (_activeConnections == 0) {
dispatch_async(dispatch_get_main_queue(), ^{ dispatch_async(dispatch_get_main_queue(), ^{
if (_disconnectDelay > 0.0) { if ((_disconnectDelay > 0.0) && (_source != NULL)) {
CFRunLoopTimerSetNextFireDate(_connectedTimer, CFAbsoluteTimeGetCurrent() + _disconnectDelay); CFRunLoopTimerSetNextFireDate(_disconnectTimer, CFAbsoluteTimeGetCurrent() + _disconnectDelay);
_disconnecting = YES;
} else { } else {
[self _didDisconnect]; [self _didDisconnect];
} }
@@ -322,6 +343,11 @@ static void _ConnectedTimerCallBack(CFRunLoopTimerRef timer, void* info) {
return name && CFStringGetLength(name) ? ARC_BRIDGE_RELEASE(CFStringCreateCopy(kCFAllocatorDefault, name)) : nil; return name && CFStringGetLength(name) ? ARC_BRIDGE_RELEASE(CFStringCreateCopy(kCFAllocatorDefault, name)) : nil;
} }
- (NSString*)bonjourType {
CFStringRef type = _service ? CFNetServiceGetType(_service) : NULL;
return type && CFStringGetLength(type) ? ARC_BRIDGE_RELEASE(CFStringCreateCopy(kCFAllocatorDefault, type)) : nil;
}
- (void)addHandlerWithMatchBlock:(GCDWebServerMatchBlock)matchBlock processBlock:(GCDWebServerProcessBlock)handlerBlock { - (void)addHandlerWithMatchBlock:(GCDWebServerMatchBlock)matchBlock processBlock:(GCDWebServerProcessBlock)handlerBlock {
DCHECK(_options == nil); DCHECK(_options == nil);
GCDWebServerHandler* handler = [[GCDWebServerHandler alloc] initWithMatchBlock:matchBlock processBlock:handlerBlock]; GCDWebServerHandler* handler = [[GCDWebServerHandler alloc] initWithMatchBlock:matchBlock processBlock:handlerBlock];
@@ -363,10 +389,12 @@ static inline NSString* _EncodeBase64(NSString* string) {
#endif #endif
return ARC_AUTORELEASE([[NSString alloc] initWithData:[data base64EncodedDataWithOptions:0] encoding:NSASCIIStringEncoding]); return ARC_AUTORELEASE([[NSString alloc] initWithData:[data base64EncodedDataWithOptions:0] encoding:NSASCIIStringEncoding]);
} }
- (BOOL)_start {
- (BOOL)_start:(NSError**)error {
DCHECK(_source == NULL); DCHECK(_source == NULL);
NSUInteger port = [_GetOption(_options, GCDWebServerOption_Port, @0) unsignedIntegerValue]; NSUInteger port = [_GetOption(_options, GCDWebServerOption_Port, @0) unsignedIntegerValue];
NSString* name = _GetOption(_options, GCDWebServerOption_BonjourName, @""); NSString* name = _GetOption(_options, GCDWebServerOption_BonjourName, @"");
NSString* bonjourType = _GetOption(_options, GCDWebServerOption_BonjourType, @"_http._tcp");
NSUInteger maxPendingConnections = [_GetOption(_options, GCDWebServerOption_MaxPendingConnections, @16) unsignedIntegerValue]; NSUInteger maxPendingConnections = [_GetOption(_options, GCDWebServerOption_MaxPendingConnections, @16) unsignedIntegerValue];
int listeningSocket = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP); int listeningSocket = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
if (listeningSocket > 0) { if (listeningSocket > 0) {
@@ -413,6 +441,7 @@ static inline NSString* _EncodeBase64(NSString* string) {
LOG_DEBUG(@"Did close listening socket %i", listeningSocket); LOG_DEBUG(@"Did close listening socket %i", listeningSocket);
} }
} }
dispatch_semaphore_signal(_sourceSemaphore);
}); });
dispatch_source_set_event_handler(_source, ^{ dispatch_source_set_event_handler(_source, ^{
@@ -463,13 +492,13 @@ static inline NSString* _EncodeBase64(NSString* string) {
} }
if (name) { if (name) {
_service = CFNetServiceCreate(kCFAllocatorDefault, CFSTR("local."), CFSTR("_http._tcp"), (ARC_BRIDGE CFStringRef)name, (SInt32)_port); _service = CFNetServiceCreate(kCFAllocatorDefault, CFSTR("local."), (ARC_BRIDGE CFStringRef)bonjourType, (ARC_BRIDGE CFStringRef)name, (SInt32)_port);
if (_service) { if (_service) {
CFNetServiceClientContext context = {0, (ARC_BRIDGE void*)self, NULL, NULL, NULL}; CFNetServiceClientContext context = {0, (ARC_BRIDGE void*)self, NULL, NULL, NULL};
CFNetServiceSetClient(_service, _NetServiceClientCallBack, &context); CFNetServiceSetClient(_service, _NetServiceClientCallBack, &context);
CFNetServiceScheduleWithRunLoop(_service, CFRunLoopGetMain(), kCFRunLoopCommonModes); CFNetServiceScheduleWithRunLoop(_service, CFRunLoopGetMain(), kCFRunLoopCommonModes);
CFStreamError error = {0}; CFStreamError streamError = {0};
CFNetServiceRegisterWithOptions(_service, 0, &error); CFNetServiceRegisterWithOptions(_service, 0, &streamError);
} else { } else {
LOG_ERROR(@"Failed creating CFNetService"); LOG_ERROR(@"Failed creating CFNetService");
} }
@@ -483,15 +512,24 @@ static inline NSString* _EncodeBase64(NSString* string) {
}); });
} }
} else { } else {
LOG_ERROR(@"Failed listening on socket: %s (%i)", strerror(errno), errno); if (error) {
*error = GCDWebServerMakePosixError(errno);
}
LOG_ERROR(@"Failed starting listening socket: %s (%i)", strerror(errno), errno);
close(listeningSocket); close(listeningSocket);
} }
} else { } else {
LOG_ERROR(@"Failed binding socket: %s (%i)", strerror(errno), errno); if (error) {
*error = GCDWebServerMakePosixError(errno);
}
LOG_ERROR(@"Failed binding listening socket: %s (%i)", strerror(errno), errno);
close(listeningSocket); close(listeningSocket);
} }
} else { } else {
LOG_ERROR(@"Failed creating socket: %s (%i)", strerror(errno), errno); if (error) {
*error = GCDWebServerMakePosixError(errno);
}
LOG_ERROR(@"Failed creating listening socket: %s (%i)", strerror(errno), errno);
} }
return (_source ? YES : NO); return (_source ? YES : NO);
} }
@@ -506,7 +544,8 @@ static inline NSString* _EncodeBase64(NSString* string) {
_service = NULL; _service = NULL;
} }
dispatch_source_cancel(_source); // This will close the socket dispatch_source_cancel(_source);
dispatch_semaphore_wait(_sourceSemaphore, DISPATCH_TIME_FOREVER); // Wait until the cancellation handler has been called which guarantees the listening socket is closed
ARC_DISPATCH_RELEASE(_source); ARC_DISPATCH_RELEASE(_source);
_source = NULL; _source = NULL;
_port = 0; _port = 0;
@@ -520,6 +559,14 @@ static inline NSString* _EncodeBase64(NSString* string) {
ARC_RELEASE(_authenticationDigestAccounts); ARC_RELEASE(_authenticationDigestAccounts);
_authenticationDigestAccounts = nil; _authenticationDigestAccounts = nil;
dispatch_async(dispatch_get_main_queue(), ^{
if (_disconnecting) {
CFRunLoopTimerSetNextFireDate(_disconnectTimer, HUGE_VAL);
_disconnecting = NO;
[self _didDisconnect];
}
});
LOG_INFO(@"%@ stopped", [self class]); LOG_INFO(@"%@ stopped", [self class]);
if ([_delegate respondsToSelector:@selector(webServerDidStop:)]) { if ([_delegate respondsToSelector:@selector(webServerDidStop:)]) {
dispatch_async(dispatch_get_main_queue(), ^{ dispatch_async(dispatch_get_main_queue(), ^{
@@ -528,17 +575,6 @@ static inline NSString* _EncodeBase64(NSString* string) {
} }
} }
- (BOOL)start {
return [self startWithPort:kDefaultPort bonjourName:@""];
}
- (BOOL)startWithPort:(NSUInteger)port bonjourName:(NSString*)name {
NSMutableDictionary* options = [NSMutableDictionary dictionary];
[options setObject:[NSNumber numberWithInteger:port] forKey:GCDWebServerOption_Port];
[options setValue:name forKey:GCDWebServerOption_BonjourName];
return [self startWithOptions:options];
}
#if TARGET_OS_IPHONE #if TARGET_OS_IPHONE
- (void)_didEnterBackground:(NSNotification*)notification { - (void)_didEnterBackground:(NSNotification*)notification {
@@ -553,20 +589,20 @@ static inline NSString* _EncodeBase64(NSString* string) {
DCHECK([NSThread isMainThread]); DCHECK([NSThread isMainThread]);
LOG_DEBUG(@"Will enter foreground"); LOG_DEBUG(@"Will enter foreground");
if (!_source) { if (!_source) {
[self _start]; // TODO: There's probably nothing we can do on failure [self _start:NULL]; // TODO: There's probably nothing we can do on failure
} }
} }
#endif #endif
- (BOOL)startWithOptions:(NSDictionary*)options { - (BOOL)startWithOptions:(NSDictionary*)options error:(NSError**)error {
if (_options == nil) { if (_options == nil) {
_options = [options copy]; _options = [options copy];
#if TARGET_OS_IPHONE #if TARGET_OS_IPHONE
_suspendInBackground = [_GetOption(_options, GCDWebServerOption_AutomaticallySuspendInBackground, @YES) boolValue]; _suspendInBackground = [_GetOption(_options, GCDWebServerOption_AutomaticallySuspendInBackground, @YES) boolValue];
if (((_suspendInBackground == NO) || ([[UIApplication sharedApplication] applicationState] != UIApplicationStateBackground)) && ![self _start]) if (((_suspendInBackground == NO) || ([[UIApplication sharedApplication] applicationState] != UIApplicationStateBackground)) && ![self _start:error])
#else #else
if (![self _start]) if (![self _start:error])
#endif #endif
{ {
ARC_RELEASE(_options); ARC_RELEASE(_options);
@@ -640,29 +676,43 @@ static inline NSString* _EncodeBase64(NSString* string) {
return nil; return nil;
} }
- (BOOL)start {
return [self startWithPort:kDefaultPort bonjourName:@""];
}
- (BOOL)startWithPort:(NSUInteger)port bonjourName:(NSString*)name {
NSMutableDictionary* options = [NSMutableDictionary dictionary];
[options setObject:[NSNumber numberWithInteger:port] forKey:GCDWebServerOption_Port];
[options setValue:name forKey:GCDWebServerOption_BonjourName];
return [self startWithOptions:options error:NULL];
}
#if !TARGET_OS_IPHONE #if !TARGET_OS_IPHONE
- (BOOL)runWithPort:(NSUInteger)port bonjourName:(NSString*)name { - (BOOL)runWithPort:(NSUInteger)port bonjourName:(NSString*)name {
NSMutableDictionary* options = [NSMutableDictionary dictionary]; NSMutableDictionary* options = [NSMutableDictionary dictionary];
[options setObject:[NSNumber numberWithInteger:port] forKey:GCDWebServerOption_Port]; [options setObject:[NSNumber numberWithInteger:port] forKey:GCDWebServerOption_Port];
[options setValue:name forKey:GCDWebServerOption_BonjourName]; [options setValue:name forKey:GCDWebServerOption_BonjourName];
return [self runWithOptions:options]; return [self runWithOptions:options error:NULL];
} }
- (BOOL)runWithOptions:(NSDictionary*)options { - (BOOL)runWithOptions:(NSDictionary*)options error:(NSError**)error {
DCHECK([NSThread isMainThread]); DCHECK([NSThread isMainThread]);
BOOL success = NO; BOOL success = NO;
_run = YES; _run = YES;
void (*handler)(int) = signal(SIGINT, _SignalHandler); void (*termHandler)(int) = signal(SIGTERM, _SignalHandler);
if (handler != SIG_ERR) { void (*intHandler)(int) = signal(SIGINT, _SignalHandler);
if ([self startWithOptions:options]) { if ((termHandler != SIG_ERR) && (intHandler != SIG_ERR)) {
if ([self startWithOptions:options error:error]) {
while (_run) { while (_run) {
CFRunLoopRunInMode(kCFRunLoopDefaultMode, 1.0, true); CFRunLoopRunInMode(kCFRunLoopDefaultMode, 1.0, true);
} }
[self stop]; [self stop];
success = YES; success = YES;
} }
signal(SIGINT, handler); _ExecuteMainThreadRunLoopSources();
signal(SIGINT, intHandler);
signal(SIGTERM, termHandler);
} }
return success; return success;
} }
@@ -846,37 +896,29 @@ static inline NSString* _EncodeBase64(NSString* string) {
- (void)logVerbose:(NSString*)format, ... { - (void)logVerbose:(NSString*)format, ... {
va_list arguments; va_list arguments;
va_start(arguments, format); va_start(arguments, format);
NSString* message = [[NSString alloc] initWithFormat:format arguments:arguments]; LOG_VERBOSE(@"%@", ARC_AUTORELEASE([[NSString alloc] initWithFormat:format arguments:arguments]));
va_end(arguments); va_end(arguments);
LOG_VERBOSE(@"%@", message);
ARC_RELEASE(message);
} }
- (void)logInfo:(NSString*)format, ... { - (void)logInfo:(NSString*)format, ... {
va_list arguments; va_list arguments;
va_start(arguments, format); va_start(arguments, format);
NSString* message = [[NSString alloc] initWithFormat:format arguments:arguments]; LOG_INFO(@"%@", ARC_AUTORELEASE([[NSString alloc] initWithFormat:format arguments:arguments]));
va_end(arguments); va_end(arguments);
LOG_INFO(@"%@", message);
ARC_RELEASE(message);
} }
- (void)logWarning:(NSString*)format, ... { - (void)logWarning:(NSString*)format, ... {
va_list arguments; va_list arguments;
va_start(arguments, format); va_start(arguments, format);
NSString* message = [[NSString alloc] initWithFormat:format arguments:arguments]; LOG_WARNING(@"%@", ARC_AUTORELEASE([[NSString alloc] initWithFormat:format arguments:arguments]));
va_end(arguments); va_end(arguments);
LOG_WARNING(@"%@", message);
ARC_RELEASE(message);
} }
- (void)logError:(NSString*)format, ... { - (void)logError:(NSString*)format, ... {
va_list arguments; va_list arguments;
va_start(arguments, format); va_start(arguments, format);
NSString* message = [[NSString alloc] initWithFormat:format arguments:arguments]; LOG_ERROR(@"%@", ARC_AUTORELEASE([[NSString alloc] initWithFormat:format arguments:arguments]));
va_end(arguments); va_end(arguments);
LOG_ERROR(@"%@", message);
ARC_RELEASE(message);
} }
- (void)logException:(NSException*)exception { - (void)logException:(NSException*)exception {
@@ -923,7 +965,7 @@ static CFHTTPMessageRef _CreateHTTPMessageFromPerformingRequest(NSData* inData,
while (1) { while (1) {
ssize_t result = read(httpSocket, (char*)outData.mutableBytes + length, outData.length - length); ssize_t result = read(httpSocket, (char*)outData.mutableBytes + length, outData.length - length);
if (result < 0) { if (result < 0) {
length = NSNotFound; length = NSUIntegerMax;
break; break;
} else if (result == 0) { } else if (result == 0) {
break; break;
@@ -933,7 +975,7 @@ static CFHTTPMessageRef _CreateHTTPMessageFromPerformingRequest(NSData* inData,
outData.length = 2 * outData.length; outData.length = 2 * outData.length;
} }
} }
if (length != NSNotFound) { if (length != NSUIntegerMax) {
outData.length = length; outData.length = length;
response = _CreateHTTPMessageFromData(outData, NO); response = _CreateHTTPMessageFromData(outData, NO);
} else { } else {
@@ -957,9 +999,11 @@ static void _LogResult(NSString* format, ...) {
} }
- (NSInteger)runTestsWithOptions:(NSDictionary*)options inDirectory:(NSString*)path { - (NSInteger)runTestsWithOptions:(NSDictionary*)options inDirectory:(NSString*)path {
DCHECK([NSThread isMainThread]);
NSArray* ignoredHeaders = @[@"Date", @"Etag"]; // Dates are always different by definition and ETags depend on file system node IDs NSArray* ignoredHeaders = @[@"Date", @"Etag"]; // Dates are always different by definition and ETags depend on file system node IDs
NSInteger result = -1; NSInteger result = -1;
if ([self startWithOptions:options]) { if ([self startWithOptions:options error:NULL]) {
_ExecuteMainThreadRunLoopSources();
result = 0; result = 0;
NSArray* files = [[NSFileManager defaultManager] contentsOfDirectoryAtPath:path error:NULL]; NSArray* files = [[NSFileManager defaultManager] contentsOfDirectoryAtPath:path error:NULL];
@@ -1015,8 +1059,13 @@ static void _LogResult(NSString* format, ...) {
} }
} }
NSString* expectedContentLength = ARC_BRIDGE_RELEASE(CFHTTPMessageCopyHeaderFieldValue(expectedResponse, CFSTR("Content-Length")));
NSData* expectedBody = ARC_BRIDGE_RELEASE(CFHTTPMessageCopyBody(expectedResponse)); NSData* expectedBody = ARC_BRIDGE_RELEASE(CFHTTPMessageCopyBody(expectedResponse));
NSString* actualContentLength = ARC_BRIDGE_RELEASE(CFHTTPMessageCopyHeaderFieldValue(actualResponse, CFSTR("Content-Length")));
NSData* actualBody = ARC_BRIDGE_RELEASE(CFHTTPMessageCopyBody(actualResponse)); NSData* actualBody = ARC_BRIDGE_RELEASE(CFHTTPMessageCopyBody(actualResponse));
if ([actualContentLength isEqualToString:expectedContentLength] && (actualBody.length > expectedBody.length)) { // Handle web browser closing connection before retrieving entire body (e.g. when playing a video file)
actualBody = [actualBody subdataWithRange:NSMakeRange(0, expectedBody.length)];
}
if (![actualBody isEqualToData:expectedBody]) { if (![actualBody isEqualToData:expectedBody]) {
_LogResult(@" Bodies not matching:\n Expected: %lu bytes\n Actual: %lu bytes", (unsigned long)expectedBody.length, (unsigned long)actualBody.length); _LogResult(@" Bodies not matching:\n Expected: %lu bytes\n Actual: %lu bytes", (unsigned long)expectedBody.length, (unsigned long)actualBody.length);
success = NO; success = NO;
@@ -1057,9 +1106,12 @@ static void _LogResult(NSString* format, ...) {
++result; ++result;
} }
} }
_ExecuteMainThreadRunLoopSources();
} }
[self stop]; [self stop];
_ExecuteMainThreadRunLoopSources();
} }
return result; return result;
} }

View File

@@ -38,8 +38,8 @@
* subclass it to override some hooks. Use the GCDWebServerOption_ConnectionClass * subclass it to override some hooks. Use the GCDWebServerOption_ConnectionClass
* option for GCDWebServer to install your custom subclass. * option for GCDWebServer to install your custom subclass.
* *
* @warning The GCDWebServerConnection retains the GCDWebServer * @warning The GCDWebServerConnection retains the GCDWebServer until the
* until the connection is closed. * connection is closed.
*/ */
@interface GCDWebServerConnection : NSObject @interface GCDWebServerConnection : NSObject
@@ -95,6 +95,7 @@
/** /**
* This method is called when the connection is opened. * This method is called when the connection is opened.
*
* Return NO to reject the connection e.g. after validating the local * Return NO to reject the connection e.g. after validating the local
* or remote address. * or remote address.
*/ */
@@ -103,17 +104,29 @@
/** /**
* This method is called whenever data has been received * This method is called whenever data has been received
* from the remote peer (i.e. client). * from the remote peer (i.e. client).
*
* @warning Do not attempt to modify this data.
*/ */
- (void)didReadBytes:(const void*)bytes length:(NSUInteger)length; - (void)didReadBytes:(const void*)bytes length:(NSUInteger)length;
/** /**
* This method is called whenever data has been sent * This method is called whenever data has been sent
* to the remote peer (i.e. client). * to the remote peer (i.e. client).
*
* @warning Do not attempt to modify this data.
*/ */
- (void)didWriteBytes:(const void*)bytes length:(NSUInteger)length; - (void)didWriteBytes:(const void*)bytes length:(NSUInteger)length;
/** /**
* Assuming a valid request was received, this method is called before * This method is called after the HTTP headers have been received to
* allow replacing the request URL by another one.
*
* The default implementation returns the original URL.
*/
- (NSURL*)rewriteRequestURL:(NSURL*)url withMethod:(NSString*)method headers:(NSDictionary*)headers;
/**
* Assuming a valid HTTP request was received, this method is called before
* the request is processed. * the request is processed.
* *
* Return a non-nil GCDWebServerResponse to bypass the request processing entirely. * Return a non-nil GCDWebServerResponse to bypass the request processing entirely.
@@ -124,18 +137,18 @@
- (GCDWebServerResponse*)preflightRequest:(GCDWebServerRequest*)request; - (GCDWebServerResponse*)preflightRequest:(GCDWebServerRequest*)request;
/** /**
* Assuming a valid request was received and -preflightRequest: returned nil, * Assuming a valid HTTP request was received and -preflightRequest: returned nil,
* this method is called to process the request. * this method is called to process the request.
*/ */
- (GCDWebServerResponse*)processRequest:(GCDWebServerRequest*)request withBlock:(GCDWebServerProcessBlock)block; - (GCDWebServerResponse*)processRequest:(GCDWebServerRequest*)request withBlock:(GCDWebServerProcessBlock)block;
/** /**
* Assuming a valid request was received and either -preflightRequest: * Assuming a valid HTTP request was received and either -preflightRequest:
* or -processRequest:withBlock: returned a non-nil GCDWebServerResponse, * or -processRequest:withBlock: returned a non-nil GCDWebServerResponse,
* this method is called to override the response. * this method is called to override the response.
* *
* You can either modify the current response and return it, or return a * You can either modify the current response and return it, or return a
* completely different one. * completely new one.
* *
* The default implementation replaces any response matching the "ETag" or * The default implementation replaces any response matching the "ETag" or
* "Last-Modified-Date" header of the request by a barebone "Not-Modified" (304) * "Last-Modified-Date" header of the request by a barebone "Not-Modified" (304)
@@ -145,7 +158,7 @@
/** /**
* This method is called if any error happens while validing or processing * This method is called if any error happens while validing or processing
* the request or no GCDWebServerResponse is generated. * the request or if no GCDWebServerResponse was generated during processing.
* *
* @warning If the request was invalid (e.g. the HTTP headers were malformed), * @warning If the request was invalid (e.g. the HTTP headers were malformed),
* the "request" argument will be nil. * the "request" argument will be nil.

View File

@@ -416,7 +416,7 @@ static inline NSUInteger _ScanHexNumber(const void* bytes, NSUInteger size) {
if (_response.contentType != nil) { if (_response.contentType != nil) {
CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Content-Type"), (ARC_BRIDGE CFStringRef)GCDWebServerNormalizeHeaderValue(_response.contentType)); CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Content-Type"), (ARC_BRIDGE CFStringRef)GCDWebServerNormalizeHeaderValue(_response.contentType));
} }
if (_response.contentLength != NSNotFound) { if (_response.contentLength != NSUIntegerMax) {
CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Content-Length"), (ARC_BRIDGE CFStringRef)[NSString stringWithFormat:@"%lu", (unsigned long)_response.contentLength]); CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Content-Length"), (ARC_BRIDGE CFStringRef)[NSString stringWithFormat:@"%lu", (unsigned long)_response.contentLength]);
} }
if (_response.usesChunkedTransferEncoding) { if (_response.usesChunkedTransferEncoding) {
@@ -522,11 +522,15 @@ static inline NSUInteger _ScanHexNumber(const void* bytes, NSUInteger size) {
requestMethod = @"GET"; requestMethod = @"GET";
_virtualHEAD = YES; _virtualHEAD = YES;
} }
NSDictionary* requestHeaders = ARC_BRIDGE_RELEASE(CFHTTPMessageCopyAllHeaderFields(_requestMessage)); // Header names are case-insensitive but CFHTTPMessageCopyAllHeaderFields() will standardize the common ones
NSURL* requestURL = ARC_BRIDGE_RELEASE(CFHTTPMessageCopyRequestURL(_requestMessage)); NSURL* requestURL = ARC_BRIDGE_RELEASE(CFHTTPMessageCopyRequestURL(_requestMessage));
if (requestURL) {
requestURL = [self rewriteRequestURL:requestURL withMethod:requestMethod headers:requestHeaders];
DCHECK(requestURL);
}
NSString* requestPath = requestURL ? GCDWebServerUnescapeURLString(ARC_BRIDGE_RELEASE(CFURLCopyPath((CFURLRef)requestURL))) : nil; // Don't use -[NSURL path] which strips the ending slash NSString* requestPath = requestURL ? GCDWebServerUnescapeURLString(ARC_BRIDGE_RELEASE(CFURLCopyPath((CFURLRef)requestURL))) : nil; // Don't use -[NSURL path] which strips the ending slash
NSString* queryString = requestURL ? ARC_BRIDGE_RELEASE(CFURLCopyQueryString((CFURLRef)requestURL, NULL)) : nil; // Don't use -[NSURL query] to make sure query is not unescaped; NSString* queryString = requestURL ? ARC_BRIDGE_RELEASE(CFURLCopyQueryString((CFURLRef)requestURL, NULL)) : nil; // Don't use -[NSURL query] to make sure query is not unescaped;
NSDictionary* requestQuery = queryString ? GCDWebServerParseURLEncodedForm(queryString) : @{}; NSDictionary* requestQuery = queryString ? GCDWebServerParseURLEncodedForm(queryString) : @{};
NSDictionary* requestHeaders = ARC_BRIDGE_RELEASE(CFHTTPMessageCopyAllHeaderFields(_requestMessage)); // Header names are case-insensitive but CFHTTPMessageCopyAllHeaderFields() will standardize the common ones
if (requestMethod && requestURL && requestHeaders && requestPath && requestQuery) { if (requestMethod && requestURL && requestHeaders && requestPath && requestQuery) {
for (_handler in _server.handlers) { for (_handler in _server.handlers) {
_request = ARC_RETAIN(_handler.matchBlock(requestMethod, requestURL, requestHeaders, requestPath, requestQuery)); _request = ARC_RETAIN(_handler.matchBlock(requestMethod, requestURL, requestHeaders, requestPath, requestQuery));
@@ -675,11 +679,11 @@ static NSString* _StringFromAddressData(NSData* data) {
_connectionIndex = OSAtomicIncrement32(&_connectionCounter); _connectionIndex = OSAtomicIncrement32(&_connectionCounter);
_requestPath = ARC_RETAIN([NSTemporaryDirectory() stringByAppendingPathComponent:[[NSProcessInfo processInfo] globallyUniqueString]]); _requestPath = ARC_RETAIN([NSTemporaryDirectory() stringByAppendingPathComponent:[[NSProcessInfo processInfo] globallyUniqueString]]);
_requestFD = open([_requestPath fileSystemRepresentation], O_CREAT | O_TRUNC | O_WRONLY); _requestFD = open([_requestPath fileSystemRepresentation], O_CREAT | O_TRUNC | O_WRONLY, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
DCHECK(_requestFD > 0); DCHECK(_requestFD > 0);
_responsePath = ARC_RETAIN([NSTemporaryDirectory() stringByAppendingPathComponent:[[NSProcessInfo processInfo] globallyUniqueString]]); _responsePath = ARC_RETAIN([NSTemporaryDirectory() stringByAppendingPathComponent:[[NSProcessInfo processInfo] globallyUniqueString]]);
_responseFD = open([_responsePath fileSystemRepresentation], O_CREAT | O_TRUNC | O_WRONLY); _responseFD = open([_responsePath fileSystemRepresentation], O_CREAT | O_TRUNC | O_WRONLY, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
DCHECK(_responseFD > 0); DCHECK(_responseFD > 0);
} }
#endif #endif
@@ -713,6 +717,10 @@ static NSString* _StringFromAddressData(NSData* data) {
#endif #endif
} }
- (NSURL*)rewriteRequestURL:(NSURL*)url withMethod:(NSString*)method headers:(NSDictionary*)headers {
return url;
}
// https://tools.ietf.org/html/rfc2617 // https://tools.ietf.org/html/rfc2617
- (GCDWebServerResponse*)preflightRequest:(GCDWebServerRequest*)request { - (GCDWebServerResponse*)preflightRequest:(GCDWebServerRequest*)request {
LOG_DEBUG(@"Connection on socket %i preflighting request \"%@ %@\" with %lu bytes body", _socket, _virtualHEAD ? @"HEAD" : _request.method, _request.path, (unsigned long)_bytesRead); LOG_DEBUG(@"Connection on socket %i preflighting request \"%@ %@\" with %lu bytes body", _socket, _virtualHEAD ? @"HEAD" : _request.method, _request.path, (unsigned long)_bytesRead);

View File

@@ -50,17 +50,18 @@ NSString* GCDWebServerEscapeURLString(NSString* string);
NSString* GCDWebServerUnescapeURLString(NSString* string); NSString* GCDWebServerUnescapeURLString(NSString* string);
/** /**
* Extracts the unescaped names and values * Extracts the unescaped names and values from an
* from a "application/x-www-form-urlencoded" form. * "application/x-www-form-urlencoded" form.
* http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1 * http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1
*/ */
NSDictionary* GCDWebServerParseURLEncodedForm(NSString* form); NSDictionary* GCDWebServerParseURLEncodedForm(NSString* form);
/** /**
* OS X: Returns the IPv4 address as a dotted string of the primary connected * On OS X, returns the IPv4 address as a dotted string of the primary connected
* service or nil if not available. * service or nil if not available.
* iOS: Returns the IPv4 address as a dotted string of the WiFi interface *
* if connected or nil otherwise. * On iOS, returns the IPv4 address as a dotted string of the WiFi interface
* if connected or nil otherwise.
*/ */
NSString* GCDWebServerGetPrimaryIPv4Address(); NSString* GCDWebServerGetPrimaryIPv4Address();
@@ -76,7 +77,7 @@ NSString* GCDWebServerFormatRFC822(NSDate* date);
* https://tools.ietf.org/html/rfc822#section-5 * https://tools.ietf.org/html/rfc822#section-5
* https://tools.ietf.org/html/rfc1123#section-5.2.14 * https://tools.ietf.org/html/rfc1123#section-5.2.14
* *
* @warning Timezones are not supported at this time. * @warning Timezones other than GMT are not supported by this function.
*/ */
NSDate* GCDWebServerParseRFC822(NSString* string); NSDate* GCDWebServerParseRFC822(NSString* string);
@@ -91,7 +92,7 @@ NSString* GCDWebServerFormatISO8601(NSDate* date);
* http://tools.ietf.org/html/rfc3339#section-5.6 * http://tools.ietf.org/html/rfc3339#section-5.6
* *
* @warning Only "calendar" variant is supported at this time and timezones * @warning Only "calendar" variant is supported at this time and timezones
* are not supported either. * other than GMT are not supported either.
*/ */
NSDate* GCDWebServerParseISO8601(NSString* string); NSDate* GCDWebServerParseISO8601(NSString* string);

View File

@@ -198,8 +198,9 @@ NSDictionary* GCDWebServerParseURLEncodedForm(NSString* form) {
[scanner setScanLocation:([scanner scanLocation] + 1)]; [scanner setScanLocation:([scanner scanLocation] + 1)];
NSString* value = nil; NSString* value = nil;
if (![scanner scanUpToString:@"&" intoString:&value]) { [scanner scanUpToString:@"&" intoString:&value];
break; if (value == nil) {
value = @"";
} }
key = [key stringByReplacingOccurrencesOfString:@"+" withString:@" "]; key = [key stringByReplacingOccurrencesOfString:@"+" withString:@" "];

View File

@@ -111,7 +111,11 @@ extern void GCDLogMessage(GCDWebServerLogLevel level, NSString* format, ...) NS_
#define kGCDWebServerErrorDomain @"GCDWebServerErrorDomain" #define kGCDWebServerErrorDomain @"GCDWebServerErrorDomain"
static inline BOOL GCDWebServerIsValidByteRange(NSRange range) { static inline BOOL GCDWebServerIsValidByteRange(NSRange range) {
return ((range.location != NSNotFound) || (range.length > 0)); return ((range.location != NSUIntegerMax) || (range.length > 0));
}
static inline NSError* GCDWebServerMakePosixError(int code) {
return [NSError errorWithDomain:NSPOSIXErrorDomain code:code userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithUTF8String:strerror(code)]}];
} }
extern void GCDWebServerInitializeFunctions(); extern void GCDWebServerInitializeFunctions();

View File

@@ -106,8 +106,8 @@
@property(nonatomic, readonly) NSDictionary* query; @property(nonatomic, readonly) NSDictionary* query;
/** /**
* Returns the content type for the body of the request (this property is * Returns the content type for the body of the request parsed from the
* automatically parsed from the HTTP headers). * "Content-Type" header.
* *
* This property will be nil if the request has no body or set to * This property will be nil if the request has no body or set to
* "application/octet-stream" if a body is present but there was no * "application/octet-stream" if a body is present but there was no
@@ -116,10 +116,10 @@
@property(nonatomic, readonly) NSString* contentType; @property(nonatomic, readonly) NSString* contentType;
/** /**
* Returns the content length for the body of the request (this property is * Returns the content length for the body of the request parsed from the
* automatically parsed from the HTTP headers). * "Content-Length" header.
* *
* This property will be set to "NSNotFound" if the request has no body or * This property will be set to "NSUIntegerMax" if the request has no body or
* if there is a body but no "Content-Length" header, typically because * if there is a body but no "Content-Length" header, typically because
* chunked transfer encoding is used. * chunked transfer encoding is used.
*/ */
@@ -136,15 +136,15 @@
@property(nonatomic, readonly) NSString* ifNoneMatch; @property(nonatomic, readonly) NSString* ifNoneMatch;
/** /**
* Returns the parsed "Range" header or (NSNotFound, 0) if absent or malformed. * Returns the parsed "Range" header or (NSUIntegerMax, 0) if absent or malformed.
* The range will be set to (offset, length) if expressed from the beginning * The range will be set to (offset, length) if expressed from the beginning
* of the body, or (NSNotFound, -length) if expressed from the end of the body. * of the entity body, or (NSUIntegerMax, length) if expressed from its end.
*/ */
@property(nonatomic, readonly) NSRange byteRange; @property(nonatomic, readonly) NSRange byteRange;
/** /**
* Indicates if the client supports gzip content encoding (this property is * Returns YES if the client supports gzip content encoding according to the
* automatically parsed from the HTTP headers). * "Accept-Encoding" header.
*/ */
@property(nonatomic, readonly) BOOL acceptsGzipContentEncoding; @property(nonatomic, readonly) BOOL acceptsGzipContentEncoding;

View File

@@ -187,14 +187,14 @@
if (_type == nil) { if (_type == nil) {
_type = kGCDWebServerDefaultMimeType; _type = kGCDWebServerDefaultMimeType;
} }
_length = NSNotFound; _length = NSUIntegerMax;
} else { } else {
if (_type) { if (_type) {
DNOT_REACHED(); DNOT_REACHED();
ARC_RELEASE(self); ARC_RELEASE(self);
return nil; return nil;
} }
_length = NSNotFound; _length = NSUIntegerMax;
} }
NSString* modifiedHeader = [_headers objectForKey:@"If-Modified-Since"]; NSString* modifiedHeader = [_headers objectForKey:@"If-Modified-Since"];
@@ -203,7 +203,7 @@
} }
_noneMatch = ARC_RETAIN([_headers objectForKey:@"If-None-Match"]); _noneMatch = ARC_RETAIN([_headers objectForKey:@"If-None-Match"]);
_range = NSMakeRange(NSNotFound, 0); _range = NSMakeRange(NSUIntegerMax, 0);
NSString* rangeHeader = GCDWebServerNormalizeHeaderValue([_headers objectForKey:@"Range"]); NSString* rangeHeader = GCDWebServerNormalizeHeaderValue([_headers objectForKey:@"Range"]);
if (rangeHeader) { if (rangeHeader) {
if ([rangeHeader hasPrefix:@"bytes="]) { if ([rangeHeader hasPrefix:@"bytes="]) {
@@ -222,13 +222,13 @@
_range.location = startValue; _range.location = startValue;
_range.length = NSUIntegerMax; _range.length = NSUIntegerMax;
} else if (endString.length && (endValue > 0)) { // The final 500 bytes: "-500" } else if (endString.length && (endValue > 0)) { // The final 500 bytes: "-500"
_range.location = NSNotFound; _range.location = NSUIntegerMax;
_range.length = endValue; _range.length = endValue;
} }
} }
} }
} }
if ((_range.location == NSNotFound) && (_range.length == 0)) { // Ignore "Range" header if syntactically invalid if ((_range.location == NSUIntegerMax) && (_range.length == 0)) { // Ignore "Range" header if syntactically invalid
LOG_WARNING(@"Failed to parse 'Range' header \"%@\" for url: %@", rangeHeader, url); LOG_WARNING(@"Failed to parse 'Range' header \"%@\" for url: %@", rangeHeader, url);
} }
} }

View File

@@ -29,7 +29,7 @@
/** /**
* This protocol is used by the GCDWebServerConnection to communicate with * This protocol is used by the GCDWebServerConnection to communicate with
* the GCDWebServerResponse and read the sent HTTP body data. * the GCDWebServerResponse and read the HTTP body data to send.
* *
* Note that multiple GCDWebServerBodyReader objects can be chained together * Note that multiple GCDWebServerBodyReader objects can be chained together
* internally e.g. to automatically apply gzip encoding to the content before * internally e.g. to automatically apply gzip encoding to the content before
@@ -48,7 +48,7 @@
- (BOOL)open:(NSError**)error; - (BOOL)open:(NSError**)error;
/** /**
* This method is called whenever body data is ready to be sent. * This method is called whenever body data is sent.
* *
* It should return a non-empty NSData if there is body data available, * It should return a non-empty NSData if there is body data available,
* or an empty NSData there is no more body data, or nil on error and set * or an empty NSData there is no more body data, or nil on error and set
@@ -67,7 +67,7 @@
* The GCDWebServerResponse class is used to wrap a single HTTP response. * The GCDWebServerResponse class is used to wrap a single HTTP response.
* It is instantiated by the handler of the GCDWebServer that handled the request. * It is instantiated by the handler of the GCDWebServer that handled the request.
* If a body is present, the methods from the GCDWebServerBodyReader protocol * If a body is present, the methods from the GCDWebServerBodyReader protocol
* will be called by the GCDWebServerConnection to retrieve it. * will be called by the GCDWebServerConnection to send it.
* *
* The default implementation of the GCDWebServerBodyReader protocol * The default implementation of the GCDWebServerBodyReader protocol
* on the class simply returns an empty body. * on the class simply returns an empty body.
@@ -78,20 +78,21 @@
/** /**
* Sets the content type for the body of the response. * Sets the content type for the body of the response.
* This property must be set if a body is present.
* *
* The default value is nil i.e. the response has no body. * The default value is nil i.e. the response has no body.
*
* @warning This property must be set if a body is present.
*/ */
@property(nonatomic, copy) NSString* contentType; @property(nonatomic, copy) NSString* contentType;
/** /**
* Sets the content length for the body of the response. If a body is present * Sets the content length for the body of the response. If a body is present
* but this property is set to "NSNotFound", this means the length of the body * but this property is set to "NSUIntegerMax", this means the length of the body
* cannot be known ahead of time and chunked transfer encoding will be * cannot be known ahead of time. Chunked transfer encoding will be
* automatically enabled by the GCDWebServerConnection to comply with HTTP/1.1 * automatically enabled by the GCDWebServerConnection to comply with HTTP/1.1
* specifications. * specifications.
* *
* The default value is "NSNotFound" i.e. the response has no body or its length * The default value is "NSUIntegerMax" i.e. the response has no body or its length
* is undefined. * is undefined.
*/ */
@property(nonatomic) NSUInteger contentLength; @property(nonatomic) NSUInteger contentLength;
@@ -152,7 +153,7 @@
* Pass a nil value to remove an additional header. * Pass a nil value to remove an additional header.
* *
* @warning Do not attempt to override the primary headers used * @warning Do not attempt to override the primary headers used
* by GCDWebServerResponse e.g. "Content-Type" or "ETag". * by GCDWebServerResponse like "Content-Type", "ETag", etc...
*/ */
- (void)setValue:(NSString*)value forAdditionalHeader:(NSString*)header; - (void)setValue:(NSString*)value forAdditionalHeader:(NSString*)header;

View File

@@ -81,7 +81,7 @@
- (id)initWithResponse:(GCDWebServerResponse*)response reader:(id<GCDWebServerBodyReader>)reader { - (id)initWithResponse:(GCDWebServerResponse*)response reader:(id<GCDWebServerBodyReader>)reader {
if ((self = [super initWithResponse:response reader:reader])) { if ((self = [super initWithResponse:response reader:reader])) {
response.contentLength = NSNotFound; // Make sure "Content-Length" header is not set since we don't know it response.contentLength = NSUIntegerMax; // Make sure "Content-Length" header is not set since we don't know it
[response setValue:@"gzip" forAdditionalHeader:@"Content-Encoding"]; [response setValue:@"gzip" forAdditionalHeader:@"Content-Encoding"];
} }
return self; return self;
@@ -180,7 +180,7 @@
- (instancetype)init { - (instancetype)init {
if ((self = [super init])) { if ((self = [super init])) {
_type = nil; _type = nil;
_length = NSNotFound; _length = NSUIntegerMax;
_status = kGCDWebServerHTTPStatusCode_OK; _status = kGCDWebServerHTTPStatusCode_OK;
_maxAge = 0; _maxAge = 0;
_headers = [[NSMutableDictionary alloc] init]; _headers = [[NSMutableDictionary alloc] init];
@@ -208,7 +208,7 @@
} }
- (BOOL)usesChunkedTransferEncoding { - (BOOL)usesChunkedTransferEncoding {
return (_type != nil) && (_length == NSNotFound); return (_type != nil) && (_length == NSUIntegerMax);
} }
- (BOOL)open:(NSError**)error { - (BOOL)open:(NSError**)error {
@@ -259,7 +259,7 @@
if (_type) { if (_type) {
[description appendFormat:@"\nContent Type = %@", _type]; [description appendFormat:@"\nContent Type = %@", _type];
} }
if (_length != NSNotFound) { if (_length != NSUIntegerMax) {
[description appendFormat:@"\nContent Length = %lu", (unsigned long)_length]; [description appendFormat:@"\nContent Length = %lu", (unsigned long)_length];
} }
[description appendFormat:@"\nCache Control Max Age = %lu", (unsigned long)_maxAge]; [description appendFormat:@"\nCache Control Max Age = %lu", (unsigned long)_maxAge];

View File

@@ -49,7 +49,7 @@
} }
- (BOOL)open:(NSError**)error { - (BOOL)open:(NSError**)error {
if (self.contentLength != NSNotFound) { if (self.contentLength != NSUIntegerMax) {
_data = [[NSMutableData alloc] initWithCapacity:self.contentLength]; _data = [[NSMutableData alloc] initWithCapacity:self.contentLength];
} else { } else {
_data = [[NSMutableData alloc] init]; _data = [[NSMutableData alloc] init];
@@ -97,7 +97,8 @@
- (id)jsonObject { - (id)jsonObject {
if (_jsonObject == nil) { if (_jsonObject == nil) {
if ([self.contentType isEqualToString:@"application/json"] || [self.contentType isEqualToString:@"text/json"] || [self.contentType isEqualToString:@"text/javascript"]) { NSString* mimeType = GCDWebServerTruncateHeaderValue(self.contentType);
if ([mimeType isEqualToString:@"application/json"] || [mimeType isEqualToString:@"text/json"] || [mimeType isEqualToString:@"text/javascript"]) {
_jsonObject = ARC_RETAIN([NSJSONSerialization JSONObjectWithData:_data options:0 error:NULL]); _jsonObject = ARC_RETAIN([NSJSONSerialization JSONObjectWithData:_data options:0 error:NULL]);
} else { } else {
DNOT_REACHED(); DNOT_REACHED();

View File

@@ -34,10 +34,6 @@
} }
@end @end
static inline NSError* _MakePosixError(int code) {
return [NSError errorWithDomain:NSPOSIXErrorDomain code:code userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"%s", strerror(code)]}];
}
@implementation GCDWebServerFileRequest @implementation GCDWebServerFileRequest
@synthesize temporaryPath=_temporaryPath; @synthesize temporaryPath=_temporaryPath;
@@ -59,7 +55,7 @@ static inline NSError* _MakePosixError(int code) {
- (BOOL)open:(NSError**)error { - (BOOL)open:(NSError**)error {
_file = open([_temporaryPath fileSystemRepresentation], O_CREAT | O_TRUNC | O_WRONLY, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); _file = open([_temporaryPath fileSystemRepresentation], O_CREAT | O_TRUNC | O_WRONLY, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
if (_file <= 0) { if (_file <= 0) {
*error = _MakePosixError(errno); *error = GCDWebServerMakePosixError(errno);
return NO; return NO;
} }
return YES; return YES;
@@ -67,7 +63,7 @@ static inline NSError* _MakePosixError(int code) {
- (BOOL)writeData:(NSData*)data error:(NSError**)error { - (BOOL)writeData:(NSData*)data error:(NSError**)error {
if (write(_file, data.bytes, data.length) != (ssize_t)data.length) { if (write(_file, data.bytes, data.length) != (ssize_t)data.length) {
*error = _MakePosixError(errno); *error = GCDWebServerMakePosixError(errno);
return NO; return NO;
} }
return YES; return YES;
@@ -75,7 +71,7 @@ static inline NSError* _MakePosixError(int code) {
- (BOOL)close:(NSError**)error { - (BOOL)close:(NSError**)error {
if (close(_file) < 0) { if (close(_file) < 0) {
*error = _MakePosixError(errno); *error = GCDWebServerMakePosixError(errno);
return NO; return NO;
} }
#ifdef __GCDWEBSERVER_ENABLE_TESTING__ #ifdef __GCDWEBSERVER_ENABLE_TESTING__

View File

@@ -33,6 +33,11 @@
*/ */
@interface GCDWebServerMultiPart : NSObject @interface GCDWebServerMultiPart : NSObject
/**
* Returns the control name retrieved from the part headers.
*/
@property(nonatomic, readonly) NSString* controlName;
/** /**
* Returns the content type retrieved from the part headers or "text/plain" * Returns the content type retrieved from the part headers or "text/plain"
* if not available (per HTTP specifications). * if not available (per HTTP specifications).
@@ -100,13 +105,13 @@
* Returns the argument parts from the multipart encoded form as * Returns the argument parts from the multipart encoded form as
* name / GCDWebServerMultiPartArgument pairs. * name / GCDWebServerMultiPartArgument pairs.
*/ */
@property(nonatomic, readonly) NSDictionary* arguments; @property(nonatomic, readonly) NSArray* arguments;
/** /**
* Returns the files parts from the multipart encoded form as * Returns the files parts from the multipart encoded form as
* name / GCDWebServerMultiPartFile pairs. * name / GCDWebServerMultiPartFile pairs.
*/ */
@property(nonatomic, readonly) NSDictionary* files; @property(nonatomic, readonly) NSArray* files;
/** /**
* Returns the MIME type for multipart encoded forms * Returns the MIME type for multipart encoded forms
@@ -114,4 +119,14 @@
*/ */
+ (NSString*)mimeType; + (NSString*)mimeType;
/**
* Returns the first argument for a given control name or nil if not found.
*/
- (GCDWebServerMultiPartArgument*)firstArgumentForControlName:(NSString*)name;
/**
* Returns the first file for a given control name or nil if not found.
*/
- (GCDWebServerMultiPartFile*)firstFileForControlName:(NSString*)name;
@end @end

View File

@@ -29,13 +29,19 @@
#define kMultiPartBufferSize (256 * 1024) #define kMultiPartBufferSize (256 * 1024)
enum { typedef enum {
kParserState_Undefined = 0, kParserState_Undefined = 0,
kParserState_Start, kParserState_Start,
kParserState_Headers, kParserState_Headers,
kParserState_Content, kParserState_Content,
kParserState_End kParserState_End
}; } ParserState;
@interface GCDWebServerMIMEStreamParser : NSObject
- (id)initWithBoundary:(NSString*)boundary defaultControlName:(NSString*)name arguments:(NSMutableArray*)arguments files:(NSMutableArray*)files;
- (BOOL)appendBytes:(const void*)bytes length:(NSUInteger)length;
- (BOOL)isAtEnd;
@end
static NSData* _newlineData = nil; static NSData* _newlineData = nil;
static NSData* _newlinesData = nil; static NSData* _newlinesData = nil;
@@ -43,6 +49,7 @@ static NSData* _dashNewlineData = nil;
@interface GCDWebServerMultiPart () { @interface GCDWebServerMultiPart () {
@private @private
NSString* _controlName;
NSString* _contentType; NSString* _contentType;
NSString* _mimeType; NSString* _mimeType;
} }
@@ -50,17 +57,19 @@ static NSData* _dashNewlineData = nil;
@implementation GCDWebServerMultiPart @implementation GCDWebServerMultiPart
@synthesize contentType=_contentType, mimeType=_mimeType; @synthesize controlName=_controlName, contentType=_contentType, mimeType=_mimeType;
- (id)initWithContentType:(NSString*)contentType { - (id)initWithControlName:(NSString*)name contentType:(NSString*)type {
if ((self = [super init])) { if ((self = [super init])) {
_contentType = [contentType copy]; _controlName = [name copy];
_contentType = [type copy];
_mimeType = ARC_RETAIN(GCDWebServerTruncateHeaderValue(_contentType)); _mimeType = ARC_RETAIN(GCDWebServerTruncateHeaderValue(_contentType));
} }
return self; return self;
} }
- (void)dealloc { - (void)dealloc {
ARC_RELEASE(_controlName);
ARC_RELEASE(_contentType); ARC_RELEASE(_contentType);
ARC_RELEASE(_mimeType); ARC_RELEASE(_mimeType);
@@ -80,8 +89,8 @@ static NSData* _dashNewlineData = nil;
@synthesize data=_data, string=_string; @synthesize data=_data, string=_string;
- (id)initWithContentType:(NSString*)contentType data:(NSData*)data { - (id)initWithControlName:(NSString*)name contentType:(NSString*)type data:(NSData*)data {
if ((self = [super initWithContentType:contentType])) { if ((self = [super initWithControlName:name contentType:type])) {
_data = ARC_RETAIN(data); _data = ARC_RETAIN(data);
if ([self.contentType hasPrefix:@"text/"]) { if ([self.contentType hasPrefix:@"text/"]) {
@@ -116,8 +125,8 @@ static NSData* _dashNewlineData = nil;
@synthesize fileName=_fileName, temporaryPath=_temporaryPath; @synthesize fileName=_fileName, temporaryPath=_temporaryPath;
- (id)initWithContentType:(NSString*)contentType fileName:(NSString*)fileName temporaryPath:(NSString*)temporaryPath { - (id)initWithControlName:(NSString*)name contentType:(NSString*)type fileName:(NSString*)fileName temporaryPath:(NSString*)temporaryPath {
if ((self = [super initWithContentType:contentType])) { if ((self = [super initWithControlName:name contentType:type])) {
_fileName = [fileName copy]; _fileName = [fileName copy];
_temporaryPath = [temporaryPath copy]; _temporaryPath = [temporaryPath copy];
} }
@@ -139,26 +148,25 @@ static NSData* _dashNewlineData = nil;
@end @end
@interface GCDWebServerMultiPartFormRequest () { @interface GCDWebServerMIMEStreamParser () {
@private @private
NSData* _boundary; NSData* _boundary;
NSString* _defaultcontrolName;
ParserState _state;
NSMutableData* _data;
NSMutableArray* _arguments;
NSMutableArray* _files;
NSUInteger _parserState;
NSMutableData* _parserData;
NSString* _controlName; NSString* _controlName;
NSString* _fileName; NSString* _fileName;
NSString* _contentType; NSString* _contentType;
NSString* _tmpPath; NSString* _tmpPath;
int _tmpFile; int _tmpFile;
GCDWebServerMIMEStreamParser* _subParser;
NSMutableDictionary* _arguments;
NSMutableDictionary* _files;
} }
@end @end
@implementation GCDWebServerMultiPartFormRequest @implementation GCDWebServerMIMEStreamParser
@synthesize arguments=_arguments, files=_files;
+ (void)initialize { + (void)initialize {
if (_newlineData == nil) { if (_newlineData == nil) {
@@ -175,49 +183,50 @@ static NSData* _dashNewlineData = nil;
} }
} }
+ (NSString*)mimeType { - (id)initWithBoundary:(NSString*)boundary defaultControlName:(NSString*)name arguments:(NSMutableArray*)arguments files:(NSMutableArray*)files {
return @"multipart/form-data"; NSData* data = boundary.length ? [[NSString stringWithFormat:@"--%@", boundary] dataUsingEncoding:NSASCIIStringEncoding] : nil;
} if (data == nil) {
DNOT_REACHED();
- (instancetype)initWithMethod:(NSString*)method url:(NSURL*)url headers:(NSDictionary*)headers path:(NSString*)path query:(NSDictionary*)query { ARC_RELEASE(self);
if ((self = [super initWithMethod:method url:url headers:headers path:path query:query])) { return nil;
NSString* boundary = GCDWebServerExtractHeaderValueParameter(self.contentType, @"boundary"); }
if (boundary) { if ((self = [super init])) {
NSData* data = [[NSString stringWithFormat:@"--%@", boundary] dataUsingEncoding:NSASCIIStringEncoding]; _boundary = ARC_RETAIN(data);
_boundary = ARC_RETAIN(data); _defaultcontrolName = ARC_RETAIN(name);
} _arguments = ARC_RETAIN(arguments);
if (_boundary == nil) { _files = ARC_RETAIN(files);
DNOT_REACHED(); _data = [[NSMutableData alloc] initWithCapacity:kMultiPartBufferSize];
ARC_RELEASE(self); _state = kParserState_Start;
return nil;
}
_arguments = [[NSMutableDictionary alloc] init];
_files = [[NSMutableDictionary alloc] init];
} }
return self; return self;
} }
- (void)dealloc { - (void)dealloc {
ARC_RELEASE(_boundary);
ARC_RELEASE(_defaultcontrolName);
ARC_RELEASE(_data);
ARC_RELEASE(_arguments); ARC_RELEASE(_arguments);
ARC_RELEASE(_files); ARC_RELEASE(_files);
ARC_RELEASE(_boundary);
ARC_RELEASE(_controlName);
ARC_RELEASE(_fileName);
ARC_RELEASE(_contentType);
if (_tmpFile > 0) {
close(_tmpFile);
unlink([_tmpPath fileSystemRepresentation]);
}
ARC_RELEASE(_tmpPath);
ARC_RELEASE(_subParser);
ARC_DEALLOC(super); ARC_DEALLOC(super);
} }
- (BOOL)open:(NSError**)error {
_parserData = [[NSMutableData alloc] initWithCapacity:kMultiPartBufferSize];
_parserState = kParserState_Start;
return YES;
}
// http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2 // http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2
- (BOOL)_parseData { - (BOOL)_parseData {
BOOL success = YES; BOOL success = YES;
if (_parserState == kParserState_Headers) { if (_state == kParserState_Headers) {
NSRange range = [_parserData rangeOfData:_newlinesData options:0 range:NSMakeRange(0, _parserData.length)]; NSRange range = [_data rangeOfData:_newlinesData options:0 range:NSMakeRange(0, _data.length)];
if (range.location != NSNotFound) { if (range.location != NSNotFound) {
ARC_RELEASE(_controlName); ARC_RELEASE(_controlName);
@@ -228,7 +237,9 @@ static NSData* _dashNewlineData = nil;
_contentType = nil; _contentType = nil;
ARC_RELEASE(_tmpPath); ARC_RELEASE(_tmpPath);
_tmpPath = nil; _tmpPath = nil;
NSString* headers = [[NSString alloc] initWithData:[_parserData subdataWithRange:NSMakeRange(0, range.location)] encoding:NSUTF8StringEncoding]; ARC_RELEASE(_subParser);
_subParser = nil;
NSString* headers = [[NSString alloc] initWithData:[_data subdataWithRange:NSMakeRange(0, range.location)] encoding:NSUTF8StringEncoding];
if (headers) { if (headers) {
for (NSString* header in [headers componentsSeparatedByString:@"\r\n"]) { for (NSString* header in [headers componentsSeparatedByString:@"\r\n"]) {
NSRange subRange = [header rangeOfString:@":"]; NSRange subRange = [header rangeOfString:@":"];
@@ -242,6 +253,9 @@ static NSData* _dashNewlineData = nil;
if ([GCDWebServerTruncateHeaderValue(contentDisposition) isEqualToString:@"form-data"]) { if ([GCDWebServerTruncateHeaderValue(contentDisposition) isEqualToString:@"form-data"]) {
_controlName = ARC_RETAIN(GCDWebServerExtractHeaderValueParameter(contentDisposition, @"name")); _controlName = ARC_RETAIN(GCDWebServerExtractHeaderValueParameter(contentDisposition, @"name"));
_fileName = ARC_RETAIN(GCDWebServerExtractHeaderValueParameter(contentDisposition, @"filename")); _fileName = ARC_RETAIN(GCDWebServerExtractHeaderValueParameter(contentDisposition, @"filename"));
} else if ([GCDWebServerTruncateHeaderValue(contentDisposition) isEqualToString:@"file"]) {
_controlName = ARC_RETAIN(_defaultcontrolName);
_fileName = ARC_RETAIN(GCDWebServerExtractHeaderValueParameter(contentDisposition, @"filename"));
} }
} }
} else { } else {
@@ -257,7 +271,14 @@ static NSData* _dashNewlineData = nil;
DNOT_REACHED(); DNOT_REACHED();
} }
if (_controlName) { if (_controlName) {
if (_fileName) { if ([GCDWebServerTruncateHeaderValue(_contentType) isEqualToString:@"multipart/mixed"]) {
NSString* boundary = GCDWebServerExtractHeaderValueParameter(_contentType, @"boundary");
_subParser = [[GCDWebServerMIMEStreamParser alloc] initWithBoundary:boundary defaultControlName:_controlName arguments:_arguments files:_files];
if (_subParser == nil) {
DNOT_REACHED();
success = NO;
}
} else if (_fileName) {
NSString* path = [NSTemporaryDirectory() stringByAppendingPathComponent:[[NSProcessInfo processInfo] globallyUniqueString]]; NSString* path = [NSTemporaryDirectory() stringByAppendingPathComponent:[[NSProcessInfo processInfo] globallyUniqueString]];
_tmpFile = open([path fileSystemRepresentation], O_CREAT | O_TRUNC | O_WRONLY, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); _tmpFile = open([path fileSystemRepresentation], O_CREAT | O_TRUNC | O_WRONLY, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
if (_tmpFile > 0) { if (_tmpFile > 0) {
@@ -272,29 +293,36 @@ static NSData* _dashNewlineData = nil;
success = NO; success = NO;
} }
[_parserData replaceBytesInRange:NSMakeRange(0, range.location + range.length) withBytes:NULL length:0]; [_data replaceBytesInRange:NSMakeRange(0, range.location + range.length) withBytes:NULL length:0];
_parserState = kParserState_Content; _state = kParserState_Content;
} }
} }
if ((_parserState == kParserState_Start) || (_parserState == kParserState_Content)) { if ((_state == kParserState_Start) || (_state == kParserState_Content)) {
NSRange range = [_parserData rangeOfData:_boundary options:0 range:NSMakeRange(0, _parserData.length)]; NSRange range = [_data rangeOfData:_boundary options:0 range:NSMakeRange(0, _data.length)];
if (range.location != NSNotFound) { if (range.location != NSNotFound) {
NSRange subRange = NSMakeRange(range.location + range.length, _parserData.length - range.location - range.length); NSRange subRange = NSMakeRange(range.location + range.length, _data.length - range.location - range.length);
NSRange subRange1 = [_parserData rangeOfData:_newlineData options:NSDataSearchAnchored range:subRange]; NSRange subRange1 = [_data rangeOfData:_newlineData options:NSDataSearchAnchored range:subRange];
NSRange subRange2 = [_parserData rangeOfData:_dashNewlineData options:NSDataSearchAnchored range:subRange]; NSRange subRange2 = [_data rangeOfData:_dashNewlineData options:NSDataSearchAnchored range:subRange];
if ((subRange1.location != NSNotFound) || (subRange2.location != NSNotFound)) { if ((subRange1.location != NSNotFound) || (subRange2.location != NSNotFound)) {
if (_parserState == kParserState_Content) { if (_state == kParserState_Content) {
const void* dataBytes = _parserData.bytes; const void* dataBytes = _data.bytes;
NSUInteger dataLength = range.location - 2; NSUInteger dataLength = range.location - 2;
if (_tmpPath) { if (_subParser) {
if (![_subParser appendBytes:dataBytes length:(dataLength + 2)] || ![_subParser isAtEnd]) {
DNOT_REACHED();
success = NO;
}
ARC_RELEASE(_subParser);
_subParser = nil;
} else if (_tmpPath) {
ssize_t result = write(_tmpFile, dataBytes, dataLength); ssize_t result = write(_tmpFile, dataBytes, dataLength);
if (result == (ssize_t)dataLength) { if (result == (ssize_t)dataLength) {
if (close(_tmpFile) == 0) { if (close(_tmpFile) == 0) {
_tmpFile = 0; _tmpFile = 0;
GCDWebServerMultiPartFile* file = [[GCDWebServerMultiPartFile alloc] initWithContentType:_contentType fileName:_fileName temporaryPath:_tmpPath]; GCDWebServerMultiPartFile* file = [[GCDWebServerMultiPartFile alloc] initWithControlName:_controlName contentType:_contentType fileName:_fileName temporaryPath:_tmpPath];
[_files setObject:file forKey:_controlName]; [_files addObject:file];
ARC_RELEASE(file); ARC_RELEASE(file);
} else { } else {
DNOT_REACHED(); DNOT_REACHED();
@@ -308,85 +336,150 @@ static NSData* _dashNewlineData = nil;
_tmpPath = nil; _tmpPath = nil;
} else { } else {
NSData* data = [[NSData alloc] initWithBytes:(void*)dataBytes length:dataLength]; NSData* data = [[NSData alloc] initWithBytes:(void*)dataBytes length:dataLength];
GCDWebServerMultiPartArgument* argument = [[GCDWebServerMultiPartArgument alloc] initWithContentType:_contentType data:data]; GCDWebServerMultiPartArgument* argument = [[GCDWebServerMultiPartArgument alloc] initWithControlName:_controlName contentType:_contentType data:data];
[_arguments setObject:argument forKey:_controlName]; [_arguments addObject:argument];
ARC_RELEASE(argument); ARC_RELEASE(argument);
ARC_RELEASE(data); ARC_RELEASE(data);
} }
} }
if (subRange1.location != NSNotFound) { if (subRange1.location != NSNotFound) {
[_parserData replaceBytesInRange:NSMakeRange(0, subRange1.location + subRange1.length) withBytes:NULL length:0]; [_data replaceBytesInRange:NSMakeRange(0, subRange1.location + subRange1.length) withBytes:NULL length:0];
_parserState = kParserState_Headers; _state = kParserState_Headers;
success = [self _parseData]; success = [self _parseData];
} else { } else {
_parserState = kParserState_End; _state = kParserState_End;
} }
} }
} else { } else {
NSUInteger margin = 2 * _boundary.length; NSUInteger margin = 2 * _boundary.length;
if (_tmpPath && (_parserData.length > margin)) { if (_data.length > margin) {
NSUInteger length = _parserData.length - margin; NSUInteger length = _data.length - margin;
ssize_t result = write(_tmpFile, _parserData.bytes, length); if (_subParser) {
if (result == (ssize_t)length) { if ([_subParser appendBytes:_data.bytes length:length]) {
[_parserData replaceBytesInRange:NSMakeRange(0, length) withBytes:NULL length:0]; [_data replaceBytesInRange:NSMakeRange(0, length) withBytes:NULL length:0];
} else { } else {
DNOT_REACHED(); DNOT_REACHED();
success = NO; success = NO;
}
} else if (_tmpPath) {
ssize_t result = write(_tmpFile, _data.bytes, length);
if (result == (ssize_t)length) {
[_data replaceBytesInRange:NSMakeRange(0, length) withBytes:NULL length:0];
} else {
DNOT_REACHED();
success = NO;
}
} }
} }
} }
} }
return success; return success;
} }
- (BOOL)appendBytes:(const void*)bytes length:(NSUInteger)length {
[_data appendBytes:bytes length:length];
return [self _parseData];
}
- (BOOL)isAtEnd {
return (_state == kParserState_End);
}
@end
@interface GCDWebServerMultiPartFormRequest () {
@private
GCDWebServerMIMEStreamParser* _parser;
NSMutableArray* _arguments;
NSMutableArray* _files;
}
@end
@implementation GCDWebServerMultiPartFormRequest
@synthesize arguments=_arguments, files=_files;
+ (NSString*)mimeType {
return @"multipart/form-data";
}
- (instancetype)initWithMethod:(NSString*)method url:(NSURL*)url headers:(NSDictionary*)headers path:(NSString*)path query:(NSDictionary*)query {
if ((self = [super initWithMethod:method url:url headers:headers path:path query:query])) {
_arguments = [[NSMutableArray alloc] init];
_files = [[NSMutableArray alloc] init];
}
return self;
}
- (void)dealloc {
ARC_RELEASE(_arguments);
ARC_RELEASE(_files);
ARC_DEALLOC(super);
}
- (BOOL)open:(NSError**)error {
NSString* boundary = GCDWebServerExtractHeaderValueParameter(self.contentType, @"boundary");
_parser = [[GCDWebServerMIMEStreamParser alloc] initWithBoundary:boundary defaultControlName:nil arguments:_arguments files:_files];
if (_parser == nil) {
*error = [NSError errorWithDomain:kGCDWebServerErrorDomain code:-1 userInfo:@{NSLocalizedDescriptionKey: @"Failed starting to parse multipart form data"}];
return NO;
}
return YES;
}
- (BOOL)writeData:(NSData*)data error:(NSError**)error { - (BOOL)writeData:(NSData*)data error:(NSError**)error {
[_parserData appendBytes:data.bytes length:data.length]; if (![_parser appendBytes:data.bytes length:data.length]) {
if (![self _parseData]) { *error = [NSError errorWithDomain:kGCDWebServerErrorDomain code:-1 userInfo:@{NSLocalizedDescriptionKey: @"Failed continuing to parse multipart form data"}];
*error = [NSError errorWithDomain:kGCDWebServerErrorDomain code:-1 userInfo:@{NSLocalizedDescriptionKey: @"Failed parsing multipart form data"}];
return NO; return NO;
} }
return YES; return YES;
} }
- (BOOL)close:(NSError**)error { - (BOOL)close:(NSError**)error {
ARC_RELEASE(_parserData); BOOL atEnd = [_parser isAtEnd];
_parserData = nil; ARC_RELEASE(_parser);
ARC_RELEASE(_controlName); _parser = nil;
_controlName = nil; if (!atEnd) {
ARC_RELEASE(_fileName); *error = [NSError errorWithDomain:kGCDWebServerErrorDomain code:-1 userInfo:@{NSLocalizedDescriptionKey: @"Failed finishing to parse multipart form data"}];
_fileName = nil;
ARC_RELEASE(_contentType);
_contentType = nil;
if (_tmpFile > 0) {
close(_tmpFile);
unlink([_tmpPath fileSystemRepresentation]);
_tmpFile = 0;
}
ARC_RELEASE(_tmpPath);
_tmpPath = nil;
if (_parserState != kParserState_End) {
*error = [NSError errorWithDomain:kGCDWebServerErrorDomain code:-1 userInfo:@{NSLocalizedDescriptionKey: @"Failed parsing multipart form data"}];
return NO; return NO;
} }
return YES; return YES;
} }
- (GCDWebServerMultiPartArgument*)firstArgumentForControlName:(NSString*)name {
for (GCDWebServerMultiPartArgument* argument in _arguments) {
if ([argument.controlName isEqualToString:name]) {
return argument;
}
}
return nil;
}
- (GCDWebServerMultiPartFile*)firstFileForControlName:(NSString*)name {
for (GCDWebServerMultiPartFile* file in _files) {
if ([file.controlName isEqualToString:name]) {
return file;
}
}
return nil;
}
- (NSString*)description { - (NSString*)description {
NSMutableString* description = [NSMutableString stringWithString:[super description]]; NSMutableString* description = [NSMutableString stringWithString:[super description]];
if (_arguments.count) { if (_arguments.count) {
[description appendString:@"\n"]; [description appendString:@"\n"];
for (NSString* key in [[_arguments allKeys] sortedArrayUsingSelector:@selector(compare:)]) { for (GCDWebServerMultiPartArgument* argument in _arguments) {
GCDWebServerMultiPartArgument* argument = [_arguments objectForKey:key]; [description appendFormat:@"\n%@ (%@)\n", argument.controlName, argument.contentType];
[description appendFormat:@"\n%@ (%@)\n", key, argument.contentType];
[description appendString:GCDWebServerDescribeData(argument.data, argument.contentType)]; [description appendString:GCDWebServerDescribeData(argument.data, argument.contentType)];
} }
} }
if (_files.count) { if (_files.count) {
[description appendString:@"\n"]; [description appendString:@"\n"];
for (NSString* key in [[_files allKeys] sortedArrayUsingSelector:@selector(compare:)]) { for (GCDWebServerMultiPartFile* file in _files) {
GCDWebServerMultiPartFile* file = [_files objectForKey:key]; [description appendFormat:@"\n%@ (%@): %@\n{%@}", file.controlName, file.contentType, file.fileName, file.temporaryPath];
[description appendFormat:@"\n%@ (%@): %@\n{%@}", key, file.contentType, file.fileName, file.temporaryPath];
} }
} }
return description; return description;

View File

@@ -35,7 +35,7 @@
@interface GCDWebServerURLEncodedFormRequest : GCDWebServerDataRequest @interface GCDWebServerURLEncodedFormRequest : GCDWebServerDataRequest
/** /**
* Returns the unescaped names and values for the URL encoded form. * Returns the unescaped control names and values for the URL encoded form.
* *
* The text encoding used to interpret the data is extracted from the * The text encoding used to interpret the data is extracted from the
* "Content-Type" header or defaults to UTF-8. * "Content-Type" header or defaults to UTF-8.

View File

@@ -78,7 +78,7 @@
/** /**
* Initializes a data response from text encoded using UTF-8. * Initializes a data response from text encoded using UTF-8.
*/ */
- (instancetype)initWithText:(NSString*)text; // Encodes using UTF-8 - (instancetype)initWithText:(NSString*)text;
/** /**
* Initializes a data response from HTML encoded using UTF-8. * Initializes a data response from HTML encoded using UTF-8.
@@ -87,6 +87,7 @@
/** /**
* Initializes a data response from an HTML template encoded using UTF-8. * Initializes a data response from an HTML template encoded using UTF-8.
*
* All occurences of "%variable%" within the HTML template are replaced with * All occurences of "%variable%" within the HTML template are replaced with
* their corresponding values. * their corresponding values.
*/ */

View File

@@ -46,13 +46,13 @@
/** /**
* Creates a client error response with the corresponding HTTP status code * Creates a client error response with the corresponding HTTP status code
* and an optional underlying NSError. * and an underlying NSError.
*/ */
+ (instancetype)responseWithClientError:(GCDWebServerClientErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... NS_FORMAT_FUNCTION(3,4); + (instancetype)responseWithClientError:(GCDWebServerClientErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... NS_FORMAT_FUNCTION(3,4);
/** /**
* Creates a server error response with the corresponding HTTP status code * Creates a server error response with the corresponding HTTP status code
* and an optional underlying NSError. * and an underlying NSError.
*/ */
+ (instancetype)responseWithServerError:(GCDWebServerServerErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... NS_FORMAT_FUNCTION(3,4); + (instancetype)responseWithServerError:(GCDWebServerServerErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... NS_FORMAT_FUNCTION(3,4);
@@ -68,13 +68,13 @@
/** /**
* Initializes a client error response with the corresponding HTTP status code * Initializes a client error response with the corresponding HTTP status code
* and an optional underlying NSError. * and an underlying NSError.
*/ */
- (instancetype)initWithClientError:(GCDWebServerClientErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... NS_FORMAT_FUNCTION(3,4); - (instancetype)initWithClientError:(GCDWebServerClientErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... NS_FORMAT_FUNCTION(3,4);
/** /**
* Initializes a server error response with the corresponding HTTP status code * Initializes a server error response with the corresponding HTTP status code
* and an optional underlying NSError. * and an underlying NSError.
*/ */
- (instancetype)initWithServerError:(GCDWebServerServerErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... NS_FORMAT_FUNCTION(3,4); - (instancetype)initWithServerError:(GCDWebServerServerErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... NS_FORMAT_FUNCTION(3,4);

View File

@@ -30,18 +30,21 @@
/** /**
* The GCDWebServerFileResponse subclass of GCDWebServerResponse reads the body * The GCDWebServerFileResponse subclass of GCDWebServerResponse reads the body
* of the HTTP response from a file on disk. * of the HTTP response from a file on disk.
*
* It will automatically set the contentType, lastModifiedDate and eTag
* properties of the GCDWebServerResponse according to the file extension and
* metadata.
*/ */
@interface GCDWebServerFileResponse : GCDWebServerResponse @interface GCDWebServerFileResponse : GCDWebServerResponse
/** /**
* Creates a response with the contents of a file and the content type * Creates a response with the contents of a file.
* automatically set from the file extension.
*/ */
+ (instancetype)responseWithFile:(NSString*)path; + (instancetype)responseWithFile:(NSString*)path;
/** /**
* Creates a response like +responseWithFile: but sets the "Content-Disposition" * Creates a response like +responseWithFile: and sets the "Content-Disposition"
* HTTP header appropriately for a download if the "attachment" argument is YES. * HTTP header for a download if the "attachment" argument is YES.
*/ */
+ (instancetype)responseWithFile:(NSString*)path isAttachment:(BOOL)attachment; + (instancetype)responseWithFile:(NSString*)path isAttachment:(BOOL)attachment;
@@ -54,29 +57,29 @@
+ (instancetype)responseWithFile:(NSString*)path byteRange:(NSRange)range; + (instancetype)responseWithFile:(NSString*)path byteRange:(NSRange)range;
/** /**
* Creates a response like +responseWithFile:byteRange: but also sets the * Creates a response like +responseWithFile:byteRange: and sets the
* "Content-Disposition" HTTP header appropriately for a download if the * "Content-Disposition" HTTP header for a download if the "attachment"
* "attachment" argument is YES. * argument is YES.
*/ */
+ (instancetype)responseWithFile:(NSString*)path byteRange:(NSRange)range isAttachment:(BOOL)attachment; + (instancetype)responseWithFile:(NSString*)path byteRange:(NSRange)range isAttachment:(BOOL)attachment;
/** /**
* Initializes a response with the contents of a file and the content type * Initializes a response with the contents of a file.
* automatically set from the file extension.
*/ */
- (instancetype)initWithFile:(NSString*)path; - (instancetype)initWithFile:(NSString*)path;
/** /**
* Initializes a response like -initWithFile: but sets the "Content-Disposition" * Initializes a response like +responseWithFile: and sets the
* HTTP header appropriately for a download if the "attachment" argument is YES. * "Content-Disposition" HTTP header for a download if the "attachment"
* argument is YES.
*/ */
- (instancetype)initWithFile:(NSString*)path isAttachment:(BOOL)attachment; - (instancetype)initWithFile:(NSString*)path isAttachment:(BOOL)attachment;
/** /**
* Initializes a response like -initWithFile: but restricts the file contents * Initializes a response like -initWithFile: but restricts the file contents
* to a specific byte range. This range should be set to (NSNotFound, 0) for * to a specific byte range. This range should be set to (NSUIntegerMax, 0) for
* the full file, (offset, length) if expressed from the beginning of the file, * the full file, (offset, length) if expressed from the beginning of the file,
* or (NSNotFound, -length) if expressed from the end of the file. The "offset" * or (NSUIntegerMax, length) if expressed from the end of the file. The "offset"
* and "length" values will be automatically adjusted to be compatible with the * and "length" values will be automatically adjusted to be compatible with the
* actual size of the file. * actual size of the file.
* *

View File

@@ -40,10 +40,6 @@
} }
@end @end
static inline NSError* _MakePosixError(int code) {
return [NSError errorWithDomain:NSPOSIXErrorDomain code:code userInfo:@{NSLocalizedDescriptionKey: [NSString stringWithFormat:@"%s", strerror(code)]}];
}
@implementation GCDWebServerFileResponse @implementation GCDWebServerFileResponse
+ (instancetype)responseWithFile:(NSString*)path { + (instancetype)responseWithFile:(NSString*)path {
@@ -63,11 +59,11 @@ static inline NSError* _MakePosixError(int code) {
} }
- (instancetype)initWithFile:(NSString*)path { - (instancetype)initWithFile:(NSString*)path {
return [self initWithFile:path byteRange:NSMakeRange(NSNotFound, 0) isAttachment:NO]; return [self initWithFile:path byteRange:NSMakeRange(NSUIntegerMax, 0) isAttachment:NO];
} }
- (instancetype)initWithFile:(NSString*)path isAttachment:(BOOL)attachment { - (instancetype)initWithFile:(NSString*)path isAttachment:(BOOL)attachment {
return [self initWithFile:path byteRange:NSMakeRange(NSNotFound, 0) isAttachment:attachment]; return [self initWithFile:path byteRange:NSMakeRange(NSUIntegerMax, 0) isAttachment:attachment];
} }
- (instancetype)initWithFile:(NSString*)path byteRange:(NSRange)range { - (instancetype)initWithFile:(NSString*)path byteRange:(NSRange)range {
@@ -85,31 +81,41 @@ static inline NSDate* _NSDateFromTimeSpec(const struct timespec* t) {
ARC_RELEASE(self); ARC_RELEASE(self);
return nil; return nil;
} }
if (GCDWebServerIsValidByteRange(range)) { #ifndef __LP64__
if (range.location != NSNotFound) { if (info.st_size >= (off_t)4294967295) { // In 32 bit mode, we can't handle files greater than 4 GiBs (don't use "NSUIntegerMax" here to avoid potential unsigned to signed conversion issues)
range.location = MIN(range.location, (NSUInteger)info.st_size); DNOT_REACHED();
range.length = MIN(range.length, (NSUInteger)info.st_size - range.location); ARC_RELEASE(self);
return nil;
}
#endif
NSUInteger fileSize = (NSUInteger)info.st_size;
BOOL hasByteRange = GCDWebServerIsValidByteRange(range);
if (hasByteRange) {
if (range.location != NSUIntegerMax) {
range.location = MIN(range.location, fileSize);
range.length = MIN(range.length, fileSize - range.location);
} else { } else {
range.length = MIN(range.length, (NSUInteger)info.st_size); range.length = MIN(range.length, fileSize);
range.location = (NSUInteger)info.st_size - range.length; range.location = fileSize - range.length;
} }
if (range.length == 0) { if (range.length == 0) {
ARC_RELEASE(self); ARC_RELEASE(self);
return nil; // TODO: Return 416 status code and "Content-Range: bytes */{file length}" header return nil; // TODO: Return 416 status code and "Content-Range: bytes */{file length}" header
} }
} else {
range.location = 0;
range.length = fileSize;
} }
if ((self = [super init])) { if ((self = [super init])) {
_path = [path copy]; _path = [path copy];
if (range.location != NSNotFound) { _offset = range.location;
_offset = range.location; _size = range.length;
_size = range.length; if (hasByteRange) {
[self setStatusCode:kGCDWebServerHTTPStatusCode_PartialContent]; [self setStatusCode:kGCDWebServerHTTPStatusCode_PartialContent];
[self setValue:[NSString stringWithFormat:@"bytes %i-%i/%i", (int)range.location, (int)(range.location + range.length - 1), (int)info.st_size] forAdditionalHeader:@"Content-Range"]; [self setValue:[NSString stringWithFormat:@"bytes %lu-%lu/%lu", (unsigned long)_offset, (unsigned long)(_offset + _size - 1), (unsigned long)fileSize] forAdditionalHeader:@"Content-Range"];
LOG_DEBUG(@"Using content bytes range [%i-%i] for file \"%@\"", (int)range.location, (int)(range.location + range.length - 1), path); LOG_DEBUG(@"Using content bytes range [%lu-%lu] for file \"%@\"", (unsigned long)_offset, (unsigned long)(_offset + _size - 1), path);
} else {
_offset = 0;
_size = (NSUInteger)info.st_size;
} }
if (attachment) { if (attachment) {
@@ -125,8 +131,8 @@ static inline NSDate* _NSDateFromTimeSpec(const struct timespec* t) {
} }
} }
self.contentType = GCDWebServerGetMimeTypeForExtension([path pathExtension]); self.contentType = GCDWebServerGetMimeTypeForExtension([_path pathExtension]);
self.contentLength = (range.location != NSNotFound ? range.length : (NSUInteger)info.st_size); self.contentLength = _size;
self.lastModifiedDate = _NSDateFromTimeSpec(&info.st_mtimespec); self.lastModifiedDate = _NSDateFromTimeSpec(&info.st_mtimespec);
self.eTag = [NSString stringWithFormat:@"%llu/%li/%li", info.st_ino, info.st_mtimespec.tv_sec, info.st_mtimespec.tv_nsec]; self.eTag = [NSString stringWithFormat:@"%llu/%li/%li", info.st_ino, info.st_mtimespec.tv_sec, info.st_mtimespec.tv_nsec];
} }
@@ -142,11 +148,11 @@ static inline NSDate* _NSDateFromTimeSpec(const struct timespec* t) {
- (BOOL)open:(NSError**)error { - (BOOL)open:(NSError**)error {
_file = open([_path fileSystemRepresentation], O_NOFOLLOW | O_RDONLY); _file = open([_path fileSystemRepresentation], O_NOFOLLOW | O_RDONLY);
if (_file <= 0) { if (_file <= 0) {
*error = _MakePosixError(errno); *error = GCDWebServerMakePosixError(errno);
return NO; return NO;
} }
if (lseek(_file, _offset, SEEK_SET) != (off_t)_offset) { if (lseek(_file, _offset, SEEK_SET) != (off_t)_offset) {
*error = _MakePosixError(errno); *error = GCDWebServerMakePosixError(errno);
close(_file); close(_file);
return NO; return NO;
} }
@@ -158,7 +164,7 @@ static inline NSDate* _NSDateFromTimeSpec(const struct timespec* t) {
NSMutableData* data = [[NSMutableData alloc] initWithLength:length]; NSMutableData* data = [[NSMutableData alloc] initWithLength:length];
ssize_t result = read(_file, data.mutableBytes, length); ssize_t result = read(_file, data.mutableBytes, length);
if (result < 0) { if (result < 0) {
*error = _MakePosixError(errno); *error = GCDWebServerMakePosixError(errno);
return nil; return nil;
} }
if (result > 0) { if (result > 0) {

View File

@@ -30,7 +30,7 @@
@class GCDWebUploader; @class GCDWebUploader;
/** /**
* Delegate methods for GCDWebUploaderDelegate. * Delegate methods for GCDWebUploader.
* *
* @warning These methods are always called on the main thread in a serialized way. * @warning These methods are always called on the main thread in a serialized way.
*/ */
@@ -70,37 +70,39 @@
* or directories. * or directories.
* *
* See the README.md file for more information about the features of GCDWebUploader. * See the README.md file for more information about the features of GCDWebUploader.
*
* @warning For GCDWebUploader to work, "GCDWebUploader.bundle" must be added
* to the resources of the Xcode target.
*/ */
@interface GCDWebUploader : GCDWebServer @interface GCDWebUploader : GCDWebServer
/** /**
* Returns the upload directory as specified when the server was initialized. * Returns the upload directory as specified when the uploader was initialized.
*/ */
@property(nonatomic, readonly) NSString* uploadDirectory; @property(nonatomic, readonly) NSString* uploadDirectory;
/** /**
* Sets the delegate for the server. * Sets the delegate for the uploader.
*/ */
@property(nonatomic, assign) id<GCDWebUploaderDelegate> delegate; @property(nonatomic, assign) id<GCDWebUploaderDelegate> delegate;
/** /**
* Restricts which files should be listed and allowed to be uploaded, downloaded, * Sets which files are allowed to be operated on depending on their extension.
* moved or deleted depending on their extensions.
* *
* The default value is nil i.e. all file extensions are allowed. * The default value is nil i.e. all file extensions are allowed.
*/ */
@property(nonatomic, copy) NSArray* allowedFileExtensions; @property(nonatomic, copy) NSArray* allowedFileExtensions;
/** /**
* Sets if files and directories whose name start with a period should be * Sets if files and directories whose name start with a period are allowed to
* listed and allowed to be uploaded, downloaded, moved or deleted. * be operated on.
* *
* The default value is NO. * The default value is NO.
*/ */
@property(nonatomic) BOOL allowHiddenItems; @property(nonatomic) BOOL allowHiddenItems;
/** /**
* Sets the title for the uploader interface. * Sets the title for the uploader web interface.
* *
* The default value is the application name. * The default value is the application name.
* *
@@ -110,7 +112,7 @@
@property(nonatomic, copy) NSString* title; @property(nonatomic, copy) NSString* title;
/** /**
* Sets the header for the uploader interface. * Sets the header for the uploader web interface.
* *
* The default value is the same as the title property. * The default value is the same as the title property.
* *
@@ -120,7 +122,7 @@
@property(nonatomic, copy) NSString* header; @property(nonatomic, copy) NSString* header;
/** /**
* Sets the prologue for the uploader interface. * Sets the prologue for the uploader web interface.
* *
* The default value is a short help text. * The default value is a short help text.
* *
@@ -130,7 +132,7 @@
@property(nonatomic, copy) NSString* prologue; @property(nonatomic, copy) NSString* prologue;
/** /**
* Sets the epilogue for the uploader interface. * Sets the epilogue for the uploader web interface.
* *
* The default value is nil i.e. no epilogue. * The default value is nil i.e. no epilogue.
* *
@@ -140,7 +142,7 @@
@property(nonatomic, copy) NSString* epilogue; @property(nonatomic, copy) NSString* epilogue;
/** /**
* Sets the footer for the uploader interface. * Sets the footer for the uploader web interface.
* *
* The default value is the application name and version. * The default value is the application name and version.
* *
@@ -164,7 +166,7 @@
@interface GCDWebUploader (Subclassing) @interface GCDWebUploader (Subclassing)
/** /**
* This method is called to check if a file is allowed to be uploaded. * This method is called to check if a file upload is allowed to complete.
* The uploaded file is available for inspection at "tempPath". * The uploaded file is available for inspection at "tempPath".
* *
* The default implementation returns YES. * The default implementation returns YES.

View File

@@ -57,6 +57,11 @@
@implementation GCDWebUploader (Methods) @implementation GCDWebUploader (Methods)
// Must match implementation in GCDWebDAVServer
- (BOOL)_checkSandboxedPath:(NSString*)path {
return [[path stringByStandardizingPath] hasPrefix:_uploadDirectory];
}
- (BOOL)_checkFileExtension:(NSString*)fileName { - (BOOL)_checkFileExtension:(NSString*)fileName {
if (_allowedExtensions && ![_allowedExtensions containsObject:[[fileName pathExtension] lowercaseString]]) { if (_allowedExtensions && ![_allowedExtensions containsObject:[[fileName pathExtension] lowercaseString]]) {
return NO; return NO;
@@ -85,8 +90,8 @@
- (GCDWebServerResponse*)listDirectory:(GCDWebServerRequest*)request { - (GCDWebServerResponse*)listDirectory:(GCDWebServerRequest*)request {
NSString* relativePath = [[request query] objectForKey:@"path"]; NSString* relativePath = [[request query] objectForKey:@"path"];
NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath]; NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath];
BOOL isDirectory; BOOL isDirectory = NO;
if (![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) { if (![self _checkSandboxedPath:absolutePath] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath];
} }
if (!isDirectory) { if (!isDirectory) {
@@ -129,8 +134,8 @@
- (GCDWebServerResponse*)downloadFile:(GCDWebServerRequest*)request { - (GCDWebServerResponse*)downloadFile:(GCDWebServerRequest*)request {
NSString* relativePath = [[request query] objectForKey:@"path"]; NSString* relativePath = [[request query] objectForKey:@"path"];
NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath]; NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath];
BOOL isDirectory; BOOL isDirectory = NO;
if (![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) { if (![self _checkSandboxedPath:absolutePath] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath];
} }
if (isDirectory) { if (isDirectory) {
@@ -154,12 +159,15 @@
NSRange range = [[request.headers objectForKey:@"Accept"] rangeOfString:@"application/json" options:NSCaseInsensitiveSearch]; NSRange range = [[request.headers objectForKey:@"Accept"] rangeOfString:@"application/json" options:NSCaseInsensitiveSearch];
NSString* contentType = (range.location != NSNotFound ? @"application/json" : @"text/plain; charset=utf-8"); // Required when using iFrame transport (see https://github.com/blueimp/jQuery-File-Upload/wiki/Setup) NSString* contentType = (range.location != NSNotFound ? @"application/json" : @"text/plain; charset=utf-8"); // Required when using iFrame transport (see https://github.com/blueimp/jQuery-File-Upload/wiki/Setup)
GCDWebServerMultiPartFile* file = [request.files objectForKey:@"files[]"]; GCDWebServerMultiPartFile* file = [request firstFileForControlName:@"files[]"];
if ((!_allowHidden && [file.fileName hasPrefix:@"."]) || ![self _checkFileExtension:file.fileName]) { if ((!_allowHidden && [file.fileName hasPrefix:@"."]) || ![self _checkFileExtension:file.fileName]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_Forbidden message:@"Uploaded file name \"%@\" is not allowed", file.fileName]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_Forbidden message:@"Uploaded file name \"%@\" is not allowed", file.fileName];
} }
NSString* relativePath = [(GCDWebServerMultiPartArgument*)[request.arguments objectForKey:@"path"] string]; NSString* relativePath = [[request firstArgumentForControlName:@"path"] string];
NSString* absolutePath = [self _uniquePathForPath:[[_uploadDirectory stringByAppendingPathComponent:relativePath] stringByAppendingPathComponent:file.fileName]]; NSString* absolutePath = [self _uniquePathForPath:[[_uploadDirectory stringByAppendingPathComponent:relativePath] stringByAppendingPathComponent:file.fileName]];
if (![self _checkSandboxedPath:absolutePath]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath];
}
if (![self shouldUploadFileAtPath:absolutePath withTemporaryFile:file.temporaryPath]) { if (![self shouldUploadFileAtPath:absolutePath withTemporaryFile:file.temporaryPath]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_Forbidden message:@"Uploading file \"%@\" to \"%@\" is not permitted", file.fileName, relativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_Forbidden message:@"Uploading file \"%@\" to \"%@\" is not permitted", file.fileName, relativePath];
@@ -181,13 +189,16 @@
- (GCDWebServerResponse*)moveItem:(GCDWebServerURLEncodedFormRequest*)request { - (GCDWebServerResponse*)moveItem:(GCDWebServerURLEncodedFormRequest*)request {
NSString* oldRelativePath = [request.arguments objectForKey:@"oldPath"]; NSString* oldRelativePath = [request.arguments objectForKey:@"oldPath"];
NSString* oldAbsolutePath = [_uploadDirectory stringByAppendingPathComponent:oldRelativePath]; NSString* oldAbsolutePath = [_uploadDirectory stringByAppendingPathComponent:oldRelativePath];
BOOL isDirectory; BOOL isDirectory = NO;
if (![[NSFileManager defaultManager] fileExistsAtPath:oldAbsolutePath isDirectory:&isDirectory]) { if (![self _checkSandboxedPath:oldAbsolutePath] || ![[NSFileManager defaultManager] fileExistsAtPath:oldAbsolutePath isDirectory:&isDirectory]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", oldRelativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", oldRelativePath];
} }
NSString* newRelativePath = [request.arguments objectForKey:@"newPath"]; NSString* newRelativePath = [request.arguments objectForKey:@"newPath"];
NSString* newAbsolutePath = [self _uniquePathForPath:[_uploadDirectory stringByAppendingPathComponent:newRelativePath]]; NSString* newAbsolutePath = [self _uniquePathForPath:[_uploadDirectory stringByAppendingPathComponent:newRelativePath]];
if (![self _checkSandboxedPath:newAbsolutePath]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", newRelativePath];
}
NSString* itemName = [newAbsolutePath lastPathComponent]; NSString* itemName = [newAbsolutePath lastPathComponent];
if ((!_allowHidden && [itemName hasPrefix:@"."]) || (!isDirectory && ![self _checkFileExtension:itemName])) { if ((!_allowHidden && [itemName hasPrefix:@"."]) || (!isDirectory && ![self _checkFileExtension:itemName])) {
@@ -215,7 +226,7 @@
NSString* relativePath = [request.arguments objectForKey:@"path"]; NSString* relativePath = [request.arguments objectForKey:@"path"];
NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath]; NSString* absolutePath = [_uploadDirectory stringByAppendingPathComponent:relativePath];
BOOL isDirectory = NO; BOOL isDirectory = NO;
if (![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) { if (![self _checkSandboxedPath:absolutePath] || ![[NSFileManager defaultManager] fileExistsAtPath:absolutePath isDirectory:&isDirectory]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath]; return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath];
} }
@@ -244,6 +255,9 @@
- (GCDWebServerResponse*)createDirectory:(GCDWebServerURLEncodedFormRequest*)request { - (GCDWebServerResponse*)createDirectory:(GCDWebServerURLEncodedFormRequest*)request {
NSString* relativePath = [request.arguments objectForKey:@"path"]; NSString* relativePath = [request.arguments objectForKey:@"path"];
NSString* absolutePath = [self _uniquePathForPath:[_uploadDirectory stringByAppendingPathComponent:relativePath]]; NSString* absolutePath = [self _uniquePathForPath:[_uploadDirectory stringByAppendingPathComponent:relativePath]];
if (![self _checkSandboxedPath:absolutePath]) {
return [GCDWebServerErrorResponse responseWithClientError:kGCDWebServerHTTPStatusCode_NotFound message:@"\"%@\" does not exist", relativePath];
}
NSString* directoryName = [absolutePath lastPathComponent]; NSString* directoryName = [absolutePath lastPathComponent];
if (!_allowHidden && [directoryName hasPrefix:@"."]) { if (!_allowHidden && [directoryName hasPrefix:@"."]) {

View File

@@ -31,6 +31,7 @@
#import "GCDWebServerDataRequest.h" #import "GCDWebServerDataRequest.h"
#import "GCDWebServerURLEncodedFormRequest.h" #import "GCDWebServerURLEncodedFormRequest.h"
#import "GCDWebServerMultiPartFormRequest.h"
#import "GCDWebServerDataResponse.h" #import "GCDWebServerDataResponse.h"
#import "GCDWebServerStreamedResponse.h" #import "GCDWebServerStreamedResponse.h"
@@ -47,9 +48,10 @@ typedef enum {
kMode_WebServer = 0, kMode_WebServer = 0,
kMode_HTMLPage, kMode_HTMLPage,
kMode_HTMLForm, kMode_HTMLForm,
kMode_HTMLFileUpload,
kMode_WebDAV, kMode_WebDAV,
kMode_WebUploader, kMode_WebUploader,
kMode_StreamingResponse kMode_StreamingResponse,
} Mode; } Mode;
@interface Delegate : NSObject <GCDWebServerDelegate, GCDWebDAVServerDelegate, GCDWebUploaderDelegate> @interface Delegate : NSObject <GCDWebServerDelegate, GCDWebDAVServerDelegate, GCDWebUploaderDelegate>
@@ -140,7 +142,7 @@ int main(int argc, const char* argv[]) {
NSString* authenticationPassword = nil; NSString* authenticationPassword = nil;
if (argc == 1) { if (argc == 1) {
fprintf(stdout, "Usage: %s [-mode webServer | htmlPage | htmlForm | webDAV | webUploader | streamingResponse] [-record] [-root directory] [-tests directory] [-authenticationMethod Basic | Digest] [-authenticationRealm realm] [-authenticationUser user] [-authenticationPassword password]\n\n", basename((char*)argv[0])); fprintf(stdout, "Usage: %s [-mode webServer | htmlPage | htmlForm | htmlFileUpload | webDAV | webUploader | streamingResponse] [-record] [-root directory] [-tests directory] [-authenticationMethod Basic | Digest] [-authenticationRealm realm] [-authenticationUser user] [-authenticationPassword password]\n\n", basename((char*)argv[0]));
} else { } else {
for (int i = 1; i < argc; ++i) { for (int i = 1; i < argc; ++i) {
if (argv[i][0] != '-') { if (argv[i][0] != '-') {
@@ -154,6 +156,8 @@ int main(int argc, const char* argv[]) {
mode = kMode_HTMLPage; mode = kMode_HTMLPage;
} else if (!strcmp(argv[i], "htmlForm")) { } else if (!strcmp(argv[i], "htmlForm")) {
mode = kMode_HTMLForm; mode = kMode_HTMLForm;
} else if (!strcmp(argv[i], "htmlFileUpload")) {
mode = kMode_HTMLFileUpload;
} else if (!strcmp(argv[i], "webDAV")) { } else if (!strcmp(argv[i], "webDAV")) {
mode = kMode_WebDAV; mode = kMode_WebDAV;
} else if (!strcmp(argv[i], "webUploader")) { } else if (!strcmp(argv[i], "webUploader")) {
@@ -243,6 +247,48 @@ int main(int argc, const char* argv[]) {
break; break;
} }
// Implements HTML file upload
case kMode_HTMLFileUpload: {
fprintf(stdout, "Running in HTML File Upload mode");
webServer = [[GCDWebServer alloc] init];
NSString* formHTML = @" \
<form name=\"input\" action=\"/\" method=\"post\" enctype=\"multipart/form-data\"> \
<input type=\"hidden\" name=\"secret\" value=\"42\"> \
<input type=\"file\" name=\"files\" multiple><br/> \
<input type=\"submit\" value=\"Submit\"> \
</form> \
";
[webServer addHandlerForMethod:@"GET"
path:@"/"
requestClass:[GCDWebServerRequest class]
processBlock:^GCDWebServerResponse *(GCDWebServerRequest* request) {
NSString* html = [NSString stringWithFormat:@"<html><body>%@</body></html>", formHTML];
return [GCDWebServerDataResponse responseWithHTML:html];
}];
[webServer addHandlerForMethod:@"POST"
path:@"/"
requestClass:[GCDWebServerMultiPartFormRequest class]
processBlock:^GCDWebServerResponse *(GCDWebServerRequest* request) {
NSMutableString* string = [NSMutableString string];
for (GCDWebServerMultiPartArgument* argument in [(GCDWebServerMultiPartFormRequest*)request arguments]) {
[string appendFormat:@"%@ = %@<br>", argument.controlName, argument.string];
}
for (GCDWebServerMultiPartFile* file in [(GCDWebServerMultiPartFormRequest*)request files]) {
NSDictionary* attributes = [[NSFileManager defaultManager] attributesOfItemAtPath:file.temporaryPath error:NULL];
[string appendFormat:@"%@ = &quot;%@&quot; (%@ | %llu %@)<br>", file.controlName, file.fileName, file.mimeType,
attributes.fileSize >= 1000 ? attributes.fileSize / 1000 : attributes.fileSize,
attributes.fileSize >= 1000 ? @"KB" : @"Bytes"];
};
NSString* html = [NSString stringWithFormat:@"<html><body><p>%@</p><hr>%@</body></html>", string, formHTML];
return [GCDWebServerDataResponse responseWithHTML:html];
}];
break;
}
// Serve home directory through WebDAV // Serve home directory through WebDAV
case kMode_WebDAV: { case kMode_WebDAV: {
fprintf(stdout, "Running in WebDAV mode from \"%s\"", [rootDirectory UTF8String]); fprintf(stdout, "Running in WebDAV mode from \"%s\"", [rootDirectory UTF8String]);
@@ -291,11 +337,14 @@ int main(int argc, const char* argv[]) {
if (webServer) { if (webServer) {
Delegate* delegate = [[Delegate alloc] init]; Delegate* delegate = [[Delegate alloc] init];
webServer.delegate = delegate;
if (testDirectory) { if (testDirectory) {
#ifndef NDEBUG
webServer.delegate = delegate;
#endif
fprintf(stdout, "<RUNNING TESTS FROM \"%s\">\n\n", [testDirectory UTF8String]); fprintf(stdout, "<RUNNING TESTS FROM \"%s\">\n\n", [testDirectory UTF8String]);
result = (int)[webServer runTestsWithOptions:@{GCDWebServerOption_Port: @8080} inDirectory:testDirectory]; result = (int)[webServer runTestsWithOptions:@{GCDWebServerOption_Port: @8080} inDirectory:testDirectory];
} else { } else {
webServer.delegate = delegate;
if (recording) { if (recording) {
fprintf(stdout, "<RECORDING ENABLED>\n"); fprintf(stdout, "<RECORDING ENABLED>\n");
webServer.recordingEnabled = YES; webServer.recordingEnabled = YES;
@@ -313,13 +362,14 @@ int main(int argc, const char* argv[]) {
[options setObject:GCDWebServerAuthenticationMethod_DigestAccess forKey:GCDWebServerOption_AuthenticationMethod]; [options setObject:GCDWebServerAuthenticationMethod_DigestAccess forKey:GCDWebServerOption_AuthenticationMethod];
} }
} }
if ([webServer runWithOptions:options]) { if ([webServer runWithOptions:options error:NULL]) {
result = 0; result = 0;
} }
} }
webServer.delegate = nil;
#if !__has_feature(objc_arc) #if !__has_feature(objc_arc)
[webServer release];
[delegate release]; [delegate release];
[webServer release];
#endif #endif
} }
} }

View File

@@ -2,6 +2,8 @@ Overview
======== ========
[![Build Status](https://travis-ci.org/swisspol/GCDWebServer.svg?branch=master)](https://travis-ci.org/swisspol/GCDWebServer) [![Build Status](https://travis-ci.org/swisspol/GCDWebServer.svg?branch=master)](https://travis-ci.org/swisspol/GCDWebServer)
[![Version](http://cocoapod-badges.herokuapp.com/v/GCDWebServer/badge.png)](http://cocoadocs.org/docsets/GCDWebServer)
[![Platform](http://cocoapod-badges.herokuapp.com/p/GCDWebServer/badge.png)](http://cocoadocs.org/docsets/GCDWebServer)
GCDWebServer is a modern and lightweight GCD based HTTP 1.1 server designed to be embedded in OS X & iOS apps. It was written from scratch with the following goals in mind: GCDWebServer is a modern and lightweight GCD based HTTP 1.1 server designed to be embedded in OS X & iOS 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) * Elegant and easy to use architecture with only 4 core classes: server, connection, request and response (see "Understanding GCDWebServer's Architecture" below)
@@ -75,8 +77,10 @@ int main(int argc, const char* argv[]) {
}]; }];
// Use convenience method that runs server on port 8080 until SIGINT received (i.e. Ctrl-C in Terminal) // Use convenience method that runs server on port 8080
// until SIGINT (Ctrl-C in Terminal) or SIGTERM is received
[webServer runWithPort:8080 bonjourName:nil]; [webServer runWithPort:8080 bonjourName:nil];
NSLog(@"Visit %@ in your web browser", webServer.serverURL);
} }
return 0; return 0;
@@ -88,7 +92,12 @@ int main(int argc, const char* argv[]) {
#import "GCDWebServer.h" #import "GCDWebServer.h"
#import "GCDWebServerDataResponse.h" #import "GCDWebServerDataResponse.h"
static GCDWebServer* _webServer = nil; // This should really be an ivar of your application's delegate class @interface AppDelegate : NSObject <UIApplicationDelegate> {
GCDWebServer* _webServer;
}
@end
@implementation AppDelegate
- (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions { - (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {
@@ -106,9 +115,35 @@ static GCDWebServer* _webServer = nil; // This should really be an ivar of your
// Start server on port 8080 // Start server on port 8080
[_webServer startWithPort:8080 bonjourName:nil]; [_webServer startWithPort:8080 bonjourName:nil];
NSLog(@"Visit %@ in your web browser", _webServer.serverURL);
return YES; return YES;
} }
@end
```
**OS X Swift version (command line tool):**
***webServer.swift***
```swift
import Foundation
let webServer = GCDWebServer()
webServer.addDefaultHandlerForMethod("GET", requestClass: GCDWebServerRequest.self) { request in
return GCDWebServerDataResponse(HTML:"<html><body><p>Hello World</p></body></html>")
}
webServer.runWithPort(8080, bonjourName: nil)
println("Visit \(webServer.serverURL) in your web browser")
```
***WebServer-Bridging-Header.h***
```objectivec
#import "GCDWebServer.h"
#import "GCDWebServerDataResponse.h"
``` ```
Web Based Uploads in iOS Apps Web Based Uploads in iOS Apps
@@ -121,7 +156,12 @@ Simply instantiate and run a ```GCDWebUploader``` instance then visit ```http://
```objectivec ```objectivec
#import "GCDWebUploader.h" #import "GCDWebUploader.h"
static GCDWebUploader* _webUploader = nil; // This should really be an ivar of your application's delegate class @interface AppDelegate : NSObject <UIApplicationDelegate> {
GCDWebUploader* _webUploader;
}
@end
@implementation AppDelegate
- (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions { - (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {
NSString* documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject]; NSString* documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
@@ -130,6 +170,8 @@ static GCDWebUploader* _webUploader = nil; // This should really be an ivar of
NSLog(@"Visit %@ in your web browser", _webUploader.serverURL); NSLog(@"Visit %@ in your web browser", _webUploader.serverURL);
return YES; return YES;
} }
@end
``` ```
WebDAV Server in iOS Apps WebDAV Server in iOS Apps
@@ -144,7 +186,12 @@ Simply instantiate and run a ```GCDWebDAVServer``` instance then connect to ```h
```objectivec ```objectivec
#import "GCDWebDAVServer.h" #import "GCDWebDAVServer.h"
static GCDWebDAVServer* _davServer = nil; // This should really be an ivar of your application's delegate class @interface AppDelegate : NSObject <UIApplicationDelegate> {
GCDWebDAVServer* _davServer;
}
@end
@implementation AppDelegate
- (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions { - (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {
NSString* documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject]; NSString* documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
@@ -153,6 +200,8 @@ static GCDWebDAVServer* _davServer = nil; // This should really be an ivar of y
NSLog(@"Visit %@ in your WebDAV client", _davServer.serverURL); NSLog(@"Visit %@ in your WebDAV client", _davServer.serverURL);
return YES; return YES;
} }
@end
``` ```
Serving a Static Website Serving a Static Website
@@ -169,7 +218,6 @@ int main(int argc, const char* argv[]) {
GCDWebServer* webServer = [[GCDWebServer alloc] init]; GCDWebServer* webServer = [[GCDWebServer alloc] init];
[webServer addGETHandlerForBasePath:@"/" directoryPath:NSHomeDirectory() indexFilename:nil cacheAge:3600 allowRangeRequests:YES]; [webServer addGETHandlerForBasePath:@"/" directoryPath:NSHomeDirectory() indexFilename:nil cacheAge:3600 allowRangeRequests:YES];
[webServer runWithPort:8080]; [webServer runWithPort:8080];
[webServer release]; // Remove if using ARC
} }
return 0; return 0;
@@ -219,6 +267,25 @@ Fortunately, GCDWebServer does all of this automatically for you:
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. 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.
Debug Builds & Custom Logging
=============================
When building GCDWebServer in "Debug" mode versus "Release" mode, GCDWebServer logs a lot more information and also performs a number of internal consistency checks. To disable this behavior, make sure to define the preprocessor constant ```NDEBUG``` when compiling GCDWebServer. In Xcode target settings, this can be done by adding ```NDEBUG``` to the build setting ```GCC_PREPROCESSOR_DEFINITIONS``` when building in Release configuration (this is done automatically for you if you use CocoaPods).
It's also possible to replace the logging system used by GCDWebServer by a custom one. Simply define the preprocessor constant ```__GCDWEBSERVER_LOGGING_HEADER__``` to the name of a header file (e.g. "MyLogging.h") that defines these macros:
```
#define LOG_DEBUG(...) // Should not do anything if NDEBUG is defined
#define LOG_VERBOSE(...)
#define LOG_INFO(...)
#define LOG_WARNING(...)
#define LOG_ERROR(...)
#define LOG_EXCEPTION(__EXCEPTION__)
#define DCHECK(__CONDITION__) // Should not do anything if NDEBUG is defined or abort if __CONDITION__ is false
#define DNOT_REACHED() // Should not do anything if NDEBUG is defined
```
Advanced Example 1: Implementing HTTP Redirects Advanced Example 1: Implementing HTTP Redirects
=============================================== ===============================================

View File

@@ -23,6 +23,12 @@ function runTests {
rm -rf "$PAYLOAD_DIR" rm -rf "$PAYLOAD_DIR"
ditto -x -k "$PAYLOAD_ZIP" "$PAYLOAD_DIR" ditto -x -k "$PAYLOAD_ZIP" "$PAYLOAD_DIR"
TZ=GMT find "$PAYLOAD_DIR" -type d -exec SetFile -d "1/1/2014 00:00:00" -m "1/1/2014 00:00:00" '{}' \; # ZIP archives do not preserve directories dates TZ=GMT find "$PAYLOAD_DIR" -type d -exec SetFile -d "1/1/2014 00:00:00" -m "1/1/2014 00:00:00" '{}' \; # ZIP archives do not preserve directories dates
if [ "$4" != "" ]; then
cp -f "$4" "$PAYLOAD_DIR/Payload"
pushd "$PAYLOAD_DIR/Payload"
SetFile -d "1/1/2014 00:00:00" -m "1/1/2014 00:00:00" `basename "$4"`
popd
fi
logLevel=2 $1 -mode "$2" -root "$PAYLOAD_DIR/Payload" -tests "$3" logLevel=2 $1 -mode "$2" -root "$PAYLOAD_DIR/Payload" -tests "$3"
} }
@@ -43,6 +49,10 @@ rm -rf "$ARC_BUILD_DIR"
xcodebuild -sdk "$OSX_SDK" -target "$OSX_TARGET" -configuration "$CONFIGURATION" build "SYMROOT=$ARC_BUILD_DIR" "CLANG_ENABLE_OBJC_ARC=YES" > /dev/null xcodebuild -sdk "$OSX_SDK" -target "$OSX_TARGET" -configuration "$CONFIGURATION" build "SYMROOT=$ARC_BUILD_DIR" "CLANG_ENABLE_OBJC_ARC=YES" > /dev/null
# Run tests # Run tests
runTests $MRC_PRODUCT "htmlForm" "Tests/HTMLForm"
runTests $ARC_PRODUCT "htmlForm" "Tests/HTMLForm"
runTests $MRC_PRODUCT "htmlFileUpload" "Tests/HTMLFileUpload"
runTests $ARC_PRODUCT "htmlFileUpload" "Tests/HTMLFileUpload"
runTests $MRC_PRODUCT "webServer" "Tests/WebServer" runTests $MRC_PRODUCT "webServer" "Tests/WebServer"
runTests $ARC_PRODUCT "webServer" "Tests/WebServer" runTests $ARC_PRODUCT "webServer" "Tests/WebServer"
runTests $MRC_PRODUCT "webDAV" "Tests/WebDAV-Transmit" runTests $MRC_PRODUCT "webDAV" "Tests/WebDAV-Transmit"
@@ -53,6 +63,8 @@ runTests $MRC_PRODUCT "webDAV" "Tests/WebDAV-Finder"
runTests $ARC_PRODUCT "webDAV" "Tests/WebDAV-Finder" runTests $ARC_PRODUCT "webDAV" "Tests/WebDAV-Finder"
runTests $MRC_PRODUCT "webUploader" "Tests/WebUploader" runTests $MRC_PRODUCT "webUploader" "Tests/WebUploader"
runTests $ARC_PRODUCT "webUploader" "Tests/WebUploader" runTests $ARC_PRODUCT "webUploader" "Tests/WebUploader"
runTests $MRC_PRODUCT "webServer" "Tests/WebServer-Sample-Movie" "Tests/Sample-Movie.mp4"
runTests $ARC_PRODUCT "webServer" "Tests/WebServer-Sample-Movie" "Tests/Sample-Movie.mp4"
# Done # Done
echo "\nAll tests completed successfully!" echo "\nAll tests completed successfully!"

View File

@@ -0,0 +1,9 @@
HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 299
Content-Type: text/html; charset=utf-8
Connection: Close
Server: GCDWebServer
Date: Fri, 25 Apr 2014 14:15:11 GMT
<html><body> <form name="input" action="/" method="post" enctype="multipart/form-data"> <input type="hidden" name="secret" value="42"> <input type="file" name="files" multiple><br/> <input type="submit" value="Submit"> </form> </body></html>

View File

@@ -0,0 +1,10 @@
GET / HTTP/1.1
Host: localhost:8080
Connection: keep-alive
Cache-Control: max-age=0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36
DNT: 1
Accept-Encoding: gzip,deflate,sdch
Accept-Language: en-US,en;q=0.8,fr;q=0.6

View File

@@ -0,0 +1,9 @@
HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 447
Content-Type: text/html; charset=utf-8
Connection: Close
Server: GCDWebServer
Date: Fri, 25 Apr 2014 14:15:21 GMT
<html><body><p>secret = 42<br>files = &quot;hero_mba_11.jpg&quot; (image/jpeg | 106 KB)<br>files = &quot;Test File.txt&quot; (text/plain | 21 Bytes)<br></p><hr> <form name="input" action="/" method="post" enctype="multipart/form-data"> <input type="hidden" name="secret" value="42"> <input type="file" name="files" multiple><br/> <input type="submit" value="Submit"> </form> </body></html>

Binary file not shown.

View File

@@ -0,0 +1,9 @@
HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 293
Content-Type: text/html; charset=utf-8
Connection: Close
Server: GCDWebServer
Date: Fri, 25 Apr 2014 14:12:09 GMT
<html><body> <form name="input" action="/" method="post" enctype="application/x-www-form-urlencoded"> Value: <input type="text" name="value"> <input type="submit" value="Submit"> </form> </body></html>

View File

@@ -0,0 +1,10 @@
GET / HTTP/1.1
Host: localhost:8080
Connection: keep-alive
Cache-Control: max-age=0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36
DNT: 1
Accept-Encoding: gzip,deflate,sdch
Accept-Language: en-US,en;q=0.8,fr;q=0.6

View File

@@ -0,0 +1,9 @@
HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 47
Content-Type: text/html; charset=utf-8
Connection: Close
Server: GCDWebServer
Date: Fri, 25 Apr 2014 14:12:20 GMT
<html><body><p>Hellø Wörld!</p></body></html>

View File

@@ -0,0 +1,15 @@
POST / HTTP/1.1
Host: localhost:8080
Connection: keep-alive
Content-Length: 30
Cache-Control: max-age=0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
Origin: http://localhost:8080
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36
Content-Type: application/x-www-form-urlencoded
DNT: 1
Referer: http://localhost:8080/
Accept-Encoding: gzip,deflate,sdch
Accept-Language: en-US,en;q=0.8,fr;q=0.6
value=Hell%C3%B8+W%C3%B6rld%21

BIN
Tests/Sample-Movie.mp4 Normal file

Binary file not shown.

Binary file not shown.

View File

@@ -0,0 +1,12 @@
GET /Sample-Movie.mp4 HTTP/1.1
Host: localhost:8080
Connection: keep-alive
Cache-Control: no-cache
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
Pragma: no-cache
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36
DNT: 1
Referer: http://localhost:8080/
Accept-Encoding: gzip,deflate,sdch
Accept-Language: en-US,en;q=0.8,fr;q=0.6

Binary file not shown.

View File

@@ -0,0 +1,13 @@
GET /Sample-Movie.mp4 HTTP/1.1
Host: localhost:8080
Connection: keep-alive
Cache-Control: no-cache
Pragma: no-cache
Accept-Encoding: identity;q=1, *;q=0
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36
Accept: */*
DNT: 1
Referer: http://localhost:8080/Sample-Movie.mp4
Accept-Language: en-US,en;q=0.8,fr;q=0.6
Range: bytes=0-

Binary file not shown.

View File

@@ -0,0 +1,13 @@
GET /Sample-Movie.mp4 HTTP/1.1
Host: localhost:8080
Connection: keep-alive
Cache-Control: no-cache
Pragma: no-cache
Accept-Encoding: identity;q=1, *;q=0
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36
Accept: */*
DNT: 1
Referer: http://localhost:8080/Sample-Movie.mp4
Accept-Language: en-US,en;q=0.8,fr;q=0.6
Range: bytes=3391326-

Binary file not shown.

View File

@@ -0,0 +1,12 @@
GET /Sample-Movie.mp4 HTTP/1.1
Host: localhost:8080
Connection: keep-alive
Accept-Encoding: identity;q=1, *;q=0
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36
Accept: */*
DNT: 1
Referer: http://localhost:8080/Sample-Movie.mp4
Accept-Language: en-US,en;q=0.8,fr;q=0.6
Range: bytes=168-3391487
If-Range: 75279017/1388563200/0

Binary file not shown.

View File

@@ -0,0 +1,12 @@
GET /Sample-Movie.mp4 HTTP/1.1
Host: localhost:8080
Connection: keep-alive
Accept-Encoding: identity;q=1, *;q=0
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36
Accept: */*
DNT: 1
Referer: http://localhost:8080/Sample-Movie.mp4
Accept-Language: en-US,en;q=0.8,fr;q=0.6
Range: bytes=168-1023
If-Range: 75279017/1388563200/0