VirtualBox

source: vbox/trunk/src/VBox/Main/DVDImageImpl.cpp@ 6380

Last change on this file since 6380 was 5999, checked in by vboxsync, 17 years ago

The Giant CDDL Dual-License Header Change.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.4 KB
Line 
1/** @file
2 *
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2006-2007 innotek GmbH
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
18#include "DVDImageImpl.h"
19#include "VirtualBoxImpl.h"
20#include "Logging.h"
21
22#include <iprt/file.h>
23#include <iprt/path.h>
24#include <iprt/cpputils.h>
25
26#include <VBox/err.h>
27#include <VBox/param.h>
28
29// constructor / destructor
30/////////////////////////////////////////////////////////////////////////////
31
32DEFINE_EMPTY_CTOR_DTOR (DVDImage)
33
34HRESULT DVDImage::FinalConstruct()
35{
36 mAccessible = FALSE;
37 return S_OK;
38}
39
40void DVDImage::FinalRelease()
41{
42 uninit();
43}
44
45// public initializer/uninitializer for internal purposes only
46/////////////////////////////////////////////////////////////////////////////
47
48/**
49 * Initializes the DVD image object.
50 *
51 * @param aParent
52 * parent object
53 * @param aFilePath
54 * local file system path to the image file
55 * (can be relative to the VirtualBox config dir)
56 * @param aRegistered
57 * whether this object is being initialized by the VirtualBox init code
58 * because it is present in the registry
59 * @param aId
60 * ID of the DVD image to assign
61 *
62 * @return COM result indicator
63 */
64HRESULT DVDImage::init (VirtualBox *aParent, const BSTR aFilePath,
65 BOOL aRegistered, const Guid &aId)
66{
67 LogFlowThisFunc (("aFilePath={%ls}, aId={%s}\n",
68 aFilePath, aId.toString().raw()));
69
70 ComAssertRet (aParent && aFilePath && !!aId, E_INVALIDARG);
71
72 /* Enclose the state transition NotReady->InInit->Ready */
73 AutoInitSpan autoInitSpan (this);
74 AssertReturn (autoInitSpan.isOk(), E_UNEXPECTED);
75
76 HRESULT rc = S_OK;
77
78 /* share the parent weakly */
79 unconst (mParent) = aParent;
80
81 /* register with parent early, since uninit() will unconditionally
82 * unregister on failure */
83 mParent->addDependentChild (this);
84
85 unconst (mImageFile) = aFilePath;
86 unconst (mUuid) = aId;
87
88 /* get the full file name */
89 char filePathFull [RTPATH_MAX];
90 int vrc = RTPathAbsEx (mParent->homeDir(), Utf8Str (aFilePath),
91 filePathFull, sizeof (filePathFull));
92 if (VBOX_FAILURE (vrc))
93 return setError (E_FAIL,
94 tr ("Invalid image file path: '%ls' (%Vrc)"),
95 aFilePath, vrc);
96
97 unconst (mImageFileFull) = filePathFull;
98 LogFlowThisFunc (("...filePathFull={%ls}\n", mImageFileFull.raw()));
99
100 if (!aRegistered)
101 {
102 /* check whether the given file exists or not */
103 RTFILE file;
104 vrc = RTFileOpen (&file, filePathFull,
105 RTFILE_O_READ | RTFILE_O_OPEN | RTFILE_O_DENY_NONE);
106 if (VBOX_FAILURE (vrc))
107 {
108 /* here we come when the image was just opened by
109 * IVirtualBox::OpenDVDImage(). fail in this case */
110 rc = setError (E_FAIL,
111 tr ("Could not open the CD/DVD image '%ls' (%Vrc)"),
112 mImageFileFull.raw(), vrc);
113 }
114 else
115 RTFileClose (file);
116 }
117
118 /* Confirm a successful initialization when it's the case */
119 if (SUCCEEDED (rc))
120 autoInitSpan.setSucceeded();
121
122 return rc;
123}
124
125/**
126 * Uninitializes the instance and sets the ready flag to FALSE.
127 * Called either from FinalRelease() or by the parent when it gets destroyed.
128 */
129void DVDImage::uninit()
130{
131 LogFlowThisFunc (("\n"));
132
133 /* Enclose the state transition Ready->InUninit->NotReady */
134 AutoUninitSpan autoUninitSpan (this);
135 if (autoUninitSpan.uninitDone())
136 return;
137
138 LogFlowThisFunc (("initFailed()=%RTbool\n", autoUninitSpan.initFailed()));
139
140 mParent->removeDependentChild (this);
141
142 unconst (mParent).setNull();
143}
144
145// IDVDImage properties
146/////////////////////////////////////////////////////////////////////////////
147
148STDMETHODIMP DVDImage::COMGETTER(Id) (GUIDPARAMOUT aId)
149{
150 if (!aId)
151 return E_POINTER;
152
153 AutoCaller autoCaller (this);
154 CheckComRCReturnRC (autoCaller.rc());
155
156 /* mUuid is constant during life time, no need to lock */
157 mUuid.cloneTo (aId);
158
159 return S_OK;
160}
161
162STDMETHODIMP DVDImage::COMGETTER(FilePath) (BSTR *aFilePath)
163{
164 if (!aFilePath)
165 return E_POINTER;
166
167 AutoCaller autoCaller (this);
168 CheckComRCReturnRC (autoCaller.rc());
169
170 AutoReaderLock alock (this);
171
172 mImageFileFull.cloneTo (aFilePath);
173
174 return S_OK;
175}
176
177STDMETHODIMP DVDImage::COMGETTER(Accessible) (BOOL *aAccessible)
178{
179 if (!aAccessible)
180 return E_POINTER;
181
182 AutoCaller autoCaller (this);
183 CheckComRCReturnRC (autoCaller.rc());
184
185 AutoLock alock (this);
186
187 HRESULT rc = S_OK;
188
189 /* check whether the given image file exists or not */
190 RTFILE file;
191 int vrc = RTFileOpen (&file, Utf8Str (mImageFileFull),
192 RTFILE_O_READ | RTFILE_O_OPEN | RTFILE_O_DENY_NONE);
193 if (VBOX_FAILURE (vrc))
194 {
195 Log (("DVDImage::COMGETTER(Accessible): WARNING: '%ls' "
196 "is not accessible (%Vrc)\n", mImageFileFull.raw(), vrc));
197 mAccessible = FALSE;
198 }
199 else
200 {
201 mAccessible = TRUE;
202 RTFileClose (file);
203 }
204
205 *aAccessible = mAccessible;
206
207 return rc;
208}
209
210STDMETHODIMP DVDImage::COMGETTER(Size) (ULONG64 *aSize)
211{
212 if (!aSize)
213 return E_POINTER;
214
215 HRESULT rc = S_OK;
216
217 AutoCaller autoCaller (this);
218 CheckComRCReturnRC (autoCaller.rc());
219
220 AutoReaderLock alock (this);
221
222 RTFILE file;
223 int vrc = RTFileOpen (&file, Utf8Str (mImageFileFull),
224 RTFILE_O_READ | RTFILE_O_OPEN | RTFILE_O_DENY_NONE);
225
226 if (VBOX_FAILURE (vrc))
227 rc = setError (E_FAIL, tr("Failed to open ISO image '%ls' (%Vrc)\n"),
228 mImageFileFull.raw(), vrc);
229 else
230 {
231 AssertCompile (sizeof (uint64_t) == sizeof (ULONG64));
232
233 uint64_t u64Size = 0;
234
235 vrc = RTFileGetSize (file, &u64Size);
236
237 if (VBOX_SUCCESS (vrc))
238 *aSize = u64Size;
239 else
240 rc = setError (E_FAIL,
241 tr ("Failed to determine size of ISO image '%ls' (%Vrc)\n"),
242 mImageFileFull.raw(), vrc);
243
244 RTFileClose (file);
245 }
246
247 return rc;
248}
249
250// public methods for internal purposes only
251////////////////////////////////////////////////////////////////////////////////
252
253/**
254 * Changes the stored path values of this image to reflect the new location.
255 * Intended to be called only by VirtualBox::updateSettings() if a machine's
256 * name change causes directory renaming that affects this image.
257 *
258 * @param aNewFullPath new full path to this image file
259 * @param aNewPath new path to this image file relative to the VirtualBox
260 * settings directory (when possible)
261 *
262 * @note Locks this object for writing.
263 */
264void DVDImage::updatePath (const char *aNewFullPath, const char *aNewPath)
265{
266 AssertReturnVoid (aNewFullPath);
267 AssertReturnVoid (aNewPath);
268
269 AutoCaller autoCaller (this);
270 AssertComRCReturnVoid (autoCaller.rc());
271
272 AutoLock alock (this);
273
274 unconst (mImageFileFull) = aNewFullPath;
275 unconst (mImageFile) = aNewPath;
276}
277
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette