xref: /AOO41X/main/extensions/source/update/check/download.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir 
29*cdf0e10cSrcweir #include <com/sun/star/uno/XComponentContext.hpp>
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <rtl/ref.hxx>
32*cdf0e10cSrcweir #include <rtl/ustring.hxx>
33*cdf0e10cSrcweir #include <osl/conditn.hxx>
34*cdf0e10cSrcweir #include <osl/file.h>
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir struct DownloadInteractionHandler : public rtl::IReference
37*cdf0e10cSrcweir {
38*cdf0e10cSrcweir     virtual bool checkDownloadDestination(const rtl::OUString& rFileName) = 0;
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir     // called if the destination file already exists, but resume is false
41*cdf0e10cSrcweir     virtual bool downloadTargetExists(const rtl::OUString& rFileName) = 0;
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir     // called when curl reports an error
44*cdf0e10cSrcweir     virtual void downloadStalled(const rtl::OUString& rErrorMessage) = 0;
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir     // progress handler
47*cdf0e10cSrcweir     virtual void downloadProgressAt(sal_Int8 nPercent) = 0;
48*cdf0e10cSrcweir 
49*cdf0e10cSrcweir     // called on first progress notification
50*cdf0e10cSrcweir     virtual void downloadStarted(const rtl::OUString& rFileName, sal_Int64 nFileSize) = 0;
51*cdf0e10cSrcweir 
52*cdf0e10cSrcweir     // called when download has been finished
53*cdf0e10cSrcweir     virtual void downloadFinished(const rtl::OUString& rFileName) = 0;
54*cdf0e10cSrcweir };
55*cdf0e10cSrcweir 
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir class Download
58*cdf0e10cSrcweir {
59*cdf0e10cSrcweir public:
60*cdf0e10cSrcweir     Download(const com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext >& xContext,
61*cdf0e10cSrcweir              const rtl::Reference< DownloadInteractionHandler >& rHandler) : m_xContext(xContext), m_aHandler(rHandler) {};
62*cdf0e10cSrcweir 
63*cdf0e10cSrcweir     // returns true when the content of rURL was successfully written to rLocalFile
64*cdf0e10cSrcweir     bool start(const rtl::OUString& rURL, const rtl::OUString& rFile, const rtl::OUString& rDestinationDir);
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir     // stops the download after the next write operation
67*cdf0e10cSrcweir     void stop();
68*cdf0e10cSrcweir 
69*cdf0e10cSrcweir     // returns true if the stop condition is set
70*cdf0e10cSrcweir     bool isStopped() const
71*cdf0e10cSrcweir         { return sal_True == const_cast <Download *> (this)->m_aCondition.check(); };
72*cdf0e10cSrcweir 
73*cdf0e10cSrcweir protected:
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir     // Determines the appropriate proxy settings for the given URL. Returns true if a proxy should be used
76*cdf0e10cSrcweir     void getProxyForURL(const rtl::OUString& rURL, rtl::OString& rHost, sal_Int32& rPort) const;
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir private:
79*cdf0e10cSrcweir     osl::Condition m_aCondition;
80*cdf0e10cSrcweir     const com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext >& m_xContext;
81*cdf0e10cSrcweir     const rtl::Reference< DownloadInteractionHandler > m_aHandler;
82*cdf0e10cSrcweir };
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir 
85