michael@0: // Copyright (c) 2011, Google Inc.
michael@0: // All rights reserved.
michael@0: //
michael@0: // Redistribution and use in source and binary forms, with or without
michael@0: // modification, are permitted provided that the following conditions are
michael@0: // met:
michael@0: //
michael@0: //     * Redistributions of source code must retain the above copyright
michael@0: // notice, this list of conditions and the following disclaimer.
michael@0: //     * Redistributions in binary form must reproduce the above
michael@0: // copyright notice, this list of conditions and the following disclaimer
michael@0: // in the documentation and/or other materials provided with the
michael@0: // distribution.
michael@0: //     * Neither the name of Google Inc. nor the names of its
michael@0: // contributors may be used to endorse or promote products derived from
michael@0: // this software without specific prior written permission.
michael@0: //
michael@0: // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0: // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0: // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0: // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
michael@0: // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
michael@0: // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
michael@0: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
michael@0: // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
michael@0: // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
michael@0: // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
michael@0: // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0: //
michael@0: // This component uses the HTTPMultipartUpload of the breakpad project to send
michael@0: // the minidump and associated data to the crash reporting servers.
michael@0: // It will perform throttling based on the parameters passed to it and will
michael@0: // prompt the user to send the minidump.
michael@0: 
michael@0: #include <Foundation/Foundation.h>
michael@0: 
michael@0: #import "common/mac/GTMDefines.h"
michael@0: 
michael@0: #define kClientIdPreferenceKey @"clientid"
michael@0: 
michael@0: extern NSString *const kGoogleServerType;
michael@0: extern NSString *const kSocorroServerType;
michael@0: extern NSString *const kDefaultServerType;
michael@0: 
michael@0: @interface Uploader : NSObject {
michael@0:  @private
michael@0:   NSMutableDictionary *parameters_;        // Key value pairs of data (STRONG)
michael@0:   NSData *minidumpContents_;               // The data in the minidump (STRONG)
michael@0:   NSData *logFileData_;                    // An NSdata for the tar,
michael@0:                                            // bz2'd log file.
michael@0:   NSMutableDictionary *serverDictionary_;  // The dictionary mapping a
michael@0:                                            // server type name to a
michael@0:                                            // dictionary of server
michael@0:                                            // parameter names.
michael@0:   NSMutableDictionary *socorroDictionary_; // The dictionary for
michael@0:                                            // Socorro.
michael@0:   NSMutableDictionary *googleDictionary_;  // The dictionary for
michael@0:                                            // Google.
michael@0:   NSMutableDictionary *extraServerVars_;   // A dictionary containing
michael@0:                                            // extra key/value pairs
michael@0:                                            // that are uploaded to the
michael@0:                                            // crash server with the
michael@0:                                            // minidump.
michael@0: }
michael@0: 
michael@0: - (id)initWithConfigFile:(const char *)configFile;
michael@0: 
michael@0: - (id)initWithConfig:(NSDictionary *)config;
michael@0: 
michael@0: - (NSMutableDictionary *)parameters;
michael@0: 
michael@0: - (void)report;
michael@0: 
michael@0: // Upload the given data to the crash server.
michael@0: - (void)uploadData:(NSData *)data name:(NSString *)name;
michael@0: 
michael@0: // This method adds a key/value pair to the dictionary that
michael@0: // will be uploaded to the crash server.
michael@0: - (void)addServerParameter:(id)value forKey:(NSString *)key;
michael@0: 
michael@0: @end