/**************************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_extensions.hxx"
#if defined WNT
#ifdef _MSC_VER
#pragma warning(push, 1) /* disable warnings within system headers */
#endif
#include <curl/curl.h>
#ifdef _MSC_VER
#pragma warning(pop)
#endif
#else
#include <curl/curl.h>
#endif
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include "download.hxx"
namespace beans = com::sun::star::beans ;
namespace container = com::sun::star::container ;
namespace lang = com::sun::star::lang ;
namespace uno = com::sun::star::uno ;
#define UNISTRING(s) rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(s))
struct OutData
{
rtl::Reference< DownloadInteractionHandler >Handler;
rtl::OUString File;
rtl::OUString DestinationDir;
oslFileHandle FileHandle;
sal_uInt64 Offset;
osl::Condition& StopCondition;
CURL *curl;
OutData(osl::Condition& rCondition) : FileHandle(NULL), Offset(0), StopCondition(rCondition), curl(NULL) {};
};
//------------------------------------------------------------------------------
static void openFile( OutData& out )
{
char * effective_url;
curl_easy_getinfo(out.curl, CURLINFO_EFFECTIVE_URL, &effective_url);
double fDownloadSize;
curl_easy_getinfo(out.curl, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &fDownloadSize);
rtl::OString aURL(effective_url);
// ensure no trailing '/'
sal_Int32 nLen = aURL.getLength();
while( (nLen > 0) && ('/' == aURL[nLen-1]) )
aURL = aURL.copy(0, --nLen);
// extract file name last '/'
sal_Int32 nIndex = aURL.lastIndexOf('/');
if( nIndex > 0 )
{
out.File = out.DestinationDir + rtl::OStringToOUString(aURL.copy(nIndex), RTL_TEXTENCODING_UTF8);
oslFileError rc;
// Give the user an overwrite warning if the target file exists
const sal_Int32 openFlags = osl_File_OpenFlag_Write | osl_File_OpenFlag_Create;
do
{
rc = osl_openFile(out.File.pData, &out.FileHandle, openFlags);
if( osl_File_E_EXIST == rc && ! out.Handler->downloadTargetExists(out.File) )
{
out.StopCondition.set();
break;
}
} while( osl_File_E_EXIST == rc );
if( osl_File_E_None == rc )
out.Handler->downloadStarted(out.File, (sal_Int64) fDownloadSize);
}
}
//------------------------------------------------------------------------------
static inline rtl::OString
getStringValue(const uno::Reference< container::XNameAccess >& xNameAccess, const rtl::OUString& aName)
{
rtl::OString aRet;
OSL_ASSERT(xNameAccess->hasByName(aName));
uno::Any aValue = xNameAccess->getByName(aName);
return rtl::OUStringToOString(aValue.get<rtl::OUString>(), RTL_TEXTENCODING_UTF8);
}
//------------------------------------------------------------------------------
static inline sal_Int32
getInt32Value(const uno::Reference< container::XNameAccess >& xNameAccess,
const rtl::OUString& aName, sal_Int32 nDefault=-1)
{
OSL_ASSERT(xNameAccess->hasByName(aName));
uno::Any aValue = xNameAccess->getByName(aName);
sal_Int32 n=nDefault;
aValue >>= n;
return n;
}
//------------------------------------------------------------------------------
static size_t
write_function( void *ptr, size_t size, size_t nmemb, void *stream )
{
OutData *out = reinterpret_cast < OutData * > (stream);
if( NULL == out->FileHandle )
openFile(*out);
sal_uInt64 nBytesWritten = 0;
if( NULL != out->FileHandle )
osl_writeFile(out->FileHandle, ptr, size * nmemb, &nBytesWritten);
return (size_t) nBytesWritten;
}
//------------------------------------------------------------------------------
static int
progress_callback( void *clientp, double dltotal, double dlnow, double ultotal, double ulnow )
{
(void) ultotal;
(void) ulnow;
OutData *out = reinterpret_cast < OutData * > (clientp);
OSL_ASSERT( out );
if( ! out->StopCondition.check() )
{
double fPercent = 0;
if ( dltotal + out->Offset )
fPercent = (dlnow + out->Offset) * 100 / (dltotal + out->Offset);
if( fPercent < 0 )
fPercent = 0;
// Do not report progress for redirection replies
long nCode;
curl_easy_getinfo(out->curl, CURLINFO_RESPONSE_CODE, &nCode);
if( (nCode != 302) && (nCode != 303) && (dltotal > 0) )
out->Handler->downloadProgressAt((sal_Int8)fPercent);
return 0;
}
// If stop condition is set, return non 0 value to abort
return -1;
}
//------------------------------------------------------------------------------
void
Download::getProxyForURL(const rtl::OUString& rURL, rtl::OString& rHost, sal_Int32& rPort) const
{
if( !m_xContext.is() )
throw uno::RuntimeException(
UNISTRING( "Download: empty component context" ),
uno::Reference< uno::XInterface >() );
uno::Reference< lang::XMultiComponentFactory > xServiceManager(m_xContext->getServiceManager());
if( !xServiceManager.is() )
throw uno::RuntimeException(
UNISTRING( "Download: unable to obtain service manager from component context" ),
uno::Reference< uno::XInterface >() );
uno::Reference< lang::XMultiServiceFactory > xConfigProvider(
xServiceManager->createInstanceWithContext( UNISTRING( "com.sun.star.configuration.ConfigurationProvider" ), m_xContext ),
uno::UNO_QUERY_THROW);
beans::PropertyValue aProperty;
aProperty.Name = UNISTRING( "nodepath" );
aProperty.Value = uno::makeAny( UNISTRING("org.openoffice.Inet/Settings") );
uno::Sequence< uno::Any > aArgumentList( 1 );
aArgumentList[0] = uno::makeAny( aProperty );
uno::Reference< container::XNameAccess > xNameAccess(
xConfigProvider->createInstanceWithArguments(
UNISTRING("com.sun.star.configuration.ConfigurationAccess"), aArgumentList ),
uno::UNO_QUERY_THROW );
OSL_ASSERT(xNameAccess->hasByName(UNISTRING("ooInetProxyType")));
uno::Any aValue = xNameAccess->getByName(UNISTRING("ooInetProxyType"));
sal_Int32 nProxyType = aValue.get< sal_Int32 >();
if( 0 != nProxyType ) // type 0 means "direct connection to the internet
{
if( rURL.matchAsciiL(RTL_CONSTASCII_STRINGPARAM("http:")) )
{
rHost = getStringValue(xNameAccess, UNISTRING("ooInetHTTPProxyName"));
rPort = getInt32Value(xNameAccess, UNISTRING("ooInetHTTPProxyPort"));
}
else if( rURL.matchAsciiL(RTL_CONSTASCII_STRINGPARAM("https:")) )
{
rHost = getStringValue(xNameAccess, UNISTRING("ooInetHTTPSProxyName"));
rPort = getInt32Value(xNameAccess, UNISTRING("ooInetHTTPSProxyPort"));
}
else if( rURL.matchAsciiL(RTL_CONSTASCII_STRINGPARAM("ftp:")) )
{
rHost = getStringValue(xNameAccess, UNISTRING("ooInetFTPProxyName"));
rPort = getInt32Value(xNameAccess, UNISTRING("ooInetFTPProxyPort"));
}
}
}
//------------------------------------------------------------------------------
bool curl_run(const rtl::OUString& rURL, OutData& out, const rtl::OString& aProxyHost, sal_Int32 nProxyPort)
{
/* Need to investigate further whether it is necessary to call
* curl_global_init or not - leave it for now (as the ftp UCB content
* provider does as well).
*/
CURL * pCURL = curl_easy_init();
bool ret = false;
if( NULL != pCURL )
{
out.curl = pCURL;
rtl::OString aURL(rtl::OUStringToOString(rURL, RTL_TEXTENCODING_UTF8));
curl_easy_setopt(pCURL, CURLOPT_URL, aURL.getStr());
// abort on http errors
curl_easy_setopt(pCURL, CURLOPT_FAILONERROR, 1);
// enable redirection
curl_easy_setopt(pCURL, CURLOPT_FOLLOWLOCATION, 1);
// write function
curl_easy_setopt(pCURL, CURLOPT_WRITEDATA, &out);
curl_easy_setopt(pCURL, CURLOPT_WRITEFUNCTION, &write_function);
// progress handler - Condition::check unfortunatly is not defined const
curl_easy_setopt(pCURL, CURLOPT_NOPROGRESS, 0);
curl_easy_setopt(pCURL, CURLOPT_PROGRESSFUNCTION, &progress_callback);
curl_easy_setopt(pCURL, CURLOPT_PROGRESSDATA, &out);
// proxy
curl_easy_setopt(pCURL, CURLOPT_PROXY, aProxyHost.getStr());
curl_easy_setopt(pCURL, CURLOPT_PROXYTYPE, CURLPROXY_HTTP);
if( -1 != nProxyPort )
curl_easy_setopt(pCURL, CURLOPT_PROXYPORT, nProxyPort);
if( out.Offset > 0 )
{
// curl_off_t offset = nOffset; libcurl seems to be compiled with large
// file support (and we not) ..
sal_Int64 offset = (sal_Int64) out.Offset;
curl_easy_setopt(pCURL, CURLOPT_RESUME_FROM_LARGE, offset);
}
CURLcode cc = curl_easy_perform(pCURL);
// treat zero byte downloads as errors
if( NULL == out.FileHandle )
openFile(out);
if( CURLE_OK == cc )
{
out.Handler->downloadFinished(out.File);
ret = true;
}
if ( CURLE_PARTIAL_FILE == cc )
{
// this sometimes happens, when a user throws away his user data, but has already
// completed the download of an update.
double fDownloadSize;
curl_easy_getinfo( pCURL, CURLINFO_CONTENT_LENGTH_DOWNLOAD, &fDownloadSize );
if ( -1 == fDownloadSize )
{
out.Handler->downloadFinished(out.File);
ret = true;
}
}
// Avoid target file being removed
else if( (CURLE_ABORTED_BY_CALLBACK == cc) || out.StopCondition.check() )
ret = true;
// Only report errors when not stopped
else
{
rtl::OString aMessage(RTL_CONSTASCII_STRINGPARAM("Unknown error"));
const char * error_message = curl_easy_strerror(cc);
if( NULL != error_message )
aMessage = error_message;
if ( CURLE_HTTP_RETURNED_ERROR == cc )
{
long nError;
curl_easy_getinfo( pCURL, CURLINFO_RESPONSE_CODE, &nError );
if ( 403 == nError )
aMessage += rtl::OString( RTL_CONSTASCII_STRINGPARAM( " 403: Access denied!" ) );
else if ( 404 == nError )
aMessage += rtl::OString( RTL_CONSTASCII_STRINGPARAM( " 404: File not found!" ) );
else if ( 416 == nError )
{
// we got this error probably, because we already downloaded the file
out.Handler->downloadFinished(out.File);
ret = true;
}
else
{
aMessage += rtl::OString( RTL_CONSTASCII_STRINGPARAM( ":error code = " ) );
aMessage += aMessage.valueOf( nError );
aMessage += rtl::OString( RTL_CONSTASCII_STRINGPARAM( " !" ) );
}
}
if ( !ret )
out.Handler->downloadStalled( rtl::OStringToOUString(aMessage, RTL_TEXTENCODING_UTF8) );
}
curl_easy_cleanup(pCURL);
}
return ret;
}
//------------------------------------------------------------------------------
bool
Download::start(const rtl::OUString& rURL, const rtl::OUString& rFile, const rtl::OUString& rDestinationDir)
{
OSL_ASSERT( m_aHandler.is() );
OutData out(m_aCondition);
rtl::OUString aFile( rFile );
// when rFile is empty, there is no remembered file name. If there is already a file with the
// same name ask the user if she wants to resume a download or restart the download
if ( !aFile.getLength() )
{
// GetFileName()
rtl::OUString aURL( rURL );
// ensure no trailing '/'
sal_Int32 nLen = aURL.getLength();
while( (nLen > 0) && ('/' == aURL[ nLen-1 ]) )
aURL = aURL.copy( 0, --nLen );
// extract file name last '/'
sal_Int32 nIndex = aURL.lastIndexOf('/');
aFile = rDestinationDir + aURL.copy( nIndex );
// check for existing file
oslFileError rc = osl_openFile( aFile.pData, &out.FileHandle, osl_File_OpenFlag_Write | osl_File_OpenFlag_Create );
osl_closeFile(out.FileHandle);
out.FileHandle = NULL;
if( osl_File_E_EXIST == rc )
{
if ( m_aHandler->checkDownloadDestination( aURL.copy( nIndex+1 ) ) )
{
osl_removeFile( aFile.pData );
aFile = rtl::OUString();
}
else
m_aHandler->downloadStarted( aFile, 0 );
}
else
{
osl_removeFile( aFile.pData );
aFile = rtl::OUString();
}
}
out.File = aFile;
out.DestinationDir = rDestinationDir;
out.Handler = m_aHandler;
if( aFile.getLength() > 0 )
{
oslFileError rc = osl_openFile(aFile.pData, &out.FileHandle, osl_File_OpenFlag_Write);
if( osl_File_E_None == rc )
{
// Set file pointer to the end of the file on resume
if( osl_File_E_None == osl_setFilePos(out.FileHandle, osl_Pos_End, 0) )
{
osl_getFilePos(out.FileHandle, &out.Offset);
}
}
else if( osl_File_E_NOENT == rc ) // file has been deleted meanwhile ..
out.File = rtl::OUString();
}
rtl::OString aProxyHost;
sal_Int32 nProxyPort = -1;
getProxyForURL(rURL, aProxyHost, nProxyPort);
bool ret = curl_run(rURL, out, aProxyHost, nProxyPort);
if( NULL != out.FileHandle )
{
osl_syncFile(out.FileHandle);
osl_closeFile(out.FileHandle);
// #i90930# Don't remove already downloaded bits, when curl_run reports an error
// because later calls might be successful
// if( ! ret )
// osl_removeFile(out.File.pData);
}
m_aCondition.reset();
return ret;
}
//------------------------------------------------------------------------------
void
Download::stop()
{
m_aCondition.set();
}