1 // Copyright (c) 2011, Google Inc. 2 // All rights reserved. 3 // 4 // Redistribution and use in source and binary forms, with or without 5 // modification, are permitted provided that the following conditions are 6 // met: 7 // 8 // * Redistributions of source code must retain the above copyright 9 // notice, this list of conditions and the following disclaimer. 10 // * Redistributions in binary form must reproduce the above 11 // copyright notice, this list of conditions and the following disclaimer 12 // in the documentation and/or other materials provided with the 13 // distribution. 14 // * Neither the name of Google Inc. nor the names of its 15 // contributors may be used to endorse or promote products derived from 16 // this software without specific prior written permission. 17 // 18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 // 30 // This component uses the HTTPMultipartUpload of the breakpad project to send 31 // the minidump and associated data to the crash reporting servers. 32 // It will perform throttling based on the parameters passed to it and will 33 // prompt the user to send the minidump. 34 35 #include <Foundation/Foundation.h> 36 37 #import "common/mac/GTMDefines.h" 38 39 #define kClientIdPreferenceKey @"clientid" 40 41 extern NSString *const kGoogleServerType; 42 extern NSString *const kSocorroServerType; 43 extern NSString *const kDefaultServerType; 44 45 // Optional user-defined function that will be called after a network upload 46 // of a crash report. 47 // |report_id| will be the id returned by the server, or "ERR" if an error 48 // occurred. 49 // |error| will contain the error, or nil if no error occured. 50 typedef void (^UploadCompletionBlock)(NSString *reportId, NSError *error); 51 52 @interface Uploader : NSObject { 53 @private 54 NSMutableDictionary *parameters_; // Key value pairs of data (STRONG) 55 NSData *minidumpContents_; // The data in the minidump (STRONG) 56 NSData *logFileData_; // An NSdata for the tar, 57 // bz2'd log file. 58 NSMutableDictionary *serverDictionary_; // The dictionary mapping a 59 // server type name to a 60 // dictionary of server 61 // parameter names. 62 NSMutableDictionary *socorroDictionary_; // The dictionary for 63 // Socorro. 64 NSMutableDictionary *googleDictionary_; // The dictionary for 65 // Google. 66 NSMutableDictionary *extraServerVars_; // A dictionary containing 67 // extra key/value pairs 68 // that are uploaded to the 69 // crash server with the 70 // minidump. 71 UploadCompletionBlock uploadCompletion_; // A block called on network upload 72 // completion. Parameters are: 73 // The report ID returned by the 74 // server, 75 // the NSError triggered during 76 // upload. 77 } 78 79 - (id)initWithConfigFile:(const char *)configFile; 80 81 - (id)initWithConfig:(NSDictionary *)config; 82 83 // Reads the file |configFile| and returns the corresponding NSDictionary. 84 // |configFile| will be deleted after reading. 85 + (NSDictionary *)readConfigurationDataFromFile:(NSString *)configFile; 86 87 - (NSMutableDictionary *)parameters; 88 89 - (void)report; 90 91 // Upload the given data to the crash server. 92 - (void)uploadData:(NSData *)data name:(NSString *)name; 93 94 // This method adds a key/value pair to the dictionary that 95 // will be uploaded to the crash server. 96 - (void)addServerParameter:(id)value forKey:(NSString *)key; 97 98 // This method process the HTTP response and renames the minidump file with the 99 // new ID. 100 - (void)handleNetworkResponse:(NSData *)data withError:(NSError *)error; 101 102 // Sets the callback to be called after uploading a crash report to the server. 103 // Only the latest callback registered will be called. 104 - (void)setUploadCompletionBlock:(UploadCompletionBlock)uploadCompletion; 105 106 @end 107