/** @file * * VirtualBox COM class implementation extra definitions * * This file pulls in generated entities that may be rather big but rarely * changed. Separating them from VirtualBoxImpl.cpp should speed up * compilation a bit. */ /* * Copyright (C) 2006-2009 Sun Microsystems, Inc. * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; * you can redistribute it and/or modify it under the terms of the GNU * General Public License (GPL) as published by the Free Software * Foundation, in version 2 as it comes in the "COPYING" file of the * VirtualBox OSE distribution. VirtualBox OSE is distributed in the * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. * * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa * Clara, CA 95054 USA or visit http://www.sun.com if you need * additional information or have any questions. */ #include #include "VirtualBoxImpl.h" #include "VirtualBoxImplExtra.h" #include "VirtualBoxXMLUtil.h" /* embedded XML Schema documents for validating XML settings files */ #include "xml_VirtualBox_settings_xsd.h" #include "xml_VirtualBox_settings_common_xsd.h" /* embedded settings converter template for updating settings files */ #include "xml_SettingsConverter_xsl.h" /* embedded VirtualBox element definition that contains a proper 'version' * attribute constraint */ static const unsigned char g_ab_xml_VirtualBox_settings_root_xsd[] = "" "" " " " " " " " " " " " " " " "" ""; static const unsigned g_cb_xml_VirtualBox_settings_root_xsd = sizeof (g_ab_xml_VirtualBox_settings_root_xsd); /** * Resolves external entities while parting and validating XML settings files. * * @param aURI URI of the external entity. * @param aID ID of the external entity (may be NULL). * * @return Input stream created using @c new or NULL to indicate * a wrong URI/ID pair. */ xml::Input * SettingsTreeHelper::resolveEntity (const char *aURI, const char * /* aID */) { if (strcmp (aURI, VBOX_XML_SCHEMA_COMMON) == 0) { return new xml:: MemoryBuf ((const char *) g_ab_xml_VirtualBox_settings_common_xsd, g_cb_xml_VirtualBox_settings_common_xsd, aURI); } if (strcmp (aURI, VBOX_XML_SCHEMA_ROOT) == 0) { return new xml:: MemoryBuf ((const char *) g_ab_xml_VirtualBox_settings_root_xsd, g_cb_xml_VirtualBox_settings_root_xsd, aURI); } if (strcmp (aURI, VBOX_XML_SCHEMA) == 0) { return new xml:: MemoryBuf ((const char *) g_ab_xml_VirtualBox_settings_xsd, g_cb_xml_VirtualBox_settings_xsd, aURI); } if (strcmp (aURI, VBOX_XML_SETTINGS_CONVERTER) == 0) { return new xml:: MemoryBuf ((const char *) g_ab_xml_SettingsConverter_xsl, g_cb_xml_SettingsConverter_xsl, aURI); } AssertMsgFailed (("Unexpected entity: '%s' - knows: '%s' and '%s'\n", aURI, VBOX_XML_SCHEMA_COMMON, VBOX_XML_SCHEMA)); return NULL; } /** * Returns @true if the given tree needs to be converted using the XSLT * template identified by #templateUri(), or @false if no conversion is * required. * * The implementation normally checks for the "version" value of the * root key to determine if the conversion is necessary. When the * @a aOldVersion argument is not NULL, the implementation must return a * non-NULL non-empty string representing the old version (before * conversion) in it this string is used by XmlTreeBackend::oldVersion() * and must be non-NULL to indicate that the conversion has been * performed on the tree. The returned string must be allocated using * RTStrDup() or such. * * This method is called again after the successful transformation to * let the implementation retry the version check and request another * transformation if necessary. This may be used to perform multi-step * conversion like this: 1.1 => 1.2, 1.2 => 1.3 (instead of 1.1 => 1.3) * which saves from the need to update all previous conversion * templates to make each of them convert directly to the recent * version. * * @note Multi-step transformations are performed in a loop that exits * only when this method returns @false. It's up to the * implementation to detect cycling (repeated requests to convert * from the same version) wrong version order, etc. and throw an * EConversionCycle exception to break the loop without returning * @false (which means the transformation succeeded). * * @param aRoot Root settings key. * @param aOldVersionString Where to store old version string * pointer. May be NULL. Allocated memory is * freed by the caller using RTStrFree(). */ bool SettingsTreeHelper:: needsConversion (const settings::Key &aRoot, char **aOldVersion) const { if (strcmp (aRoot.name(), "VirtualBox") == 0) { const char *version = aRoot.stringValue ("version"); const char *dash = strchr (version, '-'); if (dash != NULL && strcmp (dash + 1, VBOX_XML_PLATFORM) == 0) { if (strcmp (version, VBOX_XML_VERSION_FULL) != 0) { /* version mismatch */ if (aOldVersion != NULL) *aOldVersion = RTStrDup (version); return true; } } } /* either the tree is invalid, or it's the other platform, or it's the same * version */ return false; } /** * Returns the URI of the XSLT template to perform the conversion. * This template will be applied to the tree if #needsConversion() * returns @c true for this tree. */ const char* SettingsTreeHelper::templateUri() const { return VBOX_XML_SETTINGS_CONVERTER; } #if defined VBOX_MAIN_SETTINGS_ADDONS // Settings API additions //////////////////////////////////////////////////////////////////////////////// namespace settings { template<> stdx::char_auto_ptr ToString (const com::Bstr &aValue, unsigned int /* aExtra */) { stdx::char_auto_ptr result; if (aValue.raw() == NULL) throw ENoValue(); /* The only way to cause RTUtf16ToUtf8Ex return a number of bytes needed * w/o allocating the result buffer itself is to provide that both cch * and *ppsz are not NULL. */ char dummy [1]; char *dummy2 = dummy; size_t strLen = 1; int vrc = RTUtf16ToUtf8Ex (aValue.raw(), RTSTR_MAX, &dummy2, strLen, &strLen); if (RT_SUCCESS (vrc)) { /* the string only contains '\0' :) */ result.reset (new char [1]); result.get() [0] = '\0'; return result; } if (vrc == VERR_BUFFER_OVERFLOW) { result.reset (new char [strLen + 1]); char *buf = result.get(); vrc = RTUtf16ToUtf8Ex (aValue.raw(), RTSTR_MAX, &buf, strLen + 1, NULL); } if (RT_FAILURE (vrc)) throw xml::LogicError (RT_SRC_POS); return result; } template<> com::Guid FromString (const char *aValue) { if (aValue == NULL) throw ENoValue(); /* For settings, the format is always {XXX...XXX} */ char buf [RTUUID_STR_LENGTH]; if (aValue == NULL || *aValue != '{' || strlen (aValue) != RTUUID_STR_LENGTH + 1 || aValue [RTUUID_STR_LENGTH] != '}') throw ENoConversion(com::Utf8StrFmt("'%s' is not Guid", aValue)); /* strip { and } */ memcpy (buf, aValue + 1, RTUUID_STR_LENGTH - 1); buf [RTUUID_STR_LENGTH - 1] = '\0'; /* we don't use Guid (const char *) because we want to throw * ENoConversion on format error */ RTUUID uuid; int vrc = RTUuidFromStr (&uuid, buf); if (RT_FAILURE (vrc)) throw ENoConversion(com::Utf8StrFmt("'%s' is not Guid (%Rrc)", aValue, vrc)); return com::Guid (uuid); } template<> stdx::char_auto_ptr ToString (const com::Guid &aValue, unsigned int /* aExtra */) { /* For settings, the format is always {XXX...XXX} */ stdx::char_auto_ptr result (new char [RTUUID_STR_LENGTH + 2]); int vrc = RTUuidToStr (aValue.raw(), result.get() + 1, RTUUID_STR_LENGTH); if (RT_FAILURE (vrc)) throw xml::LogicError (RT_SRC_POS); result.get() [0] = '{'; result.get() [RTUUID_STR_LENGTH] = '}'; result.get() [RTUUID_STR_LENGTH + 1] = '\0'; return result; } #endif // VBOX_MAIN_SETTINGS_ADDONS } /* namespace settings */ /* vi: set tabstop=4 shiftwidth=4 expandtab: */