granicus.if.org Git - icinga2/blob - lib/config/vmops.hpp

   1 /******************************************************************************
   2  * Icinga 2                                                                   *
   3  * Copyright (C) 2012-2016 Icinga Development Team (https://www.icinga.org/)  *
   4  *                                                                            *
   5  * This program is free software; you can redistribute it and/or              *
   6  * modify it under the terms of the GNU General Public License                *
   7  * as published by the Free Software Foundation; either version 2             *
   8  * of the License, or (at your option) any later version.                     *
   9  *                                                                            *
  10  * This program is distributed in the hope that it will be useful,            *
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
  13  * GNU General Public License for more details.                               *
  14  *                                                                            *
  15  * You should have received a copy of the GNU General Public License          *
  16  * along with this program; if not, write to the Free Software Foundation     *
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
  18  ******************************************************************************/
  19
  20 #ifndef VMOPS_H
  21 #define VMOPS_H
  22
  23 #include "config/i2-config.hpp"
  24 #include "config/expression.hpp"
  25 #include "config/configitembuilder.hpp"
  26 #include "config/applyrule.hpp"
  27 #include "config/objectrule.hpp"
  28 #include "base/debuginfo.hpp"
  29 #include "base/array.hpp"
  30 #include "base/dictionary.hpp"
  31 #include "base/function.hpp"
  32 #include "base/scriptglobal.hpp"
  33 #include "base/exception.hpp"
  34 #include "base/convert.hpp"
  35 #include "base/objectlock.hpp"
  36 #include <boost/smart_ptr/make_shared.hpp>
  37 #include <map>
  38 #include <vector>
  39
  40 namespace icinga
  41 {
  42
  43 class VMOps
  44 {
  45 public:
  46         static inline bool FindVarImportRef(ScriptFrame& frame, const String& name, Value *result, const DebugInfo& debugInfo = DebugInfo())
  47         {
  48                 Array::Ptr imports = ScriptFrame::GetImports();
  49
  50                 ObjectLock olock(imports);
  51                 for (const Value& import : imports) {
  52                         Object::Ptr obj = import;
  53                         if (obj->HasOwnField(name)) {
  54                                 *result = import;
  55                                 return true;
  56                         }
  57                 }
  58
  59                 return false;
  60         }
  61
  62         static inline bool FindVarImport(ScriptFrame& frame, const String& name, Value *result, const DebugInfo& debugInfo = DebugInfo())
  63         {
  64                 Value parent;
  65
  66                 if (FindVarImportRef(frame, name, &parent, debugInfo)) {
  67                         *result = GetField(parent, name, frame.Sandboxed, debugInfo);
  68                         return true;
  69                 }
  70
  71                 return false;
  72         }
  73
  74         static inline Value ConstructorCall(const Type::Ptr& type, const std::vector<Value>& args, const DebugInfo& debugInfo = DebugInfo())
  75         {
  76                 if (type->GetName() == "String") {
  77                         if (args.empty())
  78                                 return "";
  79                         else if (args.size() == 1)
  80                                 return Convert::ToString(args[0]);
  81                         else
  82                                 BOOST_THROW_EXCEPTION(ScriptError("Too many arguments for constructor."));
  83                 } else if (type->GetName() == "Number") {
  84                         if (args.empty())
  85                                 return 0;
  86                         else if (args.size() == 1)
  87                                 return Convert::ToDouble(args[0]);
  88                         else
  89                                 BOOST_THROW_EXCEPTION(ScriptError("Too many arguments for constructor."));
  90                 } else if (type->GetName() == "Boolean") {
  91                         if (args.empty())
  92                                 return 0;
  93                         else if (args.size() == 1)
  94                                 return Convert::ToBool(args[0]);
  95                         else
  96                                 BOOST_THROW_EXCEPTION(ScriptError("Too many arguments for constructor."));
  97                 } else if (args.size() == 1 && type->IsAssignableFrom(args[0].GetReflectionType()))
  98                         return args[0];
  99                 else
 100                         return type->Instantiate(args);
 101         }
 102
 103         static inline Value FunctionCall(ScriptFrame& frame, const Value& self, const Function::Ptr& func, const std::vector<Value>& arguments)
 104         {
 105                 if (!self.IsEmpty() || self.IsString())
 106                         return func->Invoke(self, arguments);
 107                 else
 108                         return func->Invoke(arguments);
 109
 110         }
 111
 112         static inline Value NewFunction(ScriptFrame& frame, const String& name, const std::vector<String>& args,
 113             std::map<String, Expression *> *closedVars, const boost::shared_ptr<Expression>& expression)
 114         {
 115                 return new Function(name, boost::bind(&FunctionWrapper, _1, args,
 116                     EvaluateClosedVars(frame, closedVars), expression));
 117         }
 118
 119         static inline Value NewApply(ScriptFrame& frame, const String& type, const String& target, const String& name, const boost::shared_ptr<Expression>& filter,
 120                 const String& package, const String& fkvar, const String& fvvar, const boost::shared_ptr<Expression>& fterm, std::map<String, Expression *> *closedVars,
 121                 bool ignoreOnError, const boost::shared_ptr<Expression>& expression, const DebugInfo& debugInfo = DebugInfo())
 122         {
 123                 ApplyRule::AddRule(type, target, name, expression, filter, package, fkvar,
 124                     fvvar, fterm, ignoreOnError, debugInfo, EvaluateClosedVars(frame, closedVars));
 125
 126                 return Empty;
 127         }
 128
 129         static inline Value NewObject(ScriptFrame& frame, bool abstract, const String& type, const String& name, const boost::shared_ptr<Expression>& filter,
 130                 const String& zone, const String& package, bool defaultTmpl, bool ignoreOnError, std::map<String, Expression *> *closedVars, const boost::shared_ptr<Expression>& expression, const DebugInfo& debugInfo = DebugInfo())
 131         {
 132                 ConfigItemBuilder::Ptr item = new ConfigItemBuilder(debugInfo);
 133
 134                 String checkName = name;
 135
 136                 if (!abstract) {
 137                         Type::Ptr ptype = Type::GetByName(type);
 138
 139                         NameComposer *nc = dynamic_cast<NameComposer *>(ptype.get());
 140
 141                         if (nc)
 142                                 checkName = nc->MakeName(name, Dictionary::Ptr());
 143                 }
 144
 145                 if (!checkName.IsEmpty()) {
 146                         ConfigItem::Ptr oldItem = ConfigItem::GetByTypeAndName(type, checkName);
 147
 148                         if (oldItem) {
 149                                 std::ostringstream msgbuf;
 150                                 msgbuf << "Object '" << name << "' of type '" << type << "' re-defined: " << debugInfo << "; previous definition: " << oldItem->GetDebugInfo();
 151                                 BOOST_THROW_EXCEPTION(ScriptError(msgbuf.str(), debugInfo));
 152                         }
 153                 }
 154
 155                 item->SetType(type);
 156                 item->SetName(name);
 157
 158                 if (!abstract)
 159                         item->AddExpression(new ImportDefaultTemplatesExpression());
 160
 161                 item->AddExpression(new OwnedExpression(expression));
 162                 item->SetAbstract(abstract);
 163                 item->SetScope(EvaluateClosedVars(frame, closedVars));
 164                 item->SetZone(zone);
 165                 item->SetPackage(package);
 166                 item->SetFilter(filter);
 167                 item->SetDefaultTemplate(defaultTmpl);
 168                 item->SetIgnoreOnError(ignoreOnError);
 169                 item->Compile()->Register();
 170
 171                 return Empty;
 172         }
 173
 174         static inline ExpressionResult For(ScriptFrame& frame, const String& fkvar, const String& fvvar, const Value& value, Expression *expression, const DebugInfo& debugInfo = DebugInfo())
 175         {
 176                 if (value.IsObjectType<Array>()) {
 177                         if (!fvvar.IsEmpty())
 178                                 BOOST_THROW_EXCEPTION(ScriptError("Cannot use dictionary iterator for array.", debugInfo));
 179
 180                         Array::Ptr arr = value;
 181
 182                         for (Array::SizeType i = 0; i < arr->GetLength(); i++) {
 183                                 frame.Locals->Set(fkvar, arr->Get(i));
 184                                 ExpressionResult res = expression->Evaluate(frame);
 185                                 CHECK_RESULT_LOOP(res);
 186                         }
 187                 } else if (value.IsObjectType<Dictionary>()) {
 188                         if (fvvar.IsEmpty())
 189                                 BOOST_THROW_EXCEPTION(ScriptError("Cannot use array iterator for dictionary.", debugInfo));
 190
 191                         Dictionary::Ptr dict = value;
 192                         std::vector<String> keys;
 193
 194                         {
 195                                 ObjectLock olock(dict);
 196                                 for (const Dictionary::Pair& kv : dict) {
 197                                         keys.push_back(kv.first);
 198                                 }
 199                         }
 200
 201                         for (const String& key : keys) {
 202                                 frame.Locals->Set(fkvar, key);
 203                                 frame.Locals->Set(fvvar, dict->Get(key));
 204                                 ExpressionResult res = expression->Evaluate(frame);
 205                                 CHECK_RESULT_LOOP(res);
 206                         }
 207                 } else
 208                         BOOST_THROW_EXCEPTION(ScriptError("Invalid type in for expression: " + value.GetTypeName(), debugInfo));
 209
 210                 return Empty;
 211         }
 212
 213         static inline Value GetField(const Value& context, const String& field, bool sandboxed = false, const DebugInfo& debugInfo = DebugInfo())
 214         {
 215                 if (unlikely(context.IsEmpty() && !context.IsString()))
 216                         return Empty;
 217
 218                 if (unlikely(!context.IsObject()))
 219                         return GetPrototypeField(context, field, true, debugInfo);
 220
 221                 Object::Ptr object = context;
 222
 223                 return object->GetFieldByName(field, sandboxed, debugInfo);
 224         }
 225
 226         static inline void SetField(const Object::Ptr& context, const String& field, const Value& value, const DebugInfo& debugInfo = DebugInfo())
 227         {
 228                 if (!context)
 229                         BOOST_THROW_EXCEPTION(ScriptError("Cannot set field '" + field + "' on a value that is not an object.", debugInfo));
 230
 231                 return context->SetFieldByName(field, value, debugInfo);
 232         }
 233
 234 private:
 235         static inline Value FunctionWrapper(const std::vector<Value>& arguments,
 236             const std::vector<String>& funcargs, const Dictionary::Ptr& closedVars, const boost::shared_ptr<Expression>& expr)
 237         {
 238                 if (arguments.size() < funcargs.size())
 239                         BOOST_THROW_EXCEPTION(std::invalid_argument("Too few arguments for function"));
 240
 241                 ScriptFrame *frame = ScriptFrame::GetCurrentFrame();
 242
 243                 if (closedVars)
 244                         closedVars->CopyTo(frame->Locals);
 245
 246                 for (std::vector<Value>::size_type i = 0; i < std::min(arguments.size(), funcargs.size()); i++)
 247                         frame->Locals->Set(funcargs[i], arguments[i]);
 248
 249                 return expr->Evaluate(*frame);
 250         }
 251
 252         static inline Dictionary::Ptr EvaluateClosedVars(ScriptFrame& frame, std::map<String, Expression *> *closedVars)
 253         {
 254                 Dictionary::Ptr locals;
 255
 256                 if (closedVars) {
 257                         locals = new Dictionary();
 258
 259                         typedef std::pair<String, Expression *> ClosedVar;
 260                         for (const ClosedVar& cvar : *closedVars) {
 261                                 locals->Set(cvar.first, cvar.second->Evaluate(frame));
 262                         }
 263                 }
 264
 265                 return locals;
 266         }
 267 };
 268
 269 }
 270
 271 #endif /* VMOPS_H */