/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . */ #include "updatecheckconfig.hxx" #include "updatecheck.hxx" #include #include #include #include #include #include #include #include #include #include #include #ifdef _WIN32 #include #include #endif namespace container = com::sun::star::container ; namespace beans = com::sun::star::beans ; namespace lang = com::sun::star::lang ; namespace util = com::sun::star::util ; namespace uno = com::sun::star::uno ; #define LAST_CHECK "LastCheck" #define UPDATE_VERSION "UpdateVersion" #define UPDATE_BUILDID "UpdateBuildId" #define UPDATE_DESCRIPTION "UpdateDescription" #define DOWNLOAD_URL "DownloadURL" #define IS_DIRECT_DOWNLOAD "IsDirectDownload" #define OLD_VERSION "UpdateFoundFor" #define AUTOCHECK_ENABLED "AutoCheckEnabled" #define AUTODOWNLOAD_ENABLED "AutoDownloadEnabled" #define CHECK_INTERVAL "CheckInterval" #define LOCAL_FILE "LocalFile" #define DOWNLOAD_SIZE "DownloadSize" #define DOWNLOAD_PAUSED "DownloadPaused" #define DOWNLOAD_DESTINATION "DownloadDestination" #define RELEASE_NOTE "ReleaseNote" #define PROPERTY_VERSION "Version" const char * const aUpdateEntryProperties[] = { UPDATE_VERSION, UPDATE_BUILDID, UPDATE_DESCRIPTION, DOWNLOAD_URL, IS_DIRECT_DOWNLOAD, RELEASE_NOTE"1", RELEASE_NOTE"2", RELEASE_NOTE"3", RELEASE_NOTE"4", RELEASE_NOTE"5", OLD_VERSION }; const sal_uInt32 nUpdateEntryProperties = SAL_N_ELEMENTS(aUpdateEntryProperties); css::uno::Any NamedValueByNameAccess::getValue(const char * pName) { const sal_Int32 nLen = m_rValues.getLength(); for( sal_Int32 n=0; n < nLen; ++n ) { if( m_rValues[n].Name.equalsAscii( pName ) ) return m_rValues[n].Value; } return css::uno::Any(); } bool UpdateCheckROModel::isAutoCheckEnabled() const { return m_aNameAccess.getValue(AUTOCHECK_ENABLED).get(); } bool UpdateCheckROModel::isDownloadPaused() const { return m_aNameAccess.getValue(DOWNLOAD_PAUSED).get(); } OUString UpdateCheckROModel::getStringValue(const char * pStr) const { uno::Any aAny( m_aNameAccess.getValue(pStr) ); OUString aRet; aAny >>= aRet; return aRet; } OUString UpdateCheckROModel::getLocalFileName() const { return getStringValue(LOCAL_FILE); }; sal_Int64 UpdateCheckROModel::getDownloadSize() const { uno::Any aAny( m_aNameAccess.getValue(DOWNLOAD_SIZE) ); sal_Int64 nRet = -1; aAny >>= nRet; return nRet; }; OUString UpdateCheckROModel::getUpdateEntryVersion() const { return getStringValue(OLD_VERSION); } void UpdateCheckROModel::getUpdateEntry(UpdateInfo& rInfo) const { rInfo.BuildId = getStringValue(UPDATE_BUILDID); rInfo.Version = getStringValue(UPDATE_VERSION); rInfo.Description = getStringValue(UPDATE_DESCRIPTION); bool isDirectDownload = false; m_aNameAccess.getValue(IS_DIRECT_DOWNLOAD) >>= isDirectDownload; rInfo.Sources.emplace_back(isDirectDownload, getStringValue(DOWNLOAD_URL)); for(sal_Int32 n=1; n < 6; ++n ) { OUString aUStr = getStringValue( OString(OString::Concat(RELEASE_NOTE) + OString::number(n)).getStr()); if( !aUStr.isEmpty() ) rInfo.ReleaseNotes.emplace_back(static_cast(n), aUStr); } } OUString UpdateCheckConfig::getDownloadsDirectory() { OUString aRet; #ifdef _WIN32 PWSTR szPath; if (SHGetKnownFolderPath(FOLDERID_Downloads, 0, nullptr, &szPath) == S_OK) { aRet = o3tl::toU(szPath); CoTaskMemFree(szPath); osl::FileBase::getFileURLFromSystemPath( aRet, aRet ); } #else // This should become a desktop specific setting in some system backend .. OUString aHomeDir; osl::Security().getHomeDir( aHomeDir ); aRet = aHomeDir + "/Desktop"; // Set path to home directory when there is no /Desktop directory osl::Directory aDocumentsDir( aRet ); if( osl::FileBase::E_None != aDocumentsDir.open() ) aRet = aHomeDir; #endif return aRet; } OUString UpdateCheckConfig::getAllUsersDirectory() { OUString aRet; #ifdef _WIN32 PWSTR szPath = nullptr; if (SUCCEEDED(SHGetKnownFolderPath(FOLDERID_PublicDocuments, KF_FLAG_CREATE, nullptr, &szPath))) { aRet = o3tl::toU(szPath); osl::FileBase::getFileURLFromSystemPath( aRet, aRet ); } CoTaskMemFree(szPath); #else osl::FileBase::getTempDirURL(aRet); #endif return aRet; } UpdateCheckConfig::UpdateCheckConfig( const uno::Reference& xContainer, const uno::Reference& xAvailableUpdates, const uno::Reference& xIgnoredUpdates, const ::rtl::Reference< UpdateCheckConfigListener >& rListener ) : m_xContainer( xContainer ), m_xAvailableUpdates( xAvailableUpdates ), m_xIgnoredUpdates( xIgnoredUpdates ), m_rListener( rListener ) {} UpdateCheckConfig::~UpdateCheckConfig() {} ::rtl::Reference< UpdateCheckConfig > UpdateCheckConfig::get( const uno::Reference& xContext, const ::rtl::Reference< UpdateCheckConfigListener >& rListener) { uno::Reference< lang::XMultiServiceFactory > xConfigProvider( css::configuration::theDefaultProvider::get( xContext ) ); beans::PropertyValue aProperty; aProperty.Name = "nodepath"; aProperty.Value <<= u"org.openoffice.Office.Jobs/Jobs/UpdateCheck/Arguments"_ustr; uno::Sequence< uno::Any > aArgumentList{ uno::Any(aProperty) }; uno::Reference< container::XNameContainer > xContainer( xConfigProvider->createInstanceWithArguments( u"com.sun.star.configuration.ConfigurationUpdateAccess"_ustr, aArgumentList ), uno::UNO_QUERY_THROW ); aProperty.Value <<= u"/org.openoffice.Office.ExtensionManager/ExtensionUpdateData/IgnoredUpdates"_ustr; aArgumentList = { uno::Any(aProperty) }; uno::Reference< container::XNameContainer > xIgnoredExt( xConfigProvider->createInstanceWithArguments( u"com.sun.star.configuration.ConfigurationUpdateAccess"_ustr, aArgumentList ), uno::UNO_QUERY_THROW ); aProperty.Value <<= u"/org.openoffice.Office.ExtensionManager/ExtensionUpdateData/AvailableUpdates"_ustr; aArgumentList = { uno::Any(aProperty) }; uno::Reference< container::XNameContainer > xUpdateAvail( xConfigProvider->createInstanceWithArguments( u"com.sun.star.configuration.ConfigurationUpdateAccess"_ustr, aArgumentList ), uno::UNO_QUERY_THROW ); return new UpdateCheckConfig( xContainer, xUpdateAvail, xIgnoredExt, rListener ); } bool UpdateCheckConfig::isAutoCheckEnabled() const { bool nValue = false; const_cast < UpdateCheckConfig *> (this)->getByName( u"" AUTOCHECK_ENABLED ""_ustr ) >>= nValue; return nValue; } bool UpdateCheckConfig::isAutoDownloadEnabled() const { bool nValue = false; const_cast < UpdateCheckConfig *> (this)->getByName( u"" AUTODOWNLOAD_ENABLED ""_ustr ) >>= nValue; return nValue; } OUString UpdateCheckConfig::getUpdateEntryVersion() const { OUString aValue; // getByName is defined as non const in XNameAccess const_cast < UpdateCheckConfig *> (this)->getByName( u"" OLD_VERSION ""_ustr ) >>= aValue; return aValue; } sal_Int64 UpdateCheckConfig::getLastChecked() const { sal_Int64 nValue = 0; // getByName is defined as non const in XNameAccess const_cast < UpdateCheckConfig *> (this)->getByName( u"" LAST_CHECK ""_ustr ) >>= nValue; return nValue; } sal_Int64 UpdateCheckConfig::getCheckInterval() const { sal_Int64 nValue = 0; // getByName is defined as non const in XNameAccess const_cast < UpdateCheckConfig *> (this)->getByName( u"" CHECK_INTERVAL ""_ustr ) >>= nValue; return nValue; } OUString UpdateCheckConfig::getLocalFileName() const { OUString aName = u"" LOCAL_FILE ""_ustr; OUString aRet; if( m_xContainer->hasByName(aName) ) m_xContainer->getByName(aName) >>= aRet; return aRet; } OUString UpdateCheckConfig::getDownloadDestination() const { OUString aRet; const_cast (this)->getByName(u"" DOWNLOAD_DESTINATION ""_ustr) >>= aRet; return aRet; } void UpdateCheckConfig::storeLocalFileName(const OUString& rLocalFileName, sal_Int64 nFileSize) { const sal_uInt8 nItems = 2; const OUString aNameList[nItems] = { u"" LOCAL_FILE ""_ustr, u"" DOWNLOAD_SIZE ""_ustr }; const uno::Any aValueList[nItems] = { uno::Any(rLocalFileName), uno::Any(nFileSize) }; for( sal_uInt8 i=0; i < nItems; ++i ) { if( m_xContainer->hasByName(aNameList[i]) ) m_xContainer->replaceByName(aNameList[i], aValueList[i]); else m_xContainer->insertByName(aNameList[i], aValueList[i]); } commitChanges(); } void UpdateCheckConfig::clearLocalFileName() { const sal_uInt8 nItems = 2; const OUString aNameList[nItems] = { u"" LOCAL_FILE ""_ustr, u"" DOWNLOAD_SIZE ""_ustr }; for(const auto & i : aNameList) { if( m_xContainer->hasByName(i) ) m_xContainer->removeByName(i); } commitChanges(); } void UpdateCheckConfig::storeDownloadPaused(bool paused) { replaceByName(u"" DOWNLOAD_PAUSED ""_ustr , uno::Any(paused)); commitChanges(); } void UpdateCheckConfig::updateLastChecked() { TimeValue systime; osl_getSystemTime(&systime); sal_Int64 lastCheck = systime.Seconds; replaceByName(u"" LAST_CHECK ""_ustr, uno::Any(lastCheck)); } void UpdateCheckConfig::storeUpdateFound( const UpdateInfo& rInfo, const OUString& aCurrentBuild) { bool autoDownloadEnabled = isAutoDownloadEnabled(); uno::Any aValues[nUpdateEntryProperties] = { uno::Any(rInfo.Version), uno::Any(rInfo.BuildId), uno::Any(rInfo.Description), uno::Any(rInfo.Sources[0].URL), uno::Any(rInfo.Sources[0].IsDirect), uno::Any(getReleaseNote(rInfo, 1, autoDownloadEnabled) ), uno::Any(getReleaseNote(rInfo, 2, autoDownloadEnabled) ), uno::Any(getReleaseNote(rInfo, 3, autoDownloadEnabled) ), uno::Any(getReleaseNote(rInfo, 4, autoDownloadEnabled) ), uno::Any(getReleaseNote(rInfo, 5, autoDownloadEnabled) ), uno::Any(aCurrentBuild) }; OUString aName; for( sal_uInt32 n=0; n < nUpdateEntryProperties; ++n ) { aName = OUString::createFromAscii(aUpdateEntryProperties[n]); if( m_xContainer->hasByName(aName) ) m_xContainer->replaceByName(aName, aValues[n]); else m_xContainer->insertByName(aName,aValues[n]); } commitChanges(); } void UpdateCheckConfig::clearUpdateFound() { OUString aName; for(const char* aUpdateEntryProperty : aUpdateEntryProperties) { aName = OUString::createFromAscii(aUpdateEntryProperty); try { if( m_xContainer->hasByName(aName) ) m_xContainer->removeByName(aName); } catch(const lang::WrappedTargetException& ) { // Can not remove value, probably in share layer OSL_ASSERT(false); m_xContainer->replaceByName(aName, uno::Any(OUString())); } } /* As we have removed UpdateVersionFound from the shared configuration * existing entries in the user layer do not have a oor operation and * thus are completely ignored (which also means they can not be removed). */ commitChanges(); } uno::Type SAL_CALL UpdateCheckConfig::getElementType() { return m_xContainer->getElementType(); } sal_Bool SAL_CALL UpdateCheckConfig::hasElements() { return m_xContainer->hasElements(); } uno::Any SAL_CALL UpdateCheckConfig::getByName( const OUString& aName ) { uno::Any aValue = m_xContainer->getByName( aName ); // Provide dynamic default value if( aName == DOWNLOAD_DESTINATION ) { OUString aStr; aValue >>= aStr; if( aStr.isEmpty() ) aValue <<= getDownloadsDirectory(); } return aValue; } uno::Sequence< OUString > SAL_CALL UpdateCheckConfig::getElementNames() { return m_xContainer->getElementNames(); } sal_Bool SAL_CALL UpdateCheckConfig::hasByName( const OUString& aName ) { return m_xContainer->hasByName( aName ); } void SAL_CALL UpdateCheckConfig::replaceByName( const OUString& aName, const uno::Any& aElement ) { return m_xContainer->replaceByName( aName, aElement ); } // XChangesBatch void SAL_CALL UpdateCheckConfig::commitChanges() { uno::Reference< util::XChangesBatch > xChangesBatch(m_xContainer, uno::UNO_QUERY); if( xChangesBatch.is() && xChangesBatch->hasPendingChanges() ) { util::ChangesSet aChangesSet = xChangesBatch->getPendingChanges(); xChangesBatch->commitChanges(); if( m_rListener.is() ) { const sal_Int32 nChanges = aChangesSet.getLength(); OUString aString; for( sal_Int32 i=0; i>= aString; if( aString.endsWith(AUTOCHECK_ENABLED "']") ) { bool bEnabled = false; aChangesSet[i].Element >>= bEnabled; m_rListener->autoCheckStatusChanged(bEnabled); } else if( aString.endsWith(CHECK_INTERVAL "']") ) { m_rListener->autoCheckIntervalChanged(); } } } } xChangesBatch.set( m_xAvailableUpdates, uno::UNO_QUERY ); if( xChangesBatch.is() && xChangesBatch->hasPendingChanges() ) { xChangesBatch->commitChanges(); } xChangesBatch.set( m_xIgnoredUpdates, uno::UNO_QUERY ); if( xChangesBatch.is() && xChangesBatch->hasPendingChanges() ) { xChangesBatch->commitChanges(); } } sal_Bool SAL_CALL UpdateCheckConfig::hasPendingChanges( ) { uno::Reference< util::XChangesBatch > xChangesBatch(m_xContainer, uno::UNO_QUERY); if( xChangesBatch.is() ) return xChangesBatch->hasPendingChanges(); return false; } uno::Sequence< util::ElementChange > SAL_CALL UpdateCheckConfig::getPendingChanges( ) { uno::Reference< util::XChangesBatch > xChangesBatch(m_xContainer, uno::UNO_QUERY); if( xChangesBatch.is() ) return xChangesBatch->getPendingChanges(); return uno::Sequence< util::ElementChange >(); } bool UpdateCheckConfig::storeExtensionVersion( const OUString& rExtensionName, const OUString& rVersion ) { bool bNotify = true; if ( m_xAvailableUpdates->hasByName( rExtensionName ) ) uno::Reference< beans::XPropertySet >( m_xAvailableUpdates->getByName( rExtensionName ), uno::UNO_QUERY_THROW )->setPropertyValue( u"" PROPERTY_VERSION ""_ustr, uno::Any( rVersion ) ); else { uno::Reference< beans::XPropertySet > elem( uno::Reference< lang::XSingleServiceFactory >( m_xAvailableUpdates, uno::UNO_QUERY_THROW )->createInstance(), uno::UNO_QUERY_THROW ); elem->setPropertyValue( u"" PROPERTY_VERSION ""_ustr, uno::Any( rVersion ) ); m_xAvailableUpdates->insertByName( rExtensionName, uno::Any( elem ) ); } if ( m_xIgnoredUpdates->hasByName( rExtensionName ) ) { OUString aIgnoredVersion; uno::Any aValue( uno::Reference< beans::XPropertySet >( m_xIgnoredUpdates->getByName( rExtensionName ), uno::UNO_QUERY_THROW )->getPropertyValue( u"" PROPERTY_VERSION ""_ustr ) ); aValue >>= aIgnoredVersion; if ( aIgnoredVersion.isEmpty() ) // no version means ignore all updates bNotify = false; else if ( aIgnoredVersion == rVersion ) // the user wanted to ignore this update bNotify = false; } commitChanges(); return bNotify; } bool UpdateCheckConfig::checkExtensionVersion( const OUString& rExtensionName, const OUString& rVersion ) { if ( m_xAvailableUpdates->hasByName( rExtensionName ) ) { OUString aStoredVersion; uno::Any aValue( uno::Reference< beans::XPropertySet >( m_xAvailableUpdates->getByName( rExtensionName ), uno::UNO_QUERY_THROW )->getPropertyValue( u"" PROPERTY_VERSION ""_ustr ) ); aValue >>= aStoredVersion; if ( m_xIgnoredUpdates->hasByName( rExtensionName ) ) { OUString aIgnoredVersion; uno::Any aValue2( uno::Reference< beans::XPropertySet >( m_xIgnoredUpdates->getByName( rExtensionName ), uno::UNO_QUERY_THROW )->getPropertyValue( u"" PROPERTY_VERSION ""_ustr ) ); aValue2 >>= aIgnoredVersion; if ( aIgnoredVersion.isEmpty() ) // no version means ignore all updates return false; else if ( aIgnoredVersion == aStoredVersion ) // the user wanted to ignore this update return false; // TODO: else delete ignored entry? } if ( isVersionGreater( rVersion, aStoredVersion ) ) return true; else { m_xAvailableUpdates->removeByName( rExtensionName ); commitChanges(); } } return false; } OUString UpdateCheckConfig::getSubVersion( const OUString& rVersion, sal_Int32 *nIndex ) { while ( *nIndex < rVersion.getLength() && rVersion[*nIndex] == '0') { ++*nIndex; } return rVersion.getToken( 0, '.', *nIndex ); } /// checks if the second version string is greater than the first one bool UpdateCheckConfig::isVersionGreater( const OUString& rVersion1, const OUString& rVersion2 ) { for ( sal_Int32 i1 = 0, i2 = 0; i1 >= 0 || i2 >= 0; ) { OUString sSub1( getSubVersion( rVersion1, &i1 ) ); OUString sSub2( getSubVersion( rVersion2, &i2 ) ); if ( sSub1.getLength() < sSub2.getLength() ) { return true; } else if ( sSub1.getLength() > sSub2.getLength() ) { return false; } else if ( sSub1 < sSub2 ) { return true; } else if ( sSub1 > sSub2 ) { return false; } } return false; } OUString SAL_CALL UpdateCheckConfig::getImplementationName() { return u"vnd.sun.UpdateCheckConfig"_ustr; } sal_Bool SAL_CALL UpdateCheckConfig::supportsService(OUString const & serviceName) { return cppu::supportsService(this, serviceName); } uno::Sequence< OUString > SAL_CALL UpdateCheckConfig::getSupportedServiceNames() { return { u"com.sun.star.setup.UpdateCheckConfig"_ustr }; } extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface* extensions_update_UpdateCheckConfig_get_implementation( css::uno::XComponentContext* context , css::uno::Sequence const&) { return cppu::acquire(UpdateCheckConfig::get(context, *UpdateCheck::get()).get()); } /* vim:set shiftwidth=4 softtabstop=4 expandtab: */