summaryrefslogtreecommitdiff
path: root/ucb/source/ucp/ftp/ftpurl.hxx
blob: b64eb6ecf45421a2f103c1056fbb0d4c109f0e17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

/**************************************************************************
                                TODO
 **************************************************************************

 *************************************************************************/

#pragma once

#include "curl.hxx"

#include <rtl/ustring.hxx>
#include <osl/file.h>
#include <vector>

#include "ftpdirp.hxx"

namespace ftp {

    /** Forward declarations.
     */

    class FTPContentProvider;


    enum FTPErrors { FOLDER_MIGHT_EXIST_DURING_INSERT = CURL_LAST,
                     FILE_MIGHT_EXIST_DURING_INSERT };

    class malformed_exception : public std::exception { };

    class curl_exception : public std::exception
    {
    public:

        explicit curl_exception(sal_Int32 err)
            : n_err(err) { }

        sal_Int32 code() const { return n_err; }


    private:

        sal_Int32 n_err;
    };

    class CurlInput {
    public:
        // returns the number of bytes actually read
        virtual sal_Int32 read(sal_Int8 *dest,sal_Int32 nBytesRequested) = 0;

    protected:
        ~CurlInput() {}
    };


    class FTPURL
    {
    public:
        /// @throws malformed_exception
        FTPURL(
            const OUString& aIdent,
            FTPContentProvider* pFCP
        );

        FTPURL(const FTPURL& r);

        ~FTPURL();

        const OUString& host() const { return m_aHost; }

        const OUString& port() const { return m_aPort; }

        const OUString& username() const { return m_aUsername; }

        /** This returns the URL, but cleaned from
         *  unnecessary ellipses.
         */

        OUString ident(bool withslash,bool internal) const;

        /** returns the parent url.
         */

        OUString parent(bool internal = false) const;

        /** sets the unencoded title */
        void child(const OUString& title);

        /** returns the unencoded title */
        OUString child() const;

        /// @throws curl_exception
        std::vector<FTPDirentry> list(sal_Int16 nMode) const;

        // returns a pointer to an open tempfile,
        // sought to the beginning of.
        /// @throws curl_exception
        oslFileHandle open();

        /// @throws curl_exception
        /// @throws malformed_exception
        FTPDirentry direntry() const;

        /// @throws curl_exception
        void insert(bool ReplaceExisting,void* stream) const;

        /// @throws curl_exception
        /// @throws malformed_exception
        void mkdir(bool ReplaceExisting) const;

        /// @throws curl_exception
        OUString ren(const OUString& NewTitle);

        /// @throws curl_exception
        /// @throws malformed_exception
        void del() const;


    private:

        FTPContentProvider *m_pFCP;

        mutable OUString m_aUsername;
        bool m_bShowPassword;
        mutable OUString m_aHost;
        mutable OUString m_aPort;
        mutable OUString m_aType;

        /** Contains the encoded pathsegments of the url.
         */
        std::vector<OUString> m_aPathSegmentVec;

        /// @throws malformed_exception
        void parse(const OUString& url);

        /// @throws curl_exception
        OUString net_title() const;
    };

}


/* vim:set shiftwidth=4 softtabstop=4 expandtab: */