]> git.mxchange.org Git - flightgear.git/blobdiff - src/Scripting/NasalSys.cxx
Nasal: use SG_LOG for security error messages to avoid truncation
[flightgear.git] / src / Scripting / NasalSys.cxx
index b2f08fe01263097d4736168484664963b6ef5ec5..8e7622eae1de75af1dbebaadaae6dc17249f4ad9 100644 (file)
@@ -12,6 +12,7 @@
 #endif
 
 #include <string.h>
+#include <errno.h>
 #include <stdio.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <sstream>
 
 #include <simgear/nasal/nasal.h>
+#include <simgear/nasal/iolib.h>
 #include <simgear/props/props.hxx>
 #include <simgear/math/sg_random.h>
 #include <simgear/misc/sg_path.hxx>
 #include <simgear/misc/sg_dir.hxx>
+#include <simgear/misc/SimpleMarkdown.hxx>
 #include <simgear/structure/commands.hxx>
 #include <simgear/math/sg_geodesy.hxx>
 #include <simgear/structure/event_mgr.hxx>
@@ -36,6 +39,7 @@
 #include "NasalSGPath.hxx"
 #include "NasalSys.hxx"
 #include "NasalSys_private.hxx"
+#include "NasalAircraft.hxx"
 #include "NasalModelData.hxx"
 #include "NasalPositioned.hxx"
 #include "NasalCanvas.hxx"
@@ -144,11 +148,14 @@ public:
   
   void invoke()
   {
+    if( _singleShot )
+      // Callback may restart the timer, so update status before callback is
+      // called (Prevent warnings of deleting not existing tasks from the
+      // event manager).
+      _isRunning = false;
+
     naRef *args = NULL;
     _sys->callMethod(_func, _self, 0, args, naNil() /* locals */);
-    if (_singleShot) {
-      _isRunning = false;
-    }
   }
   
   void setSingleShot(bool aSingleShot)
@@ -201,7 +208,8 @@ static char* readfile(const char* file, int* lenOut)
     return buf;
 }
 
-FGNasalSys::FGNasalSys()
+FGNasalSys::FGNasalSys() :
+    _inited(false)
 {
     nasalSys = this;
     _context = 0;
@@ -235,6 +243,11 @@ naRef FGNasalSys::call(naRef code, int argc, naRef* args, naRef locals)
   return callMethod(code, naNil(), argc, args, locals);
 }
 
+naRef FGNasalSys::callWithContext(naContext ctx, naRef code, int argc, naRef* args, naRef locals)
+{
+  return callMethodWithContext(ctx, code, naNil(), argc, args, locals);
+}
+
 // Does a naCall() in a new context.  Wrapped here to make lock
 // tracking easier.  Extension functions are called with the lock, but
 // we have to release it before making a new naCall().  So rather than
@@ -247,18 +260,30 @@ naRef FGNasalSys::callMethod(naRef code, naRef self, int argc, naRef* args, naRe
   return naCallMethod(code, self, argc, args, locals);
 }
 
+naRef FGNasalSys::callMethodWithContext(naContext ctx, naRef code, naRef self, int argc, naRef* args, naRef locals)
+{
+  return naCallMethodCtx(ctx, code, self, argc, args, locals);
+}
+
 FGNasalSys::~FGNasalSys()
 {
+    if (_inited) {
+        SG_LOG(SG_GENERAL, SG_ALERT, "Nasal was not shutdown");
+    }
     nasalSys = 0;
 }
 
 bool FGNasalSys::parseAndRun(const char* sourceCode)
 {
-    naRef code = parse("FGNasalSys::parseAndRun()", sourceCode,
+    naContext ctx = naNewContext();
+    naRef code = parse(ctx, "FGNasalSys::parseAndRun()", sourceCode,
                        strlen(sourceCode));
-    if(naIsNil(code))
+    if(naIsNil(code)) {
+        naFreeContext(ctx);
         return false;
-    call(code, 0, 0, naNil());
+    }
+    callWithContext(ctx, code, 0, 0, naNil());
+    naFreeContext(ctx);
     return true;
 }
 
@@ -435,14 +460,13 @@ static naRef f_fgcommand(naContext c, naRef me, int argc, naRef* args)
     naRef props = argc > 1 ? args[1] : naNil();
     if(!naIsString(cmd) || (!naIsNil(props) && !naIsGhost(props)))
         naRuntimeError(c, "bad arguments to fgcommand()");
-    SGPropertyNode_ptr tmp, *node;
+    SGPropertyNode_ptr node;
     if(!naIsNil(props))
-        node = (SGPropertyNode_ptr*)naGhost_ptr(props);
-    else {
-        tmp = new SGPropertyNode();
-        node = &tmp;
-    }
-    return naNum(globals->get_commands()->execute(naStr_data(cmd), *node));
+        node = static_cast<SGPropertyNode*>(naGhost_ptr(props));
+    else
+        node = new SGPropertyNode;
+
+    return naNum(globals->get_commands()->execute(naStr_data(cmd), node));
 }
 
 // settimer(func, dt, simtime) extension function.  Falls through to
@@ -468,7 +492,7 @@ static naRef f_makeTimer(naContext c, naRef me, int argc, naRef* args)
   }
   
   TimerObj* timerObj = new TimerObj(nasalSys, func, self, args[0].num);
-  return NasalTimerObj::create(c, timerObj);
+  return nasal::to_nasal(c, timerObj);
 }
 
 // setlistener(func, property, bool) extension function.  Falls through to
@@ -493,7 +517,7 @@ static naRef f_cmdarg(naContext c, naRef me, int argc, naRef* args)
 }
 
 // Sets up a property interpolation.  The first argument is either a
-// ghost (SGPropertyNode_ptr*) or a string (global property path) to
+// ghost (SGPropertyNode*) or a string (global property path) to
 // interpolate.  The second argument is a vector of pairs of
 // value/delta numbers.
 static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args)
@@ -501,7 +525,7 @@ static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args)
   SGPropertyNode* node;
   naRef prop = argc > 0 ? args[0] : naNil();
   if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
-  else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
+  else if(naIsGhost(prop)) node = static_cast<SGPropertyNode*>(naGhost_ptr(prop));
   else return naNil();
 
   naRef curve = argc > 1 ? args[1] : naNil();
@@ -640,6 +664,28 @@ static naRef f_removeCommand(naContext c, naRef me, int argc, naRef* args)
     return naNil();
 }
 
+static naRef f_open(naContext c, naRef me, int argc, naRef* args)
+{
+    FILE* f;
+    naRef file = argc > 0 ? naStringValue(c, args[0]) : naNil();
+    naRef mode = argc > 1 ? naStringValue(c, args[1]) : naNil();
+    if(!naStr_data(file)) naRuntimeError(c, "bad argument to open()");
+    const char* modestr = naStr_data(mode) ? naStr_data(mode) : "rb";
+    std::string filename = fgValidatePath(naStr_data(file),
+        strcmp(modestr, "rb") && strcmp(modestr, "r"));
+    if(filename.empty()) {
+        SG_LOG(SG_NASAL, SG_ALERT, "open(): reading/writing '" <<
+        naStr_data(file) << "' denied (unauthorized directory - authorization"
+        " no longer follows symlinks; to authorize reading additional "
+        "directories, add them to --fg-aircraft)");
+        naRuntimeError(c, "open(): access denied (unauthorized directory)");
+        return naNil();
+    }
+    f = fopen(filename.c_str(), modestr);
+    if(!f) naRuntimeError(c, strerror(errno));
+    return naIOGhost(c, f);
+}
+
 // Parse XML file.
 //     parsexml(<path> [, <start-tag> [, <end-tag> [, <data> [, <pi>]]]]);
 //
@@ -660,22 +706,54 @@ static naRef f_parsexml(naContext c, naRef me, int argc, naRef* args)
         if(!(naIsNil(args[i]) || naIsFunc(args[i])))
             naRuntimeError(c, "parsexml(): callback argument not a function");
 
-    const char* file = fgValidatePath(naStr_data(args[0]), false);
-    if(!file) {
-        naRuntimeError(c, "parsexml(): reading '%s' denied "
-                "(unauthorized access)", naStr_data(args[0]));
+    std::string file = fgValidatePath(naStr_data(args[0]), false);
+    if(file.empty()) {
+        SG_LOG(SG_NASAL, SG_ALERT, "parsexml(): reading '" <<
+        naStr_data(args[0]) << "' denied (unauthorized directory - authorization"
+        " no longer follows symlinks; to authorize reading additional "
+        "directories, add them to --fg-aircraft)");
+        naRuntimeError(c, "parsexml(): access denied (unauthorized directory)");
         return naNil();
     }
-    std::ifstream input(file);
+    std::ifstream input(file.c_str());
     NasalXMLVisitor visitor(c, argc, args);
     try {
         readXML(input, visitor);
     } catch (const sg_exception& e) {
         naRuntimeError(c, "parsexml(): file '%s' %s",
-                file, e.getFormattedMessage().c_str());
+                file.c_str(), e.getFormattedMessage().c_str());
         return naNil();
     }
-    return naStr_fromdata(naNewString(c), const_cast<char*>(file), strlen(file));
+    return naStr_fromdata(naNewString(c), file.c_str(), file.length());
+}
+
+/**
+ * Parse very simple and small subset of markdown
+ *
+ * parse_markdown(src)
+ */
+static naRef f_parse_markdown(naContext c, naRef me, int argc, naRef* args)
+{
+  nasal::CallContext ctx(c, me, argc, args);
+  return ctx.to_nasal(
+    simgear::SimpleMarkdown::parse(ctx.requireArg<std::string>(0))
+  );
+}
+
+/**
+ * Create md5 hash from given string
+ *
+ * md5(str)
+ */
+static naRef f_md5(naContext c, naRef me, int argc, naRef* args)
+{
+  if( argc != 1 || !naIsString(args[0]) )
+    naRuntimeError(c, "md5(): wrong type or number of arguments");
+
+  return nasal::to_nasal(
+    c,
+    simgear::strutils::md5(naStr_data(args[0]), naStr_len(args[0]))
+  );
 }
 
 // Return UNIX epoch time in seconds.
@@ -716,6 +794,8 @@ static struct { const char* name; naCFunction func; } funcs[] = {
     { "resolvepath", f_resolveDataPath },
     { "finddata", f_findDataDir },
     { "parsexml", f_parsexml },
+    { "parse_markdown", f_parse_markdown },
+    { "md5", f_md5 },
     { "systime", f_systime },
     { 0, 0 }
 };
@@ -732,6 +812,9 @@ void FGNasalSys::setCmdArg(SGPropertyNode* aNode)
 
 void FGNasalSys::init()
 {
+    if (_inited) {
+        SG_LOG(SG_GENERAL, SG_ALERT, "duplicate init of Nasal");
+    }
     int i;
 
     _context = naNewContext();
@@ -754,7 +837,9 @@ void FGNasalSys::init()
     for(i=0; funcs[i].name; i++)
         hashset(_globals, funcs[i].name,
                 naNewFunc(_context, naNewCCode(_context, funcs[i].func)));
-
+    nasal::Hash io_module = nasal::Hash(_globals, _context).get<nasal::Hash>("io");
+    io_module.set("open", f_open);
+    
     // And our SGPropertyNode wrapper
     hashset(_globals, "props", genPropsModule());
 
@@ -765,6 +850,7 @@ void FGNasalSys::init()
 
     initNasalPositioned(_globals, _context);
     initNasalPositioned_cppbind(_globals, _context);
+    initNasalAircraft(_globals, _context);
     NasalClipboard::init(this);
     initNasalCanvas(_globals, _context);
     initNasalCondition(_globals, _context);
@@ -778,6 +864,9 @@ void FGNasalSys::init()
       .member("singleShot", &TimerObj::isSingleShot, &TimerObj::setSingleShot)
       .member("isRunning", &TimerObj::isRunning);
 
+    // Set allowed paths for Nasal I/O
+    fgInitAllowedPaths();
+    
     // Now load the various source files in the Nasal directory
     simgear::Dir nasalDir(SGPath(globals->get_fg_root(), "Nasal"));
     loadScriptDirectory(nasalDir);
@@ -803,10 +892,16 @@ void FGNasalSys::init()
     // now Nasal modules are loaded, we can do some delayed work
     postinitNasalPositioned(_globals, _context);
     postinitNasalGUI(_globals, _context);
+    
+    _inited = true;
 }
 
 void FGNasalSys::shutdown()
 {
+    if (!_inited) {
+        return;
+    }
+    
     shutdownNasalPositioned();
     
     map<int, FGNasalListener *>::iterator it, end = _listener.end();
@@ -837,7 +932,7 @@ void FGNasalSys::shutdown()
     _globals = naNil();    
     
     naGC();
-    
+    _inited = false;
 }
 
 naRef FGNasalSys::wrappedPropsNode(SGPropertyNode* aProps)
@@ -850,7 +945,7 @@ naRef FGNasalSys::wrappedPropsNode(SGPropertyNode* aProps)
     naRef args[1];
     args[0] = propNodeGhost(aProps);
     naContext ctx = naNewContext();
-    naRef wrapped = naCall(ctx, _wrappedNodeFunc, 1, args, naNil(), naNil());
+    naRef wrapped = naCallMethodCtx(ctx, _wrappedNodeFunc, naNil(), 1, args, naNil());
     naFreeContext(ctx);
     return wrapped;
 }
@@ -882,6 +977,9 @@ void FGNasalSys::update(double)
         _unloadList.pop()->unload();
     }
 
+    // Destroy all queued ghosts
+    nasal::ghostProcessDestroyList();
+
     // The global context is a legacy thing.  We use dynamically
     // created contexts for naCall() now, so that we can call them
     // recursively.  But there are still spots that want to use it for
@@ -1059,11 +1157,13 @@ bool FGNasalSys::createModule(const char* moduleName, const char* fileName,
                               const SGPropertyNode* cmdarg,
                               int argc, naRef* args)
 {
-    naRef code = parse(fileName, src, len);
-    if(naIsNil(code))
+    naContext ctx = naNewContext();
+    naRef code = parse(ctx, fileName, src, len);
+    if(naIsNil(code)) {
+        naFreeContext(ctx);
         return false;
+    }
 
-    naContext ctx = naNewContext();
     
     // See if we already have a module hash to use.  This allows the
     // user to, for example, add functions to the built-in math
@@ -1076,7 +1176,7 @@ bool FGNasalSys::createModule(const char* moduleName, const char* fileName,
 
     _cmdArg = (SGPropertyNode*)cmdarg;
 
-    call(code, argc, args, locals);
+    callWithContext(ctx, code, argc, args, locals);
     hashset(_globals, moduleName, locals);
     
     naFreeContext(ctx);
@@ -1085,6 +1185,12 @@ bool FGNasalSys::createModule(const char* moduleName, const char* fileName,
 
 void FGNasalSys::deleteModule(const char* moduleName)
 {
+    if (!_inited) {
+        // can occur on shutdown due to us being shutdown first, but other
+        // subsystems having Nasal objects.
+        return;
+    }
+    
     naContext ctx = naNewContext();
     naRef modname = naNewString(ctx);
     naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
@@ -1092,10 +1198,9 @@ void FGNasalSys::deleteModule(const char* moduleName)
     naFreeContext(ctx);
 }
 
-naRef FGNasalSys::parse(const char* filename, const char* buf, int len)
+naRef FGNasalSys::parse(naContext ctx, const char* filename, const char* buf, int len)
 {
     int errLine = -1;
-    naContext ctx = naNewContext();
     naRef srcfile = naNewString(ctx);
     naStr_fromdata(srcfile, (char*)filename, strlen(filename));
     naRef code = naParseCode(ctx, srcfile, 1, (char*)buf, len, &errLine);
@@ -1103,14 +1208,11 @@ naRef FGNasalSys::parse(const char* filename, const char* buf, int len)
         SG_LOG(SG_NASAL, SG_ALERT,
                "Nasal parse error: " << naGetError(ctx) <<
                " in "<< filename <<", line " << errLine);
-        naFreeContext(ctx);
         return naNil();
     }
 
     // Bind to the global namespace before returning
-    naRef bound = naBindFunction(ctx, code, _globals);
-    naFreeContext(ctx);
-    return bound;
+    return naBindFunction(ctx, code, _globals);
 }
 
 bool FGNasalSys::handleCommand( const char* moduleName,
@@ -1118,22 +1220,24 @@ bool FGNasalSys::handleCommand( const char* moduleName,
                                 const char* src,
                                 const SGPropertyNode* arg )
 {
-    naRef code = parse(fileName, src, strlen(src));
-    if(naIsNil(code)) return false;
+    naContext ctx = naNewContext();
+    naRef code = parse(ctx, fileName, src, strlen(src));
+    if(naIsNil(code)) {
+        naFreeContext(ctx);
+        return false;
+    }
 
     // Commands can be run "in" a module.  Make sure that module
     // exists, and set it up as the local variables hash for the
     // command.
     naRef locals = naNil();
     if(moduleName[0]) {
-        naContext ctx = naNewContext();
         naRef modname = naNewString(ctx);
         naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
         if(!naHash_get(_globals, modname, &locals)) {
             locals = naNewHash(ctx);
             naHash_set(_globals, modname, locals);
         }
-        naFreeContext(ctx);
     }
 
     // Cache this command's argument for inspection via cmdarg().  For
@@ -1141,7 +1245,8 @@ bool FGNasalSys::handleCommand( const char* moduleName,
     // code doesn't need it.
     _cmdArg = (SGPropertyNode*)arg;
 
-    call(code, 0, 0, locals);
+    callWithContext(ctx, code, 0, 0, locals);
+    naFreeContext(ctx);
     return true;
 }
 
@@ -1151,7 +1256,7 @@ bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
   const char* moduleName = arg->getStringValue("module");
 
   return handleCommand( moduleName,
-                        arg ? arg->getPath(true).c_str() : moduleName,
+                        arg->getPath(true).c_str(),
                         src,
                         arg );
 }
@@ -1210,6 +1315,8 @@ void FGNasalSys::gcRelease(int key)
     naGCRelease(key);
 }
 
+
+//------------------------------------------------------------------------------
 void FGNasalSys::NasalTimer::timerExpired()
 {
     nasal->handleTimer(this);
@@ -1220,7 +1327,7 @@ int FGNasalSys::_listenerId = 0;
 
 // setlistener(<property>, <func> [, <initial=0> [, <persistent=1>]])
 // Attaches a callback function to a property (specified as a global
-// property path string or a SGPropertyNode_ptr* ghost). If the third,
+// property path string or a SGPropertyNode* ghost). If the third,
 // optional argument (default=0) is set to 1, then the function is also
 // called initially. If the fourth, optional argument is set to 0, then the
 // function is only called when the property node value actually changes.
@@ -1233,7 +1340,7 @@ naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
     SGPropertyNode_ptr node;
     naRef prop = argc > 0 ? args[0] : naNil();
     if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
-    else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
+    else if(naIsGhost(prop)) node = static_cast<SGPropertyNode*>(naGhost_ptr(prop));
     else {
         naRuntimeError(c, "setlistener() with invalid property argument");
         return naNil();