VBoxServiceUtils.cpp revision a6e469c8c56849f9391fd5f420ddc2205f6492a1
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync * VBoxServiceUtils - Some utility functions.
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * Copyright (C) 2009-2012 Oracle Corporation
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync * available from http://www.virtualbox.org. This file is free software;
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync * you can redistribute it and/or modify it under the terms of the GNU
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync * General Public License (GPL) as published by the Free Software
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync/*******************************************************************************
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync* Header Files *
7a61a5714b9a39ac3bd59e52b0843ef498350a35vboxsync*******************************************************************************/
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * Reads a guest property.
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * @returns VBox status code, fully bitched.
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * @param u32ClientId The HGCM client ID for the guest property session.
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * @param pszPropName The property name.
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * @param ppszValue Where to return the value. This is always set
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * to NULL. Free it using RTStrFree().
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * @param ppszFlags Where to return the value flags. Free it
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * using RTStrFree(). Optional.
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * @param puTimestamp Where to return the timestamp. This is only set
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * on success. Optional.
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsyncint VBoxServiceReadProp(uint32_t u32ClientId, const char *pszPropName,
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync char **ppszValue, char **ppszFlags, uint64_t *puTimestamp)
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync AssertPtrReturn(pszPropName, VERR_INVALID_POINTER);
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * (Re-)Allocate the buffer and try read the property.
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync VBoxServiceError("Guest Property: Failed to allocate %zu bytes\n", cbBuf);
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync /* try again with a bigger buffer. */
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync VBoxServiceVerbose(2, "Guest Property: %s not found\n", pszPropName);
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync VBoxServiceError("Guest Property: Failed to query \"%s\": %Rrc\n", pszPropName, rc);
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync VBoxServiceVerbose(2, "Guest Property: Read \"%s\" = \"%s\", timestamp %RU64n\n",
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync VBoxServiceError("Guest Property: RTStrDup failed for \"%s\"\n", pszValue);
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync break; /* done */
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * Reads a guest property as a 32-bit value.
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * @returns VBox status code, fully bitched.
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * @param u32ClientId The HGCM client ID for the guest property session.
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * @param pszPropName The property name.
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync * @param pu32 Where to store the 32-bit value.
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsyncint VBoxServiceReadPropUInt32(uint32_t u32ClientId, const char *pszPropName,
bc6df168670cfc0df5ae3be50ccbf098ba2cebc7vboxsync int rc = VBoxServiceReadProp(u32ClientId, pszPropName, &pszValue,
4893c4e3513fece2ef56f559aa2370c25f12a745vboxsync rc = VBoxServiceError("The guest property value %s = %RU32 is out of range [%RU32..%RU32].\n",
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * Reads a guest property from the host side.
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * @returns VBox status code, fully bitched.
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * @param u32ClientId The HGCM client ID for the guest property session.
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * @param pszPropName The property name.
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * @param fReadOnly Whether or not this property needs to be read only
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * by the guest side. Otherwise VERR_ACCESS_DENIED will
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * be returned.
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * @param ppszValue Where to return the value. This is always set
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * to NULL. Free it using RTStrFree().
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * @param ppszFlags Where to return the value flags. Free it
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * using RTStrFree(). Optional.
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * @param puTimestamp Where to return the timestamp. This is only set
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * on success. Optional.
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsyncint VBoxServiceReadHostProp(uint32_t u32ClientId, const char *pszPropName, bool fReadOnly,
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync char **ppszValue, char **ppszFlags, uint64_t *puTimestamp)
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync int rc = VBoxServiceReadProp(u32ClientId, pszPropName, ppszValue, &pszFlags, puTimestamp);
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync /* Check security bits. */
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync if ( fReadOnly /* Do we except a guest read-only property */
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync /* If we want a property which is read-only on the guest
a6e469c8c56849f9391fd5f420ddc2205f6492a1vboxsync * and it is *not* marked as such, deny access! */
019f39cc548f50d58cfdf91965f58eab1ded841bvboxsync * Wrapper around VbglR3GuestPropWriteValue that does value formatting and
019f39cc548f50d58cfdf91965f58eab1ded841bvboxsync * @returns VBox status code. Errors will be logged.
019f39cc548f50d58cfdf91965f58eab1ded841bvboxsync * @param u32ClientId The HGCM client ID for the guest property session.
019f39cc548f50d58cfdf91965f58eab1ded841bvboxsync * @param pszName The property name.
019f39cc548f50d58cfdf91965f58eab1ded841bvboxsync * @param pszValueFormat The property format string. If this is NULL then
eb360054919960bec0e41ea49932c591096c2f5fvboxsync * the property will be deleted (if possible).
019f39cc548f50d58cfdf91965f58eab1ded841bvboxsync * @param ... Format arguments.
324b7b7cb0e3e95595f5fb069043ff3643891ba2vboxsyncint VBoxServiceWritePropF(uint32_t u32ClientId, const char *pszName, const char *pszValueFormat, ...)
d3203e1a8d5b114c66238ae33506f6e1a3d79b9evboxsync VBoxServiceVerbose(3, "Writing guest property \"%s\" = \"%N\"\n", pszName, pszValueFormat, &va);
23776fb44216ff7aa3b47916ef4975748de89de1vboxsync rc = VbglR3GuestPropWriteValueV(u32ClientId, pszName, pszValueFormat, va);
23776fb44216ff7aa3b47916ef4975748de89de1vboxsync VBoxServiceError("Error writing guest property \"%s\" (rc=%Rrc)\n", pszName, rc);
d3203e1a8d5b114c66238ae33506f6e1a3d79b9evboxsync VBoxServiceVerbose(3, "Deleting guest property \"%s\"\n", pszName);
23776fb44216ff7aa3b47916ef4975748de89de1vboxsync rc = VbglR3GuestPropWriteValue(u32ClientId, pszName, NULL);
eb360054919960bec0e41ea49932c591096c2f5fvboxsync VBoxServiceError("Error deleting guest property \"%s\" (rc=%Rrc)\n", pszName, rc);
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync#endif /* VBOX_WITH_GUEST_PROPS */
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * Helper for VBoxServiceGetFileVersion and attempts to read and parse
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * FileVersion.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * @returns Success indicator.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsyncstatic bool VBoxServiceGetFileVersionOwn(LPSTR pVerData,
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync if (!VerQueryValueA(pVerData, "\\StringFileInfo\\040904b0\\FileVersion", (LPVOID *)&pStrValue, &cchStrValue))
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync return false;
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync /** @todo r=bird: get rid of this. Avoid sscanf like the plague! */
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync if (sscanf(pStrValue, "%ld.%ld.%ld.%ld", pdwMajor, pdwMinor, pdwBuildNumber, pdwRevisionNumber) != 4)
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync return false;
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync return true;
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * Worker for VBoxServiceGetFileVersionString.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * @returns VBox status code.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * @param pszFilename ASCII & ANSI & UTF-8 compliant name.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsyncstatic int VBoxServiceGetFileVersion(const char *pszFilename,
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync *pdwMajor = *pdwMinor = *pdwBuildNumber = *pdwRevisionNumber = 0;
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * Get the file version info.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync DWORD cbVerData = GetFileVersionInfoSizeA(pszFilename, &dwHandleIgnored);
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync LPTSTR pVerData = (LPTSTR)RTMemTmpAllocZ(cbVerData);
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync if (GetFileVersionInfoA(pszFilename, dwHandleIgnored, cbVerData, pVerData))
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * Try query and parse the FileVersion string our selves first
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * since this will give us the correct revision number when
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * it goes beyond the range of an uint16_t / WORD.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync if (VBoxServiceGetFileVersionOwn(pVerData, pdwMajor, pdwMinor, pdwBuildNumber, pdwRevisionNumber))
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync /* Fall back on VS_FIXEDFILEINFO */
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync if (VerQueryValue(pVerData, "\\", (LPVOID *)&pFileInfo, &cbFileInfoIgnored))
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync *pdwBuildNumber = HIWORD(pFileInfo->dwFileVersionLS);
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync *pdwRevisionNumber = LOWORD(pFileInfo->dwFileVersionLS);
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync VBoxServiceVerbose(3, "No file version value for file \"%s\" available! (%d / rc=%Rrc)\n",
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync VBoxServiceVerbose(0, "GetFileVersionInfo(%s) -> %u / %Rrc\n", pszFilename, GetLastError(), rc);
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync VBoxServiceVerbose(0, "Failed to allocate %u byte for file version info for '%s'\n", cbVerData, pszFilename);
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync VBoxServiceVerbose(3, "GetFileVersionInfoSize(%s) -> %u / %Rrc\n", pszFilename, GetLastError(), rc);
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * Gets a re-formatted version string from the VS_FIXEDFILEINFO table.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * @returns VBox status code. The output buffer is always valid and the status
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * code can safely be ignored.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * @param pszPath The base path.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * @param pszFilaname The filename.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * @param pszVersion Where to return the version string.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * @param cbVersion The size of the version string buffer. This MUST be
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * at least 2 bytes!
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsyncint VBoxServiceGetFileVersionString(const char *pszPath, const char *pszFilename,
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * We will ALWAYS return with a valid output buffer.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync AssertReturn(cbVersion >= 2, VERR_BUFFER_OVERFLOW);
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync * Create the path and query the bits.
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync int rc = RTPathJoin(szFullPath, sizeof(szFullPath), pszPath, pszFilename);
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync rc = VBoxServiceGetFileVersion(szFullPath, &dwMajor, &dwMinor, &dwBuild, &dwRev);
e794d9028f49f95cf5a9dc4cb9ce2aa2231eac04vboxsync RTStrPrintf(pszVersion, cbVersion, "%u.%u.%ur%u", dwMajor, dwMinor, dwBuild, dwRev);
9b5bf00cddef78a2e5ab748a141ea830ce47abe2vboxsync#endif /* RT_OS_WINDOWS */