ucb/source/ucp/ftp/ftpurl.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 /**************************************************************************
  21                                 TODO
  22  **************************************************************************
  23
  24  *************************************************************************/
  25
  26 #ifndef INCLUDED_UCB_SOURCE_UCP_FTP_FTPURL_HXX
  27 #define INCLUDED_UCB_SOURCE_UCP_FTP_FTPURL_HXX
  28
  29 #include "curl.hxx"
  30
  31 #include <rtl/ustring.hxx>
  32 #include <osl/file.h>
  33 #include <vector>
  34
  35 #include "ftpdirp.hxx"
  36
  37 namespace ftp {
  38
  39     /** Forward declarations.
  40      */
  41
  42     class FTPContentProvider;
  43
  44
  45     enum FTPErrors { FOLDER_MIGHT_EXIST_DURING_INSERT = CURL_LAST,
  46                      FILE_MIGHT_EXIST_DURING_INSERT };
  47
  48     class malformed_exception : public std::exception { };
  49
  50     class curl_exception : public std::exception
  51     {
  52     public:
  53
  54         explicit curl_exception(sal_Int32 err)
  55             : n_err(err) { }
  56
  57         sal_Int32 code() const { return n_err; }
  58
  59
  60     private:
  61
  62         sal_Int32 n_err;
  63     };
  64
  65     class CurlInput {
  66     public:
  67         // returns the number of bytes actually read
  68         virtual sal_Int32 read(sal_Int8 *dest,sal_Int32 nBytesRequested) = 0;
  69
  70     protected:
  71         ~CurlInput() {}
  72     };
  73
  74
  75     class FTPURL
  76     {
  77     public:
  78         /// @throws malformed_exception
  79         FTPURL(
  80             const OUString& aIdent,
  81             FTPContentProvider* pFCP
  82         );
  83
  84         FTPURL(const FTPURL& r);
  85
  86         ~FTPURL();
  87
  88         const OUString& host() const { return m_aHost; }
  89
  90         const OUString& port() const { return m_aPort; }
  91
  92         const OUString& username() const { return m_aUsername; }
  93
  94         /** This returns the URL, but cleaned from
  95          *  unnecessary ellipses.
  96          */
  97
  98         OUString ident(bool withslash,bool internal) const;
  99
 100         /** returns the parent url.
 101          */
 102
 103         OUString parent(bool internal = false) const;
 104
 105         /** sets the unencoded title */
 106         void child(const OUString& title);
 107
 108         /** returns the unencoded title */
 109         OUString child() const;
 110
 111         /// @throws curl_exception
 112         std::vector<FTPDirentry> list(sal_Int16 nMode) const;
 113
 114         // returns a pointer to an open tempfile,
 115         // sought to the beginning of.
 116         /// @throws curl_exception
 117         oslFileHandle open();
 118
 119         /// @throws curl_exception
 120         /// @throws malformed_exception
 121         FTPDirentry direntry() const;
 122
 123         /// @throws curl_exception
 124         void insert(bool ReplaceExisting,void* stream) const;
 125
 126         /// @throws curl_exception
 127         /// @throws malformed_exception
 128         void mkdir(bool ReplaceExisting) const;
 129
 130         /// @throws curl_exception
 131         OUString ren(const OUString& NewTitle);
 132
 133         /// @throws curl_exception
 134         /// @throws malformed_exception
 135         void del() const;
 136
 137
 138     private:
 139
 140         FTPContentProvider *m_pFCP;
 141
 142         mutable OUString m_aUsername;
 143         bool m_bShowPassword;
 144         mutable OUString m_aHost;
 145         mutable OUString m_aPort;
 146         mutable OUString m_aType;
 147
 148         /** Contains the encoded pathsegments of the url.
 149          */
 150         std::vector<OUString> m_aPathSegmentVec;
 151
 152         /// @throws malformed_exception
 153         void parse(const OUString& url);
 154
 155         /// @throws curl_exception
 156         OUString net_title() const;
 157     };
 158
 159 }
 160
 161
 162 #endif
 163
 164 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */