extensions/source/update/check/updateprotocol.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #include <com/sun/star/xml/xpath/XXPathAPI.hpp>
  30
  31 #include "updateprotocol.hxx"
  32 #include "updatecheckconfig.hxx"
  33
  34 #include <com/sun/star/deployment/UpdateInformationEntry.hpp>
  35 #include <com/sun/star/deployment/XPackageInformationProvider.hpp>
  36
  37
  38 #include <rtl/ref.hxx>
  39 #include <rtl/uri.hxx>
  40 #include <rtl/strbuf.hxx>
  41 #include <rtl/ustrbuf.hxx>
  42 #include <rtl/bootstrap.hxx>
  43 #include <osl/process.h>
  44
  45 #include <cppuhelper/implbase1.hxx>
  46
  47 namespace css = com::sun::star ;
  48 namespace container = css::container ;
  49 namespace deployment = css::deployment ;
  50 namespace lang = css::lang ;
  51 namespace uno = css::uno ;
  52 namespace task = css::task ;
  53 namespace xml = css::xml ;
  54
  55 #define UNISTRING(s) rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(s))
  56
  57 //------------------------------------------------------------------------------
  58
  59 static bool
  60 getBootstrapData(
  61     uno::Sequence< ::rtl::OUString > & rRepositoryList,
  62     ::rtl::OUString & rGitID,
  63     ::rtl::OUString & rInstallSetID)
  64 {
  65     rGitID = UNISTRING( "${$BRAND_BASE_DIR/program/" SAL_CONFIGFILE("version") ":buildid}" );
  66     rtl::Bootstrap::expandMacros( rGitID );
  67     if ( rGitID.isEmpty() )
  68         return false;
  69
  70     rInstallSetID = UNISTRING( "${$BRAND_BASE_DIR/program/" SAL_CONFIGFILE("version") ":UpdateID}" );
  71     rtl::Bootstrap::expandMacros( rInstallSetID );
  72     if ( rInstallSetID.isEmpty() )
  73         return false;
  74
  75     rtl::OUString aValue( UNISTRING( "${$BRAND_BASE_DIR/program/" SAL_CONFIGFILE("version") ":UpdateURL}" ) );
  76     rtl::Bootstrap::expandMacros( aValue );
  77
  78     if( !aValue.isEmpty() )
  79     {
  80         rRepositoryList.realloc(1);
  81         rRepositoryList[0] = aValue;
  82     }
  83
  84     return true;
  85 }
  86
  87 //------------------------------------------------------------------------------
  88
  89 // Returns 'true' if successfully connected to the update server
  90 bool
  91 checkForUpdates(
  92     UpdateInfo& o_rUpdateInfo,
  93     uno::Reference< uno::XComponentContext > const & rxContext,
  94     uno::Reference< task::XInteractionHandler > const & rxInteractionHandler,
  95     const uno::Reference< deployment::XUpdateInformationProvider >& rUpdateInfoProvider)
  96 {
  97     OSL_TRACE("checking for updates ..");
  98
  99     ::rtl::OUString myArch;
 100     ::rtl::OUString myOS;
 101
 102     rtl::Bootstrap::get(UNISTRING("_OS"), myOS);
 103     rtl::Bootstrap::get(UNISTRING("_ARCH"), myArch);
 104
 105     uno::Sequence< ::rtl::OUString > aRepositoryList;
 106     ::rtl::OUString aGitID;
 107     ::rtl::OUString aInstallSetID;
 108
 109     if( ! ( getBootstrapData(aRepositoryList, aGitID, aInstallSetID) && (aRepositoryList.getLength() > 0) ) )
 110         return false;
 111
 112     return checkForUpdates( o_rUpdateInfo, rxContext, rxInteractionHandler, rUpdateInfoProvider,
 113             myOS, myArch,
 114             aRepositoryList, aGitID, aInstallSetID );
 115 }
 116
 117 bool
 118 checkForUpdates(
 119     UpdateInfo& o_rUpdateInfo,
 120     const uno::Reference< uno::XComponentContext > & rxContext,
 121     const uno::Reference< task::XInteractionHandler > & rxInteractionHandler,
 122     const uno::Reference< deployment::XUpdateInformationProvider >& rUpdateInfoProvider,
 123     const rtl::OUString &rOS,
 124     const rtl::OUString &rArch,
 125     const uno::Sequence< rtl::OUString > &rRepositoryList,
 126     const rtl::OUString &rGitID,
 127     const rtl::OUString &rInstallSetID )
 128 {
 129     if( !rxContext.is() )
 130         throw uno::RuntimeException(
 131             UNISTRING( "checkForUpdates: empty component context" ), uno::Reference< uno::XInterface >() );
 132
 133     OSL_ASSERT( rxContext->getServiceManager().is() );
 134
 135     // XPath implementation
 136     uno::Reference< xml::xpath::XXPathAPI > xXPath(
 137         rxContext->getServiceManager()->createInstanceWithContext( UNISTRING( "com.sun.star.xml.xpath.XPathAPI" ), rxContext ),
 138         uno::UNO_QUERY_THROW);
 139
 140     xXPath->registerNS( UNISTRING("inst"), UNISTRING("http://update.libreoffice.org/description") );
 141
 142     if( rxInteractionHandler.is() )
 143         rUpdateInfoProvider->setInteractionHandler(rxInteractionHandler);
 144
 145     try
 146     {
 147         uno::Reference< container::XEnumeration > aUpdateInfoEnumeration =
 148             rUpdateInfoProvider->getUpdateInformationEnumeration( rRepositoryList, rInstallSetID );
 149
 150         if ( !aUpdateInfoEnumeration.is() )
 151             return false; // something went wrong ..
 152
 153         rtl::OUStringBuffer aBuffer;
 154         aBuffer.appendAscii("/child::inst:description[inst:os=\'");
 155         aBuffer.append( rOS );
 156         aBuffer.appendAscii("\' and inst:arch=\'");
 157         aBuffer.append( rArch );
 158         aBuffer.appendAscii("\' and inst:gitid!=\'");
 159         aBuffer.append( rGitID );
 160         aBuffer.appendAscii("\']");
 161
 162         rtl::OUString aXPathExpression = aBuffer.makeStringAndClear();
 163
 164         while( aUpdateInfoEnumeration->hasMoreElements() )
 165         {
 166             deployment::UpdateInformationEntry aEntry;
 167
 168             if( aUpdateInfoEnumeration->nextElement() >>= aEntry )
 169             {
 170                 uno::Reference< xml::dom::XNode > xNode( aEntry.UpdateDocument.get() );
 171                 uno::Reference< xml::dom::XNodeList > xNodeList;
 172                 try {
 173                     xNodeList = xXPath->selectNodeList(xNode, aXPathExpression
 174                         + UNISTRING("/inst:update/attribute::src"));
 175                 } catch (const css::xml::xpath::XPathException &) {
 176                     // ignore
 177                 }
 178
 179 /*
 180                 o_rUpdateInfo.Sources.push_back( DownloadSource(true,
 181                     UNISTRING("http://openoffice.bouncer.osuosl.org/?product=OpenOffice.org&os=solarissparcwjre&lang=en-US&version=2.2.1") ) );
 182 */
 183
 184                 sal_Int32 i, imax = xNodeList->getLength();
 185                 for( i = 0; i < imax; ++i )
 186                 {
 187                     uno::Reference< xml::dom::XNode > xNode2( xNodeList->item(i) );
 188
 189                     if( xNode2.is() )
 190                     {
 191                         uno::Reference< xml::dom::XElement > xParent(xNode2->getParentNode(), uno::UNO_QUERY_THROW);
 192                         rtl::OUString aType = xParent->getAttribute(UNISTRING("type"));
 193                         bool bIsDirect = ( sal_False == aType.equalsIgnoreAsciiCaseAsciiL(RTL_CONSTASCII_STRINGPARAM("text/html")) );
 194
 195                         o_rUpdateInfo.Sources.push_back( DownloadSource(bIsDirect, xNode2->getNodeValue()) );
 196                     }
 197                 }
 198
 199                 uno::Reference< xml::dom::XNode > xNode2;
 200                 try {
 201                     xNode2 = xXPath->selectSingleNode(xNode, aXPathExpression
 202                         + UNISTRING("/inst:version/text()"));
 203                 } catch (const css::xml::xpath::XPathException &) {
 204                     // ignore
 205                 }
 206
 207                 if( xNode2.is() )
 208                     o_rUpdateInfo.Version = xNode2->getNodeValue();
 209
 210                 try {
 211                     xNode2 = xXPath->selectSingleNode(xNode, aXPathExpression
 212                         + UNISTRING("/inst:buildid/text()"));
 213                 } catch (const css::xml::xpath::XPathException &) {
 214                     // ignore
 215                 }
 216
 217                 if( xNode2.is() )
 218                     o_rUpdateInfo.BuildId = xNode2->getNodeValue();
 219
 220                 o_rUpdateInfo.Description = aEntry.Description;
 221
 222                 // Release Notes
 223                 try {
 224                     xNodeList = xXPath->selectNodeList(xNode, aXPathExpression
 225                         + UNISTRING("/inst:relnote"));
 226                 } catch (const css::xml::xpath::XPathException &) {
 227                     // ignore
 228                 }
 229                 imax = xNodeList->getLength();
 230                 for( i = 0; i < imax; ++i )
 231                 {
 232                     uno::Reference< xml::dom::XElement > xRelNote(xNodeList->item(i), uno::UNO_QUERY);
 233                     if( xRelNote.is() )
 234                     {
 235                         sal_Int32 pos = xRelNote->getAttribute(UNISTRING("pos")).toInt32();
 236
 237                         ReleaseNote aRelNote((sal_uInt8) pos, xRelNote->getAttribute(UNISTRING("src")));
 238
 239                         if( xRelNote->hasAttribute(UNISTRING("src2")) )
 240                         {
 241                             pos = xRelNote->getAttribute(UNISTRING("pos2")).toInt32();
 242                             aRelNote.Pos2 = (sal_Int8) pos;
 243                             aRelNote.URL2 = xRelNote->getAttribute(UNISTRING("src2"));
 244                         }
 245
 246                         o_rUpdateInfo.ReleaseNotes.push_back(aRelNote);
 247                     }
 248                 }
 249
 250                 if( !o_rUpdateInfo.Sources.empty() )
 251                     return true;
 252             }
 253         }
 254     }
 255     catch( ... )
 256     {
 257         return false;
 258     }
 259
 260     return true;
 261 }
 262
 263 //------------------------------------------------------------------------------
 264 bool storeExtensionUpdateInfos( const uno::Reference< uno::XComponentContext > & rxContext,
 265                                 const uno::Sequence< uno::Sequence< rtl::OUString > > &rUpdateInfos )
 266 {
 267     bool bNotify = false;
 268
 269     if ( rUpdateInfos.hasElements() )
 270     {
 271         rtl::Reference< UpdateCheckConfig > aConfig = UpdateCheckConfig::get( rxContext );
 272
 273         for ( sal_Int32 i = rUpdateInfos.getLength() - 1; i >= 0; i-- )
 274         {
 275             bNotify |= aConfig->storeExtensionVersion( rUpdateInfos[i][0], rUpdateInfos[i][1] );
 276         }
 277     }
 278     return bNotify;
 279 }
 280
 281 //------------------------------------------------------------------------------
 282 // Returns 'true' if there are updates for any extension
 283
 284 bool checkForExtensionUpdates( const uno::Reference< uno::XComponentContext > & rxContext )
 285 {
 286     uno::Sequence< uno::Sequence< rtl::OUString > > aUpdateList;
 287
 288     uno::Reference< deployment::XPackageInformationProvider > xInfoProvider;
 289     try
 290     {
 291         uno::Any aValue( rxContext->getValueByName(
 292                 UNISTRING( "/singletons/com.sun.star.deployment.PackageInformationProvider" ) ) );
 293         OSL_VERIFY( aValue >>= xInfoProvider );
 294     }
 295     catch( const uno::Exception& )
 296     {
 297         OSL_FAIL( "checkForExtensionUpdates: could not create the PackageInformationProvider!" );
 298     }
 299
 300     if ( !xInfoProvider.is() ) return false;
 301
 302     aUpdateList = xInfoProvider->isUpdateAvailable( ::rtl::OUString() );
 303     bool bNotify = storeExtensionUpdateInfos( rxContext, aUpdateList );
 304
 305     return bNotify;
 306 }
 307
 308 //------------------------------------------------------------------------------
 309 // Returns 'true' if there are any pending updates for any extension (offline check)
 310
 311 bool checkForPendingUpdates( const uno::Reference< uno::XComponentContext > & rxContext )
 312 {
 313     uno::Sequence< uno::Sequence< rtl::OUString > > aExtensionList;
 314     uno::Reference< deployment::XPackageInformationProvider > xInfoProvider;
 315     try
 316     {
 317         uno::Any aValue( rxContext->getValueByName(
 318                 UNISTRING( "/singletons/com.sun.star.deployment.PackageInformationProvider" ) ) );
 319         OSL_VERIFY( aValue >>= xInfoProvider );
 320     }
 321     catch( const uno::Exception& )
 322     {
 323         OSL_FAIL( "checkForExtensionUpdates: could not create the PackageInformationProvider!" );
 324     }
 325
 326     if ( !xInfoProvider.is() ) return false;
 327
 328     bool bPendingUpdateFound = false;
 329
 330     aExtensionList = xInfoProvider->getExtensionList();
 331     if ( aExtensionList.hasElements() )
 332     {
 333         rtl::Reference< UpdateCheckConfig > aConfig = UpdateCheckConfig::get( rxContext );
 334
 335         for ( sal_Int32 i = aExtensionList.getLength() - 1; i >= 0; i-- )
 336         {
 337             bPendingUpdateFound = aConfig->checkExtensionVersion( aExtensionList[i][0], aExtensionList[i][1] );
 338             if ( bPendingUpdateFound )
 339                 break;
 340         }
 341     }
 342
 343     return bPendingUpdateFound;
 344 }
 345
 346 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */