ucb/source/ucp/ftp/ftpurl.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ftpurl.hxx,v $
  10  * $Revision: 1.15 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 /**************************************************************************
  32                                 TODO
  33  **************************************************************************
  34
  35  *************************************************************************/
  36
  37 #ifndef _FTP_FTPURL_HXX_
  38 #define _FTP_FTPURL_HXX_
  39
  40 #include "curl.hxx"
  41 #include <curl/easy.h>
  42 #include <com/sun/star/io/XOutputStream.hpp>
  43
  44 #include <stdio.h>
  45 #include <rtl/ustring.hxx>
  46 #include <osl/mutex.hxx>
  47 #include <vector>
  48
  49 #include "ftpdirp.hxx"
  50 #include "ftpcfunc.hxx"
  51
  52 namespace ftp {
  53
  54     /** Forward declarations.
  55      */
  56
  57     class FTPHandleProvider;
  58
  59
  60     enum FTPErrors { FILE_EXIST_DURING_INSERT = CURL_LAST +1,
  61                      FOLDER_EXIST_DURING_INSERT,
  62                      FOLDER_MIGHT_EXIST_DURING_INSERT,
  63                      FILE_MIGHT_EXIST_DURING_INSERT };
  64
  65
  66     class malformed_exception { };
  67
  68
  69     class curl_exception
  70     {
  71     public:
  72
  73         curl_exception(sal_Int32 err)
  74             : n_err(err) { }
  75
  76         sal_Int32 code() const { return n_err; }
  77
  78
  79     private:
  80
  81         sal_Int32 n_err;
  82     };
  83
  84     class CurlInput {
  85
  86     public:
  87
  88         // returns the number of bytes actually read
  89         virtual sal_Int32 read(sal_Int8 *dest,sal_Int32 nBytesRequested) = 0;
  90     };
  91
  92
  93     class FTPURL
  94     {
  95     public:
  96
  97         FTPURL(
  98             const rtl::OUString& aIdent,
  99             FTPHandleProvider* pFCP = 0
 100         )
 101             throw(
 102                 malformed_exception
 103             );
 104
 105         FTPURL(const FTPURL& r);
 106
 107         ~FTPURL();
 108
 109         rtl::OUString host() const { return m_aHost; }
 110
 111         rtl::OUString port() const { return m_aPort; }
 112
 113         rtl::OUString username() const { return m_aUsername; }
 114
 115         /** This returns the URL, but cleaned from
 116          *  unnessary ellipses.
 117          */
 118
 119         rtl::OUString ident(bool withslash,bool internal) const;
 120
 121         /** returns the parent url.
 122          */
 123
 124         rtl::OUString parent(bool internal = false) const;
 125
 126         /** sets the unencoded title */
 127         void child(const rtl::OUString& title);
 128
 129         /** returns the unencoded title */
 130         rtl::OUString child(void) const;
 131
 132         std::vector<FTPDirentry> list(sal_Int16 nMode) const
 133             throw(curl_exception);
 134
 135         // returns a pointer to an open tempfile,
 136         // seeked to the beginning of.
 137         FILE* open() throw(curl_exception);
 138
 139         FTPDirentry direntry() const throw(curl_exception);
 140
 141         void insert(bool ReplaceExisting,void* stream) const
 142             throw(curl_exception);
 143
 144         void mkdir(bool ReplaceExisting) const
 145             throw(curl_exception);
 146
 147         rtl::OUString ren(const rtl::OUString& NewTitle)
 148             throw(curl_exception);
 149
 150         void del() const
 151             throw(curl_exception);
 152
 153
 154     private:
 155
 156         osl::Mutex m_mutex;
 157
 158         FTPHandleProvider *m_pFCP;
 159
 160         mutable rtl::OUString m_aUsername;
 161         bool m_bShowPassword;
 162         mutable rtl::OUString m_aHost;
 163         mutable rtl::OUString m_aPort;
 164         mutable rtl::OUString m_aType;
 165
 166         /** Contains the encoded pathsegments of the url.
 167          */
 168         std::vector<rtl::OUString> m_aPathSegmentVec;
 169
 170         void parse(const rtl::OUString& url)
 171             throw(
 172                 malformed_exception
 173             );
 174
 175         rtl::OUString net_title() const throw(curl_exception);
 176     };
 177
 178 }
 179
 180
 181 #endif