Changeset 86274 in vbox

Timestamp:

Sep 24, 2020 7:52:56 PM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

140550

Message:

bugref:9781. New function Unattended::i_getDetectedOSVersion(). New function UnattendedScriptTemplate::getGuestOSConditional(). New placeholders @@VBOX_GUEST_OS_COND_VERSION@@, @@VBOX_INSERT_GUEST_OS_VERSION@@, @@VBOX_INSERT_GUEST_OS_MAJOR_VERSION@@.

Location:

trunk/src/VBox/Main

Files:

• include/UnattendedImpl.h (modified) (1 diff)
• include/UnattendedScript.h (modified) (1 diff)
• src-server/UnattendedImpl.cpp (modified) (1 diff)
• src-server/UnattendedScript.cpp (modified) (11 diffs)

trunk/src/VBox/Main/include/UnattendedImpl.h

@@ -78 +78 @@
     bool           i_isGuestOs64Bit() const;
     VBOXOSTYPE     i_getGuestOsType() const;
+    Utf8Str const &i_getDetectedOSVersion();
 
 

trunk/src/VBox/Main/include/UnattendedScript.h

@@ -95 +95 @@
      */
     virtual HRESULT getConditional(const char *pachPlaceholder, size_t cchPlaceholder, bool *pfOutputting);
+
+
+    /**
+     * Get the result of a conditional for special version of guest OS.
+     *
+     * @returns COM status code.
+     * @param   pachPlaceholder     The placholder string.  Not zero terminated.
+     * @param   cchPlaceholder      The length of the placeholder.
+     * @param   cchContent          The length of placeholder content.
+     * @param   pcchCorrect         The length of part which must be excluded from the final content of
+     *                              the placeholder.
+     * @param   pfOutputting        Where to return the result of the conditional.
+     *                              This holds the current outputting state on input
+     *                              in case someone want to sanity check anything.
+     */
+    virtual HRESULT getGuestOSConditional(const char *pachPlaceholder,
+                                          size_t cchPlaceholder,
+                                          size_t cchContent,
+                                          size_t *pcchCorrect,
+                                          bool *pfOutputting);
 };
 

trunk/src/VBox/Main/src-server/UnattendedImpl.cpp

@@ -2682 +2682 @@
 }
 
+Utf8Str const & Unattended::i_getDetectedOSVersion()
+{
+    Assert(isReadLockedOnCurrentThread());
+    return mStrDetectedOSVersion;
+}
+
 HRESULT Unattended::i_attachImage(UnattendedInstallationDisk const *pImage, ComPtr<IMachine> const &rPtrSessionMachine,
                                   AutoMultiWriteLock2 &rLock)

trunk/src/VBox/Main/src-server/UnattendedScript.cpp

@@ -59 +59 @@
     static const char s_szPrefixCond[]     = "@@VBOX_COND_";
     static const char s_szPrefixCondEnd[]  = "@@VBOX_COND_END@@";
+    static const char s_szPrefixCondGuestOs[]     = "@@VBOX_GUEST_OS_COND_";
+    static const char s_szPrefixCondGuestOsEnd[]  = "@@VBOX_GUEST_OS_COND_END@@";
 
     struct
@@ -69 +71 @@
     size_t      offTemplate = 0;
     size_t      cchTemplate = mStrScriptFullContent.length();
+    size_t      cchInternalCorrect = 0;//used in logic handling the placeholder @@VBOX_GUEST_OS_COND_XXX@@
     rStrDst.setNull();
     for (;;)
@@ -83 +86 @@
                 try
                 {
-                    rStrDst.append(mStrScriptFullContent, offTemplate, cchToCopy);
+                    rStrDst.append(mStrScriptFullContent, offTemplate + cchInternalCorrect, cchToCopy - + cchInternalCorrect);
                 }
                 catch (std::bad_alloc &)
@@ -92 +95 @@
             }
             offTemplate += cchToCopy;
+            cchInternalCorrect = 0;//don't forget to reset
         }
 
@@ -124 +128 @@
                 || pszPlaceholder[cchPlaceholder - 2] != '@'
                 || (   strncmp(pszPlaceholder, s_szPrefixInsert, sizeof(s_szPrefixInsert) - 1) != 0
-                    && strncmp(pszPlaceholder, s_szPrefixCond,   sizeof(s_szPrefixCond)   - 1) != 0) )
+                    && strncmp(pszPlaceholder, s_szPrefixCond,   sizeof(s_szPrefixCond)   - 1) != 0
+                    && strncmp(pszPlaceholder, s_szPrefixCondGuestOs,   sizeof(s_szPrefixCondGuestOs) - 1) != 0) )
             {
                 hrc = mpSetError->setError(E_FAIL, mpSetError->tr("Malformed template placeholder '%.*s'"),
@@ -136 +141 @@
              * @@VBOX_INSERT_XXX@@:
              */
-            if (strncmp(pszPlaceholder, s_szPrefixInsert, sizeof(s_szPrefixInsert) - 1) == 0)
+            if ( strncmp(pszPlaceholder, s_szPrefixInsert, sizeof(s_szPrefixInsert) - 1) == 0 )
             {
                 /*
@@ -164 +169 @@
              * @@VBOX_COND_END@@: Pop one item of the conditional stack.
              */
-            else if (   cchPlaceholder == sizeof(s_szPrefixCondEnd) - 1U
-                     && strncmp(pszPlaceholder, s_szPrefixCondEnd, sizeof(s_szPrefixCondEnd) - 1U) == 0)
+            else if ( strncmp(pszPlaceholder, s_szPrefixCondEnd, sizeof(s_szPrefixCondEnd) - 1U) == 0 )
             {
                 if (cConds > 0)
@@ -184 +188 @@
              *                    one from the condition.
              */
-            else
-            {
-                Assert(strncmp(pszPlaceholder, s_szPrefixCond, sizeof(s_szPrefixCond) - 1) == 0);
+            else if ( strncmp(pszPlaceholder, s_szPrefixCond, sizeof(s_szPrefixCond) - 1U) == 0 )
+            {
                 if (cConds + 1 < RT_ELEMENTS(aConds))
                 {
@@ -192 +195 @@
                     bool fNewOutputting = fOutputting;
                     hrc = getConditional(pszPlaceholder, cchPlaceholder, &fNewOutputting);
+                    if (SUCCEEDED(hrc))
+                        fOutputting = fOutputting && fNewOutputting;
+                    else
+                        break;
+                    cConds++;
+                }
+                else
+                {
+                    hrc = mpSetError->setErrorBoth(E_FAIL, VERR_PARSE_ERROR,
+                                                   mpSetError->tr("Too deep conditional nesting at offset %zu (%#zx)"),
+                                                   offPlaceholder, offPlaceholder);
+                    break;
+                }
+            }
+            /*
+             * @@VBOX_GUEST_OS_COND_END@@: Pop one item of the conditional stack.
+             */
+            else if ( strncmp(pszPlaceholder, s_szPrefixCondGuestOsEnd, sizeof(s_szPrefixCondGuestOsEnd) - 1U) == 0 )
+            {
+                if (cConds > 0)
+                {
+                    cConds--;
+                    fOutputting = aConds[cConds].fSavedOutputting;
+                }
+                else
+                {
+                    hrc = mpSetError->setErrorBoth(E_FAIL, VERR_PARSE_ERROR,
+                                                   mpSetError->tr("%s without @@VBOX_GUEST_OS_COND_XXX@@ at offset %zu (%#zx)"),
+                                                   s_szPrefixCondGuestOsEnd, offPlaceholder, offPlaceholder);
+                    break;
+                }
+            }
+            /*
+             * @@VBOX_GUEST_OS_COND_XXX@@: Push the previous outputting state and combine it with the
+             *                             one from the condition.
+             */
+            else
+            {
+                Assert(strncmp(pszPlaceholder, s_szPrefixCondGuestOs, sizeof(s_szPrefixCondGuestOs) - 1) == 0);
+                if (cConds + 1 < RT_ELEMENTS(aConds))
+                {
+                    aConds[cConds].fSavedOutputting = fOutputting;
+                    bool fNewOutputting = fOutputting;
+
+                    //offTemplate is the beginning of content, offEndContent is the end of content
+                    //@@PLACEHOLDER_BEGIN@@Content@@PLACEHOLDER_END@@
+                    //                 ^       ^
+                    //                 |       |
+                    //         offTemplate  offEndContent
+                    size_t offEndContent = mStrScriptFullContent.find(s_szPrefix, offTemplate);
+                    size_t cchContent = offEndContent - offTemplate - 1;
+                    hrc = getGuestOSConditional(pszPlaceholder, cchPlaceholder, cchContent, &cchInternalCorrect, &fNewOutputting);
                     if (SUCCEEDED(hrc))
                         fOutputting = fOutputting && fNewOutputting;
@@ -379 +434 @@
     else if (IS_PLACEHOLDER_MATCH("OS_ARCH6"))
         rValue = mpUnattended->i_isGuestOs64Bit() ? "x86_64" : "i686";
+    else if (IS_PLACEHOLDER_MATCH("GUEST_OS_VERSION"))
+        rValue = mpUnattended->i_getDetectedOSVersion();
+    else if (IS_PLACEHOLDER_MATCH("GUEST_OS_MAJOR_VERSION"))
+    {
+        Utf8Str strOsVer(mpUnattended->i_getDetectedOSVersion());
+        RTCList<RTCString> partList = strOsVer.split(".");
+        if (partList.size() < 1)
+        {
+            rValue.setNull();
+            return mpSetError->setErrorBoth(E_FAIL, VERR_NOT_FOUND, mpSetError->tr("Unknown guest OS major version '%s'"),
+                                            partList.at(0).c_str());
+        }
+        rValue = partList.at(0);
+    }
     else if (IS_PLACEHOLDER_MATCH("TIME_ZONE_UX"))
         rValue = mpUnattended->i_getTimeZoneInfo()
@@ -426 +495 @@
                                         cchFullPlaceholder, pachPlaceholder);
     }
+    return S_OK;
+#undef IS_PLACEHOLDER_MATCH
+}
+
+HRESULT UnattendedScriptTemplate::getGuestOSConditional(const char *pachPlaceholder,
+                                                        size_t cchPlaceholder,
+                                                        size_t cchContent,
+                                                        size_t *cchCorrect,
+                                                        bool *pfOutputting)
+{
+#define IS_PLACEHOLDER_MATCH(a_szMatch) \
+        (   cchPlaceholder == sizeof("@@VBOX_GUEST_OS_COND_" a_szMatch "@@") - 1U \
+         && memcmp(pachPlaceholder, "@@VBOX_GUEST_OS_COND_" a_szMatch "@@", sizeof("@@VBOX_GUEST_OS_COND_" a_szMatch "@@") - 1U) == 0)
+
+    if ( IS_PLACEHOLDER_MATCH("VERSION") )
+    {
+        Utf8Str strT(pachPlaceholder + cchPlaceholder, cchContent);
+        RTCList<RTCString> partList = strT.split("**");
+        Utf8Str strRequiredOSVersion;
+        if (partList.size() == 2)//when the version is placed together with the placeholder in one line in the file
+        {
+            //The case when the string has been splitted on the 2 parts:
+            //1. OS version
+            //2. Actual content
+            strRequiredOSVersion.assign(partList.at(0));
+            //cchCorrect = "**" + length of OS version string + "**"
+            *cchCorrect = 2 + partList.at(0).length() + 2;// must be subtracted from the cchContent
+        }
+        else if (partList.size() == 3)//when the version is placed on a standalone line in the file
+        {
+            //The case when the string has been splitted on the 3 parts:
+            //1. Empty string or string with only "\n"
+            //2. OS version
+            //3. Actual content
+            strRequiredOSVersion.assign(partList.at(1));
+            *cchCorrect = 2 + partList.at(0).length() + partList.at(1).length() + 2;// must be subtracted from the cchContent
+        }
+        else//case with wrong string syntax
+        {
+            *cchCorrect = 0;
+            *pfOutputting = false;
+            LogRel(("Malformed content of the template @@VBOX_GUEST_OS_COND_VERSION@@\n"));
+            return S_OK;
+        }
+
+        if (strRequiredOSVersion.isEmpty())
+            *pfOutputting = false;
+        else
+        {
+            Utf8Str strDetectedOSVersion = mpUnattended->i_getDetectedOSVersion();
+            RTCList<RTCString> partListRequired = strRequiredOSVersion.split(".");
+            RTCList<RTCString> partListDetected = strDetectedOSVersion.split(".");
+            *pfOutputting = false;//initially is set to "false"
+
+            /** @todo r=vvp: Should we check the string with a requested OS version for digits?
+             *        (with RTLocCIsDigit()) */
+            //Major version must be presented
+            if ( partListDetected.at(0).toUInt32() >= partListRequired.at(0).toUInt32() )//comparison major versions
+            {
+                //OS major versions are equal or detected guest OS major version is greater. Go further.
+                if (partListDetected.size() > 1 && partListRequired.size() > 1)//comparison minor versions
+                {
+                    if (partListDetected.at(1).toUInt32() >= partListRequired.at(1).toUInt32())
+                        //OS minor versions are equal or detected guest OS minor version is greater. Go further.
+                        *pfOutputting = true;
+                    else
+                        //The detected guest OS minor version is less than the requested one.
+                        *pfOutputting = false;
+                }
+                else
+                    //OS minor versions are absent.
+                    *pfOutputting = true;
+            }
+            else
+                //The detected guest OS major version is less than the requested one.
+                *pfOutputting = false;
+        }
+    }
+    else
+        return mpSetError->setErrorBoth(E_FAIL, VERR_NOT_FOUND, mpSetError->tr("Unknown conditional placeholder '%.*s'"),
+                                        cchPlaceholder, pachPlaceholder);
     return S_OK;
 #undef IS_PLACEHOLDER_MATCH