GuestSessionImpl.h revision 702a8ee2dc1de96f2f77e97135015d3e243186fd
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/* $Id$ */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @file
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * VirtualBox Main - XXX.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync/*
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Copyright (C) 2012 Oracle Corporation
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync *
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * available from http://www.virtualbox.org. This file is free software;
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * you can redistribute it and/or modify it under the terms of the GNU
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * General Public License (GPL) as published by the Free Software
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync */
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync#ifndef ____H_GUESTSESSIONIMPL
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#define ____H_GUESTSESSIONIMPL
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#include "VirtualBoxBase.h"
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#include "GuestCtrlImplPrivate.h"
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#include "GuestProcessImpl.h"
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#include "GuestDirectoryImpl.h"
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#include "GuestFileImpl.h"
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#include "GuestFsObjInfoImpl.h"
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncclass Guest;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/**
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * TODO
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncclass ATL_NO_VTABLE GuestSession :
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync public VirtualBoxBase,
61fa69e2bc9fc9e7490feed1c020273f3ddb238dvboxsync VBOX_SCRIPTABLE_IMPL(IGuestSession)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync{
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncpublic:
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @name COM and internal init/term/mapping cruft.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @{ */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(GuestSession, IGuestSession)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync DECLARE_NOT_AGGREGATABLE(GuestSession)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync DECLARE_PROTECT_FINAL_CONSTRUCT()
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync BEGIN_COM_MAP(GuestSession)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync VBOX_DEFAULT_INTERFACE_ENTRIES(IGuestSession)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync END_COM_MAP()
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync DECLARE_EMPTY_CTOR_DTOR(GuestSession)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
223cf005b18af2c21352a70693ebaf0582f68ebcvboxsync int init(Guest *aGuest, uint32_t aSessionID, Utf8Str aUser, Utf8Str aPassword, Utf8Str aDomain, Utf8Str aName);
223cf005b18af2c21352a70693ebaf0582f68ebcvboxsync void uninit(void);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync HRESULT FinalConstruct(void);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync void FinalRelease(void);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @} */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @name IGuestSession properties.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @{ */
afed5ab737f4aacfae3fe73776f40e989190a7cavboxsync STDMETHOD(COMGETTER(User))(BSTR *aName);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(Domain))(BSTR *aDomain);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(Name))(BSTR *aName);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(Id))(ULONG *aId);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(Timeout))(ULONG *aTimeout);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(Environment))(ComSafeArrayOut(BSTR, aEnvironment));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(Processes))(ComSafeArrayOut(IGuestProcess *, aProcesses));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(Directories))(ComSafeArrayOut(IGuestDirectory *, aDirectories));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(Files))(ComSafeArrayOut(IGuestFile *, aFiles));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @} */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @name IGuestSession methods.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @{ */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(Close)(void);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(CopyFrom)(IN_BSTR aSource, IN_BSTR aDest, ComSafeArrayIn(ULONG, aFlags), IProgress **aProgress);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(CopyTo)(IN_BSTR aSource, IN_BSTR aDest, ComSafeArrayIn(ULONG, aFlags), IProgress **aProgress);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(DirectoryCreate)(IN_BSTR aPath, ULONG aMode, ULONG aFlags, IGuestDirectory **aDirectory);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(DirectoryCreateTemp)(IN_BSTR aTemplate, ULONG aMode, IN_BSTR aName, IGuestDirectory **aDirectory);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(DirectoryExists)(IN_BSTR aPath, BOOL *aExists);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(DirectoryOpen)(IN_BSTR aPath, IN_BSTR aFilter, IN_BSTR aFlags, IGuestDirectory **aDirectory);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(DirectoryQueryInfo)(IN_BSTR aPath, IGuestFsObjInfo **aInfo);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(DirectoryRemove)(IN_BSTR aPath);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(DirectoryRemoveRecursive)(IN_BSTR aPath, ComSafeArrayIn(DirectoryRemoveRecFlag_T, aFlags), IProgress **aProgress);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(DirectoryRename)(IN_BSTR aSource, IN_BSTR aDest, ComSafeArrayIn(PathRenameFlag_T, aFlags));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(DirectorySetACL)(IN_BSTR aPath, IN_BSTR aACL);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(EnvironmentClear)(void);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(EnvironmentGet)(IN_BSTR aName, BSTR *aValue);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(EnvironmentSet)(IN_BSTR aName, IN_BSTR aValue);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(EnvironmentSetArray)(ComSafeArrayIn(IN_BSTR, aValues));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(EnvironmentUnset)(IN_BSTR aName);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(FileCreateTemp)(IN_BSTR aTemplate, ULONG aMode, IN_BSTR aName, IGuestFile **aFile);
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync STDMETHOD(FileExists)(IN_BSTR aPath, BOOL *aExists);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(FileOpen)(IN_BSTR aPath, IN_BSTR aOpenMode, IN_BSTR aDisposition, ULONG aCreationMode, LONG64 aOffset, IGuestFile **aFile);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(FileQueryInfo)(IN_BSTR aPath, IGuestFsObjInfo **aInfo);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(FileQuerySize)(IN_BSTR aPath, LONG64 *aSize);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(FileRemove)(IN_BSTR aPath);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(FileRename)(IN_BSTR aSource, IN_BSTR aDest, ComSafeArrayIn(PathRenameFlag_T, aFlags));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(FileSetACL)(IN_BSTR aPath, IN_BSTR aACL);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(ProcessCreate)(IN_BSTR aCommand, ComSafeArrayIn(IN_BSTR, aArguments), ComSafeArrayIn(IN_BSTR, aEnvironment),
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync ComSafeArrayIn(ProcessCreateFlag_T, aFlags), ULONG aTimeoutMS, IGuestProcess **aProcess);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(ProcessCreateEx)(IN_BSTR aCommand, ComSafeArrayIn(IN_BSTR, aArguments), ComSafeArrayIn(IN_BSTR, aEnvironment),
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync ComSafeArrayIn(ProcessCreateFlag_T, aFlags), ULONG aTimeoutMS,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync ProcessPriority_T aPriority, ComSafeArrayIn(LONG, aAffinity),
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync IGuestProcess **aProcess);
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync STDMETHOD(ProcessGet)(ULONG aPID, IGuestProcess **aProcess);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(SetTimeout)(ULONG aTimeoutMS);
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync STDMETHOD(SymlinkCreate)(IN_BSTR aSource, IN_BSTR aTarget, SymlinkType_T aType);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(SymlinkExists)(IN_BSTR aSymlink, BOOL *aExists);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(SymlinkRead)(IN_BSTR aSymlink, ComSafeArrayIn(SymlinkReadFlag_T, aFlags), BSTR *aTarget);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(SymlinkRemoveDirectory)(IN_BSTR aPath);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(SymlinkRemoveFile)(IN_BSTR aFile);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @} */
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncprivate:
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync typedef std::vector <ComObjPtr<GuestDirectory> > SessionDirectories;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync typedef std::vector <ComObjPtr<GuestFile> > SessionFiles;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync typedef std::map <uint32_t, ComObjPtr<GuestProcess> > SessionProcesses;
fdea543f71872a3ec3909536a4fce37ab7aa3a8bvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncpublic:
fdea543f71872a3ec3909536a4fce37ab7aa3a8bvboxsync /** @name Public internal methods.
fdea543f71872a3ec3909536a4fce37ab7aa3a8bvboxsync * @{ */
fdea543f71872a3ec3909536a4fce37ab7aa3a8bvboxsync int directoryClose(ComObjPtr<GuestDirectory> pDirectory);
fdea543f71872a3ec3909536a4fce37ab7aa3a8bvboxsync int fileClose(ComObjPtr<GuestFile> pFile);
fdea543f71872a3ec3909536a4fce37ab7aa3a8bvboxsync const GuestCredentials &getCredentials(void);
fdea543f71872a3ec3909536a4fce37ab7aa3a8bvboxsync const GuestEnvironment &getEnvironment(void);
8f7bc6ad2b7bbcb4b3b96248cd2478e45f2e3b88vboxsync int processClose(ComObjPtr<GuestProcess> pProcess);
8f7bc6ad2b7bbcb4b3b96248cd2478e45f2e3b88vboxsync int processCreateExInteral(GuestProcessInfo &aProcInfo, IGuestProcess **aProcess);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync inline bool processExists(uint32_t uProcessID);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @} */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncprivate:
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync struct Data
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync {
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync /** Flag indicating if this is an internal session
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync * or not. Internal session are not accessible by clients. */
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync bool fInternal;
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync /** Pointer to the parent (Guest). */
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync Guest *mParent;
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync /** The session credentials. */
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync GuestCredentials mCredentials;
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync /** The (optional) session name. */
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync Utf8Str mName;
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync /** The session ID. */
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync ULONG mId;
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync /** The session timeout. Default is 30s. */
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync ULONG mTimeout;
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync GuestEnvironment mEnvironment;
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync SessionDirectories mDirectories;
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync SessionFiles mFiles;
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync SessionProcesses mProcesses;
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync } mData;
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync};
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync#endif /* !____H_GUESTSESSIONIMPL */
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync
50df3da42ff6589b0ecc4f50f2288811bc370186vboxsync