UpdateAgentImpl.cpp@ 94729

Last change on this file since 94729 was 94729, checked in by vboxsync, 3 years ago
Main/Update check: Clang build fixes. bugref:7983
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 33.1 KB

Line
1	/* $Id: UpdateAgentImpl.cpp 94729 2022-04-28 05:56:40Z vboxsync $ */
2	/** @file
3	* IUpdateAgent COM class implementations.
4	*/
5
6	/*
7	* Copyright (C) 2020-2022 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.215389.xyz. 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
19	#define LOG_GROUP LOG_GROUP_MAIN_UPDATEAGENT
20
21	#include <iprt/cpp/utils.h>
22	#include <iprt/param.h>
23	#include <iprt/path.h>
24	#include <iprt/http.h>
25	#include <iprt/system.h>
26	#include <iprt/message.h>
27	#include <iprt/pipe.h>
28	#include <iprt/env.h>
29	#include <iprt/process.h>
30	#include <iprt/assert.h>
31	#include <iprt/err.h>
32	#include <iprt/stream.h>
33	#include <iprt/time.h>
34	#include <VBox/com/defs.h>
35	#include <VBox/err.h>
36	#include <VBox/version.h>
37
38	#include "HostImpl.h"
39	#include "UpdateAgentImpl.h"
40	#include "ProgressImpl.h"
41	#include "AutoCaller.h"
42	#include "LoggingNew.h"
43	#include "VirtualBoxImpl.h"
44	#include "VBoxEvents.h"
45	#include "ThreadTask.h"
46	#include "VirtualBoxBase.h"
47
48
49	/*********************************************************************************************************************************
50	* Update agent task implementation *
51	*********************************************************************************************************************************/
52
53	/**
54	* Base task class for asynchronous update agent tasks.
55	*/
56	class UpdateAgentTask : public ThreadTask
57	{
58	public:
59	UpdateAgentTask(UpdateAgentBase aThat, Progress aProgress)
60	: m_pParent(aThat)
61	, m_pProgress(aProgress)
62	{
63	m_strTaskName = "UpdateAgentTask";
64	}
65	virtual ~UpdateAgentTask(void) { }
66
67	private:
68	void handler(void);
69
70	/** Weak pointer to parent (update agent). */
71	UpdateAgentBase *m_pParent;
72	/** Smart pointer to the progress object for this job. */
73	ComObjPtr<Progress> m_pProgress;
74
75	friend class UpdateAgent; // allow member functions access to private data
76	};
77
78	void UpdateAgentTask::handler(void)
79	{
80	UpdateAgentBase *pUpdateAgent = this->m_pParent;
81	AssertPtr(pUpdateAgent);
82
83	/** @todo Differentiate tasks once we have more stuff to do (downloading, installing, ++). */
84
85	HRESULT rc = pUpdateAgent->i_checkForUpdateTask(this);
86
87	if (!m_pProgress.isNull())
88	m_pProgress->i_notifyComplete(rc);
89
90	LogFlowFunc(("rc=%Rhrc\n", rc)); RT_NOREF(rc);
91	}
92
93
94	/*********************************************************************************************************************************
95	* Update agent base class implementation *
96	*********************************************************************************************************************************/
97
98	/**
99	* Returns platform information as a string.
100	*
101	* @returns Platform information as string.
102	*/
103	/* static */
104	Utf8Str UpdateAgentBase::i_getPlatformInfo(void)
105	{
106	/* Prepare platform report: */
107	Utf8Str strPlatform;
108
109	# if defined (RT_OS_WINDOWS)
110	strPlatform = "win";
111	# elif defined (RT_OS_LINUX)
112	strPlatform = "linux";
113	# elif defined (RT_OS_DARWIN)
114	strPlatform = "macosx";
115	# elif defined (RT_OS_OS2)
116	strPlatform = "os2";
117	# elif defined (RT_OS_FREEBSD)
118	strPlatform = "freebsd";
119	# elif defined (RT_OS_SOLARIS)
120	strPlatform = "solaris";
121	# else
122	strPlatform = "unknown";
123	# endif
124
125	/* The format is <system>.<bitness>: */
126	strPlatform.appendPrintf(".%lu", ARCH_BITS);
127
128	/* Add more system information: */
129	int vrc;
130	# ifdef RT_OS_LINUX
131	// WORKAROUND:
132	// On Linux we try to generate information using script first of all..
133
134	/* Get script path: */
135	char szAppPrivPath[RTPATH_MAX];
136	vrc = RTPathAppPrivateNoArch(szAppPrivPath, sizeof(szAppPrivPath));
137	AssertRC(vrc);
138	if (RT_SUCCESS(vrc))
139	vrc = RTPathAppend(szAppPrivPath, sizeof(szAppPrivPath), "/VBoxSysInfo.sh");
140	AssertRC(vrc);
141	if (RT_SUCCESS(vrc))
142	{
143	RTPIPE hPipeR;
144	RTHANDLE hStdOutPipe;
145	hStdOutPipe.enmType = RTHANDLETYPE_PIPE;
146	vrc = RTPipeCreate(&hPipeR, &hStdOutPipe.u.hPipe, RTPIPE_C_INHERIT_WRITE);
147	AssertLogRelRC(vrc);
148
149	char const *szAppPrivArgs[2];
150	szAppPrivArgs[0] = szAppPrivPath;
151	szAppPrivArgs[1] = NULL;
152	RTPROCESS hProc = NIL_RTPROCESS;
153
154	/* Run script: */
155	vrc = RTProcCreateEx(szAppPrivPath, szAppPrivArgs, RTENV_DEFAULT, 0 /fFlags/, NULL /phStdin/, &hStdOutPipe,
156	NULL /phStderr/, NULL /pszAsUser/, NULL /pszPassword/, NULL /pvExtraData/, &hProc);
157
158	(void) RTPipeClose(hStdOutPipe.u.hPipe);
159	hStdOutPipe.u.hPipe = NIL_RTPIPE;
160
161	if (RT_SUCCESS(vrc))
162	{
163	RTPROCSTATUS ProcStatus;
164	size_t cbStdOutBuf = 0;
165	size_t offStdOutBuf = 0;
166	char *pszStdOutBuf = NULL;
167	do
168	{
169	if (hPipeR != NIL_RTPIPE)
170	{
171	char achBuf[1024];
172	size_t cbRead;
173	vrc = RTPipeReadBlocking(hPipeR, achBuf, sizeof(achBuf), &cbRead);
174	if (RT_SUCCESS(vrc))
175	{
176	/* grow the buffer? */
177	size_t cbBufReq = offStdOutBuf + cbRead + 1;
178	if ( cbBufReq > cbStdOutBuf
179	&& cbBufReq < _256K)
180	{
181	size_t cbNew = RT_ALIGN_Z(cbBufReq, 16); // 1024
182	void *pvNew = RTMemRealloc(pszStdOutBuf, cbNew);
183	if (pvNew)
184	{
185	pszStdOutBuf = (char *)pvNew;
186	cbStdOutBuf = cbNew;
187	}
188	}
189
190	/* append if we've got room. */
191	if (cbBufReq <= cbStdOutBuf)
192	{
193	(void) memcpy(&pszStdOutBuf[offStdOutBuf], achBuf, cbRead);
194	offStdOutBuf = offStdOutBuf + cbRead;
195	pszStdOutBuf[offStdOutBuf] = '\0';
196	}
197	}
198	else
199	{
200	AssertLogRelMsg(vrc == VERR_BROKEN_PIPE, ("%Rrc\n", vrc));
201	RTPipeClose(hPipeR);
202	hPipeR = NIL_RTPIPE;
203	}
204	}
205
206	/*
207	* Service the process. Block if we have no pipe.
208	*/
209	if (hProc != NIL_RTPROCESS)
210	{
211	vrc = RTProcWait(hProc,
212	hPipeR == NIL_RTPIPE ? RTPROCWAIT_FLAGS_BLOCK : RTPROCWAIT_FLAGS_NOBLOCK,
213	&ProcStatus);
214	if (RT_SUCCESS(vrc))
215	hProc = NIL_RTPROCESS;
216	else
217	AssertLogRelMsgStmt(vrc == VERR_PROCESS_RUNNING, ("%Rrc\n", vrc), hProc = NIL_RTPROCESS);
218	}
219	} while ( hPipeR != NIL_RTPIPE
220	\|\| hProc != NIL_RTPROCESS);
221
222	if ( ProcStatus.enmReason == RTPROCEXITREASON_NORMAL
223	&& ProcStatus.iStatus == 0) {
224	pszStdOutBuf[offStdOutBuf-1] = '\0'; // remove trailing newline
225	Utf8Str pszStdOutBufUTF8(pszStdOutBuf);
226	strPlatform.appendPrintf(" [%s]", pszStdOutBufUTF8.strip().c_str());
227	// For testing, here is some sample output:
228	//strPlatform.appendPrintf(" [Distribution: Redhat \| Version: 7.6.1810 \| Kernel: Linux version 3.10.0-952.27.2.el7.x86_64 (gcc version 4.8.5 20150623 (Red Hat 4.8.5-36) (GCC) ) #1 SMP Mon Jul 29 17:46:05 UTC 2019]");
229	}
230	}
231	else
232	vrc = VERR_TRY_AGAIN; /* (take the fallback path) */
233	}
234
235	if (RT_FAILURE(vrc))
236	# endif /* RT_OS_LINUX */
237	{
238	/* Use RTSystemQueryOSInfo: */
239	char szTmp[256];
240
241	vrc = RTSystemQueryOSInfo(RTSYSOSINFO_PRODUCT, szTmp, sizeof(szTmp));
242	if ((RT_SUCCESS(vrc) \|\| vrc == VERR_BUFFER_OVERFLOW) && szTmp[0] != '\0')
243	strPlatform.appendPrintf(" [Product: %s", szTmp);
244
245	vrc = RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szTmp, sizeof(szTmp));
246	if ((RT_SUCCESS(vrc) \|\| vrc == VERR_BUFFER_OVERFLOW) && szTmp[0] != '\0')
247	strPlatform.appendPrintf(" %sRelease: %s", strlen(szTmp) == 0 ? "[" : "\| ", szTmp);
248
249	vrc = RTSystemQueryOSInfo(RTSYSOSINFO_VERSION, szTmp, sizeof(szTmp));
250	if ((RT_SUCCESS(vrc) \|\| vrc == VERR_BUFFER_OVERFLOW) && szTmp[0] != '\0')
251	strPlatform.appendPrintf(" %sVersion: %s", strlen(szTmp) == 0 ? "[" : "\| ", szTmp);
252
253	vrc = RTSystemQueryOSInfo(RTSYSOSINFO_SERVICE_PACK, szTmp, sizeof(szTmp));
254	if ((RT_SUCCESS(vrc) \|\| vrc == VERR_BUFFER_OVERFLOW) && szTmp[0] != '\0')
255	strPlatform.appendPrintf(" %sSP: %s]", strlen(szTmp) == 0 ? "[" : "\| ", szTmp);
256
257	if (!strPlatform.endsWith("]"))
258	strPlatform.append("]");
259	}
260
261	LogRel2(("UpdateAgent: Platform is '%s'\n", strPlatform.c_str()));
262
263	return strPlatform;
264	}
265
266
267	/*********************************************************************************************************************************
268	* Update agent class implementation *
269	*********************************************************************************************************************************/
270	UpdateAgent::UpdateAgent()
271	{
272	}
273
274	UpdateAgent::~UpdateAgent()
275	{
276	}
277
278	HRESULT UpdateAgent::FinalConstruct(void)
279	{
280	return BaseFinalConstruct();
281	}
282
283	void UpdateAgent::FinalRelease(void)
284	{
285	uninit();
286
287	BaseFinalRelease();
288	}
289
290	HRESULT UpdateAgent::init(VirtualBox *aVirtualBox)
291	{
292	/* Weak reference to a VirtualBox object */
293	unconst(m_VirtualBox) = aVirtualBox;
294
295	HRESULT hr = unconst(m_EventSource).createObject();
296	if (SUCCEEDED(hr))
297	hr = m_EventSource->init();
298
299	return hr;
300	}
301
302	void UpdateAgent::uninit(void)
303	{
304	// Enclose the state transition Ready->InUninit->NotReady.
305	AutoUninitSpan autoUninitSpan(this);
306	if (autoUninitSpan.uninitDone())
307	return;
308
309	unconst(m_EventSource).setNull();
310	}
311
312	HRESULT UpdateAgent::checkFor(ComPtr<IProgress> &aProgress)
313	{
314	RT_NOREF(aProgress);
315
316	return VBOX_E_NOT_SUPPORTED;
317	}
318
319	HRESULT UpdateAgent::download(ComPtr<IProgress> &aProgress)
320	{
321	RT_NOREF(aProgress);
322
323	return VBOX_E_NOT_SUPPORTED;
324	}
325
326	HRESULT UpdateAgent::install(ComPtr<IProgress> &aProgress)
327	{
328	RT_NOREF(aProgress);
329
330	return VBOX_E_NOT_SUPPORTED;
331	}
332
333	HRESULT UpdateAgent::rollback(void)
334	{
335	return VBOX_E_NOT_SUPPORTED;
336	}
337
338	HRESULT UpdateAgent::getName(com::Utf8Str &aName)
339	{
340	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
341
342	aName = mData.m_strName;
343
344	return S_OK;
345	}
346
347	HRESULT UpdateAgent::getEventSource(ComPtr<IEventSource> &aEventSource)
348	{
349	LogFlowThisFuncEnter();
350
351	/* No need to lock - lifetime constant. */
352	m_EventSource.queryInterfaceTo(aEventSource.asOutParam());
353
354	LogFlowFuncLeaveRC(S_OK);
355	return S_OK;
356	}
357
358	HRESULT UpdateAgent::getOrder(ULONG *aOrder)
359	{
360	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
361
362	aOrder = 0; / 0 means no order / disabled. */
363
364	return S_OK;
365	}
366
367	HRESULT UpdateAgent::getDependsOn(std::vector<com::Utf8Str> &aDeps)
368	{
369	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
370
371	aDeps.resize(0); /* No dependencies by default. */
372
373	return S_OK;
374	}
375
376	HRESULT UpdateAgent::getVersion(com::Utf8Str &aVer)
377	{
378	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
379
380	aVer = mData.m_lastResult.strVer;
381
382	return S_OK;
383	}
384
385	HRESULT UpdateAgent::getDownloadUrl(com::Utf8Str &aUrl)
386	{
387	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
388
389	aUrl = mData.m_lastResult.strDownloadUrl;
390
391	return S_OK;
392	}
393
394
395	HRESULT UpdateAgent::getWebUrl(com::Utf8Str &aUrl)
396	{
397	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
398
399	aUrl = mData.m_lastResult.strWebUrl;
400
401	return S_OK;
402	}
403
404	HRESULT UpdateAgent::getReleaseNotes(com::Utf8Str &aRelNotes)
405	{
406	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
407
408	aRelNotes = mData.m_lastResult.strReleaseNotes;
409
410	return S_OK;
411	}
412
413	HRESULT UpdateAgent::getEnabled(BOOL *aEnabled)
414	{
415	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
416
417	*aEnabled = m->fEnabled;
418
419	return S_OK;
420	}
421
422	HRESULT UpdateAgent::setEnabled(const BOOL aEnabled)
423	{
424	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
425
426	m->fEnabled = aEnabled;
427
428	return i_commitSettings(alock);
429	}
430
431
432	HRESULT UpdateAgent::getHidden(BOOL *aHidden)
433	{
434	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
435
436	*aHidden = mData.m_fHidden;
437
438	return S_OK;
439	}
440
441	HRESULT UpdateAgent::getState(UpdateState_T *aState)
442	{
443	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
444
445	*aState = mData.m_enmState;
446
447	return S_OK;
448	}
449
450	HRESULT UpdateAgent::getCheckFrequency(ULONG *aFreqSeconds)
451	{
452	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
453
454	*aFreqSeconds = m->uCheckFreqSeconds;
455
456	return S_OK;
457	}
458
459	HRESULT UpdateAgent::setCheckFrequency(ULONG aFreqSeconds)
460	{
461	if (aFreqSeconds < RT_SEC_1DAY) /* Don't allow more frequent checks for now. */
462	return setError(E_INVALIDARG, tr("Frequency too small; one day is the minimum"));
463
464	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
465
466	m->uCheckFreqSeconds = aFreqSeconds;
467
468	return i_commitSettings(alock);
469	}
470
471	HRESULT UpdateAgent::getChannel(UpdateChannel_T *aChannel)
472	{
473	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
474
475	*aChannel = m->enmChannel;
476
477	return S_OK;
478	}
479
480	HRESULT UpdateAgent::setChannel(UpdateChannel_T aChannel)
481	{
482	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
483
484	m->enmChannel = aChannel;
485
486	return i_commitSettings(alock);
487	}
488
489	HRESULT UpdateAgent::getCheckCount(ULONG *aCount)
490	{
491	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
492
493	*aCount = m->uCheckCount;
494
495	return S_OK;
496	}
497
498	HRESULT UpdateAgent::getRepositoryURL(com::Utf8Str &aRepo)
499	{
500	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
501
502	aRepo = m->strRepoUrl;
503
504	return S_OK;
505	}
506
507	HRESULT UpdateAgent::setRepositoryURL(const com::Utf8Str &aRepo)
508	{
509	if (!aRepo.startsWith("https://", com::Utf8Str::CaseInsensitive))
510	return setError(E_INVALIDARG, tr("Invalid URL scheme specified; only https:// is supported."));
511
512	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
513
514	m->strRepoUrl = aRepo;
515
516	return i_commitSettings(alock);
517	}
518
519	HRESULT UpdateAgent::getProxyMode(ProxyMode_T *aMode)
520	{
521	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
522
523	*aMode = m->enmProxyMode;
524
525	return S_OK;
526	}
527
528	HRESULT UpdateAgent::setProxyMode(ProxyMode_T aMode)
529	{
530	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
531
532	m->enmProxyMode = aMode;
533
534	return i_commitSettings(alock);
535	}
536
537	HRESULT UpdateAgent::getProxyURL(com::Utf8Str &aAddress)
538	{
539	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
540
541	aAddress = m->strProxyUrl;
542
543	return S_OK;
544	}
545
546	HRESULT UpdateAgent::setProxyURL(const com::Utf8Str &aAddress)
547	{
548	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
549
550	m->strProxyUrl = aAddress;
551
552	return i_commitSettings(alock);
553	}
554
555	HRESULT UpdateAgent::getLastCheckDate(com::Utf8Str &aDate)
556	{
557	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
558
559	aDate = m->strLastCheckDate;
560
561	return S_OK;
562	}
563
564	HRESULT UpdateAgent::getIsCheckNeeded(BOOL *aCheckNeeded)
565	{
566	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
567
568	/*
569	* Is update checking enabled at all?
570	*/
571	if (!m->fEnabled)
572	{
573	*aCheckNeeded = FALSE;
574	return S_OK;
575	}
576
577	/*
578	* When was the last update?
579	*/
580	if (m->strLastCheckDate.isEmpty()) /* No prior update check performed -- do so now. */
581	{
582	*aCheckNeeded = TRUE;
583	return S_OK;
584	}
585
586	RTTIMESPEC LastCheckTime;
587	if (!RTTimeSpecFromString(&LastCheckTime, Utf8Str(m->strLastCheckDate).c_str()))
588	{
589	aCheckNeeded = TRUE; / Invalid date set or error? Perform check. */
590	return S_OK;
591	}
592
593	/*
594	* Compare last update with how often we are supposed to check for updates.
595	*/
596	if ( !m->uCheckFreqSeconds /* Paranoia */
597	\|\| m->uCheckFreqSeconds < RT_SEC_1DAY) /* This is the minimum we currently allow. */
598	{
599	/* Consider config (enable, 0 day interval) as checking once but never again.
600	We've already check since we've got a date. */
601	*aCheckNeeded = FALSE;
602	return S_OK;
603	}
604
605	uint64_t const cCheckFreqDays = m->uCheckFreqSeconds / RT_SEC_1DAY_64;
606
607	RTTIMESPEC TimeDiff;
608	RTTimeSpecSub(RTTimeNow(&TimeDiff), &LastCheckTime);
609
610	int64_t const diffLastCheckSecs = RTTimeSpecGetSeconds(&TimeDiff);
611	int64_t const diffLastCheckDays = diffLastCheckSecs / (int64_t)RT_SEC_1DAY_64;
612
613	/* Be as accurate as possible. */
614	*aCheckNeeded = diffLastCheckSecs >= (int64_t)m->uCheckFreqSeconds ? TRUE : FALSE;
615
616	LogRel2(("Update agent (%s): Last update %RI64 days (%RI64 seconds) ago, check frequency is every %RU64 days (%RU64 seconds) -> Check %s\n",
617	mData.m_strName.c_str(), diffLastCheckDays, diffLastCheckSecs, cCheckFreqDays, m->uCheckFreqSeconds,
618	*aCheckNeeded ? "needed" : "not needed"));
619
620	return S_OK;
621	}
622
623	HRESULT UpdateAgent::getSupportedChannels(std::vector<UpdateChannel_T> &aSupportedChannels)
624	{
625	/* No need to take the read lock, as m_enmChannels is const. */
626
627	aSupportedChannels = mData.m_enmChannels;
628
629	return S_OK;
630	}
631
632
633	/*********************************************************************************************************************************
634	* Internal helper methods of update agent class *
635	*********************************************************************************************************************************/
636
637	/**
638	* Loads the settings of the update agent base class.
639	*
640	* @returns HRESULT
641	* @param data Where to load the settings from.
642	*/
643	HRESULT UpdateAgent::i_loadSettings(const settings::UpdateAgent &data)
644	{
645	AutoCaller autoCaller(this);
646	if (FAILED(autoCaller.rc())) return autoCaller.rc();
647
648	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
649
650	m->fEnabled = data.fEnabled;
651	m->enmChannel = data.enmChannel;
652	m->uCheckFreqSeconds = data.uCheckFreqSeconds;
653	m->strRepoUrl = data.strRepoUrl;
654	m->enmProxyMode = data.enmProxyMode;
655	m->strProxyUrl = data.strProxyUrl;
656	m->strLastCheckDate = data.strLastCheckDate;
657	m->uCheckCount = data.uCheckCount;
658
659	return S_OK;
660	}
661
662	/**
663	* Saves the settings of the update agent base class.
664	*
665	* @returns HRESULT
666	* @param data Where to save the settings to.
667	*/
668	HRESULT UpdateAgent::i_saveSettings(settings::UpdateAgent &data)
669	{
670	AutoCaller autoCaller(this);
671	if (FAILED(autoCaller.rc())) return autoCaller.rc();
672
673	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
674
675	data = *m;
676
677	return S_OK;
678	}
679
680	/**
681	* Sets the update check count.
682	*
683	* @returns HRESULT
684	* @param aCount Update check count to set.
685	*/
686	HRESULT UpdateAgent::i_setCheckCount(ULONG aCount)
687	{
688	AutoCaller autoCaller(this);
689	if (FAILED(autoCaller.rc())) return autoCaller.rc();
690
691	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
692
693	m->uCheckCount = aCount;
694
695	return i_commitSettings(alock);
696	}
697
698	/**
699	* Sets the last update check date.
700	*
701	* @returns HRESULT
702	* @param aDate Last update check date to set.
703	* Must be in ISO 8601 format (e.g. 2020-05-11T21:13:39.348416000Z).
704	*/
705	HRESULT UpdateAgent::i_setLastCheckDate(const com::Utf8Str &aDate)
706	{
707	AutoCaller autoCaller(this);
708	if (FAILED(autoCaller.rc())) return autoCaller.rc();
709
710	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
711
712	m->strLastCheckDate = aDate;
713
714	return i_commitSettings(alock);
715	}
716
717	/**
718	* Internal helper function to commit modified settings.
719	*
720	* @returns HRESULT
721	* @param aLock Write lock to release before committing settings.
722	*/
723	HRESULT UpdateAgent::i_commitSettings(AutoWriteLock &aLock)
724	{
725	aLock.release();
726
727	::FireUpdateAgentSettingsChangedEvent(m_EventSource, "" /** @todo Include attribute hints */);
728
729	AutoWriteLock vboxLock(m_VirtualBox COMMA_LOCKVAL_SRC_POS);
730	return m_VirtualBox->i_saveSettings();
731	}
732
733	/**
734	* Reports an error by setting the error info and also informs subscribed listeners.
735	*
736	* @returns HRESULT
737	* @param vrc Result code (IPRT-style) to report.
738	* @param pcszMsgFmt Error message to report.
739	* @param ... Format string for \a pcszMsgFmt.
740	*/
741	HRESULT UpdateAgent::i_reportError(int vrc, const char *pcszMsgFmt, ...)
742	{
743	AssertReturn(pcszMsgFmt && *pcszMsgFmt != '\0', E_INVALIDARG);
744
745	va_list va;
746	va_start(va, pcszMsgFmt);
747
748	Utf8Str strMsg;
749	int const vrc2 = strMsg.printfVNoThrow(pcszMsgFmt, va);
750	if (RT_FAILURE(vrc2))
751	{
752	va_end(va);
753	return setErrorBoth(VBOX_E_IPRT_ERROR, vrc2, tr("Failed to format update agent error string (%Rrc)"), vrc2);
754	}
755
756	va_end(va);
757
758	LogRel(("Update agent (%s): %s\n", mData.m_strName.c_str(), strMsg.c_str()));
759
760	::FireUpdateAgentErrorEvent(m_EventSource, strMsg.c_str(), vrc);
761
762	return setErrorBoth(VBOX_E_IPRT_ERROR, vrc, strMsg.c_str());
763	}
764
765
766	/*********************************************************************************************************************************
767	* Host update implementation *
768	*********************************************************************************************************************************/
769
770	HostUpdateAgent::HostUpdateAgent(void)
771	{
772	}
773
774	HostUpdateAgent::~HostUpdateAgent(void)
775	{
776	}
777
778
779	HRESULT HostUpdateAgent::FinalConstruct(void)
780	{
781	return BaseFinalConstruct();
782	}
783
784	void HostUpdateAgent::FinalRelease(void)
785	{
786	uninit();
787
788	BaseFinalRelease();
789	}
790
791	HRESULT HostUpdateAgent::init(VirtualBox *aVirtualBox)
792	{
793	// Enclose the state transition NotReady->InInit->Ready.
794	AutoInitSpan autoInitSpan(this);
795	AssertReturn(autoInitSpan.isOk(), E_FAIL);
796
797	/* Initialize the bare minimum to get things going.
798	** @todo Add more stuff later here. */
799	mData.m_strName = "VirtualBox";
800	mData.m_fHidden = false;
801
802	const UpdateChannel_T aChannels[] =
803	{
804	UpdateChannel_Stable,
805	UpdateChannel_All,
806	UpdateChannel_WithBetas
807	/** @todo Add UpdateChannel_WithTesting once it's implemented on the backend. */
808	};
809	unconst(mData.m_enmChannels).assign(aChannels, aChannels + RT_ELEMENTS(aChannels));
810
811	/* Set default repository. */
812	m->strRepoUrl = "https://update.virtualbox.org";
813
814	HRESULT hr = UpdateAgent::init(aVirtualBox);
815	if (SUCCEEDED(hr))
816	autoInitSpan.setSucceeded();
817
818	return hr;
819	}
820
821	void HostUpdateAgent::uninit(void)
822	{
823	// Enclose the state transition Ready->InUninit->NotReady.
824	AutoUninitSpan autoUninitSpan(this);
825	if (autoUninitSpan.uninitDone())
826	return;
827	}
828
829	HRESULT HostUpdateAgent::checkFor(ComPtr<IProgress> &aProgress)
830	{
831	AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
832
833	ComObjPtr<Progress> pProgress;
834	HRESULT rc = pProgress.createObject();
835	if (FAILED(rc))
836	return rc;
837
838	rc = pProgress->init(m_VirtualBox,
839	static_cast<IUpdateAgent*>(this),
840	tr("Checking for update for %s ...", this->mData.m_strName.c_str()),
841	TRUE /* aCancelable */);
842	if (FAILED(rc))
843	return rc;
844
845	/* initialize the worker task */
846	UpdateAgentTask *pTask = new UpdateAgentTask(this, pProgress);
847	rc = pTask->createThread();
848	pTask = NULL;
849	if (FAILED(rc))
850	return rc;
851
852	return pProgress.queryInterfaceTo(aProgress.asOutParam());
853	}
854
855
856	/*********************************************************************************************************************************
857	* Host update internal functions *
858	*********************************************************************************************************************************/
859
860	/**
861	* Task callback to perform an update check for the VirtualBox host (core).
862	*
863	* @returns HRESULT
864	* @param pTask Associated update agent task to use.
865	*/
866	DECLCALLBACK(HRESULT) HostUpdateAgent::i_checkForUpdateTask(UpdateAgentTask *pTask)
867	{
868	RT_NOREF(pTask);
869
870	// Following the sequence of steps in UIUpdateStepVirtualBox::sltStartStep()
871	// Build up our query URL starting with the configured repository.
872	Utf8Str strUrl;
873	strUrl.appendPrintf("%s/query.php/?", m->strRepoUrl.c_str());
874
875	// Add platform ID.
876	Bstr platform;
877	HRESULT rc = m_VirtualBox->COMGETTER(PackageType)(platform.asOutParam());
878	AssertComRCReturn(rc, rc);
879	strUrl.appendPrintf("platform=%ls", platform.raw()); // e.g. SOLARIS_64BITS_GENERIC
880
881	// Get the complete current version string for the query URL
882	Bstr versionNormalized;
883	rc = m_VirtualBox->COMGETTER(VersionNormalized)(versionNormalized.asOutParam());
884	AssertComRCReturn(rc, rc);
885	strUrl.appendPrintf("&version=%ls", versionNormalized.raw()); // e.g. 6.1.1
886	#ifdef DEBUG // Comment out previous line and uncomment this one for testing.
887	// strUrl.appendPrintf("&version=6.0.12");
888	#endif
889
890	ULONG revision = 0;
891	rc = m_VirtualBox->COMGETTER(Revision)(&revision);
892	AssertComRCReturn(rc, rc);
893	strUrl.appendPrintf("_%u", revision); // e.g. 135618
894
895	// Update the last update check timestamp.
896	RTTIME Time;
897	RTTIMESPEC TimeNow;
898	char szTimeStr[RTTIME_STR_LEN];
899	RTTimeToString(RTTimeExplode(&Time, RTTimeNow(&TimeNow)), szTimeStr, sizeof(szTimeStr));
900	LogRel2(("Update agent (%s): Setting last update check timestamp to '%s'\n", mData.m_strName.c_str(), szTimeStr));
901
902	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
903
904	m->strLastCheckDate = szTimeStr;
905	m->uCheckCount++;
906
907	rc = i_commitSettings(alock);
908	AssertComRCReturn(rc, rc);
909
910	strUrl.appendPrintf("&count=%RU32", m->uCheckCount);
911
912	// Update the query URL (if necessary) with the 'channel' information.
913	switch (m->enmChannel)
914	{
915	case UpdateChannel_All:
916	strUrl.appendPrintf("&branch=allrelease"); // query.php expects 'allrelease' and not 'allreleases'
917	break;
918	case UpdateChannel_WithBetas:
919	strUrl.appendPrintf("&branch=withbetas");
920	break;
921	/** @todo Handle UpdateChannel_WithTesting once implemented on the backend. */
922	case UpdateChannel_Stable:
923	RT_FALL_THROUGH();
924	default:
925	strUrl.appendPrintf("&branch=stable");
926	break;
927	}
928
929	LogRel2(("Update agent (%s): Using URL '%s'\n", mData.m_strName.c_str(), strUrl.c_str()));
930
931	/*
932	* Compose the User-Agent header for the GET request.
933	*/
934	Bstr version;
935	rc = m_VirtualBox->COMGETTER(Version)(version.asOutParam()); // e.g. 6.1.0_RC1
936	AssertComRCReturn(rc, rc);
937
938	Utf8StrFmt const strUserAgent("VirtualBox %ls <%s>", version.raw(), UpdateAgent::i_getPlatformInfo().c_str());
939	LogRel2(("Update agent (%s): Using user agent '%s'\n", mData.m_strName.c_str(), strUserAgent.c_str()));
940
941	/*
942	* Create the HTTP client instance and pass it to a inner worker method to
943	* ensure proper cleanup.
944	*/
945	RTHTTP hHttp = NIL_RTHTTP;
946	int vrc = RTHttpCreate(&hHttp);
947	if (RT_SUCCESS(vrc))
948	{
949	try
950	{
951	rc = i_checkForUpdateInner(hHttp, strUrl, strUserAgent);
952	}
953	catch (...)
954	{
955	AssertFailed();
956	rc = E_UNEXPECTED;
957	}
958	RTHttpDestroy(hHttp);
959	}
960	else
961	rc = i_reportError(vrc, tr("RTHttpCreate() failed: %Rrc"), vrc);
962
963	return rc;
964	}
965
966	/**
967	* Inner function of the actual update checking mechanism.
968	*
969	* @returns HRESULT
970	* @param hHttp HTTP client instance to use for checking.
971	* @param strUrl URL of repository to check.
972	* @param strUserAgent HTTP user agent to use for checking.
973	*/
974	HRESULT HostUpdateAgent::i_checkForUpdateInner(RTHTTP hHttp, Utf8Str const &strUrl, Utf8Str const &strUserAgent)
975	{
976	/** @todo Are there any other headers needed to be added first via RTHttpSetHeaders()? */
977	int vrc = RTHttpAddHeader(hHttp, "User-Agent", strUserAgent.c_str(), strUserAgent.length(), RTHTTPADDHDR_F_BACK);
978	if (RT_FAILURE(vrc))
979	return i_reportError(vrc, tr("RTHttpAddHeader() failed: %Rrc (user agent)"), vrc);
980
981	/*
982	* Configure proxying.
983	*/
984	if (m->enmProxyMode == ProxyMode_Manual)
985	{
986	vrc = RTHttpSetProxyByUrl(hHttp, m->strProxyUrl.c_str());
987	if (RT_FAILURE(vrc))
988	return i_reportError(vrc, tr("RTHttpSetProxyByUrl() failed: %Rrc"), vrc);
989	}
990	else if (m->enmProxyMode == ProxyMode_System)
991	{
992	vrc = RTHttpUseSystemProxySettings(hHttp);
993	if (RT_FAILURE(vrc))
994	return i_reportError(vrc, tr("RTHttpUseSystemProxySettings() failed: %Rrc"), vrc);
995	}
996	else
997	Assert(m->enmProxyMode == ProxyMode_NoProxy);
998
999	/*
1000	* Perform the GET request, returning raw binary stuff.
1001	*/
1002	void *pvResponse = NULL;
1003	size_t cbResponse = 0;
1004	vrc = RTHttpGetBinary(hHttp, strUrl.c_str(), &pvResponse, &cbResponse);
1005	if (RT_FAILURE(vrc))
1006	return i_reportError(vrc, tr("RTHttpGetBinary() failed: %Rrc"), vrc);
1007
1008	/* Note! We can do nothing that might throw exceptions till we call RTHttpFreeResponse! */
1009
1010	/*
1011	* If url is platform=DARWIN_64BITS_GENERIC&version=6.0.12&branch=stable for example, the reply is:
1012	* 6.0.14<SPACE>https://download.virtualbox.org/virtualbox/6.0.14/VirtualBox-6.0.14-133895-OSX.dmg
1013	* If no update required, 'UPTODATE' is returned.
1014	*/
1015	/* Parse out the two first words of the response, ignoring whatever follows: */
1016	const char pchResponse = (const char )pvResponse;
1017	while (cbResponse > 0 && *pchResponse == ' ')
1018	cbResponse--, pchResponse++;
1019
1020	char ch;
1021	const char *pchWord0 = pchResponse;
1022	while (cbResponse > 0 && (ch = *pchResponse) != ' ' && ch != '\0')
1023	cbResponse--, pchResponse++;
1024	size_t const cchWord0 = (size_t)(pchResponse - pchWord0);
1025
1026	while (cbResponse > 0 && *pchResponse == ' ')
1027	cbResponse--, pchResponse++;
1028	const char *pchWord1 = pchResponse;
1029	while (cbResponse > 0 && (ch = *pchResponse) != ' ' && ch != '\0')
1030	cbResponse--, pchResponse++;
1031	size_t const cchWord1 = (size_t)(pchResponse - pchWord1);
1032
1033	HRESULT rc;
1034
1035	/* Decode the two word: */
1036	static char const s_szUpToDate[] = "UPTODATE";
1037	if ( cchWord0 == sizeof(s_szUpToDate) - 1
1038	&& memcmp(pchWord0, s_szUpToDate, sizeof(s_szUpToDate) - 1) == 0)
1039	{
1040	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1041
1042	mData.m_enmState = UpdateState_NotAvailable;
1043	rc = S_OK;
1044
1045	alock.release(); /* Release lock before firing off event. */
1046
1047	::FireUpdateAgentStateChangedEvent(m_EventSource, UpdateState_NotAvailable);
1048	}
1049	else
1050	{
1051	mData.m_enmState = UpdateState_Error; /* Play safe by default. */
1052
1053	vrc = RTStrValidateEncodingEx(pchWord0, cchWord0, 0 /fFlags/);
1054	if (RT_SUCCESS(vrc))
1055	vrc = RTStrValidateEncodingEx(pchWord1, cchWord1, 0 /fFlags/);
1056	if (RT_SUCCESS(vrc))
1057	{
1058	/** @todo Any additional sanity checks we could perform here? */
1059	rc = mData.m_lastResult.strVer.assignEx(pchWord0, cchWord0);
1060	if (SUCCEEDED(rc))
1061	rc = mData.m_lastResult.strDownloadUrl.assignEx(pchWord1, cchWord1);
1062
1063	if (SUCCEEDED(rc))
1064	{
1065	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
1066
1067	/** @todo Implement this on the backend first.
1068	* We also could do some guessing based on the installed version vs. reported update version? */
1069	mData.m_lastResult.enmSeverity = UpdateSeverity_Invalid;
1070	mData.m_enmState = UpdateState_Available;
1071
1072	alock.release(); /* Release lock before firing off events. */
1073
1074	::FireUpdateAgentStateChangedEvent(m_EventSource, UpdateState_Available);
1075	::FireUpdateAgentAvailableEvent(m_EventSource, mData.m_lastResult.strVer, m->enmChannel,
1076	mData.m_lastResult.enmSeverity, mData.m_lastResult.strDownloadUrl,
1077	mData.m_lastResult.strWebUrl, mData.m_lastResult.strReleaseNotes);
1078	}
1079	else
1080	rc = i_reportError(VERR_GENERAL_FAILURE /** @todo Use a better rc */,
1081	tr("Invalid server response [1]: %Rhrc (%.Rhxs -- %.Rhxs)"),
1082	rc, cchWord0, pchWord0, cchWord1, pchWord1);
1083
1084	LogRel2(("Update agent (%s): HTTP server replied: %.s %.s\n",
1085	mData.m_strName.c_str(), cchWord0, pchWord0, cchWord1, pchWord1));
1086	}
1087	else
1088	rc = i_reportError(vrc, tr("Invalid server response [2]: %Rrc (%.Rhxs -- %.Rhxs)"),
1089	vrc, cchWord0, pchWord0, cchWord1, pchWord1);
1090	}
1091
1092	RTHttpFreeResponse(pvResponse);
1093
1094	return rc;
1095	}
1096

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/src-server/UpdateAgentImpl.cpp@ 94729

Download in other formats: