ExtPackManagerImpl.h revision dfb168a2e2b9e4dd806eab2ebfcbf3b36dc9a8b9
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync * VirtualBox Main - interface for Extension Packs, VBoxSVC & VBoxC.
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync * Copyright (C) 2010 Oracle Corporation
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync * available from http://www.virtualbox.org. This file is free software;
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync * you can redistribute it and/or modify it under the terms of the GNU
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync * General Public License (GPL) as published by the Free Software
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync * An extension pack file.
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync /** @name COM and internal init/term/mapping cruft.
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(ExtPackFile, IExtPackFile)
f7d0672fb68919a6a824f47d7ef72b9b7bd0c266vboxsync HRESULT initWithFile(const char *a_pszFile, class ExtPackManager *a_pExtPackMgr);
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync /** @name IExtPackBase interfaces
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync STDMETHOD(COMGETTER(Description))(BSTR *a_pbstrDescription);
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync STDMETHOD(COMGETTER(Version))(BSTR *a_pbstrVersion);
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync STDMETHOD(COMGETTER(Revision))(ULONG *a_puRevision);
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync STDMETHOD(COMGETTER(VRDEModule))(BSTR *a_pbstrVrdeModule);
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync STDMETHOD(COMGETTER(PlugIns))(ComSafeArrayOut(IExtPackPlugIn *, a_paPlugIns));
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync STDMETHOD(COMGETTER(WhyUnusable))(BSTR *a_pbstrWhy);
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync /** @name IExtPackFile interfaces
f7d0672fb68919a6a824f47d7ef72b9b7bd0c266vboxsync /** @name Misc init helpers
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync /** Pointer to the private instance. */
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync * An installed extension pack.
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync /** @name COM and internal init/term/mapping cruft.
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(ExtPack, IExtPack)
71a0530ccd741736d49c6798fd01cbc2956eea12vboxsync HRESULT initWithDir(VBOXEXTPACKCTX a_enmContext, const char *a_pszName, const char *a_pszDir);
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync /** @name IExtPackBase interfaces
d6835eb59b58420b98d9adf7b7f1f8f5ef6187bcvboxsync STDMETHOD(COMGETTER(Description))(BSTR *a_pbstrDescription);
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync STDMETHOD(COMGETTER(Version))(BSTR *a_pbstrVersion);
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync STDMETHOD(COMGETTER(Revision))(ULONG *a_puRevision);
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync STDMETHOD(COMGETTER(VRDEModule))(BSTR *a_pbstrVrdeModule);
8479df0918362ee801608d4f48c6d8ee8fdf505evboxsync STDMETHOD(COMGETTER(PlugIns))(ComSafeArrayOut(IExtPackPlugIn *, a_paPlugIns));
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync STDMETHOD(COMGETTER(WhyUnusable))(BSTR *a_pbstrWhy);
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync /** @name IExtPack interfaces
8479df0918362ee801608d4f48c6d8ee8fdf505evboxsync STDMETHOD(QueryObject)(IN_BSTR a_bstrObjectId, IUnknown **a_ppUnknown);
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync /** @name Internal interfaces used by ExtPackManager.
8dcec71b7a288828cf280aa9c60d5dd260388254vboxsync bool callInstalledHook(IVirtualBox *a_pVirtualBox, AutoWriteLock *a_pLock);
6f63267ae3ac590beee4c0e298774baf18e0fb84vboxsync HRESULT callUninstallHookAndClose(IVirtualBox *a_pVirtualBox, bool a_fForcedRemoval);
8dcec71b7a288828cf280aa9c60d5dd260388254vboxsync bool callVirtualBoxReadyHook(IVirtualBox *a_pVirtualBox, AutoWriteLock *a_pLock);
8dcec71b7a288828cf280aa9c60d5dd260388254vboxsync bool callConsoleReadyHook(IConsole *a_pConsole, AutoWriteLock *a_pLock);
8dcec71b7a288828cf280aa9c60d5dd260388254vboxsync bool callVmCreatedHook(IVirtualBox *a_pVirtualBox, IMachine *a_pMachine, AutoWriteLock *a_pLock);
8dcec71b7a288828cf280aa9c60d5dd260388254vboxsync bool callVmConfigureVmmHook(IConsole *a_pConsole, PVM a_pVM, AutoWriteLock *a_pLock, int *a_pvrc);
8dcec71b7a288828cf280aa9c60d5dd260388254vboxsync bool callVmPowerOnHook(IConsole *a_pConsole, PVM a_pVM, AutoWriteLock *a_pLock, int *a_pvrc);
8dcec71b7a288828cf280aa9c60d5dd260388254vboxsync bool callVmPowerOffHook(IConsole *a_pConsole, PVM a_pVM, AutoWriteLock *a_pLock);
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync HRESULT getVrdpLibraryName(Utf8Str *a_pstrVrdeLibrary);
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync bool wantsToBeDefaultVrde(void) const;
710d24589d0cbe0ea6e9ad143eda5bbd41000693vboxsync /** @name Internal helper methods.
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync bool findModule(const char *a_pszName, const char *a_pszExt, VBOXEXTPACKMODKIND a_enmKind,
8479df0918362ee801608d4f48c6d8ee8fdf505evboxsync Utf8Str *a_ppStrFound, bool *a_pfNative, PRTFSOBJINFO a_pObjInfo) const;
710d24589d0cbe0ea6e9ad143eda5bbd41000693vboxsync static bool objinfoIsEqual(PCRTFSOBJINFO pObjInfo1, PCRTFSOBJINFO pObjInfo2);
710d24589d0cbe0ea6e9ad143eda5bbd41000693vboxsync /** @name Extension Pack Helpers
710d24589d0cbe0ea6e9ad143eda5bbd41000693vboxsync static DECLCALLBACK(int) hlpFindModule(PCVBOXEXTPACKHLP pHlp, const char *pszName, const char *pszExt,
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync VBOXEXTPACKMODKIND enmKind, char *pszFound, size_t cbFound, bool *pfNative);
8479df0918362ee801608d4f48c6d8ee8fdf505evboxsync static DECLCALLBACK(int) hlpGetFilePath(PCVBOXEXTPACKHLP pHlp, const char *pszFilename, char *pszPath, size_t cbPath);
8dcec71b7a288828cf280aa9c60d5dd260388254vboxsync static DECLCALLBACK(VBOXEXTPACKCTX) hlpGetContext(PCVBOXEXTPACKHLP pHlp);
8dcec71b7a288828cf280aa9c60d5dd260388254vboxsync static DECLCALLBACK(int) hlpReservedN(PCVBOXEXTPACKHLP pHlp);
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync /** Pointer to the private instance. */
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync * Extension pack manager.
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync /** @name COM and internal init/term/mapping cruft.
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(ExtPackManager, IExtPackManager)
dfb168a2e2b9e4dd806eab2ebfcbf3b36dc9a8b9vboxsync HRESULT initExtPackManager(VirtualBox *a_pVirtualBox, VBOXEXTPACKCTX a_enmContext);
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync /** @name IExtPack interfaces
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync STDMETHOD(COMGETTER(InstalledExtPacks))(ComSafeArrayOut(IExtPack *, a_paExtPacks));
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync STDMETHOD(Find)(IN_BSTR a_bstrName, IExtPack **a_pExtPack);
94e055188526aeeb119b5d60fe22bf7a302522dcvboxsync STDMETHOD(OpenExtPackFile)(IN_BSTR a_bstrTarball, IExtPackFile **a_ppExtPackFile);
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync STDMETHOD(Uninstall)(IN_BSTR a_bstrName, BOOL a_fForcedRemoval);
8479df0918362ee801608d4f48c6d8ee8fdf505evboxsync STDMETHOD(QueryAllPlugInsForFrontend)(IN_BSTR a_bstrFrontend, ComSafeArrayOut(BSTR, a_pabstrPlugInModules));
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync /** @name Internal interfaces used by other Main classes.
8dcec71b7a288828cf280aa9c60d5dd260388254vboxsync void callAllConsoleReadyHooks(IConsole *a_pConsole);
d6835eb59b58420b98d9adf7b7f1f8f5ef6187bcvboxsync int callAllVmConfigureVmmHooks(IConsole *a_pConsole, PVM a_pVM);
d6835eb59b58420b98d9adf7b7f1f8f5ef6187bcvboxsync int callAllVmPowerOnHooks(IConsole *a_pConsole, PVM a_pVM);
d6835eb59b58420b98d9adf7b7f1f8f5ef6187bcvboxsync void callAllVmPowerOffHooks(IConsole *a_pConsole, PVM a_pVM);
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync HRESULT checkVrdeExtPack(Utf8Str const *a_pstrExtPack);
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync int getVrdeLibraryPathForExtPack(Utf8Str const *a_pstrExtPack, Utf8Str *a_pstrVrdeLibrary);
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync HRESULT getDefaultVrdeExtPack(Utf8Str *a_pstrExtPack);
8d82d07fc2f7234b1e5a3ba544e1086a5a7a7c5fvboxsync HRESULT runSetUidToRootHelper(const char *a_pszCommand, ...);
8d82d07fc2f7234b1e5a3ba544e1086a5a7a7c5fvboxsync HRESULT refreshExtPack(const char *a_pszName, bool a_fUnsuableIsError, ExtPack **a_ppExtPack);
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync /** Pointer to the private instance. */
73045e3d71f04f3d399e70e89fbd6395c4402821vboxsync/* vi: set tabstop=4 shiftwidth=4 expandtab: */