Improve error management (rc in functions)
[anna.git] / source / core / util / Environment.cpp
1 // ANNA - Anna is Not Nothingness Anymore
2 //
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
4 //
5 // http://redmine.teslayout.com/projects/anna-suite
6 //
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
9 // are met:
10 //
11 //     * Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 //     * Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
16 // distribution.
17 //     *  Neither the name of the copyright holder nor the names of its
18 // contributors may be used to endorse or promote products derived from
19 // this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
33 // Authors: eduardo.ramos.testillano@gmail.com
34 //          cisco.tierra@gmail.com
35
36
37 #include <anna/core/util/Environment.hpp>
38
39 #include <anna/config/defines.hpp>
40 #include <anna/core/tracing/Logger.hpp>
41 #include <anna/core/tracing/TraceMethod.hpp>
42 #include <anna/core/functions.hpp>
43
44 #include <stdlib.h> // getenv / setenv
45 #include <string>
46
47
48
49 using namespace std;
50 using namespace anna;
51
52 extern int errno;
53
54 void Environment::initialize(char **envp) throw() {
55   LOGMETHOD(TraceMethod tm("Environment", "initialize", ANNA_FILE_LOCATION));
56   // clear data
57   a_vars.clear();
58
59   if(!envp) return;
60
61   // register data
62   std::string assignment, var, val;
63
64   while(*envp) {
65     assignment = *envp;
66     std::size_t equalPos = assignment.find("=");
67
68     if(equalPos !=  string::npos) {  // protection
69       var = assignment.substr(0, equalPos - 1);
70       val = assignment.substr(equalPos, assignment.size() - 1);
71       a_vars[var] = val;
72     }
73
74     envp++;
75   }
76 }
77
78 std::string Environment::getValue(const char* variableName, bool exceptionIfMissing) throw(RuntimeException) {
79   if(!variableName)
80     throw RuntimeException("Invalid NULL variable name!", ANNA_FILE_LOCATION);
81
82   std::string var = variableName;
83   return getValue(var, exceptionIfMissing);
84 }
85
86 std::string Environment::getValue(const std::string &variableName, bool exceptionIfMissing) throw(RuntimeException) {
87   std::string result = "";
88   std::map<std::string, std::string>::const_iterator it = a_vars.find(variableName);
89
90   if(it == a_vars.end()) {
91     char *current = getenv(variableName.c_str());
92
93     if(!current) {
94       std::string msg = "The variable '";
95       msg += variableName;
96       msg += "' is not defined in the environment.";
97       LOGDEBUG(Logger::debug(msg, ANNA_FILE_LOCATION));
98
99       if(exceptionIfMissing) throw RuntimeException(msg, ANNA_FILE_LOCATION);
100     } else {
101       // assignment
102       a_vars[variableName] = current;
103       result = current;
104     }
105   } else {
106     result = it->second;
107   }
108
109   return result;
110 }
111
112
113 void Environment::setVariable(const std::string &name, const std::string &value, bool overwrite) throw(RuntimeException) {
114   if(name == "") throw RuntimeException("Must provide non-empty variable name", ANNA_FILE_LOCATION);
115
116   if(setenv(name.c_str(), value.c_str(), overwrite ? 1 : 0) != 0) {
117     std::string msg = "Cannot set the environment variable '";
118     msg += name;
119     msg += "=\"";
120     msg += value;
121     msg += "\"'. The errno is ";
122     msg += anna::functions::asString(errno);
123     throw RuntimeException(msg, ANNA_FILE_LOCATION);
124   }
125
126   // optimization
127   if(overwrite)
128     a_vars[name] = value;
129 }
130
131
132 void Environment::unsetVariable(const std::string &name) throw(RuntimeException) {
133   if(name == "") throw RuntimeException("Must provide non-empty variable name", ANNA_FILE_LOCATION);
134
135   if(unsetenv(name.c_str()) != 0) {
136     std::string msg = "Cannot unset the environment variable named '";
137     msg += name;
138     msg += "'. The errno is ";
139     msg += anna::functions::asString(errno);
140     throw RuntimeException(msg, ANNA_FILE_LOCATION);
141   }
142
143   std::map<std::string, std::string>::iterator it = a_vars.find(name);
144
145   if(it != a_vars.end()) a_vars.erase(it);
146 }
147