simgear/io/HTTPRepository.hxx

   1 // HTTPRepository.hxx - plain HTTP TerraSync remote server client
   2 //
   3 // Copyright (C) 2016  James Turner <zakalawe@mac.com>
   4 //
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License as
   7 // published by the Free Software Foundation; either version 2 of the
   8 // License, or (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful, but
  11 // WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18
  19
  20 #ifndef SG_IO_HTTP_REPOSITORY_HXX
  21 #define SG_IO_HTTP_REPOSITORY_HXX
  22
  23 #include <memory>
  24
  25 #include <simgear/misc/sg_path.hxx>
  26 #include <simgear/io/HTTPClient.hxx>
  27
  28 namespace simgear  {
  29
  30 class HTTPRepoPrivate;
  31
  32 class HTTPRepository
  33 {
  34 public:
  35     enum ResultCode {
  36         REPO_NO_ERROR = 0,
  37         REPO_ERROR_NOT_FOUND,
  38         REPO_ERROR_SOCKET,
  39         SVN_ERROR_XML,
  40         SVN_ERROR_TXDELTA,
  41         REPO_ERROR_IO,
  42         REPO_ERROR_CHECKSUM,
  43         REPO_ERROR_FILE_NOT_FOUND,
  44         REPO_ERROR_HTTP,
  45         REPO_PARTIAL_UPDATE
  46     };
  47
  48     HTTPRepository(const SGPath& root, HTTP::Client* cl);
  49     virtual ~HTTPRepository();
  50
  51     virtual SGPath fsBase() const;
  52
  53     virtual void setBaseUrl(const std::string& url);
  54     virtual std::string baseUrl() const;
  55
  56     virtual HTTP::Client* http() const;
  57
  58     virtual void update();
  59
  60     /**
  61      * set if we should sync the entire repository
  62      */
  63     void setEntireRepositoryMode();
  64
  65     void addSubpath(const std::string& relPath);
  66
  67     virtual bool isDoingSync() const;
  68
  69     virtual ResultCode failure() const;
  70
  71     virtual size_t bytesToDownload() const;
  72
  73     virtual size_t bytesDownloaded() const;
  74 private:
  75     bool isBare() const;
  76
  77     std::auto_ptr<HTTPRepoPrivate> _d;
  78 };
  79
  80 } // of namespace simgear
  81
  82 #endif // of HTTPRepository