Changeset 16903 in vbox for trunk

Timestamp:

Feb 18, 2009 2:17:15 PM (16 years ago)

Author:

vboxsync

Message:

Python: imporved error reporting in XPCOM, shell updates, docs

Location:

trunk/src

Files:

• VBox/Main/VirtualBoxImpl.cpp (modified) (1 diff)
• VBox/Main/idl/VirtualBox.xidl (modified) (1 diff)
• libs/xpcom18a4/python/sample/shellcommon.py (modified) (5 diffs)
• libs/xpcom18a4/python/src/ErrorUtils.cpp (modified) (5 diffs)
• libs/xpcom18a4/python/src/PyISupports.cpp (modified) (12 diffs)
• libs/xpcom18a4/python/src/PyXPCOM.h (modified) (1 diff)

trunk/src/VBox/Main/VirtualBoxImpl.cpp

@@ -749 +749 @@
 {
     LogFlowThisFuncEnter();
+    LogFlowThisFunc (("aName=\"%ls\",aOsTypeId =\"%ls\",aBaseFolder=\"%ls\"\n", aName, aOsTypeId, aBaseFolder));
 
     CheckComArgStrNotEmptyOrNull (aName);

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -1497 +1497 @@
         However, this is not recommended and you should normally pass an empty
         (null) UUID to this method so that a new UUID will be automatically
-        generated for every created machine.
+        generated for every created machine. You can use UUID
+        00000000-0000-0000-0000-000000000000 as null value.
 
         <note>

trunk/src/libs/xpcom18a4/python/sample/shellcommon.py

@@ -145 +145 @@
    return s.split()
 
-def startVm(mgr,vb,mach,type,perf):
+def createVm(ctx,name,kind,base):
+    mgr = ctx['mgr']
+    vb = ctx['vb']
+    session = mgr.getSessionObject(vb)
+    mach = vb.createMachine(name, kind, base,
+                            "00000000-0000-0000-0000-000000000000")
+    mach.saveSettings()
+    print "created machine with UUID",mach.id
+    vb.registerMachine(mach)
+
+def removeVm(ctx,mach):
+    mgr = ctx['mgr']
+    vb = ctx['vb']
+    print "removing machine ",mach.name,"with UUID",mach.id
+    mach = vb.unregisterMachine(mach.id)
+    if mach:
+         mach.deleteSettings()
+
+def startVm(ctx,mach,type):
+    mgr = ctx['mgr']
+    vb = ctx['vb']
+    perf = ctx['perf']
     session = mgr.getSessionObject(vb)
     uuid = mach.id
@@ -152 +173 @@
     completed = progress.completed
     rc = progress.resultCode
-    print "Completed:", completed, "rc:",rc
+    print "Completed:", completed, "rc:",hex(rc&0xffffffff)
     if int(rc) == 0:
         # we ignore exceptions to allow starting VM even if
@@ -163 +184 @@
                 traceback.print_exc()
             pass
-    session.close()
+         # if session not opened, close doesn't make sense
+        session.close()
+    else:
+        # Not yet implemented error string query API for remote API
+        if not ctx['remote']:
+            print session.QueryErrorObject(rc)
 
 def getMachines(ctx):
@@ -282 +308 @@
     else:
         type = "gui"
-    startVm(ctx['mgr'], ctx['vb'], mach, type, ctx['perf'])
+    startVm(ctx, mach, type)
+    return 0
+
+def createCmd(ctx, args):
+    if (len(args) < 3 or len(args) > 4):
+        print "usage: create name ostype <basefolder>"
+        return 0
+    name = args[1]
+    oskind = args[2]
+    if len(args) == 4:
+        base = args[3]
+    else:
+        base = ''
+    try:
+         ctx['vb'].getGuestOSType(oskind)
+    except Exception, e:
+        print 'Unknown OS type:',oskind
+        return 0
+    createVm(ctx, name, oskind, base)
+    return 0
+
+def removeCmd(ctx, args):
+    mach = argsToMach(ctx,args)
+    if mach == None:
+        return 0
+    removeVm(ctx, mach)
     return 0
 
@@ -382 +433 @@
 commands = {'help':['Prints help information', helpCmd],
             'start':['Start virtual machine by name or uuid', startCmd],
+            'create':['Create virtual machine', createCmd],
+            'remove':['Remove virtual machine', removeCmd],
             'pause':['Pause virtual machine', pauseCmd],
             'resume':['Resume virtual machine', resumeCmd],

trunk/src/libs/xpcom18a4/python/src/ErrorUtils.cpp

@@ -51 +51 @@
 #ifdef VBOX
 #include <nsIExceptionService.h>
+#include <iprt/err.h>
 #endif
 #include "nspr.h" // PR_fprintf
@@ -210 +211 @@
         // state when called back from the C code is clear.  Only Python 2.4
         // and later allows an explicit exc_info tuple().
-        
+
         // Don't use VLogF here, instead arrange for exception info and
         // traceback to be in the same buffer.
@@ -243 +244 @@
 #endif
 
+#ifdef VBOX
+PyObject *PyXPCOM_BuildErrorMessage(nsresult r)
+{
+    char msg[512];
+    bool gotMsg = false;
+
+    const RTCOMERRMSG* pMsg = RTErrCOMGet(r);
+    if (strncmp(pMsg->pszMsgFull, "Unknown", 7) != 0)
+    {
+        gotMsg = true;
+        PR_snprintf(msg, sizeof(msg), "%s (%s)", 
+                    pMsg->pszMsgFull, pMsg->pszDefine);
+        gotMsg = true;
+    }
+
+    nsresult rc;
+    nsCOMPtr <nsIExceptionService> es;
+    es = do_GetService (NS_EXCEPTIONSERVICE_CONTRACTID, &rc);
+    if (!gotMsg && NS_SUCCEEDED (rc))
+    {
+        nsCOMPtr <nsIExceptionManager> em;
+        rc = es->GetCurrentExceptionManager (getter_AddRefs (em));
+        if (NS_SUCCEEDED (rc))
+        {
+            nsCOMPtr <nsIException> ex;
+            rc = em->GetExceptionFromProvider(r, NULL, getter_AddRefs (ex));
+            if  (NS_SUCCEEDED (rc) && ex)
+            {
+                nsXPIDLCString emsg;
+                ex->GetMessage(getter_Copies(emsg));
+                PR_snprintf(msg, sizeof(msg), "%s",
+                            emsg.get());
+                gotMsg = true;
+            }
+        }
+    }
+
+    if (!gotMsg)
+    {
+        PR_snprintf(msg, sizeof(msg), "Error %d in module %d",
+                    NS_ERROR_GET_CODE(r), NS_ERROR_GET_MODULE(r));
+    }
+    PyObject *evalue = Py_BuildValue("is", r, msg);
+    return evalue;
+}
+#endif
 
 PyObject *PyXPCOM_BuildPyException(nsresult r)
 {
-#ifndef VBOX 
+#ifndef VBOX
         // Need the message etc.
         PyObject *evalue = Py_BuildValue("i", r);
+#else
+        PyObject *evalue = PyXPCOM_BuildErrorMessage(r);
+#endif
         PyErr_SetObject(PyXPCOM_Error, evalue);
         Py_XDECREF(evalue);
         return NULL;
-#else
-        char msg[256];
-        
-        nsresult rc;
-        nsCOMPtr <nsIExceptionService> es;
-        es = do_GetService (NS_EXCEPTIONSERVICE_CONTRACTID, &rc);
-        bool gotMsg = false;
-        if (NS_SUCCEEDED (rc))
-        {
-            nsCOMPtr <nsIExceptionManager> em;
-            rc = es->GetCurrentExceptionManager (getter_AddRefs (em));
-            if (NS_SUCCEEDED (rc))
-            {
-                nsCOMPtr <nsIException> ex;
-                rc = em->GetExceptionFromProvider(r, NULL, getter_AddRefs (ex));
-                if  (NS_SUCCEEDED (rc) && ex)
-                {       
-                    nsXPIDLCString emsg;
-                    ex->GetMessage(getter_Copies(emsg));
-                    PR_snprintf(msg, sizeof(msg), "%s",
-                                emsg.get());
-                    gotMsg = true;
-                }
-            }
-        }
-
-        if (!gotMsg)
-        {
-            PR_snprintf(msg, sizeof(msg), "Error %d in module %d", 
-                        NS_ERROR_GET_CODE(r), NS_ERROR_GET_MODULE(r));
-        }
-        PyObject *evalue = Py_BuildValue("is", r, msg);
-        PyErr_SetObject(PyXPCOM_Error, evalue);
-        Py_XDECREF(evalue);
-        return NULL;
-#endif
 }
 
@@ -348 +362 @@
                 TRACEBACK_FETCH_ERROR("cant find traceback.print_tb\n");
 
-        argsTB = Py_BuildValue("OOO", 
+        argsTB = Py_BuildValue("OOO",
                         exc_tb  ? exc_tb  : Py_None,
-                        Py_None, 
+                        Py_None,
                         obStringIO);
-        if (argsTB==NULL) 
+        if (argsTB==NULL)
                 TRACEBACK_FETCH_ERROR("cant make print_tb arguments\n");
 
         obResult = PyObject_CallObject(obFuncTB, argsTB);
-        if (obResult==NULL) 
+        if (obResult==NULL)
                 TRACEBACK_FETCH_ERROR("traceback.print_tb() failed\n");
         /* Now call the getvalue() method in the StringIO instance */
@@ -365 +379 @@
         Py_DECREF(obResult);
         obResult = PyObject_CallObject(obFuncStringIO, NULL);
-        if (obResult==NULL) 
+        if (obResult==NULL)
                 TRACEBACK_FETCH_ERROR("getvalue() failed.\n");
 

trunk/src/libs/xpcom18a4/python/src/PyISupports.cpp

@@ -53 +53 @@
 
 PyObject *PyObject_FromNSInterface( nsISupports *aInterface,
-                                    const nsIID &iid, 
+                                    const nsIID &iid,
                                     PRBool bMakeNicePyObject /*= PR_TRUE */)
 {
@@ -60 +60 @@
 }
 
-PRInt32 
+PRInt32
 _PyXPCOM_GetInterfaceCount(void)
 {
@@ -79 +79 @@
 Py_nsISupports::~Py_nsISupports()
 {
-        SafeRelease(this);      
+        SafeRelease(this);
         PR_AtomicDecrement(&cInterfaces);
         PyXPCOM_DLLRelease();
@@ -130 +130 @@
                 if (NS_SUCCEEDED(rv))
                         rv = ss->ToString(&val);
-                } // end-scope 
+                } // end-scope
                 Py_END_ALLOW_THREADS;
                 PyObject *ret = NS_FAILED(rv) ?
@@ -154 +154 @@
 Py_nsISupports::Constructor(nsISupports *pInitObj, const nsIID &iid)
 {
-        return new Py_nsISupports(pInitObj, 
-                                       iid, 
+        return new Py_nsISupports(pInitObj,
+                                       iid,
                                        type);
 }
 
 PRBool
-Py_nsISupports::InterfaceFromPyISupports(PyObject *ob, 
-                                         const nsIID &iid, 
+Py_nsISupports::InterfaceFromPyISupports(PyObject *ob,
+                                         const nsIID &iid,
                                          nsISupports **ppv)
 {
@@ -178 +178 @@
         if (iid.Equals(Py_nsIID_NULL)) {
                 // a bit of a hack - we are asking for the arbitary interface
-                // wrapped by this object, not some other specific interface - 
+                // wrapped by this object, not some other specific interface -
                 // so no QI, just an AddRef();
                 Py_BEGIN_ALLOW_THREADS
@@ -209 +209 @@
 
 PRBool
-Py_nsISupports::InterfaceFromPyObject(PyObject *ob, 
-                                           const nsIID &iid, 
-                                           nsISupports **ppv, 
+Py_nsISupports::InterfaceFromPyObject(PyObject *ob,
+                                           const nsIID &iid,
+                                           nsISupports **ppv,
                                            PRBool bNoneOK,
                                            PRBool bTryAutoWrap /* = PR_TRUE */)
@@ -300 +300 @@
 
 /*static */PyObject *
-Py_nsISupports::PyObjectFromInterface(nsISupports *pis, 
-                                      const nsIID &riid, 
+Py_nsISupports::PyObjectFromInterface(nsISupports *pis,
+                                      const nsIID &riid,
                                       PRBool bMakeNicePyObject, /* = PR_TRUE */
                                       PRBool bIsInternalCall /* = PR_FALSE */)
@@ -359 +359 @@
 // the object to actually pass to Python.
 PyObject *
-Py_nsISupports::MakeDefaultWrapper(PyObject *pyis, 
+Py_nsISupports::MakeDefaultWrapper(PyObject *pyis,
                              const nsIID &iid)
 {
@@ -374 +374 @@
         if (g_obFuncMakeInterfaceCount==NULL) {
                 PyObject *mod = PyImport_ImportModule("xpcom.client");
-                if (mod) 
+                if (mod)
                         g_obFuncMakeInterfaceCount = PyObject_GetAttrString(mod, "MakeInterfaceResult");
                 Py_XDECREF(mod);
@@ -393 +393 @@
         Py_XDECREF(obIID);
         if (ret==NULL) // eek - error - return the original with no refcount mod.
-                ret = pyis; 
+                ret = pyis;
         else
                 // no error - decref the old object
@@ -442 +442 @@
 
 
+#ifdef VBOX
+static PyObject *
+QueryErrorObject(PyObject *self, PyObject *args)
+{
+        nsresult rc = 0;
+
+        if (!PyArg_ParseTuple(args, "i", &rc))
+                return NULL;
+
+        return PyXPCOM_BuildErrorMessage(rc);
+}
+#endif
+
 // @object Py_nsISupports|The base object for all PythonCOM objects.  Wraps a COM nsISupports interface.
-/*static*/ struct PyMethodDef 
+/*static*/ struct PyMethodDef
 Py_nsISupports::methods[] =
 {
         { "queryInterface", Py_nsISupports::QueryInterface, 1, "Queries the object for an interface."},
         { "QueryInterface", Py_nsISupports::QueryInterface, 1, "An alias for queryInterface."},
+#ifdef VBOX
+        { "QueryErrorObject", QueryErrorObject, 1, "Query an error object for given status code."},
+#endif
         {NULL}
 };

trunk/src/libs/xpcom18a4/python/src/PyXPCOM.h

@@ -153 +153 @@
 PYXPCOM_EXPORT PyObject *PyXPCOM_BuildPyException(nsresult res);
 
+#ifdef VBOX
+// Build human readable error message out of XPCOM error
+PYXPCOM_EXPORT PyObject *PyXPCOM_BuildErrorMessage(nsresult r);
+#endif
+
 // Used in gateways to handle the current Python exception
 // NOTE: this function assumes it is operating within the Python context