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

Timestamp:

Oct 15, 2019 4:37:37 PM (5 years ago)

Author:

vboxsync

Message:

Shared Clipboard/Transfers: Added IMachine::clipboardFileTransfersEnabled attribute (getter/setter) for enabling/disabling the feature. Disabled by default.

Location:

trunk/src/VBox/Main

Files:

• idl/VirtualBox.xidl (modified) (5 diffs)
• include/ConsoleImpl.h (modified) (2 diffs)
• include/MachineImpl.h (modified) (4 diffs)
• include/SessionImpl.h (modified) (1 diff)
• src-client/ConsoleImpl.cpp (modified) (2 diffs)
• src-client/SessionImpl.cpp (modified) (1 diff)
• src-server/MachineImpl.cpp (modified) (6 diffs)
• xml/Settings.cpp (modified) (4 diffs)

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

@@ -5853 +5853 @@
   <interface
     name="IMachine" extends="$unknown"
-    uuid="13a7c7cb-02fd-4962-a578-5660a5035776"
+    uuid="0020076B-00D0-494E-0023-C293000086A7"
     wsmap="managed"
     wrap-hint-server-addinterfaces="IInternalMachineControl"
@@ -6404 +6404 @@
         Synchronization mode between the host OS clipboard
         and the guest OS clipboard.
+      </desc>
+    </attribute>
+
+    <attribute name="clipboardFileTransfersEnabled" type="boolean">
+      <desc>
+        Sets or retrieves whether clipboard file transfers are allowed or not.
+
+        When set to @a true, clipboard file transfers between supported
+        host and guest OSes are allowed.
       </desc>
     </attribute>
@@ -21775 +21784 @@
       <param name="clipboardMode" type="ClipboardMode" dir="in">
         <desc>The new shared clipboard mode.</desc>
+      </param>
+    </method>
+
+    <method name="onClipboardFileTransferModeChange">
+      <desc>
+        Notification when the shared clipboard file transfers mode changes.
+      </desc>
+      <param name="enabled" type="boolean" dir="in">
+        <desc>Flag whether clipboard file transfers are allowed or not.</desc>
       </param>
     </method>
@@ -24082 +24100 @@
       </desc>
     </const>
+    <const name="OnClipboardFileTransferModeChanged" value="104">
+      <desc>
+        See <link to="IClipboardFileTransferModeChangedEvent">IClipboardFileTransferModeChangedEvent</link>.
+      </desc>
+    </const>
     <!-- End event marker -->
     <!-- @todo rename to 'End' as it is exclusive (we use 'last' to be inclusive). -->
-    <const name="Last" value="104">
+    <const name="Last" value="105">
       <desc>
         Must be last event, used for iterations and structures relying on numerical event values.
@@ -24903 +24926 @@
       <desc>
         The new clipboard mode.
+      </desc>
+    </attribute>
+  </interface>
+
+  <interface
+    name="IClipboardFileTransferModeChangedEvent" extends="IEvent"
+    uuid="00391758-00B1-4E9D-0000-11FA00F9D583"
+    wsmap="managed" autogen="VBoxEvent" id="OnClipboardFileTransferModeChanged"
+    >
+    <desc>
+      Notification when the shared clipboard file transfer mode changes.
+    </desc>
+    <attribute name="enabled" type="boolean" readonly="yes">
+      <desc>
+        Whether file transfers are allowed or not.
       </desc>
     </attribute>

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

@@ -190 +190 @@
     HRESULT i_onCPUExecutionCapChange(ULONG aExecutionCap);
     HRESULT i_onClipboardModeChange(ClipboardMode_T aClipboardMode);
+    HRESULT i_onClipboardFileTransferModeChange(bool aEnabled);
     HRESULT i_onDnDModeChange(DnDMode_T aDnDMode);
     HRESULT i_onVRDEServerChange(BOOL aRestart);
@@ -773 +774 @@
 
     int i_changeClipboardMode(ClipboardMode_T aClipboardMode);
+    int i_changeClipboardFileTransferMode(bool aEnabled);
     int i_changeDnDMode(DnDMode_T aDnDMode);
 

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

@@ -311 +311 @@
 
         ClipboardMode_T     mClipboardMode;
+        BOOL                mClipboardFileTransfersEnabled;
+
         DnDMode_T           mDnDMode;
 
@@ -528 +530 @@
     virtual HRESULT i_onVMProcessPriorityChange(VMProcPriority_T /* aPriority */) { return S_OK; }
     virtual HRESULT i_onClipboardModeChange(ClipboardMode_T /* aClipboardMode */) { return S_OK; }
+    virtual HRESULT i_onClipboardFileTransferModeChange(BOOL /* aEnable */) { return S_OK; }
     virtual HRESULT i_onDnDModeChange(DnDMode_T /* aDnDMode */) { return S_OK; }
     virtual HRESULT i_onBandwidthGroupChange(IBandwidthGroup * /* aBandwidthGroup */) { return S_OK; }
@@ -929 +932 @@
     HRESULT getClipboardMode(ClipboardMode_T *aClipboardMode);
     HRESULT setClipboardMode(ClipboardMode_T aClipboardMode);
+    HRESULT getClipboardFileTransfersEnabled(BOOL *aEnabled);
+    HRESULT setClipboardFileTransfersEnabled(BOOL aEnabled);
     HRESULT getDnDMode(DnDMode_T *aDnDMode);
     HRESULT setDnDMode(DnDMode_T aDnDMode);
@@ -1345 +1350 @@
     HRESULT i_onSharedFolderChange();
     HRESULT i_onClipboardModeChange(ClipboardMode_T aClipboardMode);
+    HRESULT i_onClipboardFileTransferModeChange(BOOL aEnable);
     HRESULT i_onDnDModeChange(DnDMode_T aDnDMode);
     HRESULT i_onBandwidthGroupChange(IBandwidthGroup *aBandwidthGroup);

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

@@ -101 +101 @@
     HRESULT onVMProcessPriorityChange(VMProcPriority_T priority);
     HRESULT onClipboardModeChange(ClipboardMode_T aClipboardMode);
+    HRESULT onClipboardFileTransferModeChange(BOOL aEnabled);
     HRESULT onDnDModeChange(DnDMode_T aDndMode);
     HRESULT onCPUChange(ULONG aCpu,

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

@@ -5374 +5374 @@
         alock.release();
         fireClipboardModeChangedEvent(mEventSource, aClipboardMode);
+    }
+
+    LogFlowThisFunc(("Leaving rc=%#x\n", rc));
+    return rc;
+}
+
+/**
+ * Called by IInternalSessionControl::OnClipboardFileTransferModeChange().
+ *
+ * @note Locks this object for writing.
+ */
+HRESULT Console::i_onClipboardFileTransferModeChange(bool aEnabled)
+{
+    LogFlowThisFunc(("\n"));
+
+    AutoCaller autoCaller(this);
+    AssertComRCReturnRC(autoCaller.rc());
+
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    HRESULT rc = S_OK;
+
+    /* don't trigger the change if the VM isn't running */
+    SafeVMPtrQuiet ptrVM(this);
+    if (ptrVM.isOk())
+    {
+        if (   mMachineState == MachineState_Running
+            || mMachineState == MachineState_Teleporting
+            || mMachineState == MachineState_LiveSnapshotting)
+        {
+            int vrc = i_changeClipboardFileTransferMode(aEnabled);
+            if (RT_FAILURE(vrc))
+                rc = E_FAIL; /** @todo r=andy Set error info here? */
+        }
+        else
+            rc = i_setInvalidMachineStateError();
+        ptrVM.release();
+    }
+
+    /* notify console callbacks on success */
+    if (SUCCEEDED(rc))
+    {
+        alock.release();
+        fireClipboardFileTransferModeChangedEvent(mEventSource, aEnabled ? TRUE : FALSE);
     }
 
@@ -9285 +9329 @@
 
 /**
+ * Changes the clipboard file transfer mode.
+ *
+ * @returns VBox status code.
+ * @param   aEnabled    Whether clipboard file transfers are enabled or not.
+ */
+int Console::i_changeClipboardFileTransferMode(bool aEnabled)
+{
+#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
+    VMMDev *pVMMDev = m_pVMMDev;
+    AssertPtrReturn(pVMMDev, VERR_INVALID_POINTER);
+
+    VBOXHGCMSVCPARM parm;
+    RT_ZERO(parm);
+
+    parm.type     = VBOX_HGCM_SVC_PARM_32BIT;
+    parm.u.uint32 = aEnabled ? VBOX_SHCL_TRANSFER_MODE_ENABLED : VBOX_SHCL_TRANSFER_MODE_DISABLED;
+
+    int vrc = pVMMDev->hgcmHostCall("VBoxSharedClipboard", VBOX_SHCL_HOST_FN_SET_TRANSFER_MODE, 1 /* cParms */, &parm);
+    if (RT_FAILURE(vrc))
+        LogRel(("Shared Clipboard: Error changing file transfer mode: %Rrc\n", vrc));
+
+    return vrc;
+#else
+    RT_NOREF(aEnabled);
+    return VERR_NOT_IMPLEMENTED;
+#endif
+}
+
+/**
  * Changes the drag and drop mode.
  *

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

@@ -811 +811 @@
 }
 
+HRESULT Session::onClipboardFileTransferModeChange(BOOL aEnabled)
+{
+    LogFlowThisFunc(("\n"));
+
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+    AssertReturn(mState == SessionState_Locked, VBOX_E_INVALID_VM_STATE);
+    AssertReturn(mType == SessionType_WriteLock, VBOX_E_INVALID_OBJECT_STATE);
+#ifndef VBOX_COM_INPROC_API_CLIENT
+    AssertReturn(mConsole, VBOX_E_INVALID_OBJECT_STATE);
+
+    return mConsole->i_onClipboardFileTransferModeChange(RT_BOOL(aEnabled));
+#else
+    RT_NOREF(aEnabled);
+    return S_OK;
+#endif
+}
+
 HRESULT Session::onDnDModeChange(DnDMode_T aDndMode)
 {

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

@@ -86 +86 @@
 # include <VBox/HostServices/GuestPropertySvc.h>
 # include <VBox/com/array.h>
+#endif
+
+#ifdef VBOX_WITH_SHARED_CLIPBOARD
+# include <VBox/HostServices/VBoxClipboardSvc.h>
 #endif
 
@@ -214 +218 @@
         mBootOrder[i] = DeviceType_Null;
 
-    mClipboardMode = ClipboardMode_Disabled;
+    mClipboardMode                 = ClipboardMode_Disabled;
+    mClipboardFileTransfersEnabled = FALSE;
+
     mDnDMode = DnDMode_Disabled;
 
@@ -2734 +2740 @@
 }
 
+HRESULT Machine::getClipboardFileTransfersEnabled(BOOL *aEnabled)
+{
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    *aEnabled = mHWData->mClipboardFileTransfersEnabled;
+
+    return S_OK;
+}
+
+HRESULT Machine::setClipboardFileTransfersEnabled(BOOL aEnabled)
+{
+    HRESULT rc = S_OK;
+
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    alock.release();
+    rc = i_onClipboardFileTransferModeChange(aEnabled);
+    alock.acquire();
+    if (FAILED(rc)) return rc;
+
+    i_setModified(IsModified_MachineData);
+    mHWData.backup();
+    mHWData->mClipboardFileTransfersEnabled = aEnabled;
+
+    /** Save settings if online - @todo why is this required? -- @bugref{6818} */
+    if (Global::IsOnline(mData->mMachineState))
+        i_saveSettings(NULL);
+
+    return S_OK;
+}
+
 HRESULT Machine::getDnDMode(DnDMode_T *aDnDMode)
 {
@@ -8981 +9018 @@
 
         // Clipboard
-        mHWData->mClipboardMode = data.clipboardMode;
+        mHWData->mClipboardMode                 = data.clipboardMode;
+        mHWData->mClipboardFileTransfersEnabled = data.fClipboardFileTransfersEnabled ? TRUE : FALSE;
 
         // drag'n'drop
@@ -10284 +10322 @@
 
         // clipboard
-        data.clipboardMode = mHWData->mClipboardMode;
+        data.clipboardMode                  = mHWData->mClipboardMode;
+        data.fClipboardFileTransfersEnabled = RT_BOOL(mHWData->mClipboardFileTransfersEnabled);
 
         // drag'n'drop
@@ -14266 +14305 @@
  * @note Locks this object for reading.
  */
+HRESULT SessionMachine::i_onClipboardFileTransferModeChange(BOOL aEnable)
+{
+    LogFlowThisFunc(("\n"));
+
+    AutoCaller autoCaller(this);
+    AssertComRCReturnRC(autoCaller.rc());
+
+    ComPtr<IInternalSessionControl> directControl;
+    {
+        AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+        if (mData->mSession.mLockType == LockType_VM)
+            directControl = mData->mSession.mDirectControl;
+    }
+
+    /* ignore notifications sent after #OnSessionEnd() is called */
+    if (!directControl)
+        return S_OK;
+
+    return directControl->OnClipboardFileTransferModeChange(aEnable);
+}
+
+/**
+ * @note Locks this object for reading.
+ */
 HRESULT SessionMachine::i_onDnDModeChange(DnDMode_T aDnDMode)
 {

trunk/src/VBox/Main/xml/Settings.cpp

@@ -3234 +3234 @@
     fEmulatedUSBCardReader(false),
     clipboardMode(ClipboardMode_Disabled),
+    fClipboardFileTransfersEnabled(false),
     dndMode(DnDMode_Disabled),
     ulMemoryBalloonSize(0),
@@ -3327 +3328 @@
 {
     return (this == &h)
-        || (   strVersion                == h.strVersion
-            && uuid                      == h.uuid
-            && fHardwareVirt             == h.fHardwareVirt
-            && fNestedPaging             == h.fNestedPaging
-            && fLargePages               == h.fLargePages
-            && fVPID                     == h.fVPID
-            && fUnrestrictedExecution    == h.fUnrestrictedExecution
-            && fHardwareVirtForce        == h.fHardwareVirtForce
-            && fUseNativeApi             == h.fUseNativeApi
-            && fPAE                      == h.fPAE
-            && enmLongMode               == h.enmLongMode
-            && fTripleFaultReset         == h.fTripleFaultReset
-            && fAPIC                     == h.fAPIC
-            && fX2APIC                   == h.fX2APIC
-            && fIBPBOnVMExit             == h.fIBPBOnVMExit
-            && fIBPBOnVMEntry            == h.fIBPBOnVMEntry
-            && fSpecCtrl                 == h.fSpecCtrl
-            && fSpecCtrlByHost           == h.fSpecCtrlByHost
-            && fL1DFlushOnSched          == h.fL1DFlushOnSched
-            && fL1DFlushOnVMEntry        == h.fL1DFlushOnVMEntry
-            && fMDSClearOnSched          == h.fMDSClearOnSched
-            && fMDSClearOnVMEntry        == h.fMDSClearOnVMEntry
-            && fNestedHWVirt             == h.fNestedHWVirt
-            && cCPUs                     == h.cCPUs
-            && fCpuHotPlug               == h.fCpuHotPlug
-            && ulCpuExecutionCap         == h.ulCpuExecutionCap
-            && uCpuIdPortabilityLevel    == h.uCpuIdPortabilityLevel
-            && strCpuProfile             == h.strCpuProfile
-            && fHPETEnabled              == h.fHPETEnabled
-            && llCpus                    == h.llCpus
-            && llCpuIdLeafs              == h.llCpuIdLeafs
-            && ulMemorySizeMB            == h.ulMemorySizeMB
-            && mapBootOrder              == h.mapBootOrder
-            && graphicsControllerType    == h.graphicsControllerType
-            && ulVRAMSizeMB              == h.ulVRAMSizeMB
-            && cMonitors                 == h.cMonitors
-            && fAccelerate3D             == h.fAccelerate3D
-            && fAccelerate2DVideo        == h.fAccelerate2DVideo
-            && firmwareType              == h.firmwareType
-            && pointingHIDType           == h.pointingHIDType
-            && keyboardHIDType           == h.keyboardHIDType
-            && chipsetType               == h.chipsetType
-            && paravirtProvider          == h.paravirtProvider
-            && strParavirtDebug          == h.strParavirtDebug
-            && fEmulatedUSBCardReader    == h.fEmulatedUSBCardReader
-            && vrdeSettings              == h.vrdeSettings
-            && biosSettings              == h.biosSettings
-            && usbSettings               == h.usbSettings
-            && llNetworkAdapters         == h.llNetworkAdapters
-            && llSerialPorts             == h.llSerialPorts
-            && llParallelPorts           == h.llParallelPorts
-            && audioAdapter              == h.audioAdapter
-            && storage                   == h.storage
-            && llSharedFolders           == h.llSharedFolders
-            && clipboardMode             == h.clipboardMode
-            && dndMode                   == h.dndMode
-            && ulMemoryBalloonSize       == h.ulMemoryBalloonSize
-            && fPageFusionEnabled        == h.fPageFusionEnabled
-            && llGuestProperties         == h.llGuestProperties
-            && ioSettings                == h.ioSettings
-            && pciAttachments            == h.pciAttachments
-            && strDefaultFrontend        == h.strDefaultFrontend);
+        || (   strVersion                     == h.strVersion
+            && uuid                           == h.uuid
+            && fHardwareVirt                  == h.fHardwareVirt
+            && fNestedPaging                  == h.fNestedPaging
+            && fLargePages                    == h.fLargePages
+            && fVPID                          == h.fVPID
+            && fUnrestrictedExecution         == h.fUnrestrictedExecution
+            && fHardwareVirtForce             == h.fHardwareVirtForce
+            && fUseNativeApi                  == h.fUseNativeApi
+            && fPAE                           == h.fPAE
+            && enmLongMode                    == h.enmLongMode
+            && fTripleFaultReset              == h.fTripleFaultReset
+            && fAPIC                          == h.fAPIC
+            && fX2APIC                        == h.fX2APIC
+            && fIBPBOnVMExit                  == h.fIBPBOnVMExit
+            && fIBPBOnVMEntry                 == h.fIBPBOnVMEntry
+            && fSpecCtrl                      == h.fSpecCtrl
+            && fSpecCtrlByHost                == h.fSpecCtrlByHost
+            && fL1DFlushOnSched               == h.fL1DFlushOnSched
+            && fL1DFlushOnVMEntry             == h.fL1DFlushOnVMEntry
+            && fMDSClearOnSched               == h.fMDSClearOnSched
+            && fMDSClearOnVMEntry             == h.fMDSClearOnVMEntry
+            && fNestedHWVirt                  == h.fNestedHWVirt
+            && cCPUs                          == h.cCPUs
+            && fCpuHotPlug                    == h.fCpuHotPlug
+            && ulCpuExecutionCap              == h.ulCpuExecutionCap
+            && uCpuIdPortabilityLevel         == h.uCpuIdPortabilityLevel
+            && strCpuProfile                  == h.strCpuProfile
+            && fHPETEnabled                   == h.fHPETEnabled
+            && llCpus                         == h.llCpus
+            && llCpuIdLeafs                   == h.llCpuIdLeafs
+            && ulMemorySizeMB                 == h.ulMemorySizeMB
+            && mapBootOrder                   == h.mapBootOrder
+            && graphicsControllerType         == h.graphicsControllerType
+            && ulVRAMSizeMB                   == h.ulVRAMSizeMB
+            && cMonitors                      == h.cMonitors
+            && fAccelerate3D                  == h.fAccelerate3D
+            && fAccelerate2DVideo             == h.fAccelerate2DVideo
+            && firmwareType                   == h.firmwareType
+            && pointingHIDType                == h.pointingHIDType
+            && keyboardHIDType                == h.keyboardHIDType
+            && chipsetType                    == h.chipsetType
+            && paravirtProvider               == h.paravirtProvider
+            && strParavirtDebug               == h.strParavirtDebug
+            && fEmulatedUSBCardReader         == h.fEmulatedUSBCardReader
+            && vrdeSettings                   == h.vrdeSettings
+            && biosSettings                   == h.biosSettings
+            && usbSettings                    == h.usbSettings
+            && llNetworkAdapters              == h.llNetworkAdapters
+            && llSerialPorts                  == h.llSerialPorts
+            && llParallelPorts                == h.llParallelPorts
+            && audioAdapter                   == h.audioAdapter
+            && storage                        == h.storage
+            && llSharedFolders                == h.llSharedFolders
+            && clipboardMode                  == h.clipboardMode
+            && fClipboardFileTransfersEnabled == h.fClipboardFileTransfersEnabled
+            && dndMode                        == h.dndMode
+            && ulMemoryBalloonSize            == h.ulMemoryBalloonSize
+            && fPageFusionEnabled             == h.fPageFusionEnabled
+            && llGuestProperties              == h.llGuestProperties
+            && ioSettings                     == h.ioSettings
+            && pciAttachments                 == h.pciAttachments
+            && strDefaultFrontend             == h.strDefaultFrontend);
 }
 
@@ -4888 +4890 @@
                     throw ConfigFileError(this, pelmHwChild, N_("Invalid value '%s' in Clipboard/@mode attribute"), strTemp.c_str());
             }
+
+            pelmHwChild->getAttributeValue("fileTransfersEnabled", hw.fClipboardFileTransfersEnabled);
         }
         else if (pelmHwChild->nameEquals("DragAndDrop"))
@@ -6661 +6665 @@
     }
 
-    if (hw.clipboardMode != ClipboardMode_Disabled)
-    {
-        xml::ElementNode *pelmClip = pelmHardware->createChild("Clipboard");
-        const char *pcszClip;
-        switch (hw.clipboardMode)
-        {
-            default: /*case ClipboardMode_Disabled:*/ pcszClip = "Disabled"; break;
-            case ClipboardMode_HostToGuest: pcszClip = "HostToGuest"; break;
-            case ClipboardMode_GuestToHost: pcszClip = "GuestToHost"; break;
-            case ClipboardMode_Bidirectional: pcszClip = "Bidirectional"; break;
-        }
-        pelmClip->setAttribute("mode", pcszClip);
+    xml::ElementNode *pelmClip = pelmHardware->createChild("Clipboard");
+    if (pelmClip)
+    {
+        if (hw.clipboardMode != ClipboardMode_Disabled)
+        {
+            const char *pcszClip;
+            switch (hw.clipboardMode)
+            {
+                default: /*case ClipboardMode_Disabled:*/ pcszClip = "Disabled"; break;
+                case ClipboardMode_HostToGuest: pcszClip = "HostToGuest"; break;
+                case ClipboardMode_GuestToHost: pcszClip = "GuestToHost"; break;
+                case ClipboardMode_Bidirectional: pcszClip = "Bidirectional"; break;
+            }
+            pelmClip->setAttribute("mode", pcszClip);
+        }
+
+        if (hw.fClipboardFileTransfersEnabled)
+            pelmClip->setAttribute("fileTransfersEnabled", hw.fClipboardFileTransfersEnabled);
     }