annotate liboctave/util/url-transfer.h @ 26376:00f796120a6d stable

maint: Update copyright dates in all source files.
author John W. Eaton <jwe@octave.org>
date Wed, 02 Jan 2019 16:32:43 -0500
parents cb1606f78f6b
children 159402e52cfa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
1 /*
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2
26376
00f796120a6d maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents: 25438
diff changeset
3 Copyright (C) 2013-2019 John W. Eaton
00f796120a6d maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents: 25438
diff changeset
4 Copyright (C) 2006-2019 Alexander Barth
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 Copyright (C) 2009 David Bateman
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 This file is part of Octave.
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24254
diff changeset
9 Octave is free software: you can redistribute it and/or modify it
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
10 under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24254
diff changeset
11 the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
12 (at your option) any later version.
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
14 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
15 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
17 GNU General Public License for more details.
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 You should have received a copy of the GNU General Public License
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20 along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24254
diff changeset
21 <https://www.gnu.org/licenses/>.
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
23 */
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
24
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25 // Author: Alexander Barth <abarth@marine.usf.edu>
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 // Author: jwe
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 19697
diff changeset
28 #if ! defined (octave_url_transfer_h)
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29 #define octave_url_transfer_h 1
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30
21244
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21017
diff changeset
31 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21017
diff changeset
32
25438
cb1606f78f6b prefer <istream>, <ostream>, or <iosfwd> to <iostream> where possible
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
33 #include <istream>
24254
4bca68f0d8d5 use shared_ptr to manage url_transfer object
John W. Eaton <jwe@octave.org>
parents: 23696
diff changeset
34 #include <memory>
25438
cb1606f78f6b prefer <istream>, <ostream>, or <iosfwd> to <iostream> where possible
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
35 #include <ostream>
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36 #include <string>
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37
23442
53f5f8231c37 allow most header files to be compiled separately
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
38 #include "str-vec.h"
53f5f8231c37 allow most header files to be compiled separately
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
39
53f5f8231c37 allow most header files to be compiled separately
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
40 template <typename T> class Array;
53f5f8231c37 allow most header files to be compiled separately
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
41
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
42 namespace octave
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 {
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
44 class
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
45 OCTAVE_API
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
46 base_url_transfer
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 {
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
48 private:
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
50 static void delete_file (const std::string& file);
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
52 static void reset_path (base_url_transfer *curl_xfer)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
53 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
54 curl_xfer->cwd ("..");
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
55 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
57 public:
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
58
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
59 friend class url_transfer;
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
60
25438
cb1606f78f6b prefer <istream>, <ostream>, or <iosfwd> to <iostream> where possible
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
61 base_url_transfer (void);
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
63 base_url_transfer (const std::string& host,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
64 const std::string& /* user_arg */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
65 const std::string& /* passwd */,
25438
cb1606f78f6b prefer <istream>, <ostream>, or <iosfwd> to <iostream> where possible
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
66 std::ostream& os);
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67
25438
cb1606f78f6b prefer <istream>, <ostream>, or <iosfwd> to <iostream> where possible
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
68 base_url_transfer (const std::string& url, std::ostream& os);
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
69
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
70 // No copying!
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
71
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
72 base_url_transfer (const base_url_transfer&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
73
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
74 base_url_transfer& operator = (const base_url_transfer&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
75
22868
87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
76 virtual ~base_url_transfer (void) = default;
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
77
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
78 bool is_valid (void) const { return valid; }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
79
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
80 bool good (void) const { return valid && ok; }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
81
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
82 virtual void perform (void) { }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
83
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
84 virtual std::string lasterror (void) const { return errmsg; }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
85
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
86 virtual std::ostream& set_ostream (std::ostream& /* os */)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
87 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
88 return *curr_ostream;
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
89 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
90
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
91 virtual std::istream& set_istream (std::istream& /* is */)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
92 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
93 return *curr_istream;
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
94 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
95
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
96 virtual void ascii (void) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
97
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
98 virtual void binary (void) { }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
99
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
100 bool is_ascii (void) const { return ascii_mode; }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
101
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
102 bool is_binary (void) const { return ! ascii_mode; }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
103
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
104 virtual void cwd (const std::string& /* path */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
105
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
106 virtual void del (const std::string& /* file */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
107
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
108 virtual void rmdir (const std::string& /* path */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
109
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
110 virtual void mkdir (const std::string& /* path */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
111
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
112 virtual void rename (const std::string& /* oldname */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
113 const std::string& /* newname */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
114
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
115 virtual void put (const std::string& /* file */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
116 std::istream& /* is */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
117
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
118 virtual void get (const std::string& /* file */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
119 std::ostream& /* os */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
120
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
121 void mget_directory (const std::string& directory,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
122 const std::string& target);
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
123
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
124 string_vector mput_directory (const std::string& base,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
125 const std::string& directory);
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
126
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
127 virtual void dir (void) { }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
128
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
129 virtual string_vector list (void) { return string_vector (); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
130
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
131 virtual void get_fileinfo (const std::string& /* filename */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
132 double& /* filesize */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
133 time_t& /* filetime */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
134 bool& /* fileisdir */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
135
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
136 virtual std::string pwd (void) { return ""; }
17596
43b9181340fb separate object creation from http actions in url_transfer class
John W. Eaton <jwe@octave.org>
parents: 17557
diff changeset
137
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
138 virtual void http_get (const Array<std::string>& /* param */) { }
17596
43b9181340fb separate object creation from http actions in url_transfer class
John W. Eaton <jwe@octave.org>
parents: 17557
diff changeset
139
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
140 virtual void http_post (const Array<std::string>& /* param */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
141
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
142 virtual void http_action (const Array<std::string>& /* param */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
143 const std::string& /* action */) { }
17596
43b9181340fb separate object creation from http actions in url_transfer class
John W. Eaton <jwe@octave.org>
parents: 17557
diff changeset
144
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
145 protected:
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
146
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
147 // Host for ftp transfers or full URL for http requests.
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
148 std::string host_or_url;
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
149 bool valid;
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
150 bool ftp;
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
151 bool ascii_mode;
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
152 bool ok;
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
153 std::string errmsg;
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
154 std::istream *curr_istream;
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
155 std::ostream *curr_ostream;
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
156 };
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
157
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
158 class
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
159 OCTAVE_API
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
160 url_transfer
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
161 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
162 public:
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
163
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
164 url_transfer (void);
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
165
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
166 url_transfer (const std::string& host, const std::string& user,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
167 const std::string& passwd, std::ostream& os);
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
168
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
169 url_transfer (const std::string& url, std::ostream& os);
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
170
24991
831389905438 omit argument name from default copy ctors and assignment operators
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
171 url_transfer (const url_transfer&) = default;
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
172
24991
831389905438 omit argument name from default copy ctors and assignment operators
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
173 url_transfer& operator = (const url_transfer&) = default;
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
174
24254
4bca68f0d8d5 use shared_ptr to manage url_transfer object
John W. Eaton <jwe@octave.org>
parents: 23696
diff changeset
175 ~url_transfer (void) = default;
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
176
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
177 bool is_valid (void) const { return rep->is_valid (); }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
178
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
179 bool good (void) const { return rep->good (); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
180
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
181 std::string lasterror (void) const { return rep->lasterror (); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
182
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
183 std::ostream& set_ostream (std::ostream& os)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
184 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
185 return rep->set_ostream (os);
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
186 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
187
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
188 std::istream& set_istream (std::istream& is)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
189 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
190 return rep->set_istream (is);
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
191 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
192
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
193 void ascii (void) { rep->ascii (); }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
194
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
195 void binary (void) { rep->binary (); }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
196
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
197 bool is_ascii (void) const { return rep->is_ascii (); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
198
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
199 bool is_binary (void) const { return rep->is_binary (); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
200
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
201 void cwd (const std::string& path) { rep->cwd (path); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
202
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
203 void del (const std::string& file) { rep->del (file); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
204
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
205 void rmdir (const std::string& path) { rep->rmdir (path); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
206
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
207 void mkdir (const std::string& path) { rep->mkdir (path); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
208
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
209 void rename (const std::string& oldname, const std::string& newname)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
210 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
211 rep->rename (oldname, newname);
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
212 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
213
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
214 void put (const std::string& file, std::istream& is)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
215 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
216 rep->put (file, is);
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
217 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
218
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
219 void get (const std::string& file, std::ostream& os)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
220 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
221 rep->get (file, os);
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
222 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
223
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
224 void mget_directory (const std::string& directory,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
225 const std::string& target)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
226 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
227 rep->mget_directory (directory, target);
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
228 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
229
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
230 string_vector mput_directory (const std::string& base,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
231 const std::string& directory)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
232 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
233 return rep->mput_directory (base, directory);
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
234 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
235
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
236 void dir (void) { rep->dir (); }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
237
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
238 string_vector list (void) { return rep->list (); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
239
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
240 void get_fileinfo (const std::string& filename, double& filesize,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
241 time_t& filetime, bool& fileisdir)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
242 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
243 rep->get_fileinfo (filename, filesize, filetime, fileisdir);
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
244 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
245
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
246 std::string pwd (void) { return rep->pwd (); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
247
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
248 void http_get (const Array<std::string>& param) { rep->http_get (param); }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
249
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
250 void http_post (const Array<std::string>& param) { rep->http_post (param); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
251
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
252 void http_action (const Array<std::string>& param,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
253 const std::string& action)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
254 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
255 rep->http_action (param, action);
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
256 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
257
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
258 private:
17596
43b9181340fb separate object creation from http actions in url_transfer class
John W. Eaton <jwe@octave.org>
parents: 17557
diff changeset
259
24254
4bca68f0d8d5 use shared_ptr to manage url_transfer object
John W. Eaton <jwe@octave.org>
parents: 23696
diff changeset
260 std::shared_ptr<base_url_transfer> rep;
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
261 };
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
262 }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
263
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
264 #endif