Home | History | Annotate | Download | only in sender
      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 @interface Uploader : NSObject {
     46  @private
     47   NSMutableDictionary *parameters_;        // Key value pairs of data (STRONG)
     48   NSData *minidumpContents_;               // The data in the minidump (STRONG)
     49   NSData *logFileData_;                    // An NSdata for the tar,
     50                                            // bz2'd log file.
     51   NSMutableDictionary *serverDictionary_;  // The dictionary mapping a
     52                                            // server type name to a
     53                                            // dictionary of server
     54                                            // parameter names.
     55   NSMutableDictionary *socorroDictionary_; // The dictionary for
     56                                            // Socorro.
     57   NSMutableDictionary *googleDictionary_;  // The dictionary for
     58                                            // Google.
     59   NSMutableDictionary *extraServerVars_;   // A dictionary containing
     60                                            // extra key/value pairs
     61                                            // that are uploaded to the
     62                                            // crash server with the
     63                                            // minidump.
     64 }
     65 
     66 - (id)initWithConfigFile:(const char *)configFile;
     67 
     68 - (id)initWithConfig:(NSDictionary *)config;
     69 
     70 // Reads the file |configFile| and returns the corresponding NSDictionary.
     71 // |configFile| will be deleted after reading.
     72 + (NSDictionary *)readConfigurationDataFromFile:(NSString *)configFile;
     73 
     74 - (NSMutableDictionary *)parameters;
     75 
     76 - (void)report;
     77 
     78 // Upload the given data to the crash server.
     79 - (void)uploadData:(NSData *)data name:(NSString *)name;
     80 
     81 // This method adds a key/value pair to the dictionary that
     82 // will be uploaded to the crash server.
     83 - (void)addServerParameter:(id)value forKey:(NSString *)key;
     84 
     85 // This method process the HTTP response and renames the minidump file with the
     86 // new ID.
     87 - (void)handleNetworkResponse:(NSData *)data withError:(NSError *)error;
     88 
     89 @end
     90