GuestSessionImpl.h revision 687794577e2e35c3cae67e692a7f2130d1262a82
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/* $Id$ */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @file
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * VirtualBox Main - XXX.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
e64031e20c39650a7bc902a3e1aba613b9415deevboxsync/*
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
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#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"
42c1972c22e09797b4b24afbd0ec114ed076c37cvboxsync#include "GuestFsObjInfoImpl.h"
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
48d60b042893290a747d3abeda71a3085d9133fdvboxsyncclass Guest;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/**
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * TODO
8809400ad2407593d3471b82d5caf0c24cbcdf8avboxsync */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncclass ATL_NO_VTABLE GuestSession :
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync public VirtualBoxBase,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync VBOX_SCRIPTABLE_IMPL(IGuestSession)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync{
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncpublic:
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @name COM and internal init/term/mapping cruft.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @{ */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(GuestSession, IGuestSession)
590bfe12ce22cd3716448fbb9f4dc51664bfe5e2vboxsync 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)
ffa39e5fea478b00909918ab8d45fb3ffb02bc14vboxsync
06dc6eb95cf33b2b83f0d07c602d1ca20a575663vboxsync int init(Guest *aGuest, ULONG aSessionID, Utf8Str aUser, Utf8Str aPassword, Utf8Str aDomain, Utf8Str aName);
590bfe12ce22cd3716448fbb9f4dc51664bfe5e2vboxsync void uninit(void);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync HRESULT FinalConstruct(void);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync void FinalRelease(void);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @} */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @name IGuestSession properties.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @{ */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(User))(BSTR *aName);
f1f55b6ac890efaabca0ff940f58aa8df1dc84c8vboxsync STDMETHOD(COMGETTER(Domain))(BSTR *aDomain);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(Name))(BSTR *aName);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(Id))(ULONG *aId);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(Timeout))(ULONG *aTimeout);
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync STDMETHOD(COMGETTER(Environment))(ComSafeArrayOut(BSTR, aEnvironment));
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync STDMETHOD(COMGETTER(Processes))(ComSafeArrayOut(IGuestProcess *, aProcesses));
ffa39e5fea478b00909918ab8d45fb3ffb02bc14vboxsync STDMETHOD(COMGETTER(Directories))(ComSafeArrayOut(IGuestDirectory *, aDirectories));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(COMGETTER(Files))(ComSafeArrayOut(IGuestFile *, aFiles));
ce666b71b4eb6477625b0057689a08aaa7c11b64vboxsync /** @} */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @name IGuestSession methods.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @{ */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(Close)(void);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(CopyFrom)(IN_BSTR aSource, IN_BSTR aDest, ComSafeArrayIn(ULONG, aFlags), IProgress **aProgress);
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync STDMETHOD(CopyTo)(IN_BSTR aSource, IN_BSTR aDest, ComSafeArrayIn(ULONG, aFlags), IProgress **aProgress);
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync STDMETHOD(DirectoryCreate)(IN_BSTR aPath, ULONG aMode, ULONG aFlags, IGuestDirectory **aDirectory);
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync 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));
38b70b2dcb1783801f7580cba797a0c8af4b5326vboxsync STDMETHOD(EnvironmentUnset)(IN_BSTR aName);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(FileCreateTemp)(IN_BSTR aTemplate, ULONG aMode, IN_BSTR aName, IGuestFile **aFile);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync 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);
38b70b2dcb1783801f7580cba797a0c8af4b5326vboxsync 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));
38b70b2dcb1783801f7580cba797a0c8af4b5326vboxsync STDMETHOD(FileSetACL)(IN_BSTR aPath, IN_BSTR aACL);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(ProcessCreate)(IN_BSTR aCommand, ComSafeArrayIn(IN_BSTR, aArguments), ComSafeArrayIn(IN_BSTR, aEnvironment),
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync 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);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(ProcessGet)(ULONG aPID, IGuestProcess **aProcess);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(SetTimeout)(ULONG aTimeoutMS);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync STDMETHOD(SymlinkCreate)(IN_BSTR aSource, IN_BSTR aTarget, SymlinkType_T aType);
ce666b71b4eb6477625b0057689a08aaa7c11b64vboxsync 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 /** @} */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsyncprivate:
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync typedef std::vector <ComObjPtr<GuestDirectory> > SessionDirectories;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync typedef std::vector <ComObjPtr<GuestFile> > SessionFiles;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** Map of guest processes. The key specifies the internal process number.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * To retrieve the process' guest PID use the Id() method of the IProgress interface. */
ce666b71b4eb6477625b0057689a08aaa7c11b64vboxsync typedef std::map <ULONG, ComObjPtr<GuestProcess> > SessionProcesses;
17c6e5e8177d068d1bc6af875d1610718efcfdb4vboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncpublic:
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @name Public internal methods.
b1c3cdef473df2fbc621d5da81acc82dbfb8a11avboxsync * @{ */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync int directoryClose(ComObjPtr<GuestDirectory> pDirectory);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync int dispatchToProcess(uint32_t uContextID, uint32_t uFunction, void *pvData, size_t cbData);
fa92c704624def98d3c4aca86d65182effb98e04vboxsync int fileClose(ComObjPtr<GuestFile> pFile);
fa92c704624def98d3c4aca86d65182effb98e04vboxsync const GuestCredentials &getCredentials(void);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync const GuestEnvironment &getEnvironment(void);
17c6e5e8177d068d1bc6af875d1610718efcfdb4vboxsync int processClose(ComObjPtr<GuestProcess> pProcess);
17c6e5e8177d068d1bc6af875d1610718efcfdb4vboxsync int processCreateExInteral(GuestProcessInfo &aProcInfo, IGuestProcess **aProcess);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync inline bool processExists(ULONG uProcessID, ComObjPtr<GuestProcess> *pProcess);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync inline int processGetByPID(ULONG uPID, ComObjPtr<GuestProcess> *pProcess);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @} */
ce666b71b4eb6477625b0057689a08aaa7c11b64vboxsync
17c6e5e8177d068d1bc6af875d1610718efcfdb4vboxsyncprivate:
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync struct Data
b1c3cdef473df2fbc621d5da81acc82dbfb8a11avboxsync {
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** Flag indicating if this is an internal session
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * or not. Internal session are not accessible by clients. */
fa92c704624def98d3c4aca86d65182effb98e04vboxsync bool fInternal;
fa92c704624def98d3c4aca86d65182effb98e04vboxsync /** Pointer to the parent (Guest). */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync Guest *mParent;
17c6e5e8177d068d1bc6af875d1610718efcfdb4vboxsync /** The session credentials. */
17c6e5e8177d068d1bc6af875d1610718efcfdb4vboxsync GuestCredentials mCredentials;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** The (optional) session name. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync Utf8Str mName;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** The session ID. */
ce666b71b4eb6477625b0057689a08aaa7c11b64vboxsync ULONG mId;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** The session timeout. Default is 30s. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync ULONG mTimeout;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync GuestEnvironment mEnvironment;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync SessionDirectories mDirectories;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync SessionFiles mFiles;
42c1972c22e09797b4b24afbd0ec114ed076c37cvboxsync SessionProcesses mProcesses;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync } mData;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync};
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#endif /* !____H_GUESTSESSIONIMPL */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync