Files
libreoffice/extensions/source/update/check/updateprotocol.cxx
Jan Holesovsky b87fa222f1 online update: Unit testing framework + rewrite of load().
- introduce first two basic tests (to be improved)
- rewrite of UpdateInformationProvider::load() to use comphelper
- smaller splitting of functions to be able to unit test
2011-11-30 00:24:51 +01:00

347 lines
12 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#include <com/sun/star/xml/xpath/XXPathAPI.hpp>
#include "updateprotocol.hxx"
#include "updatecheckconfig.hxx"
#include <com/sun/star/deployment/UpdateInformationEntry.hpp>
#include <com/sun/star/deployment/XPackageInformationProvider.hpp>
#include <rtl/ref.hxx>
#include <rtl/uri.hxx>
#include <rtl/strbuf.hxx>
#include <rtl/ustrbuf.hxx>
#include <rtl/bootstrap.hxx>
#include <osl/process.h>
#include <cppuhelper/implbase1.hxx>
namespace css = com::sun::star ;
namespace container = css::container ;
namespace deployment = css::deployment ;
namespace lang = css::lang ;
namespace uno = css::uno ;
namespace task = css::task ;
namespace xml = css::xml ;
#define UNISTRING(s) rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(s))
//------------------------------------------------------------------------------
static bool
getBootstrapData(
uno::Sequence< ::rtl::OUString > & rRepositoryList,
::rtl::OUString & rBuildID,
::rtl::OUString & rInstallSetID)
{
rBuildID = UNISTRING( "${$BRAND_BASE_DIR/program/" SAL_CONFIGFILE("version") ":ProductBuildid}" );
rtl::Bootstrap::expandMacros( rBuildID );
if ( ! rBuildID.getLength() )
return false;
rInstallSetID = UNISTRING( "${$BRAND_BASE_DIR/program/" SAL_CONFIGFILE("version") ":UpdateID}" );
rtl::Bootstrap::expandMacros( rInstallSetID );
if ( ! rInstallSetID.getLength() )
return false;
rtl::OUString aValue( UNISTRING( "${$BRAND_BASE_DIR/program/" SAL_CONFIGFILE("version") ":UpdateURL}" ) );
rtl::Bootstrap::expandMacros( aValue );
if( aValue.getLength() > 0 )
{
rRepositoryList.realloc(1);
rRepositoryList[0] = aValue;
}
return true;
}
//------------------------------------------------------------------------------
// Returns 'true' if successfully connected to the update server
bool
checkForUpdates(
UpdateInfo& o_rUpdateInfo,
uno::Reference< uno::XComponentContext > const & rxContext,
uno::Reference< task::XInteractionHandler > const & rxInteractionHandler,
const uno::Reference< deployment::XUpdateInformationProvider >& rUpdateInfoProvider)
{
OSL_TRACE("checking for updates ..");
::rtl::OUString myArch;
::rtl::OUString myOS;
rtl::Bootstrap::get(UNISTRING("_OS"), myOS);
rtl::Bootstrap::get(UNISTRING("_ARCH"), myArch);
uno::Sequence< ::rtl::OUString > aRepositoryList;
::rtl::OUString aBuildID;
::rtl::OUString aInstallSetID;
if( ! ( getBootstrapData(aRepositoryList, aBuildID, aInstallSetID) && (aRepositoryList.getLength() > 0) ) )
return false;
return checkForUpdates( o_rUpdateInfo, rxContext, rxInteractionHandler, rUpdateInfoProvider,
myOS, myArch,
aRepositoryList, aBuildID, aInstallSetID );
}
bool
checkForUpdates(
UpdateInfo& o_rUpdateInfo,
const uno::Reference< uno::XComponentContext > & rxContext,
const uno::Reference< task::XInteractionHandler > & rxInteractionHandler,
const uno::Reference< deployment::XUpdateInformationProvider >& rUpdateInfoProvider,
const rtl::OUString &rOS,
const rtl::OUString &rArch,
const uno::Sequence< rtl::OUString > &rRepositoryList,
const rtl::OUString &rBuildID,
const rtl::OUString &rInstallSetID )
{
if( !rxContext.is() )
throw uno::RuntimeException(
UNISTRING( "checkForUpdates: empty component context" ), uno::Reference< uno::XInterface >() );
OSL_ASSERT( rxContext->getServiceManager().is() );
// XPath implementation
uno::Reference< xml::xpath::XXPathAPI > xXPath(
rxContext->getServiceManager()->createInstanceWithContext( UNISTRING( "com.sun.star.xml.xpath.XPathAPI" ), rxContext ),
uno::UNO_QUERY_THROW);
xXPath->registerNS( UNISTRING("inst"), UNISTRING("http://update.libreoffice.org/description") );
if( rxInteractionHandler.is() )
rUpdateInfoProvider->setInteractionHandler(rxInteractionHandler);
try
{
uno::Reference< container::XEnumeration > aUpdateInfoEnumeration =
rUpdateInfoProvider->getUpdateInformationEnumeration( rRepositoryList, rInstallSetID );
if ( !aUpdateInfoEnumeration.is() )
return false; // something went wrong ..
rtl::OUStringBuffer aBuffer;
aBuffer.appendAscii("/child::inst:description[inst:os=\'");
aBuffer.append( rOS );
aBuffer.appendAscii("\' and inst:arch=\'");
aBuffer.append( rArch );
aBuffer.appendAscii("\' and inst:buildid>");
aBuffer.append( rBuildID );
aBuffer.appendAscii("]");
rtl::OUString aXPathExpression = aBuffer.makeStringAndClear();
while( aUpdateInfoEnumeration->hasMoreElements() )
{
deployment::UpdateInformationEntry aEntry;
if( aUpdateInfoEnumeration->nextElement() >>= aEntry )
{
uno::Reference< xml::dom::XNode > xNode( aEntry.UpdateDocument.get() );
uno::Reference< xml::dom::XNodeList > xNodeList;
try {
xNodeList = xXPath->selectNodeList(xNode, aXPathExpression
+ UNISTRING("/inst:update/attribute::src"));
} catch (css::xml::xpath::XPathException &) {
// ignore
}
/*
o_rUpdateInfo.Sources.push_back( DownloadSource(true,
UNISTRING("http://openoffice.bouncer.osuosl.org/?product=OpenOffice.org&os=solarissparcwjre&lang=en-US&version=2.2.1") ) );
*/
sal_Int32 i, imax = xNodeList->getLength();
for( i = 0; i < imax; ++i )
{
uno::Reference< xml::dom::XNode > xNode2( xNodeList->item(i) );
if( xNode2.is() )
{
uno::Reference< xml::dom::XElement > xParent(xNode2->getParentNode(), uno::UNO_QUERY_THROW);
rtl::OUString aType = xParent->getAttribute(UNISTRING("type"));
bool bIsDirect = ( sal_False == aType.equalsIgnoreAsciiCaseAscii("text/html") );
o_rUpdateInfo.Sources.push_back( DownloadSource(bIsDirect, xNode2->getNodeValue()) );
}
}
uno::Reference< xml::dom::XNode > xNode2;
try {
xNode2 = xXPath->selectSingleNode(xNode, aXPathExpression
+ UNISTRING("/inst:version/text()"));
} catch (css::xml::xpath::XPathException &) {
// ignore
}
if( xNode2.is() )
o_rUpdateInfo.Version = xNode2->getNodeValue();
try {
xNode2 = xXPath->selectSingleNode(xNode, aXPathExpression
+ UNISTRING("/inst:buildid/text()"));
} catch (css::xml::xpath::XPathException &) {
// ignore
}
if( xNode2.is() )
o_rUpdateInfo.BuildId = xNode2->getNodeValue();
o_rUpdateInfo.Description = aEntry.Description;
// Release Notes
try {
xNodeList = xXPath->selectNodeList(xNode, aXPathExpression
+ UNISTRING("/inst:relnote"));
} catch (css::xml::xpath::XPathException &) {
// ignore
}
imax = xNodeList->getLength();
for( i = 0; i < imax; ++i )
{
uno::Reference< xml::dom::XElement > xRelNote(xNodeList->item(i), uno::UNO_QUERY);
if( xRelNote.is() )
{
sal_Int32 pos = xRelNote->getAttribute(UNISTRING("pos")).toInt32();
ReleaseNote aRelNote((sal_uInt8) pos, xRelNote->getAttribute(UNISTRING("src")));
if( xRelNote->hasAttribute(UNISTRING("src2")) )
{
pos = xRelNote->getAttribute(UNISTRING("pos2")).toInt32();
aRelNote.Pos2 = (sal_Int8) pos;
aRelNote.URL2 = xRelNote->getAttribute(UNISTRING("src2"));
}
o_rUpdateInfo.ReleaseNotes.push_back(aRelNote);
}
}
if( !o_rUpdateInfo.Sources.empty() )
return true;
}
}
}
catch( ... )
{
return false;
}
return true;
}
//------------------------------------------------------------------------------
bool storeExtensionUpdateInfos( const uno::Reference< uno::XComponentContext > & rxContext,
const uno::Sequence< uno::Sequence< rtl::OUString > > &rUpdateInfos )
{
bool bNotify = false;
if ( rUpdateInfos.hasElements() )
{
rtl::Reference< UpdateCheckConfig > aConfig = UpdateCheckConfig::get( rxContext );
for ( sal_Int32 i = rUpdateInfos.getLength() - 1; i >= 0; i-- )
{
bNotify |= aConfig->storeExtensionVersion( rUpdateInfos[i][0], rUpdateInfos[i][1] );
}
}
return bNotify;
}
//------------------------------------------------------------------------------
// Returns 'true' if there are updates for any extension
bool checkForExtensionUpdates( const uno::Reference< uno::XComponentContext > & rxContext )
{
uno::Sequence< uno::Sequence< rtl::OUString > > aUpdateList;
uno::Reference< deployment::XPackageInformationProvider > xInfoProvider;
try
{
uno::Any aValue( rxContext->getValueByName(
UNISTRING( "/singletons/com.sun.star.deployment.PackageInformationProvider" ) ) );
OSL_VERIFY( aValue >>= xInfoProvider );
}
catch( const uno::Exception& )
{
OSL_FAIL( "checkForExtensionUpdates: could not create the PackageInformationProvider!" );
}
if ( !xInfoProvider.is() ) return false;
aUpdateList = xInfoProvider->isUpdateAvailable( ::rtl::OUString() );
bool bNotify = storeExtensionUpdateInfos( rxContext, aUpdateList );
return bNotify;
}
//------------------------------------------------------------------------------
// Returns 'true' if there are any pending updates for any extension (offline check)
bool checkForPendingUpdates( const uno::Reference< uno::XComponentContext > & rxContext )
{
uno::Sequence< uno::Sequence< rtl::OUString > > aExtensionList;
uno::Reference< deployment::XPackageInformationProvider > xInfoProvider;
try
{
uno::Any aValue( rxContext->getValueByName(
UNISTRING( "/singletons/com.sun.star.deployment.PackageInformationProvider" ) ) );
OSL_VERIFY( aValue >>= xInfoProvider );
}
catch( const uno::Exception& )
{
OSL_FAIL( "checkForExtensionUpdates: could not create the PackageInformationProvider!" );
}
if ( !xInfoProvider.is() ) return false;
bool bPendingUpdateFound = false;
aExtensionList = xInfoProvider->getExtensionList();
if ( aExtensionList.hasElements() )
{
rtl::Reference< UpdateCheckConfig > aConfig = UpdateCheckConfig::get( rxContext );
for ( sal_Int32 i = aExtensionList.getLength() - 1; i >= 0; i-- )
{
bPendingUpdateFound = aConfig->checkExtensionVersion( aExtensionList[i][0], aExtensionList[i][1] );
if ( bPendingUpdateFound )
break;
}
}
return bPendingUpdateFound;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */