VirtualBox

source: vbox/trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibSharedFolders.cpp@ 63206

Last change on this file since 63206 was 62521, checked in by vboxsync, 8 years ago

(C) 2016
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.8 KB
Line 
1/* $Id: VBoxGuestR3LibSharedFolders.cpp 62521 2016-07-22 19:16:33Z vboxsync $ */
2/** @file
3 * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, shared folders.
4 */
5
6/*
7 * Copyright (C) 2010-2016 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27
28/*********************************************************************************************************************************
29* Header Files *
30*********************************************************************************************************************************/
31#include <iprt/string.h>
32#include <iprt/mem.h>
33#include <iprt/assert.h>
34#include <iprt/cpp/autores.h>
35#include <iprt/stdarg.h>
36#include <VBox/log.h>
37#include <VBox/shflsvc.h> /** @todo File should be moved to VBox/HostServices/SharedFolderSvc.h */
38
39#include "VBGLR3Internal.h"
40
41
42/**
43 * Connects to the shared folder service.
44 *
45 * @returns VBox status code
46 * @param pidClient Where to put the client id on success. The client id
47 * must be passed to all the other calls to the service.
48 */
49VBGLR3DECL(int) VbglR3SharedFolderConnect(HGCMCLIENTID *pidClient)
50{
51 VBoxGuestHGCMConnectInfo Info;
52 Info.result = VERR_WRONG_ORDER;
53 Info.Loc.type = VMMDevHGCMLoc_LocalHost_Existing;
54 RT_ZERO(Info.Loc.u);
55 strcpy(Info.Loc.u.host.achName, "VBoxSharedFolders");
56 Info.u32ClientID = UINT32_MAX; /* try make valgrind shut up. */
57
58 int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CONNECT, &Info, sizeof(Info));
59 if (RT_SUCCESS(rc))
60 {
61 rc = Info.result;
62 if (RT_SUCCESS(rc))
63 *pidClient = Info.u32ClientID;
64 }
65 return rc;
66}
67
68
69/**
70 * Disconnect from the shared folder service.
71 *
72 * @returns VBox status code.
73 * @param idClient The client id returned by VbglR3InfoSvcConnect().
74 */
75VBGLR3DECL(int) VbglR3SharedFolderDisconnect(HGCMCLIENTID idClient)
76{
77 VBoxGuestHGCMDisconnectInfo Info;
78 Info.result = VERR_WRONG_ORDER;
79 Info.u32ClientID = idClient;
80
81 int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_DISCONNECT, &Info, sizeof(Info));
82 if (RT_SUCCESS(rc))
83 rc = Info.result;
84 return rc;
85}
86
87
88/**
89 * Checks whether a shared folder share exists or not.
90 *
91 * @returns True if shared folder exists, false if not.
92 * @param idClient The client id returned by VbglR3InfoSvcConnect().
93 * @param pszShareName Shared folder name to check.
94 */
95VBGLR3DECL(bool) VbglR3SharedFolderExists(HGCMCLIENTID idClient, const char *pszShareName)
96{
97 AssertPtr(pszShareName);
98
99 uint32_t cMappings;
100 VBGLR3SHAREDFOLDERMAPPING *paMappings;
101
102 /** @todo Use some caching here? */
103 bool fFound = false;
104 int rc = VbglR3SharedFolderGetMappings(idClient, true /* Only process auto-mounted folders */, &paMappings, &cMappings);
105 if (RT_SUCCESS(rc))
106 {
107 for (uint32_t i = 0; i < cMappings && !fFound; i++)
108 {
109 char *pszName = NULL;
110 rc = VbglR3SharedFolderGetName(idClient, paMappings[i].u32Root, &pszName);
111 if ( RT_SUCCESS(rc)
112 && *pszName)
113 {
114 if (RTStrICmp(pszName, pszShareName) == 0)
115 fFound = true;
116 RTStrFree(pszName);
117 }
118 }
119 VbglR3SharedFolderFreeMappings(paMappings);
120 }
121 return fFound;
122}
123
124
125/**
126 * Get the list of available shared folders.
127 *
128 * @returns VBox status code.
129 * @param idClient The client id returned by VbglR3SharedFolderConnect().
130 * @param fAutoMountOnly Flag whether only auto-mounted shared folders
131 * should be reported.
132 * @param ppaMappings Allocated array which will retrieve the mapping info. Needs
133 * to be freed with VbglR3SharedFolderFreeMappings() later.
134 * @param pcMappings The number of mappings returned in @a ppaMappings.
135 */
136VBGLR3DECL(int) VbglR3SharedFolderGetMappings(HGCMCLIENTID idClient, bool fAutoMountOnly,
137 PVBGLR3SHAREDFOLDERMAPPING *ppaMappings, uint32_t *pcMappings)
138{
139 AssertPtrReturn(pcMappings, VERR_INVALID_PARAMETER);
140 AssertPtrReturn(ppaMappings, VERR_INVALID_PARAMETER);
141
142 *pcMappings = 0;
143 *ppaMappings = NULL;
144
145 VBoxSFQueryMappings Msg;
146
147 Msg.callInfo.result = VERR_WRONG_ORDER;
148 Msg.callInfo.u32ClientID = idClient;
149 Msg.callInfo.u32Function = SHFL_FN_QUERY_MAPPINGS;
150 Msg.callInfo.cParms = 3;
151
152 /* Set the mapping flags. */
153 uint32_t u32Flags = 0; /** @todo SHFL_MF_UTF8 is not implemented yet. */
154 if (fAutoMountOnly) /* We only want the mappings which get auto-mounted. */
155 u32Flags |= SHFL_MF_AUTOMOUNT;
156 VbglHGCMParmUInt32Set(&Msg.flags, u32Flags);
157
158 /*
159 * Prepare and get the actual mappings from the host service.
160 */
161 int rc = VINF_SUCCESS;
162 uint32_t cMappings = 8; /* Should be a good default value. */
163 uint32_t cbSize = cMappings * sizeof(VBGLR3SHAREDFOLDERMAPPING);
164 VBGLR3SHAREDFOLDERMAPPING *ppaMappingsTemp = (PVBGLR3SHAREDFOLDERMAPPING)RTMemAllocZ(cbSize);
165 if (!ppaMappingsTemp)
166 return VERR_NO_MEMORY;
167
168 do
169 {
170 VbglHGCMParmUInt32Set(&Msg.numberOfMappings, cMappings);
171 VbglHGCMParmPtrSet(&Msg.mappings, ppaMappingsTemp, cbSize);
172
173 rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
174 if (RT_SUCCESS(rc))
175 {
176 rc = Msg.callInfo.result;
177 if (RT_SUCCESS(rc))
178 {
179 VbglHGCMParmUInt32Get(&Msg.numberOfMappings, pcMappings);
180
181 /* Do we have more mappings than we have allocated space for? */
182 if (rc == VINF_BUFFER_OVERFLOW)
183 {
184 cMappings = *pcMappings;
185 cbSize = cMappings * sizeof(VBGLR3SHAREDFOLDERMAPPING);
186 void *pvNew = RTMemRealloc(ppaMappingsTemp, cbSize);
187 AssertPtrBreakStmt(pvNew, rc = VERR_NO_MEMORY);
188 ppaMappingsTemp = (PVBGLR3SHAREDFOLDERMAPPING)pvNew;
189 }
190 }
191 }
192 } while (rc == VINF_BUFFER_OVERFLOW);
193
194 if ( RT_FAILURE(rc)
195 || !*pcMappings)
196 {
197 RTMemFree(ppaMappingsTemp);
198 ppaMappingsTemp = NULL;
199 }
200
201 /* In this case, just return success with 0 mappings */
202 if ( rc == VERR_INVALID_PARAMETER
203 && fAutoMountOnly)
204 rc = VINF_SUCCESS;
205
206 *ppaMappings = ppaMappingsTemp;
207
208 return rc;
209}
210
211
212/**
213 * Frees the shared folder mappings allocated by
214 * VbglR3SharedFolderGetMappings() before.
215 *
216 * @param paMappings What
217 */
218VBGLR3DECL(void) VbglR3SharedFolderFreeMappings(PVBGLR3SHAREDFOLDERMAPPING paMappings)
219{
220 if (paMappings)
221 RTMemFree(paMappings);
222}
223
224
225/**
226 * Get the real name of a shared folder.
227 *
228 * @returns VBox status code.
229 * @param idClient The client id returned by VbglR3InvsSvcConnect().
230 * @param u32Root Root ID of shared folder to get the name for.
231 * @param ppszName Where to return the name string. This shall be
232 * freed by calling RTStrFree.
233 */
234VBGLR3DECL(int) VbglR3SharedFolderGetName(HGCMCLIENTID idClient, uint32_t u32Root, char **ppszName)
235{
236 AssertPtr(ppszName);
237
238 VBoxSFQueryMapName Msg;
239
240 Msg.callInfo.result = VERR_WRONG_ORDER;
241 Msg.callInfo.u32ClientID = idClient;
242 Msg.callInfo.u32Function = SHFL_FN_QUERY_MAP_NAME;
243 Msg.callInfo.cParms = 2;
244
245 int rc;
246 uint32_t cbString = SHFLSTRING_HEADER_SIZE + SHFL_MAX_LEN;
247 PSHFLSTRING pString = (PSHFLSTRING)RTMemAlloc(cbString);
248 if (pString)
249 {
250 if (!ShflStringInitBuffer(pString, cbString))
251 {
252 RTMemFree(pString);
253 return VERR_INVALID_PARAMETER;
254 }
255
256 VbglHGCMParmUInt32Set(&Msg.root, u32Root);
257 VbglHGCMParmPtrSet(&Msg.name, pString, cbString);
258
259 rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
260 if (RT_SUCCESS(rc))
261 {
262 rc = Msg.callInfo.result;
263 if (RT_SUCCESS(rc))
264 {
265 *ppszName = NULL;
266 rc = RTUtf16ToUtf8(&pString->String.ucs2[0], ppszName);
267 }
268 }
269 RTMemFree(pString);
270 }
271 else
272 rc = VERR_INVALID_PARAMETER;
273 return rc;
274}
275
276/**
277 * Retrieves the prefix for a shared folder mount point. If no prefix
278 * is set in the guest properties "sf_" is returned.
279 *
280 * @returns VBox status code.
281 * @param ppszPrefix Where to return the prefix string. This shall be
282 * freed by calling RTStrFree.
283 */
284VBGLR3DECL(int) VbglR3SharedFolderGetMountPrefix(char **ppszPrefix)
285{
286 AssertPtrReturn(ppszPrefix, VERR_INVALID_POINTER);
287 int rc;
288#ifdef VBOX_WITH_GUEST_PROPS
289 HGCMCLIENTID idClientGuestProp;
290 rc = VbglR3GuestPropConnect(&idClientGuestProp);
291 if (RT_SUCCESS(rc))
292 {
293 rc = VbglR3GuestPropReadValueAlloc(idClientGuestProp, "/VirtualBox/GuestAdd/SharedFolders/MountPrefix", ppszPrefix);
294 if (rc == VERR_NOT_FOUND) /* No prefix set? Then set the default. */
295 {
296#endif
297 rc = RTStrDupEx(ppszPrefix, "sf_");
298#ifdef VBOX_WITH_GUEST_PROPS
299 }
300 VbglR3GuestPropDisconnect(idClientGuestProp);
301 }
302#endif
303 return rc;
304}
305
306/**
307 * Retrieves the mount root directory for auto-mounted shared
308 * folders. mount point. If no string is set (VERR_NOT_FOUND)
309 * it's up on the caller (guest) to decide where to mount.
310 *
311 * @returns VBox status code.
312 * @param ppszDir Where to return the directory
313 * string. This shall be freed by
314 * calling RTStrFree.
315 */
316VBGLR3DECL(int) VbglR3SharedFolderGetMountDir(char **ppszDir)
317{
318 AssertPtrReturn(ppszDir, VERR_INVALID_POINTER);
319 int rc = VERR_NOT_FOUND;
320#ifdef VBOX_WITH_GUEST_PROPS
321 HGCMCLIENTID idClientGuestProp;
322 rc = VbglR3GuestPropConnect(&idClientGuestProp);
323 if (RT_SUCCESS(rc))
324 {
325 rc = VbglR3GuestPropReadValueAlloc(idClientGuestProp, "/VirtualBox/GuestAdd/SharedFolders/MountDir", ppszDir);
326 VbglR3GuestPropDisconnect(idClientGuestProp);
327 }
328#endif
329 return rc;
330}
331
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use