extensions/source/update/check/download.hxx

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