Repository: driftyco/cordova-plugin-wkwebview-engine Branch: master Commit: 0ba9a65318d3 Files: 64 Total size: 368.8 KB Directory structure: gitextract_ak8tiifl/ ├── .appveyor.yml ├── .eslintrc.yml ├── .gitignore ├── .jshintrc ├── .travis.yml ├── LICENSE ├── README.md ├── RELEASENOTES.md ├── package.json ├── plugin.xml ├── src/ │ ├── ios/ │ │ ├── CDVWKProcessPoolFactory.h │ │ ├── CDVWKProcessPoolFactory.m │ │ ├── CDVWKWebViewEngine.h │ │ ├── CDVWKWebViewEngine.m │ │ ├── CDVWKWebViewUIDelegate.h │ │ ├── CDVWKWebViewUIDelegate.m │ │ ├── GCDWebServer/ │ │ │ ├── Core/ │ │ │ │ ├── GCDWebServer.h │ │ │ │ ├── GCDWebServer.m │ │ │ │ ├── GCDWebServerConnection.h │ │ │ │ ├── GCDWebServerConnection.m │ │ │ │ ├── GCDWebServerFunctions.h │ │ │ │ ├── GCDWebServerFunctions.m │ │ │ │ ├── GCDWebServerHTTPStatusCodes.h │ │ │ │ ├── GCDWebServerPrivate.h │ │ │ │ ├── GCDWebServerRequest.h │ │ │ │ ├── GCDWebServerRequest.m │ │ │ │ ├── GCDWebServerResponse.h │ │ │ │ └── GCDWebServerResponse.m │ │ │ ├── Requests/ │ │ │ │ ├── GCDWebServerDataRequest.h │ │ │ │ ├── GCDWebServerDataRequest.m │ │ │ │ ├── GCDWebServerFileRequest.h │ │ │ │ ├── GCDWebServerFileRequest.m │ │ │ │ ├── GCDWebServerMultiPartFormRequest.h │ │ │ │ ├── GCDWebServerMultiPartFormRequest.m │ │ │ │ ├── GCDWebServerURLEncodedFormRequest.h │ │ │ │ └── GCDWebServerURLEncodedFormRequest.m │ │ │ └── Responses/ │ │ │ ├── GCDWebServerDataResponse.h │ │ │ ├── GCDWebServerDataResponse.m │ │ │ ├── GCDWebServerErrorResponse.h │ │ │ ├── GCDWebServerErrorResponse.m │ │ │ ├── GCDWebServerFileResponse.h │ │ │ ├── GCDWebServerFileResponse.m │ │ │ ├── GCDWebServerStreamedResponse.h │ │ │ └── GCDWebServerStreamedResponse.m │ │ ├── LICENSE │ │ └── wk-plugin.js │ └── www/ │ └── ios/ │ └── ios-wkwebview-exec.js └── tests/ ├── ios/ │ ├── CDVWKWebViewEngineTest/ │ │ ├── .gitignore │ │ ├── CDVWKWebViewEngineLibTests/ │ │ │ ├── CDVWKWebViewEngineTest.m │ │ │ └── Info.plist │ │ └── CDVWKWebViewEngineTest.xcodeproj/ │ │ ├── project.pbxproj │ │ ├── project.xcworkspace/ │ │ │ ├── contents.xcworkspacedata │ │ │ └── xcshareddata/ │ │ │ └── CDVWKWebViewEngineTest.xccheckout │ │ └── xcshareddata/ │ │ └── xcschemes/ │ │ ├── CDVWKWebViewEngineLib.xcscheme │ │ └── CDVWKWebViewEngineLibTests.xcscheme │ ├── CDVWKWebViewEngineTest.xcworkspace/ │ │ ├── contents.xcworkspacedata │ │ └── xcshareddata/ │ │ ├── CDVWKWebViewEngineTest.xccheckout │ │ └── xcschemes/ │ │ └── CordovaLib.xcscheme │ ├── README.md │ ├── package.json │ └── test.xcconfig ├── package.json ├── plugin.xml └── tests.js ================================================ FILE CONTENTS ================================================ ================================================ FILE: .appveyor.yml ================================================ # appveyor file # http://www.appveyor.com/docs/appveyor-yml max_jobs: 1 shallow_clone: true init: - git config --global core.autocrlf true image: - Visual Studio 2017 environment: nodejs_version: "4" matrix: - PLATFORM: windows-10-store install: - npm cache clean -f - node --version - npm install -g cordova-paramedic@https://github.com/apache/cordova-paramedic.git - npm install -g cordova build: off test_script: - cordova-paramedic --config pr\%PLATFORM% --plugin . --justBuild ================================================ FILE: .eslintrc.yml ================================================ root: true extends: semistandard rules: indent: - error - 4 camelcase: off padded-blocks: off operator-linebreak: off no-throw-literal: off ================================================ FILE: .gitignore ================================================ #If ignorance is bliss, then somebody knock the smile off my face *.csproj.user *.suo *.cache Thumbs.db *.DS_Store *.bak *.cache *.log *.swp *.user node_modules xcuserdata ================================================ FILE: .jshintrc ================================================ { "browser": true , "devel": true , "bitwise": true , "undef": true , "trailing": true , "quotmark": false , "indent": 4 , "unused": "vars" , "latedef": "nofunc" , "globals": { "module": false, "exports": false, "require": false } } ================================================ FILE: .travis.yml ================================================ osx_image: xcode8 language: objective-c sudo: false before_install: - rvm get head - npm cache clean -f - npm install -g n - n stable - node --version - xcodebuild -version install: - npm install script: - npm test ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: README.md ================================================ # DEPRECATED Repo moved to: [https://github.com/ionic-team/cordova-plugin-ionic-webview](https://github.com/ionic-team/cordova-plugin-ionic-webview) ================================================ FILE: RELEASENOTES.md ================================================ # Release Notes ### 1.1.3 (Apr 27, 2017) * [CB-12696](https://issues.apache.org/jira/browse/CB-12696) (iOS) Fixing some Xcode warnings * [CB-12685](https://issues.apache.org/jira/browse/CB-12685) added `package.json` to tests folder * [CB-12575](https://issues.apache.org/jira/browse/CB-12575) cordova-plugin-wkwebview-engine missing LICENSE file * [CB-12519](https://issues.apache.org/jira/browse/CB-12519) added missing license header ### 1.1.2 (Feb 28, 2017) * [CB-12497](https://issues.apache.org/jira/browse/CB-12497) `location.href` links are silently disallowed * [CB-12490](https://issues.apache.org/jira/browse/CB-12490) - Updated experimental plugin link * Allow to configure navigation by gestures * [CB-12297](https://issues.apache.org/jira/browse/CB-12297) Support `WKProcessPool` for cookie sharing * [CB-12414](https://issues.apache.org/jira/browse/CB-12414) **iOS:** Forward error from provisional load error to standard load error ### 1.1.1 (Dec 07, 2016) * [CB-12224](https://issues.apache.org/jira/browse/CB-12224) Updated version and RELEASENOTES.md for release 1.1.1 * [CB-10228](https://issues.apache.org/jira/browse/CB-10228) - AppendUserAgent not working with WKWebView * [CB-11997](https://issues.apache.org/jira/browse/CB-11997) - Add crash recovery for iOS 8 * [CB-11917](https://issues.apache.org/jira/browse/CB-11917) - Remove pull request template checklist item: "iCLA has been submitted…" * [CB-11818](https://issues.apache.org/jira/browse/CB-11818) - Avoid retain cycle: WKUserContentController retains its message handler, to break it we cannot pass directly CDVWKWebViewEngine's instance * [CB-11832](https://issues.apache.org/jira/browse/CB-11832) Incremented plugin version. ### 1.1.0 (Sep 08, 2016) * [CB-11824](https://issues.apache.org/jira/browse/CB-11824) - Update tests to include objective-c tests * [CB-11554](https://issues.apache.org/jira/browse/CB-11554) - fixed unit tests * [CB-11815](https://issues.apache.org/jira/browse/CB-11815) (**iOS**) Fix hard-coded bridge name "cordova" * [CB-11554](https://issues.apache.org/jira/browse/CB-11554) - too 'brutal' app reload when title is empty * [CB-11074](https://issues.apache.org/jira/browse/CB-11074) - Ensure settings from `config.xml` are taken into consideration * Add ability to set the deceleration rate for the scrollview to 'fast' * [CB-11496](https://issues.apache.org/jira/browse/CB-11496) - Add obj-c unit tests for `WKWebViewConfiguration`, `WKPreference` * [CB-11496](https://issues.apache.org/jira/browse/CB-11496) - Create Obj-C unit-tests for `wkwebview-engine` (fix linker error) * [CB-11452](https://issues.apache.org/jira/browse/CB-11452) - Update README.md with latest news about `AllowInlineMediaPlayback` fix * [CB-9888](https://issues.apache.org/jira/browse/CB-9888) (**iOS**) check & reload `WKWebView` * [CB-11375](https://issues.apache.org/jira/browse/CB-11375) - `onReset` method of `CDVPlugin` is never called * Add pull request template. * [CB-10818](https://issues.apache.org/jira/browse/CB-10818) - Support the scroll deceleration speed preference. * [CB-10817](https://issues.apache.org/jira/browse/CB-10817) - Will now reload the `webView` if a crash occurs ### 1.0.3 (Apr 15, 2016) * [CB-10636](https://issues.apache.org/jira/browse/CB-10636) Add `JSHint` for plugins ### 1.0.2 (Feb 09, 2016) * [CB-10269](https://issues.apache.org/jira/browse/CB-10269) - Replace cordova exec only when present in wkwebview * [CB-10202](https://issues.apache.org/jira/browse/CB-10202) - Add README quirk about WKWebview does not work with the AllowInlineMediaPlayback preference ### 1.0.1 (Dec 11, 2015) * [CB-10190](https://issues.apache.org/jira/browse/CB-10190) - WKWebView engine is not releasing the user-agent lock ### 1.0.0 (Dec 04, 2015) * [CB-10146](https://issues.apache.org/jira/browse/CB-10146) - Add to README WKWebViewEngine quirks that will affect migration from UIWebView * [CB-10133](https://issues.apache.org/jira/browse/CB-10133) - DataClone DOM Exception 25 thrown for postMessage * [CB-10106](https://issues.apache.org/jira/browse/CB-10106) - added bridge proxy * [CB-10107](https://issues.apache.org/jira/browse/CB-10107) - nativeEvalAndFetch called for all bridges * [CB-10106](https://issues.apache.org/jira/browse/CB-10106) - iOS bridges need to take into account bridge changes * [CB-10073](https://issues.apache.org/jira/browse/CB-10073) - WKWebViewEngine should post CDVPluginResetNotification * [CB-10035](https://issues.apache.org/jira/browse/CB-10035) Updated RELEASENOTES to be newest to oldest * [CB-10002](https://issues.apache.org/jira/browse/CB-10002) - WKWebView should propagate shouldOverrideLoadWithRequest to plugins * [CB-9979](https://issues.apache.org/jira/browse/CB-9979) [CB-9972](https://issues.apache.org/jira/browse/CB-9972) Change ATS link to new link * [CB-9636](https://issues.apache.org/jira/browse/CB-9636) - Plugin should detect at runtime iOS 8 and use of file:// url and present an error * [CB-8839](https://issues.apache.org/jira/browse/CB-8839) - WKWebView ignores DisallowOverscroll preference * [CB-8556](https://issues.apache.org/jira/browse/CB-8556) - fix handleOpenURL for WKWebViewEngine plugin * [CB-8666](https://issues.apache.org/jira/browse/CB-8666) - Update CDVWKWebViewEngine plugin to use 4.0.x branch code ================================================ FILE: package.json ================================================ { "name": "cordova-plugin-wkwebview-engine", "version": "1.1.6", "description": "The official Apache Cordova WKWebView Engine Plugin", "main": "index.js", "repository": { "type": "git", "url": "https://github.com/ionic-team/cordova-plugin-wkwebview-engine" }, "bugs": { "url": "https://github.com/ionic-team/cordova-plugin-wkwebview-engine/issues" }, "keywords": [ "cordova", "wkwebview" ], "scripts": { "test": "npm run eslint && npm run objc-tests", "objc-tests": "cd tests/ios && npm test", "preobjc-tests": "cd tests/ios && npm install", "eslint": "node_modules/.bin/eslint src" }, "author": "Apache Cordova", "license": "Apache-2.0", "devDependencies": { "eslint": "^3.19.0", "eslint-config-semistandard": "^11.0.0", "eslint-config-standard": "^10.2.1", "eslint-plugin-import": "^2.3.0", "eslint-plugin-node": "^5.0.0", "eslint-plugin-promise": "^3.5.0", "eslint-plugin-standard": "^3.0.1" } } ================================================ FILE: plugin.xml ================================================ Cordova WKWebView Engine Cordova WKWebView Engine Plugin Apache 2.0 cordova,wkwebview,webview https://git-wip-us.apache.org/repos/asf/cordova-plugin-wkwebview-engine.git ================================================ FILE: src/ios/CDVWKProcessPoolFactory.h ================================================ /* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ #import @interface CDVWKProcessPoolFactory : NSObject @property (nonatomic, retain) WKProcessPool* sharedPool; +(instancetype) sharedFactory; -(WKProcessPool*) sharedProcessPool; @end ================================================ FILE: src/ios/CDVWKProcessPoolFactory.m ================================================ /* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ #import #import #import "CDVWKProcessPoolFactory.h" static CDVWKProcessPoolFactory *factory = nil; @implementation CDVWKProcessPoolFactory + (instancetype)sharedFactory { static dispatch_once_t onceToken; dispatch_once(&onceToken, ^{ factory = [[CDVWKProcessPoolFactory alloc] init]; }); return factory; } - (instancetype)init { if (self = [super init]) { _sharedPool = [[WKProcessPool alloc] init]; } return self; } - (WKProcessPool*) sharedProcessPool { return _sharedPool; } @end ================================================ FILE: src/ios/CDVWKWebViewEngine.h ================================================ /* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ #import #import @interface CDVWKWebViewEngine : CDVPlugin @property (nonatomic, strong, readonly) id uiDelegate; @end ================================================ FILE: src/ios/CDVWKWebViewEngine.m ================================================ /* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ #import "CDVWKWebViewEngine.h" #import "CDVWKWebViewUIDelegate.h" #import "CDVWKProcessPoolFactory.h" #import #import #import #import "GCDWebServer.h" #define CDV_LOCAL_SERVER @"http://localhost:8080" #define CDV_BRIDGE_NAME @"cordova" #define CDV_IONIC_STOP_SCROLL @"stopScroll" #if __IPHONE_OS_VERSION_MAX_ALLOWED >= 110000 @implementation UIScrollView (BugIOS11) + (void)load { if (@available(iOS 11.0, *)) { static dispatch_once_t onceToken; dispatch_once(&onceToken, ^{ Class class = [self class]; SEL originalSelector = @selector(init); SEL swizzledSelector = @selector(xxx_init); Method originalMethod = class_getInstanceMethod(class, originalSelector); Method swizzledMethod = class_getInstanceMethod(class, swizzledSelector); BOOL didAddMethod = class_addMethod(class, originalSelector, method_getImplementation(swizzledMethod), method_getTypeEncoding(swizzledMethod)); if (didAddMethod) { class_replaceMethod(class, swizzledSelector, method_getImplementation(originalMethod), method_getTypeEncoding(originalMethod)); } else { method_exchangeImplementations(originalMethod, swizzledMethod); } }); } } #pragma mark - Method Swizzling - (id)xxx_init { id a = [self xxx_init]; if (@available(iOS 11.0, *)) { NSArray *stack = [NSThread callStackSymbols]; for(NSString *trace in stack) { if([trace containsString:@"WebKit"]) { [a setContentInsetAdjustmentBehavior:UIScrollViewContentInsetAdjustmentNever]; break; } } } return a; } @end #endif @interface CDVWKWeakScriptMessageHandler : NSObject @property (nonatomic, weak, readonly) idscriptMessageHandler; - (instancetype)initWithScriptMessageHandler:(id)scriptMessageHandler; @end @interface CDVWKWebViewEngine () @property (nonatomic, strong, readwrite) UIView* engineWebView; @property (nonatomic, strong, readwrite) id uiDelegate; @property (nonatomic, weak) id weakScriptMessageHandler; @property (nonatomic, strong) GCDWebServer *webServer; @property (nonatomic, readwrite) CGRect frame; @end // see forwardingTargetForSelector: selector comment for the reason for this pragma #pragma clang diagnostic ignored "-Wprotocol" @implementation CDVWKWebViewEngine @synthesize engineWebView = _engineWebView; - (instancetype)initWithFrame:(CGRect)frame { self = [super init]; if (self) { if (NSClassFromString(@"WKWebView") == nil) { return nil; } if(!IsAtLeastiOSVersion(@"9.0")) { return nil; } self.frame = frame; self.webServer = [[GCDWebServer alloc] init]; [self.webServer addGETHandlerForBasePath:@"/" directoryPath:@"/" indexFilename:nil cacheAge:3600 allowRangeRequests:YES]; NSDictionary *options = @{ GCDWebServerOption_Port: @(8080), GCDWebServerOption_BindToLocalhost: @(YES), GCDWebServerOption_ServerName: @"Ionic" }; [self.webServer startWithOptions:options error:nil]; } return self; } - (WKWebViewConfiguration*) createConfigurationFromSettings:(NSDictionary*)settings { WKWebViewConfiguration* configuration = [[WKWebViewConfiguration alloc] init]; configuration.processPool = [[CDVWKProcessPoolFactory sharedFactory] sharedProcessPool]; #if __IPHONE_OS_VERSION_MAX_ALLOWED >= 110000 if(@available(iOS 10.0, *)) { configuration.mediaTypesRequiringUserActionForPlayback = WKAudiovisualMediaTypeNone; }else{ configuration.mediaPlaybackRequiresUserAction = YES; } #else configuration.mediaTypesRequiringUserActionForPlayback = WKAudiovisualMediaTypeNone; #endif if (settings == nil) { return configuration; } configuration.allowsInlineMediaPlayback = [settings cordovaBoolSettingForKey:@"AllowInlineMediaPlayback" defaultValue:YES]; configuration.suppressesIncrementalRendering = [settings cordovaBoolSettingForKey:@"SuppressesIncrementalRendering" defaultValue:NO]; configuration.allowsAirPlayForMediaPlayback = [settings cordovaBoolSettingForKey:@"MediaPlaybackAllowsAirPlay" defaultValue:YES]; return configuration; } - (void)pluginInitialize { // viewController would be available now. we attempt to set all possible delegates to it, by default NSDictionary* settings = self.commandDelegate.settings; self.uiDelegate = [[CDVWKWebViewUIDelegate alloc] initWithTitle:[[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleDisplayName"]]; CDVWKWeakScriptMessageHandler *weakScriptMessageHandler = [[CDVWKWeakScriptMessageHandler alloc] initWithScriptMessageHandler:self]; WKUserContentController* userContentController = [[WKUserContentController alloc] init]; [userContentController addScriptMessageHandler:weakScriptMessageHandler name:CDV_BRIDGE_NAME]; [userContentController addScriptMessageHandler:weakScriptMessageHandler name:CDV_IONIC_STOP_SCROLL]; // Inject XHR Polyfill NSLog(@"CDVWKWebViewEngine: trying to inject XHR polyfill"); WKUserScript *wkScript = [self wkPluginScript]; if (wkScript) { [userContentController addUserScript:wkScript]; } WKUserScript *configScript = [self configScript]; if (configScript) { [userContentController addUserScript:configScript]; } BOOL autoCordova = [settings cordovaBoolSettingForKey:@"AutoInjectCordova" defaultValue:NO]; if(autoCordova){ NSLog(@"CDVWKWebViewEngine: trying to inject XHR polyfill"); WKUserScript *cordova = [self autoCordovify]; if (cordova) { [userContentController addUserScript:cordova]; } } WKWebViewConfiguration* configuration = [self createConfigurationFromSettings:settings]; configuration.userContentController = userContentController; // re-create WKWebView, since we need to update configuration WKWebView* wkWebView = [[WKWebView alloc] initWithFrame:self.frame configuration:configuration]; #if __IPHONE_OS_VERSION_MAX_ALLOWED >= 110000 if (@available(iOS 11.0, *)) { [wkWebView.scrollView setContentInsetAdjustmentBehavior:UIScrollViewContentInsetAdjustmentNever]; } #endif wkWebView.UIDelegate = self.uiDelegate; self.engineWebView = wkWebView; if (IsAtLeastiOSVersion(@"9.0") && [self.viewController isKindOfClass:[CDVViewController class]]) { wkWebView.customUserAgent = ((CDVViewController*) self.viewController).userAgent; } if ([self.viewController conformsToProtocol:@protocol(WKUIDelegate)]) { wkWebView.UIDelegate = (id )self.viewController; } if ([self.viewController conformsToProtocol:@protocol(WKNavigationDelegate)]) { wkWebView.navigationDelegate = (id )self.viewController; } else { wkWebView.navigationDelegate = (id )self; } if ([self.viewController conformsToProtocol:@protocol(WKScriptMessageHandler)]) { [wkWebView.configuration.userContentController addScriptMessageHandler:(id < WKScriptMessageHandler >)self.viewController name:CDV_BRIDGE_NAME]; } if (![settings cordovaBoolSettingForKey:@"KeyboardDisplayRequiresUserAction" defaultValue:YES]) { [self keyboardDisplayDoesNotRequireUserAction]; } [self updateSettings:settings]; // check if content thread has died on resume NSLog(@"%@", @"CDVWKWebViewEngine will reload WKWebView if required on resume"); [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(onAppWillEnterForeground:) name:UIApplicationWillEnterForegroundNotification object:nil]; NSLog(@"Using Ionic WKWebView"); [self addURLObserver]; } // https://github.com/Telerik-Verified-Plugins/WKWebView/commit/04e8296adeb61f289f9c698045c19b62d080c7e3#L609-L620 - (void) keyboardDisplayDoesNotRequireUserAction { SEL sel = sel_getUid("_startAssistingNode:userIsInteracting:blurPreviousNode:userObject:"); Class WKContentView = NSClassFromString(@"WKContentView"); Method method = class_getInstanceMethod(WKContentView, sel); IMP originalImp = method_getImplementation(method); IMP imp = imp_implementationWithBlock(^void(id me, void* arg0, BOOL arg1, BOOL arg2, id arg3) { ((void (*)(id, SEL, void*, BOOL, BOOL, id))originalImp)(me, sel, arg0, TRUE, arg2, arg3); }); method_setImplementation(method, imp); } - (void)onReset { [self addURLObserver]; } static void * KVOContext = &KVOContext; - (void)addURLObserver { if(!IsAtLeastiOSVersion(@"9.0")){ [self.webView addObserver:self forKeyPath:@"URL" options:0 context:KVOContext]; } } - (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context { if (context == KVOContext) { if (object == [self webView] && [keyPath isEqualToString: @"URL"] && [object valueForKeyPath:keyPath] == nil){ NSLog(@"URL is nil. Reloading WKWebView"); [(WKWebView*)_engineWebView reload]; } } else { [super observeValueForKeyPath:keyPath ofObject:object change:change context:context]; } } - (void) onAppWillEnterForeground:(NSNotification*)notification { if ([self shouldReloadWebView]) { NSLog(@"%@", @"CDVWKWebViewEngine reloading!"); [(WKWebView*)_engineWebView reload]; } } - (BOOL)shouldReloadWebView { WKWebView* wkWebView = (WKWebView*)_engineWebView; return [self shouldReloadWebView:wkWebView.URL title:wkWebView.title]; } - (BOOL)shouldReloadWebView:(NSURL*)location title:(NSString*)title { BOOL title_is_nil = (title == nil); BOOL location_is_blank = [[location absoluteString] isEqualToString:@"about:blank"]; BOOL reload = (title_is_nil || location_is_blank); #ifdef DEBUG NSLog(@"%@", @"CDVWKWebViewEngine shouldReloadWebView::"); NSLog(@"CDVWKWebViewEngine shouldReloadWebView title: %@", title); NSLog(@"CDVWKWebViewEngine shouldReloadWebView location: %@", [location absoluteString]); NSLog(@"CDVWKWebViewEngine shouldReloadWebView reload: %u", reload); #endif return reload; } - (id)loadRequest:(NSURLRequest*)request { if (request.URL.fileURL) { NSURL *url = [[NSURL URLWithString:CDV_LOCAL_SERVER] URLByAppendingPathComponent:request.URL.path]; if(request.URL.query) { url = [NSURL URLWithString:[@"?" stringByAppendingString:request.URL.query] relativeToURL:url]; } if(request.URL.fragment) { url = [NSURL URLWithString:[@"#" stringByAppendingString:request.URL.fragment] relativeToURL:url]; } request = [NSURLRequest requestWithURL:url]; } return [(WKWebView*)_engineWebView loadRequest:request]; } - (id)loadHTMLString:(NSString*)string baseURL:(NSURL*)baseURL { return [(WKWebView*)_engineWebView loadHTMLString:string baseURL:baseURL]; } - (NSURL*) URL { return [(WKWebView*)_engineWebView URL]; } - (BOOL)canLoadRequest:(NSURLRequest *)request { return TRUE; } - (void)updateSettings:(NSDictionary*)settings { WKWebView* wkWebView = (WKWebView*)_engineWebView; // By default, DisallowOverscroll is false (thus bounce is allowed) BOOL bounceAllowed = !([settings cordovaBoolSettingForKey:@"DisallowOverscroll" defaultValue:NO]); // prevent webView from bouncing if (!bounceAllowed) { if ([wkWebView respondsToSelector:@selector(scrollView)]) { ((UIScrollView*)[wkWebView scrollView]).bounces = NO; } else { for (id subview in wkWebView.subviews) { if ([[subview class] isSubclassOfClass:[UIScrollView class]]) { ((UIScrollView*)subview).bounces = NO; } } } } wkWebView.configuration.preferences.minimumFontSize = [settings cordovaFloatSettingForKey:@"MinimumFontSize" defaultValue:0.0]; wkWebView.allowsLinkPreview = [settings cordovaBoolSettingForKey:@"AllowLinkPreview" defaultValue:NO]; wkWebView.scrollView.scrollEnabled = [settings cordovaBoolSettingForKey:@"ScrollEnabled" defaultValue:NO]; wkWebView.allowsBackForwardNavigationGestures = [settings cordovaBoolSettingForKey:@"AllowBackForwardNavigationGestures" defaultValue:NO]; } - (void)updateWithInfo:(NSDictionary*)info { NSDictionary* scriptMessageHandlers = [info objectForKey:kCDVWebViewEngineScriptMessageHandlers]; NSDictionary* settings = [info objectForKey:kCDVWebViewEngineWebViewPreferences]; id navigationDelegate = [info objectForKey:kCDVWebViewEngineWKNavigationDelegate]; id uiDelegate = [info objectForKey:kCDVWebViewEngineWKUIDelegate]; WKWebView* wkWebView = (WKWebView*)_engineWebView; if (scriptMessageHandlers && [scriptMessageHandlers isKindOfClass:[NSDictionary class]]) { NSArray* allKeys = [scriptMessageHandlers allKeys]; for (NSString* key in allKeys) { id object = [scriptMessageHandlers objectForKey:key]; if ([object conformsToProtocol:@protocol(WKScriptMessageHandler)]) { [wkWebView.configuration.userContentController addScriptMessageHandler:object name:key]; } } } if (navigationDelegate && [navigationDelegate conformsToProtocol:@protocol(WKNavigationDelegate)]) { wkWebView.navigationDelegate = navigationDelegate; } if (uiDelegate && [uiDelegate conformsToProtocol:@protocol(WKUIDelegate)]) { wkWebView.UIDelegate = uiDelegate; } if (settings && [settings isKindOfClass:[NSDictionary class]]) { [self updateSettings:settings]; } } // This forwards the methods that are in the header that are not implemented here. // Both WKWebView and UIWebView implement the below: // loadHTMLString:baseURL: // loadRequest: - (id)forwardingTargetForSelector:(SEL)aSelector { return _engineWebView; } - (UIView*)webView { return self.engineWebView; } - (WKUserScript*)wkPluginScript { NSString *scriptFile = [[NSBundle mainBundle] pathForResource:@"www/wk-plugin" ofType:@"js"]; if (scriptFile == nil) { NSLog(@"CDVWKWebViewEngine: WK plugin was not found"); return nil; } NSError *error = nil; NSString *source = [NSString stringWithContentsOfFile:scriptFile encoding:NSUTF8StringEncoding error:&error]; if (source == nil || error != nil) { NSLog(@"CDVWKWebViewEngine: WK plugin can not be loaded: %@", error); return nil; } return [[WKUserScript alloc] initWithSource:source injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:YES]; } - (WKUserScript*)configScript { Class keyboard = NSClassFromString(@"CDVIonicKeyboard"); BOOL keyboardPlugin = keyboard != nil; if(!keyboardPlugin) { return nil; } BOOL keyboardResizes = [self.commandDelegate.settings cordovaBoolSettingForKey:@"KeyboardResizes" defaultValue:YES]; NSString *source = [NSString stringWithFormat: @"window.Ionic = window.Ionic || {};" @"window.Ionic.keyboardPlugin=true;" @"window.Ionic.keyboardResizes=%@", keyboardResizes ? @"true" : @"false"]; return [[WKUserScript alloc] initWithSource:source injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:YES]; } - (WKUserScript*)autoCordovify { NSURL *cordovaURL = [[NSBundle mainBundle] URLForResource:@"www/cordova" withExtension:@"js"]; if (cordovaURL == nil) { NSLog(@"CDVWKWebViewEngine: cordova.js WAS NOT FOUND"); return nil; } NSError *error = nil; NSString *source = [NSString stringWithContentsOfURL:cordovaURL encoding:NSUTF8StringEncoding error:&error]; if (source == nil || error != nil) { NSLog(@"CDVWKWebViewEngine: cordova.js can not be loaded: %@", error); return nil; } NSLog(@"CDVWKWebViewEngine: auto injecting cordova"); NSString *cordovaPath = [CDV_LOCAL_SERVER stringByAppendingString:cordovaURL.URLByDeletingLastPathComponent.path]; NSString *replacement = [NSString stringWithFormat:@"var pathPrefix = '%@/';", cordovaPath]; source = [source stringByReplacingOccurrencesOfString:@"var pathPrefix = findCordovaPath();" withString:replacement]; return [[WKUserScript alloc] initWithSource:source injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:YES]; } #pragma mark WKScriptMessageHandler implementation - (void)userContentController:(WKUserContentController*)userContentController didReceiveScriptMessage:(WKScriptMessage*)message { if ([message.name isEqualToString:CDV_BRIDGE_NAME]) { [self handleCordovaMessage: message]; } else if ([message.name isEqualToString:CDV_IONIC_STOP_SCROLL]) { [self handleStopScroll]; } } - (void)handleCordovaMessage:(WKScriptMessage*)message { CDVViewController* vc = (CDVViewController*)self.viewController; NSArray* jsonEntry = message.body; // NSString:callbackId, NSString:service, NSString:action, NSArray:args CDVInvokedUrlCommand* command = [CDVInvokedUrlCommand commandFromJson:jsonEntry]; CDV_EXEC_LOG(@"Exec(%@): Calling %@.%@", command.callbackId, command.className, command.methodName); if (![vc.commandQueue execute:command]) { #ifdef DEBUG NSError* error = nil; NSString* commandJson = nil; NSData* jsonData = [NSJSONSerialization dataWithJSONObject:jsonEntry options:0 error:&error]; if (error == nil) { commandJson = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding]; } static NSUInteger maxLogLength = 1024; NSString* commandString = ([commandJson length] > maxLogLength) ? [NSString stringWithFormat : @"%@[...]", [commandJson substringToIndex:maxLogLength]] : commandJson; NSLog(@"FAILED pluginJSON = %@", commandString); #endif } } - (void)handleStopScroll { WKWebView* wkWebView = (WKWebView*)_engineWebView; NSLog(@"CDVWKWebViewEngine: handleStopScroll"); [self recursiveStopScroll:[wkWebView scrollView]]; [wkWebView evaluateJavaScript:@"window.IonicStopScroll.fire()" completionHandler:nil]; } - (void)recursiveStopScroll:(UIView *)node { if([node isKindOfClass: [UIScrollView class]]) { UIScrollView *nodeAsScroll = (UIScrollView *)node; if([nodeAsScroll isScrollEnabled] && ![nodeAsScroll isHidden]) { [nodeAsScroll setScrollEnabled: NO]; [nodeAsScroll setScrollEnabled: YES]; } } // iterate tree recursivelly for (UIView *child in [node subviews]) { [self recursiveStopScroll:child]; } } #pragma mark WKNavigationDelegate implementation - (void)webView:(WKWebView*)webView didStartProvisionalNavigation:(WKNavigation*)navigation { [[NSNotificationCenter defaultCenter] postNotification:[NSNotification notificationWithName:CDVPluginResetNotification object:webView]]; } - (void)webView:(WKWebView*)webView didFinishNavigation:(WKNavigation*)navigation { CDVViewController* vc = (CDVViewController*)self.viewController; [CDVUserAgentUtil releaseLock:vc.userAgentLockToken]; [[NSNotificationCenter defaultCenter] postNotification:[NSNotification notificationWithName:CDVPageDidLoadNotification object:webView]]; } - (void)webView:(WKWebView*)theWebView didFailProvisionalNavigation:(WKNavigation*)navigation withError:(NSError*)error { [self webView:theWebView didFailNavigation:navigation withError:error]; } - (void)webView:(WKWebView*)theWebView didFailNavigation:(WKNavigation*)navigation withError:(NSError*)error { CDVViewController* vc = (CDVViewController*)self.viewController; [CDVUserAgentUtil releaseLock:vc.userAgentLockToken]; NSString* message = [NSString stringWithFormat:@"Failed to load webpage with error: %@", [error localizedDescription]]; NSLog(@"%@", message); NSURL* errorUrl = vc.errorURL; if (errorUrl) { errorUrl = [NSURL URLWithString:[NSString stringWithFormat:@"?error=%@", [message stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding]] relativeToURL:errorUrl]; NSLog(@"%@", [errorUrl absoluteString]); [theWebView loadRequest:[NSURLRequest requestWithURL:errorUrl]]; } } - (void)webViewWebContentProcessDidTerminate:(WKWebView *)webView { [webView reload]; } - (BOOL)defaultResourcePolicyForURL:(NSURL*)url { // all file:// urls are allowed if ([url isFileURL]) { return YES; } return NO; } - (void) webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction*)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler { NSURL* url = [navigationAction.request URL]; CDVViewController* vc = (CDVViewController*)self.viewController; /* * Give plugins the chance to handle the url */ BOOL anyPluginsResponded = NO; BOOL shouldAllowRequest = NO; for (NSString* pluginName in vc.pluginObjects) { CDVPlugin* plugin = [vc.pluginObjects objectForKey:pluginName]; SEL selector = NSSelectorFromString(@"shouldOverrideLoadWithRequest:navigationType:"); if ([plugin respondsToSelector:selector]) { anyPluginsResponded = YES; // https://issues.apache.org/jira/browse/CB-12497 int navType = (int)navigationAction.navigationType; if (WKNavigationTypeOther == navigationAction.navigationType) { navType = (int)UIWebViewNavigationTypeOther; } shouldAllowRequest = (((BOOL (*)(id, SEL, id, int))objc_msgSend)(plugin, selector, navigationAction.request, navType)); if (!shouldAllowRequest) { break; } } } if (!anyPluginsResponded) { /* * Handle all other types of urls (tel:, sms:), and requests to load a url in the main webview. */ shouldAllowRequest = [self defaultResourcePolicyForURL:url]; if (!shouldAllowRequest) { [[NSNotificationCenter defaultCenter] postNotification:[NSNotification notificationWithName:CDVPluginHandleOpenURLNotification object:url]]; } } if (shouldAllowRequest) { NSString *scheme = url.scheme; if ([scheme isEqualToString:@"tel"] || [scheme isEqualToString:@"mailto"] || [scheme isEqualToString:@"facetime"] || [scheme isEqualToString:@"sms"] || [scheme isEqualToString:@"maps"] || [scheme isEqualToString:@"itms-services"]) { [[UIApplication sharedApplication] openURL:url]; decisionHandler(WKNavigationActionPolicyCancel); } else { decisionHandler(WKNavigationActionPolicyAllow); } } else { decisionHandler(WKNavigationActionPolicyCancel); } } @end #pragma mark - CDVWKWeakScriptMessageHandler @implementation CDVWKWeakScriptMessageHandler - (instancetype)initWithScriptMessageHandler:(id)scriptMessageHandler { self = [super init]; if (self) { _scriptMessageHandler = scriptMessageHandler; } return self; } - (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message { [self.scriptMessageHandler userContentController:userContentController didReceiveScriptMessage:message]; } @end ================================================ FILE: src/ios/CDVWKWebViewUIDelegate.h ================================================ /* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ #import @interface CDVWKWebViewUIDelegate : NSObject @property (nonatomic, copy) NSString* title; - (instancetype)initWithTitle:(NSString*)title; @end ================================================ FILE: src/ios/CDVWKWebViewUIDelegate.m ================================================ /* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ #import "CDVWKWebViewUIDelegate.h" @implementation CDVWKWebViewUIDelegate - (instancetype)initWithTitle:(NSString*)title { self = [super init]; if (self) { self.title = title; } return self; } - (void) webView:(WKWebView*)webView runJavaScriptAlertPanelWithMessage:(NSString*)message initiatedByFrame:(WKFrameInfo*)frame completionHandler:(void (^)(void))completionHandler { UIAlertController* alert = [UIAlertController alertControllerWithTitle:self.title message:message preferredStyle:UIAlertControllerStyleAlert]; UIAlertAction* ok = [UIAlertAction actionWithTitle:NSLocalizedString(@"OK", @"OK") style:UIAlertActionStyleDefault handler:^(UIAlertAction* action) { completionHandler(); [alert dismissViewControllerAnimated:YES completion:nil]; }]; [alert addAction:ok]; UIViewController* rootController = [UIApplication sharedApplication].delegate.window.rootViewController; [rootController presentViewController:alert animated:YES completion:nil]; } - (void) webView:(WKWebView*)webView runJavaScriptConfirmPanelWithMessage:(NSString*)message initiatedByFrame:(WKFrameInfo*)frame completionHandler:(void (^)(BOOL result))completionHandler { UIAlertController* alert = [UIAlertController alertControllerWithTitle:self.title message:message preferredStyle:UIAlertControllerStyleAlert]; UIAlertAction* ok = [UIAlertAction actionWithTitle:NSLocalizedString(@"OK", @"OK") style:UIAlertActionStyleDefault handler:^(UIAlertAction* action) { completionHandler(YES); [alert dismissViewControllerAnimated:YES completion:nil]; }]; [alert addAction:ok]; UIAlertAction* cancel = [UIAlertAction actionWithTitle:NSLocalizedString(@"Cancel", @"Cancel") style:UIAlertActionStyleDefault handler:^(UIAlertAction* action) { completionHandler(NO); [alert dismissViewControllerAnimated:YES completion:nil]; }]; [alert addAction:cancel]; UIViewController* rootController = [UIApplication sharedApplication].delegate.window.rootViewController; [rootController presentViewController:alert animated:YES completion:nil]; } - (void) webView:(WKWebView*)webView runJavaScriptTextInputPanelWithPrompt:(NSString*)prompt defaultText:(NSString*)defaultText initiatedByFrame:(WKFrameInfo*)frame completionHandler:(void (^)(NSString* result))completionHandler { UIAlertController* alert = [UIAlertController alertControllerWithTitle:self.title message:prompt preferredStyle:UIAlertControllerStyleAlert]; UIAlertAction* ok = [UIAlertAction actionWithTitle:NSLocalizedString(@"OK", @"OK") style:UIAlertActionStyleDefault handler:^(UIAlertAction* action) { completionHandler(((UITextField*)alert.textFields[0]).text); [alert dismissViewControllerAnimated:YES completion:nil]; }]; [alert addAction:ok]; UIAlertAction* cancel = [UIAlertAction actionWithTitle:NSLocalizedString(@"Cancel", @"Cancel") style:UIAlertActionStyleDefault handler:^(UIAlertAction* action) { completionHandler(nil); [alert dismissViewControllerAnimated:YES completion:nil]; }]; [alert addAction:cancel]; [alert addTextFieldWithConfigurationHandler:^(UITextField* textField) { textField.text = defaultText; }]; UIViewController* rootController = [UIApplication sharedApplication].delegate.window.rootViewController; [rootController presentViewController:alert animated:YES completion:nil]; } @end ================================================ FILE: src/ios/GCDWebServer/Core/GCDWebServer.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import #import "GCDWebServerRequest.h" #import "GCDWebServerResponse.h" /** * The GCDWebServerMatchBlock is called for every handler added to the * GCDWebServer whenever a new HTTP request has started (i.e. HTTP headers have * been received). The block is passed the basic info for the request (HTTP method, * URL, headers...) and must decide if it wants to handle it or not. * * If the handler can handle the request, the block must return a new * GCDWebServerRequest instance created with the same basic info. * Otherwise, it simply returns nil. */ typedef GCDWebServerRequest* (^GCDWebServerMatchBlock)(NSString* requestMethod, NSURL* requestURL, NSDictionary* requestHeaders, NSString* urlPath, NSDictionary* urlQuery); /** * 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 * GCDWebServerRequest created at the previous step by the GCDWebServerMatchBlock. * * The block must return a GCDWebServerResponse or nil on error, which will * result in a 500 HTTP status code returned to the client. It's however * recommended to return a GCDWebServerErrorResponse on error so more useful * information can be returned to the client. */ typedef GCDWebServerResponse* (^GCDWebServerProcessBlock)(__kindof GCDWebServerRequest* request); /** * The GCDWebServerAsynchronousProcessBlock works like the GCDWebServerProcessBlock * except the GCDWebServerResponse can be returned to the server at a later time * allowing for asynchronous generation of the response. * * The block must eventually call "completionBlock" passing a GCDWebServerResponse * or nil on error, which will result in a 500 HTTP status code returned to the client. * It's however recommended to return a GCDWebServerErrorResponse on error so more * useful information can be returned to the client. */ typedef void (^GCDWebServerCompletionBlock)(GCDWebServerResponse* response); typedef void (^GCDWebServerAsyncProcessBlock)(__kindof GCDWebServerRequest* request, GCDWebServerCompletionBlock completionBlock); /** * The port used by the GCDWebServer (NSNumber / NSUInteger). * * The default value is 0 i.e. let the OS pick a random port. */ extern NSString* const GCDWebServerOption_Port; /** * The Bonjour name used by the GCDWebServer (NSString). If set to an empty string, * the name will automatically take the value of the GCDWebServerOption_ServerName * option. If this option is set to nil, Bonjour will be disabled. * * The default value is nil. */ extern NSString* const GCDWebServerOption_BonjourName; /** * The Bonjour service type used by the GCDWebServer (NSString). * * The default value is "_http._tcp", the service type for HTTP web servers. */ extern NSString* const GCDWebServerOption_BonjourType; /** * Request a port mapping in the NAT gateway (NSNumber / BOOL). * * This uses the DNSService API under the hood which supports IPv4 mappings only. * * The default value is NO. * * @warning The external port set up by the NAT gateway may be different than * the one used by the GCDWebServer. */ extern NSString* const GCDWebServerOption_RequestNATPortMapping; /** * Only accept HTTP requests coming from localhost i.e. not from the outside * network (NSNumber / BOOL). * * The default value is NO. * * @warning Bonjour and NAT port mapping should be disabled if using this option * since the server will not be reachable from the outside network anyway. */ extern NSString* const GCDWebServerOption_BindToLocalhost; /** * The maximum number of incoming HTTP requests that can be queued waiting to * be handled before new ones are dropped (NSNumber / NSUInteger). * * The default value is 16. */ extern NSString* const GCDWebServerOption_MaxPendingConnections; /** * The value for "Server" HTTP header used by the GCDWebServer (NSString). * * The default value is the GCDWebServer class name. */ extern NSString* const GCDWebServerOption_ServerName; /** * The authentication method used by the GCDWebServer * (one of "GCDWebServerAuthenticationMethod_..."). * * The default value is nil i.e. authentication is disabled. */ extern NSString* const GCDWebServerOption_AuthenticationMethod; /** * The authentication realm used by the GCDWebServer (NSString). * * The default value is the same as the GCDWebServerOption_ServerName option. */ extern NSString* const GCDWebServerOption_AuthenticationRealm; /** * The authentication accounts used by the GCDWebServer * (NSDictionary of username / password pairs). * * The default value is nil i.e. no accounts. */ extern NSString* const GCDWebServerOption_AuthenticationAccounts; /** * The class used by the GCDWebServer when instantiating GCDWebServerConnection * (subclass of GCDWebServerConnection). * * The default value is the GCDWebServerConnection class. */ extern NSString* const GCDWebServerOption_ConnectionClass; /** * Allow the GCDWebServer to pretend "HEAD" requests are actually "GET" ones * and automatically discard the HTTP body of the response (NSNumber / BOOL). * * The default value is YES. */ extern NSString* const GCDWebServerOption_AutomaticallyMapHEADToGET; /** * The interval expressed in seconds used by the GCDWebServer to decide how to * coalesce calls to -webServerDidConnect: and -webServerDidDisconnect: * (NSNumber / double). Coalescing will be disabled if the interval is <= 0.0. * * The default value is 1.0 second. */ extern NSString* const GCDWebServerOption_ConnectedStateCoalescingInterval; /** * Set the dispatch queue priority on which server connection will be * run (NSNumber / long). * * * The default value is DISPATCH_QUEUE_PRIORITY_DEFAULT. */ extern NSString* const GCDWebServerOption_DispatchQueuePriority; #if TARGET_OS_IPHONE /** * Enables the GCDWebServer to automatically suspend itself (as if -stop was * called) when the iOS app goes into the background and the last * GCDWebServerConnection is closed, then resume itself (as if -start was called) * when the iOS app comes back to the foreground (NSNumber / BOOL). * * See the README.md file for more information about this option. * * The default value is YES. * * @warning The running property will be NO while the GCDWebServer is suspended. */ extern NSString* const GCDWebServerOption_AutomaticallySuspendInBackground; #endif /** * HTTP Basic Authentication scheme (see https://tools.ietf.org/html/rfc2617). * * @warning Use of this authentication scheme is not recommended as the * passwords are sent in clear. */ extern NSString* const GCDWebServerAuthenticationMethod_Basic; /** * HTTP Digest Access Authentication scheme (see https://tools.ietf.org/html/rfc2617). */ extern NSString* const GCDWebServerAuthenticationMethod_DigestAccess; @class GCDWebServer; /** * Delegate methods for GCDWebServer. * * @warning These methods are always called on the main thread in a serialized way. */ @protocol GCDWebServerDelegate @optional /** * This method is called after the server has successfully started. */ - (void)webServerDidStart:(GCDWebServer*)server; /** * This method is called after the Bonjour registration for the server has * successfully completed. * * Use the "bonjourServerURL" property to retrieve the Bonjour address of the * server. */ - (void)webServerDidCompleteBonjourRegistration:(GCDWebServer*)server; /** * This method is called after the NAT port mapping for the server has been * updated. * * Use the "publicServerURL" property to retrieve the public address of the * server. */ - (void)webServerDidUpdateNATPortMapping:(GCDWebServer*)server; /** * This method is called when the first GCDWebServerConnection is opened by the * server to serve a series of HTTP requests. * * 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). */ - (void)webServerDidConnect:(GCDWebServer*)server; /** * This method is called when the last GCDWebServerConnection is closed after * the server has served a series of HTTP requests. * * The GCDWebServerOption_ConnectedStateCoalescingInterval option can be used * to have the server wait some extra delay before considering that the series * of HTTP requests has ended (in case there some latency between consecutive * requests). This effectively coalesces the calls to -webServerDidConnect: * and -webServerDidDisconnect:. */ - (void)webServerDidDisconnect:(GCDWebServer*)server; /** * This method is called after the server has stopped. */ - (void)webServerDidStop:(GCDWebServer*)server; @end /** * The GCDWebServer class listens for incoming HTTP requests on a given port, * 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. */ @interface GCDWebServer : NSObject /** * Sets the delegate for the server. */ @property(nonatomic, assign) id delegate; /** * Returns YES if the server is currently running. */ @property(nonatomic, readonly, getter=isRunning) BOOL running; /** * Returns the port used by the server. * * @warning This property is only valid if the server is running. */ @property(nonatomic, readonly) NSUInteger port; /** * Returns the Bonjour name 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* 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. */ - (instancetype)init; /** * Adds to the server a handler that generates responses synchronously when handling incoming HTTP requests. * * 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; /** * Adds to the server a handler that generates responses asynchronously when handling incoming HTTP requests. * * 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 asyncProcessBlock:(GCDWebServerAsyncProcessBlock)processBlock; /** * Removes all handlers previously added to the server. * * @warning Removing handlers while the server is running is not allowed. */ - (void)removeAllHandlers; /** * Starts the server with explicit options. This method is the designated way * to start the server. * * Returns NO if the server failed to start and sets "error" argument if not NULL. */ - (BOOL)startWithOptions:(NSDictionary*)options error:(NSError**)error; /** * Stops the server and prevents it to accepts new HTTP requests. * * @warning Stopping the server does not abort GCDWebServerConnection instances * currently handling already received HTTP requests. These connections will * continue to execute normally until completion. */ - (void)stop; @end @interface GCDWebServer (Extensions) /** * Returns the server's URL. * * @warning This property is only valid if the server is running. */ @property(nonatomic, readonly) NSURL* serverURL; /** * Returns the server's Bonjour URL. * * @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. * Also be aware this property will not automatically update if the Bonjour hostname * has been dynamically changed after the server started running (this should be rare). */ @property(nonatomic, readonly) NSURL* bonjourServerURL; /** * Returns the server's public URL. * * @warning This property is only valid if the server is running and NAT port * mapping is active. */ @property(nonatomic, readonly) NSURL* publicServerURL; /** * Starts the server on port 8080 (OS X & iOS Simulator) or port 80 (iOS) * using the default 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 default name. * * Returns NO if the server failed to start. */ - (BOOL)startWithPort:(NSUInteger)port bonjourName:(NSString*)name; #if !TARGET_OS_IPHONE /** * Runs the server synchronously using -startWithPort:bonjourName: until a * SIGINT signal is received i.e. Ctrl-C. This method is intended to be used * by command line tools. * * Returns NO if the server failed to start. * * @warning This method must be used from the main thread only. */ - (BOOL)runWithPort:(NSUInteger)port bonjourName:(NSString*)name; /** * Runs the server synchronously using -startWithOptions: until a SIGTERM or * SIGINT signal is received i.e. Ctrl-C in Terminal. This method is intended to * be used by command line tools. * * 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. */ - (BOOL)runWithOptions:(NSDictionary*)options error:(NSError**)error; #endif @end @interface GCDWebServer (Handlers) /** * Adds a default handler to the server to handle all incoming HTTP requests * with a given HTTP method and generate responses synchronously. */ - (void)addDefaultHandlerForMethod:(NSString*)method requestClass:(Class)aClass processBlock:(GCDWebServerProcessBlock)block; /** * Adds a default handler to the server to handle all incoming HTTP requests * with a given HTTP method and generate responses asynchronously. */ - (void)addDefaultHandlerForMethod:(NSString*)method requestClass:(Class)aClass asyncProcessBlock:(GCDWebServerAsyncProcessBlock)block; /** * Adds a handler to the server to handle incoming HTTP requests with a given * HTTP method and a specific case-insensitive path and generate responses * synchronously. */ - (void)addHandlerForMethod:(NSString*)method path:(NSString*)path requestClass:(Class)aClass processBlock:(GCDWebServerProcessBlock)block; /** * Adds a handler to the server to handle incoming HTTP requests with a given * HTTP method and a specific case-insensitive path and generate responses * asynchronously. */ - (void)addHandlerForMethod:(NSString*)method path:(NSString*)path requestClass:(Class)aClass asyncProcessBlock:(GCDWebServerAsyncProcessBlock)block; /** * Adds a handler to the server to handle incoming HTTP requests with a given * HTTP method and a path matching a case-insensitive regular expression and * generate responses synchronously. */ - (void)addHandlerForMethod:(NSString*)method pathRegex:(NSString*)regex requestClass:(Class)aClass processBlock:(GCDWebServerProcessBlock)block; /** * Adds a handler to the server to handle incoming HTTP requests with a given * HTTP method and a path matching a case-insensitive regular expression and * generate responses asynchronously. */ - (void)addHandlerForMethod:(NSString*)method pathRegex:(NSString*)regex requestClass:(Class)aClass asyncProcessBlock:(GCDWebServerAsyncProcessBlock)block; @end @interface GCDWebServer (GETHandlers) /** * Adds a handler to the server to respond to incoming "GET" HTTP requests * with a specific case-insensitive path with in-memory data. */ - (void)addGETHandlerForPath:(NSString*)path staticData:(NSData*)staticData contentType:(NSString*)contentType cacheAge:(NSUInteger)cacheAge; /** * Adds a handler to the server to respond to incoming "GET" HTTP requests * with a specific case-insensitive path with a file. */ - (void)addGETHandlerForPath:(NSString*)path filePath:(NSString*)filePath isAttachment:(BOOL)isAttachment cacheAge:(NSUInteger)cacheAge allowRangeRequests:(BOOL)allowRangeRequests; /** * Adds a handler to the server to respond to incoming "GET" HTTP requests * with a case-insensitive path inside a base path with the corresponding file * inside a local directory. If no local file matches the request path, a 401 * HTTP status code is returned to the client. * * The "indexFilename" argument allows to specify an "index" file name to use * when the request path corresponds to a directory. */ - (void)addGETHandlerForBasePath:(NSString*)basePath directoryPath:(NSString*)directoryPath indexFilename:(NSString*)indexFilename cacheAge:(NSUInteger)cacheAge allowRangeRequests:(BOOL)allowRangeRequests; @end /** * GCDWebServer provides its own built-in logging facility which is used by * default. It simply sends log messages to stderr assuming it is connected * to a terminal type device. * * GCDWebServer is also compatible with a limited set of third-party logging * facilities. If one of them is available at compile time, GCDWebServer will * automatically use it in place of the built-in one. * * Currently supported third-party logging facilities are: * - XLFacility (by the same author as GCDWebServer): https://github.com/swisspol/XLFacility * - CocoaLumberjack: https://github.com/CocoaLumberjack/CocoaLumberjack * * For both the built-in logging facility and CocoaLumberjack, the default * logging level is INFO (or DEBUG if the preprocessor constant "DEBUG" * evaluates to non-zero at compile time). * * It's possible to have GCDWebServer use a custom logging facility by defining * the "__GCDWEBSERVER_LOGGING_HEADER__" preprocessor constant in Xcode build * settings to the name of a custom header file (escaped like \"MyLogging.h\"). * This header file must define the following set of macros: * * GWS_LOG_DEBUG(...) * GWS_LOG_VERBOSE(...) * GWS_LOG_INFO(...) * GWS_LOG_WARNING(...) * GWS_LOG_ERROR(...) * * IMPORTANT: These macros must behave like NSLog(). Furthermore the GWS_LOG_DEBUG() * macro should not do anything unless the preprocessor constant "DEBUG" evaluates * to non-zero. * * The logging methods below send log messages to the same logging facility * used by GCDWebServer. They can be used for consistency wherever you interact * with GCDWebServer in your code (e.g. in the implementation of handlers). */ @interface GCDWebServer (Logging) /** * Sets the log level of the logging facility below which log messages are discarded. * * @warning The interpretation of the "level" argument depends on the logging * facility used at compile time. * * If using the built-in logging facility, the log levels are as follow: * DEBUG = 0 * VERBOSE = 1 * INFO = 2 * WARNING = 3 * ERROR = 4 */ + (void)setLogLevel:(int)level; /** * Logs a message to the logging facility at the VERBOSE level. */ - (void)logVerbose:(NSString*)format, ... NS_FORMAT_FUNCTION(1, 2); /** * Logs a message to the logging facility at the INFO level. */ - (void)logInfo:(NSString*)format, ... NS_FORMAT_FUNCTION(1, 2); /** * Logs a message to the logging facility at the WARNING level. */ - (void)logWarning:(NSString*)format, ... NS_FORMAT_FUNCTION(1, 2); /** * Logs a message to the logging facility at the ERROR level. */ - (void)logError:(NSString*)format, ... NS_FORMAT_FUNCTION(1, 2); @end #ifdef __GCDWEBSERVER_ENABLE_TESTING__ @interface GCDWebServer (Testing) /** * Activates recording of HTTP requests and responses which create files in the * current directory containing the raw data for all requests and responses. * * @warning The current directory must not contain any prior recording files. */ @property(nonatomic, getter=isRecordingEnabled) BOOL recordingEnabled; /** * Runs tests by playing back pre-recorded HTTP requests in the given directory * and comparing the generated responses with the pre-recorded ones. * * Returns the number of failed tests or -1 if server failed to start. */ - (NSInteger)runTestsWithOptions:(NSDictionary*)options inDirectory:(NSString*)path; @end #endif ================================================ FILE: src/ios/GCDWebServer/Core/GCDWebServer.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import #if TARGET_OS_IPHONE #import #else #ifdef __GCDWEBSERVER_ENABLE_TESTING__ #import #endif #endif #import #import #import "GCDWebServerPrivate.h" #if TARGET_OS_IPHONE && !TARGET_IPHONE_SIMULATOR #define kDefaultPort 80 #else #define kDefaultPort 8080 #endif #define kBonjourResolutionTimeout 5.0 NSString* const GCDWebServerOption_Port = @"Port"; NSString* const GCDWebServerOption_BonjourName = @"BonjourName"; NSString* const GCDWebServerOption_BonjourType = @"BonjourType"; NSString* const GCDWebServerOption_RequestNATPortMapping = @"RequestNATPortMapping"; NSString* const GCDWebServerOption_BindToLocalhost = @"BindToLocalhost"; NSString* const GCDWebServerOption_MaxPendingConnections = @"MaxPendingConnections"; NSString* const GCDWebServerOption_ServerName = @"ServerName"; NSString* const GCDWebServerOption_AuthenticationMethod = @"AuthenticationMethod"; NSString* const GCDWebServerOption_AuthenticationRealm = @"AuthenticationRealm"; NSString* const GCDWebServerOption_AuthenticationAccounts = @"AuthenticationAccounts"; NSString* const GCDWebServerOption_ConnectionClass = @"ConnectionClass"; NSString* const GCDWebServerOption_AutomaticallyMapHEADToGET = @"AutomaticallyMapHEADToGET"; NSString* const GCDWebServerOption_ConnectedStateCoalescingInterval = @"ConnectedStateCoalescingInterval"; NSString* const GCDWebServerOption_DispatchQueuePriority = @"DispatchQueuePriority"; #if TARGET_OS_IPHONE NSString* const GCDWebServerOption_AutomaticallySuspendInBackground = @"AutomaticallySuspendInBackground"; #endif NSString* const GCDWebServerAuthenticationMethod_Basic = @"Basic"; NSString* const GCDWebServerAuthenticationMethod_DigestAccess = @"DigestAccess"; #if defined(__GCDWEBSERVER_LOGGING_FACILITY_BUILTIN__) #if DEBUG GCDWebServerLoggingLevel GCDWebServerLogLevel = kGCDWebServerLoggingLevel_Debug; #else GCDWebServerLoggingLevel GCDWebServerLogLevel = kGCDWebServerLoggingLevel_Info; #endif #elif defined(__GCDWEBSERVER_LOGGING_FACILITY_COCOALUMBERJACK__) #if DEBUG DDLogLevel GCDWebServerLogLevel = DDLogLevelDebug; #else DDLogLevel GCDWebServerLogLevel = DDLogLevelInfo; #endif #endif #if !TARGET_OS_IPHONE static BOOL _run; #endif #ifdef __GCDWEBSERVER_LOGGING_FACILITY_BUILTIN__ void GCDWebServerLogMessage(GCDWebServerLoggingLevel level, NSString* format, ...) { static const char* levelNames[] = {"DEBUG", "VERBOSE", "INFO", "WARNING", "ERROR"}; static int enableLogging = -1; if (enableLogging < 0) { enableLogging = (isatty(STDERR_FILENO) ? 1 : 0); } if (enableLogging) { va_list arguments; va_start(arguments, format); NSString* message = [[NSString alloc] initWithFormat:format arguments:arguments]; va_end(arguments); fprintf(stderr, "[%s] %s\n", levelNames[level], [message UTF8String]); } } #endif #if !TARGET_OS_IPHONE static void _SignalHandler(int signal) { _run = NO; printf("\n"); } #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 application’s 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; GCDWebServerAsyncProcessBlock _asyncProcessBlock; } @end @implementation GCDWebServerHandler @synthesize matchBlock = _matchBlock, asyncProcessBlock = _asyncProcessBlock; - (id)initWithMatchBlock:(GCDWebServerMatchBlock)matchBlock asyncProcessBlock:(GCDWebServerAsyncProcessBlock)processBlock { if ((self = [super init])) { _matchBlock = [matchBlock copy]; _asyncProcessBlock = [processBlock copy]; } return self; } @end @interface GCDWebServer () { @private id __unsafe_unretained _delegate; dispatch_queue_t _syncQueue; dispatch_group_t _sourceGroup; NSMutableArray* _handlers; NSInteger _activeConnections; // Accessed through _syncQueue only BOOL _connected; // 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; dispatch_queue_priority_t _dispatchQueuePriority; NSUInteger _port; dispatch_source_t _source4; dispatch_source_t _source6; CFNetServiceRef _registrationService; CFNetServiceRef _resolutionService; DNSServiceRef _dnsService; CFSocketRef _dnsSocket; CFRunLoopSourceRef _dnsSource; NSString* _dnsAddress; NSUInteger _dnsPort; BOOL _bindToLocalhost; #if TARGET_OS_IPHONE BOOL _suspendInBackground; UIBackgroundTaskIdentifier _backgroundTask; #endif #ifdef __GCDWEBSERVER_ENABLE_TESTING__ BOOL _recording; #endif } @end @implementation GCDWebServer @synthesize delegate = _delegate, handlers = _handlers, port = _port, serverName = _serverName, authenticationRealm = _authenticationRealm, authenticationBasicAccounts = _authenticationBasicAccounts, authenticationDigestAccounts = _authenticationDigestAccounts, shouldAutomaticallyMapHEADToGET = _mapHEADToGET, dispatchQueuePriority = _dispatchQueuePriority; + (void)initialize { GCDWebServerInitializeFunctions(); } - (instancetype)init { if ((self = [super init])) { _syncQueue = dispatch_queue_create([NSStringFromClass([self class]) UTF8String], DISPATCH_QUEUE_SERIAL); _sourceGroup = dispatch_group_create(); _handlers = [[NSMutableArray alloc] init]; #if TARGET_OS_IPHONE _backgroundTask = UIBackgroundTaskInvalid; #endif } return self; } - (void)dealloc { GWS_DCHECK(_connected == NO); GWS_DCHECK(_activeConnections == 0); GWS_DCHECK(_options == nil); // The server can never be dealloc'ed while running because of the retain-cycle with the dispatch source GWS_DCHECK(_disconnectTimer == NULL); // The server can never be dealloc'ed while the disconnect timer is pending because of the retain-cycle #if !OS_OBJECT_USE_OBJC_RETAIN_RELEASE dispatch_release(_sourceGroup); dispatch_release(_syncQueue); #endif } #if TARGET_OS_IPHONE // Always called on main thread - (void)_startBackgroundTask { GWS_DCHECK([NSThread isMainThread]); if (_backgroundTask == UIBackgroundTaskInvalid) { GWS_LOG_DEBUG(@"Did start background task"); _backgroundTask = [[UIApplication sharedApplication] beginBackgroundTaskWithExpirationHandler:^{ GWS_LOG_WARNING(@"Application is being suspended while %@ is still connected", [self class]); [self _endBackgroundTask]; }]; } else { GWS_DNOT_REACHED(); } } #endif // Always called on main thread - (void)_didConnect { GWS_DCHECK([NSThread isMainThread]); GWS_DCHECK(_connected == NO); _connected = YES; GWS_LOG_DEBUG(@"Did connect"); #if TARGET_OS_IPHONE if ([[UIApplication sharedApplication] applicationState] != UIApplicationStateBackground) { [self _startBackgroundTask]; } #endif if ([_delegate respondsToSelector:@selector(webServerDidConnect:)]) { [_delegate webServerDidConnect:self]; } } - (void)willStartConnection:(GCDWebServerConnection*)connection { dispatch_sync(_syncQueue, ^{ GWS_DCHECK(_activeConnections >= 0); if (_activeConnections == 0) { dispatch_async(dispatch_get_main_queue(), ^{ if (_disconnectTimer) { CFRunLoopTimerInvalidate(_disconnectTimer); CFRelease(_disconnectTimer); _disconnectTimer = NULL; } if (_connected == NO) { [self _didConnect]; } }); } _activeConnections += 1; }); } #if TARGET_OS_IPHONE // Always called on main thread - (void)_endBackgroundTask { GWS_DCHECK([NSThread isMainThread]); if (_backgroundTask != UIBackgroundTaskInvalid) { if (_suspendInBackground && ([[UIApplication sharedApplication] applicationState] == UIApplicationStateBackground) && _source4) { [self _stop]; } [[UIApplication sharedApplication] endBackgroundTask:_backgroundTask]; _backgroundTask = UIBackgroundTaskInvalid; GWS_LOG_DEBUG(@"Did end background task"); } } #endif // Always called on main thread - (void)_didDisconnect { GWS_DCHECK([NSThread isMainThread]); GWS_DCHECK(_connected == YES); _connected = NO; GWS_LOG_DEBUG(@"Did disconnect"); #if TARGET_OS_IPHONE [self _endBackgroundTask]; #endif if ([_delegate respondsToSelector:@selector(webServerDidDisconnect:)]) { [_delegate webServerDidDisconnect:self]; } } - (void)didEndConnection:(GCDWebServerConnection*)connection { dispatch_sync(_syncQueue, ^{ GWS_DCHECK(_activeConnections > 0); _activeConnections -= 1; if (_activeConnections == 0) { dispatch_async(dispatch_get_main_queue(), ^{ if ((_disconnectDelay > 0.0) && (_source4 != NULL)) { if (_disconnectTimer) { CFRunLoopTimerInvalidate(_disconnectTimer); CFRelease(_disconnectTimer); } _disconnectTimer = CFRunLoopTimerCreateWithHandler(kCFAllocatorDefault, CFAbsoluteTimeGetCurrent() + _disconnectDelay, 0.0, 0, 0, ^(CFRunLoopTimerRef timer) { GWS_DCHECK([NSThread isMainThread]); [self _didDisconnect]; CFRelease(_disconnectTimer); _disconnectTimer = NULL; }); CFRunLoopAddTimer(CFRunLoopGetMain(), _disconnectTimer, kCFRunLoopCommonModes); } else { [self _didDisconnect]; } }); } }); } - (NSString*)bonjourName { CFStringRef name = _resolutionService ? CFNetServiceGetName(_resolutionService) : NULL; return name && CFStringGetLength(name) ? CFBridgingRelease(CFStringCreateCopy(kCFAllocatorDefault, name)) : nil; } - (NSString*)bonjourType { CFStringRef type = _resolutionService ? CFNetServiceGetType(_resolutionService) : NULL; return type && CFStringGetLength(type) ? CFBridgingRelease(CFStringCreateCopy(kCFAllocatorDefault, type)) : nil; } - (void)addHandlerWithMatchBlock:(GCDWebServerMatchBlock)matchBlock processBlock:(GCDWebServerProcessBlock)processBlock { [self addHandlerWithMatchBlock:matchBlock asyncProcessBlock:^(GCDWebServerRequest* request, GCDWebServerCompletionBlock completionBlock) { completionBlock(processBlock(request)); }]; } - (void)addHandlerWithMatchBlock:(GCDWebServerMatchBlock)matchBlock asyncProcessBlock:(GCDWebServerAsyncProcessBlock)processBlock { GWS_DCHECK(_options == nil); GCDWebServerHandler* handler = [[GCDWebServerHandler alloc] initWithMatchBlock:matchBlock asyncProcessBlock:processBlock]; [_handlers insertObject:handler atIndex:0]; } - (void)removeAllHandlers { GWS_DCHECK(_options == nil); [_handlers removeAllObjects]; } static void _NetServiceRegisterCallBack(CFNetServiceRef service, CFStreamError* error, void* info) { GWS_DCHECK([NSThread isMainThread]); @autoreleasepool { if (error->error) { GWS_LOG_ERROR(@"Bonjour registration error %i (domain %i)", (int)error->error, (int)error->domain); } else { GCDWebServer* server = (__bridge GCDWebServer*)info; GWS_LOG_VERBOSE(@"Bonjour registration complete for %@", [server class]); if (!CFNetServiceResolveWithTimeout(server->_resolutionService, kBonjourResolutionTimeout, NULL)) { GWS_LOG_ERROR(@"Failed starting Bonjour resolution"); GWS_DNOT_REACHED(); } } } } static void _NetServiceResolveCallBack(CFNetServiceRef service, CFStreamError* error, void* info) { GWS_DCHECK([NSThread isMainThread]); @autoreleasepool { if (error->error) { if ((error->domain != kCFStreamErrorDomainNetServices) && (error->error != kCFNetServicesErrorTimeout)) { GWS_LOG_ERROR(@"Bonjour resolution error %i (domain %i)", (int)error->error, (int)error->domain); } } else { GCDWebServer* server = (__bridge GCDWebServer*)info; GWS_LOG_INFO(@"%@ now locally reachable at %@", [server class], server.bonjourServerURL); if ([server.delegate respondsToSelector:@selector(webServerDidCompleteBonjourRegistration:)]) { [server.delegate webServerDidCompleteBonjourRegistration:server]; } } } } static void _DNSServiceCallBack(DNSServiceRef sdRef, DNSServiceFlags flags, uint32_t interfaceIndex, DNSServiceErrorType errorCode, uint32_t externalAddress, DNSServiceProtocol protocol, uint16_t internalPort, uint16_t externalPort, uint32_t ttl, void* context) { GWS_DCHECK([NSThread isMainThread]); @autoreleasepool { GCDWebServer* server = (__bridge GCDWebServer*)context; if ((errorCode == kDNSServiceErr_NoError) || (errorCode == kDNSServiceErr_DoubleNAT)) { struct sockaddr_in addr4; bzero(&addr4, sizeof(addr4)); addr4.sin_len = sizeof(addr4); addr4.sin_family = AF_INET; addr4.sin_addr.s_addr = externalAddress; // Already in network byte order server->_dnsAddress = GCDWebServerStringFromSockAddr((const struct sockaddr*)&addr4, NO); server->_dnsPort = ntohs(externalPort); GWS_LOG_INFO(@"%@ now publicly reachable at %@", [server class], server.publicServerURL); } else { GWS_LOG_ERROR(@"DNS service error %i", errorCode); server->_dnsAddress = nil; server->_dnsPort = 0; } if ([server.delegate respondsToSelector:@selector(webServerDidUpdateNATPortMapping:)]) { [server.delegate webServerDidUpdateNATPortMapping:server]; } } } static void _SocketCallBack(CFSocketRef s, CFSocketCallBackType type, CFDataRef address, const void* data, void* info) { GWS_DCHECK([NSThread isMainThread]); @autoreleasepool { GCDWebServer* server = (__bridge GCDWebServer*)info; DNSServiceErrorType status = DNSServiceProcessResult(server->_dnsService); if (status != kDNSServiceErr_NoError) { GWS_LOG_ERROR(@"DNS service error %i", status); } } } static inline id _GetOption(NSDictionary* options, NSString* key, id defaultValue) { id value = [options objectForKey:key]; return value ? value : defaultValue; } static inline NSString* _EncodeBase64(NSString* string) { NSData* data = [string dataUsingEncoding:NSUTF8StringEncoding]; #if (TARGET_OS_IPHONE && !(__IPHONE_OS_VERSION_MIN_REQUIRED >= __IPHONE_7_0)) || (!TARGET_OS_IPHONE && !(__MAC_OS_X_VERSION_MIN_REQUIRED >= __MAC_10_9)) if (![data respondsToSelector:@selector(base64EncodedDataWithOptions:)]) { return [data base64Encoding]; } #endif return [[NSString alloc] initWithData:[data base64EncodedDataWithOptions:0] encoding:NSASCIIStringEncoding]; } - (int)_createListeningSocket:(BOOL)useIPv6 localAddress:(const void*)address length:(socklen_t)length maxPendingConnections:(NSUInteger)maxPendingConnections error:(NSError**)error { int listeningSocket = socket(useIPv6 ? PF_INET6 : PF_INET, SOCK_STREAM, IPPROTO_TCP); if (listeningSocket > 0) { int yes = 1; setsockopt(listeningSocket, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(yes)); if (bind(listeningSocket, address, length) == 0) { if (listen(listeningSocket, (int)maxPendingConnections) == 0) { GWS_LOG_DEBUG(@"Did open %s listening socket %i", useIPv6 ? "IPv6" : "IPv4", listeningSocket); return listeningSocket; } else { if (error) { *error = GCDWebServerMakePosixError(errno); } GWS_LOG_ERROR(@"Failed starting %s listening socket: %s (%i)", useIPv6 ? "IPv6" : "IPv4", strerror(errno), errno); close(listeningSocket); } } else { if (error) { *error = GCDWebServerMakePosixError(errno); } GWS_LOG_ERROR(@"Failed binding %s listening socket: %s (%i)", useIPv6 ? "IPv6" : "IPv4", strerror(errno), errno); close(listeningSocket); } } else { if (error) { *error = GCDWebServerMakePosixError(errno); } GWS_LOG_ERROR(@"Failed creating %s listening socket: %s (%i)", useIPv6 ? "IPv6" : "IPv4", strerror(errno), errno); } return -1; } - (dispatch_source_t)_createDispatchSourceWithListeningSocket:(int)listeningSocket isIPv6:(BOOL)isIPv6 { dispatch_group_enter(_sourceGroup); dispatch_source_t source = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ, listeningSocket, 0, dispatch_get_global_queue(_dispatchQueuePriority, 0)); dispatch_source_set_cancel_handler(source, ^{ @autoreleasepool { int result = close(listeningSocket); if (result != 0) { GWS_LOG_ERROR(@"Failed closing %s listening socket: %s (%i)", isIPv6 ? "IPv6" : "IPv4", strerror(errno), errno); } else { GWS_LOG_DEBUG(@"Did close %s listening socket %i", isIPv6 ? "IPv6" : "IPv4", listeningSocket); } } dispatch_group_leave(_sourceGroup); }); dispatch_source_set_event_handler(source, ^{ @autoreleasepool { struct sockaddr_storage remoteSockAddr; socklen_t remoteAddrLen = sizeof(remoteSockAddr); int socket = accept(listeningSocket, (struct sockaddr*)&remoteSockAddr, &remoteAddrLen); if (socket > 0) { NSData* remoteAddress = [NSData dataWithBytes:&remoteSockAddr length:remoteAddrLen]; struct sockaddr_storage localSockAddr; socklen_t localAddrLen = sizeof(localSockAddr); NSData* localAddress = nil; if (getsockname(socket, (struct sockaddr*)&localSockAddr, &localAddrLen) == 0) { localAddress = [NSData dataWithBytes:&localSockAddr length:localAddrLen]; GWS_DCHECK((!isIPv6 && localSockAddr.ss_family == AF_INET) || (isIPv6 && localSockAddr.ss_family == AF_INET6)); } else { GWS_DNOT_REACHED(); } int noSigPipe = 1; setsockopt(socket, SOL_SOCKET, SO_NOSIGPIPE, &noSigPipe, sizeof(noSigPipe)); // Make sure this socket cannot generate SIG_PIPE GCDWebServerConnection* connection = [[_connectionClass alloc] initWithServer:self localAddress:localAddress remoteAddress:remoteAddress socket:socket]; // Connection will automatically retain itself while opened [connection self]; // Prevent compiler from complaining about unused variable / useless statement } else { GWS_LOG_ERROR(@"Failed accepting %s socket: %s (%i)", isIPv6 ? "IPv6" : "IPv4", strerror(errno), errno); } } }); return source; } - (BOOL)_start:(NSError**)error { GWS_DCHECK(_source4 == NULL); NSUInteger port = [_GetOption(_options, GCDWebServerOption_Port, @0) unsignedIntegerValue]; BOOL bindToLocalhost = [_GetOption(_options, GCDWebServerOption_BindToLocalhost, @NO) boolValue]; NSUInteger maxPendingConnections = [_GetOption(_options, GCDWebServerOption_MaxPendingConnections, @16) unsignedIntegerValue]; struct sockaddr_in addr4; bzero(&addr4, sizeof(addr4)); addr4.sin_len = sizeof(addr4); addr4.sin_family = AF_INET; addr4.sin_port = htons(port); addr4.sin_addr.s_addr = bindToLocalhost ? htonl(INADDR_LOOPBACK) : htonl(INADDR_ANY); int listeningSocket4 = [self _createListeningSocket:NO localAddress:&addr4 length:sizeof(addr4) maxPendingConnections:maxPendingConnections error:error]; if (listeningSocket4 <= 0) { return NO; } if (port == 0) { struct sockaddr_in addr; socklen_t addrlen = sizeof(addr); if (getsockname(listeningSocket4, (struct sockaddr*)&addr, &addrlen) == 0) { port = ntohs(addr.sin_port); } else { GWS_LOG_ERROR(@"Failed retrieving socket address: %s (%i)", strerror(errno), errno); } } struct sockaddr_in6 addr6; bzero(&addr6, sizeof(addr6)); addr6.sin6_len = sizeof(addr6); addr6.sin6_family = AF_INET6; addr6.sin6_port = htons(port); addr6.sin6_addr = bindToLocalhost ? in6addr_loopback : in6addr_any; int listeningSocket6 = [self _createListeningSocket:YES localAddress:&addr6 length:sizeof(addr6) maxPendingConnections:maxPendingConnections error:error]; if (listeningSocket6 <= 0) { close(listeningSocket4); return NO; } _serverName = [_GetOption(_options, GCDWebServerOption_ServerName, NSStringFromClass([self class])) copy]; NSString* authenticationMethod = _GetOption(_options, GCDWebServerOption_AuthenticationMethod, nil); if ([authenticationMethod isEqualToString:GCDWebServerAuthenticationMethod_Basic]) { _authenticationRealm = [_GetOption(_options, GCDWebServerOption_AuthenticationRealm, _serverName) copy]; _authenticationBasicAccounts = [[NSMutableDictionary alloc] init]; NSDictionary* accounts = _GetOption(_options, GCDWebServerOption_AuthenticationAccounts, @{}); [accounts enumerateKeysAndObjectsUsingBlock:^(NSString* username, NSString* password, BOOL* stop) { [_authenticationBasicAccounts setObject:_EncodeBase64([NSString stringWithFormat:@"%@:%@", username, password]) forKey:username]; }]; } else if ([authenticationMethod isEqualToString:GCDWebServerAuthenticationMethod_DigestAccess]) { _authenticationRealm = [_GetOption(_options, GCDWebServerOption_AuthenticationRealm, _serverName) copy]; _authenticationDigestAccounts = [[NSMutableDictionary alloc] init]; NSDictionary* accounts = _GetOption(_options, GCDWebServerOption_AuthenticationAccounts, @{}); [accounts enumerateKeysAndObjectsUsingBlock:^(NSString* username, NSString* password, BOOL* stop) { [_authenticationDigestAccounts setObject:GCDWebServerComputeMD5Digest(@"%@:%@:%@", username, _authenticationRealm, password) forKey:username]; }]; } _connectionClass = _GetOption(_options, GCDWebServerOption_ConnectionClass, [GCDWebServerConnection class]); _mapHEADToGET = [_GetOption(_options, GCDWebServerOption_AutomaticallyMapHEADToGET, @YES) boolValue]; _disconnectDelay = [_GetOption(_options, GCDWebServerOption_ConnectedStateCoalescingInterval, @1.0) doubleValue]; _dispatchQueuePriority = [_GetOption(_options, GCDWebServerOption_DispatchQueuePriority, @(DISPATCH_QUEUE_PRIORITY_DEFAULT)) longValue]; _source4 = [self _createDispatchSourceWithListeningSocket:listeningSocket4 isIPv6:NO]; _source6 = [self _createDispatchSourceWithListeningSocket:listeningSocket6 isIPv6:YES]; _port = port; _bindToLocalhost = bindToLocalhost; NSString* bonjourName = _GetOption(_options, GCDWebServerOption_BonjourName, nil); NSString* bonjourType = _GetOption(_options, GCDWebServerOption_BonjourType, @"_http._tcp"); if (bonjourName) { _registrationService = CFNetServiceCreate(kCFAllocatorDefault, CFSTR("local."), (__bridge CFStringRef)bonjourType, (__bridge CFStringRef)(bonjourName.length ? bonjourName : _serverName), (SInt32)_port); if (_registrationService) { CFNetServiceClientContext context = {0, (__bridge void*)self, NULL, NULL, NULL}; CFNetServiceSetClient(_registrationService, _NetServiceRegisterCallBack, &context); CFNetServiceScheduleWithRunLoop(_registrationService, CFRunLoopGetMain(), kCFRunLoopCommonModes); CFStreamError streamError = {0}; CFNetServiceRegisterWithOptions(_registrationService, 0, &streamError); _resolutionService = CFNetServiceCreateCopy(kCFAllocatorDefault, _registrationService); if (_resolutionService) { CFNetServiceSetClient(_resolutionService, _NetServiceResolveCallBack, &context); CFNetServiceScheduleWithRunLoop(_resolutionService, CFRunLoopGetMain(), kCFRunLoopCommonModes); } else { GWS_LOG_ERROR(@"Failed creating CFNetService for resolution"); } } else { GWS_LOG_ERROR(@"Failed creating CFNetService for registration"); } } if ([_GetOption(_options, GCDWebServerOption_RequestNATPortMapping, @NO) boolValue]) { DNSServiceErrorType status = DNSServiceNATPortMappingCreate(&_dnsService, 0, 0, kDNSServiceProtocol_TCP, htons(port), htons(port), 0, _DNSServiceCallBack, (__bridge void*)self); if (status == kDNSServiceErr_NoError) { CFSocketContext context = {0, (__bridge void*)self, NULL, NULL, NULL}; _dnsSocket = CFSocketCreateWithNative(kCFAllocatorDefault, DNSServiceRefSockFD(_dnsService), kCFSocketReadCallBack, _SocketCallBack, &context); if (_dnsSocket) { CFSocketSetSocketFlags(_dnsSocket, CFSocketGetSocketFlags(_dnsSocket) & ~kCFSocketCloseOnInvalidate); _dnsSource = CFSocketCreateRunLoopSource(kCFAllocatorDefault, _dnsSocket, 0); if (_dnsSource) { CFRunLoopAddSource(CFRunLoopGetMain(), _dnsSource, kCFRunLoopCommonModes); } else { GWS_LOG_ERROR(@"Failed creating CFRunLoopSource"); GWS_DNOT_REACHED(); } } else { GWS_LOG_ERROR(@"Failed creating CFSocket"); GWS_DNOT_REACHED(); } } else { GWS_LOG_ERROR(@"Failed creating NAT port mapping (%i)", status); } } dispatch_resume(_source4); dispatch_resume(_source6); GWS_LOG_INFO(@"%@ started on port %i and reachable at %@", [self class], (int)_port, self.serverURL); if ([_delegate respondsToSelector:@selector(webServerDidStart:)]) { dispatch_async(dispatch_get_main_queue(), ^{ [_delegate webServerDidStart:self]; }); } return YES; } - (void)_stop { GWS_DCHECK(_source4 != NULL); if (_dnsService) { _dnsAddress = nil; _dnsPort = 0; if (_dnsSource) { CFRunLoopSourceInvalidate(_dnsSource); CFRelease(_dnsSource); _dnsSource = NULL; } if (_dnsSocket) { CFRelease(_dnsSocket); _dnsSocket = NULL; } DNSServiceRefDeallocate(_dnsService); _dnsService = NULL; } if (_registrationService) { if (_resolutionService) { CFNetServiceUnscheduleFromRunLoop(_resolutionService, CFRunLoopGetMain(), kCFRunLoopCommonModes); CFNetServiceSetClient(_resolutionService, NULL, NULL); CFNetServiceCancel(_resolutionService); CFRelease(_resolutionService); _resolutionService = NULL; } CFNetServiceUnscheduleFromRunLoop(_registrationService, CFRunLoopGetMain(), kCFRunLoopCommonModes); CFNetServiceSetClient(_registrationService, NULL, NULL); CFNetServiceCancel(_registrationService); CFRelease(_registrationService); _registrationService = NULL; } dispatch_source_cancel(_source6); dispatch_source_cancel(_source4); dispatch_group_wait(_sourceGroup, DISPATCH_TIME_FOREVER); // Wait until the cancellation handlers have been called which guarantees the listening sockets are closed #if !OS_OBJECT_USE_OBJC_RETAIN_RELEASE dispatch_release(_source6); #endif _source6 = NULL; #if !OS_OBJECT_USE_OBJC_RETAIN_RELEASE dispatch_release(_source4); #endif _source4 = NULL; _port = 0; _bindToLocalhost = NO; _serverName = nil; _authenticationRealm = nil; _authenticationBasicAccounts = nil; _authenticationDigestAccounts = nil; dispatch_async(dispatch_get_main_queue(), ^{ if (_disconnectTimer) { CFRunLoopTimerInvalidate(_disconnectTimer); CFRelease(_disconnectTimer); _disconnectTimer = NULL; [self _didDisconnect]; } }); GWS_LOG_INFO(@"%@ stopped", [self class]); if ([_delegate respondsToSelector:@selector(webServerDidStop:)]) { dispatch_async(dispatch_get_main_queue(), ^{ [_delegate webServerDidStop:self]; }); } } #if TARGET_OS_IPHONE - (void)_didEnterBackground:(NSNotification*)notification { GWS_DCHECK([NSThread isMainThread]); GWS_LOG_DEBUG(@"Did enter background"); if ((_backgroundTask == UIBackgroundTaskInvalid) && _source4) { [self _stop]; } } - (void)_willEnterForeground:(NSNotification*)notification { GWS_DCHECK([NSThread isMainThread]); GWS_LOG_DEBUG(@"Will enter foreground"); if (!_source4) { [self _start:NULL]; // TODO: There's probably nothing we can do on failure } } #endif - (BOOL)startWithOptions:(NSDictionary*)options error:(NSError**)error { if (_options == nil) { _options = options ? [options copy] : @{}; #if TARGET_OS_IPHONE _suspendInBackground = [_GetOption(_options, GCDWebServerOption_AutomaticallySuspendInBackground, @YES) boolValue]; if (((_suspendInBackground == NO) || ([[UIApplication sharedApplication] applicationState] != UIApplicationStateBackground)) && ![self _start:error]) #else if (![self _start:error]) #endif { _options = nil; return NO; } #if TARGET_OS_IPHONE if (_suspendInBackground) { [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(_didEnterBackground:) name:UIApplicationDidEnterBackgroundNotification object:nil]; [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(_willEnterForeground:) name:UIApplicationWillEnterForegroundNotification object:nil]; } #endif return YES; } else { GWS_DNOT_REACHED(); } return NO; } - (BOOL)isRunning { return (_options ? YES : NO); } - (void)stop { if (_options) { #if TARGET_OS_IPHONE if (_suspendInBackground) { [[NSNotificationCenter defaultCenter] removeObserver:self name:UIApplicationDidEnterBackgroundNotification object:nil]; [[NSNotificationCenter defaultCenter] removeObserver:self name:UIApplicationWillEnterForegroundNotification object:nil]; } #endif if (_source4) { [self _stop]; } _options = nil; } else { GWS_DNOT_REACHED(); } } @end @implementation GCDWebServer (Extensions) - (NSURL*)serverURL { if (_source4) { NSString* ipAddress = _bindToLocalhost ? @"localhost" : GCDWebServerGetPrimaryIPAddress(NO); // We can't really use IPv6 anyway as it doesn't work great with HTTP URLs in practice if (ipAddress) { if (_port != 80) { return [NSURL URLWithString:[NSString stringWithFormat:@"http://%@:%i/", ipAddress, (int)_port]]; } else { return [NSURL URLWithString:[NSString stringWithFormat:@"http://%@/", ipAddress]]; } } } return nil; } - (NSURL*)bonjourServerURL { if (_source4 && _resolutionService) { NSString* name = (__bridge NSString*)CFNetServiceGetTargetHost(_resolutionService); if (name.length) { name = [name substringToIndex:(name.length - 1)]; // Strip trailing period at end of domain if (_port != 80) { return [NSURL URLWithString:[NSString stringWithFormat:@"http://%@:%i/", name, (int)_port]]; } else { return [NSURL URLWithString:[NSString stringWithFormat:@"http://%@/", name]]; } } } return nil; } - (NSURL*)publicServerURL { if (_source4 && _dnsService && _dnsAddress && _dnsPort) { if (_dnsPort != 80) { return [NSURL URLWithString:[NSString stringWithFormat:@"http://%@:%i/", _dnsAddress, (int)_dnsPort]]; } else { return [NSURL URLWithString:[NSString stringWithFormat:@"http://%@/", _dnsAddress]]; } } 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 - (BOOL)runWithPort:(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 runWithOptions:options error:NULL]; } - (BOOL)runWithOptions:(NSDictionary*)options error:(NSError**)error { GWS_DCHECK([NSThread isMainThread]); BOOL success = NO; _run = YES; void (*termHandler)(int) = signal(SIGTERM, _SignalHandler); void (*intHandler)(int) = signal(SIGINT, _SignalHandler); if ((termHandler != SIG_ERR) && (intHandler != SIG_ERR)) { if ([self startWithOptions:options error:error]) { while (_run) { CFRunLoopRunInMode(kCFRunLoopDefaultMode, 1.0, true); } [self stop]; success = YES; } _ExecuteMainThreadRunLoopSources(); signal(SIGINT, intHandler); signal(SIGTERM, termHandler); } return success; } #endif @end @implementation GCDWebServer (Handlers) - (void)addDefaultHandlerForMethod:(NSString*)method requestClass:(Class)aClass processBlock:(GCDWebServerProcessBlock)block { [self addDefaultHandlerForMethod:method requestClass:aClass asyncProcessBlock:^(GCDWebServerRequest* request, GCDWebServerCompletionBlock completionBlock) { completionBlock(block(request)); }]; } - (void)addDefaultHandlerForMethod:(NSString*)method requestClass:(Class)aClass asyncProcessBlock:(GCDWebServerAsyncProcessBlock)block { [self addHandlerWithMatchBlock:^GCDWebServerRequest*(NSString* requestMethod, NSURL* requestURL, NSDictionary* requestHeaders, NSString* urlPath, NSDictionary* urlQuery) { if (![requestMethod isEqualToString:method]) { return nil; } return [[aClass alloc] initWithMethod:requestMethod url:requestURL headers:requestHeaders path:urlPath query:urlQuery]; } asyncProcessBlock:block]; } - (void)addHandlerForMethod:(NSString*)method path:(NSString*)path requestClass:(Class)aClass processBlock:(GCDWebServerProcessBlock)block { [self addHandlerForMethod:method path:path requestClass:aClass asyncProcessBlock:^(GCDWebServerRequest* request, GCDWebServerCompletionBlock completionBlock) { completionBlock(block(request)); }]; } - (void)addHandlerForMethod:(NSString*)method path:(NSString*)path requestClass:(Class)aClass asyncProcessBlock:(GCDWebServerAsyncProcessBlock)block { if ([path hasPrefix:@"/"] && [aClass isSubclassOfClass:[GCDWebServerRequest class]]) { [self addHandlerWithMatchBlock:^GCDWebServerRequest*(NSString* requestMethod, NSURL* requestURL, NSDictionary* requestHeaders, NSString* urlPath, NSDictionary* urlQuery) { if (![requestMethod isEqualToString:method]) { return nil; } if ([urlPath caseInsensitiveCompare:path] != NSOrderedSame) { return nil; } return [[aClass alloc] initWithMethod:requestMethod url:requestURL headers:requestHeaders path:urlPath query:urlQuery]; } asyncProcessBlock:block]; } else { GWS_DNOT_REACHED(); } } - (void)addHandlerForMethod:(NSString*)method pathRegex:(NSString*)regex requestClass:(Class)aClass processBlock:(GCDWebServerProcessBlock)block { [self addHandlerForMethod:method pathRegex:regex requestClass:aClass asyncProcessBlock:^(GCDWebServerRequest* request, GCDWebServerCompletionBlock completionBlock) { completionBlock(block(request)); }]; } - (void)addHandlerForMethod:(NSString*)method pathRegex:(NSString*)regex requestClass:(Class)aClass asyncProcessBlock:(GCDWebServerAsyncProcessBlock)block { NSRegularExpression* expression = [NSRegularExpression regularExpressionWithPattern:regex options:NSRegularExpressionCaseInsensitive error:NULL]; if (expression && [aClass isSubclassOfClass:[GCDWebServerRequest class]]) { [self addHandlerWithMatchBlock:^GCDWebServerRequest*(NSString* requestMethod, NSURL* requestURL, NSDictionary* requestHeaders, NSString* urlPath, NSDictionary* urlQuery) { if (![requestMethod isEqualToString:method]) { return nil; } NSArray* matches = [expression matchesInString:urlPath options:0 range:NSMakeRange(0, urlPath.length)]; if (matches.count == 0) { return nil; } NSMutableArray* captures = [NSMutableArray array]; for (NSTextCheckingResult* result in matches) { // Start at 1; index 0 is the whole string for (NSUInteger i = 1; i < result.numberOfRanges; i++) { NSRange range = [result rangeAtIndex:i]; // range is {NSNotFound, 0} "if one of the capture groups did not participate in this particular match" // see discussion in -[NSRegularExpression firstMatchInString:options:range:] if (range.location != NSNotFound) { [captures addObject:[urlPath substringWithRange:range]]; } } } GCDWebServerRequest* request = [[aClass alloc] initWithMethod:requestMethod url:requestURL headers:requestHeaders path:urlPath query:urlQuery]; [request setAttribute:captures forKey:GCDWebServerRequestAttribute_RegexCaptures]; return request; } asyncProcessBlock:block]; } else { GWS_DNOT_REACHED(); } } @end @implementation GCDWebServer (GETHandlers) - (void)addGETHandlerForPath:(NSString*)path staticData:(NSData*)staticData contentType:(NSString*)contentType cacheAge:(NSUInteger)cacheAge { [self addHandlerForMethod:@"GET" path:path requestClass:[GCDWebServerRequest class] processBlock:^GCDWebServerResponse*(GCDWebServerRequest* request) { GCDWebServerResponse* response = [GCDWebServerDataResponse responseWithData:staticData contentType:contentType]; response.cacheControlMaxAge = cacheAge; return response; }]; } - (void)addGETHandlerForPath:(NSString*)path filePath:(NSString*)filePath isAttachment:(BOOL)isAttachment cacheAge:(NSUInteger)cacheAge allowRangeRequests:(BOOL)allowRangeRequests { [self addHandlerForMethod:@"GET" path:path requestClass:[GCDWebServerRequest class] processBlock:^GCDWebServerResponse*(GCDWebServerRequest* request) { GCDWebServerResponse* response = nil; if (allowRangeRequests) { response = [GCDWebServerFileResponse responseWithFile:filePath byteRange:request.byteRange isAttachment:isAttachment]; [response setValue:@"bytes" forAdditionalHeader:@"Accept-Ranges"]; } else { response = [GCDWebServerFileResponse responseWithFile:filePath isAttachment:isAttachment]; } response.cacheControlMaxAge = cacheAge; return response; }]; } - (GCDWebServerResponse*)_responseWithContentsOfDirectory:(NSString*)path { NSDirectoryEnumerator* enumerator = [[NSFileManager defaultManager] enumeratorAtPath:path]; if (enumerator == nil) { return nil; } NSMutableString* html = [NSMutableString string]; [html appendString:@"\n"]; [html appendString:@"\n"]; [html appendString:@"\n"]; return [GCDWebServerDataResponse responseWithHTML:html]; } - (void)addGETHandlerForBasePath:(NSString*)basePath directoryPath:(NSString*)directoryPath indexFilename:(NSString*)indexFilename cacheAge:(NSUInteger)cacheAge allowRangeRequests:(BOOL)allowRangeRequests { if ([basePath hasPrefix:@"/"] && [basePath hasSuffix:@"/"]) { GCDWebServer* __unsafe_unretained server = self; [self addHandlerWithMatchBlock:^GCDWebServerRequest*(NSString* requestMethod, NSURL* requestURL, NSDictionary* requestHeaders, NSString* urlPath, NSDictionary* urlQuery) { if (![requestMethod isEqualToString:@"GET"]) { return nil; } if (![urlPath hasPrefix:basePath]) { return nil; } return [[GCDWebServerRequest alloc] initWithMethod:requestMethod url:requestURL headers:requestHeaders path:urlPath query:urlQuery]; } processBlock:^GCDWebServerResponse*(GCDWebServerRequest* request) { GCDWebServerResponse* response = nil; NSString* filePath = [directoryPath stringByAppendingPathComponent:[request.path substringFromIndex:basePath.length]]; NSString* fileType = [[[NSFileManager defaultManager] attributesOfItemAtPath:filePath error:NULL] fileType]; if (fileType) { if ([fileType isEqualToString:NSFileTypeDirectory]) { if (indexFilename) { NSString* indexPath = [filePath stringByAppendingPathComponent:indexFilename]; NSString* indexType = [[[NSFileManager defaultManager] attributesOfItemAtPath:indexPath error:NULL] fileType]; if ([indexType isEqualToString:NSFileTypeRegular]) { return [GCDWebServerFileResponse responseWithFile:indexPath]; } } response = [server _responseWithContentsOfDirectory:filePath]; } else if ([fileType isEqualToString:NSFileTypeRegular]) { if (allowRangeRequests) { response = [GCDWebServerFileResponse responseWithFile:filePath byteRange:request.byteRange]; [response setValue:@"bytes" forAdditionalHeader:@"Accept-Ranges"]; } else { response = [GCDWebServerFileResponse responseWithFile:filePath]; } } } if (response) { response.cacheControlMaxAge = cacheAge; } else { response = [GCDWebServerResponse responseWithStatusCode:kGCDWebServerHTTPStatusCode_NotFound]; } [response setValue:@"*" forAdditionalHeader:@"Access-Control-Allow-Origin"]; return response; }]; } else { GWS_DNOT_REACHED(); } } @end @implementation GCDWebServer (Logging) + (void)setLogLevel:(int)level { #if defined(__GCDWEBSERVER_LOGGING_FACILITY_XLFACILITY__) [XLSharedFacility setMinLogLevel:level]; #elif defined(__GCDWEBSERVER_LOGGING_FACILITY_COCOALUMBERJACK__) GCDWebServerLogLevel = level; #elif defined(__GCDWEBSERVER_LOGGING_FACILITY_BUILTIN__) GCDWebServerLogLevel = level; #endif } - (void)logVerbose:(NSString*)format, ... { va_list arguments; va_start(arguments, format); GWS_LOG_VERBOSE(@"%@", [[NSString alloc] initWithFormat:format arguments:arguments]); va_end(arguments); } - (void)logInfo:(NSString*)format, ... { va_list arguments; va_start(arguments, format); GWS_LOG_INFO(@"%@", [[NSString alloc] initWithFormat:format arguments:arguments]); va_end(arguments); } - (void)logWarning:(NSString*)format, ... { va_list arguments; va_start(arguments, format); GWS_LOG_WARNING(@"%@", [[NSString alloc] initWithFormat:format arguments:arguments]); va_end(arguments); } - (void)logError:(NSString*)format, ... { va_list arguments; va_start(arguments, format); GWS_LOG_ERROR(@"%@", [[NSString alloc] initWithFormat:format arguments:arguments]); va_end(arguments); } @end #ifdef __GCDWEBSERVER_ENABLE_TESTING__ @implementation GCDWebServer (Testing) - (void)setRecordingEnabled:(BOOL)flag { _recording = flag; } - (BOOL)isRecordingEnabled { return _recording; } static CFHTTPMessageRef _CreateHTTPMessageFromData(NSData* data, BOOL isRequest) { CFHTTPMessageRef message = CFHTTPMessageCreateEmpty(kCFAllocatorDefault, isRequest); if (CFHTTPMessageAppendBytes(message, data.bytes, data.length)) { return message; } CFRelease(message); return NULL; } static CFHTTPMessageRef _CreateHTTPMessageFromPerformingRequest(NSData* inData, NSUInteger port) { CFHTTPMessageRef response = NULL; int httpSocket = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP); if (httpSocket > 0) { struct sockaddr_in addr4; bzero(&addr4, sizeof(addr4)); addr4.sin_len = sizeof(port); addr4.sin_family = AF_INET; addr4.sin_port = htons(8080); addr4.sin_addr.s_addr = htonl(INADDR_ANY); if (connect(httpSocket, (void*)&addr4, sizeof(addr4)) == 0) { if (write(httpSocket, inData.bytes, inData.length) == (ssize_t)inData.length) { NSMutableData* outData = [[NSMutableData alloc] initWithLength:(256 * 1024)]; NSUInteger length = 0; while (1) { ssize_t result = read(httpSocket, (char*)outData.mutableBytes + length, outData.length - length); if (result < 0) { length = NSUIntegerMax; break; } else if (result == 0) { break; } length += result; if (length >= outData.length) { outData.length = 2 * outData.length; } } if (length != NSUIntegerMax) { outData.length = length; response = _CreateHTTPMessageFromData(outData, NO); } else { GWS_DNOT_REACHED(); } } } close(httpSocket); } return response; } static void _LogResult(NSString* format, ...) { va_list arguments; va_start(arguments, format); NSString* message = [[NSString alloc] initWithFormat:format arguments:arguments]; va_end(arguments); fprintf(stdout, "%s\n", [message UTF8String]); } - (NSInteger)runTestsWithOptions:(NSDictionary*)options inDirectory:(NSString*)path { GWS_DCHECK([NSThread isMainThread]); NSArray* ignoredHeaders = @[ @"Date", @"Etag" ]; // Dates are always different by definition and ETags depend on file system node IDs NSInteger result = -1; if ([self startWithOptions:options error:NULL]) { _ExecuteMainThreadRunLoopSources(); result = 0; NSArray* files = [[NSFileManager defaultManager] contentsOfDirectoryAtPath:path error:NULL]; for (NSString* requestFile in files) { if (![requestFile hasSuffix:@".request"]) { continue; } @autoreleasepool { NSString* index = [[requestFile componentsSeparatedByString:@"-"] firstObject]; BOOL success = NO; NSData* requestData = [NSData dataWithContentsOfFile:[path stringByAppendingPathComponent:requestFile]]; if (requestData) { CFHTTPMessageRef request = _CreateHTTPMessageFromData(requestData, YES); if (request) { NSString* requestMethod = CFBridgingRelease(CFHTTPMessageCopyRequestMethod(request)); NSURL* requestURL = CFBridgingRelease(CFHTTPMessageCopyRequestURL(request)); _LogResult(@"[%i] %@ %@", (int)[index integerValue], requestMethod, requestURL.path); NSString* prefix = [index stringByAppendingString:@"-"]; for (NSString* responseFile in files) { if ([responseFile hasPrefix:prefix] && [responseFile hasSuffix:@".response"]) { NSData* responseData = [NSData dataWithContentsOfFile:[path stringByAppendingPathComponent:responseFile]]; if (responseData) { CFHTTPMessageRef expectedResponse = _CreateHTTPMessageFromData(responseData, NO); if (expectedResponse) { CFHTTPMessageRef actualResponse = _CreateHTTPMessageFromPerformingRequest(requestData, self.port); if (actualResponse) { success = YES; CFIndex expectedStatusCode = CFHTTPMessageGetResponseStatusCode(expectedResponse); CFIndex actualStatusCode = CFHTTPMessageGetResponseStatusCode(actualResponse); if (actualStatusCode != expectedStatusCode) { _LogResult(@" Status code not matching:\n Expected: %i\n Actual: %i", (int)expectedStatusCode, (int)actualStatusCode); success = NO; } NSDictionary* expectedHeaders = CFBridgingRelease(CFHTTPMessageCopyAllHeaderFields(expectedResponse)); NSDictionary* actualHeaders = CFBridgingRelease(CFHTTPMessageCopyAllHeaderFields(actualResponse)); for (NSString* expectedHeader in expectedHeaders) { if ([ignoredHeaders containsObject:expectedHeader]) { continue; } NSString* expectedValue = [expectedHeaders objectForKey:expectedHeader]; NSString* actualValue = [actualHeaders objectForKey:expectedHeader]; if (![actualValue isEqualToString:expectedValue]) { _LogResult(@" Header '%@' not matching:\n Expected: \"%@\"\n Actual: \"%@\"", expectedHeader, expectedValue, actualValue); success = NO; } } for (NSString* actualHeader in actualHeaders) { if (![expectedHeaders objectForKey:actualHeader]) { _LogResult(@" Header '%@' not matching:\n Expected: \"%@\"\n Actual: \"%@\"", actualHeader, nil, [actualHeaders objectForKey:actualHeader]); success = NO; } } NSString* expectedContentLength = CFBridgingRelease(CFHTTPMessageCopyHeaderFieldValue(expectedResponse, CFSTR("Content-Length"))); NSData* expectedBody = CFBridgingRelease(CFHTTPMessageCopyBody(expectedResponse)); NSString* actualContentLength = CFBridgingRelease(CFHTTPMessageCopyHeaderFieldValue(actualResponse, CFSTR("Content-Length"))); NSData* actualBody = CFBridgingRelease(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]) { _LogResult(@" Bodies not matching:\n Expected: %lu bytes\n Actual: %lu bytes", (unsigned long)expectedBody.length, (unsigned long)actualBody.length); success = NO; #if !TARGET_OS_IPHONE #if DEBUG if (GCDWebServerIsTextContentType([expectedHeaders objectForKey:@"Content-Type"])) { NSString* expectedPath = [NSTemporaryDirectory() stringByAppendingPathComponent:[[[NSProcessInfo processInfo] globallyUniqueString] stringByAppendingPathExtension:@"txt"]]; NSString* actualPath = [NSTemporaryDirectory() stringByAppendingPathComponent:[[[NSProcessInfo processInfo] globallyUniqueString] stringByAppendingPathExtension:@"txt"]]; if ([expectedBody writeToFile:expectedPath atomically:YES] && [actualBody writeToFile:actualPath atomically:YES]) { NSTask* task = [[NSTask alloc] init]; [task setLaunchPath:@"/usr/bin/opendiff"]; [task setArguments:@[ expectedPath, actualPath ]]; [task launch]; } } #endif #endif } CFRelease(actualResponse); } CFRelease(expectedResponse); } } else { GWS_DNOT_REACHED(); } break; } } CFRelease(request); } } else { GWS_DNOT_REACHED(); } _LogResult(@""); if (!success) { ++result; } } _ExecuteMainThreadRunLoopSources(); } [self stop]; _ExecuteMainThreadRunLoopSources(); } return result; } @end #endif ================================================ FILE: src/ios/GCDWebServer/Core/GCDWebServerConnection.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import "GCDWebServer.h" @class GCDWebServerHandler; /** * The GCDWebServerConnection class is instantiated by GCDWebServer to handle * each new HTTP connection. Each instance stays alive until the connection is * closed. * * You cannot use this class directly, but it is made public so you can * subclass it to override some hooks. Use the GCDWebServerOption_ConnectionClass * option for GCDWebServer to install your custom subclass. * * @warning The GCDWebServerConnection retains the GCDWebServer until the * connection is closed. */ @interface GCDWebServerConnection : NSObject /** * Returns the GCDWebServer that owns the connection. */ @property(nonatomic, readonly) GCDWebServer* server; /** * Returns YES if the connection is using IPv6. */ @property(nonatomic, readonly, getter=isUsingIPv6) BOOL usingIPv6; /** * Returns the address of the local peer (i.e. server) of the connection * as a raw "struct sockaddr". */ @property(nonatomic, readonly) NSData* localAddressData; /** * Returns the address of the local peer (i.e. server) of the connection * as a string. */ @property(nonatomic, readonly) NSString* localAddressString; /** * Returns the address of the remote peer (i.e. client) of the connection * as a raw "struct sockaddr". */ @property(nonatomic, readonly) NSData* remoteAddressData; /** * Returns the address of the remote peer (i.e. client) of the connection * as a string. */ @property(nonatomic, readonly) NSString* remoteAddressString; /** * Returns the total number of bytes received from the remote peer (i.e. client) * so far. */ @property(nonatomic, readonly) NSUInteger totalBytesRead; /** * Returns the total number of bytes sent to the remote peer (i.e. client) so far. */ @property(nonatomic, readonly) NSUInteger totalBytesWritten; @end /** * Hooks to customize the behavior of GCDWebServer HTTP connections. * * @warning These methods can be called on any GCD thread. * Be sure to also call "super" when overriding them. */ @interface GCDWebServerConnection (Subclassing) /** * This method is called when the connection is opened. * * Return NO to reject the connection e.g. after validating the local * or remote address. */ - (BOOL)open; /** * This method is called whenever data has been received * from the remote peer (i.e. client). * * @warning Do not attempt to modify this data. */ - (void)didReadBytes:(const void*)bytes length:(NSUInteger)length; /** * This method is called whenever data has been sent * to the remote peer (i.e. client). * * @warning Do not attempt to modify this data. */ - (void)didWriteBytes:(const void*)bytes length:(NSUInteger)length; /** * 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. * * Return a non-nil GCDWebServerResponse to bypass the request processing entirely. * * The default implementation checks for HTTP authentication if applicable * and returns a barebone 401 status code response if authentication failed. */ - (GCDWebServerResponse*)preflightRequest:(GCDWebServerRequest*)request; /** * Assuming a valid HTTP request was received and -preflightRequest: returned nil, * this method is called to process the request by executing the handler's * process block. */ - (void)processRequest:(GCDWebServerRequest*)request completion:(GCDWebServerCompletionBlock)completion; /** * Assuming a valid HTTP request was received and either -preflightRequest: * or -processRequest:completion: returned a non-nil GCDWebServerResponse, * this method is called to override the response. * * You can either modify the current response and return it, or return a * completely new one. * * The default implementation replaces any response matching the "ETag" or * "Last-Modified-Date" header of the request by a barebone "Not-Modified" (304) * one. */ - (GCDWebServerResponse*)overrideResponse:(GCDWebServerResponse*)response forRequest:(GCDWebServerRequest*)request; /** * This method is called if any error happens while validing or processing * the request or if no GCDWebServerResponse was generated during processing. * * @warning If the request was invalid (e.g. the HTTP headers were malformed), * the "request" argument will be nil. */ - (void)abortRequest:(GCDWebServerRequest*)request withStatusCode:(NSInteger)statusCode; /** * Called when the connection is closed. */ - (void)close; @end ================================================ FILE: src/ios/GCDWebServer/Core/GCDWebServerConnection.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import #import #ifdef __GCDWEBSERVER_ENABLE_TESTING__ #import #endif #import "GCDWebServerPrivate.h" #define kHeadersReadCapacity (1 * 1024) #define kBodyReadCapacity (256 * 1024) typedef void (^ReadDataCompletionBlock)(BOOL success); typedef void (^ReadHeadersCompletionBlock)(NSData* extraData); typedef void (^ReadBodyCompletionBlock)(BOOL success); typedef void (^WriteDataCompletionBlock)(BOOL success); typedef void (^WriteHeadersCompletionBlock)(BOOL success); typedef void (^WriteBodyCompletionBlock)(BOOL success); static NSData* _CRLFData = nil; static NSData* _CRLFCRLFData = nil; static NSData* _continueData = nil; static NSData* _lastChunkData = nil; static NSString* _digestAuthenticationNonce = nil; #ifdef __GCDWEBSERVER_ENABLE_TESTING__ static int32_t _connectionCounter = 0; #endif @interface GCDWebServerConnection () { @private GCDWebServer* _server; NSData* _localAddress; NSData* _remoteAddress; CFSocketNativeHandle _socket; NSUInteger _bytesRead; NSUInteger _bytesWritten; BOOL _virtualHEAD; CFHTTPMessageRef _requestMessage; GCDWebServerRequest* _request; GCDWebServerHandler* _handler; CFHTTPMessageRef _responseMessage; GCDWebServerResponse* _response; NSInteger _statusCode; BOOL _opened; #ifdef __GCDWEBSERVER_ENABLE_TESTING__ NSUInteger _connectionIndex; NSString* _requestPath; int _requestFD; NSString* _responsePath; int _responseFD; #endif } @end @implementation GCDWebServerConnection (Read) - (void)_readData:(NSMutableData*)data withLength:(NSUInteger)length completionBlock:(ReadDataCompletionBlock)block { dispatch_read(_socket, length, dispatch_get_global_queue(_server.dispatchQueuePriority, 0), ^(dispatch_data_t buffer, int error) { @autoreleasepool { if (error == 0) { size_t size = dispatch_data_get_size(buffer); if (size > 0) { NSUInteger originalLength = data.length; dispatch_data_apply(buffer, ^bool(dispatch_data_t region, size_t chunkOffset, const void* chunkBytes, size_t chunkSize) { [data appendBytes:chunkBytes length:chunkSize]; return true; }); [self didReadBytes:((char*)data.bytes + originalLength) length:(data.length - originalLength)]; block(YES); } else { if (_bytesRead > 0) { GWS_LOG_ERROR(@"No more data available on socket %i", _socket); } else { GWS_LOG_WARNING(@"No data received from socket %i", _socket); } block(NO); } } else { GWS_LOG_ERROR(@"Error while reading from socket %i: %s (%i)", _socket, strerror(error), error); block(NO); } } }); } - (void)_readHeaders:(NSMutableData*)headersData withCompletionBlock:(ReadHeadersCompletionBlock)block { GWS_DCHECK(_requestMessage); [self _readData:headersData withLength:NSUIntegerMax completionBlock:^(BOOL success) { if (success) { NSRange range = [headersData rangeOfData:_CRLFCRLFData options:0 range:NSMakeRange(0, headersData.length)]; if (range.location == NSNotFound) { [self _readHeaders:headersData withCompletionBlock:block]; } else { NSUInteger length = range.location + range.length; if (CFHTTPMessageAppendBytes(_requestMessage, headersData.bytes, length)) { if (CFHTTPMessageIsHeaderComplete(_requestMessage)) { block([headersData subdataWithRange:NSMakeRange(length, headersData.length - length)]); } else { GWS_LOG_ERROR(@"Failed parsing request headers from socket %i", _socket); block(nil); } } else { GWS_LOG_ERROR(@"Failed appending request headers data from socket %i", _socket); block(nil); } } } else { block(nil); } }]; } - (void)_readBodyWithRemainingLength:(NSUInteger)length completionBlock:(ReadBodyCompletionBlock)block { GWS_DCHECK([_request hasBody] && ![_request usesChunkedTransferEncoding]); NSMutableData* bodyData = [[NSMutableData alloc] initWithCapacity:kBodyReadCapacity]; [self _readData:bodyData withLength:length completionBlock:^(BOOL success) { if (success) { if (bodyData.length <= length) { NSError* error = nil; if ([_request performWriteData:bodyData error:&error]) { NSUInteger remainingLength = length - bodyData.length; if (remainingLength) { [self _readBodyWithRemainingLength:remainingLength completionBlock:block]; } else { block(YES); } } else { GWS_LOG_ERROR(@"Failed writing request body on socket %i: %@", _socket, error); block(NO); } } else { GWS_LOG_ERROR(@"Unexpected extra content reading request body on socket %i", _socket); block(NO); GWS_DNOT_REACHED(); } } else { block(NO); } }]; } static inline NSUInteger _ScanHexNumber(const void* bytes, NSUInteger size) { char buffer[size + 1]; bcopy(bytes, buffer, size); buffer[size] = 0; char* end = NULL; long result = strtol(buffer, &end, 16); return ((end != NULL) && (*end == 0) && (result >= 0) ? result : NSNotFound); } - (void)_readNextBodyChunk:(NSMutableData*)chunkData completionBlock:(ReadBodyCompletionBlock)block { GWS_DCHECK([_request hasBody] && [_request usesChunkedTransferEncoding]); while (1) { NSRange range = [chunkData rangeOfData:_CRLFData options:0 range:NSMakeRange(0, chunkData.length)]; if (range.location == NSNotFound) { break; } NSRange extensionRange = [chunkData rangeOfData:[NSData dataWithBytes:";" length:1] options:0 range:NSMakeRange(0, range.location)]; // Ignore chunk extensions NSUInteger length = _ScanHexNumber((char*)chunkData.bytes, extensionRange.location != NSNotFound ? extensionRange.location : range.location); if (length != NSNotFound) { if (length) { if (chunkData.length < range.location + range.length + length + 2) { break; } const char* ptr = (char*)chunkData.bytes + range.location + range.length + length; if ((*ptr == '\r') && (*(ptr + 1) == '\n')) { NSError* error = nil; if ([_request performWriteData:[chunkData subdataWithRange:NSMakeRange(range.location + range.length, length)] error:&error]) { [chunkData replaceBytesInRange:NSMakeRange(0, range.location + range.length + length + 2) withBytes:NULL length:0]; } else { GWS_LOG_ERROR(@"Failed writing request body on socket %i: %@", _socket, error); block(NO); return; } } else { GWS_LOG_ERROR(@"Missing terminating CRLF sequence for chunk reading request body on socket %i", _socket); block(NO); return; } } else { NSRange trailerRange = [chunkData rangeOfData:_CRLFCRLFData options:0 range:NSMakeRange(range.location, chunkData.length - range.location)]; // Ignore trailers if (trailerRange.location != NSNotFound) { block(YES); return; } } } else { GWS_LOG_ERROR(@"Invalid chunk length reading request body on socket %i", _socket); block(NO); return; } } [self _readData:chunkData withLength:NSUIntegerMax completionBlock:^(BOOL success) { if (success) { [self _readNextBodyChunk:chunkData completionBlock:block]; } else { block(NO); } }]; } @end @implementation GCDWebServerConnection (Write) - (void)_writeData:(NSData*)data withCompletionBlock:(WriteDataCompletionBlock)block { dispatch_data_t buffer = dispatch_data_create(data.bytes, data.length, dispatch_get_global_queue(_server.dispatchQueuePriority, 0), ^{ [data self]; // Keeps ARC from releasing data too early }); dispatch_write(_socket, buffer, dispatch_get_global_queue(_server.dispatchQueuePriority, 0), ^(dispatch_data_t remainingData, int error) { @autoreleasepool { if (error == 0) { GWS_DCHECK(remainingData == NULL); [self didWriteBytes:data.bytes length:data.length]; block(YES); } else { GWS_LOG_ERROR(@"Error while writing to socket %i: %s (%i)", _socket, strerror(error), error); block(NO); } } }); #if !OS_OBJECT_USE_OBJC_RETAIN_RELEASE dispatch_release(buffer); #endif } - (void)_writeHeadersWithCompletionBlock:(WriteHeadersCompletionBlock)block { GWS_DCHECK(_responseMessage); CFDataRef data = CFHTTPMessageCopySerializedMessage(_responseMessage); [self _writeData:(__bridge NSData*)data withCompletionBlock:block]; CFRelease(data); } - (void)_writeBodyWithCompletionBlock:(WriteBodyCompletionBlock)block { GWS_DCHECK([_response hasBody]); [_response performReadDataWithCompletion:^(NSData* data, NSError* error) { if (data) { if (data.length) { if (_response.usesChunkedTransferEncoding) { const char* hexString = [[NSString stringWithFormat:@"%lx", (unsigned long)data.length] UTF8String]; size_t hexLength = strlen(hexString); NSData* chunk = [NSMutableData dataWithLength:(hexLength + 2 + data.length + 2)]; if (chunk == nil) { GWS_LOG_ERROR(@"Failed allocating memory for response body chunk for socket %i: %@", _socket, error); block(NO); return; } char* ptr = (char*)[(NSMutableData*)chunk mutableBytes]; bcopy(hexString, ptr, hexLength); ptr += hexLength; *ptr++ = '\r'; *ptr++ = '\n'; bcopy(data.bytes, ptr, data.length); ptr += data.length; *ptr++ = '\r'; *ptr = '\n'; data = chunk; } [self _writeData:data withCompletionBlock:^(BOOL success) { if (success) { [self _writeBodyWithCompletionBlock:block]; } else { block(NO); } }]; } else { if (_response.usesChunkedTransferEncoding) { [self _writeData:_lastChunkData withCompletionBlock:^(BOOL success) { block(success); }]; } else { block(YES); } } } else { GWS_LOG_ERROR(@"Failed reading response body for socket %i: %@", _socket, error); block(NO); } }]; } @end @implementation GCDWebServerConnection @synthesize server = _server, localAddressData = _localAddress, remoteAddressData = _remoteAddress, totalBytesRead = _bytesRead, totalBytesWritten = _bytesWritten; + (void)initialize { if (_CRLFData == nil) { _CRLFData = [[NSData alloc] initWithBytes:"\r\n" length:2]; GWS_DCHECK(_CRLFData); } if (_CRLFCRLFData == nil) { _CRLFCRLFData = [[NSData alloc] initWithBytes:"\r\n\r\n" length:4]; GWS_DCHECK(_CRLFCRLFData); } if (_continueData == nil) { CFHTTPMessageRef message = CFHTTPMessageCreateResponse(kCFAllocatorDefault, 100, NULL, kCFHTTPVersion1_1); _continueData = CFBridgingRelease(CFHTTPMessageCopySerializedMessage(message)); CFRelease(message); GWS_DCHECK(_continueData); } if (_lastChunkData == nil) { _lastChunkData = [[NSData alloc] initWithBytes:"0\r\n\r\n" length:5]; } if (_digestAuthenticationNonce == nil) { CFUUIDRef uuid = CFUUIDCreate(kCFAllocatorDefault); _digestAuthenticationNonce = GCDWebServerComputeMD5Digest(@"%@", CFBridgingRelease(CFUUIDCreateString(kCFAllocatorDefault, uuid))); CFRelease(uuid); } } - (BOOL)isUsingIPv6 { const struct sockaddr* localSockAddr = _localAddress.bytes; return (localSockAddr->sa_family == AF_INET6); } - (void)_initializeResponseHeadersWithStatusCode:(NSInteger)statusCode { _statusCode = statusCode; _responseMessage = CFHTTPMessageCreateResponse(kCFAllocatorDefault, statusCode, NULL, kCFHTTPVersion1_1); CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Connection"), CFSTR("Close")); CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Server"), (__bridge CFStringRef)_server.serverName); CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Date"), (__bridge CFStringRef)GCDWebServerFormatRFC822([NSDate date])); } - (void)_startProcessingRequest { GWS_DCHECK(_responseMessage == NULL); GCDWebServerResponse* preflightResponse = [self preflightRequest:_request]; if (preflightResponse) { [self _finishProcessingRequest:preflightResponse]; } else { [self processRequest:_request completion:^(GCDWebServerResponse* processResponse) { [self _finishProcessingRequest:processResponse]; }]; } } // http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html - (void)_finishProcessingRequest:(GCDWebServerResponse*)response { GWS_DCHECK(_responseMessage == NULL); BOOL hasBody = NO; if (response) { response = [self overrideResponse:response forRequest:_request]; } if (response) { if ([response hasBody]) { [response prepareForReading]; hasBody = !_virtualHEAD; } NSError* error = nil; if (hasBody && ![response performOpen:&error]) { GWS_LOG_ERROR(@"Failed opening response body for socket %i: %@", _socket, error); } else { _response = response; } } if (_response) { [self _initializeResponseHeadersWithStatusCode:_response.statusCode]; if (_response.lastModifiedDate) { CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Last-Modified"), (__bridge CFStringRef)GCDWebServerFormatRFC822(_response.lastModifiedDate)); } if (_response.eTag) { CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("ETag"), (__bridge CFStringRef)_response.eTag); } if ((_response.statusCode >= 200) && (_response.statusCode < 300)) { if (_response.cacheControlMaxAge > 0) { CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Cache-Control"), (__bridge CFStringRef)[NSString stringWithFormat:@"max-age=%i, public", (int)_response.cacheControlMaxAge]); } else { CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Cache-Control"), CFSTR("no-cache")); } } if (_response.contentType != nil) { CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Content-Type"), (__bridge CFStringRef)GCDWebServerNormalizeHeaderValue(_response.contentType)); } if (_response.contentLength != NSUIntegerMax) { CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Content-Length"), (__bridge CFStringRef)[NSString stringWithFormat:@"%lu", (unsigned long)_response.contentLength]); } if (_response.usesChunkedTransferEncoding) { CFHTTPMessageSetHeaderFieldValue(_responseMessage, CFSTR("Transfer-Encoding"), CFSTR("chunked")); } [_response.additionalHeaders enumerateKeysAndObjectsUsingBlock:^(id key, id obj, BOOL* stop) { CFHTTPMessageSetHeaderFieldValue(_responseMessage, (__bridge CFStringRef)key, (__bridge CFStringRef)obj); }]; [self _writeHeadersWithCompletionBlock:^(BOOL success) { if (success) { if (hasBody) { [self _writeBodyWithCompletionBlock:^(BOOL successInner) { [_response performClose]; // TODO: There's nothing we can do on failure as headers have already been sent }]; } } else if (hasBody) { [_response performClose]; } }]; } else { [self abortRequest:_request withStatusCode:kGCDWebServerHTTPStatusCode_InternalServerError]; } } - (void)_readBodyWithLength:(NSUInteger)length initialData:(NSData*)initialData { NSError* error = nil; if (![_request performOpen:&error]) { GWS_LOG_ERROR(@"Failed opening request body for socket %i: %@", _socket, error); [self abortRequest:_request withStatusCode:kGCDWebServerHTTPStatusCode_InternalServerError]; return; } if (initialData.length) { if (![_request performWriteData:initialData error:&error]) { GWS_LOG_ERROR(@"Failed writing request body on socket %i: %@", _socket, error); if (![_request performClose:&error]) { GWS_LOG_ERROR(@"Failed closing request body for socket %i: %@", _socket, error); } [self abortRequest:_request withStatusCode:kGCDWebServerHTTPStatusCode_InternalServerError]; return; } length -= initialData.length; } if (length) { [self _readBodyWithRemainingLength:length completionBlock:^(BOOL success) { NSError* localError = nil; if ([_request performClose:&localError]) { [self _startProcessingRequest]; } else { GWS_LOG_ERROR(@"Failed closing request body for socket %i: %@", _socket, error); [self abortRequest:_request withStatusCode:kGCDWebServerHTTPStatusCode_InternalServerError]; } }]; } else { if ([_request performClose:&error]) { [self _startProcessingRequest]; } else { GWS_LOG_ERROR(@"Failed closing request body for socket %i: %@", _socket, error); [self abortRequest:_request withStatusCode:kGCDWebServerHTTPStatusCode_InternalServerError]; } } } - (void)_readChunkedBodyWithInitialData:(NSData*)initialData { NSError* error = nil; if (![_request performOpen:&error]) { GWS_LOG_ERROR(@"Failed opening request body for socket %i: %@", _socket, error); [self abortRequest:_request withStatusCode:kGCDWebServerHTTPStatusCode_InternalServerError]; return; } NSMutableData* chunkData = [[NSMutableData alloc] initWithData:initialData]; [self _readNextBodyChunk:chunkData completionBlock:^(BOOL success) { NSError* localError = nil; if ([_request performClose:&localError]) { [self _startProcessingRequest]; } else { GWS_LOG_ERROR(@"Failed closing request body for socket %i: %@", _socket, error); [self abortRequest:_request withStatusCode:kGCDWebServerHTTPStatusCode_InternalServerError]; } }]; } - (void)_readRequestHeaders { _requestMessage = CFHTTPMessageCreateEmpty(kCFAllocatorDefault, true); NSMutableData* headersData = [[NSMutableData alloc] initWithCapacity:kHeadersReadCapacity]; [self _readHeaders:headersData withCompletionBlock:^(NSData* extraData) { if (extraData) { NSString* requestMethod = CFBridgingRelease(CFHTTPMessageCopyRequestMethod(_requestMessage)); // Method verbs are case-sensitive and uppercase if (_server.shouldAutomaticallyMapHEADToGET && [requestMethod isEqualToString:@"HEAD"]) { requestMethod = @"GET"; _virtualHEAD = YES; } NSDictionary* requestHeaders = CFBridgingRelease(CFHTTPMessageCopyAllHeaderFields(_requestMessage)); // Header names are case-insensitive but CFHTTPMessageCopyAllHeaderFields() will standardize the common ones NSURL* requestURL = CFBridgingRelease(CFHTTPMessageCopyRequestURL(_requestMessage)); if (requestURL) { requestURL = [self rewriteRequestURL:requestURL withMethod:requestMethod headers:requestHeaders]; GWS_DCHECK(requestURL); } NSString* requestPath = requestURL ? GCDWebServerUnescapeURLString(CFBridgingRelease(CFURLCopyPath((CFURLRef)requestURL))) : nil; // Don't use -[NSURL path] which strips the ending slash NSString* queryString = requestURL ? CFBridgingRelease(CFURLCopyQueryString((CFURLRef)requestURL, NULL)) : nil; // Don't use -[NSURL query] to make sure query is not unescaped; NSDictionary* requestQuery = queryString ? GCDWebServerParseURLEncodedForm(queryString) : @{}; if (requestMethod && requestURL && requestHeaders && requestPath && requestQuery) { for (_handler in _server.handlers) { _request = _handler.matchBlock(requestMethod, requestURL, requestHeaders, requestPath, requestQuery); if (_request) { break; } } if (_request) { _request.localAddressData = self.localAddressData; _request.remoteAddressData = self.remoteAddressData; if ([_request hasBody]) { [_request prepareForWriting]; if (_request.usesChunkedTransferEncoding || (extraData.length <= _request.contentLength)) { NSString* expectHeader = [requestHeaders objectForKey:@"Expect"]; if (expectHeader) { if ([expectHeader caseInsensitiveCompare:@"100-continue"] == NSOrderedSame) { // TODO: Actually validate request before continuing [self _writeData:_continueData withCompletionBlock:^(BOOL success) { if (success) { if (_request.usesChunkedTransferEncoding) { [self _readChunkedBodyWithInitialData:extraData]; } else { [self _readBodyWithLength:_request.contentLength initialData:extraData]; } } }]; } else { GWS_LOG_ERROR(@"Unsupported 'Expect' / 'Content-Length' header combination on socket %i", _socket); [self abortRequest:_request withStatusCode:kGCDWebServerHTTPStatusCode_ExpectationFailed]; } } else { if (_request.usesChunkedTransferEncoding) { [self _readChunkedBodyWithInitialData:extraData]; } else { [self _readBodyWithLength:_request.contentLength initialData:extraData]; } } } else { GWS_LOG_ERROR(@"Unexpected 'Content-Length' header value on socket %i", _socket); [self abortRequest:_request withStatusCode:kGCDWebServerHTTPStatusCode_BadRequest]; } } else { [self _startProcessingRequest]; } } else { _request = [[GCDWebServerRequest alloc] initWithMethod:requestMethod url:requestURL headers:requestHeaders path:requestPath query:requestQuery]; GWS_DCHECK(_request); [self abortRequest:_request withStatusCode:kGCDWebServerHTTPStatusCode_MethodNotAllowed]; } } else { [self abortRequest:nil withStatusCode:kGCDWebServerHTTPStatusCode_InternalServerError]; GWS_DNOT_REACHED(); } } else { [self abortRequest:nil withStatusCode:kGCDWebServerHTTPStatusCode_InternalServerError]; } }]; } - (id)initWithServer:(GCDWebServer*)server localAddress:(NSData*)localAddress remoteAddress:(NSData*)remoteAddress socket:(CFSocketNativeHandle)socket { if ((self = [super init])) { _server = server; _localAddress = localAddress; _remoteAddress = remoteAddress; _socket = socket; GWS_LOG_DEBUG(@"Did open connection on socket %i", _socket); [_server willStartConnection:self]; if (![self open]) { close(_socket); return nil; } _opened = YES; [self _readRequestHeaders]; } return self; } - (NSString*)localAddressString { return GCDWebServerStringFromSockAddr(_localAddress.bytes, YES); } - (NSString*)remoteAddressString { return GCDWebServerStringFromSockAddr(_remoteAddress.bytes, YES); } - (void)dealloc { int result = close(_socket); if (result != 0) { GWS_LOG_ERROR(@"Failed closing socket %i for connection: %s (%i)", _socket, strerror(errno), errno); } else { GWS_LOG_DEBUG(@"Did close connection on socket %i", _socket); } if (_opened) { [self close]; } [_server didEndConnection:self]; if (_requestMessage) { CFRelease(_requestMessage); } if (_responseMessage) { CFRelease(_responseMessage); } } @end @implementation GCDWebServerConnection (Subclassing) - (BOOL)open { #ifdef __GCDWEBSERVER_ENABLE_TESTING__ if (_server.recordingEnabled) { #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" _connectionIndex = OSAtomicIncrement32(&_connectionCounter); #pragma clang diagnostic pop _requestPath = [NSTemporaryDirectory() stringByAppendingPathComponent:[[NSProcessInfo processInfo] globallyUniqueString]]; _requestFD = open([_requestPath fileSystemRepresentation], O_CREAT | O_TRUNC | O_WRONLY, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); GWS_DCHECK(_requestFD > 0); _responsePath = [NSTemporaryDirectory() stringByAppendingPathComponent:[[NSProcessInfo processInfo] globallyUniqueString]]; _responseFD = open([_responsePath fileSystemRepresentation], O_CREAT | O_TRUNC | O_WRONLY, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); GWS_DCHECK(_responseFD > 0); } #endif return YES; } - (void)didReadBytes:(const void*)bytes length:(NSUInteger)length { GWS_LOG_DEBUG(@"Connection received %lu bytes on socket %i", (unsigned long)length, _socket); _bytesRead += length; #ifdef __GCDWEBSERVER_ENABLE_TESTING__ if ((_requestFD > 0) && (write(_requestFD, bytes, length) != (ssize_t)length)) { GWS_LOG_ERROR(@"Failed recording request data: %s (%i)", strerror(errno), errno); close(_requestFD); _requestFD = 0; } #endif } - (void)didWriteBytes:(const void*)bytes length:(NSUInteger)length { GWS_LOG_DEBUG(@"Connection sent %lu bytes on socket %i", (unsigned long)length, _socket); _bytesWritten += length; #ifdef __GCDWEBSERVER_ENABLE_TESTING__ if ((_responseFD > 0) && (write(_responseFD, bytes, length) != (ssize_t)length)) { GWS_LOG_ERROR(@"Failed recording response data: %s (%i)", strerror(errno), errno); close(_responseFD); _responseFD = 0; } #endif } - (NSURL*)rewriteRequestURL:(NSURL*)url withMethod:(NSString*)method headers:(NSDictionary*)headers { return url; } // https://tools.ietf.org/html/rfc2617 - (GCDWebServerResponse*)preflightRequest:(GCDWebServerRequest*)request { GWS_LOG_DEBUG(@"Connection on socket %i preflighting request \"%@ %@\" with %lu bytes body", _socket, _virtualHEAD ? @"HEAD" : _request.method, _request.path, (unsigned long)_bytesRead); GCDWebServerResponse* response = nil; if (_server.authenticationBasicAccounts) { __block BOOL authenticated = NO; NSString* authorizationHeader = [request.headers objectForKey:@"Authorization"]; if ([authorizationHeader hasPrefix:@"Basic "]) { NSString* basicAccount = [authorizationHeader substringFromIndex:6]; [_server.authenticationBasicAccounts enumerateKeysAndObjectsUsingBlock:^(NSString* username, NSString* digest, BOOL* stop) { if ([basicAccount isEqualToString:digest]) { authenticated = YES; *stop = YES; } }]; } if (!authenticated) { response = [GCDWebServerResponse responseWithStatusCode:kGCDWebServerHTTPStatusCode_Unauthorized]; [response setValue:[NSString stringWithFormat:@"Basic realm=\"%@\"", _server.authenticationRealm] forAdditionalHeader:@"WWW-Authenticate"]; } } else if (_server.authenticationDigestAccounts) { BOOL authenticated = NO; BOOL isStaled = NO; NSString* authorizationHeader = [request.headers objectForKey:@"Authorization"]; if ([authorizationHeader hasPrefix:@"Digest "]) { NSString* realm = GCDWebServerExtractHeaderValueParameter(authorizationHeader, @"realm"); if ([realm isEqualToString:_server.authenticationRealm]) { NSString* nonce = GCDWebServerExtractHeaderValueParameter(authorizationHeader, @"nonce"); if ([nonce isEqualToString:_digestAuthenticationNonce]) { NSString* username = GCDWebServerExtractHeaderValueParameter(authorizationHeader, @"username"); NSString* uri = GCDWebServerExtractHeaderValueParameter(authorizationHeader, @"uri"); NSString* actualResponse = GCDWebServerExtractHeaderValueParameter(authorizationHeader, @"response"); NSString* ha1 = [_server.authenticationDigestAccounts objectForKey:username]; NSString* ha2 = GCDWebServerComputeMD5Digest(@"%@:%@", request.method, uri); // We cannot use "request.path" as the query string is required NSString* expectedResponse = GCDWebServerComputeMD5Digest(@"%@:%@:%@", ha1, _digestAuthenticationNonce, ha2); if ([actualResponse isEqualToString:expectedResponse]) { authenticated = YES; } } else if (nonce.length) { isStaled = YES; } } } if (!authenticated) { response = [GCDWebServerResponse responseWithStatusCode:kGCDWebServerHTTPStatusCode_Unauthorized]; [response setValue:[NSString stringWithFormat:@"Digest realm=\"%@\", nonce=\"%@\"%@", _server.authenticationRealm, _digestAuthenticationNonce, isStaled ? @", stale=TRUE" : @""] forAdditionalHeader:@"WWW-Authenticate"]; // TODO: Support Quality of Protection ("qop") } } return response; } - (void)processRequest:(GCDWebServerRequest*)request completion:(GCDWebServerCompletionBlock)completion { GWS_LOG_DEBUG(@"Connection on socket %i processing request \"%@ %@\" with %lu bytes body", _socket, _virtualHEAD ? @"HEAD" : _request.method, _request.path, (unsigned long)_bytesRead); _handler.asyncProcessBlock(request, [completion copy]); } // http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25 // http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26 static inline BOOL _CompareResources(NSString* responseETag, NSString* requestETag, NSDate* responseLastModified, NSDate* requestLastModified) { if (requestLastModified && responseLastModified) { if ([responseLastModified compare:requestLastModified] != NSOrderedDescending) { return YES; } } if (requestETag && responseETag) { // Per the specs "If-None-Match" must be checked after "If-Modified-Since" if ([requestETag isEqualToString:@"*"]) { return YES; } if ([responseETag isEqualToString:requestETag]) { return YES; } } return NO; } - (GCDWebServerResponse*)overrideResponse:(GCDWebServerResponse*)response forRequest:(GCDWebServerRequest*)request { if ((response.statusCode >= 200) && (response.statusCode < 300) && _CompareResources(response.eTag, request.ifNoneMatch, response.lastModifiedDate, request.ifModifiedSince)) { NSInteger code = [request.method isEqualToString:@"HEAD"] || [request.method isEqualToString:@"GET"] ? kGCDWebServerHTTPStatusCode_NotModified : kGCDWebServerHTTPStatusCode_PreconditionFailed; GCDWebServerResponse* newResponse = [GCDWebServerResponse responseWithStatusCode:code]; newResponse.cacheControlMaxAge = response.cacheControlMaxAge; newResponse.lastModifiedDate = response.lastModifiedDate; newResponse.eTag = response.eTag; GWS_DCHECK(newResponse); return newResponse; } return response; } - (void)abortRequest:(GCDWebServerRequest*)request withStatusCode:(NSInteger)statusCode { GWS_DCHECK(_responseMessage == NULL); GWS_DCHECK((statusCode >= 400) && (statusCode < 600)); [self _initializeResponseHeadersWithStatusCode:statusCode]; [self _writeHeadersWithCompletionBlock:^(BOOL success) { ; // Nothing more to do }]; GWS_LOG_DEBUG(@"Connection aborted with status code %i on socket %i", (int)statusCode, _socket); } - (void)close { #ifdef __GCDWEBSERVER_ENABLE_TESTING__ if (_requestPath) { BOOL success = NO; NSError* error = nil; if (_requestFD > 0) { close(_requestFD); NSString* name = [NSString stringWithFormat:@"%03lu-%@.request", (unsigned long)_connectionIndex, _virtualHEAD ? @"HEAD" : _request.method]; success = [[NSFileManager defaultManager] moveItemAtPath:_requestPath toPath:[[[NSFileManager defaultManager] currentDirectoryPath] stringByAppendingPathComponent:name] error:&error]; } if (!success) { GWS_LOG_ERROR(@"Failed saving recorded request: %@", error); GWS_DNOT_REACHED(); } unlink([_requestPath fileSystemRepresentation]); } if (_responsePath) { BOOL success = NO; NSError* error = nil; if (_responseFD > 0) { close(_responseFD); NSString* name = [NSString stringWithFormat:@"%03lu-%i.response", (unsigned long)_connectionIndex, (int)_statusCode]; success = [[NSFileManager defaultManager] moveItemAtPath:_responsePath toPath:[[[NSFileManager defaultManager] currentDirectoryPath] stringByAppendingPathComponent:name] error:&error]; } if (!success) { GWS_LOG_ERROR(@"Failed saving recorded response: %@", error); GWS_DNOT_REACHED(); } unlink([_responsePath fileSystemRepresentation]); } #endif if (_request) { GWS_LOG_VERBOSE(@"[%@] %@ %i \"%@ %@\" (%lu | %lu)", self.localAddressString, self.remoteAddressString, (int)_statusCode, _virtualHEAD ? @"HEAD" : _request.method, _request.path, (unsigned long)_bytesRead, (unsigned long)_bytesWritten); } else { GWS_LOG_VERBOSE(@"[%@] %@ %i \"(invalid request)\" (%lu | %lu)", self.localAddressString, self.remoteAddressString, (int)_statusCode, (unsigned long)_bytesRead, (unsigned long)_bytesWritten); } } @end ================================================ FILE: src/ios/GCDWebServer/Core/GCDWebServerFunctions.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import #ifdef __cplusplus extern "C" { #endif /** * Converts a file extension to the corresponding MIME type. * If there is no match, "application/octet-stream" is returned. */ NSString* GCDWebServerGetMimeTypeForExtension(NSString* extension); /** * Add percent-escapes to a string so it can be used in a URL. * The legal characters ":@/?&=+" are also escaped to ensure compatibility * with URL encoded forms and URL queries. */ NSString* GCDWebServerEscapeURLString(NSString* string); /** * Unescapes a URL percent-encoded string. */ NSString* GCDWebServerUnescapeURLString(NSString* string); /** * Extracts the unescaped names and values from an * "application/x-www-form-urlencoded" form. * http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1 */ NSDictionary* GCDWebServerParseURLEncodedForm(NSString* form); /** * On OS X, returns the IPv4 or IPv6 address as a string of the primary * connected service or nil if not available. * * On iOS, returns the IPv4 or IPv6 address as a string of the WiFi * interface if connected or nil otherwise. */ NSString* GCDWebServerGetPrimaryIPAddress(BOOL useIPv6); /** * Converts a date into a string using RFC822 formatting. * https://tools.ietf.org/html/rfc822#section-5 * https://tools.ietf.org/html/rfc1123#section-5.2.14 */ NSString* GCDWebServerFormatRFC822(NSDate* date); /** * Converts a RFC822 formatted string into a date. * https://tools.ietf.org/html/rfc822#section-5 * https://tools.ietf.org/html/rfc1123#section-5.2.14 * * @warning Timezones other than GMT are not supported by this function. */ NSDate* GCDWebServerParseRFC822(NSString* string); /** * Converts a date into a string using IOS 8601 formatting. * http://tools.ietf.org/html/rfc3339#section-5.6 */ NSString* GCDWebServerFormatISO8601(NSDate* date); /** * Converts a ISO 8601 formatted string into a date. * http://tools.ietf.org/html/rfc3339#section-5.6 * * @warning Only "calendar" variant is supported at this time and timezones * other than GMT are not supported either. */ NSDate* GCDWebServerParseISO8601(NSString* string); #ifdef __cplusplus } #endif ================================================ FILE: src/ios/GCDWebServer/Core/GCDWebServerFunctions.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import #if TARGET_OS_IPHONE #import #else #import #endif #import #import #import #import #import "GCDWebServerPrivate.h" static NSDateFormatter* _dateFormatterRFC822 = nil; static NSDateFormatter* _dateFormatterISO8601 = nil; static dispatch_queue_t _dateFormatterQueue = NULL; // TODO: Handle RFC 850 and ANSI C's asctime() format void GCDWebServerInitializeFunctions() { GWS_DCHECK([NSThread isMainThread]); // NSDateFormatter should be initialized on main thread if (_dateFormatterRFC822 == nil) { _dateFormatterRFC822 = [[NSDateFormatter alloc] init]; _dateFormatterRFC822.timeZone = [NSTimeZone timeZoneWithAbbreviation:@"GMT"]; _dateFormatterRFC822.dateFormat = @"EEE',' dd MMM yyyy HH':'mm':'ss 'GMT'"; _dateFormatterRFC822.locale = [[NSLocale alloc] initWithLocaleIdentifier:@"en_US"]; GWS_DCHECK(_dateFormatterRFC822); } if (_dateFormatterISO8601 == nil) { _dateFormatterISO8601 = [[NSDateFormatter alloc] init]; _dateFormatterISO8601.timeZone = [NSTimeZone timeZoneWithAbbreviation:@"GMT"]; _dateFormatterISO8601.dateFormat = @"yyyy-MM-dd'T'HH:mm:ss'+00:00'"; _dateFormatterISO8601.locale = [[NSLocale alloc] initWithLocaleIdentifier:@"en_US"]; GWS_DCHECK(_dateFormatterISO8601); } if (_dateFormatterQueue == NULL) { _dateFormatterQueue = dispatch_queue_create(NULL, DISPATCH_QUEUE_SERIAL); GWS_DCHECK(_dateFormatterQueue); } } NSString* GCDWebServerNormalizeHeaderValue(NSString* value) { if (value) { NSRange range = [value rangeOfString:@";"]; // Assume part before ";" separator is case-insensitive if (range.location != NSNotFound) { value = [[[value substringToIndex:range.location] lowercaseString] stringByAppendingString:[value substringFromIndex:range.location]]; } else { value = [value lowercaseString]; } } return value; } NSString* GCDWebServerTruncateHeaderValue(NSString* value) { NSRange range = [value rangeOfString:@";"]; return range.location != NSNotFound ? [value substringToIndex:range.location] : value; } NSString* GCDWebServerExtractHeaderValueParameter(NSString* value, NSString* name) { NSString* parameter = nil; NSScanner* scanner = [[NSScanner alloc] initWithString:value]; [scanner setCaseSensitive:NO]; // Assume parameter names are case-insensitive NSString* string = [NSString stringWithFormat:@"%@=", name]; if ([scanner scanUpToString:string intoString:NULL]) { [scanner scanString:string intoString:NULL]; if ([scanner scanString:@"\"" intoString:NULL]) { [scanner scanUpToString:@"\"" intoString:¶meter]; } else { [scanner scanUpToCharactersFromSet:[NSCharacterSet whitespaceCharacterSet] intoString:¶meter]; } } return parameter; } // http://www.w3schools.com/tags/ref_charactersets.asp NSStringEncoding GCDWebServerStringEncodingFromCharset(NSString* charset) { NSStringEncoding encoding = kCFStringEncodingInvalidId; if (charset) { encoding = CFStringConvertEncodingToNSStringEncoding(CFStringConvertIANACharSetNameToEncoding((CFStringRef)charset)); } return (encoding != kCFStringEncodingInvalidId ? encoding : NSUTF8StringEncoding); } NSString* GCDWebServerFormatRFC822(NSDate* date) { __block NSString* string; dispatch_sync(_dateFormatterQueue, ^{ string = [_dateFormatterRFC822 stringFromDate:date]; }); return string; } NSDate* GCDWebServerParseRFC822(NSString* string) { __block NSDate* date; dispatch_sync(_dateFormatterQueue, ^{ date = [_dateFormatterRFC822 dateFromString:string]; }); return date; } NSString* GCDWebServerFormatISO8601(NSDate* date) { __block NSString* string; dispatch_sync(_dateFormatterQueue, ^{ string = [_dateFormatterISO8601 stringFromDate:date]; }); return string; } NSDate* GCDWebServerParseISO8601(NSString* string) { __block NSDate* date; dispatch_sync(_dateFormatterQueue, ^{ date = [_dateFormatterISO8601 dateFromString:string]; }); return date; } BOOL GCDWebServerIsTextContentType(NSString* type) { return ([type hasPrefix:@"text/"] || [type hasPrefix:@"application/json"] || [type hasPrefix:@"application/xml"]); } NSString* GCDWebServerDescribeData(NSData* data, NSString* type) { if (GCDWebServerIsTextContentType(type)) { NSString* charset = GCDWebServerExtractHeaderValueParameter(type, @"charset"); NSString* string = [[NSString alloc] initWithData:data encoding:GCDWebServerStringEncodingFromCharset(charset)]; if (string) { return string; } } return [NSString stringWithFormat:@"<%lu bytes>", (unsigned long)data.length]; } NSString* GCDWebServerGetMimeTypeForExtension(NSString* extension) { static NSDictionary* _overrides = nil; if (_overrides == nil) { _overrides = [[NSDictionary alloc] initWithObjectsAndKeys: @"text/css", @"css", nil]; } NSString* mimeType = nil; extension = [extension lowercaseString]; if (extension.length) { mimeType = [_overrides objectForKey:extension]; if (mimeType == nil) { CFStringRef uti = UTTypeCreatePreferredIdentifierForTag(kUTTagClassFilenameExtension, (__bridge CFStringRef)extension, NULL); if (uti) { mimeType = CFBridgingRelease(UTTypeCopyPreferredTagWithClass(uti, kUTTagClassMIMEType)); CFRelease(uti); } } } return mimeType ? mimeType : kGCDWebServerDefaultMimeType; } NSString* GCDWebServerEscapeURLString(NSString* string) { #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" return CFBridgingRelease(CFURLCreateStringByAddingPercentEscapes(kCFAllocatorDefault, (CFStringRef)string, NULL, CFSTR(":@/?&=+"), kCFStringEncodingUTF8)); #pragma clang diagnostic pop } NSString* GCDWebServerUnescapeURLString(NSString* string) { #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" return CFBridgingRelease(CFURLCreateStringByReplacingPercentEscapesUsingEncoding(kCFAllocatorDefault, (CFStringRef)string, CFSTR(""), kCFStringEncodingUTF8)); #pragma clang diagnostic pop } NSDictionary* GCDWebServerParseURLEncodedForm(NSString* form) { NSMutableDictionary* parameters = [NSMutableDictionary dictionary]; NSScanner* scanner = [[NSScanner alloc] initWithString:form]; [scanner setCharactersToBeSkipped:nil]; while (1) { NSString* key = nil; if (![scanner scanUpToString:@"=" intoString:&key] || [scanner isAtEnd]) { break; } [scanner setScanLocation:([scanner scanLocation] + 1)]; NSString* value = nil; [scanner scanUpToString:@"&" intoString:&value]; if (value == nil) { value = @""; } key = [key stringByReplacingOccurrencesOfString:@"+" withString:@" "]; NSString* unescapedKey = key ? GCDWebServerUnescapeURLString(key) : nil; value = [value stringByReplacingOccurrencesOfString:@"+" withString:@" "]; NSString* unescapedValue = value ? GCDWebServerUnescapeURLString(value) : nil; if (unescapedKey && unescapedValue) { [parameters setObject:unescapedValue forKey:unescapedKey]; } else { GWS_LOG_WARNING(@"Failed parsing URL encoded form for key \"%@\" and value \"%@\"", key, value); GWS_DNOT_REACHED(); } if ([scanner isAtEnd]) { break; } [scanner setScanLocation:([scanner scanLocation] + 1)]; } return parameters; } NSString* GCDWebServerStringFromSockAddr(const struct sockaddr* addr, BOOL includeService) { NSString* string = nil; char hostBuffer[NI_MAXHOST]; char serviceBuffer[NI_MAXSERV]; if (getnameinfo(addr, addr->sa_len, hostBuffer, sizeof(hostBuffer), serviceBuffer, sizeof(serviceBuffer), NI_NUMERICHOST | NI_NUMERICSERV | NI_NOFQDN) >= 0) { string = includeService ? [NSString stringWithFormat:@"%s:%s", hostBuffer, serviceBuffer] : [NSString stringWithUTF8String:hostBuffer]; } else { GWS_DNOT_REACHED(); } return string; } NSString* GCDWebServerGetPrimaryIPAddress(BOOL useIPv6) { NSString* address = nil; #if TARGET_OS_IPHONE #if !TARGET_IPHONE_SIMULATOR && !TARGET_OS_TV const char* primaryInterface = "en0"; // WiFi interface on iOS #endif #else const char* primaryInterface = NULL; SCDynamicStoreRef store = SCDynamicStoreCreate(kCFAllocatorDefault, CFSTR("GCDWebServer"), NULL, NULL); if (store) { CFPropertyListRef info = SCDynamicStoreCopyValue(store, CFSTR("State:/Network/Global/IPv4")); // There is no equivalent for IPv6 but the primary interface should be the same if (info) { primaryInterface = [[NSString stringWithString:[(__bridge NSDictionary*)info objectForKey:@"PrimaryInterface"]] UTF8String]; CFRelease(info); } CFRelease(store); } if (primaryInterface == NULL) { primaryInterface = "lo0"; } #endif struct ifaddrs* list; if (getifaddrs(&list) >= 0) { for (struct ifaddrs* ifap = list; ifap; ifap = ifap->ifa_next) { #if TARGET_IPHONE_SIMULATOR || TARGET_OS_TV // Assume en0 is Ethernet and en1 is WiFi since there is no way to use SystemConfiguration framework in iOS Simulator // Assumption holds for Apple TV running tvOS if (strcmp(ifap->ifa_name, "en0") && strcmp(ifap->ifa_name, "en1")) #else if (strcmp(ifap->ifa_name, primaryInterface)) #endif { continue; } if ((ifap->ifa_flags & IFF_UP) && ((!useIPv6 && (ifap->ifa_addr->sa_family == AF_INET)) || (useIPv6 && (ifap->ifa_addr->sa_family == AF_INET6)))) { address = GCDWebServerStringFromSockAddr(ifap->ifa_addr, NO); break; } } freeifaddrs(list); } return address; } NSString* GCDWebServerComputeMD5Digest(NSString* format, ...) { va_list arguments; va_start(arguments, format); const char* string = [[[NSString alloc] initWithFormat:format arguments:arguments] UTF8String]; va_end(arguments); unsigned char md5[CC_MD5_DIGEST_LENGTH]; CC_MD5(string, (CC_LONG)strlen(string), md5); char buffer[2 * CC_MD5_DIGEST_LENGTH + 1]; for (int i = 0; i < CC_MD5_DIGEST_LENGTH; ++i) { unsigned char byte = md5[i]; unsigned char byteHi = (byte & 0xF0) >> 4; buffer[2 * i + 0] = byteHi >= 10 ? 'a' + byteHi - 10 : '0' + byteHi; unsigned char byteLo = byte & 0x0F; buffer[2 * i + 1] = byteLo >= 10 ? 'a' + byteLo - 10 : '0' + byteLo; } buffer[2 * CC_MD5_DIGEST_LENGTH] = 0; return [NSString stringWithUTF8String:buffer]; } ================================================ FILE: src/ios/GCDWebServer/Core/GCDWebServerHTTPStatusCodes.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ // http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html // http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml #import /** * Convenience constants for "informational" HTTP status codes. */ typedef NS_ENUM(NSInteger, GCDWebServerInformationalHTTPStatusCode) { kGCDWebServerHTTPStatusCode_Continue = 100, kGCDWebServerHTTPStatusCode_SwitchingProtocols = 101, kGCDWebServerHTTPStatusCode_Processing = 102 }; /** * Convenience constants for "successful" HTTP status codes. */ typedef NS_ENUM(NSInteger, GCDWebServerSuccessfulHTTPStatusCode) { kGCDWebServerHTTPStatusCode_OK = 200, kGCDWebServerHTTPStatusCode_Created = 201, kGCDWebServerHTTPStatusCode_Accepted = 202, kGCDWebServerHTTPStatusCode_NonAuthoritativeInformation = 203, kGCDWebServerHTTPStatusCode_NoContent = 204, kGCDWebServerHTTPStatusCode_ResetContent = 205, kGCDWebServerHTTPStatusCode_PartialContent = 206, kGCDWebServerHTTPStatusCode_MultiStatus = 207, kGCDWebServerHTTPStatusCode_AlreadyReported = 208 }; /** * Convenience constants for "redirection" HTTP status codes. */ typedef NS_ENUM(NSInteger, GCDWebServerRedirectionHTTPStatusCode) { kGCDWebServerHTTPStatusCode_MultipleChoices = 300, kGCDWebServerHTTPStatusCode_MovedPermanently = 301, kGCDWebServerHTTPStatusCode_Found = 302, kGCDWebServerHTTPStatusCode_SeeOther = 303, kGCDWebServerHTTPStatusCode_NotModified = 304, kGCDWebServerHTTPStatusCode_UseProxy = 305, kGCDWebServerHTTPStatusCode_TemporaryRedirect = 307, kGCDWebServerHTTPStatusCode_PermanentRedirect = 308 }; /** * Convenience constants for "client error" HTTP status codes. */ typedef NS_ENUM(NSInteger, GCDWebServerClientErrorHTTPStatusCode) { kGCDWebServerHTTPStatusCode_BadRequest = 400, kGCDWebServerHTTPStatusCode_Unauthorized = 401, kGCDWebServerHTTPStatusCode_PaymentRequired = 402, kGCDWebServerHTTPStatusCode_Forbidden = 403, kGCDWebServerHTTPStatusCode_NotFound = 404, kGCDWebServerHTTPStatusCode_MethodNotAllowed = 405, kGCDWebServerHTTPStatusCode_NotAcceptable = 406, kGCDWebServerHTTPStatusCode_ProxyAuthenticationRequired = 407, kGCDWebServerHTTPStatusCode_RequestTimeout = 408, kGCDWebServerHTTPStatusCode_Conflict = 409, kGCDWebServerHTTPStatusCode_Gone = 410, kGCDWebServerHTTPStatusCode_LengthRequired = 411, kGCDWebServerHTTPStatusCode_PreconditionFailed = 412, kGCDWebServerHTTPStatusCode_RequestEntityTooLarge = 413, kGCDWebServerHTTPStatusCode_RequestURITooLong = 414, kGCDWebServerHTTPStatusCode_UnsupportedMediaType = 415, kGCDWebServerHTTPStatusCode_RequestedRangeNotSatisfiable = 416, kGCDWebServerHTTPStatusCode_ExpectationFailed = 417, kGCDWebServerHTTPStatusCode_UnprocessableEntity = 422, kGCDWebServerHTTPStatusCode_Locked = 423, kGCDWebServerHTTPStatusCode_FailedDependency = 424, kGCDWebServerHTTPStatusCode_UpgradeRequired = 426, kGCDWebServerHTTPStatusCode_PreconditionRequired = 428, kGCDWebServerHTTPStatusCode_TooManyRequests = 429, kGCDWebServerHTTPStatusCode_RequestHeaderFieldsTooLarge = 431 }; /** * Convenience constants for "server error" HTTP status codes. */ typedef NS_ENUM(NSInteger, GCDWebServerServerErrorHTTPStatusCode) { kGCDWebServerHTTPStatusCode_InternalServerError = 500, kGCDWebServerHTTPStatusCode_NotImplemented = 501, kGCDWebServerHTTPStatusCode_BadGateway = 502, kGCDWebServerHTTPStatusCode_ServiceUnavailable = 503, kGCDWebServerHTTPStatusCode_GatewayTimeout = 504, kGCDWebServerHTTPStatusCode_HTTPVersionNotSupported = 505, kGCDWebServerHTTPStatusCode_InsufficientStorage = 507, kGCDWebServerHTTPStatusCode_LoopDetected = 508, kGCDWebServerHTTPStatusCode_NotExtended = 510, kGCDWebServerHTTPStatusCode_NetworkAuthenticationRequired = 511 }; ================================================ FILE: src/ios/GCDWebServer/Core/GCDWebServerPrivate.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import #import /** * All GCDWebServer headers. */ #import "GCDWebServerHTTPStatusCodes.h" #import "GCDWebServerFunctions.h" #import "GCDWebServer.h" #import "GCDWebServerConnection.h" #import "GCDWebServerDataRequest.h" #import "GCDWebServerFileRequest.h" #import "GCDWebServerMultiPartFormRequest.h" #import "GCDWebServerURLEncodedFormRequest.h" #import "GCDWebServerDataResponse.h" #import "GCDWebServerErrorResponse.h" #import "GCDWebServerFileResponse.h" #import "GCDWebServerStreamedResponse.h" /** * Check if a custom logging facility should be used instead. */ #if defined(__GCDWEBSERVER_LOGGING_HEADER__) #define __GCDWEBSERVER_LOGGING_FACILITY_CUSTOM__ #import __GCDWEBSERVER_LOGGING_HEADER__ /** * Automatically detect if XLFacility is available and if so use it as a * logging facility. */ #elif defined(__has_include) && __has_include("XLFacilityMacros.h") #define __GCDWEBSERVER_LOGGING_FACILITY_XLFACILITY__ #undef XLOG_TAG #define XLOG_TAG @"gcdwebserver.internal" #import "XLFacilityMacros.h" #define GWS_LOG_DEBUG(...) XLOG_DEBUG(__VA_ARGS__) #define GWS_LOG_VERBOSE(...) XLOG_VERBOSE(__VA_ARGS__) #define GWS_LOG_INFO(...) XLOG_INFO(__VA_ARGS__) #define GWS_LOG_WARNING(...) XLOG_WARNING(__VA_ARGS__) #define GWS_LOG_ERROR(...) XLOG_ERROR(__VA_ARGS__) #define GWS_DCHECK(__CONDITION__) XLOG_DEBUG_CHECK(__CONDITION__) #define GWS_DNOT_REACHED() XLOG_DEBUG_UNREACHABLE() /** * Automatically detect if CocoaLumberJack is available and if so use * it as a logging facility. */ #elif defined(__has_include) && __has_include("CocoaLumberjack/CocoaLumberjack.h") #import #define __GCDWEBSERVER_LOGGING_FACILITY_COCOALUMBERJACK__ #undef LOG_LEVEL_DEF #define LOG_LEVEL_DEF GCDWebServerLogLevel extern DDLogLevel GCDWebServerLogLevel; #define GWS_LOG_DEBUG(...) DDLogDebug(__VA_ARGS__) #define GWS_LOG_VERBOSE(...) DDLogVerbose(__VA_ARGS__) #define GWS_LOG_INFO(...) DDLogInfo(__VA_ARGS__) #define GWS_LOG_WARNING(...) DDLogWarn(__VA_ARGS__) #define GWS_LOG_ERROR(...) DDLogError(__VA_ARGS__) /** * If all of the above fail, then use GCDWebServer built-in * logging facility. */ #else #define __GCDWEBSERVER_LOGGING_FACILITY_BUILTIN__ typedef NS_ENUM(int, GCDWebServerLoggingLevel) { kGCDWebServerLoggingLevel_Debug = 0, kGCDWebServerLoggingLevel_Verbose, kGCDWebServerLoggingLevel_Info, kGCDWebServerLoggingLevel_Warning, kGCDWebServerLoggingLevel_Error }; extern GCDWebServerLoggingLevel GCDWebServerLogLevel; extern void GCDWebServerLogMessage(GCDWebServerLoggingLevel level, NSString* format, ...) NS_FORMAT_FUNCTION(2, 3); #if DEBUG #define GWS_LOG_DEBUG(...) \ do { \ if (GCDWebServerLogLevel <= kGCDWebServerLoggingLevel_Debug) GCDWebServerLogMessage(kGCDWebServerLoggingLevel_Debug, __VA_ARGS__); \ } while (0) #else #define GWS_LOG_DEBUG(...) #endif #define GWS_LOG_VERBOSE(...) \ do { \ if (GCDWebServerLogLevel <= kGCDWebServerLoggingLevel_Verbose) GCDWebServerLogMessage(kGCDWebServerLoggingLevel_Verbose, __VA_ARGS__); \ } while (0) #define GWS_LOG_INFO(...) \ do { \ if (GCDWebServerLogLevel <= kGCDWebServerLoggingLevel_Info) GCDWebServerLogMessage(kGCDWebServerLoggingLevel_Info, __VA_ARGS__); \ } while (0) #define GWS_LOG_WARNING(...) \ do { \ if (GCDWebServerLogLevel <= kGCDWebServerLoggingLevel_Warning) GCDWebServerLogMessage(kGCDWebServerLoggingLevel_Warning, __VA_ARGS__); \ } while (0) #define GWS_LOG_ERROR(...) \ do { \ if (GCDWebServerLogLevel <= kGCDWebServerLoggingLevel_Error) GCDWebServerLogMessage(kGCDWebServerLoggingLevel_Error, __VA_ARGS__); \ } while (0) #endif /** * Consistency check macros used when building Debug only. */ #if !defined(GWS_DCHECK) || !defined(GWS_DNOT_REACHED) #if DEBUG #define GWS_DCHECK(__CONDITION__) \ do { \ if (!(__CONDITION__)) { \ abort(); \ } \ } while (0) #define GWS_DNOT_REACHED() abort() #else #define GWS_DCHECK(__CONDITION__) #define GWS_DNOT_REACHED() #endif #endif /** * GCDWebServer internal constants and APIs. */ #define kGCDWebServerDefaultMimeType @"application/octet-stream" #define kGCDWebServerErrorDomain @"GCDWebServerErrorDomain" static inline BOOL GCDWebServerIsValidByteRange(NSRange range) { 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 NSString* GCDWebServerNormalizeHeaderValue(NSString* value); extern NSString* GCDWebServerTruncateHeaderValue(NSString* value); extern NSString* GCDWebServerExtractHeaderValueParameter(NSString* header, NSString* attribute); extern NSStringEncoding GCDWebServerStringEncodingFromCharset(NSString* charset); extern BOOL GCDWebServerIsTextContentType(NSString* type); extern NSString* GCDWebServerDescribeData(NSData* data, NSString* contentType); extern NSString* GCDWebServerComputeMD5Digest(NSString* format, ...) NS_FORMAT_FUNCTION(1, 2); extern NSString* GCDWebServerStringFromSockAddr(const struct sockaddr* addr, BOOL includeService); @interface GCDWebServerConnection () - (id)initWithServer:(GCDWebServer*)server localAddress:(NSData*)localAddress remoteAddress:(NSData*)remoteAddress socket:(CFSocketNativeHandle)socket; @end @interface GCDWebServer () @property(nonatomic, readonly) NSArray* handlers; @property(nonatomic, readonly) NSString* serverName; @property(nonatomic, readonly) NSString* authenticationRealm; @property(nonatomic, readonly) NSDictionary* authenticationBasicAccounts; @property(nonatomic, readonly) NSDictionary* authenticationDigestAccounts; @property(nonatomic, readonly) BOOL shouldAutomaticallyMapHEADToGET; @property(nonatomic, readonly) dispatch_queue_priority_t dispatchQueuePriority; - (void)willStartConnection:(GCDWebServerConnection*)connection; - (void)didEndConnection:(GCDWebServerConnection*)connection; @end @interface GCDWebServerHandler : NSObject @property(nonatomic, readonly) GCDWebServerMatchBlock matchBlock; @property(nonatomic, readonly) GCDWebServerAsyncProcessBlock asyncProcessBlock; @end @interface GCDWebServerRequest () @property(nonatomic, readonly) BOOL usesChunkedTransferEncoding; @property(nonatomic, readwrite) NSData* localAddressData; @property(nonatomic, readwrite) NSData* remoteAddressData; - (void)prepareForWriting; - (BOOL)performOpen:(NSError**)error; - (BOOL)performWriteData:(NSData*)data error:(NSError**)error; - (BOOL)performClose:(NSError**)error; - (void)setAttribute:(id)attribute forKey:(NSString*)key; @end @interface GCDWebServerResponse () @property(nonatomic, readonly) NSDictionary* additionalHeaders; @property(nonatomic, readonly) BOOL usesChunkedTransferEncoding; - (void)prepareForReading; - (BOOL)performOpen:(NSError**)error; - (void)performReadDataWithCompletion:(GCDWebServerBodyReaderCompletionBlock)block; - (void)performClose; @end ================================================ FILE: src/ios/GCDWebServer/Core/GCDWebServerRequest.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import /** * Attribute key to retrieve an NSArray containing NSStrings from a GCDWebServerRequest * with the contents of any regular expression captures done on the request path. * * @warning This attribute will only be set on the request if adding a handler using * -addHandlerForMethod:pathRegex:requestClass:processBlock:. */ extern NSString* const GCDWebServerRequestAttribute_RegexCaptures; /** * This protocol is used by the GCDWebServerConnection to communicate with * the GCDWebServerRequest and write the received HTTP body data. * * Note that multiple GCDWebServerBodyWriter objects can be chained together * internally e.g. to automatically decode gzip encoded content before * passing it on to the GCDWebServerRequest. * * @warning These methods can be called on any GCD thread. */ @protocol GCDWebServerBodyWriter /** * This method is called before any body data is received. * * It should return YES on success or NO on failure and set the "error" argument * which is guaranteed to be non-NULL. */ - (BOOL)open:(NSError**)error; /** * This method is called whenever body data has been received. * * It should return YES on success or NO on failure and set the "error" argument * which is guaranteed to be non-NULL. */ - (BOOL)writeData:(NSData*)data error:(NSError**)error; /** * This method is called after all body data has been received. * * It should return YES on success or NO on failure and set the "error" argument * which is guaranteed to be non-NULL. */ - (BOOL)close:(NSError**)error; @end /** * The GCDWebServerRequest class is instantiated by the GCDWebServerConnection * after the HTTP headers have been received. Each instance wraps a single HTTP * request. If a body is present, the methods from the GCDWebServerBodyWriter * protocol will be called by the GCDWebServerConnection to receive it. * * The default implementation of the GCDWebServerBodyWriter protocol on the class * simply ignores the body data. * * @warning GCDWebServerRequest instances can be created and used on any GCD thread. */ @interface GCDWebServerRequest : NSObject /** * Returns the HTTP method for the request. */ @property(nonatomic, readonly) NSString* method; /** * Returns the URL for the request. */ @property(nonatomic, readonly) NSURL* URL; /** * Returns the HTTP headers for the request. */ @property(nonatomic, readonly) NSDictionary* headers; /** * Returns the path component of the URL for the request. */ @property(nonatomic, readonly) NSString* path; /** * Returns the parsed and unescaped query component of the URL for the request. * * @warning This property will be nil if there is no query in the URL. */ @property(nonatomic, readonly) NSDictionary* query; /** * Returns the content type for the body of the request parsed from the * "Content-Type" header. * * 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 * "Content-Type" header. */ @property(nonatomic, readonly) NSString* contentType; /** * Returns the content length for the body of the request parsed from the * "Content-Length" header. * * 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 * chunked transfer encoding is used. */ @property(nonatomic, readonly) NSUInteger contentLength; /** * Returns the parsed "If-Modified-Since" header or nil if absent or malformed. */ @property(nonatomic, readonly) NSDate* ifModifiedSince; /** * Returns the parsed "If-None-Match" header or nil if absent or malformed. */ @property(nonatomic, readonly) NSString* ifNoneMatch; /** * 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 * of the entity body, or (NSUIntegerMax, length) if expressed from its end. */ @property(nonatomic, readonly) NSRange byteRange; /** * Returns YES if the client supports gzip content encoding according to the * "Accept-Encoding" header. */ @property(nonatomic, readonly) BOOL acceptsGzipContentEncoding; /** * Returns the address of the local peer (i.e. server) for the request * as a raw "struct sockaddr". */ @property(nonatomic, readonly) NSData* localAddressData; /** * Returns the address of the local peer (i.e. server) for the request * as a string. */ @property(nonatomic, readonly) NSString* localAddressString; /** * Returns the address of the remote peer (i.e. client) for the request * as a raw "struct sockaddr". */ @property(nonatomic, readonly) NSData* remoteAddressData; /** * Returns the address of the remote peer (i.e. client) for the request * as a string. */ @property(nonatomic, readonly) NSString* remoteAddressString; /** * This method is the designated initializer for the class. */ - (instancetype)initWithMethod:(NSString*)method url:(NSURL*)url headers:(NSDictionary*)headers path:(NSString*)path query:(NSDictionary*)query; /** * Convenience method that checks if the contentType property is defined. */ - (BOOL)hasBody; /** * Convenience method that checks if the byteRange property is defined. */ - (BOOL)hasByteRange; /** * Retrieves an attribute associated with this request using the given key. * * @return The attribute value for the key. */ - (id)attributeForKey:(NSString*)key; @end ================================================ FILE: src/ios/GCDWebServer/Core/GCDWebServerRequest.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import #import "GCDWebServerPrivate.h" NSString* const GCDWebServerRequestAttribute_RegexCaptures = @"GCDWebServerRequestAttribute_RegexCaptures"; #define kZlibErrorDomain @"ZlibErrorDomain" #define kGZipInitialBufferSize (256 * 1024) @interface GCDWebServerBodyDecoder : NSObject - (id)initWithRequest:(GCDWebServerRequest*)request writer:(id)writer; @end @interface GCDWebServerGZipDecoder : GCDWebServerBodyDecoder @end @interface GCDWebServerBodyDecoder () { @private GCDWebServerRequest* __unsafe_unretained _request; id __unsafe_unretained _writer; } @end @implementation GCDWebServerBodyDecoder - (id)initWithRequest:(GCDWebServerRequest*)request writer:(id)writer { if ((self = [super init])) { _request = request; _writer = writer; } return self; } - (BOOL)open:(NSError**)error { return [_writer open:error]; } - (BOOL)writeData:(NSData*)data error:(NSError**)error { return [_writer writeData:data error:error]; } - (BOOL)close:(NSError**)error { return [_writer close:error]; } @end @interface GCDWebServerGZipDecoder () { @private z_stream _stream; BOOL _finished; } @end @implementation GCDWebServerGZipDecoder - (BOOL)open:(NSError**)error { int result = inflateInit2(&_stream, 15 + 16); if (result != Z_OK) { if (error) { *error = [NSError errorWithDomain:kZlibErrorDomain code:result userInfo:nil]; } return NO; } if (![super open:error]) { inflateEnd(&_stream); return NO; } return YES; } - (BOOL)writeData:(NSData*)data error:(NSError**)error { GWS_DCHECK(!_finished); _stream.next_in = (Bytef*)data.bytes; _stream.avail_in = (uInt)data.length; NSMutableData* decodedData = [[NSMutableData alloc] initWithLength:kGZipInitialBufferSize]; if (decodedData == nil) { GWS_DNOT_REACHED(); return NO; } NSUInteger length = 0; while (1) { NSUInteger maxLength = decodedData.length - length; _stream.next_out = (Bytef*)((char*)decodedData.mutableBytes + length); _stream.avail_out = (uInt)maxLength; int result = inflate(&_stream, Z_NO_FLUSH); if ((result != Z_OK) && (result != Z_STREAM_END)) { if (error) { *error = [NSError errorWithDomain:kZlibErrorDomain code:result userInfo:nil]; } return NO; } length += maxLength - _stream.avail_out; if (_stream.avail_out > 0) { if (result == Z_STREAM_END) { _finished = YES; } break; } decodedData.length = 2 * decodedData.length; // zlib has used all the output buffer so resize it and try again in case more data is available } decodedData.length = length; BOOL success = length ? [super writeData:decodedData error:error] : YES; // No need to call writer if we have no data yet return success; } - (BOOL)close:(NSError**)error { GWS_DCHECK(_finished); inflateEnd(&_stream); return [super close:error]; } @end @interface GCDWebServerRequest () { @private NSString* _method; NSURL* _url; NSDictionary* _headers; NSString* _path; NSDictionary* _query; NSString* _type; BOOL _chunked; NSUInteger _length; NSDate* _modifiedSince; NSString* _noneMatch; NSRange _range; BOOL _gzipAccepted; NSData* _localAddress; NSData* _remoteAddress; BOOL _opened; NSMutableArray* _decoders; NSMutableDictionary* _attributes; id __unsafe_unretained _writer; } @end @implementation GCDWebServerRequest : NSObject @synthesize method = _method, URL = _url, headers = _headers, path = _path, query = _query, contentType = _type, contentLength = _length, ifModifiedSince = _modifiedSince, ifNoneMatch = _noneMatch, byteRange = _range, acceptsGzipContentEncoding = _gzipAccepted, usesChunkedTransferEncoding = _chunked, localAddressData = _localAddress, remoteAddressData = _remoteAddress; - (instancetype)initWithMethod:(NSString*)method url:(NSURL*)url headers:(NSDictionary*)headers path:(NSString*)path query:(NSDictionary*)query { if ((self = [super init])) { _method = [method copy]; _url = url; _headers = headers; _path = [path copy]; _query = query; _type = GCDWebServerNormalizeHeaderValue([_headers objectForKey:@"Content-Type"]); _chunked = [GCDWebServerNormalizeHeaderValue([_headers objectForKey:@"Transfer-Encoding"]) isEqualToString:@"chunked"]; NSString* lengthHeader = [_headers objectForKey:@"Content-Length"]; if (lengthHeader) { NSInteger length = [lengthHeader integerValue]; if (_chunked || (length < 0)) { GWS_LOG_WARNING(@"Invalid 'Content-Length' header '%@' for '%@' request on \"%@\"", lengthHeader, _method, _url); GWS_DNOT_REACHED(); return nil; } _length = length; if (_type == nil) { _type = kGCDWebServerDefaultMimeType; } } else if (_chunked) { if (_type == nil) { _type = kGCDWebServerDefaultMimeType; } _length = NSUIntegerMax; } else { if (_type) { GWS_LOG_WARNING(@"Ignoring 'Content-Type' header for '%@' request on \"%@\"", _method, _url); _type = nil; // Content-Type without Content-Length or chunked-encoding doesn't make sense } _length = NSUIntegerMax; } NSString* modifiedHeader = [_headers objectForKey:@"If-Modified-Since"]; if (modifiedHeader) { _modifiedSince = [GCDWebServerParseRFC822(modifiedHeader) copy]; } _noneMatch = [_headers objectForKey:@"If-None-Match"]; _range = NSMakeRange(NSUIntegerMax, 0); NSString* rangeHeader = GCDWebServerNormalizeHeaderValue([_headers objectForKey:@"Range"]); if (rangeHeader) { if ([rangeHeader hasPrefix:@"bytes="]) { NSArray* components = [[rangeHeader substringFromIndex:6] componentsSeparatedByString:@","]; if (components.count == 1) { components = [[components firstObject] componentsSeparatedByString:@"-"]; if (components.count == 2) { NSString* startString = [components objectAtIndex:0]; NSInteger startValue = [startString integerValue]; NSString* endString = [components objectAtIndex:1]; NSInteger endValue = [endString integerValue]; if (startString.length && (startValue >= 0) && endString.length && (endValue >= startValue)) { // The second 500 bytes: "500-999" _range.location = startValue; _range.length = endValue - startValue + 1; } else if (startString.length && (startValue >= 0)) { // The bytes after 9500 bytes: "9500-" _range.location = startValue; _range.length = NSUIntegerMax; } else if (endString.length && (endValue > 0)) { // The final 500 bytes: "-500" _range.location = NSUIntegerMax; _range.length = endValue; } } } } if ((_range.location == NSUIntegerMax) && (_range.length == 0)) { // Ignore "Range" header if syntactically invalid GWS_LOG_WARNING(@"Failed to parse 'Range' header \"%@\" for url: %@", rangeHeader, url); } } if ([[_headers objectForKey:@"Accept-Encoding"] rangeOfString:@"gzip"].location != NSNotFound) { _gzipAccepted = YES; } _decoders = [[NSMutableArray alloc] init]; _attributes = [[NSMutableDictionary alloc] init]; } return self; } - (BOOL)hasBody { return _type ? YES : NO; } - (BOOL)hasByteRange { return GCDWebServerIsValidByteRange(_range); } - (id)attributeForKey:(NSString*)key { return [_attributes objectForKey:key]; } - (BOOL)open:(NSError**)error { return YES; } - (BOOL)writeData:(NSData*)data error:(NSError**)error { return YES; } - (BOOL)close:(NSError**)error { return YES; } - (void)prepareForWriting { _writer = self; if ([GCDWebServerNormalizeHeaderValue([self.headers objectForKey:@"Content-Encoding"]) isEqualToString:@"gzip"]) { GCDWebServerGZipDecoder* decoder = [[GCDWebServerGZipDecoder alloc] initWithRequest:self writer:_writer]; [_decoders addObject:decoder]; _writer = decoder; } } - (BOOL)performOpen:(NSError**)error { GWS_DCHECK(_type); GWS_DCHECK(_writer); if (_opened) { GWS_DNOT_REACHED(); return NO; } _opened = YES; return [_writer open:error]; } - (BOOL)performWriteData:(NSData*)data error:(NSError**)error { GWS_DCHECK(_opened); return [_writer writeData:data error:error]; } - (BOOL)performClose:(NSError**)error { GWS_DCHECK(_opened); return [_writer close:error]; } - (void)setAttribute:(id)attribute forKey:(NSString*)key { [_attributes setValue:attribute forKey:key]; } - (NSString*)localAddressString { return GCDWebServerStringFromSockAddr(_localAddress.bytes, YES); } - (NSString*)remoteAddressString { return GCDWebServerStringFromSockAddr(_remoteAddress.bytes, YES); } - (NSString*)description { NSMutableString* description = [NSMutableString stringWithFormat:@"%@ %@", _method, _path]; for (NSString* argument in [[_query allKeys] sortedArrayUsingSelector:@selector(compare:)]) { [description appendFormat:@"\n %@ = %@", argument, [_query objectForKey:argument]]; } [description appendString:@"\n"]; for (NSString* header in [[_headers allKeys] sortedArrayUsingSelector:@selector(compare:)]) { [description appendFormat:@"\n%@: %@", header, [_headers objectForKey:header]]; } return description; } @end ================================================ FILE: src/ios/GCDWebServer/Core/GCDWebServerResponse.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import /** * The GCDWebServerBodyReaderCompletionBlock is passed by GCDWebServer to the * GCDWebServerBodyReader object when reading data from it asynchronously. */ typedef void (^GCDWebServerBodyReaderCompletionBlock)(NSData* data, NSError* error); /** * This protocol is used by the GCDWebServerConnection to communicate with * the GCDWebServerResponse and read the HTTP body data to send. * * Note that multiple GCDWebServerBodyReader objects can be chained together * internally e.g. to automatically apply gzip encoding to the content before * passing it on to the GCDWebServerResponse. * * @warning These methods can be called on any GCD thread. */ @protocol GCDWebServerBodyReader @required /** * This method is called before any body data is sent. * * It should return YES on success or NO on failure and set the "error" argument * which is guaranteed to be non-NULL. */ - (BOOL)open:(NSError**)error; /** * This method is called whenever body data is sent. * * 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 * the "error" argument which is guaranteed to be non-NULL. */ - (NSData*)readData:(NSError**)error; /** * This method is called after all body data has been sent. */ - (void)close; @optional /** * If this method is implemented, it will be preferred over -readData:. * * It must call the passed block when data is available, passing 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 pass an NSError along. */ - (void)asyncReadDataWithCompletion:(GCDWebServerBodyReaderCompletionBlock)block; @end /** * The GCDWebServerResponse class is used to wrap a single HTTP response. * It is instantiated by the handler of the GCDWebServer that handled the request. * If a body is present, the methods from the GCDWebServerBodyReader protocol * will be called by the GCDWebServerConnection to send it. * * The default implementation of the GCDWebServerBodyReader protocol * on the class simply returns an empty body. * * @warning GCDWebServerResponse instances can be created and used on any GCD thread. */ @interface GCDWebServerResponse : NSObject /** * Sets the content type for the body of the response. * * 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; /** * Sets the content length for the body of the response. If a body is present * but this property is set to "NSUIntegerMax", this means the length of the body * cannot be known ahead of time. Chunked transfer encoding will be * automatically enabled by the GCDWebServerConnection to comply with HTTP/1.1 * specifications. * * The default value is "NSUIntegerMax" i.e. the response has no body or its length * is undefined. */ @property(nonatomic) NSUInteger contentLength; /** * Sets the HTTP status code for the response. * * The default value is 200 i.e. "OK". */ @property(nonatomic) NSInteger statusCode; /** * Sets the caching hint for the response using the "Cache-Control" header. * This value is expressed in seconds. * * The default value is 0 i.e. "no-cache". */ @property(nonatomic) NSUInteger cacheControlMaxAge; /** * Sets the last modified date for the response using the "Last-Modified" header. * * The default value is nil. */ @property(nonatomic, retain) NSDate* lastModifiedDate; /** * Sets the ETag for the response using the "ETag" header. * * The default value is nil. */ @property(nonatomic, copy) NSString* eTag; /** * Enables gzip encoding for the response body. * * The default value is NO. * * @warning Enabling gzip encoding will remove any "Content-Length" header * since the length of the body is not known anymore. The client will still * be able to determine the body length when connection is closed per * HTTP/1.1 specifications. */ @property(nonatomic, getter=isGZipContentEncodingEnabled) BOOL gzipContentEncodingEnabled; /** * Creates an empty response. */ + (instancetype)response; /** * This method is the designated initializer for the class. */ - (instancetype)init; /** * Sets an additional HTTP header on the response. * Pass a nil value to remove an additional header. * * @warning Do not attempt to override the primary headers used * by GCDWebServerResponse like "Content-Type", "ETag", etc... */ - (void)setValue:(NSString*)value forAdditionalHeader:(NSString*)header; /** * Convenience method that checks if the contentType property is defined. */ - (BOOL)hasBody; @end @interface GCDWebServerResponse (Extensions) /** * Creates a empty response with a specific HTTP status code. */ + (instancetype)responseWithStatusCode:(NSInteger)statusCode; /** * Creates an HTTP redirect response to a new URL. */ + (instancetype)responseWithRedirect:(NSURL*)location permanent:(BOOL)permanent; /** * Initializes an empty response with a specific HTTP status code. */ - (instancetype)initWithStatusCode:(NSInteger)statusCode; /** * Initializes an HTTP redirect response to a new URL. */ - (instancetype)initWithRedirect:(NSURL*)location permanent:(BOOL)permanent; @end ================================================ FILE: src/ios/GCDWebServer/Core/GCDWebServerResponse.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import #import "GCDWebServerPrivate.h" #define kZlibErrorDomain @"ZlibErrorDomain" #define kGZipInitialBufferSize (256 * 1024) @interface GCDWebServerBodyEncoder : NSObject - (id)initWithResponse:(GCDWebServerResponse*)response reader:(id)reader; @end @interface GCDWebServerGZipEncoder : GCDWebServerBodyEncoder @end @interface GCDWebServerBodyEncoder () { @private GCDWebServerResponse* __unsafe_unretained _response; id __unsafe_unretained _reader; } @end @implementation GCDWebServerBodyEncoder - (id)initWithResponse:(GCDWebServerResponse*)response reader:(id)reader { if ((self = [super init])) { _response = response; _reader = reader; } return self; } - (BOOL)open:(NSError**)error { return [_reader open:error]; } - (NSData*)readData:(NSError**)error { return [_reader readData:error]; } - (void)close { [_reader close]; } @end @interface GCDWebServerGZipEncoder () { @private z_stream _stream; BOOL _finished; } @end @implementation GCDWebServerGZipEncoder - (id)initWithResponse:(GCDWebServerResponse*)response reader:(id)reader { if ((self = [super initWithResponse:response reader:reader])) { response.contentLength = NSUIntegerMax; // Make sure "Content-Length" header is not set since we don't know it [response setValue:@"gzip" forAdditionalHeader:@"Content-Encoding"]; } return self; } - (BOOL)open:(NSError**)error { int result = deflateInit2(&_stream, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 15 + 16, 8, Z_DEFAULT_STRATEGY); if (result != Z_OK) { if (error) { *error = [NSError errorWithDomain:kZlibErrorDomain code:result userInfo:nil]; } return NO; } if (![super open:error]) { deflateEnd(&_stream); return NO; } return YES; } - (NSData*)readData:(NSError**)error { NSMutableData* encodedData; if (_finished) { encodedData = [[NSMutableData alloc] init]; } else { encodedData = [[NSMutableData alloc] initWithLength:kGZipInitialBufferSize]; if (encodedData == nil) { GWS_DNOT_REACHED(); return nil; } NSUInteger length = 0; do { NSData* data = [super readData:error]; if (data == nil) { return nil; } _stream.next_in = (Bytef*)data.bytes; _stream.avail_in = (uInt)data.length; while (1) { NSUInteger maxLength = encodedData.length - length; _stream.next_out = (Bytef*)((char*)encodedData.mutableBytes + length); _stream.avail_out = (uInt)maxLength; int result = deflate(&_stream, data.length ? Z_NO_FLUSH : Z_FINISH); if (result == Z_STREAM_END) { _finished = YES; } else if (result != Z_OK) { if (error) { *error = [NSError errorWithDomain:kZlibErrorDomain code:result userInfo:nil]; } return nil; } length += maxLength - _stream.avail_out; if (_stream.avail_out > 0) { break; } encodedData.length = 2 * encodedData.length; // zlib has used all the output buffer so resize it and try again in case more data is available } GWS_DCHECK(_stream.avail_in == 0); } while (length == 0); // Make sure we don't return an empty NSData if not in finished state encodedData.length = length; } return encodedData; } - (void)close { deflateEnd(&_stream); [super close]; } @end @interface GCDWebServerResponse () { @private NSString* _type; NSUInteger _length; NSInteger _status; NSUInteger _maxAge; NSDate* _lastModified; NSString* _eTag; NSMutableDictionary* _headers; BOOL _chunked; BOOL _gzipped; BOOL _opened; NSMutableArray* _encoders; id __unsafe_unretained _reader; } @end @implementation GCDWebServerResponse @synthesize contentType = _type, contentLength = _length, statusCode = _status, cacheControlMaxAge = _maxAge, lastModifiedDate = _lastModified, eTag = _eTag, gzipContentEncodingEnabled = _gzipped, additionalHeaders = _headers; + (instancetype)response { return [[[self class] alloc] init]; } - (instancetype)init { if ((self = [super init])) { _type = nil; _length = NSUIntegerMax; _status = kGCDWebServerHTTPStatusCode_OK; _maxAge = 0; _headers = [[NSMutableDictionary alloc] init]; _encoders = [[NSMutableArray alloc] init]; } return self; } - (void)setValue:(NSString*)value forAdditionalHeader:(NSString*)header { [_headers setValue:value forKey:header]; } - (BOOL)hasBody { return _type ? YES : NO; } - (BOOL)usesChunkedTransferEncoding { return (_type != nil) && (_length == NSUIntegerMax); } - (BOOL)open:(NSError**)error { return YES; } - (NSData*)readData:(NSError**)error { return [NSData data]; } - (void)close { ; } - (void)prepareForReading { _reader = self; if (_gzipped) { GCDWebServerGZipEncoder* encoder = [[GCDWebServerGZipEncoder alloc] initWithResponse:self reader:_reader]; [_encoders addObject:encoder]; _reader = encoder; } } - (BOOL)performOpen:(NSError**)error { GWS_DCHECK(_type); GWS_DCHECK(_reader); if (_opened) { GWS_DNOT_REACHED(); return NO; } _opened = YES; return [_reader open:error]; } - (void)performReadDataWithCompletion:(GCDWebServerBodyReaderCompletionBlock)block { GWS_DCHECK(_opened); if ([_reader respondsToSelector:@selector(asyncReadDataWithCompletion:)]) { [_reader asyncReadDataWithCompletion:[block copy]]; } else { NSError* error = nil; NSData* data = [_reader readData:&error]; block(data, error); } } - (void)performClose { GWS_DCHECK(_opened); [_reader close]; } - (NSString*)description { NSMutableString* description = [NSMutableString stringWithFormat:@"Status Code = %i", (int)_status]; if (_type) { [description appendFormat:@"\nContent Type = %@", _type]; } if (_length != NSUIntegerMax) { [description appendFormat:@"\nContent Length = %lu", (unsigned long)_length]; } [description appendFormat:@"\nCache Control Max Age = %lu", (unsigned long)_maxAge]; if (_lastModified) { [description appendFormat:@"\nLast Modified Date = %@", _lastModified]; } if (_eTag) { [description appendFormat:@"\nETag = %@", _eTag]; } if (_headers.count) { [description appendString:@"\n"]; for (NSString* header in [[_headers allKeys] sortedArrayUsingSelector:@selector(compare:)]) { [description appendFormat:@"\n%@: %@", header, [_headers objectForKey:header]]; } } return description; } @end @implementation GCDWebServerResponse (Extensions) + (instancetype)responseWithStatusCode:(NSInteger)statusCode { return [[self alloc] initWithStatusCode:statusCode]; } + (instancetype)responseWithRedirect:(NSURL*)location permanent:(BOOL)permanent { return [[self alloc] initWithRedirect:location permanent:permanent]; } - (instancetype)initWithStatusCode:(NSInteger)statusCode { if ((self = [self init])) { self.statusCode = statusCode; } return self; } - (instancetype)initWithRedirect:(NSURL*)location permanent:(BOOL)permanent { if ((self = [self init])) { self.statusCode = permanent ? kGCDWebServerHTTPStatusCode_MovedPermanently : kGCDWebServerHTTPStatusCode_TemporaryRedirect; [self setValue:[location absoluteString] forAdditionalHeader:@"Location"]; } return self; } @end ================================================ FILE: src/ios/GCDWebServer/Requests/GCDWebServerDataRequest.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import "GCDWebServerRequest.h" /** * The GCDWebServerDataRequest subclass of GCDWebServerRequest stores the body * of the HTTP request in memory. */ @interface GCDWebServerDataRequest : GCDWebServerRequest /** * Returns the data for the request body. */ @property(nonatomic, readonly) NSData* data; @end @interface GCDWebServerDataRequest (Extensions) /** * Returns the data for the request body interpreted as text. If the content * type of the body is not a text one, or if an error occurs, nil is returned. * * The text encoding used to interpret the data is extracted from the * "Content-Type" header or defaults to UTF-8. */ @property(nonatomic, readonly) NSString* text; /** * Returns the data for the request body interpreted as a JSON object. If the * content type of the body is not JSON, or if an error occurs, nil is returned. */ @property(nonatomic, readonly) id jsonObject; @end ================================================ FILE: src/ios/GCDWebServer/Requests/GCDWebServerDataRequest.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import "GCDWebServerPrivate.h" @interface GCDWebServerDataRequest () { @private NSMutableData* _data; NSString* _text; id _jsonObject; } @end @implementation GCDWebServerDataRequest @synthesize data = _data; - (BOOL)open:(NSError**)error { if (self.contentLength != NSUIntegerMax) { _data = [[NSMutableData alloc] initWithCapacity:self.contentLength]; } else { _data = [[NSMutableData alloc] init]; } if (_data == nil) { if (error) { *error = [NSError errorWithDomain:kGCDWebServerErrorDomain code:-1 userInfo:@{ NSLocalizedDescriptionKey : @"Failed allocating memory" }]; } return NO; } return YES; } - (BOOL)writeData:(NSData*)data error:(NSError**)error { [_data appendData:data]; return YES; } - (BOOL)close:(NSError**)error { return YES; } - (NSString*)description { NSMutableString* description = [NSMutableString stringWithString:[super description]]; if (_data) { [description appendString:@"\n\n"]; [description appendString:GCDWebServerDescribeData(_data, self.contentType)]; } return description; } @end @implementation GCDWebServerDataRequest (Extensions) - (NSString*)text { if (_text == nil) { if ([self.contentType hasPrefix:@"text/"]) { NSString* charset = GCDWebServerExtractHeaderValueParameter(self.contentType, @"charset"); _text = [[NSString alloc] initWithData:self.data encoding:GCDWebServerStringEncodingFromCharset(charset)]; } else { GWS_DNOT_REACHED(); } } return _text; } - (id)jsonObject { if (_jsonObject == nil) { NSString* mimeType = GCDWebServerTruncateHeaderValue(self.contentType); if ([mimeType isEqualToString:@"application/json"] || [mimeType isEqualToString:@"text/json"] || [mimeType isEqualToString:@"text/javascript"]) { _jsonObject = [NSJSONSerialization JSONObjectWithData:_data options:0 error:NULL]; } else { GWS_DNOT_REACHED(); } } return _jsonObject; } @end ================================================ FILE: src/ios/GCDWebServer/Requests/GCDWebServerFileRequest.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import "GCDWebServerRequest.h" /** * The GCDWebServerFileRequest subclass of GCDWebServerRequest stores the body * of the HTTP request to a file on disk. */ @interface GCDWebServerFileRequest : GCDWebServerRequest /** * Returns the path to the temporary file containing the request body. * * @warning This temporary file will be automatically deleted when the * GCDWebServerFileRequest is deallocated. If you want to preserve this file, * you must move it to a different location beforehand. */ @property(nonatomic, readonly) NSString* temporaryPath; @end ================================================ FILE: src/ios/GCDWebServer/Requests/GCDWebServerFileRequest.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import "GCDWebServerPrivate.h" @interface GCDWebServerFileRequest () { @private NSString* _temporaryPath; int _file; } @end @implementation GCDWebServerFileRequest @synthesize temporaryPath = _temporaryPath; - (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])) { _temporaryPath = [NSTemporaryDirectory() stringByAppendingPathComponent:[[NSProcessInfo processInfo] globallyUniqueString]]; } return self; } - (void)dealloc { unlink([_temporaryPath fileSystemRepresentation]); } - (BOOL)open:(NSError**)error { _file = open([_temporaryPath fileSystemRepresentation], O_CREAT | O_TRUNC | O_WRONLY, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); if (_file <= 0) { if (error) { *error = GCDWebServerMakePosixError(errno); } return NO; } return YES; } - (BOOL)writeData:(NSData*)data error:(NSError**)error { if (write(_file, data.bytes, data.length) != (ssize_t)data.length) { if (error) { *error = GCDWebServerMakePosixError(errno); } return NO; } return YES; } - (BOOL)close:(NSError**)error { if (close(_file) < 0) { if (error) { *error = GCDWebServerMakePosixError(errno); } return NO; } #ifdef __GCDWEBSERVER_ENABLE_TESTING__ NSString* creationDateHeader = [self.headers objectForKey:@"X-GCDWebServer-CreationDate"]; if (creationDateHeader) { NSDate* date = GCDWebServerParseISO8601(creationDateHeader); if (!date || ![[NSFileManager defaultManager] setAttributes:@{ NSFileCreationDate : date } ofItemAtPath:_temporaryPath error:error]) { return NO; } } NSString* modifiedDateHeader = [self.headers objectForKey:@"X-GCDWebServer-ModifiedDate"]; if (modifiedDateHeader) { NSDate* date = GCDWebServerParseRFC822(modifiedDateHeader); if (!date || ![[NSFileManager defaultManager] setAttributes:@{ NSFileModificationDate : date } ofItemAtPath:_temporaryPath error:error]) { return NO; } } #endif return YES; } - (NSString*)description { NSMutableString* description = [NSMutableString stringWithString:[super description]]; [description appendFormat:@"\n\n{%@}", _temporaryPath]; return description; } @end ================================================ FILE: src/ios/GCDWebServer/Requests/GCDWebServerMultiPartFormRequest.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import "GCDWebServerRequest.h" /** * The GCDWebServerMultiPart class is an abstract class that wraps the content * of a part. */ @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" * if not available (per HTTP specifications). */ @property(nonatomic, readonly) NSString* contentType; /** * Returns the MIME type component of the content type for the part. */ @property(nonatomic, readonly) NSString* mimeType; @end /** * The GCDWebServerMultiPartArgument subclass of GCDWebServerMultiPart wraps * the content of a part as data in memory. */ @interface GCDWebServerMultiPartArgument : GCDWebServerMultiPart /** * Returns the data for the part. */ @property(nonatomic, readonly) NSData* data; /** * Returns the data for the part interpreted as text. If the content * type of the part is not a text one, or if an error occurs, nil is returned. * * The text encoding used to interpret the data is extracted from the * "Content-Type" header or defaults to UTF-8. */ @property(nonatomic, readonly) NSString* string; @end /** * The GCDWebServerMultiPartFile subclass of GCDWebServerMultiPart wraps * the content of a part as a file on disk. */ @interface GCDWebServerMultiPartFile : GCDWebServerMultiPart /** * Returns the file name retrieved from the part headers. */ @property(nonatomic, readonly) NSString* fileName; /** * Returns the path to the temporary file containing the part data. * * @warning This temporary file will be automatically deleted when the * GCDWebServerMultiPartFile is deallocated. If you want to preserve this file, * you must move it to a different location beforehand. */ @property(nonatomic, readonly) NSString* temporaryPath; @end /** * The GCDWebServerMultiPartFormRequest subclass of GCDWebServerRequest * parses the body of the HTTP request as a multipart encoded form. */ @interface GCDWebServerMultiPartFormRequest : GCDWebServerRequest /** * Returns the argument parts from the multipart encoded form as * name / GCDWebServerMultiPartArgument pairs. */ @property(nonatomic, readonly) NSArray* arguments; /** * Returns the files parts from the multipart encoded form as * name / GCDWebServerMultiPartFile pairs. */ @property(nonatomic, readonly) NSArray* files; /** * Returns the MIME type for multipart encoded forms * i.e. "multipart/form-data". */ + (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 ================================================ FILE: src/ios/GCDWebServer/Requests/GCDWebServerMultiPartFormRequest.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import "GCDWebServerPrivate.h" #define kMultiPartBufferSize (256 * 1024) typedef enum { kParserState_Undefined = 0, kParserState_Start, kParserState_Headers, kParserState_Content, 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* _newlinesData = nil; static NSData* _dashNewlineData = nil; @interface GCDWebServerMultiPart () { @private NSString* _controlName; NSString* _contentType; NSString* _mimeType; } @end @implementation GCDWebServerMultiPart @synthesize controlName = _controlName, contentType = _contentType, mimeType = _mimeType; - (id)initWithControlName:(NSString*)name contentType:(NSString*)type { if ((self = [super init])) { _controlName = [name copy]; _contentType = [type copy]; _mimeType = GCDWebServerTruncateHeaderValue(_contentType); } return self; } @end @interface GCDWebServerMultiPartArgument () { @private NSData* _data; NSString* _string; } @end @implementation GCDWebServerMultiPartArgument @synthesize data = _data, string = _string; - (id)initWithControlName:(NSString*)name contentType:(NSString*)type data:(NSData*)data { if ((self = [super initWithControlName:name contentType:type])) { _data = data; if ([self.contentType hasPrefix:@"text/"]) { NSString* charset = GCDWebServerExtractHeaderValueParameter(self.contentType, @"charset"); _string = [[NSString alloc] initWithData:_data encoding:GCDWebServerStringEncodingFromCharset(charset)]; } } return self; } - (NSString*)description { return [NSString stringWithFormat:@"<%@ | '%@' | %lu bytes>", [self class], self.mimeType, (unsigned long)_data.length]; } @end @interface GCDWebServerMultiPartFile () { @private NSString* _fileName; NSString* _temporaryPath; } @end @implementation GCDWebServerMultiPartFile @synthesize fileName = _fileName, temporaryPath = _temporaryPath; - (id)initWithControlName:(NSString*)name contentType:(NSString*)type fileName:(NSString*)fileName temporaryPath:(NSString*)temporaryPath { if ((self = [super initWithControlName:name contentType:type])) { _fileName = [fileName copy]; _temporaryPath = [temporaryPath copy]; } return self; } - (void)dealloc { unlink([_temporaryPath fileSystemRepresentation]); } - (NSString*)description { return [NSString stringWithFormat:@"<%@ | '%@' | '%@>'", [self class], self.mimeType, _fileName]; } @end @interface GCDWebServerMIMEStreamParser () { @private NSData* _boundary; NSString* _defaultcontrolName; ParserState _state; NSMutableData* _data; NSMutableArray* _arguments; NSMutableArray* _files; NSString* _controlName; NSString* _fileName; NSString* _contentType; NSString* _tmpPath; int _tmpFile; GCDWebServerMIMEStreamParser* _subParser; } @end @implementation GCDWebServerMIMEStreamParser + (void)initialize { if (_newlineData == nil) { _newlineData = [[NSData alloc] initWithBytes:"\r\n" length:2]; GWS_DCHECK(_newlineData); } if (_newlinesData == nil) { _newlinesData = [[NSData alloc] initWithBytes:"\r\n\r\n" length:4]; GWS_DCHECK(_newlinesData); } if (_dashNewlineData == nil) { _dashNewlineData = [[NSData alloc] initWithBytes:"--\r\n" length:4]; GWS_DCHECK(_dashNewlineData); } } - (id)initWithBoundary:(NSString*)boundary defaultControlName:(NSString*)name arguments:(NSMutableArray*)arguments files:(NSMutableArray*)files { NSData* data = boundary.length ? [[NSString stringWithFormat:@"--%@", boundary] dataUsingEncoding:NSASCIIStringEncoding] : nil; if (data == nil) { GWS_DNOT_REACHED(); return nil; } if ((self = [super init])) { _boundary = data; _defaultcontrolName = name; _arguments = arguments; _files = files; _data = [[NSMutableData alloc] initWithCapacity:kMultiPartBufferSize]; _state = kParserState_Start; } return self; } - (void)dealloc { if (_tmpFile > 0) { close(_tmpFile); unlink([_tmpPath fileSystemRepresentation]); } } // http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2 - (BOOL)_parseData { BOOL success = YES; if (_state == kParserState_Headers) { NSRange range = [_data rangeOfData:_newlinesData options:0 range:NSMakeRange(0, _data.length)]; if (range.location != NSNotFound) { _controlName = nil; _fileName = nil; _contentType = nil; _tmpPath = nil; _subParser = nil; NSString* headers = [[NSString alloc] initWithData:[_data subdataWithRange:NSMakeRange(0, range.location)] encoding:NSUTF8StringEncoding]; if (headers) { for (NSString* header in [headers componentsSeparatedByString:@"\r\n"]) { NSRange subRange = [header rangeOfString:@":"]; if (subRange.location != NSNotFound) { NSString* name = [header substringToIndex:subRange.location]; NSString* value = [[header substringFromIndex:(subRange.location + subRange.length)] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]]; if ([name caseInsensitiveCompare:@"Content-Type"] == NSOrderedSame) { _contentType = GCDWebServerNormalizeHeaderValue(value); } else if ([name caseInsensitiveCompare:@"Content-Disposition"] == NSOrderedSame) { NSString* contentDisposition = GCDWebServerNormalizeHeaderValue(value); if ([GCDWebServerTruncateHeaderValue(contentDisposition) isEqualToString:@"form-data"]) { _controlName = GCDWebServerExtractHeaderValueParameter(contentDisposition, @"name"); _fileName = GCDWebServerExtractHeaderValueParameter(contentDisposition, @"filename"); } else if ([GCDWebServerTruncateHeaderValue(contentDisposition) isEqualToString:@"file"]) { _controlName = _defaultcontrolName; _fileName = GCDWebServerExtractHeaderValueParameter(contentDisposition, @"filename"); } } } else { GWS_DNOT_REACHED(); } } if (_contentType == nil) { _contentType = @"text/plain"; } } else { GWS_LOG_ERROR(@"Failed decoding headers in part of 'multipart/form-data'"); GWS_DNOT_REACHED(); } if (_controlName) { 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) { GWS_DNOT_REACHED(); success = NO; } } else if (_fileName) { 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); if (_tmpFile > 0) { _tmpPath = [path copy]; } else { GWS_DNOT_REACHED(); success = NO; } } } else { GWS_DNOT_REACHED(); success = NO; } [_data replaceBytesInRange:NSMakeRange(0, range.location + range.length) withBytes:NULL length:0]; _state = kParserState_Content; } } if ((_state == kParserState_Start) || (_state == kParserState_Content)) { NSRange range = [_data rangeOfData:_boundary options:0 range:NSMakeRange(0, _data.length)]; if (range.location != NSNotFound) { NSRange subRange = NSMakeRange(range.location + range.length, _data.length - range.location - range.length); NSRange subRange1 = [_data rangeOfData:_newlineData options:NSDataSearchAnchored range:subRange]; NSRange subRange2 = [_data rangeOfData:_dashNewlineData options:NSDataSearchAnchored range:subRange]; if ((subRange1.location != NSNotFound) || (subRange2.location != NSNotFound)) { if (_state == kParserState_Content) { const void* dataBytes = _data.bytes; NSUInteger dataLength = range.location - 2; if (_subParser) { if (![_subParser appendBytes:dataBytes length:(dataLength + 2)] || ![_subParser isAtEnd]) { GWS_DNOT_REACHED(); success = NO; } _subParser = nil; } else if (_tmpPath) { ssize_t result = write(_tmpFile, dataBytes, dataLength); if (result == (ssize_t)dataLength) { if (close(_tmpFile) == 0) { _tmpFile = 0; GCDWebServerMultiPartFile* file = [[GCDWebServerMultiPartFile alloc] initWithControlName:_controlName contentType:_contentType fileName:_fileName temporaryPath:_tmpPath]; [_files addObject:file]; } else { GWS_DNOT_REACHED(); success = NO; } } else { GWS_DNOT_REACHED(); success = NO; } _tmpPath = nil; } else { NSData* data = [[NSData alloc] initWithBytes:(void*)dataBytes length:dataLength]; GCDWebServerMultiPartArgument* argument = [[GCDWebServerMultiPartArgument alloc] initWithControlName:_controlName contentType:_contentType data:data]; [_arguments addObject:argument]; } } if (subRange1.location != NSNotFound) { [_data replaceBytesInRange:NSMakeRange(0, subRange1.location + subRange1.length) withBytes:NULL length:0]; _state = kParserState_Headers; success = [self _parseData]; } else { _state = kParserState_End; } } } else { NSUInteger margin = 2 * _boundary.length; if (_data.length > margin) { NSUInteger length = _data.length - margin; if (_subParser) { if ([_subParser appendBytes:_data.bytes length:length]) { [_data replaceBytesInRange:NSMakeRange(0, length) withBytes:NULL length:0]; } else { GWS_DNOT_REACHED(); 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 { GWS_DNOT_REACHED(); success = NO; } } } } } 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; } - (BOOL)open:(NSError**)error { NSString* boundary = GCDWebServerExtractHeaderValueParameter(self.contentType, @"boundary"); _parser = [[GCDWebServerMIMEStreamParser alloc] initWithBoundary:boundary defaultControlName:nil arguments:_arguments files:_files]; if (_parser == nil) { if (error) { *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 { if (![_parser appendBytes:data.bytes length:data.length]) { if (error) { *error = [NSError errorWithDomain:kGCDWebServerErrorDomain code:-1 userInfo:@{ NSLocalizedDescriptionKey : @"Failed continuing to parse multipart form data" }]; } return NO; } return YES; } - (BOOL)close:(NSError**)error { BOOL atEnd = [_parser isAtEnd]; _parser = nil; if (!atEnd) { if (error) { *error = [NSError errorWithDomain:kGCDWebServerErrorDomain code:-1 userInfo:@{ NSLocalizedDescriptionKey : @"Failed finishing to parse multipart form data" }]; } return NO; } 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 { NSMutableString* description = [NSMutableString stringWithString:[super description]]; if (_arguments.count) { [description appendString:@"\n"]; for (GCDWebServerMultiPartArgument* argument in _arguments) { [description appendFormat:@"\n%@ (%@)\n", argument.controlName, argument.contentType]; [description appendString:GCDWebServerDescribeData(argument.data, argument.contentType)]; } } if (_files.count) { [description appendString:@"\n"]; for (GCDWebServerMultiPartFile* file in _files) { [description appendFormat:@"\n%@ (%@): %@\n{%@}", file.controlName, file.contentType, file.fileName, file.temporaryPath]; } } return description; } @end ================================================ FILE: src/ios/GCDWebServer/Requests/GCDWebServerURLEncodedFormRequest.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import "GCDWebServerDataRequest.h" /** * The GCDWebServerURLEncodedFormRequest subclass of GCDWebServerRequest * parses the body of the HTTP request as a URL encoded form using * GCDWebServerParseURLEncodedForm(). */ @interface GCDWebServerURLEncodedFormRequest : GCDWebServerDataRequest /** * Returns the unescaped control names and values for the URL encoded form. * * The text encoding used to interpret the data is extracted from the * "Content-Type" header or defaults to UTF-8. */ @property(nonatomic, readonly) NSDictionary* arguments; /** * Returns the MIME type for URL encoded forms * i.e. "application/x-www-form-urlencoded". */ + (NSString*)mimeType; @end ================================================ FILE: src/ios/GCDWebServer/Requests/GCDWebServerURLEncodedFormRequest.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import "GCDWebServerPrivate.h" @interface GCDWebServerURLEncodedFormRequest () { @private NSDictionary* _arguments; } @end @implementation GCDWebServerURLEncodedFormRequest @synthesize arguments = _arguments; + (NSString*)mimeType { return @"application/x-www-form-urlencoded"; } - (BOOL)close:(NSError**)error { if (![super close:error]) { return NO; } NSString* charset = GCDWebServerExtractHeaderValueParameter(self.contentType, @"charset"); NSString* string = [[NSString alloc] initWithData:self.data encoding:GCDWebServerStringEncodingFromCharset(charset)]; _arguments = GCDWebServerParseURLEncodedForm(string); GWS_DCHECK(_arguments); return YES; } - (NSString*)description { NSMutableString* description = [NSMutableString stringWithString:[super description]]; [description appendString:@"\n"]; for (NSString* argument in [[_arguments allKeys] sortedArrayUsingSelector:@selector(compare:)]) { [description appendFormat:@"\n%@ = %@", argument, [_arguments objectForKey:argument]]; } return description; } @end ================================================ FILE: src/ios/GCDWebServer/Responses/GCDWebServerDataResponse.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import "GCDWebServerResponse.h" /** * The GCDWebServerDataResponse subclass of GCDWebServerResponse reads the body * of the HTTP response from memory. */ @interface GCDWebServerDataResponse : GCDWebServerResponse /** * Creates a response with data in memory and a given content type. */ + (instancetype)responseWithData:(NSData*)data contentType:(NSString*)type; /** * This method is the designated initializer for the class. */ - (instancetype)initWithData:(NSData*)data contentType:(NSString*)type; @end @interface GCDWebServerDataResponse (Extensions) /** * Creates a data response from text encoded using UTF-8. */ + (instancetype)responseWithText:(NSString*)text; /** * Creates a data response from HTML encoded using UTF-8. */ + (instancetype)responseWithHTML:(NSString*)html; /** * Creates a data response from an HTML template encoded using UTF-8. * See -initWithHTMLTemplate:variables: for details. */ + (instancetype)responseWithHTMLTemplate:(NSString*)path variables:(NSDictionary*)variables; /** * Creates a data response from a serialized JSON object and the default * "application/json" content type. */ + (instancetype)responseWithJSONObject:(id)object; /** * Creates a data response from a serialized JSON object and a custom * content type. */ + (instancetype)responseWithJSONObject:(id)object contentType:(NSString*)type; /** * Initializes a data response from text encoded using UTF-8. */ - (instancetype)initWithText:(NSString*)text; /** * Initializes a data response from HTML encoded using UTF-8. */ - (instancetype)initWithHTML:(NSString*)html; /** * Initializes a data response from an HTML template encoded using UTF-8. * * All occurences of "%variable%" within the HTML template are replaced with * their corresponding values. */ - (instancetype)initWithHTMLTemplate:(NSString*)path variables:(NSDictionary*)variables; /** * Initializes a data response from a serialized JSON object and the default * "application/json" content type. */ - (instancetype)initWithJSONObject:(id)object; /** * Initializes a data response from a serialized JSON object and a custom * content type. */ - (instancetype)initWithJSONObject:(id)object contentType:(NSString*)type; @end ================================================ FILE: src/ios/GCDWebServer/Responses/GCDWebServerDataResponse.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import "GCDWebServerPrivate.h" @interface GCDWebServerDataResponse () { @private NSData* _data; BOOL _done; } @end @implementation GCDWebServerDataResponse + (instancetype)responseWithData:(NSData*)data contentType:(NSString*)type { return [[[self class] alloc] initWithData:data contentType:type]; } - (instancetype)initWithData:(NSData*)data contentType:(NSString*)type { if (data == nil) { GWS_DNOT_REACHED(); return nil; } if ((self = [super init])) { _data = data; self.contentType = type; self.contentLength = data.length; } return self; } - (NSData*)readData:(NSError**)error { NSData* data; if (_done) { data = [NSData data]; } else { data = _data; _done = YES; } return data; } - (NSString*)description { NSMutableString* description = [NSMutableString stringWithString:[super description]]; [description appendString:@"\n\n"]; [description appendString:GCDWebServerDescribeData(_data, self.contentType)]; return description; } @end @implementation GCDWebServerDataResponse (Extensions) + (instancetype)responseWithText:(NSString*)text { return [[self alloc] initWithText:text]; } + (instancetype)responseWithHTML:(NSString*)html { return [[self alloc] initWithHTML:html]; } + (instancetype)responseWithHTMLTemplate:(NSString*)path variables:(NSDictionary*)variables { return [[self alloc] initWithHTMLTemplate:path variables:variables]; } + (instancetype)responseWithJSONObject:(id)object { return [[self alloc] initWithJSONObject:object]; } + (instancetype)responseWithJSONObject:(id)object contentType:(NSString*)type { return [[self alloc] initWithJSONObject:object contentType:type]; } - (instancetype)initWithText:(NSString*)text { NSData* data = [text dataUsingEncoding:NSUTF8StringEncoding]; if (data == nil) { GWS_DNOT_REACHED(); return nil; } return [self initWithData:data contentType:@"text/plain; charset=utf-8"]; } - (instancetype)initWithHTML:(NSString*)html { NSData* data = [html dataUsingEncoding:NSUTF8StringEncoding]; if (data == nil) { GWS_DNOT_REACHED(); return nil; } return [self initWithData:data contentType:@"text/html; charset=utf-8"]; } - (instancetype)initWithHTMLTemplate:(NSString*)path variables:(NSDictionary*)variables { NSMutableString* html = [[NSMutableString alloc] initWithContentsOfFile:path encoding:NSUTF8StringEncoding error:NULL]; [variables enumerateKeysAndObjectsUsingBlock:^(NSString* key, NSString* value, BOOL* stop) { [html replaceOccurrencesOfString:[NSString stringWithFormat:@"%%%@%%", key] withString:value options:0 range:NSMakeRange(0, html.length)]; }]; id response = [self initWithHTML:html]; return response; } - (instancetype)initWithJSONObject:(id)object { return [self initWithJSONObject:object contentType:@"application/json"]; } - (instancetype)initWithJSONObject:(id)object contentType:(NSString*)type { NSData* data = [NSJSONSerialization dataWithJSONObject:object options:0 error:NULL]; if (data == nil) { return nil; } return [self initWithData:data contentType:type]; } @end ================================================ FILE: src/ios/GCDWebServer/Responses/GCDWebServerErrorResponse.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import "GCDWebServerDataResponse.h" #import "GCDWebServerHTTPStatusCodes.h" /** * The GCDWebServerDataResponse subclass of GCDWebServerDataResponse generates * an HTML body from an HTTP status code and an error message. */ @interface GCDWebServerErrorResponse : GCDWebServerDataResponse /** * Creates a client error response with the corresponding HTTP status code. */ + (instancetype)responseWithClientError:(GCDWebServerClientErrorHTTPStatusCode)errorCode message:(NSString*)format, ... NS_FORMAT_FUNCTION(2, 3); /** * Creates a server error response with the corresponding HTTP status code. */ + (instancetype)responseWithServerError:(GCDWebServerServerErrorHTTPStatusCode)errorCode message:(NSString*)format, ... NS_FORMAT_FUNCTION(2, 3); /** * Creates a client error response with the corresponding HTTP status code * and an underlying NSError. */ + (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 * and an underlying NSError. */ + (instancetype)responseWithServerError:(GCDWebServerServerErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... NS_FORMAT_FUNCTION(3, 4); /** * Initializes a client error response with the corresponding HTTP status code. */ - (instancetype)initWithClientError:(GCDWebServerClientErrorHTTPStatusCode)errorCode message:(NSString*)format, ... NS_FORMAT_FUNCTION(2, 3); /** * Initializes a server error response with the corresponding HTTP status code. */ - (instancetype)initWithServerError:(GCDWebServerServerErrorHTTPStatusCode)errorCode message:(NSString*)format, ... NS_FORMAT_FUNCTION(2, 3); /** * Initializes a client error response with the corresponding HTTP status code * and an underlying NSError. */ - (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 * and an underlying NSError. */ - (instancetype)initWithServerError:(GCDWebServerServerErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... NS_FORMAT_FUNCTION(3, 4); @end ================================================ FILE: src/ios/GCDWebServer/Responses/GCDWebServerErrorResponse.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import "GCDWebServerPrivate.h" @interface GCDWebServerErrorResponse () - (instancetype)initWithStatusCode:(NSInteger)statusCode underlyingError:(NSError*)underlyingError messageFormat:(NSString*)format arguments:(va_list)arguments; @end @implementation GCDWebServerErrorResponse + (instancetype)responseWithClientError:(GCDWebServerClientErrorHTTPStatusCode)errorCode message:(NSString*)format, ... { GWS_DCHECK(((NSInteger)errorCode >= 400) && ((NSInteger)errorCode < 500)); va_list arguments; va_start(arguments, format); GCDWebServerErrorResponse* response = [[self alloc] initWithStatusCode:errorCode underlyingError:nil messageFormat:format arguments:arguments]; va_end(arguments); return response; } + (instancetype)responseWithServerError:(GCDWebServerServerErrorHTTPStatusCode)errorCode message:(NSString*)format, ... { GWS_DCHECK(((NSInteger)errorCode >= 500) && ((NSInteger)errorCode < 600)); va_list arguments; va_start(arguments, format); GCDWebServerErrorResponse* response = [[self alloc] initWithStatusCode:errorCode underlyingError:nil messageFormat:format arguments:arguments]; va_end(arguments); return response; } + (instancetype)responseWithClientError:(GCDWebServerClientErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... { GWS_DCHECK(((NSInteger)errorCode >= 400) && ((NSInteger)errorCode < 500)); va_list arguments; va_start(arguments, format); GCDWebServerErrorResponse* response = [[self alloc] initWithStatusCode:errorCode underlyingError:underlyingError messageFormat:format arguments:arguments]; va_end(arguments); return response; } + (instancetype)responseWithServerError:(GCDWebServerServerErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... { GWS_DCHECK(((NSInteger)errorCode >= 500) && ((NSInteger)errorCode < 600)); va_list arguments; va_start(arguments, format); GCDWebServerErrorResponse* response = [[self alloc] initWithStatusCode:errorCode underlyingError:underlyingError messageFormat:format arguments:arguments]; va_end(arguments); return response; } static inline NSString* _EscapeHTMLString(NSString* string) { return [string stringByReplacingOccurrencesOfString:@"\"" withString:@"""]; } - (instancetype)initWithStatusCode:(NSInteger)statusCode underlyingError:(NSError*)underlyingError messageFormat:(NSString*)format arguments:(va_list)arguments { NSString* message = [[NSString alloc] initWithFormat:format arguments:arguments]; NSString* title = [NSString stringWithFormat:@"HTTP Error %i", (int)statusCode]; NSString* error = underlyingError ? [NSString stringWithFormat:@"[%@] %@ (%li)", underlyingError.domain, _EscapeHTMLString(underlyingError.localizedDescription), (long)underlyingError.code] : @""; NSString* html = [NSString stringWithFormat:@"%@

%@: %@

%@

", title, title, _EscapeHTMLString(message), error]; if ((self = [self initWithHTML:html])) { self.statusCode = statusCode; } return self; } - (instancetype)initWithClientError:(GCDWebServerClientErrorHTTPStatusCode)errorCode message:(NSString*)format, ... { GWS_DCHECK(((NSInteger)errorCode >= 400) && ((NSInteger)errorCode < 500)); va_list arguments; va_start(arguments, format); self = [self initWithStatusCode:errorCode underlyingError:nil messageFormat:format arguments:arguments]; va_end(arguments); return self; } - (instancetype)initWithServerError:(GCDWebServerServerErrorHTTPStatusCode)errorCode message:(NSString*)format, ... { GWS_DCHECK(((NSInteger)errorCode >= 500) && ((NSInteger)errorCode < 600)); va_list arguments; va_start(arguments, format); self = [self initWithStatusCode:errorCode underlyingError:nil messageFormat:format arguments:arguments]; va_end(arguments); return self; } - (instancetype)initWithClientError:(GCDWebServerClientErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... { GWS_DCHECK(((NSInteger)errorCode >= 400) && ((NSInteger)errorCode < 500)); va_list arguments; va_start(arguments, format); self = [self initWithStatusCode:errorCode underlyingError:underlyingError messageFormat:format arguments:arguments]; va_end(arguments); return self; } - (instancetype)initWithServerError:(GCDWebServerServerErrorHTTPStatusCode)errorCode underlyingError:(NSError*)underlyingError message:(NSString*)format, ... { GWS_DCHECK(((NSInteger)errorCode >= 500) && ((NSInteger)errorCode < 600)); va_list arguments; va_start(arguments, format); self = [self initWithStatusCode:errorCode underlyingError:underlyingError messageFormat:format arguments:arguments]; va_end(arguments); return self; } @end ================================================ FILE: src/ios/GCDWebServer/Responses/GCDWebServerFileResponse.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import "GCDWebServerResponse.h" /** * The GCDWebServerFileResponse subclass of GCDWebServerResponse reads the body * 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 /** * Creates a response with the contents of a file. */ + (instancetype)responseWithFile:(NSString*)path; /** * Creates a response like +responseWithFile: and sets the "Content-Disposition" * HTTP header for a download if the "attachment" argument is YES. */ + (instancetype)responseWithFile:(NSString*)path isAttachment:(BOOL)attachment; /** * Creates a response like +responseWithFile: but restricts the file contents * to a specific byte range. * * See -initWithFile:byteRange: for details. */ + (instancetype)responseWithFile:(NSString*)path byteRange:(NSRange)range; /** * Creates a response like +responseWithFile:byteRange: and sets the * "Content-Disposition" HTTP header for a download if the "attachment" * argument is YES. */ + (instancetype)responseWithFile:(NSString*)path byteRange:(NSRange)range isAttachment:(BOOL)attachment; /** * Initializes a response with the contents of a file. */ - (instancetype)initWithFile:(NSString*)path; /** * Initializes a response like +responseWithFile: and sets the * "Content-Disposition" HTTP header for a download if the "attachment" * argument is YES. */ - (instancetype)initWithFile:(NSString*)path isAttachment:(BOOL)attachment; /** * Initializes a response like -initWithFile: but restricts the file contents * 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, * 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 * actual size of the file. * * This argument would typically be set to the value of the byteRange property * of the current GCDWebServerRequest. */ - (instancetype)initWithFile:(NSString*)path byteRange:(NSRange)range; /** * This method is the designated initializer for the class. */ - (instancetype)initWithFile:(NSString*)path byteRange:(NSRange)range isAttachment:(BOOL)attachment; @end ================================================ FILE: src/ios/GCDWebServer/Responses/GCDWebServerFileResponse.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import #import "GCDWebServerPrivate.h" #define kFileReadBufferSize (32 * 1024) @interface GCDWebServerFileResponse () { @private NSString* _path; NSUInteger _offset; NSUInteger _size; int _file; } @end @implementation GCDWebServerFileResponse + (instancetype)responseWithFile:(NSString*)path { return [[[self class] alloc] initWithFile:path]; } + (instancetype)responseWithFile:(NSString*)path isAttachment:(BOOL)attachment { return [[[self class] alloc] initWithFile:path isAttachment:attachment]; } + (instancetype)responseWithFile:(NSString*)path byteRange:(NSRange)range { return [[[self class] alloc] initWithFile:path byteRange:range]; } + (instancetype)responseWithFile:(NSString*)path byteRange:(NSRange)range isAttachment:(BOOL)attachment { return [[[self class] alloc] initWithFile:path byteRange:range isAttachment:attachment]; } - (instancetype)initWithFile:(NSString*)path { return [self initWithFile:path byteRange:NSMakeRange(NSUIntegerMax, 0) isAttachment:NO]; } - (instancetype)initWithFile:(NSString*)path isAttachment:(BOOL)attachment { return [self initWithFile:path byteRange:NSMakeRange(NSUIntegerMax, 0) isAttachment:attachment]; } - (instancetype)initWithFile:(NSString*)path byteRange:(NSRange)range { return [self initWithFile:path byteRange:range isAttachment:NO]; } static inline NSDate* _NSDateFromTimeSpec(const struct timespec* t) { return [NSDate dateWithTimeIntervalSince1970:((NSTimeInterval)t->tv_sec + (NSTimeInterval)t->tv_nsec / 1000000000.0)]; } - (instancetype)initWithFile:(NSString*)path byteRange:(NSRange)range isAttachment:(BOOL)attachment { struct stat info; if (lstat([path fileSystemRepresentation], &info) || !(info.st_mode & S_IFREG)) { GWS_DNOT_REACHED(); return nil; } #ifndef __LP64__ 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) GWS_DNOT_REACHED(); 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 { range.length = MIN(range.length, fileSize); range.location = fileSize - range.length; } if (range.length == 0) { 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])) { _path = [path copy]; _offset = range.location; _size = range.length; if (hasByteRange) { [self setStatusCode:kGCDWebServerHTTPStatusCode_PartialContent]; [self setValue:[NSString stringWithFormat:@"bytes %lu-%lu/%lu", (unsigned long)_offset, (unsigned long)(_offset + _size - 1), (unsigned long)fileSize] forAdditionalHeader:@"Content-Range"]; GWS_LOG_DEBUG(@"Using content bytes range [%lu-%lu] for file \"%@\"", (unsigned long)_offset, (unsigned long)(_offset + _size - 1), path); } if (attachment) { NSString* fileName = [path lastPathComponent]; NSData* data = [[fileName stringByReplacingOccurrencesOfString:@"\"" withString:@""] dataUsingEncoding:NSISOLatin1StringEncoding allowLossyConversion:YES]; NSString* lossyFileName = data ? [[NSString alloc] initWithData:data encoding:NSISOLatin1StringEncoding] : nil; if (lossyFileName) { NSString* value = [NSString stringWithFormat:@"attachment; filename=\"%@\"; filename*=UTF-8''%@", lossyFileName, GCDWebServerEscapeURLString(fileName)]; [self setValue:value forAdditionalHeader:@"Content-Disposition"]; } else { GWS_DNOT_REACHED(); } } self.contentType = GCDWebServerGetMimeTypeForExtension([_path pathExtension]); self.contentLength = _size; 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]; } return self; } - (BOOL)open:(NSError**)error { _file = open([_path fileSystemRepresentation], O_NOFOLLOW | O_RDONLY); if (_file <= 0) { if (error) { *error = GCDWebServerMakePosixError(errno); } return NO; } if (lseek(_file, _offset, SEEK_SET) != (off_t)_offset) { if (error) { *error = GCDWebServerMakePosixError(errno); } close(_file); return NO; } return YES; } - (NSData*)readData:(NSError**)error { size_t length = MIN((NSUInteger)kFileReadBufferSize, _size); NSMutableData* data = [[NSMutableData alloc] initWithLength:length]; ssize_t result = read(_file, data.mutableBytes, length); if (result < 0) { if (error) { *error = GCDWebServerMakePosixError(errno); } return nil; } if (result > 0) { [data setLength:result]; _size -= result; } return data; } - (void)close { close(_file); } - (NSString*)description { NSMutableString* description = [NSMutableString stringWithString:[super description]]; [description appendFormat:@"\n\n{%@}", _path]; return description; } @end ================================================ FILE: src/ios/GCDWebServer/Responses/GCDWebServerStreamedResponse.h ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #import "GCDWebServerResponse.h" /** * The GCDWebServerStreamBlock is called to stream the data for the HTTP body. * The block must return either a chunk of data, an empty NSData when done, or * nil on error and set the "error" argument which is guaranteed to be non-NULL. */ typedef NSData* (^GCDWebServerStreamBlock)(NSError** error); /** * The GCDWebServerAsyncStreamBlock works like the GCDWebServerStreamBlock * except the streamed data can be returned at a later time allowing for * truly asynchronous generation of the data. * * The block must call "completionBlock" passing the new chunk of data when ready, * an empty NSData when done, or nil on error and pass a NSError. * * The block cannot call "completionBlock" more than once per invocation. */ typedef void (^GCDWebServerAsyncStreamBlock)(GCDWebServerBodyReaderCompletionBlock completionBlock); /** * The GCDWebServerStreamedResponse subclass of GCDWebServerResponse streams * the body of the HTTP response using a GCD block. */ @interface GCDWebServerStreamedResponse : GCDWebServerResponse /** * Creates a response with streamed data and a given content type. */ + (instancetype)responseWithContentType:(NSString*)type streamBlock:(GCDWebServerStreamBlock)block; /** * Creates a response with async streamed data and a given content type. */ + (instancetype)responseWithContentType:(NSString*)type asyncStreamBlock:(GCDWebServerAsyncStreamBlock)block; /** * Initializes a response with streamed data and a given content type. */ - (instancetype)initWithContentType:(NSString*)type streamBlock:(GCDWebServerStreamBlock)block; /** * This method is the designated initializer for the class. */ - (instancetype)initWithContentType:(NSString*)type asyncStreamBlock:(GCDWebServerAsyncStreamBlock)block; @end ================================================ FILE: src/ios/GCDWebServer/Responses/GCDWebServerStreamedResponse.m ================================================ /* Copyright (c) 2012-2015, Pierre-Olivier Latour All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name of Pierre-Olivier Latour may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PIERRE-OLIVIER LATOUR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #if !__has_feature(objc_arc) #error GCDWebServer requires ARC #endif #import "GCDWebServerPrivate.h" @interface GCDWebServerStreamedResponse () { @private GCDWebServerAsyncStreamBlock _block; } @end @implementation GCDWebServerStreamedResponse + (instancetype)responseWithContentType:(NSString*)type streamBlock:(GCDWebServerStreamBlock)block { return [[[self class] alloc] initWithContentType:type streamBlock:block]; } + (instancetype)responseWithContentType:(NSString*)type asyncStreamBlock:(GCDWebServerAsyncStreamBlock)block { return [[[self class] alloc] initWithContentType:type asyncStreamBlock:block]; } - (instancetype)initWithContentType:(NSString*)type streamBlock:(GCDWebServerStreamBlock)block { return [self initWithContentType:type asyncStreamBlock:^(GCDWebServerBodyReaderCompletionBlock completionBlock) { NSError* error = nil; NSData* data = block(&error); completionBlock(data, error); }]; } - (instancetype)initWithContentType:(NSString*)type asyncStreamBlock:(GCDWebServerAsyncStreamBlock)block { if ((self = [super init])) { _block = [block copy]; self.contentType = type; } return self; } - (void)asyncReadDataWithCompletion:(GCDWebServerBodyReaderCompletionBlock)block { _block(block); } - (NSString*)description { NSMutableString* description = [NSMutableString stringWithString:[super description]]; [description appendString:@"\n\n"]; return description; } @end ================================================ FILE: src/ios/LICENSE ================================================ Copyright (c) 2012 Niklas von Hertzen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: src/ios/wk-plugin.js ================================================ (function _wk_plugin() { // Check if we are running in WKWebView if (!window.webkit || !window.webkit.messageHandlers) { return; } // Initialize Ionic window.Ionic = window.Ionic || {}; function normalizeURL(url) { if (!url) { return url; } if (!url.startsWith("file://")) { return url; } url = url.substr(7); // len("file://") == 7 if (url.length == 0 || url[0] !== '/') { // ensure the new URL starts with / url = '/' + url; } return 'http://localhost:8080' + url; } if (typeof window.wkRewriteURL === 'undefined') { window.wkRewriteURL = function (url) { console.warn('wkRewriteURL is deprecated, use normalizeURL instead'); return normalizeURL(url); } } window.Ionic.normalizeURL = normalizeURL; var xhrPrototype = window.XMLHttpRequest.prototype; var originalOpen = xhrPrototype.open; xhrPrototype.open = function _wk_open(method, url) { arguments[1] = normalizeURL(url); originalOpen.apply(this, arguments); } console.debug("XHR polyfill injected!"); var stopScrollHandler = window.webkit.messageHandlers.stopScroll; if (!stopScrollHandler) { console.error('Can not find stopScroll handler'); return; } var stopScrollFunc = null; var stopScroll = { stop: function stop(callback) { if (!stopScrollFunc) { stopScrollFunc = callback; stopScrollHandler.postMessage(''); } }, fire: function fire() { stopScrollFunc && stopScrollFunc(); stopScrollFunc = null; }, cancel: function cancel() { stopScrollFunc = null; } }; window.Ionic.StopScroll = stopScroll; // deprecated window.IonicStopScroll = stopScroll; console.debug("Ionic Stop Scroll injected!"); })(); ================================================ FILE: src/www/ios/ios-wkwebview-exec.js ================================================ /* * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * */ /** * Creates the exec bridge used to notify the native code of * commands. */ var cordova = require('cordova'); var utils = require('cordova/utils'); var base64 = require('cordova/base64'); function massageArgsJsToNative (args) { if (!args || utils.typeName(args) !== 'Array') { return args; } var ret = []; args.forEach(function (arg, i) { if (utils.typeName(arg) === 'ArrayBuffer') { ret.push({ 'CDVType': 'ArrayBuffer', 'data': base64.fromArrayBuffer(arg) }); } else { ret.push(arg); } }); return ret; } function massageMessageNativeToJs (message) { if (message.CDVType === 'ArrayBuffer') { var stringToArrayBuffer = function (str) { var ret = new Uint8Array(str.length); for (var i = 0; i < str.length; i++) { ret[i] = str.charCodeAt(i); } return ret.buffer; }; var base64ToArrayBuffer = function (b64) { return stringToArrayBuffer(atob(b64)); // eslint-disable-line no-undef }; message = base64ToArrayBuffer(message.data); } return message; } function convertMessageToArgsNativeToJs (message) { var args = []; if (!message || !message.hasOwnProperty('CDVType')) { args.push(message); } else if (message.CDVType === 'MultiPart') { message.messages.forEach(function (e) { args.push(massageMessageNativeToJs(e)); }); } else { args.push(massageMessageNativeToJs(message)); } return args; } var iOSExec = function () { // detect change in bridge, if there is a change, we forward to new bridge // if (window.webkit && window.webkit.messageHandlers && window.webkit.messageHandlers.cordova && window.webkit.messageHandlers.cordova.postMessage) { // bridgeMode = jsToNativeModes.WK_WEBVIEW_BINDING; // } var successCallback, failCallback, service, action, actionArgs; var callbackId = null; if (typeof arguments[0] !== 'string') { // FORMAT ONE successCallback = arguments[0]; failCallback = arguments[1]; service = arguments[2]; action = arguments[3]; actionArgs = arguments[4]; // Since we need to maintain backwards compatibility, we have to pass // an invalid callbackId even if no callback was provided since plugins // will be expecting it. The Cordova.exec() implementation allocates // an invalid callbackId and passes it even if no callbacks were given. callbackId = 'INVALID'; } else { throw new Error('The old format of this exec call has been removed (deprecated since 2.1). Change to: ' + // eslint-disable-line 'cordova.exec(null, null, \'Service\', \'action\', [ arg1, arg2 ]);'); } // If actionArgs is not provided, default to an empty array actionArgs = actionArgs || []; // Register the callbacks and add the callbackId to the positional // arguments if given. if (successCallback || failCallback) { callbackId = service + cordova.callbackId++; cordova.callbacks[callbackId] = {success: successCallback, fail: failCallback}; } actionArgs = massageArgsJsToNative(actionArgs); // CB-10133 DataClone DOM Exception 25 guard (fast function remover) var command = [callbackId, service, action, JSON.parse(JSON.stringify(actionArgs))]; window.webkit.messageHandlers.cordova.postMessage(command); }; iOSExec.nativeCallback = function (callbackId, status, message, keepCallback, debug) { var success = status === 0 || status === 1; var args = convertMessageToArgsNativeToJs(message); setTimeout(function () { cordova.callbackFromNative(callbackId, success, status, args, keepCallback); // eslint-disable-line }, 0); }; // for backwards compatibility iOSExec.nativeEvalAndFetch = function (func) { try { func(); } catch (e) { console.log(e); } }; // Proxy the exec for bridge changes. See CB-10106 function cordovaExec () { var cexec = require('cordova/exec'); var cexec_valid = (typeof cexec.nativeFetchMessages === 'function') && (typeof cexec.nativeEvalAndFetch === 'function') && (typeof cexec.nativeCallback === 'function'); return (cexec_valid && execProxy !== cexec) ? cexec : iOSExec; } function execProxy () { cordovaExec().apply(null, arguments); } execProxy.nativeFetchMessages = function () { return cordovaExec().nativeFetchMessages.apply(null, arguments); }; execProxy.nativeEvalAndFetch = function () { return cordovaExec().nativeEvalAndFetch.apply(null, arguments); }; execProxy.nativeCallback = function () { return cordovaExec().nativeCallback.apply(null, arguments); }; module.exports = execProxy; if (window.webkit && window.webkit.messageHandlers && window.webkit.messageHandlers.cordova && window.webkit.messageHandlers.cordova.postMessage) { // unregister the old bridge cordova.define.remove('cordova/exec'); // redefine bridge to our new bridge cordova.define('cordova/exec', function (require, exports, module) { module.exports = execProxy; }); } ================================================ FILE: tests/ios/CDVWKWebViewEngineTest/.gitignore ================================================ build ================================================ FILE: tests/ios/CDVWKWebViewEngineTest/CDVWKWebViewEngineLibTests/CDVWKWebViewEngineTest.m ================================================ /* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ #import #import #import "CDVWKWebViewEngine.h" #import "CDVWKProcessPoolFactory.h" #import #import @interface CDVWKWebViewEngineTest : XCTestCase @property (nonatomic, strong) CDVWKWebViewEngine* plugin; @property (nonatomic, strong) CDVViewController* viewController; @end @interface CDVWKWebViewEngine () // TODO: expose private interface, if needed - (BOOL)shouldReloadWebView; - (BOOL)shouldReloadWebView:(NSURL*)location title:(NSString*)title; @end @interface CDVViewController () // expose property as readwrite, for test purposes @property (nonatomic, readwrite, strong) NSMutableDictionary* settings; @end @implementation CDVWKWebViewEngineTest - (void)setUp { [super setUp]; // Put setup code here. This method is called before the invocation of each test method in the class. // NOTE: no app settings are set, so it will rely on default WKWebViewConfiguration settings self.plugin = [[CDVWKWebViewEngine alloc] initWithFrame:CGRectMake(0, 0, 100, 100)]; self.viewController = [[CDVViewController alloc] init]; [self.viewController registerPlugin:self.plugin withClassName:NSStringFromClass([self.plugin class])]; XCTAssert([self.plugin conformsToProtocol:@protocol(CDVWebViewEngineProtocol)], @"Plugin does not conform to CDVWebViewEngineProtocol"); } - (void)tearDown { // Put teardown code here. This method is called after the invocation of each test method in the class. [super tearDown]; } - (void) testCanLoadRequest { NSURLRequest* fileUrlRequest = [NSURLRequest requestWithURL:[NSURL fileURLWithPath:@"path/to/file.html"]]; NSURLRequest* httpUrlRequest = [NSURLRequest requestWithURL:[NSURL URLWithString:@"http://apache.org"]]; NSURLRequest* miscUrlRequest = [NSURLRequest requestWithURL:[NSURL URLWithString:@"foo://bar"]]; id webViewEngineProtocol = self.plugin; SEL wk_sel = NSSelectorFromString(@"loadFileURL:allowingReadAccessToURL:"); if ([self.plugin.engineWebView respondsToSelector:wk_sel]) { XCTAssertTrue([webViewEngineProtocol canLoadRequest:fileUrlRequest]); } else { XCTAssertFalse([webViewEngineProtocol canLoadRequest:fileUrlRequest]); } XCTAssertTrue([webViewEngineProtocol canLoadRequest:httpUrlRequest]); XCTAssertTrue([webViewEngineProtocol canLoadRequest:miscUrlRequest]); } - (void) testUpdateInfo { // Add -ObjC to Other Linker Flags to test project, to load Categories // Update objc test template generator as well id webViewEngineProtocol = self.plugin; WKWebView* wkWebView = (WKWebView*)self.plugin.engineWebView; // iOS >=10 defaults to NO, < 10 defaults to YES. BOOL mediaPlaybackRequiresUserActionDefault = IsAtLeastiOSVersion(@"10.0")? NO : YES; NSDictionary* preferences = @{ [@"MinimumFontSize" lowercaseString] : @1.1, // default is 0.0 [@"AllowInlineMediaPlayback" lowercaseString] : @YES, // default is NO [@"MediaPlaybackRequiresUserAction" lowercaseString] : @(!mediaPlaybackRequiresUserActionDefault), // default is NO on iOS >= 10, YES for < 10 [@"SuppressesIncrementalRendering" lowercaseString] : @YES, // default is NO [@"MediaPlaybackAllowsAirPlay" lowercaseString] : @NO, // default is YES [@"DisallowOverscroll" lowercaseString] : @YES, // so bounces is to be NO. defaults to NO [@"WKWebViewDecelerationSpeed" lowercaseString] : @"fast" // default is 'normal' }; NSDictionary* info = @{ kCDVWebViewEngineWebViewPreferences : preferences }; [webViewEngineProtocol updateWithInfo:info]; // the only preference we can set, we **can** change this during runtime XCTAssertEqualWithAccuracy(wkWebView.configuration.preferences.minimumFontSize, 1.1, 0.0001); // the WKWebViewConfiguration properties, we **cannot** change outside of initialization if (IsAtLeastiOSVersion(@"10.0")) { XCTAssertFalse(wkWebView.configuration.mediaPlaybackRequiresUserAction); } else { XCTAssertTrue(wkWebView.configuration.mediaPlaybackRequiresUserAction); } XCTAssertFalse(wkWebView.configuration.allowsInlineMediaPlayback); XCTAssertFalse(wkWebView.configuration.suppressesIncrementalRendering); XCTAssertTrue(wkWebView.configuration.mediaPlaybackAllowsAirPlay); // in the test above, DisallowOverscroll is YES, so no bounce if ([wkWebView respondsToSelector:@selector(scrollView)]) { XCTAssertFalse(((UIScrollView*)[wkWebView scrollView]).bounces); } else { for (id subview in wkWebView.subviews) { if ([[subview class] isSubclassOfClass:[UIScrollView class]]) { XCTAssertFalse(((UIScrollView*)subview).bounces = NO); } } } XCTAssertTrue(wkWebView.scrollView.decelerationRate == UIScrollViewDecelerationRateFast); } - (void) testConfigurationFromSettings { // we need to re-set the plugin from the "setup" to take in the app settings we need self.plugin = [[CDVWKWebViewEngine alloc] initWithFrame:CGRectMake(0, 0, 100, 100)]; self.viewController = [[CDVViewController alloc] init]; // generate the app settings // iOS >=10 defaults to NO, < 10 defaults to YES. BOOL mediaPlaybackRequiresUserActionDefault = IsAtLeastiOSVersion(@"10.0")? NO : YES; NSDictionary* settings = @{ [@"MinimumFontSize" lowercaseString] : @1.1, // default is 0.0 [@"AllowInlineMediaPlayback" lowercaseString] : @YES, // default is NO [@"MediaPlaybackRequiresUserAction" lowercaseString] : @(!mediaPlaybackRequiresUserActionDefault), // default is NO on iOS >= 10, YES for < 10 [@"SuppressesIncrementalRendering" lowercaseString] : @YES, // default is NO [@"MediaPlaybackAllowsAirPlay" lowercaseString] : @NO, // default is YES [@"DisallowOverscroll" lowercaseString] : @YES, // so bounces is to be NO. defaults to NO [@"WKWebViewDecelerationSpeed" lowercaseString] : @"fast" // default is 'normal' }; // this can be set because of the Category at the top of the file self.viewController.settings = [settings mutableCopy]; // app settings are read after you register the plugin [self.viewController registerPlugin:self.plugin withClassName:NSStringFromClass([self.plugin class])]; XCTAssert([self.plugin conformsToProtocol:@protocol(CDVWebViewEngineProtocol)], @"Plugin does not conform to CDVWebViewEngineProtocol"); // after registering (thus plugin initialization), we can grab the webview configuration WKWebView* wkWebView = (WKWebView*)self.plugin.engineWebView; // the only preference we can set, we **can** change this during runtime XCTAssertEqualWithAccuracy(wkWebView.configuration.preferences.minimumFontSize, 1.1, 0.0001); // the WKWebViewConfiguration properties, we **cannot** change outside of initialization if (IsAtLeastiOSVersion(@"10.0")) { XCTAssertTrue(wkWebView.configuration.mediaPlaybackRequiresUserAction); } else { XCTAssertFalse(wkWebView.configuration.mediaPlaybackRequiresUserAction); } XCTAssertTrue(wkWebView.configuration.allowsInlineMediaPlayback); XCTAssertTrue(wkWebView.configuration.suppressesIncrementalRendering); // The test case below is in a separate test "testConfigurationWithMediaPlaybackAllowsAirPlay" (Apple bug) // XCTAssertFalse(wkWebView.configuration.mediaPlaybackAllowsAirPlay); // in the test above, DisallowOverscroll is YES, so no bounce if ([wkWebView respondsToSelector:@selector(scrollView)]) { XCTAssertFalse(((UIScrollView*)[wkWebView scrollView]).bounces); } else { for (id subview in wkWebView.subviews) { if ([[subview class] isSubclassOfClass:[UIScrollView class]]) { XCTAssertFalse(((UIScrollView*)subview).bounces = NO); } } } XCTAssertTrue(wkWebView.scrollView.decelerationRate == UIScrollViewDecelerationRateFast); } - (void) testShouldReloadWebView { WKWebView* wkWebView = (WKWebView*)self.plugin.engineWebView; NSURL* about_blank = [NSURL URLWithString:@"about:blank"]; NSURL* real_site = [NSURL URLWithString:@"https://cordova.apache.org"]; NSString* empty_title_document = @""; // about:blank should reload [wkWebView loadRequest:[NSURLRequest requestWithURL:about_blank]]; XCTAssertTrue([self.plugin shouldReloadWebView]); // a network location should *not* reload [wkWebView loadRequest:[NSURLRequest requestWithURL:real_site]]; XCTAssertFalse([self.plugin shouldReloadWebView]); // document with empty title should *not* reload // baseURL:nil results in about:blank, so we use a dummy here [wkWebView loadHTMLString:empty_title_document baseURL:[NSURL URLWithString:@"about:"]]; XCTAssertFalse([self.plugin shouldReloadWebView]); // Anecdotal assertion that when the WKWebView process has died, // the title is nil, should always reload XCTAssertTrue([self.plugin shouldReloadWebView:about_blank title:nil]); XCTAssertTrue([self.plugin shouldReloadWebView:real_site title:nil]); // about:blank should always reload XCTAssertTrue([self.plugin shouldReloadWebView:about_blank title:@"some title"]); // non about:blank with a non-nil title should **not** reload XCTAssertFalse([self.plugin shouldReloadWebView:real_site title:@""]); } - (void) testConfigurationWithMediaPlaybackAllowsAirPlay { WKWebViewConfiguration* configuration = [WKWebViewConfiguration new]; configuration.allowsAirPlayForMediaPlayback = NO; WKWebView* wkWebView = [[WKWebView alloc] initWithFrame:CGRectMake(0, 0, 100, 100) configuration:configuration]; XCTAssertFalse(configuration.allowsAirPlayForMediaPlayback); // Uh-oh, bug in WKWebView below. Tested on iOS 9, iOS 10 beta 3 XCTAssertFalse(wkWebView.configuration.allowsAirPlayForMediaPlayback); } - (void) testWKProcessPoolFactory { WKProcessPool* shared = [[CDVWKProcessPoolFactory sharedFactory] sharedProcessPool]; XCTAssertTrue(shared != nil); } @end ================================================ FILE: tests/ios/CDVWKWebViewEngineTest/CDVWKWebViewEngineLibTests/Info.plist ================================================ CFBundleDevelopmentRegion en CFBundleExecutable $(EXECUTABLE_NAME) CFBundleIdentifier $(PRODUCT_BUNDLE_IDENTIFIER) CFBundleInfoDictionaryVersion 6.0 CFBundleName $(PRODUCT_NAME) CFBundlePackageType BNDL CFBundleShortVersionString 1.0 CFBundleSignature ???? CFBundleVersion 1 ================================================ FILE: tests/ios/CDVWKWebViewEngineTest/CDVWKWebViewEngineTest.xcodeproj/project.pbxproj ================================================ // !$*UTF8*$! { archiveVersion = 1; classes = { }; objectVersion = 46; objects = { /* Begin PBXBuildFile section */ 7E9F51AB19DA10AE00DA31AC /* CDVWKWebViewEngine.m in Sources */ = {isa = PBXBuildFile; fileRef = 7E9F51A919DA10AE00DA31AC /* CDVWKWebViewEngine.m */; }; 7E9F51B119DA114400DA31AC /* CDVWKWebViewEngineTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 7E9F51B019DA114400DA31AC /* CDVWKWebViewEngineTest.m */; }; 7E9F51B319DA116500DA31AC /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 7E9F51B219DA116500DA31AC /* Foundation.framework */; }; 7E9F51B519DA127E00DA31AC /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 7E9F51B419DA127E00DA31AC /* UIKit.framework */; }; 7E9F51B919DA1B1600DA31AC /* libCDVWKWebViewEngineLib.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 7E9F519519DA102000DA31AC /* libCDVWKWebViewEngineLib.a */; }; 7E9F51BA19DA1B2000DA31AC /* libCordova.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 7E9F519019DA0F8300DA31AC /* libCordova.a */; }; 7EACDCE71D234E2A00494C9E /* WebKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 7EACDCE61D234E2A00494C9E /* WebKit.framework */; }; 7EACDCEB1D234FB300494C9E /* CDVWKWebViewUIDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = 7EACDCEA1D234FB300494C9E /* CDVWKWebViewUIDelegate.m */; }; A9CC1CED1E0D42F50083E165 /* CDVWKProcessPoolFactory.m in Sources */ = {isa = PBXBuildFile; fileRef = A9CC1CEC1E0D42F50083E165 /* CDVWKProcessPoolFactory.m */; }; /* End PBXBuildFile section */ /* Begin PBXContainerItemProxy section */ 3050280F1E2973F700CF9F12 /* PBXContainerItemProxy */ = { isa = PBXContainerItemProxy; containerPortal = 7E9F518B19DA0F8300DA31AC /* CordovaLib.xcodeproj */; proxyType = 1; remoteGlobalIDString = D2AAC07D0554694100DB518D; remoteInfo = CordovaLib; }; 7E9F518F19DA0F8300DA31AC /* PBXContainerItemProxy */ = { isa = PBXContainerItemProxy; containerPortal = 7E9F518B19DA0F8300DA31AC /* CordovaLib.xcodeproj */; proxyType = 2; remoteGlobalIDString = 68A32D7114102E1C006B237C; remoteInfo = CordovaLib; }; 7E9F51AC19DA10DE00DA31AC /* PBXContainerItemProxy */ = { isa = PBXContainerItemProxy; containerPortal = 7E9F517219DA09CE00DA31AC /* Project object */; proxyType = 1; remoteGlobalIDString = 7E9F519419DA102000DA31AC; remoteInfo = CDVWKWebViewEngineLib; }; 7E9F51AE19DA10E100DA31AC /* PBXContainerItemProxy */ = { isa = PBXContainerItemProxy; containerPortal = 7E9F518B19DA0F8300DA31AC /* CordovaLib.xcodeproj */; proxyType = 1; remoteGlobalIDString = D2AAC07D0554694100DB518D; remoteInfo = CordovaLib; }; /* End PBXContainerItemProxy section */ /* Begin PBXCopyFilesBuildPhase section */ 7E9F519319DA102000DA31AC /* CopyFiles */ = { isa = PBXCopyFilesBuildPhase; buildActionMask = 2147483647; dstPath = "include/$(PRODUCT_NAME)"; dstSubfolderSpec = 16; files = ( ); runOnlyForDeploymentPostprocessing = 0; }; /* End PBXCopyFilesBuildPhase section */ /* Begin PBXFileReference section */ 7E9F518B19DA0F8300DA31AC /* CordovaLib.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = CordovaLib.xcodeproj; path = "../node_modules/cordova-ios/CordovaLib/CordovaLib.xcodeproj"; sourceTree = ""; }; 7E9F519519DA102000DA31AC /* libCDVWKWebViewEngineLib.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libCDVWKWebViewEngineLib.a; sourceTree = BUILT_PRODUCTS_DIR; }; 7E9F519F19DA102000DA31AC /* CDVWKWebViewEngineLibTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = CDVWKWebViewEngineLibTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; 7E9F51A219DA102000DA31AC /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; 7E9F51A919DA10AE00DA31AC /* CDVWKWebViewEngine.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = CDVWKWebViewEngine.m; path = ../../../src/ios/CDVWKWebViewEngine.m; sourceTree = SOURCE_ROOT; }; 7E9F51AA19DA10AE00DA31AC /* CDVWKWebViewEngine.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = CDVWKWebViewEngine.h; path = ../../../src/ios/CDVWKWebViewEngine.h; sourceTree = SOURCE_ROOT; }; 7E9F51B019DA114400DA31AC /* CDVWKWebViewEngineTest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CDVWKWebViewEngineTest.m; sourceTree = ""; }; 7E9F51B219DA116500DA31AC /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS8.0.sdk/System/Library/Frameworks/Foundation.framework; sourceTree = DEVELOPER_DIR; }; 7E9F51B419DA127E00DA31AC /* UIKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = UIKit.framework; path = Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS8.0.sdk/System/Library/Frameworks/UIKit.framework; sourceTree = DEVELOPER_DIR; }; 7EACDCE61D234E2A00494C9E /* WebKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = WebKit.framework; path = Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS9.3.sdk/System/Library/Frameworks/WebKit.framework; sourceTree = DEVELOPER_DIR; }; 7EACDCE91D234FB300494C9E /* CDVWKWebViewUIDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = CDVWKWebViewUIDelegate.h; path = ../../../src/ios/CDVWKWebViewUIDelegate.h; sourceTree = SOURCE_ROOT; }; 7EACDCEA1D234FB300494C9E /* CDVWKWebViewUIDelegate.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = CDVWKWebViewUIDelegate.m; path = ../../../src/ios/CDVWKWebViewUIDelegate.m; sourceTree = SOURCE_ROOT; }; A9CC1CEB1E0D42F50083E165 /* CDVWKProcessPoolFactory.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = CDVWKProcessPoolFactory.h; path = ../../../src/ios/CDVWKProcessPoolFactory.h; sourceTree = SOURCE_ROOT; }; A9CC1CEC1E0D42F50083E165 /* CDVWKProcessPoolFactory.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = CDVWKProcessPoolFactory.m; path = ../../../src/ios/CDVWKProcessPoolFactory.m; sourceTree = SOURCE_ROOT; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ 7E9F519219DA102000DA31AC /* Frameworks */ = { isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( 7EACDCE71D234E2A00494C9E /* WebKit.framework in Frameworks */, ); runOnlyForDeploymentPostprocessing = 0; }; 7E9F519C19DA102000DA31AC /* Frameworks */ = { isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( 7E9F51BA19DA1B2000DA31AC /* libCordova.a in Frameworks */, 7E9F51B919DA1B1600DA31AC /* libCDVWKWebViewEngineLib.a in Frameworks */, 7E9F51B519DA127E00DA31AC /* UIKit.framework in Frameworks */, 7E9F51B319DA116500DA31AC /* Foundation.framework in Frameworks */, ); runOnlyForDeploymentPostprocessing = 0; }; /* End PBXFrameworksBuildPhase section */ /* Begin PBXGroup section */ 7E9F517119DA09CE00DA31AC = { isa = PBXGroup; children = ( 7EACDCE61D234E2A00494C9E /* WebKit.framework */, 7E9F51B419DA127E00DA31AC /* UIKit.framework */, 7E9F51B219DA116500DA31AC /* Foundation.framework */, 7E9F518B19DA0F8300DA31AC /* CordovaLib.xcodeproj */, 7E9F519619DA102000DA31AC /* CDVWKWebViewEngineLib */, 7E9F51A019DA102000DA31AC /* CDVWKWebViewEngineLibTests */, 7E9F517D19DA0A0A00DA31AC /* Products */, ); sourceTree = ""; }; 7E9F517D19DA0A0A00DA31AC /* Products */ = { isa = PBXGroup; children = ( 7E9F519519DA102000DA31AC /* libCDVWKWebViewEngineLib.a */, 7E9F519F19DA102000DA31AC /* CDVWKWebViewEngineLibTests.xctest */, ); name = Products; sourceTree = ""; }; 7E9F518C19DA0F8300DA31AC /* Products */ = { isa = PBXGroup; children = ( 7E9F519019DA0F8300DA31AC /* libCordova.a */, ); name = Products; sourceTree = ""; }; 7E9F519619DA102000DA31AC /* CDVWKWebViewEngineLib */ = { isa = PBXGroup; children = ( A9CC1CEB1E0D42F50083E165 /* CDVWKProcessPoolFactory.h */, A9CC1CEC1E0D42F50083E165 /* CDVWKProcessPoolFactory.m */, 7EACDCE91D234FB300494C9E /* CDVWKWebViewUIDelegate.h */, 7EACDCEA1D234FB300494C9E /* CDVWKWebViewUIDelegate.m */, 7E9F51A919DA10AE00DA31AC /* CDVWKWebViewEngine.m */, 7E9F51AA19DA10AE00DA31AC /* CDVWKWebViewEngine.h */, ); path = CDVWKWebViewEngineLib; sourceTree = SOURCE_ROOT; }; 7E9F51A019DA102000DA31AC /* CDVWKWebViewEngineLibTests */ = { isa = PBXGroup; children = ( 7E9F51A119DA102000DA31AC /* Supporting Files */, 7E9F51B019DA114400DA31AC /* CDVWKWebViewEngineTest.m */, ); path = CDVWKWebViewEngineLibTests; sourceTree = ""; }; 7E9F51A119DA102000DA31AC /* Supporting Files */ = { isa = PBXGroup; children = ( 7E9F51A219DA102000DA31AC /* Info.plist */, ); name = "Supporting Files"; sourceTree = ""; }; /* End PBXGroup section */ /* Begin PBXNativeTarget section */ 7E9F519419DA102000DA31AC /* CDVWKWebViewEngineLib */ = { isa = PBXNativeTarget; buildConfigurationList = 7E9F51A319DA102000DA31AC /* Build configuration list for PBXNativeTarget "CDVWKWebViewEngineLib" */; buildPhases = ( 7E9F519119DA102000DA31AC /* Sources */, 7E9F519219DA102000DA31AC /* Frameworks */, 7E9F519319DA102000DA31AC /* CopyFiles */, ); buildRules = ( ); dependencies = ( 305028101E2973F700CF9F12 /* PBXTargetDependency */, ); name = CDVWKWebViewEngineLib; productName = CDVWKWebViewEngineLib; productReference = 7E9F519519DA102000DA31AC /* libCDVWKWebViewEngineLib.a */; productType = "com.apple.product-type.library.static"; }; 7E9F519E19DA102000DA31AC /* CDVWKWebViewEngineLibTests */ = { isa = PBXNativeTarget; buildConfigurationList = 7E9F51A619DA102000DA31AC /* Build configuration list for PBXNativeTarget "CDVWKWebViewEngineLibTests" */; buildPhases = ( 7E9F519B19DA102000DA31AC /* Sources */, 7E9F519C19DA102000DA31AC /* Frameworks */, 7E9F519D19DA102000DA31AC /* Resources */, ); buildRules = ( ); dependencies = ( 7E9F51AF19DA10E100DA31AC /* PBXTargetDependency */, 7E9F51AD19DA10DE00DA31AC /* PBXTargetDependency */, ); name = CDVWKWebViewEngineLibTests; productName = CDVWKWebViewEngineLibTests; productReference = 7E9F519F19DA102000DA31AC /* CDVWKWebViewEngineLibTests.xctest */; productType = "com.apple.product-type.bundle.unit-test"; }; /* End PBXNativeTarget section */ /* Begin PBXProject section */ 7E9F517219DA09CE00DA31AC /* Project object */ = { isa = PBXProject; attributes = { LastUpgradeCheck = 0830; TargetAttributes = { 7E9F519419DA102000DA31AC = { CreatedOnToolsVersion = 6.0; }; 7E9F519E19DA102000DA31AC = { CreatedOnToolsVersion = 6.0; }; }; }; buildConfigurationList = 7E9F517519DA09CE00DA31AC /* Build configuration list for PBXProject "CDVWKWebViewEngineTest" */; compatibilityVersion = "Xcode 3.2"; developmentRegion = English; hasScannedForEncodings = 0; knownRegions = ( en, ); mainGroup = 7E9F517119DA09CE00DA31AC; productRefGroup = 7E9F517D19DA0A0A00DA31AC /* Products */; projectDirPath = ""; projectReferences = ( { ProductGroup = 7E9F518C19DA0F8300DA31AC /* Products */; ProjectRef = 7E9F518B19DA0F8300DA31AC /* CordovaLib.xcodeproj */; }, ); projectRoot = ""; targets = ( 7E9F519419DA102000DA31AC /* CDVWKWebViewEngineLib */, 7E9F519E19DA102000DA31AC /* CDVWKWebViewEngineLibTests */, ); }; /* End PBXProject section */ /* Begin PBXReferenceProxy section */ 7E9F519019DA0F8300DA31AC /* libCordova.a */ = { isa = PBXReferenceProxy; fileType = archive.ar; path = libCordova.a; remoteRef = 7E9F518F19DA0F8300DA31AC /* PBXContainerItemProxy */; sourceTree = BUILT_PRODUCTS_DIR; }; /* End PBXReferenceProxy section */ /* Begin PBXResourcesBuildPhase section */ 7E9F519D19DA102000DA31AC /* Resources */ = { isa = PBXResourcesBuildPhase; buildActionMask = 2147483647; files = ( ); runOnlyForDeploymentPostprocessing = 0; }; /* End PBXResourcesBuildPhase section */ /* Begin PBXSourcesBuildPhase section */ 7E9F519119DA102000DA31AC /* Sources */ = { isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( A9CC1CED1E0D42F50083E165 /* CDVWKProcessPoolFactory.m in Sources */, 7EACDCEB1D234FB300494C9E /* CDVWKWebViewUIDelegate.m in Sources */, 7E9F51AB19DA10AE00DA31AC /* CDVWKWebViewEngine.m in Sources */, ); runOnlyForDeploymentPostprocessing = 0; }; 7E9F519B19DA102000DA31AC /* Sources */ = { isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( 7E9F51B119DA114400DA31AC /* CDVWKWebViewEngineTest.m in Sources */, ); runOnlyForDeploymentPostprocessing = 0; }; /* End PBXSourcesBuildPhase section */ /* Begin PBXTargetDependency section */ 305028101E2973F700CF9F12 /* PBXTargetDependency */ = { isa = PBXTargetDependency; name = CordovaLib; targetProxy = 3050280F1E2973F700CF9F12 /* PBXContainerItemProxy */; }; 7E9F51AD19DA10DE00DA31AC /* PBXTargetDependency */ = { isa = PBXTargetDependency; target = 7E9F519419DA102000DA31AC /* CDVWKWebViewEngineLib */; targetProxy = 7E9F51AC19DA10DE00DA31AC /* PBXContainerItemProxy */; }; 7E9F51AF19DA10E100DA31AC /* PBXTargetDependency */ = { isa = PBXTargetDependency; name = CordovaLib; targetProxy = 7E9F51AE19DA10E100DA31AC /* PBXContainerItemProxy */; }; /* End PBXTargetDependency section */ /* Begin XCBuildConfiguration section */ 7E9F517619DA09CE00DA31AC /* Debug */ = { isa = XCBuildConfiguration; buildSettings = { CLANG_WARN_BOOL_CONVERSION = YES; CLANG_WARN_CONSTANT_CONVERSION = YES; CLANG_WARN_EMPTY_BODY = YES; CLANG_WARN_ENUM_CONVERSION = YES; CLANG_WARN_INFINITE_RECURSION = YES; CLANG_WARN_INT_CONVERSION = YES; CLANG_WARN_SUSPICIOUS_MOVE = YES; CLANG_WARN_UNREACHABLE_CODE = YES; CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; ENABLE_STRICT_OBJC_MSGSEND = YES; ENABLE_TESTABILITY = YES; GCC_NO_COMMON_BLOCKS = YES; GCC_WARN_64_TO_32_BIT_CONVERSION = YES; GCC_WARN_ABOUT_RETURN_TYPE = YES; GCC_WARN_UNDECLARED_SELECTOR = YES; GCC_WARN_UNINITIALIZED_AUTOS = YES; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; ONLY_ACTIVE_ARCH = YES; OTHER_LDFLAGS = "-ObjC"; }; name = Debug; }; 7E9F517719DA09CE00DA31AC /* Release */ = { isa = XCBuildConfiguration; buildSettings = { CLANG_WARN_BOOL_CONVERSION = YES; CLANG_WARN_CONSTANT_CONVERSION = YES; CLANG_WARN_EMPTY_BODY = YES; CLANG_WARN_ENUM_CONVERSION = YES; CLANG_WARN_INFINITE_RECURSION = YES; CLANG_WARN_INT_CONVERSION = YES; CLANG_WARN_SUSPICIOUS_MOVE = YES; CLANG_WARN_UNREACHABLE_CODE = YES; CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; ENABLE_STRICT_OBJC_MSGSEND = YES; GCC_NO_COMMON_BLOCKS = YES; GCC_WARN_64_TO_32_BIT_CONVERSION = YES; GCC_WARN_ABOUT_RETURN_TYPE = YES; GCC_WARN_UNDECLARED_SELECTOR = YES; GCC_WARN_UNINITIALIZED_AUTOS = YES; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; OTHER_LDFLAGS = "-ObjC"; }; name = Release; }; 7E9F51A419DA102000DA31AC /* Debug */ = { isa = XCBuildConfiguration; buildSettings = { ALWAYS_SEARCH_USER_PATHS = NO; CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; CLANG_CXX_LIBRARY = "libc++"; CLANG_ENABLE_MODULES = YES; CLANG_ENABLE_OBJC_ARC = YES; CLANG_WARN_BOOL_CONVERSION = YES; CLANG_WARN_CONSTANT_CONVERSION = YES; CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; CLANG_WARN_EMPTY_BODY = YES; CLANG_WARN_ENUM_CONVERSION = YES; CLANG_WARN_INT_CONVERSION = YES; CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; CLANG_WARN_UNREACHABLE_CODE = YES; CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; COPY_PHASE_STRIP = NO; ENABLE_STRICT_OBJC_MSGSEND = YES; GCC_C_LANGUAGE_STANDARD = gnu99; GCC_DYNAMIC_NO_PIC = NO; GCC_OPTIMIZATION_LEVEL = 0; GCC_PREPROCESSOR_DEFINITIONS = ( "DEBUG=1", "$(inherited)", ); GCC_SYMBOLS_PRIVATE_EXTERN = NO; GCC_WARN_64_TO_32_BIT_CONVERSION = YES; GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; GCC_WARN_UNDECLARED_SELECTOR = YES; GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; HEADER_SEARCH_PATHS = "$(inherited)"; IPHONEOS_DEPLOYMENT_TARGET = 8.0; MTL_ENABLE_DEBUG_INFO = YES; ONLY_ACTIVE_ARCH = YES; OTHER_LDFLAGS = "-ObjC"; PRODUCT_NAME = "$(TARGET_NAME)"; SDKROOT = iphoneos; SKIP_INSTALL = YES; }; name = Debug; }; 7E9F51A519DA102000DA31AC /* Release */ = { isa = XCBuildConfiguration; buildSettings = { ALWAYS_SEARCH_USER_PATHS = NO; CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; CLANG_CXX_LIBRARY = "libc++"; CLANG_ENABLE_MODULES = YES; CLANG_ENABLE_OBJC_ARC = YES; CLANG_WARN_BOOL_CONVERSION = YES; CLANG_WARN_CONSTANT_CONVERSION = YES; CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; CLANG_WARN_EMPTY_BODY = YES; CLANG_WARN_ENUM_CONVERSION = YES; CLANG_WARN_INT_CONVERSION = YES; CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; CLANG_WARN_UNREACHABLE_CODE = YES; CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; COPY_PHASE_STRIP = YES; ENABLE_NS_ASSERTIONS = NO; ENABLE_STRICT_OBJC_MSGSEND = YES; GCC_C_LANGUAGE_STANDARD = gnu99; GCC_WARN_64_TO_32_BIT_CONVERSION = YES; GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; GCC_WARN_UNDECLARED_SELECTOR = YES; GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; HEADER_SEARCH_PATHS = "$(inherited)"; IPHONEOS_DEPLOYMENT_TARGET = 8.0; MTL_ENABLE_DEBUG_INFO = NO; OTHER_LDFLAGS = "-ObjC"; PRODUCT_NAME = "$(TARGET_NAME)"; SDKROOT = iphoneos; SKIP_INSTALL = YES; VALIDATE_PRODUCT = YES; }; name = Release; }; 7E9F51A719DA102000DA31AC /* Debug */ = { isa = XCBuildConfiguration; buildSettings = { ALWAYS_SEARCH_USER_PATHS = NO; CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; CLANG_CXX_LIBRARY = "libc++"; CLANG_ENABLE_MODULES = YES; CLANG_ENABLE_OBJC_ARC = YES; CLANG_WARN_BOOL_CONVERSION = YES; CLANG_WARN_CONSTANT_CONVERSION = YES; CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; CLANG_WARN_EMPTY_BODY = YES; CLANG_WARN_ENUM_CONVERSION = YES; CLANG_WARN_INT_CONVERSION = YES; CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; CLANG_WARN_UNREACHABLE_CODE = YES; CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; COPY_PHASE_STRIP = NO; ENABLE_STRICT_OBJC_MSGSEND = YES; FRAMEWORK_SEARCH_PATHS = ( "$(SDKROOT)/Developer/Library/Frameworks", "$(inherited)", ); GCC_C_LANGUAGE_STANDARD = gnu99; GCC_DYNAMIC_NO_PIC = NO; GCC_OPTIMIZATION_LEVEL = 0; GCC_PREPROCESSOR_DEFINITIONS = ( "DEBUG=1", "$(inherited)", ); GCC_SYMBOLS_PRIVATE_EXTERN = NO; GCC_WARN_64_TO_32_BIT_CONVERSION = YES; GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; GCC_WARN_UNDECLARED_SELECTOR = YES; GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; INFOPLIST_FILE = CDVWKWebViewEngineLibTests/Info.plist; IPHONEOS_DEPLOYMENT_TARGET = 8.0; LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"; MTL_ENABLE_DEBUG_INFO = YES; ONLY_ACTIVE_ARCH = YES; PRODUCT_BUNDLE_IDENTIFIER = "org.apache.cordova.$(PRODUCT_NAME:rfc1034identifier)"; PRODUCT_NAME = "$(TARGET_NAME)"; SDKROOT = iphoneos; }; name = Debug; }; 7E9F51A819DA102000DA31AC /* Release */ = { isa = XCBuildConfiguration; buildSettings = { ALWAYS_SEARCH_USER_PATHS = NO; CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; CLANG_CXX_LIBRARY = "libc++"; CLANG_ENABLE_MODULES = YES; CLANG_ENABLE_OBJC_ARC = YES; CLANG_WARN_BOOL_CONVERSION = YES; CLANG_WARN_CONSTANT_CONVERSION = YES; CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; CLANG_WARN_EMPTY_BODY = YES; CLANG_WARN_ENUM_CONVERSION = YES; CLANG_WARN_INT_CONVERSION = YES; CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; CLANG_WARN_UNREACHABLE_CODE = YES; CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; COPY_PHASE_STRIP = YES; ENABLE_NS_ASSERTIONS = NO; ENABLE_STRICT_OBJC_MSGSEND = YES; FRAMEWORK_SEARCH_PATHS = ( "$(SDKROOT)/Developer/Library/Frameworks", "$(inherited)", ); GCC_C_LANGUAGE_STANDARD = gnu99; GCC_WARN_64_TO_32_BIT_CONVERSION = YES; GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; GCC_WARN_UNDECLARED_SELECTOR = YES; GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; INFOPLIST_FILE = CDVWKWebViewEngineLibTests/Info.plist; IPHONEOS_DEPLOYMENT_TARGET = 8.0; LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"; MTL_ENABLE_DEBUG_INFO = NO; PRODUCT_BUNDLE_IDENTIFIER = "org.apache.cordova.$(PRODUCT_NAME:rfc1034identifier)"; PRODUCT_NAME = "$(TARGET_NAME)"; SDKROOT = iphoneos; VALIDATE_PRODUCT = YES; }; name = Release; }; /* End XCBuildConfiguration section */ /* Begin XCConfigurationList section */ 7E9F517519DA09CE00DA31AC /* Build configuration list for PBXProject "CDVWKWebViewEngineTest" */ = { isa = XCConfigurationList; buildConfigurations = ( 7E9F517619DA09CE00DA31AC /* Debug */, 7E9F517719DA09CE00DA31AC /* Release */, ); defaultConfigurationIsVisible = 0; defaultConfigurationName = Release; }; 7E9F51A319DA102000DA31AC /* Build configuration list for PBXNativeTarget "CDVWKWebViewEngineLib" */ = { isa = XCConfigurationList; buildConfigurations = ( 7E9F51A419DA102000DA31AC /* Debug */, 7E9F51A519DA102000DA31AC /* Release */, ); defaultConfigurationIsVisible = 0; defaultConfigurationName = Release; }; 7E9F51A619DA102000DA31AC /* Build configuration list for PBXNativeTarget "CDVWKWebViewEngineLibTests" */ = { isa = XCConfigurationList; buildConfigurations = ( 7E9F51A719DA102000DA31AC /* Debug */, 7E9F51A819DA102000DA31AC /* Release */, ); defaultConfigurationIsVisible = 0; defaultConfigurationName = Release; }; /* End XCConfigurationList section */ }; rootObject = 7E9F517219DA09CE00DA31AC /* Project object */; } ================================================ FILE: tests/ios/CDVWKWebViewEngineTest/CDVWKWebViewEngineTest.xcodeproj/project.xcworkspace/contents.xcworkspacedata ================================================ ================================================ FILE: tests/ios/CDVWKWebViewEngineTest/CDVWKWebViewEngineTest.xcodeproj/project.xcworkspace/xcshareddata/CDVWKWebViewEngineTest.xccheckout ================================================ IDESourceControlProjectFavoriteDictionaryKey IDESourceControlProjectIdentifier 6BE9AD73-1B9F-4362-98D7-DC631BEC6185 IDESourceControlProjectName CDVWKWebViewEngineTest IDESourceControlProjectOriginsDictionary BEF5A5D0FF64801E558286389440357A9233D7DB https://git-wip-us.apache.org/repos/asf/cordova-plugin-wkwebview-engine.git IDESourceControlProjectPath tests/ios/CDVWKWebViewEngineTest/CDVWKWebViewEngineTest.xcodeproj IDESourceControlProjectRelativeInstallPathDictionary BEF5A5D0FF64801E558286389440357A9233D7DB ../../../../.. IDESourceControlProjectURL https://git-wip-us.apache.org/repos/asf/cordova-plugin-wkwebview-engine.git IDESourceControlProjectVersion 111 IDESourceControlProjectWCCIdentifier BEF5A5D0FF64801E558286389440357A9233D7DB IDESourceControlProjectWCConfigurations IDESourceControlRepositoryExtensionIdentifierKey public.vcs.git IDESourceControlWCCIdentifierKey BEF5A5D0FF64801E558286389440357A9233D7DB IDESourceControlWCCName cordova-plugin-wkwebview-engine ================================================ FILE: tests/ios/CDVWKWebViewEngineTest/CDVWKWebViewEngineTest.xcodeproj/xcshareddata/xcschemes/CDVWKWebViewEngineLib.xcscheme ================================================ ================================================ FILE: tests/ios/CDVWKWebViewEngineTest/CDVWKWebViewEngineTest.xcodeproj/xcshareddata/xcschemes/CDVWKWebViewEngineLibTests.xcscheme ================================================ ================================================ FILE: tests/ios/CDVWKWebViewEngineTest.xcworkspace/contents.xcworkspacedata ================================================ ================================================ FILE: tests/ios/CDVWKWebViewEngineTest.xcworkspace/xcshareddata/CDVWKWebViewEngineTest.xccheckout ================================================ IDESourceControlProjectFavoriteDictionaryKey IDESourceControlProjectIdentifier 6BE9AD73-1B9F-4362-98D7-DC631BEC6185 IDESourceControlProjectName CDVWKWebViewEngineTest IDESourceControlProjectOriginsDictionary BEF5A5D0FF64801E558286389440357A9233D7DB https://git-wip-us.apache.org/repos/asf/cordova-plugin-wkwebview-engine.git IDESourceControlProjectPath tests/ios/CDVWKWebViewEngineTest/CDVWKWebViewEngineTest.xcodeproj IDESourceControlProjectRelativeInstallPathDictionary BEF5A5D0FF64801E558286389440357A9233D7DB ../../../../.. IDESourceControlProjectURL https://git-wip-us.apache.org/repos/asf/cordova-plugin-wkwebview-engine.git IDESourceControlProjectVersion 111 IDESourceControlProjectWCCIdentifier BEF5A5D0FF64801E558286389440357A9233D7DB IDESourceControlProjectWCConfigurations IDESourceControlRepositoryExtensionIdentifierKey public.vcs.git IDESourceControlWCCIdentifierKey BEF5A5D0FF64801E558286389440357A9233D7DB IDESourceControlWCCName cordova-plugin-wkwebview-engine ================================================ FILE: tests/ios/CDVWKWebViewEngineTest.xcworkspace/xcshareddata/xcschemes/CordovaLib.xcscheme ================================================ ================================================ FILE: tests/ios/README.md ================================================ # iOS Tests for CDVWKWebViewEngine You need to install `node.js` to pull in `cordova-ios`. First install cordova-ios: npm install ... in the current folder. # Testing from Xcode 1. Launch the `CDVWKWebViewEngineTest.xcworkspace` file. 2. Choose "CDVWKWebViewEngineLibTests" from the scheme drop-down menu 3. Click and hold on the `Play` button, and choose the `Wrench` icon to run the tests # Testing from the command line npm test ================================================ FILE: tests/ios/package.json ================================================ { "name": "cordova-plugin-wkwebview-engine-test-ios", "version": "1.0.0", "description": "iOS Unit Tests for cordova-plugin-wkwebview-engine Plugin", "author": "Apache Software Foundation", "license": "Apache Version 2.0", "dependencies": { "cordova-ios": "*" }, "scripts": { "test": "xcodebuild test -workspace CDVWKWebViewEngineTest.xcworkspace -scheme CDVWKWebViewEngineLibTests -destination 'platform=iOS Simulator,name=iPhone 5' -xcconfig test.xcconfig" } } ================================================ FILE: tests/ios/test.xcconfig ================================================ // // Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you under the Apache License, Version 2.0 (the // "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, // software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License. // HEADER_SEARCH_PATHS = $(TARGET_BUILD_DIR)/include ================================================ FILE: tests/package.json ================================================ { "name": "cordova-plugin-wkwebview-engine-tests", "version": "1.1.3-dev", "description": "", "cordova": { "id": "cordova-plugin-wkwebview-engine-tests", "platforms": [] }, "keywords": [ "ecosystem:cordova" ], "author": "", "license": "Apache 2.0" } ================================================ FILE: tests/plugin.xml ================================================ cordova-plugin-wkwebview-engine Tests Apache 2.0 ================================================ FILE: tests/tests.js ================================================ /* * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * */ /* jshint jasmine: true */ exports.defineAutoTests = function () { describe('cordova-plugin-wkwebview-engine (cordova)', function () { it("cordova-plugin-wkwebview-engine.spec.1 should exist", function () { //expect(window).toBeDefined(); }); }); }; exports.defineManualTests = function (contentEl, createActionButton) { contentEl.innerHTML = 'Your HTML instructions here'; createActionButton('Do something 1', function () { // do something 1; }, 'do-something-1'); createActionButton('Do something 2', function () { // do something 2; }, 'do-something-2'); };