ConfigFile.h revision 00936cf4ad413ec012b81c814319467c206d7447
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// Utility class that can persist a SimpleStringDictionary to disk.
31
32#import <Foundation/Foundation.h>
33
34#import "common/mac/SimpleStringDictionary.h"
35
36namespace google_breakpad {
37
38BOOL EnsureDirectoryPathExists(NSString *dirPath);
39
40//=============================================================================
41class ConfigFile {
42 public:
43  ConfigFile() {
44    config_file_ = -1;
45    config_file_path_[0] = 0;
46    has_created_file_ = false;
47  };
48
49  ~ConfigFile() {
50  };
51
52  void WriteFile(const char* directory,
53                 const SimpleStringDictionary *configurationParameters,
54                 const char *dump_dir,
55                 const char *minidump_id);
56
57  const char *GetFilePath() { return config_file_path_; }
58
59  void Unlink() {
60    if (config_file_ != -1)
61      unlink(config_file_path_);
62
63    config_file_ = -1;
64  }
65
66 private:
67  BOOL WriteData(const void *data, size_t length);
68
69  BOOL AppendConfigData(const char *key,
70                        const void *data,
71                        size_t length);
72
73  BOOL AppendConfigString(const char *key,
74                          const char *value);
75
76  BOOL AppendCrashTimeParameters(const char *processStartTimeString);
77
78  int   config_file_;                    // descriptor for config file
79  char  config_file_path_[PATH_MAX];     // Path to configuration file
80  bool  has_created_file_;
81};
82
83} // namespace google_breakpad
84