Changeset 83309 in vbox for trunk/src/VBox/Main

Timestamp:

Mar 17, 2020 1:54:12 PM (5 years ago)

Author:

vboxsync

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

136482

Message:

Guest Control: Fixes for IGuestSession::directoryExists() + documentation.

Location:

trunk/src/VBox/Main

Files:

• idl/VirtualBox.xidl (modified) (1 diff)
• src-client/GuestSessionImpl.cpp (modified) (4 diffs)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -13449 +13449 @@
       </param>
       <param name="exists" type="boolean" dir="return">
-        <desc>Returns @c true if the directory exists, @c false if not.</desc>
+        <desc>Returns @c true if the directory exists, @c false if not, or is not a directory.</desc>
       </param>
     </method>

trunk/src/VBox/Main/src-client/GuestSessionImpl.cpp

@@ -962 +962 @@
 }
 
+/**
+ * Queries information about a directory on the guest.
+ *
+ * @returns VBox status code, or VERR_NOT_A_DIRECTORY if the file system object exists but is not a directory.
+ * @param   strPath             Path to directory to query information for.
+ * @param   fFollowSymlinks     Whether to follow symlinks or not.
+ * @param   objData             Where to store the information returned on success.
+ * @param   prcGuest            Guest rc, when returning VERR_GSTCTL_GUEST_ERROR.
+ */
 int GuestSession::i_directoryQueryInfo(const Utf8Str &strPath, bool fFollowSymlinks,
                                        GuestFsObjData &objData, int *prcGuest)
@@ -3349 +3358 @@
 HRESULT GuestSession::directoryExists(const com::Utf8Str &aPath, BOOL aFollowSymlinks, BOOL *aExists)
 {
-    AutoCaller autoCaller(this); /** @todo r=bird: GuestSessionWrap.cpp does already, doesn't it? */
-    if (FAILED(autoCaller.rc())) return autoCaller.rc();
-
     if (RT_UNLIKELY(aPath.isEmpty()))
         return setError(E_INVALIDARG, tr("Empty path"));
@@ -3363 +3369 @@
     GuestFsObjData objData;
     int rcGuest = VERR_IPE_UNINITIALIZED_STATUS;
-    /** @todo r=bird: Please look at i_directoryQueryInfo() and explain why there
-     * is an extra FsObjType_Directory check here...
-     *
-     * Looks a lot like you wanted to replicate the RTDirExists behavior, but when
-     * refactoring in i_directoryQueryInfo you lost overview here.   One problem
-     * could be that the documention is VirtualBox.xidl does not mention what
-     * happens when the path leads to a file system object that isn't a
-     * directory.
-     *
-     * Fix the documention and behaviour so it works like RTDirExists and
-     * RTFileExists.  */
+
     int vrc = i_directoryQueryInfo(aPath, aFollowSymlinks != FALSE, objData, &rcGuest);
     if (RT_SUCCESS(vrc))
-        *aExists = objData.mType == FsObjType_Directory;
+        *aExists = TRUE;
     else
     {
@@ -3393 +3389 @@
                         break;
                 }
+                break;
+            }
+
+            case VERR_NOT_A_DIRECTORY:
+            {
+                *aExists = FALSE;
                 break;
             }