Changeset 42118 in vbox for trunk/src

Timestamp:

Jul 11, 2012 7:43:11 PM (13 years ago)

Author:

vboxsync

Message:

Autostart: Updates, implemented config parser for the autostart daemon

Location:

trunk/src/VBox

Files:

• Frontends/VBoxAutostart/VBoxAutostart.cpp (modified) (11 diffs)
• Main/src-server/generic/AutostartDb-generic.cpp (modified) (1 diff)

trunk/src/VBox/Frontends/VBoxAutostart/VBoxAutostart.cpp

@@ -50 +50 @@
 #include <iprt/system.h>
 #include <iprt/time.h>
+#include <iprt/ctype.h>
 
 
@@ -60 +61 @@
 
 /**
+ * Tokenizer instance data for the config data.
+ */
+typedef struct CFGTOKENIZER
+{
+    /** Config file handle. */
+    PRTSTREAM hStrmConfig;
+    /** String buffer for the current line we are operating in. */
+    char      *pszLine;
+    /** Size of the string buffer. */
+    size_t     cbLine;
+    /** Current position in the line. */
+    char      *pszLineCurr;
+    /** Current line in the config file. */
+    unsigned   iLine;
+} CFGTOKENIZER, *PCFGTOKENIZER;
+
+/**
  * VM list entry.
  */
 typedef struct AUTOSTARTVM
 {
+    /** ID of the VM to start. */
     Bstr  strId;
+    /** Startup delay of the VM. */
     ULONG uStartupDelay;
 } AUTOSTARTVM;
@@ -117 +137 @@
 #define serviceLogVerbose(a) if (g_fVerbose) { serviceLog a; }
 
+/**
+ * Reads the next line from the config stream.
+ *
+ * @returns VBox status code.
+ * @param   pCfgTokenizer    The config tokenizer.
+ */
+static int autostartConfigTokenizerReadNextLine(PCFGTOKENIZER pCfgTokenizer)
+{
+    int rc = VINF_SUCCESS;
+
+    do
+    {
+        rc = RTStrmGetLine(pCfgTokenizer->hStrmConfig, pCfgTokenizer->pszLine,
+                           pCfgTokenizer->cbLine);
+        if (rc == VERR_BUFFER_OVERFLOW)
+        {
+            char *pszTmp;
+
+            pCfgTokenizer->cbLine += 128;
+            pszTmp = (char *)RTMemRealloc(pCfgTokenizer->pszLine, pCfgTokenizer->cbLine);
+            if (pszTmp)
+                pCfgTokenizer->pszLine = pszTmp;
+            else
+                rc = VERR_NO_MEMORY;
+        }
+    } while (rc == VERR_BUFFER_OVERFLOW);
+
+    if (RT_SUCCESS(rc))
+    {
+        pCfgTokenizer->iLine++;
+        pCfgTokenizer->pszLineCurr = pCfgTokenizer->pszLine;
+    }
+
+    return rc;
+}
+
+/**
+ * Creates the config tokenizer from the given filename.
+ *
+ * @returns VBox status code.
+ * @param   pszFilename    Config filename.
+ * @param   ppCfgTokenizer Where to store the pointer to the config tokenizer on
+ *                         success.
+ */
+static int autostartConfigTokenizerCreate(const char *pszFilename, PCFGTOKENIZER *ppCfgTokenizer)
+{
+    int rc = VINF_SUCCESS;
+    PCFGTOKENIZER pCfgTokenizer = (PCFGTOKENIZER)RTMemAllocZ(sizeof(CFGTOKENIZER));
+
+    if (pCfgTokenizer)
+    {
+        pCfgTokenizer->iLine = 1;
+        pCfgTokenizer->cbLine = 128;
+        pCfgTokenizer->pszLine = (char *)RTMemAllocZ(pCfgTokenizer->cbLine);
+        if (pCfgTokenizer->pszLine)
+        {
+            rc = RTStrmOpen(pszFilename, "r", &pCfgTokenizer->hStrmConfig);
+            if (RT_SUCCESS(rc))
+                rc = autostartConfigTokenizerReadNextLine(pCfgTokenizer);
+        }
+        else
+            rc = VERR_NO_MEMORY;
+    }
+    else
+        rc = VERR_NO_MEMORY;
+
+    if (RT_SUCCESS(rc))
+        *ppCfgTokenizer = pCfgTokenizer;
+    else if (   RT_FAILURE(rc)
+             && pCfgTokenizer)
+    {
+        if (pCfgTokenizer->pszLine)
+            RTMemFree(pCfgTokenizer->pszLine);
+        if (pCfgTokenizer->hStrmConfig)
+            RTStrmClose(pCfgTokenizer->hStrmConfig);
+        RTMemFree(pCfgTokenizer);
+    }
+
+    return rc;
+}
+
+/**
+ * Destroys the given config tokenizer.
+ *
+ * @returns nothing.
+ * @param   pCfgTokenizer    The config tokenizer to destroy.
+ */
+static void autostartConfigTokenizerDestroy(PCFGTOKENIZER pCfgTokenizer)
+{
+    if (pCfgTokenizer->pszLine)
+        RTMemFree(pCfgTokenizer->pszLine);
+    if (pCfgTokenizer->hStrmConfig)
+        RTStrmClose(pCfgTokenizer->hStrmConfig);
+    RTMemFree(pCfgTokenizer);
+}
+
+/**
+ * Read the next token from the config file.
+ *
+ * @returns VBox status code.
+ * @param   pCfgTokenizer    The config tokenizer data.
+ * @param   ppszToken        Where to store the start to the next token on success.
+ * @param   pcchToken        Where to store the number of characters of the next token
+ *                           excluding the \0 terminator on success.
+ */
+static int autostartConfigTokenizerReadNext(PCFGTOKENIZER pCfgTokenizer, const char **ppszToken,
+                                            size_t *pcchToken)
+{
+    if (!pCfgTokenizer->pszLineCurr)
+        return VERR_EOF;
+
+    int rc = VINF_SUCCESS;
+
+    for (;;)
+    {
+        char *pszTok = pCfgTokenizer->pszLineCurr;
+
+        /* Skip all spaces. */
+        while (RT_C_IS_BLANK(*pszTok))
+            pszTok++;
+
+        /* Check if we have to read a new line. */
+        if (   *pszTok == '\0'
+            || *pszTok == '#')
+        {
+            rc = autostartConfigTokenizerReadNextLine(pCfgTokenizer);
+            if (RT_FAILURE(rc))
+                break;
+            /* start from the beginning. */
+        }
+        else if (   *pszTok == '='
+                 || *pszTok == ',')
+        {
+            *ppszToken = pszTok;
+            *pcchToken = 1;
+            pCfgTokenizer->pszLineCurr = pszTok + 1;
+            break;
+        }
+        else
+        {
+            /* Get the complete token. */
+            size_t cchToken = 1;
+            char *pszTmp = pszTok + 1;
+
+            while (   RT_C_IS_ALNUM(*pszTmp)
+                   || *pszTmp == '_')
+            {
+                pszTmp++;
+                cchToken++;
+            }
+
+            *ppszToken = pszTok;
+            *pcchToken = cchToken;
+            pCfgTokenizer->pszLineCurr = pszTmp;
+            break;
+        }
+    }
+
+    return rc;
+}
+
+static int autostartConfigTokenizerCheckAndConsume(PCFGTOKENIZER pCfgTokenizer, const char *pszTokCheck)
+{
+    int rc = VINF_SUCCESS;
+    const char *pszToken = NULL;
+    size_t cchToken = 0;
+
+    rc = autostartConfigTokenizerReadNext(pCfgTokenizer, &pszToken, &cchToken);
+    if (RT_SUCCESS(rc))
+    {
+        if (RTStrNCmp(pszToken, pszTokCheck, cchToken))
+        {
+            RTMsgError("Unexpected token at line %d, expected '%s'",
+                       pCfgTokenizer->iLine, pszTokCheck);
+            rc = VERR_INVALID_PARAMETER;
+        }
+    }
+    return rc;
+}
+
+/**
+ * Returns the start of the next token without consuming it.
+ *
+ * @returns VBox status code.
+ * @param   pCfgTokenizer    Tokenizer instance data.
+ * @param   ppszTok          Where to store the start of the next token on success.
+ */
+static int autostartConfigTokenizerPeek(PCFGTOKENIZER pCfgTokenizer, const char **ppszTok)
+{
+    int rc = VINF_SUCCESS;
+
+    for (;;)
+    {
+        char *pszTok = pCfgTokenizer->pszLineCurr;
+
+        /* Skip all spaces. */
+        while (RT_C_IS_BLANK(*pszTok))
+            pszTok++;
+
+        /* Check if we have to read a new line. */
+        if (   *pszTok == '\0'
+            || *pszTok == '#')
+        {
+            rc = autostartConfigTokenizerReadNextLine(pCfgTokenizer);
+            if (RT_FAILURE(rc))
+                break;
+            /* start from the beginning. */
+        }
+        else
+        {
+            *ppszTok = pszTok;
+            break;
+        }
+    }
+
+    return rc;
+}
+
+/**
+ * Check whether the given token is a reserved token.
+ *
+ * @returns true if the token is reserved or false otherwise.
+ * @param   pszToken    The token to check.
+ * @param   cchToken    Size of the token in characters.
+ */
+static bool autostartConfigTokenizerIsReservedToken(const char *pszToken, size_t cchToken)
+{
+    if (   cchToken == 1
+        && (   *pszToken == ','
+            || *pszToken == '='))
+        return true;
+    else if (   cchToken > 1
+             && (   !RTStrNCmp(pszToken, "default_policy", cchToken)
+                 || !RTStrNCmp(pszToken, "exception_list", cchToken)))
+        return true;
+
+    return false;
+}
+
+/**
+ * Parse the given configuration file and return the interesting config parameters.
+ *
+ * @returns VBox status code.
+ * @param   pszFilename    The config file to parse.
+ * @param   pfAllowed      Where to store the flag whether the user of this process
+ *                         is allowed to start VMs automatically during system startup.
+ * @param   puStartupDelay Where to store the startup delay for the user.
+ */
+static int autostartParseConfig(const char *pszFilename, bool *pfAllowed, uint32_t *puStartupDelay)
+{
+    int rc = VINF_SUCCESS;
+    char *pszUserProcess = NULL;
+    bool fDefaultAllow = false;
+    bool fInExceptionList = false;
+
+    AssertPtrReturn(pfAllowed, VERR_INVALID_POINTER);
+    AssertPtrReturn(puStartupDelay, VERR_INVALID_POINTER);
+
+    *pfAllowed = false;
+    *puStartupDelay = 0;
+
+    rc = RTProcQueryUsernameA(RTProcSelf(), &pszUserProcess);
+    if (RT_SUCCESS(rc))
+    {
+        PCFGTOKENIZER pCfgTokenizer = NULL;
+
+        rc = autostartConfigTokenizerCreate(pszFilename, &pCfgTokenizer);
+        if (RT_SUCCESS(rc))
+        {
+            do
+            {
+                size_t cchToken = 0;
+                const char *pszToken = NULL;
+
+                rc = autostartConfigTokenizerReadNext(pCfgTokenizer, &pszToken,
+                                                      &cchToken);
+                if (RT_SUCCESS(rc))
+                {
+                    if (!RTStrNCmp(pszToken, "default_policy", strlen("default_policy")))
+                    {
+                        rc = autostartConfigTokenizerCheckAndConsume(pCfgTokenizer, "=");
+                        if (RT_SUCCESS(rc))
+                        {
+                            rc = autostartConfigTokenizerReadNext(pCfgTokenizer, &pszToken,
+                                                                  &cchToken);
+                            if (RT_SUCCESS(rc))
+                            {
+                                if (!RTStrNCmp(pszToken, "allow", strlen("allow")))
+                                    fDefaultAllow = true;
+                                else if (!RTStrNCmp(pszToken, "deny", strlen("deny")))
+                                    fDefaultAllow = false;
+                                else
+                                {
+                                    RTMsgError("Unexpected token at line %d, expected either 'allow' or 'deny'",
+                                               pCfgTokenizer->iLine);
+                                    rc = VERR_INVALID_PARAMETER;
+                                    break;
+                                }
+                            }
+                        }
+                    }
+                    else if (!RTStrNCmp(pszToken, "exception_list", strlen("exception_list")))
+                    {
+                        rc = autostartConfigTokenizerCheckAndConsume(pCfgTokenizer, "=");
+                        if (RT_SUCCESS(rc))
+                        {
+                            rc = autostartConfigTokenizerReadNext(pCfgTokenizer, &pszToken,
+                                                                  &cchToken);
+
+                            while (RT_SUCCESS(rc))
+                            {
+                                if (autostartConfigTokenizerIsReservedToken(pszToken, cchToken))
+                                {
+                                    RTMsgError("Unexpected token at line %d, expected a username",
+                                               pCfgTokenizer->iLine);
+                                    rc = VERR_INVALID_PARAMETER;
+                                    break;
+                                }
+                                else if (!RTStrNCmp(pszUserProcess, pszToken, strlen(pszUserProcess)))
+                                    fInExceptionList = true;
+
+                                /* Skip , */
+                                rc = autostartConfigTokenizerPeek(pCfgTokenizer, &pszToken);
+                                if (   RT_SUCCESS(rc)
+                                    && *pszToken == ',')
+                                {
+                                    rc = autostartConfigTokenizerCheckAndConsume(pCfgTokenizer, ",");
+                                    AssertRC(rc);
+                                }
+                                else if (RT_SUCCESS(rc))
+                                    break;
+
+                                rc = autostartConfigTokenizerReadNext(pCfgTokenizer, &pszToken,
+                                                                      &cchToken);
+                            }
+
+                            if (rc == VERR_EOF)
+                                rc = VINF_SUCCESS;
+                        }
+                    }
+                    else if (!autostartConfigTokenizerIsReservedToken(pszToken, cchToken))
+                    {
+                        /* Treat as 'username = <base delay in seconds>. */
+                        rc = autostartConfigTokenizerCheckAndConsume(pCfgTokenizer, "=");
+                        if (RT_SUCCESS(rc))
+                        {
+                            size_t cchDelay = 0;
+                            const char *pszDelay = NULL;
+
+                            rc = autostartConfigTokenizerReadNext(pCfgTokenizer, &pszDelay,
+                                                                  &cchDelay);
+                            if (RT_SUCCESS(rc))
+                            {
+                                uint32_t uDelay = 0;
+
+                                rc = RTStrToUInt32Ex(pszDelay, NULL, 10, &uDelay);
+                                if (rc == VWRN_TRAILING_SPACES)
+                                    rc = VINF_SUCCESS;
+
+                                if (   RT_SUCCESS(rc)
+                                    && !RTStrNCmp(pszUserProcess, pszToken, strlen(pszUserProcess)))
+                                        *puStartupDelay = uDelay;
+
+                                if (RT_FAILURE(rc))
+                                    RTMsgError("Unexpected token at line %d, expected a number",
+                                               pCfgTokenizer->iLine);
+                            }
+                        }
+                    }
+                    else
+                    {
+                        RTMsgError("Unexpected token at line %d, expected a username",
+                                   pCfgTokenizer->iLine);
+                        rc = VERR_INVALID_PARAMETER;
+                    }
+                }
+                else if (rc == VERR_EOF)
+                {
+                    rc = VINF_SUCCESS;
+                    break;
+                }
+            } while (RT_SUCCESS(rc));
+
+            if (   RT_SUCCESS(rc)
+                && (   (fDefaultAllow && !fInExceptionList)
+                    || (!fDefaultAllow && fInExceptionList)))
+                *pfAllowed= true;
+
+            autostartConfigTokenizerDestroy(pCfgTokenizer);
+        }
+
+        RTStrFree(pszUserProcess);
+    }
+
+    return rc;
+}
+
 static DECLCALLBACK(bool) autostartVMCmp(const AUTOSTARTVM &vm1, const AUTOSTARTVM &vm2)
 {
@@ -127 +544 @@
  * @returns exit status code.
  */
-static RTEXITCODE autostartMain(void)
+static RTEXITCODE autostartMain(uint32_t uStartupDelay)
 {
     RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
+    int vrc = VINF_SUCCESS;
     std::list<AUTOSTARTVM> listVM;
+
+    if (uStartupDelay)
+    {
+        serviceLogVerbose(("Delay starting for %d seconds ...\n", uStartupDelay));
+        vrc = RTThreadSleep(uStartupDelay * 1000);
+    }
+
+    if (vrc == VERR_INTERRUPTED)
+        return RTEXITCODE_SUCCESS;
 
     /*
@@ -169 +596 @@
             && listVM.size())
         {
+            ULONG uDelayCurr = 0;
+
             /* Sort by startup delay and apply base override. */
             listVM.sort(autostartVMCmp);
@@ -178 +607 @@
                 ComPtr<IProgress> progress;
 
+                if ((*it).uStartupDelay > uDelayCurr)
+                {
+                    serviceLogVerbose(("Delay starting of the next VMs for %d seconds ...\n",
+                                       (*it).uStartupDelay - uDelayCurr));
+                    RTThreadSleep(((*it).uStartupDelay - uDelayCurr) * 1000);
+                    uDelayCurr = (*it).uStartupDelay;
+                }
+
                 CHECK_ERROR_BREAK(g_pVirtualBox, FindMachine((*it).strId.raw(),
                                                              machine.asOutParam()));
@@ -185 +622 @@
                 if (SUCCEEDED(rc) && !progress.isNull())
                 {
-                    RTPrintf("Waiting for VM \"%ls\" to power on...\n", (*it).strId.raw());
+                    serviceLogVerbose(("Waiting for VM \"%ls\" to power on...\n", (*it).strId.raw()));
                     CHECK_ERROR(progress, WaitForCompletion(-1));
                     if (SUCCEEDED(rc))
@@ -205 +642 @@
                                 }
                                 else
-                                {
-                                    RTPrintf("VM \"%ls\" has been successfully started.\n", (*it).strId.raw());
-                                }
+                                    serviceLogVerbose(("VM \"%ls\" has been successfully started.\n", (*it).strId.raw()));
                             }
                         }
@@ -273 +708 @@
                 break;
 #endif
-            case 'P':
-                pcszDescr = "Name of the PID file which is created when the daemon was started.";
-                break;
 
             case 'F':
@@ -427 +859 @@
     }
 
+    if (!pszConfigFile)
+    {
+        displayHelp(argv[0]);
+        return RTMsgErrorExit(RTEXITCODE_FAILURE, "--config <config file> is missing");
+    }
+
     if (!fQuiet)
         displayHeader();
+
+    bool fAllowed = false;
+    uint32_t uStartupDelay = 0;
+    rc = autostartParseConfig(pszConfigFile, &fAllowed, &uStartupDelay);
+    if (RT_FAILURE(rc))
+        return RTEXITCODE_FAILURE;
+
+    if (!fAllowed)
+        return RTMsgErrorExit(RTEXITCODE_FAILURE, "User is not allowed to autostart VMs");
 
     /* create release logger, to stdout */
@@ -509 +956 @@
         return RTEXITCODE_FAILURE;
 
-    RTEXITCODE rcExit = autostartMain();
+    RTEXITCODE rcExit = autostartMain(uStartupDelay);
 
     EventQueue::getMainEventQueue()->processEventQueue(0);

trunk/src/VBox/Main/src-server/generic/AutostartDb-generic.cpp

@@ -54 +54 @@
         if (fAddVM)
             fOpen |= RTFILE_O_OPEN_CREATE;
+        else
+            fOpen |= RTFILE_O_OPEN;
 
         rc = RTStrAPrintf(&pszFile, "%s/%s.%s",