vboxweb.cpp revision 22d7a125fcbe8650770ac700108b6f27ca1f0dfd
03831d35f7499c87d51205817c93e9a8d42c4baestevel/**
03831d35f7499c87d51205817c93e9a8d42c4baestevel * vboxweb.cpp:
03831d35f7499c87d51205817c93e9a8d42c4baestevel * hand-coded parts of the webservice server. This is linked with the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * generated code in out/.../src/VBox/Main/webservice/methodmaps.cpp
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * (plus static gSOAP server code) to implement the actual webservice
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * server, to which clients can connect.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Copyright (C) 2006-2010 Sun Microsystems, Inc.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * This file is part of VirtualBox Open Source Edition (OSE), as
03831d35f7499c87d51205817c93e9a8d42c4baestevel * available from http://www.virtualbox.org. This file is free software;
03831d35f7499c87d51205817c93e9a8d42c4baestevel * you can redistribute it and/or modify it under the terms of the GNU
03831d35f7499c87d51205817c93e9a8d42c4baestevel * General Public License (GPL) as published by the Free Software
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Foundation, in version 2 as it comes in the "COPYING" file of the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Clara, CA 95054 USA or visit http://www.sun.com if you need
03831d35f7499c87d51205817c93e9a8d42c4baestevel * additional information or have any questions.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
03831d35f7499c87d51205817c93e9a8d42c4baestevel// shared webservice header
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include "vboxweb.h"
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel// vbox headers
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <VBox/com/com.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <VBox/com/ErrorInfo.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <VBox/com/errorprint.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <VBox/com/EventQueue.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <VBox/VRDPAuth.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <VBox/version.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/cpp/lock.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/rand.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/initterm.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/getopt.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/ctype.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/process.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/string.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/ldr.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel// workaround for compile problems on gcc 4.1
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifdef __GNUC__
03831d35f7499c87d51205817c93e9a8d42c4baestevel#pragma GCC visibility push(default)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki#endif
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
03831d35f7499c87d51205817c93e9a8d42c4baestevel// gSOAP headers (must come after vbox includes because it checks for conflicting defs)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include "soapH.h"
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel// standard headers
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <map>
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifdef __GNUC__
03831d35f7499c87d51205817c93e9a8d42c4baestevel#pragma GCC visibility pop
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki// include generated namespaces table
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki#include "vboxwebsrv.nsmap"
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/****************************************************************************
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * private typedefs
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ****************************************************************************/
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkitypedef std::map<uint64_t, ManagedObjectRef*>
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectsMapById;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkitypedef std::map<uint64_t, ManagedObjectRef*>::iterator
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectsIteratorById;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkitypedef std::map<uintptr_t, ManagedObjectRef*>
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectsMapByPtr;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkitypedef std::map<uint64_t, WebServiceSession*>
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki SessionsMap;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkitypedef std::map<uint64_t, WebServiceSession*>::iterator
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki SessionsMapIterator;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiint fntWatchdog(RTTHREAD ThreadSelf, void *pvUser);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/****************************************************************************
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Read-only global variables
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ****************************************************************************/
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiComPtr<IVirtualBox> g_pVirtualBox = NULL;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki// generated strings in methodmaps.cpp
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiextern const char *g_pcszISession,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *g_pcszIVirtualBox;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki// globals for vboxweb command-line arguments
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki#define DEFAULT_TIMEOUT_SECS 300
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki#define DEFAULT_TIMEOUT_SECS_STRING "300"
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiint g_iWatchdogTimeoutSecs = DEFAULT_TIMEOUT_SECS;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiint g_iWatchdogCheckInterval = 5;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiconst char *g_pcszBindToHost = NULL; // host; NULL = current machine
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiunsigned int g_uBindToPort = 18083; // port
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiunsigned int g_uBacklog = 100; // backlog = max queue size for requests
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkibool g_fVerbose = false; // be verbose
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiPRTSTREAM g_pstrLog = NULL;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki#if defined(RT_OS_DARWIN) || defined(RT_OS_LINUX) || defined (RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkibool g_fDaemonize = false; // run in background.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki#endif
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/****************************************************************************
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Writeable global variables
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel ****************************************************************************/
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiRTLockMtx g_mutexAuthLib;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel// this mutex protects all of the below
03831d35f7499c87d51205817c93e9a8d42c4baestevelRTLockMtx g_mutexSessions;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiSessionsMap g_mapSessions;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiULONG64 g_iMaxManagedObjectID = 0;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiULONG64 g_cManagedObjects = 0;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/****************************************************************************
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * main
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel ****************************************************************************/
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevelstatic const RTGETOPTDEF g_aOptions[]
03831d35f7499c87d51205817c93e9a8d42c4baestevel = {
03831d35f7499c87d51205817c93e9a8d42c4baestevel { "--help", 'h', RTGETOPT_REQ_NOTHING },
03831d35f7499c87d51205817c93e9a8d42c4baestevel#if defined(RT_OS_DARWIN) || defined(RT_OS_LINUX) || defined (RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
03831d35f7499c87d51205817c93e9a8d42c4baestevel { "--background", 'b', RTGETOPT_REQ_NOTHING },
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel { "--host", 'H', RTGETOPT_REQ_STRING },
03831d35f7499c87d51205817c93e9a8d42c4baestevel { "--port", 'p', RTGETOPT_REQ_UINT32 },
03831d35f7499c87d51205817c93e9a8d42c4baestevel { "--timeout", 't', RTGETOPT_REQ_UINT32 },
03831d35f7499c87d51205817c93e9a8d42c4baestevel { "--check-interval", 'i', RTGETOPT_REQ_UINT32 },
03831d35f7499c87d51205817c93e9a8d42c4baestevel { "--verbose", 'v', RTGETOPT_REQ_NOTHING },
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki { "--logfile", 'F', RTGETOPT_REQ_STRING },
a90d965d832a5578dbfc2eadd1617e8cccf25264fw };
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
03831d35f7499c87d51205817c93e9a8d42c4baestevelvoid DisplayHelp()
03831d35f7499c87d51205817c93e9a8d42c4baestevel{
03831d35f7499c87d51205817c93e9a8d42c4baestevel RTStrmPrintf(g_pStdErr, "\nUsage: vboxwebsrv [options]\n\nSupported options (default values in brackets):\n");
03831d35f7499c87d51205817c93e9a8d42c4baestevel for (unsigned i = 0;
03831d35f7499c87d51205817c93e9a8d42c4baestevel i < RT_ELEMENTS(g_aOptions);
03831d35f7499c87d51205817c93e9a8d42c4baestevel ++i)
a90d965d832a5578dbfc2eadd1617e8cccf25264fw {
03831d35f7499c87d51205817c93e9a8d42c4baestevel std::string str(g_aOptions[i].pszLong);
03831d35f7499c87d51205817c93e9a8d42c4baestevel str += ", -";
03831d35f7499c87d51205817c93e9a8d42c4baestevel str += g_aOptions[i].iShort;
03831d35f7499c87d51205817c93e9a8d42c4baestevel str += ":";
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel const char *pcszDescr = "";
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel switch (g_aOptions[i].iShort)
03831d35f7499c87d51205817c93e9a8d42c4baestevel {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 'h':
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki pcszDescr = "Print this help message and exit.";
03831d35f7499c87d51205817c93e9a8d42c4baestevel break;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#if defined(RT_OS_DARWIN) || defined(RT_OS_LINUX) || defined (RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 'b':
03831d35f7499c87d51205817c93e9a8d42c4baestevel pcszDescr = "Run in background (daemon mode).";
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki#endif
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
a90d965d832a5578dbfc2eadd1617e8cccf25264fw case 'H':
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki pcszDescr = "The host to bind to (localhost).";
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
a90d965d832a5578dbfc2eadd1617e8cccf25264fw case 'p':
a90d965d832a5578dbfc2eadd1617e8cccf25264fw pcszDescr = "The port to bind to (18083).";
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 't':
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki pcszDescr = "Session timeout in seconds; 0 = disable timeouts (" DEFAULT_TIMEOUT_SECS_STRING ").";
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 'i':
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki pcszDescr = "Frequency of timeout checks in seconds (5).";
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 'v':
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki pcszDescr = "Be verbose.";
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
4c5e0fde93352f23abc94e445999402e38b91268vivek
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 'F':
a90d965d832a5578dbfc2eadd1617e8cccf25264fw pcszDescr = "Name of file to write log to (no file).";
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw }
4c5e0fde93352f23abc94e445999402e38b91268vivek
a90d965d832a5578dbfc2eadd1617e8cccf25264fw RTStrmPrintf(g_pStdErr, "%-23s%s\n", str.c_str(), pcszDescr);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Implementation for WEBLOG macro defined in vboxweb.h; this prints a message
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * to the console and optionally to the file that may have been given to the
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * vboxwebsrv command line.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param pszFormat
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkivoid WebLog(const char *pszFormat, ...)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
a90d965d832a5578dbfc2eadd1617e8cccf25264fw va_list args;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki va_start(args, pszFormat);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki char *psz = NULL;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTStrAPrintfV(&psz, pszFormat, args);
4c5e0fde93352f23abc94e445999402e38b91268vivek va_end(args);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // terminal
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTPrintf("%s", psz);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // log file
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (g_pstrLog)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTStrmPrintf(g_pstrLog, "%s", psz);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTStrmFlush(g_pstrLog);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // logger instance
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTLogLoggerEx(LOG_INSTANCE, RTLOGGRPFLAGS_DJ, LOG_GROUP, "%s", psz);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTStrFree(psz);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Helper for printing SOAP error messages.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param soap
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
a90d965d832a5578dbfc2eadd1617e8cccf25264fwvoid WebLogSoapError(struct soap *soap)
a90d965d832a5578dbfc2eadd1617e8cccf25264fw{
a90d965d832a5578dbfc2eadd1617e8cccf25264fw if (soap_check_state(soap))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WebLog("Error: soap struct not initialized\n");
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki const char *pcszFaultString = *soap_faultstring(soap);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki const char **ppcszDetail = soap_faultcode(soap);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WebLog("#### SOAP FAULT: %s [%s]\n",
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki pcszFaultString ? pcszFaultString : "[no fault string available]",
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki (ppcszDetail && *ppcszDetail) ? *ppcszDetail : "no details available");
a90d965d832a5578dbfc2eadd1617e8cccf25264fw}
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Start up the webservice server. This keeps running and waits
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * for incoming SOAP connections; for each request that comes in,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * it calls method implementation code, most of it in the generated
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * code in methodmaps.cpp.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @param argc
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param argv[]
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @return
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiint main(int argc, char* argv[])
a90d965d832a5578dbfc2eadd1617e8cccf25264fw{
a90d965d832a5578dbfc2eadd1617e8cccf25264fw int rc;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // intialize runtime
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTR3Init();
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel RTStrmPrintf(g_pStdErr, VBOX_PRODUCT " Webservice Version " VBOX_VERSION_STRING "\n"
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki "(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki "All rights reserved.\n");
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki int c;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTGETOPTUNION ValueUnion;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTGETOPTSTATE GetState;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTGetOptInit(&GetState, argc, argv, g_aOptions, RT_ELEMENTS(g_aOptions), 1, 0 /* fFlags */);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki while ((c = RTGetOpt(&GetState, &ValueUnion)))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki switch (c)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw case 'H':
a90d965d832a5578dbfc2eadd1617e8cccf25264fw g_pcszBindToHost = ValueUnion.psz;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 'p':
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki g_uBindToPort = ValueUnion.u32;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 't':
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki g_iWatchdogTimeoutSecs = ValueUnion.u32;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 'i':
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki g_iWatchdogCheckInterval = ValueUnion.u32;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw break;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 'F':
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
4c5e0fde93352f23abc94e445999402e38b91268vivek int rc2 = RTStrmOpen(ValueUnion.psz, "a", &g_pstrLog);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw if (rc2)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTPrintf("Error: Cannot open log file \"%s\" for writing, error %d.\n", ValueUnion.psz, rc2);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki exit(2);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WebLog("Sun VirtualBox Webservice Version %s\n"
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki "Opened log file \"%s\"\n", VBOX_VERSION_STRING, ValueUnion.psz);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 'h':
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki DisplayHelp();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki exit(0);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 'v':
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki g_fVerbose = true;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki#if defined(RT_OS_DARWIN) || defined(RT_OS_LINUX) || defined (RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case 'b':
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki g_fDaemonize = true;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki#endif
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki case VINF_GETOPT_NOT_OPTION:
a90d965d832a5578dbfc2eadd1617e8cccf25264fw RTStrmPrintf(g_pStdErr, "unhandled parameter: %s\n", ValueUnion.psz);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return 1;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki default:
a90d965d832a5578dbfc2eadd1617e8cccf25264fw if (c > 0)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (RT_C_IS_GRAPH(c))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTStrmPrintf(g_pStdErr, "unhandled option: -%c", c);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki else
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTStrmPrintf(g_pStdErr, "unhandled option: %i", c);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki else if (c == VERR_GETOPT_UNKNOWN_OPTION)
a90d965d832a5578dbfc2eadd1617e8cccf25264fw RTStrmPrintf(g_pStdErr, "unknown option: %s", ValueUnion.psz);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw else if (ValueUnion.pDef)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTStrmPrintf(g_pStdErr, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki else
a90d965d832a5578dbfc2eadd1617e8cccf25264fw RTStrmPrintf(g_pStdErr, "%Rrs", c);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki exit(1);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw break;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
a90d965d832a5578dbfc2eadd1617e8cccf25264fw#if defined(RT_OS_DARWIN) || defined(RT_OS_LINUX) || defined (RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (g_fDaemonize)
a90d965d832a5578dbfc2eadd1617e8cccf25264fw {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw rc = RTProcDaemonize(false /* fNoChDir */, false /* fNoClose */,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki NULL);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (RT_FAILURE(rc))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTStrmPrintf(g_pStdErr, "vboxwebsrv: failed to daemonize, rc=%Rrc. exiting.\n", rc);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki exit(1);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki#endif
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // intialize COM/XPCOM
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki rc = com::Initialize();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (FAILED(rc))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTPrintf("ERROR: failed to initialize COM!\n");
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return rc;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
4c5e0fde93352f23abc94e445999402e38b91268vivek ComPtr<ISession> session;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki rc = g_pVirtualBox.createLocalObject(CLSID_VirtualBox);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (FAILED(rc))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTPrintf("ERROR: failed to create the VirtualBox object!\n");
a90d965d832a5578dbfc2eadd1617e8cccf25264fw else
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
4c5e0fde93352f23abc94e445999402e38b91268vivek rc = session.createInprocObject(CLSID_Session);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (FAILED(rc))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTPrintf("ERROR: failed to create a session object!\n");
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (FAILED(rc))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw com::ErrorInfo info;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw if (!info.isFullAvailable() && !info.isBasicAvailable())
a90d965d832a5578dbfc2eadd1617e8cccf25264fw {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki com::GluePrintRCMessage(rc);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTPrintf("Most likely, the VirtualBox COM server is not running or failed to start.\n");
a90d965d832a5578dbfc2eadd1617e8cccf25264fw }
a90d965d832a5578dbfc2eadd1617e8cccf25264fw else
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki com::GluePrintErrorInfo(info);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return rc;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (g_iWatchdogTimeoutSecs > 0)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw // start our watchdog thread
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTTHREAD tWatchdog;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (RTThreadCreate(&tWatchdog,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki fntWatchdog,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki NULL,
a90d965d832a5578dbfc2eadd1617e8cccf25264fw 32*1024,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTTHREADTYPE_MAIN_WORKER,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki 0,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki "Watchdog"))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTStrmPrintf(g_pStdErr, "[!] Cannot start watchdog thread\n");
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki exit(1);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
a90d965d832a5578dbfc2eadd1617e8cccf25264fw }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // set up gSOAP
4c5e0fde93352f23abc94e445999402e38b91268vivek struct soap soap;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw soap_init(&soap);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki soap.bind_flags |= SO_REUSEADDR;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // avoid EADDRINUSE on bind()
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki int m, s; // master and slave sockets
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki m = soap_bind(&soap,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki g_pcszBindToHost, // host: current machine
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki g_uBindToPort, // port
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki g_uBacklog); // backlog = max queue size for requests
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (m < 0)
a90d965d832a5578dbfc2eadd1617e8cccf25264fw WebLogSoapError(&soap);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki else
4c5e0fde93352f23abc94e445999402e38b91268vivek {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WebLog("Socket connection successful: host = %s, port = %u, master socket = %d\n",
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki (g_pcszBindToHost) ? g_pcszBindToHost : "default (localhost)",
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki g_uBindToPort,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki m);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki for (uint64_t i = 1;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki i++)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // call gSOAP to handle incoming SOAP connection
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki s = soap_accept(&soap);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (s < 0)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WebLogSoapError(&soap);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WebLog("%llu: accepted connection from IP=%lu.%lu.%lu.%lu socket=%d... ",
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki i,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki (soap.ip>>24)&0xFF,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki (soap.ip>>16)&0xFF,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki (soap.ip>>8)&0xFF,
a90d965d832a5578dbfc2eadd1617e8cccf25264fw soap.ip&0xFF,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki s);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
03831d35f7499c87d51205817c93e9a8d42c4baestevel // enclose the entire RPC call in the sessions lock
03831d35f7499c87d51205817c93e9a8d42c4baestevel // so that the watchdog cannot destroy COM objects
03831d35f7499c87d51205817c93e9a8d42c4baestevel // while the RPC is ongoing
03831d35f7499c87d51205817c93e9a8d42c4baestevel RTLock lock(g_mutexSessions);
03831d35f7499c87d51205817c93e9a8d42c4baestevel // now process the RPC request (this goes into the
03831d35f7499c87d51205817c93e9a8d42c4baestevel // generated code in methodmaps.cpp with all the COM calls)
03831d35f7499c87d51205817c93e9a8d42c4baestevel if (soap_serve(&soap) != SOAP_OK)
03831d35f7499c87d51205817c93e9a8d42c4baestevel {
03831d35f7499c87d51205817c93e9a8d42c4baestevel WebLogSoapError(&soap);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki lock.release();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WebLog("Request served\n");
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki soap_destroy(&soap); // clean up class instances
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki soap_end(&soap); // clean up everything and close socket
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // we have to process main event queue
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki int vrc = com::EventQueue::getMainEventQueue()->processEventQueue(0);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki soap_done(&soap); // close master socket and detach environment
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki com::Shutdown();
a90d965d832a5578dbfc2eadd1617e8cccf25264fw}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/****************************************************************************
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Watchdog thread
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ****************************************************************************/
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * Watchdog thread, runs in the background while the webservice is alive.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * This gets started by main() and runs in the background to check all sessions
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * for whether they have been no requests in a configurable timeout period. In
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * that case, the session is automatically logged off.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiint fntWatchdog(RTTHREAD ThreadSelf, void *pvUser)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("Watchdog thread started\n"));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki while (1)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("Watchdog: sleeping %d seconds\n", g_iWatchdogCheckInterval));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTThreadSleep(g_iWatchdogCheckInterval * 1000);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki time_t tNow;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki time(&tNow);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTLock lock(g_mutexSessions);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("Watchdog: checking %d sessions\n", g_mapSessions.size()));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki SessionsMap::iterator
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki it = g_mapSessions.begin(),
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki itEnd = g_mapSessions.end();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki while (it != itEnd)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WebServiceSession *pSession = it->second;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("Watchdog: tNow: %d, session timestamp: %d\n", tNow, pSession->getLastObjectLookup()));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if ( tNow
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki > pSession->getLastObjectLookup() + g_iWatchdogTimeoutSecs
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki )
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("Watchdog: Session %llX timed out, deleting\n", pSession->getID()));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki delete pSession;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki it = g_mapSessions.begin();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki else
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ++it;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki lock.release();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("Watchdog thread ending\n"));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return 0;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/****************************************************************************
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * SOAP exceptions
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ****************************************************************************/
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Helper function to raise a SOAP fault. Called by the other helper
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * functions, which raise specific SOAP faults.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param soap
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param str
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param extype
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param ex
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkivoid RaiseSoapFault(struct soap *soap,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki const char *pcsz,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki int extype,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki void *ex)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // raise the fault
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki soap_sender_fault(soap, pcsz, NULL);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki struct SOAP_ENV__Detail *pDetail = (struct SOAP_ENV__Detail*)soap_malloc(soap, sizeof(struct SOAP_ENV__Detail));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // without the following, gSOAP crashes miserably when sending out the
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // data because it will try to serialize all fields (stupid documentation)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki memset(pDetail, 0, sizeof(struct SOAP_ENV__Detail));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // fill extended info depending on SOAP version
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (soap->version == 2) // SOAP 1.2 is used
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw soap->fault->SOAP_ENV__Detail = pDetail;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki soap->fault->SOAP_ENV__Detail->__type = extype;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki soap->fault->SOAP_ENV__Detail->fault = ex;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw soap->fault->SOAP_ENV__Detail->__any = NULL; // no other XML data
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki else
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw soap->fault->detail = pDetail;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki soap->fault->detail->__type = extype;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki soap->fault->detail->fault = ex;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw soap->fault->detail->__any = NULL; // no other XML data
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
a90d965d832a5578dbfc2eadd1617e8cccf25264fw/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Raises a SOAP fault that signals that an invalid object was passed.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @param soap
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param obj
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkivoid RaiseSoapInvalidObjectFault(struct soap *soap,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WSDLT_ID obj)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
a90d965d832a5578dbfc2eadd1617e8cccf25264fw _vbox__InvalidObjectFault *ex = soap_new__vbox__InvalidObjectFault(soap, 1);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw ex->badObjectID = obj;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki std::string str("VirtualBox error: ");
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki str += "Invalid managed object reference \"" + obj + "\"";
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RaiseSoapFault(soap,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki str.c_str(),
a90d965d832a5578dbfc2eadd1617e8cccf25264fw SOAP_TYPE__vbox__InvalidObjectFault,
a90d965d832a5578dbfc2eadd1617e8cccf25264fw ex);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw}
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
a90d965d832a5578dbfc2eadd1617e8cccf25264fw/**
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * Return a safe C++ string from the given COM string,
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * without crashing if the COM string is empty.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @param bstr
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @return
a90d965d832a5578dbfc2eadd1617e8cccf25264fw */
a90d965d832a5578dbfc2eadd1617e8cccf25264fwstd::string ConvertComString(const com::Bstr &bstr)
a90d965d832a5578dbfc2eadd1617e8cccf25264fw{
a90d965d832a5578dbfc2eadd1617e8cccf25264fw com::Utf8Str ustr(bstr);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw const char *pcsz;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw if ((pcsz = ustr.raw()))
a90d965d832a5578dbfc2eadd1617e8cccf25264fw return pcsz;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw return "";
a90d965d832a5578dbfc2eadd1617e8cccf25264fw}
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
a90d965d832a5578dbfc2eadd1617e8cccf25264fw/**
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * Return a safe C++ string from the given COM UUID,
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * without crashing if the UUID is empty.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @param bstr
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @return
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkistd::string ConvertComString(const com::Guid &uuid)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki com::Bstr bstr(uuid);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki com::Utf8Str ustr(bstr);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki const char *pcsz;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if ((pcsz = ustr.raw()))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return pcsz;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return "";
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Raises a SOAP runtime fault.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param pObj
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkivoid RaiseSoapRuntimeFault(struct soap *soap,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki HRESULT apirc,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki IUnknown *pObj)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki com::ErrorInfo info(pObj);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG((" error, raising SOAP exception\n"));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTStrmPrintf(g_pStdErr, "API return code: 0x%08X (%Rhrc)\n", apirc, apirc);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw RTStrmPrintf(g_pStdErr, "COM error info result code: 0x%lX\n", info.getResultCode());
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTStrmPrintf(g_pStdErr, "COM error info text: %ls\n", info.getText().raw());
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // allocated our own soap fault struct
a90d965d832a5578dbfc2eadd1617e8cccf25264fw _vbox__RuntimeFault *ex = soap_new__vbox__RuntimeFault(soap, 1);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw ex->resultCode = info.getResultCode();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ex->text = ConvertComString(info.getText());
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ex->component = ConvertComString(info.getComponent());
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ex->interfaceID = ConvertComString(info.getInterfaceID());
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
a90d965d832a5578dbfc2eadd1617e8cccf25264fw // compose descriptive message
a90d965d832a5578dbfc2eadd1617e8cccf25264fw com::Utf8StrFmt str("VirtualBox error: %s (0x%RU32)", ex->text.c_str(), ex->resultCode);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
a90d965d832a5578dbfc2eadd1617e8cccf25264fw RaiseSoapFault(soap,
a90d965d832a5578dbfc2eadd1617e8cccf25264fw str.c_str(),
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki SOAP_TYPE__vbox__RuntimeFault,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ex);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/****************************************************************************
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * splitting and merging of object IDs
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ****************************************************************************/
03831d35f7499c87d51205817c93e9a8d42c4baestevel
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiuint64_t str2ulonglong(const char *pcsz)
03831d35f7499c87d51205817c93e9a8d42c4baestevel{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki uint64_t u = 0;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTStrToUInt64Full(pcsz, 16, &u);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw return u;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Splits a managed object reference (in string form, as
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * passed in from a SOAP method call) into two integers for
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * session and object IDs, respectively.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param id
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @param sessid
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @param objid
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @return
a90d965d832a5578dbfc2eadd1617e8cccf25264fw */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkibool SplitManagedObjectRef(const WSDLT_ID &id,
a90d965d832a5578dbfc2eadd1617e8cccf25264fw uint64_t *pSessid,
a90d965d832a5578dbfc2eadd1617e8cccf25264fw uint64_t *pObjid)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
a90d965d832a5578dbfc2eadd1617e8cccf25264fw // 64-bit numbers in hex have 16 digits; hence
03831d35f7499c87d51205817c93e9a8d42c4baestevel // the object-ref string must have 16 + "-" + 16 characters
03831d35f7499c87d51205817c93e9a8d42c4baestevel std::string str;
03831d35f7499c87d51205817c93e9a8d42c4baestevel if ( (id.length() == 33)
03831d35f7499c87d51205817c93e9a8d42c4baestevel && (id[16] == '-')
03831d35f7499c87d51205817c93e9a8d42c4baestevel )
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
03831d35f7499c87d51205817c93e9a8d42c4baestevel char psz[34];
03831d35f7499c87d51205817c93e9a8d42c4baestevel memcpy(psz, id.c_str(), 34);
03831d35f7499c87d51205817c93e9a8d42c4baestevel psz[16] = '\0';
03831d35f7499c87d51205817c93e9a8d42c4baestevel if (pSessid)
03831d35f7499c87d51205817c93e9a8d42c4baestevel *pSessid = str2ulonglong(psz);
03831d35f7499c87d51205817c93e9a8d42c4baestevel if (pObjid)
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *pObjid = str2ulonglong(psz + 17);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw return true;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw }
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
a90d965d832a5578dbfc2eadd1617e8cccf25264fw return false;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw}
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/**
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Creates a managed object reference (in string form) from
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * two integers representing a session and object ID, respectively.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * @param sz Buffer with at least 34 bytes space to receive MOR string.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @param sessid
03831d35f7499c87d51205817c93e9a8d42c4baestevel * @param objid
03831d35f7499c87d51205817c93e9a8d42c4baestevel * @return
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevelvoid MakeManagedObjectRef(char *sz,
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint64_t &sessid,
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint64_t &objid)
03831d35f7499c87d51205817c93e9a8d42c4baestevel{
03831d35f7499c87d51205817c93e9a8d42c4baestevel RTStrFormatNumber(sz, sessid, 16, 16, 0, RTSTR_F_64BIT | RTSTR_F_ZEROPAD);
03831d35f7499c87d51205817c93e9a8d42c4baestevel sz[16] = '-';
03831d35f7499c87d51205817c93e9a8d42c4baestevel RTStrFormatNumber(sz + 17, objid, 16, 16, 0, RTSTR_F_64BIT | RTSTR_F_ZEROPAD);
03831d35f7499c87d51205817c93e9a8d42c4baestevel}
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/****************************************************************************
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * class WebServiceSession
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
03831d35f7499c87d51205817c93e9a8d42c4baestevel ****************************************************************************/
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiclass WebServiceSessionPrivate
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki public:
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectsMapById _mapManagedObjectsById;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectsMapByPtr _mapManagedObjectsByPtr;
03831d35f7499c87d51205817c93e9a8d42c4baestevel};
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/**
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Constructor for the session object.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Preconditions: Caller must have locked g_mutexSessions.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * @param username
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param password
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
03831d35f7499c87d51205817c93e9a8d42c4baestevelWebServiceSession::WebServiceSession()
03831d35f7499c87d51205817c93e9a8d42c4baestevel : _fDestructing(false),
03831d35f7499c87d51205817c93e9a8d42c4baestevel _pISession(NULL),
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _tLastObjectLookup(0)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
03831d35f7499c87d51205817c93e9a8d42c4baestevel _pp = new WebServiceSessionPrivate;
03831d35f7499c87d51205817c93e9a8d42c4baestevel _uSessionID = RTRandU64();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // register this session globally
03831d35f7499c87d51205817c93e9a8d42c4baestevel g_mapSessions[_uSessionID] = this;
03831d35f7499c87d51205817c93e9a8d42c4baestevel}
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/**
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * Destructor. Cleans up and destroys all contained managed object references on the way.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Preconditions: Caller must have locked g_mutexSessions.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiWebServiceSession::~WebServiceSession()
03831d35f7499c87d51205817c93e9a8d42c4baestevel{
03831d35f7499c87d51205817c93e9a8d42c4baestevel // delete us from global map first so we can't be found
03831d35f7499c87d51205817c93e9a8d42c4baestevel // any more while we're cleaning up
03831d35f7499c87d51205817c93e9a8d42c4baestevel g_mapSessions.erase(_uSessionID);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
03831d35f7499c87d51205817c93e9a8d42c4baestevel // notify ManagedObjectRef destructor so it won't
03831d35f7499c87d51205817c93e9a8d42c4baestevel // remove itself from the maps; this avoids rebalancing
03831d35f7499c87d51205817c93e9a8d42c4baestevel // the map's tree on every delete as well
03831d35f7499c87d51205817c93e9a8d42c4baestevel _fDestructing = true;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
03831d35f7499c87d51205817c93e9a8d42c4baestevel // if (_pISession)
03831d35f7499c87d51205817c93e9a8d42c4baestevel // {
03831d35f7499c87d51205817c93e9a8d42c4baestevel // delete _pISession;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // _pISession = NULL;
03831d35f7499c87d51205817c93e9a8d42c4baestevel // }
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel ManagedObjectsMapById::iterator
a90d965d832a5578dbfc2eadd1617e8cccf25264fw it,
03831d35f7499c87d51205817c93e9a8d42c4baestevel end = _pp->_mapManagedObjectsById.end();
03831d35f7499c87d51205817c93e9a8d42c4baestevel for (it = _pp->_mapManagedObjectsById.begin();
03831d35f7499c87d51205817c93e9a8d42c4baestevel it != end;
03831d35f7499c87d51205817c93e9a8d42c4baestevel ++it)
03831d35f7499c87d51205817c93e9a8d42c4baestevel {
03831d35f7499c87d51205817c93e9a8d42c4baestevel ManagedObjectRef *pRef = it->second;
03831d35f7499c87d51205817c93e9a8d42c4baestevel delete pRef; // this frees the contained ComPtr as well
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel delete _pp;
03831d35f7499c87d51205817c93e9a8d42c4baestevel}
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Authenticate the username and password against an authentification authority.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @return 0 if the user was successfully authenticated, or an error code
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * otherwise.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevelint WebServiceSession::authenticate(const char *pcszUsername,
03831d35f7499c87d51205817c93e9a8d42c4baestevel const char *pcszPassword)
03831d35f7499c87d51205817c93e9a8d42c4baestevel{
03831d35f7499c87d51205817c93e9a8d42c4baestevel int rc = VERR_WEB_NOT_AUTHENTICATED;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
03831d35f7499c87d51205817c93e9a8d42c4baestevel RTLock lock(g_mutexAuthLib);
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel static bool fAuthLibLoaded = false;
03831d35f7499c87d51205817c93e9a8d42c4baestevel static PVRDPAUTHENTRY pfnAuthEntry = NULL;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki static PVRDPAUTHENTRY2 pfnAuthEntry2 = NULL;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel if (!fAuthLibLoaded)
03831d35f7499c87d51205817c93e9a8d42c4baestevel {
03831d35f7499c87d51205817c93e9a8d42c4baestevel // retrieve authentication library from system properties
03831d35f7499c87d51205817c93e9a8d42c4baestevel ComPtr<ISystemProperties> systemProperties;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki g_pVirtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam());
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel com::Bstr authLibrary;
03831d35f7499c87d51205817c93e9a8d42c4baestevel systemProperties->COMGETTER(WebServiceAuthLibrary)(authLibrary.asOutParam());
03831d35f7499c87d51205817c93e9a8d42c4baestevel com::Utf8Str filename = authLibrary;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("external authentication library is '%ls'\n", authLibrary.raw()));
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel if (filename == "null")
03831d35f7499c87d51205817c93e9a8d42c4baestevel // authentication disabled, let everyone in:
a90d965d832a5578dbfc2eadd1617e8cccf25264fw fAuthLibLoaded = true;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki else
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RTLDRMOD hlibAuth = 0;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki do
03831d35f7499c87d51205817c93e9a8d42c4baestevel {
03831d35f7499c87d51205817c93e9a8d42c4baestevel rc = RTLdrLoad(filename.raw(), &hlibAuth);
03831d35f7499c87d51205817c93e9a8d42c4baestevel if (RT_FAILURE(rc))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
03831d35f7499c87d51205817c93e9a8d42c4baestevel WEBDEBUG(("%s() Failed to load external authentication library. Error code: %Rrc\n", __FUNCTION__, rc));
03831d35f7499c87d51205817c93e9a8d42c4baestevel break;
03831d35f7499c87d51205817c93e9a8d42c4baestevel }
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel if (RT_FAILURE(rc = RTLdrGetSymbol(hlibAuth, "VRDPAuth2", (void**)&pfnAuthEntry2)))
03831d35f7499c87d51205817c93e9a8d42c4baestevel WEBDEBUG(("%s(): Could not resolve import '%s'. Error code: %Rrc\n", __FUNCTION__, "VRDPAuth2", rc));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
03831d35f7499c87d51205817c93e9a8d42c4baestevel if (RT_FAILURE(rc = RTLdrGetSymbol(hlibAuth, "VRDPAuth", (void**)&pfnAuthEntry)))
03831d35f7499c87d51205817c93e9a8d42c4baestevel WEBDEBUG(("%s(): Could not resolve import '%s'. Error code: %Rrc\n", __FUNCTION__, "VRDPAuth", rc));
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
03831d35f7499c87d51205817c93e9a8d42c4baestevel if (pfnAuthEntry || pfnAuthEntry2)
03831d35f7499c87d51205817c93e9a8d42c4baestevel fAuthLibLoaded = true;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
03831d35f7499c87d51205817c93e9a8d42c4baestevel } while (0);
03831d35f7499c87d51205817c93e9a8d42c4baestevel }
03831d35f7499c87d51205817c93e9a8d42c4baestevel }
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel rc = VERR_WEB_NOT_AUTHENTICATED;
03831d35f7499c87d51205817c93e9a8d42c4baestevel VRDPAuthResult result;
03831d35f7499c87d51205817c93e9a8d42c4baestevel if (pfnAuthEntry2)
03831d35f7499c87d51205817c93e9a8d42c4baestevel {
03831d35f7499c87d51205817c93e9a8d42c4baestevel result = pfnAuthEntry2(NULL, VRDPAuthGuestNotAsked, pcszUsername, pcszPassword, NULL, true, 0);
03831d35f7499c87d51205817c93e9a8d42c4baestevel WEBDEBUG(("%s(): result of VRDPAuth2(): %d\n", __FUNCTION__, result));
03831d35f7499c87d51205817c93e9a8d42c4baestevel if (result == VRDPAuthAccessGranted)
03831d35f7499c87d51205817c93e9a8d42c4baestevel rc = 0;
03831d35f7499c87d51205817c93e9a8d42c4baestevel }
03831d35f7499c87d51205817c93e9a8d42c4baestevel else if (pfnAuthEntry)
03831d35f7499c87d51205817c93e9a8d42c4baestevel {
03831d35f7499c87d51205817c93e9a8d42c4baestevel result = pfnAuthEntry(NULL, VRDPAuthGuestNotAsked, pcszUsername, pcszPassword, NULL);
03831d35f7499c87d51205817c93e9a8d42c4baestevel WEBDEBUG(("%s(): result of VRDPAuth(%s, [%d]): %d\n", __FUNCTION__, pcszUsername, strlen(pcszPassword), result));
03831d35f7499c87d51205817c93e9a8d42c4baestevel if (result == VRDPAuthAccessGranted)
03831d35f7499c87d51205817c93e9a8d42c4baestevel rc = 0;
03831d35f7499c87d51205817c93e9a8d42c4baestevel }
03831d35f7499c87d51205817c93e9a8d42c4baestevel else if (fAuthLibLoaded)
03831d35f7499c87d51205817c93e9a8d42c4baestevel // fAuthLibLoaded = true but both pointers are NULL:
03831d35f7499c87d51205817c93e9a8d42c4baestevel // then the authlib was "null" and auth was disabled
03831d35f7499c87d51205817c93e9a8d42c4baestevel rc = 0;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki else
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("Could not resolve VRDPAuth2 or VRDPAuth entry point"));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (!rc)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki do
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // now create the ISession object that this webservice session can use
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // (and of which IWebsessionManager::getSessionObject returns a managed object reference)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ComPtr<ISession> session;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (FAILED(rc = session.createInprocObject(CLSID_Session)))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("ERROR: cannot create session object!"));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _pISession = new ManagedObjectRef(*this, g_pcszISession, session);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (g_fVerbose)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ISession *p = session;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki std::string strMOR = _pISession->toWSDL();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG((" * %s: created session object with comptr 0x%lX, MOR = %s\n", __FUNCTION__, p, strMOR.c_str()));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki } while (0);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return rc;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Look up, in this session, whether a ManagedObjectRef has already been
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * created for the given COM pointer.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Note how we require that a ComPtr<IUnknown> is passed, which causes a
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * queryInterface call when the caller passes in a different type, since
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * a ComPtr<IUnknown> will point to something different than a
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * ComPtr<IVirtualBox>, for example. As we store the ComPtr<IUnknown> in
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * our private hash table, we must search for one too.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Preconditions: Caller must have locked g_mutexSessions.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param pcu pointer to a COM object.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @return The existing ManagedObjectRef that represents the COM object, or NULL if there's none yet.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiManagedObjectRef* WebServiceSession::findRefFromPtr(const ComPtr<IUnknown> &pcu)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki IUnknown *p = pcu;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki uintptr_t ulp = (uintptr_t)p;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectRef *pRef;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // WEBDEBUG((" %s: looking up 0x%lX\n", __FUNCTION__, ulp));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectsMapByPtr::iterator it = _pp->_mapManagedObjectsByPtr.find(ulp);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (it != _pp->_mapManagedObjectsByPtr.end())
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki pRef = it->second;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WSDLT_ID id = pRef->toWSDL();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG((" %s: found existing ref %s for COM obj 0x%lX\n", __FUNCTION__, id.c_str(), ulp));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki else
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki pRef = NULL;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return pRef;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Static method which attempts to find the session for which the given managed
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * object reference was created, by splitting the reference into the session and
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * object IDs and then looking up the session object for that session ID.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Preconditions: Caller must have locked g_mutexSessions.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param id Managed object reference (with combined session and object IDs).
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @return
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiWebServiceSession* WebServiceSession::findSessionFromRef(const WSDLT_ID &id)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WebServiceSession *pSession = NULL;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki uint64_t sessid;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw if (SplitManagedObjectRef(id,
a90d965d832a5578dbfc2eadd1617e8cccf25264fw &sessid,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki NULL))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki SessionsMapIterator it = g_mapSessions.find(sessid);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (it != g_mapSessions.end())
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki pSession = it->second;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return pSession;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiWSDLT_ID WebServiceSession::getSessionObject() const
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
a90d965d832a5578dbfc2eadd1617e8cccf25264fw return _pISession->toWSDL();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Touches the webservice session to prevent it from timing out.
4c5e0fde93352f23abc94e445999402e38b91268vivek *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Each webservice session has an internal timestamp that records
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * the last request made to it from the client that started it.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * If no request was made within a configurable timeframe, then
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * the client is logged off automatically,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * by calling IWebsessionManager::logoff()
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkivoid WebServiceSession::touch()
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki time(&_tLastObjectLookup);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
a90d965d832a5578dbfc2eadd1617e8cccf25264fwvoid WebServiceSession::DumpRefs()
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG((" dumping object refs:\n"));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectsIteratorById
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki iter = _pp->_mapManagedObjectsById.begin(),
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki end = _pp->_mapManagedObjectsById.end();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki for (;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki iter != end;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw ++iter)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectRef *pRef = iter->second;
4c5e0fde93352f23abc94e445999402e38b91268vivek uint64_t id = pRef->getID();
4c5e0fde93352f23abc94e445999402e38b91268vivek void *p = pRef->getComPtr();
a90d965d832a5578dbfc2eadd1617e8cccf25264fw WEBDEBUG((" objid %llX: comptr 0x%lX\n", id, p));
4c5e0fde93352f23abc94e445999402e38b91268vivek }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
4c5e0fde93352f23abc94e445999402e38b91268vivek
4c5e0fde93352f23abc94e445999402e38b91268vivek/****************************************************************************
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * class ManagedObjectRef
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ****************************************************************************/
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Constructor, which assigns a unique ID to this managed object
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * reference and stores it two global hashs:
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * a) G_mapManagedObjectsById, which maps ManagedObjectID's to
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * instances of this class; this hash is then used by the
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * findObjectFromRef() template function in vboxweb.h
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * to quickly retrieve the COM object from its managed
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * object ID (mostly in the context of the method mappers
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * in methodmaps.cpp, when a web service client passes in
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * a managed object ID);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * b) G_mapManagedObjectsByComPtr, which maps COM pointers to
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * instances of this class; this hash is used by
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * createRefFromObject() to quickly figure out whether an
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * instance already exists for a given COM pointer.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * This does _not_ check whether another instance already
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * exists in the hash. This gets called only from the
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * createRefFromObject() template function in vboxweb.h, which
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * does perform that check.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Preconditions: Caller must have locked g_mutexSessions.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param pObj
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
a90d965d832a5578dbfc2eadd1617e8cccf25264fwManagedObjectRef::ManagedObjectRef(WebServiceSession &session,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki const char *pcszInterface,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki const ComPtr<IUnknown> &pc)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki : _session(session),
a90d965d832a5578dbfc2eadd1617e8cccf25264fw _pObj(pc),
a90d965d832a5578dbfc2eadd1617e8cccf25264fw _pcszInterface(pcszInterface)
a90d965d832a5578dbfc2eadd1617e8cccf25264fw{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ComPtr<IUnknown> pcUnknown(pc);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _ulp = (uintptr_t)(IUnknown*)pcUnknown;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _id = ++g_iMaxManagedObjectID;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw // and count globally
a90d965d832a5578dbfc2eadd1617e8cccf25264fw ULONG64 cTotal = ++g_cManagedObjects; // raise global count and make a copy for the debug message below
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki char sz[34];
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki MakeManagedObjectRef(sz, session._uSessionID, _id);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _strID = sz;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki session._pp->_mapManagedObjectsById[_id] = this;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki session._pp->_mapManagedObjectsByPtr[_ulp] = this;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki session.touch();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG((" * %s: MOR created for ulp 0x%lX (%s), new ID is %llX; now %lld objects total\n", __FUNCTION__, _ulp, pcszInterface, _id, cTotal));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Destructor; removes the instance from the global hash of
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * managed objects.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Preconditions: Caller must have locked g_mutexSessions.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiManagedObjectRef::~ManagedObjectRef()
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ULONG64 cTotal = --g_cManagedObjects;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG((" * %s: deleting MOR for ID %llX (%s); now %lld objects total\n", __FUNCTION__, _id, _pcszInterface, cTotal));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // if we're being destroyed from the session's destructor,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // then that destructor is iterating over the maps, so
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // don't remove us there! (data integrity + speed)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (!_session._fDestructing)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw WEBDEBUG((" * %s: removing from session maps\n", __FUNCTION__));
a90d965d832a5578dbfc2eadd1617e8cccf25264fw _session._pp->_mapManagedObjectsById.erase(_id);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (_session._pp->_mapManagedObjectsByPtr.erase(_ulp) != 1)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG((" WARNING: could not find %llX in _mapManagedObjectsByPtr\n", _ulp));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Converts the ID of this managed object reference to string
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * form, for returning with SOAP data or similar.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @return The ID in string form.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiWSDLT_ID ManagedObjectRef::toWSDL() const
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return _strID;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Static helper method for findObjectFromRef() template that actually
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * looks up the object from a given integer ID.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * This has been extracted into this non-template function to reduce
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * code bloat as we have the actual STL map lookup only in this function.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * This also "touches" the timestamp in the session whose ID is encoded
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * in the given integer ID, in order to prevent the session from timing
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * out.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Preconditions: Caller must have locked g_mutexSessions.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param strId
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param iter
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @return
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
a90d965d832a5578dbfc2eadd1617e8cccf25264fwint ManagedObjectRef::findRefFromId(const WSDLT_ID &id,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectRef **pRef,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki bool fNullAllowed)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki int rc = 0;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki do
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw // allow NULL (== empty string) input reference, which should return a NULL pointer
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (!id.length() && fNullAllowed)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
4c5e0fde93352f23abc94e445999402e38b91268vivek *pRef = NULL;
4c5e0fde93352f23abc94e445999402e38b91268vivek return 0;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw }
4c5e0fde93352f23abc94e445999402e38b91268vivek
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki uint64_t sessid;
4c5e0fde93352f23abc94e445999402e38b91268vivek uint64_t objid;
4c5e0fde93352f23abc94e445999402e38b91268vivek WEBDEBUG((" %s(): looking up objref %s\n", __FUNCTION__, id.c_str()));
a90d965d832a5578dbfc2eadd1617e8cccf25264fw if (!SplitManagedObjectRef(id,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki &sessid,
a90d965d832a5578dbfc2eadd1617e8cccf25264fw &objid))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki rc = VERR_WEB_INVALID_MANAGED_OBJECT_REFERENCE;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG((" %s(): sessid %llX, objid %llX\n", __FUNCTION__, sessid, objid));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki SessionsMapIterator it = g_mapSessions.find(sessid);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (it == g_mapSessions.end())
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG((" %s: cannot find session for objref %s\n", __FUNCTION__, id.c_str()));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki rc = VERR_WEB_INVALID_SESSION_ID;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WebServiceSession *pSess = it->second;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // "touch" session to prevent it from timing out
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki pSess->touch();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectsIteratorById iter = pSess->_pp->_mapManagedObjectsById.find(objid);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (iter == pSess->_pp->_mapManagedObjectsById.end())
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw WEBDEBUG((" %s: cannot find comobj for objref %s\n", __FUNCTION__, id.c_str()));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki rc = VERR_WEB_INVALID_OBJECT_ID;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *pRef = iter->second;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki } while (0);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return rc;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
a90d965d832a5578dbfc2eadd1617e8cccf25264fw/****************************************************************************
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * interface IManagedObjectRef
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ****************************************************************************/
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * This is the hard-coded implementation for the IManagedObjectRef::getInterfaceName()
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * that our WSDL promises to our web service clients. This method returns a
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * string describing the interface that this managed object reference
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * supports, e.g. "IMachine".
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param soap
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param req
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param resp
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @return
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
a90d965d832a5578dbfc2eadd1617e8cccf25264fwint __vbox__IManagedObjectRef_USCOREgetInterfaceName(
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki struct soap *soap,
a90d965d832a5578dbfc2eadd1617e8cccf25264fw _vbox__IManagedObjectRef_USCOREgetInterfaceName *req,
a90d965d832a5578dbfc2eadd1617e8cccf25264fw _vbox__IManagedObjectRef_USCOREgetInterfaceNameResponse *resp)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki HRESULT rc = SOAP_OK;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("\n-- entering %s\n", __FUNCTION__));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki do {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw ManagedObjectRef *pRef;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw if (!ManagedObjectRef::findRefFromId(req->_USCOREthis, &pRef, false))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki resp->returnval = pRef->getInterfaceName();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki } while (0);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("-- leaving %s, rc: 0x%lX\n", __FUNCTION__, rc));
a90d965d832a5578dbfc2eadd1617e8cccf25264fw if (FAILED(rc))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return SOAP_FAULT;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw return SOAP_OK;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * This is the hard-coded implementation for the IManagedObjectRef::release()
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * that our WSDL promises to our web service clients. This method releases
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * a managed object reference and removes it from our stacks.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @param soap
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param req
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @param resp
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @return
a90d965d832a5578dbfc2eadd1617e8cccf25264fw */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiint __vbox__IManagedObjectRef_USCORErelease(
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki struct soap *soap,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _vbox__IManagedObjectRef_USCORErelease *req,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _vbox__IManagedObjectRef_USCOREreleaseResponse *resp)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki HRESULT rc = SOAP_OK;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw WEBDEBUG(("\n-- entering %s\n", __FUNCTION__));
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki do {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectRef *pRef;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if ((rc = ManagedObjectRef::findRefFromId(req->_USCOREthis, &pRef, false)))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki RaiseSoapInvalidObjectFault(soap, req->_USCOREthis);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw break;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG((" found reference; deleting!\n"));
a90d965d832a5578dbfc2eadd1617e8cccf25264fw delete pRef;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw // this removes the object from all stacks; since
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // there's a ComPtr<> hidden inside the reference,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // this should also invoke Release() on the COM
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // object
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki } while (0);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
a90d965d832a5578dbfc2eadd1617e8cccf25264fw WEBDEBUG(("-- leaving %s, rc: 0x%lX\n", __FUNCTION__, rc));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (FAILED(rc))
a90d965d832a5578dbfc2eadd1617e8cccf25264fw return SOAP_FAULT;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw return SOAP_OK;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/****************************************************************************
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * interface IWebsessionManager
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
a90d965d832a5578dbfc2eadd1617e8cccf25264fw ****************************************************************************/
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Hard-coded implementation for IWebsessionManager::logon. As opposed to the underlying
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * COM API, this is the first method that a webservice client must call before the
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * webservice will do anything useful.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * This returns a managed object reference to the global IVirtualBox object; into this
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * reference a session ID is encoded which remains constant with all managed object
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * references returned by other methods.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * This also creates an instance of ISession, which is stored internally with the
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * webservice session and can be retrieved with IWebsessionManager::getSessionObject
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * (__vbox__IWebsessionManager_USCOREgetSessionObject). In order for the
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * VirtualBox web service to do anything useful, one usually needs both a
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * VirtualBox and an ISession object, for which these two methods are designed.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * When the webservice client is done, it should call IWebsessionManager::logoff. This
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * will clean up internally (destroy all remaining managed object references and
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * related COM objects used internally).
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * After logon, an internal timeout ensures that if the webservice client does not
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * call any methods, after a configurable number of seconds, the webservice will log
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * off the client automatically. This is to ensure that the webservice does not
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * drown in managed object references and eventually deny service. Still, it is
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * a much better solution, both for performance and cleanliness, for the webservice
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * client to clean up itself.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Preconditions: Caller must have locked g_mutexSessions.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Since this gets called from main() like other SOAP method
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * implementations, this is ensured.
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @param vbox__IWebsessionManager_USCORElogon
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param vbox__IWebsessionManager_USCORElogonResponse
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * @return
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
a90d965d832a5578dbfc2eadd1617e8cccf25264fwint __vbox__IWebsessionManager_USCORElogon(
a90d965d832a5578dbfc2eadd1617e8cccf25264fw struct soap*,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _vbox__IWebsessionManager_USCORElogon *req,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _vbox__IWebsessionManager_USCORElogonResponse *resp)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki HRESULT rc = SOAP_OK;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("\n-- entering %s\n", __FUNCTION__));
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki do {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw // create new session; the constructor stores the new session
a90d965d832a5578dbfc2eadd1617e8cccf25264fw // in the global map automatically
a90d965d832a5578dbfc2eadd1617e8cccf25264fw WebServiceSession *pSession = new WebServiceSession();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // authenticate the user
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (!(pSession->authenticate(req->username.c_str(),
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki req->password.c_str())))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw // in the new session, create a managed object reference (moref) for the
a90d965d832a5578dbfc2eadd1617e8cccf25264fw // global VirtualBox object; this encodes the session ID in the moref so
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // that it will be implicitly be included in all future requests of this
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki // webservice client
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki ManagedObjectRef *pRef = new ManagedObjectRef(*pSession, g_pcszIVirtualBox, g_pVirtualBox);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki resp->returnval = pRef->toWSDL();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("VirtualBox object ref is %s\n", resp->returnval.c_str()));
a90d965d832a5578dbfc2eadd1617e8cccf25264fw }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki } while (0);
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("-- leaving %s, rc: 0x%lX\n", __FUNCTION__, rc));
a90d965d832a5578dbfc2eadd1617e8cccf25264fw if (FAILED(rc))
a90d965d832a5578dbfc2eadd1617e8cccf25264fw return SOAP_FAULT;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw return SOAP_OK;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Returns the ISession object that was created for the webservice client
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * on logon.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Preconditions: Caller must have locked g_mutexSessions.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * Since this gets called from main() like other SOAP method
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * implementations, this is ensured.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw */
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenkiint __vbox__IWebsessionManager_USCOREgetSessionObject(
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki struct soap*,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _vbox__IWebsessionManager_USCOREgetSessionObject *req,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _vbox__IWebsessionManager_USCOREgetSessionObjectResponse *resp)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
a90d965d832a5578dbfc2eadd1617e8cccf25264fw HRESULT rc = SOAP_OK;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw WEBDEBUG(("\n-- entering %s\n", __FUNCTION__));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki do {
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WebServiceSession* pSession;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if ((pSession = WebServiceSession::findSessionFromRef(req->refIVirtualBox)))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw resp->returnval = pSession->getSessionObject();
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
a90d965d832a5578dbfc2eadd1617e8cccf25264fw } while (0);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
a90d965d832a5578dbfc2eadd1617e8cccf25264fw WEBDEBUG(("-- leaving %s, rc: 0x%lX\n", __FUNCTION__, rc));
a90d965d832a5578dbfc2eadd1617e8cccf25264fw if (FAILED(rc))
a90d965d832a5578dbfc2eadd1617e8cccf25264fw return SOAP_FAULT;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return SOAP_OK;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki/**
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * hard-coded implementation for IWebsessionManager::logoff.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * Preconditions: Caller must have locked g_mutexSessions.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * Since this gets called from main() like other SOAP method
a90d965d832a5578dbfc2eadd1617e8cccf25264fw * implementations, this is ensured.
a90d965d832a5578dbfc2eadd1617e8cccf25264fw *
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param vbox__IWebsessionManager_USCORElogon
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @param vbox__IWebsessionManager_USCORElogonResponse
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki * @return
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki */
a90d965d832a5578dbfc2eadd1617e8cccf25264fwint __vbox__IWebsessionManager_USCORElogoff(
a90d965d832a5578dbfc2eadd1617e8cccf25264fw struct soap*,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _vbox__IWebsessionManager_USCORElogoff *req,
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki _vbox__IWebsessionManager_USCORElogoffResponse *resp)
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki{
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki HRESULT rc = SOAP_OK;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("\n-- entering %s\n", __FUNCTION__));
a90d965d832a5578dbfc2eadd1617e8cccf25264fw
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki do {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw WebServiceSession* pSession;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if ((pSession = WebServiceSession::findSessionFromRef(req->refIVirtualBox)))
a90d965d832a5578dbfc2eadd1617e8cccf25264fw {
a90d965d832a5578dbfc2eadd1617e8cccf25264fw delete pSession;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw // destructor cleans up
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki WEBDEBUG(("session destroyed, %d sessions left open\n", g_mapSessions.size()));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki }
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki } while (0);
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki
a90d965d832a5578dbfc2eadd1617e8cccf25264fw WEBDEBUG(("-- leaving %s, rc: 0x%lX\n", __FUNCTION__, rc));
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki if (FAILED(rc))
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return SOAP_FAULT;
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki return SOAP_OK;
a90d965d832a5578dbfc2eadd1617e8cccf25264fw}
0d63ce2b32a9e1cc8ed71d4d92536c44d66a530avenki